relaton-calconnect 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61a4cc200fc734369371f45f1333152f0680a618d00789df5e2eb59d67ffedff
-  data.tar.gz: 79b164ad5afcffd22d57d6ca80edf4cb17ceb7302151be4d9267633c835f4600
+  metadata.gz: 19125bb0584cd670fca9b33e70b08c02f03a24bd7a4c100f92ee068df874d78f
+  data.tar.gz: bcddbe3739ac22b47fecf70097569c180e2ed3ac83a92d2f801507bb362717a9
 SHA512:
-  metadata.gz: 50e66f424c080ee02333e8af0c49b130c27303c0ec737191a0d201b2f111331748011f6835c0ab2f87fa56db3260fb795272b33576d1ef0b34fc9fb4914fe5af
-  data.tar.gz: db45ccdedfa3f1885445592fe7ff5a0fed0305ffcfda55a0cee8bd083e55c64842817ebdde40a4191e9750bdf91aeea0e3be28ae1d051be67971ae8f9bce3791
+  metadata.gz: b55fc339e7072e6c179fd7759df271bbf8b5ca17e952cde6ae76d95ade6ddab4a48d3ee719d0e039b248635937d2dab094bcf938a35355c0ce799a641b9e5545
+  data.tar.gz: 60206cdfaa01221628834e8261713589411ff43d416b11f2c7270e9b4f27b7526647dc59ad459f5e81e3530497424eef192c6263335636322c7376313b090f79

data/README.adoc

@@ -23,13 +23,24 @@ 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 `RelatonCalconnect.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_calconnect'
 => true
 
+RelatonCalconnect.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 hits = RelatonCalconnect::CcBibliography.search("CC/DIR 10005:2019")
 => <RelatonCalconnect::HitCollection:0x007f98e34a8bb0 @ref=CC/DIR 10005:2019 @fetched=false>
 
@@ -91,8 +102,8 @@ item.link
 [source,ruby]
 ----
 RelatonCalconnect::CcBibliography.get "CC/DIR 10005", "2019", {}
-[relaton-calconnect] ("CC/DIR 10005") fetching...
-[relaton-calconnect] ("CC/DIR 10005") found CC/DIR 10005:2019
+[relaton-calconnect] (CC/DIR 10005) Fetching from Relaton repository ...
+[relaton-calconnect] (CC/DIR 10005) Found: `CC/DIR 10005:2019`
 => #<RelatonCalconnect::CcBibliographicItem:0x007f9a73dfa290
 ...
 ----

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_calconnect/cc_bibliographic_item.rb

@@ -1,10 +1,5 @@
 module RelatonCalconnect
   class CcBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[
-      directive guide specification standard report administrative amendment
-      technical\ corrigendum advisory
-    ].freeze
-
     #
     # Fetch flavor schema version
     #

data/lib/relaton_calconnect/cc_bibliography.rb

@@ -29,13 +29,14 @@ module RelatonCalconnect
           end
         end
 
-        Util.warn "(#{ref}) fetching..."
+        Util.warn "(#{ref}) Fetching from Relaton repository ..."
         result = search(code, year, opts) || (return nil)
         ret = bib_results_filter(result, year)
         if ret[:ret]
-          Util.warn "(#{ref}) found `#{ret[:ret].docidentifier.first.id}`"
+          Util.warn "(#{ref}) Found: `#{ret[:ret].docidentifier.first.id}`"
           ret[:ret]
         else
+          Util.warn "(#{ref}) No found."
           fetch_ref_err(code, year, ret[:years])
         end
       end
@@ -73,12 +74,12 @@ module RelatonCalconnect
       # @param year [String]
       # @param missed_years [Array<Strig>]
       def fetch_ref_err(code, year, missed_years)
-        id = year ? "`#{code}` year `#{year}`" : code
-        Util.warn "WARNING: no match found online for #{id}. " \
-                  "The code must be exactly like it is on the standards website."
+        # id = year ? "`#{code}` year `#{year}`" : code
+        # Util.warn "WARNING: No match found online for #{id}. " \
+        #           "The code must be exactly like it is on the standards website."
         unless missed_years.empty?
-          Util.warn "(There was no match for `#{year}`, though there " \
-                    "were matches found for `#{missed_years.join('`, `')}`.)"
+          Util.warn "There was no match for `#{year}`, though there " \
+                    "were matches found for `#{missed_years.join('`, `')}`."
         end
         nil
       end

data/lib/relaton_calconnect/document_type.rb

@@ -0,0 +1,19 @@
+module RelatonCalconnect
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      directive guide specification standard report administrative amendment
+      technical\ corrigendum advisory
+    ].freeze
+
+    def initialize(type:, abbreviation: nil)
+      check_type type
+      super
+    end
+
+    def check_type(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+      end
+    end
+  end
+end

data/lib/relaton_calconnect/hash_converter.rb

@@ -1,15 +1,20 @@
 module RelatonCalconnect
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        return unless ret[:editorialgroup]
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
 
-        technical_committee = RelatonBib.array(ret[:editorialgroup]).map do |wg|
-          TechnicalCommittee.new RelatonBib::WorkGroup.new(**wg)
-        end
-        ret[:editorialgroup] = RelatonBib::EditorialGroup.new technical_committee
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      return unless ret[:editorialgroup]
+
+      technical_committee = RelatonBib.array(ret[:editorialgroup]).map do |wg|
+        TechnicalCommittee.new RelatonBib::WorkGroup.new(**wg)
       end
+      ret[:editorialgroup] = RelatonBib::EditorialGroup.new technical_committee
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_calconnect/version.rb

@@ -1,3 +1,3 @@
 module RelatonCalconnect
-  VERSION = "1.16.1".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_calconnect.rb

@@ -3,6 +3,7 @@ require "relaton_bib"
 require "relaton_calconnect/version"
 require "relaton_calconnect/config"
 require "relaton_calconnect/util"
+require "relaton_calconnect/document_type"
 require "relaton_calconnect/cc_bibliography"
 require "relaton_calconnect/hit_collection"
 require "relaton_calconnect/hit"

data/relaton_calconnect.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "faraday", "~> 2.7.0"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-calconnect
 version: !ruby/object:Gem::Version
-  version: 1.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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
@@ -82,6 +82,7 @@ files:
 - lib/relaton_calconnect/cc_bibliography.rb
 - lib/relaton_calconnect/config.rb
 - lib/relaton_calconnect/data_fetcher.rb
+- lib/relaton_calconnect/document_type.rb
 - lib/relaton_calconnect/hash_converter.rb
 - lib/relaton_calconnect/hit.rb
 - lib/relaton_calconnect/hit_collection.rb