relaton-ccsds 1.16.1 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb70be3294be3ba408274ff671392077b6be402928798bdf42be8a445d26f281
-  data.tar.gz: 64c27dfa9fb804c04e9a4381a68001e18d85af4e467162380ab289db234ad3ef
+  metadata.gz: caadca5cd377ef986fe543832065034345b663edd712f6fcee97d532c5b85203
+  data.tar.gz: 248abeac8b28b415dd153ea230ff22613ef29a784b0cbadd11921d76bc5901a7
 SHA512:
-  metadata.gz: b33be383d1200e0a976a5d3c48a296cd957314baf342299e712ea7e606eb23d123e91a08dcd3a6b0c17f808ac156e8a97352413900c34281e29a784ad8768625
-  data.tar.gz: 8fb7ee5bf02d2b3590cc2b9badb9f0e5a7de8da197d055936f8611158ca772af7d3b3c9f53f1eb6c3a0b3fac7583647875f37e77ef7b03cfdfa521f3d3be720e
+  metadata.gz: bbbcb5e1724786a88d157c84da7a15ee96ce2b16a9bf89cfe9087537b702b441d4c48fac49c1d7c88ab484778af8ee4c9c7d92c2ebd94eb44e15e60c9ca6826e
+  data.tar.gz: db36ad93abee600eaddf8701add8dc803b9ecfc480a61dc68dc2aeb275ebf605a5fe03a15e3953418a7a28412f608f4b77b450ff93569af6fbae99ee2fe7c4b0

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /vendor/
+.vscode/
 
 # rspec failure tracking
 .rspec_status

data/README.adoc

@@ -23,17 +23,28 @@ Or install it yourself as:
 
 == Usage
 
-=== Search for a standard using keywords
+=== Configuration
+
+Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonCcsds.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_ccsds'
 => true
 
+RelatonCcsds.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 hits = RelatonCcsds::Bibliography.search("CCSDS 230.2-G-1")
 => <RelatonCcsds::HitCollection:0x00000000001770 @ref=CCSDS 230.2-G-1 @fetched=false>
 
-item = hits[0].fetch
+item = hits[0].doc
 => #<RelatonCcsds::BibliographicItem:0x00000001135f6540
 ...
 ----
@@ -83,7 +94,7 @@ item.link
   @script=nil,
   @type="pdf">]
 
- RelatonCcsds::Bibliography.get("CCSDS 720.6-Y-1").link
+RelatonCcsds::Bibliography.get("CCSDS 720.6-Y-1").link
 [relaton-ccsd] (CCSDS 720.6-Y-1) fetching...
 [relaton-ccsd] (CCSDS 720.6-Y-1) found `CCSDS 720.6-Y-1`.
 => [#<RelatonBib::TypedUri:0x0000000114183bb0
@@ -108,6 +119,41 @@ RelatonCcsds::Bibliography.get("CCSDS 230.2-G-1")
 ...
 ----
 
+=== Get specific format
+
+[source,ruby]
+----
+item = RelatonCcsds::Bibliography.get("CCSDS 720.4-Y-1 (DOC)")
+[relaton-ccsd] (CCSDS 720.4-Y-1 (DOC)) fetching...
+[relaton-ccsd] (CCSDS 720.4-Y-1 (DOC)) found `CCSDS 720.4-Y-1`.
+=> #<RelatonCcsds::BibliographicItem:0x000000011100dfe0
+...
+
+item.link.size
+=> 1
+
+item.link[0].type
+=> "doc"
+
+pry(main)> item.link[0].content.to_s
+=> "https://public.ccsds.org/Pubs/720x4y1.doc"
+
+item = RelatonCcsds::Bibliography.get("CCSDS 720.4-Y-1 (PDF)")
+[relaton-ccsd] (CCSDS 720.4-Y-1 (PDF)) fetching...
+[relaton-ccsd] (CCSDS 720.4-Y-1 (PDF)) found `CCSDS 720.4-Y-1`.
+=> #<RelatonCcsds::BibliographicItem:0x0000000111004620
+...
+
+item.link.size
+=> 1
+
+item.link[0].type
+=> "pdf"
+
+item.link[0].content.to_s
+=> "https://public.ccsds.org/Pubs/720x4y1.pdf"
+----
+
 === Create bibliographic item from XML
 [source,ruby]
 ----

data/lib/relaton_ccsds/bibliographic_item.rb

@@ -7,7 +7,7 @@ module RelatonCcsds
     # @param technology_area [String, nil]
     def initialize(**args)
       if args[:doctype] && !DOCTYPES.include?(args[:doctype])
-        Util.warn "WARNING: invalid doctype: #{args[:doctype]}"
+        Util.warn "WARNING: invalid doctype: `#{args[:doctype]}`"
       end
       @technology_area = args.delete(:technology_area)
       super
@@ -45,5 +45,13 @@ module RelatonCcsds
       end
       hash
     end
+
+    def to_format(format)
+      return self unless format
+
+      me = deep_clone
+      me.link.select! { |l| l.type.casecmp(format).zero? }
+      me if me.link.any?
+    end
   end
 end

data/lib/relaton_ccsds/bibliography.rb

@@ -15,22 +15,26 @@ module RelatonCcsds
 
     #
     # Get CCSDS standard by document reference.
+    # If format is not specified, then all format will be returned.
     #
-    # @param text [String]
+    # @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(ref, _year = nil, _opts = {})
-      Util.warn "(#{ref}) fetching..."
+    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..."
       hits = search ref
-      if hits.empty?
-        Util.warn "(#{ref}) not found."
+      doc = hits.first&.doc&.to_format(opts[:format])
+      unless doc
+        Util.warn "(#{reference}) not found."
         return nil
       end
-      doc = hits.first.doc
-      Util.warn "(#{ref}) found `#{hits.first.code}`."
+      Util.warn "(#{reference}) found `#{hits.first.code}`."
       doc
     end
   end

data/lib/relaton_ccsds/data_fetcher.rb

@@ -17,6 +17,12 @@ module RelatonCcsds
 
     TRRGX = /\s-\s\w+\sTranslated$/.freeze
 
+    #
+    # Initialize fetcher
+    #
+    # @param [String] output path to output directory
+    # @param [String] format output format (yaml, xml, bibxml)
+    #
     def initialize(output, format)
       @output = output
       @format = format
@@ -36,6 +42,14 @@ module RelatonCcsds
       @index ||= Relaton::Index.find_or_create "CCSDS", file: "index-v1.yaml"
     end
 
+    #
+    # Create fetcher instance and fetch data
+    #
+    # @param [String] output path to output directory (default: "data")
+    # @param [String] format output format (yaml, xml, bibxml) (default: "yaml")
+    #
+    # @return [void]
+    #
     def self.fetch(output: "data", format: "yaml")
       t1 = Time.now
       puts "Started at: #{t1}"
@@ -52,6 +66,14 @@ module RelatonCcsds
       index.save
     end
 
+    #
+    # Fetch documents from url
+    #
+    # @param [String] url
+    # @param [Boolean] retired if true, then fetch retired documents
+    #
+    # @return [void]
+    #
     def fetch_docs(url, retired: false)
       resp = agent.get(url)
       json = JSON.parse resp.body
@@ -60,6 +82,15 @@ module RelatonCcsds
       end
     end
 
+    #
+    # Parse document and save to file
+    #
+    # @param [Hash] doc document data
+    # @param [Array<Hash>] results collection of documents
+    # @param [Boolean] retired if true then document is retired
+    #
+    # @return [void]
+    #
     def parse_and_save(doc, results, retired)
       bibitem = DataParser.new(doc, results).parse
       if retired
@@ -69,8 +100,15 @@ module RelatonCcsds
       save_bib bibitem
     end
 
+    #
+    # Save bibitem to file
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib bibitem
+    #
+    # @return [void]
+    #
     def save_bib(bib)
-      search_translation bib
+      search_instance_translation bib
       id = bib.docidentifier.first.id
       file = File.join @output, "#{id.gsub(/[.\s-]+/, '-')}.#{@ext}"
       if @files.include?(file)
@@ -82,52 +120,117 @@ module RelatonCcsds
       index.add_or_update id, file
     end
 
-    def search_translation(bib) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    #
+    # Search translation and instance relation
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib <description>
+    #
+    # @return [void]
+    #
+    def search_instance_translation(bib)
       bibid = bib.docidentifier.first.id.dup
       if bibid.sub!(TRRGX, "")
-        index.search do |row|
-          id = row[:id].sub(TRRGX, "")
-          next if id != bibid || row[:id] == bib.docidentifier.first.id
-
-          create_translation_relation bib, row[:file]
-        end
+        search_relations bibid, bib
       else
-        index.search do |row|
-          next unless row[:id].match?(/^#{bibid}#{TRRGX}/)
+        search_translations bibid, bib
+      end
+    end
+
+    #
+    # Search instance or translation relation
+    #
+    # @param [String] bibid instance bibitem id
+    # @param [RelatonCcsds::BibliographicItem] bib instance or translation bibitem
+    #
+    # @return [void]
+    #
+    def search_relations(bibid, bib)
+      index.search do |row|
+        id = row[:id].sub(TRRGX, "")
+        next if id != bibid || row[:id] == bib.docidentifier.first.id
+
+        create_relations bib, row[:file]
+      end
+    end
+
+    def search_translations(bibid, bib)
+      index.search do |row|
+        next unless row[:id].match?(/^#{bibid}#{TRRGX}/)
 
-          create_instance_relation bib, row[:file]
-        end
+        create_instance_relation bib, row[:file]
       end
     end
 
-    def create_translation_relation(bib, file) # rubocop:disable Metrics/MethodLength
+    #
+    # Create translation or instance relation and save to file
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib bibliographic item
+    # @param [String] file translation or instance file
+    #
+    # @return [void]
+    #
+    def create_relations(bib, file)
       hash = YAML.load_file file
       inst = BibliographicItem.from_hash hash
-      if inst.docidentifier.first.id.match?(TRRGX)
-        type1 = type2 = "hasTranslation"
+      type1, type2 = translation_relation_types(inst)
+      bib.relation << create_relation(inst, type1)
+      inst.relation << create_relation(bib, type2)
+      File.write file, content(inst), encoding: "UTF-8"
+    end
+
+    #
+    # Translation or instance relation types
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib bibliographic item
+    #
+    # @return [Array<String>] relation types
+    #
+    def translation_relation_types(bib)
+      if bib.docidentifier.first.id.match?(TRRGX)
+        ["hasTranslation"] * 2
       else
-        type1 = "instanceOf"
-        type2 = "hasInstance"
+        ["instanceOf", "hasInstance"]
       end
-      create_relation(bib, inst, type1)
-      create_relation(inst, bib, type2)
-      File.write file, content(inst), encoding: "UTF-8"
     end
 
+    #
+    # Create instance relation and save to file
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib bibliographic item
+    # @param [String] file file name
+    #
+    # @return [void]
+    #
     def create_instance_relation(bib, file)
       hash = YAML.load_file file
       inst = BibliographicItem.from_hash hash
-      create_relation bib, inst, "hasInstance"
-      create_relation inst, bib, "instanceOf"
+      bib.relation << create_relation(inst, "hasInstance")
+      inst.relation << create_relation(bib, "instanceOf")
       File.write file, content(inst), encoding: "UTF-8"
     end
 
-    def create_relation(bib1, bib2, type)
-      fref = RelatonBib::FormattedRef.new content: bib2.docidentifier.first.id
-      rel = BibliographicItem.new docid: bib2.docidentifier, formattedref: fref
-      bib1.relation << RelatonBib::DocumentRelation.new(type: type, bibitem: rel)
+    #
+    # Create relation
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib the related bibliographic item
+    # @param [String] type type of relation
+    #
+    # @return [RelatonBib::DocumentRelation] relation
+    #
+    def create_relation(bib, type)
+      fref = RelatonBib::FormattedRef.new content: bib.docidentifier.first.id
+      rel = BibliographicItem.new docid: bib.docidentifier, formattedref: fref
+      RelatonBib::DocumentRelation.new(type: type, bibitem: rel)
     end
 
+    #
+    # Merge identical documents with different links (updaes given bibitem)
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib bibliographic item
+    # @param [String] file path to existing document
+    #
+    # @return [void]
+    #
     def merge_links(bib, file) # rubocop:disable Metrics/AbcSize
       hash = YAML.load_file file
       bib2 = BibliographicItem.from_hash hash
@@ -139,6 +242,13 @@ module RelatonCcsds
       bib.link << bib2.link[0]
     end
 
+    #
+    # Srerialize bibliographic item
+    #
+    # @param [RelatonCcsds::BibliographicItem] bib <description>
+    #
+    # @return [String] serialized bibliographic item
+    #
     def content(bib)
       case @format
       when "yaml" then bib.to_hash.to_yaml

data/lib/relaton_ccsds/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonCcsds
-  VERSION = "1.16.1"
+  VERSION = "1.16.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ccsds
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.16.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -64,7 +64,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".vscode/launch.json"
 - Gemfile
 - README.adoc
 - Rakefile

data/.vscode/launch.json

@@ -1,40 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "RSpec - all",
-      "type": "Ruby",
-      "request": "launch",
-      "program": "${workspaceRoot}/bin/rspec",
-      "args": [
-        "-I",
-        "${workspaceRoot}"
-      ]
-    },
-    {
-      "name": "RSpec - file only",
-      "type": "Ruby",
-      "request": "launch",
-      "program": "${workspaceRoot}/bin/rspec",
-      "args": [
-        "-I",
-        "${workspaceRoot}",
-        "${file}"
-      ]
-    },
-    {
-      "name": "RSpec - line only",
-      "type": "Ruby",
-      "request": "launch",
-      "program": "${workspaceRoot}/bin/rspec",
-      "args": [
-        "-I",
-        "${workspaceRoot}",
-        "${file}:${lineNumber}"
-      ]
-    }
-  ]
-}