relaton-ccsds 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d80f031f0c147f71e47a5995bde9fd2bc1870d48cb14b72ce75a3696a759ff
-  data.tar.gz: 10432fb3b7e23107f083e3b3a257252f57affb956671bc9b7efefef00ec1ae33
+  metadata.gz: d13a1ff82cb418e8778c916807bb43c5e8a3fe31f48f8f572c32e6f1631a59b1
+  data.tar.gz: 499cafc2a2dcfd2aa2f8b1040a6d0f2a7af4ad14851df92b980e73697b95ace2
 SHA512:
-  metadata.gz: 42c9d010b92c8e44c55a50b25b02733dc3411b0ad29e984ad67b02dbbab72b9957bdc4b34c8f81bd79e527041fdca4ed69d30a2f0cfff125ae00e56559d3c0cc
-  data.tar.gz: 0dc6886b36189ed8ab4e65943bab41983ce196be324c9f08fdc22c373e38d6b5b093fa7f1996f074a1d0b2f5bde8c850736998f15afab53982dc68974ae6c0b7
+  metadata.gz: 9cbac64eb97f0ca87f19c1274d9ff2864597fb62912a599ea8bd65c4ce722eb9c73e4c2466cdc915385425f9c08bab9f0392de64e62111c579c56df8ca6750c7
+  data.tar.gz: 37ccb6686d9b6cc55990561a205641d809d8ced600468f919588b7a56aa8c252e06076cee066bf3a97e17dbc76d12a05124d43069e5e1f8cab2d6376996fb91a

data/README.adoc

@@ -23,24 +23,13 @@ Or install it yourself as:
 
 == Usage
 
-=== 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.
+=== Search for a standard using keywords
 
 [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>
 
@@ -54,7 +43,7 @@ item = hits[0].doc
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.8">
+=> "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.9">
       <fetched>2023-08-25</fetched>
       <title format="text/plain" language="en" script="Latn">Next Generation Uplink</title>
       <uri type="pdf">https://public.ccsds.org/Pubs/230x2g1.pdf</uri>
@@ -66,7 +55,7 @@ With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and ad
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata schema-version="v1.2.8">
+=> "<bibdata schema-version="v1.2.9">
       <fetched>2023-08-25</fetched>
       <title format="text/plain" language="en" script="Latn">Next Generation Uplink</title>
       <uri type="pdf">https://public.ccsds.org/Pubs/230x2g1.pdf</uri>
@@ -95,8 +84,8 @@ item.link
   @type="pdf">]
 
 RelatonCcsds::Bibliography.get("CCSDS 720.6-Y-1").link
-[relaton-ccsd] (CCSDS 720.6-Y-1) Fetching from Relaton repository ...
-[relaton-ccsd] (CCSDS 720.6-Y-1) Found: `CCSDS 720.6-Y-1`.
+[relaton-ccsds] (CCSDS 720.6-Y-1) Fetching from Relaton repository ...
+[relaton-ccsds] (CCSDS 720.6-Y-1) Found: `CCSDS 720.6-Y-1`.
 => [#<RelatonBib::TypedUri:0x0000000114183bb0
   @content=#<Addressable::URI:0xca8 URI:https://public.ccsds.org/Pubs/720x6y1.pdf>,
   @language=nil,
@@ -113,8 +102,8 @@ RelatonCcsds::Bibliography.get("CCSDS 720.6-Y-1").link
 [source,ruby]
 ----
 RelatonCcsds::Bibliography.get("CCSDS 230.2-G-1")
-[relaton-ccsd] (CCSDS 230.2-G-1) Fetching from Relaton repository ...
-[relaton-ccsd] (CCSDS 230.2-G-1) Found: `CCSDS 230.2-G-1`.
+[relaton-ccsds] (CCSDS 230.2-G-1) Fetching from Relaton repository ...
+[relaton-ccsds] (CCSDS 230.2-G-1) Found: `CCSDS 230.2-G-1`.
 => #<RelatonCcsds::BibliographicItem:0x00000001135dade0
 ...
 ----
@@ -124,8 +113,8 @@ RelatonCcsds::Bibliography.get("CCSDS 230.2-G-1")
 [source,ruby]
 ----
 item = RelatonCcsds::Bibliography.get("CCSDS 720.4-Y-1 (DOC)")
-[relaton-ccsd] (CCSDS 720.4-Y-1 (DOC)) Fetching from Relaton repository ...
-[relaton-ccsd] (CCSDS 720.4-Y-1 (DOC)) Found: `CCSDS 720.4-Y-1`.
+[relaton-ccsds] (CCSDS 720.4-Y-1 (DOC)) Fetching from Relaton repository ...
+[relaton-ccsds] (CCSDS 720.4-Y-1 (DOC)) Found: `CCSDS 720.4-Y-1`.
 => #<RelatonCcsds::BibliographicItem:0x000000011100dfe0
 ...
 
@@ -139,8 +128,8 @@ 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 from Relaton repository ...
-[relaton-ccsd] (CCSDS 720.4-Y-1 (PDF)) Found: `CCSDS 720.4-Y-1`.
+[relaton-ccsds] (CCSDS 720.4-Y-1 (PDF)) Fetching from Relaton repository ...
+[relaton-ccsds] (CCSDS 720.4-Y-1 (PDF)) Found: `CCSDS 720.4-Y-1`.
 => #<RelatonCcsds::BibliographicItem:0x0000000111004620
 ...
 
@@ -195,6 +184,10 @@ Done in: 20 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonCcsds uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/grammars/basicdoc.rng

@@ -244,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>

data/lib/relaton_ccsds/bibliography.rb

@@ -27,14 +27,14 @@ module RelatonCcsds
     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 ..."
+      Util.info "Fetching from Relaton repository ...", key: reference
       hits = search ref
       doc = hits.first&.doc&.to_format(opts[:format])
       unless doc
-        Util.warn "(#{reference}) Not found."
+        Util.info "Not found.", key: reference
         return nil
       end
-      Util.warn "(#{reference}) Found: `#{hits.first.code}`."
+      Util.info "Found: `#{hits.first.code}`.", key: reference
       doc
     end
   end

data/lib/relaton_ccsds/data_fetcher.rb

@@ -112,7 +112,7 @@ module RelatonCcsds
       id = bib.docidentifier.first.id
       file = File.join @output, "#{id.gsub(/[.\s-]+/, '-')}.#{@ext}"
       if @files.include?(file)
-        puts "(#{file}) file already exists. Trying to merge links ..."
+        Util.info "(#{file}) file already exists. Trying to merge links ..."
         merge_links bib, file
       else @files << file
       end
@@ -235,10 +235,10 @@ module RelatonCcsds
       hash = YAML.load_file file
       bib2 = BibliographicItem.from_hash hash
       if bib.link[0].type == bib2.link[0].type
-        warn "(#{file}) links are the same."
+        Util.info "links are the same.", key: file
         return
       end
-      warn "(#{file}) links are merged."
+      Util.info "links are merged.", key: file
       bib.link << bib2.link[0]
     end
 

data/lib/relaton_ccsds/util.rb

@@ -1,9 +1,6 @@
 module RelatonCcsds
   module Util
     extend RelatonBib::Util
-
-    def self.logger
-      RelatonCcsds.configuration.logger
-    end
+    PROGNAME = "relaton-ccsds".freeze
   end
 end

data/lib/relaton_ccsds/version.rb

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

data/lib/relaton_ccsds/xml_parser.rb

@@ -26,6 +26,10 @@ module RelatonCcsds
       def bib_item(item_hash)
         BibliographicItem.new(**item_hash)
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_ccsds.rb

@@ -5,7 +5,6 @@ require "relaton_bib"
 require "relaton/index"
 require_relative "relaton_ccsds/version"
 require_relative "relaton_ccsds/bibliographic_item"
-require_relative "relaton_ccsds/config"
 require_relative "relaton_ccsds/util"
 require_relative "relaton_ccsds/document_type"
 require_relative "relaton_ccsds/bibliography"

data/relaton_ccsds.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "mechanize", "~> 2.10"
-  spec.add_dependency "relaton-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-bib", "~> 1.19.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ccsds
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -76,7 +76,6 @@ files:
 - lib/relaton_ccsds.rb
 - lib/relaton_ccsds/bibliographic_item.rb
 - lib/relaton_ccsds/bibliography.rb
-- lib/relaton_ccsds/config.rb
 - lib/relaton_ccsds/data_fetcher.rb
 - lib/relaton_ccsds/data_parser.rb
 - lib/relaton_ccsds/document_type.rb

data/lib/relaton_ccsds/config.rb

@@ -1,10 +0,0 @@
-module RelatonCcsds
-  module Config
-    include RelatonBib::Config
-  end
-  extend Config
-
-  class Configuration < RelatonBib::Configuration
-    PROGNAME = "relaton-ccsd".freeze
-  end
-end