Contents

module RelatonCcsds
  module Bibliography
    extend self

    #
    # Search for CCSDS standards by document reference.
    #
    # @param [String] ref document reference
    #
    # @return [RelatonCcsds::HitCollection] collection of hits
    #
    def search(ref)
      RelatonCcsds::HitCollection.new(ref).fetch
    end

    #
    # Get CCSDS standard by document reference.
    # If format is not specified, then all format will be returned.
    #
    # @param reference [String]
    # @param year [String, nil]
    # @param opts [Hash]
    # @option opts [String] :format format of fetched document (DOC, PDF)
    #
    # @return [RelatonCcsds::BibliographicItem]
    #
    def get(reference, _year = nil, opts = {}) # rubocop:disable Metrics/MethodLength
      ref = reference.sub(/\s\((DOC|PDF)\)$/, "")
      opts[:format] ||= Regexp.last_match(1)
      Util.warn "(#{reference}) Fetching from Relaton repository ..."
      hits = search ref
      doc = hits.first&.doc&.to_format(opts[:format])
      unless doc
        Util.warn "(#{reference}) Not found."
        return nil
      end
      Util.warn "(#{reference}) Found: `#{hits.first.code}`."
      doc
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
relaton-ccsds-1.18.1	lib/relaton_ccsds/bibliography.rb
relaton-ccsds-1.18.0	lib/relaton_ccsds/bibliography.rb
relaton-ccsds-1.17.0	lib/relaton_ccsds/bibliography.rb
relaton-ccsds-1.16.3	lib/relaton_ccsds/bibliography.rb