relaton-ccsds 1.16.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caadca5cd377ef986fe543832065034345b663edd712f6fcee97d532c5b85203
-  data.tar.gz: 248abeac8b28b415dd153ea230ff22613ef29a784b0cbadd11921d76bc5901a7
+  metadata.gz: 3b632bd8f8858ae2fb6d2fbaffed10fff5f6fde030337ce6fff74e2b4f19e010
+  data.tar.gz: b73f9f3a7b63f80bac18024b2afa60a6bf19f63569a62f9ac7b82302b3dfc631
 SHA512:
-  metadata.gz: bbbcb5e1724786a88d157c84da7a15ee96ce2b16a9bf89cfe9087537b702b441d4c48fac49c1d7c88ab484778af8ee4c9c7d92c2ebd94eb44e15e60c9ca6826e
-  data.tar.gz: db36ad93abee600eaddf8701add8dc803b9ecfc480a61dc68dc2aeb275ebf605a5fe03a15e3953418a7a28412f608f4b77b450ff93569af6fbae99ee2fe7c4b0
+  metadata.gz: aef90a13ba49c82b849bab3192b64b3fd632c85670af4297d4fa3dfa40fc03321976402b610d5b96fa292520c0d72d9b481b498ebad876eefb617a9ef3d6d0a7
+  data.tar.gz: e23521780a2abe04b89167727751191963cb40ed2a805b884348342c459ee90903d6f960261be54459dcddade6bfad877fd40dcc70123b879c59a13e4724e2dd

data/README.adoc

@@ -54,7 +54,7 @@ item = hits[0].doc
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.4">
+=> "<bibitem id="CCSDS230.2-G-1" schema-version="v1.2.5">
       <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 +66,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.4">
+=> "<bibdata schema-version="v1.2.5">
       <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 +95,8 @@ item.link
   @type="pdf">]
 
 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`.
+[relaton-ccsd] (CCSDS 720.6-Y-1) Fetching from Relaton repository ...
+[relaton-ccsd] (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 +113,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...
-[relaton-ccsd] (CCSDS 230.2-G-1) found `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`.
 => #<RelatonCcsds::BibliographicItem:0x00000001135dade0
 ...
 ----
@@ -124,8 +124,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...
-[relaton-ccsd] (CCSDS 720.4-Y-1 (DOC)) found `CCSDS 720.4-Y-1`.
+[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`.
 => #<RelatonCcsds::BibliographicItem:0x000000011100dfe0
 ...
 
@@ -139,8 +139,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...
-[relaton-ccsd] (CCSDS 720.4-Y-1 (PDF)) found `CCSDS 720.4-Y-1`.
+[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`.
 => #<RelatonCcsds::BibliographicItem:0x0000000111004620
 ...
 

data/grammars/basicdoc.rng

@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,6 +654,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -655,7 +663,11 @@
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/grammars/biblio.rng

@@ -942,6 +942,7 @@
       <value>obsoleted</value>
       <value>confirmed</value>
       <value>updated</value>
+      <value>corrected</value>
       <value>issued</value>
       <value>transmitted</value>
       <value>copied</value>

data/lib/relaton_ccsds/bibliographic_item.rb

@@ -1,14 +1,9 @@
 module RelatonCcsds
   class BibliographicItem < RelatonBib::BibliographicItem
-    DOCTYPES = %w[standard practice report specification record].freeze
-
     attr_reader :technology_area
 
     # @param technology_area [String, nil]
     def initialize(**args)
-      if args[:doctype] && !DOCTYPES.include?(args[:doctype])
-        Util.warn "WARNING: invalid doctype: `#{args[:doctype]}`"
-      end
       @technology_area = args.delete(:technology_area)
       super
     end
@@ -27,7 +22,7 @@ module RelatonCcsds
       super do |builder|
         if opts[:bibdata] && (doctype || editorialgroup || technology_area)
           ext = builder.ext do |b|
-            b.doctype doctype if doctype
+            doctype&.to_xml b
             editorialgroup&.to_xml b
             b.send(:"technology-area", technology_area) if technology_area
           end

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..."
+      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."
+        Util.warn "(#{reference}) Not found."
         return nil
       end
-      Util.warn "(#{reference}) found `#{hits.first.code}`."
+      Util.warn "(#{reference}) Found: `#{hits.first.code}`."
       doc
     end
   end

data/lib/relaton_ccsds/data_parser.rb

@@ -56,7 +56,7 @@ module RelatonCcsds
 
     def parse_doctype
       /^CCSDS\s[\d.]+-(?<type>\w+)/ =~ @doc["Document_x0020_Number"]
-      DOCTYPES[type&.to_sym]
+      DocumentType.new type: DOCTYPES[type&.to_sym]
     end
 
     def parse_date

data/lib/relaton_ccsds/document_type.rb

@@ -0,0 +1,16 @@
+module RelatonCcsds
+  class DocumentType < RelatonBib::DocumentType
+    # DOCTYPES = %w[standard practice report specification record].freeze
+
+    def initialize(type:, abbreviation: nil)
+      # check_type type
+      super
+    end
+
+    # def check_type(type)
+    #   return if DOCTYPES.include? type
+
+    #   Util.warn "WARNING: invalid doctype: `#{type}`"
+    # end
+  end
+end

data/lib/relaton_ccsds/hash_converter.rb

@@ -1,21 +1,25 @@
 module RelatonCcsds
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      # @param args [Hash]
-      # @return [Hash]
-      def hash_to_bib(args)
-        ret = super
-        return unless ret
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
+    # @param args [Hash]
+    # @return [Hash]
+    def hash_to_bib(args)
+      ret = super
+      return unless ret
 
-        ret[:technology_area] = ret[:ext][:technology_area] if ret[:ext]
-        ret
-      end
+      ret[:technology_area] = ret[:ext][:technology_area] if ret[:ext]
+      ret
+    end
+
+    # @param item_hash [Hash]
+    # @return [RelatonCie::BibliographicItem]
+    def bib_item(item_hash)
+      BibliographicItem.new(**item_hash)
+    end
 
-      # @param item_hash [Hash]
-      # @return [RelatonCie::BibliographicItem]
-      def bib_item(item_hash)
-        BibliographicItem.new(**item_hash)
-      end
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_ccsds/version.rb

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

data/lib/relaton_ccsds.rb

@@ -7,6 +7,7 @@ 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"
 require_relative "relaton_ccsds/hit"
 require_relative "relaton_ccsds/hit_collection"

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.7"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.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.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ files:
 - lib/relaton_ccsds/config.rb
 - lib/relaton_ccsds/data_fetcher.rb
 - lib/relaton_ccsds/data_parser.rb
+- lib/relaton_ccsds/document_type.rb
 - lib/relaton_ccsds/hash_converter.rb
 - lib/relaton_ccsds/hit.rb
 - lib/relaton_ccsds/hit_collection.rb