relaton-w3c 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845e2b18fd329b3f50315eebb7cdf91bd467d53397c65cd2a9124b09d9683e61
-  data.tar.gz: ed906f6bd964ac5af614c1ff88b485d73af30eb4006c6fdea7372f130ebd54cc
+  metadata.gz: 2be8f996d2817de1178521c3e44076641c356a5070b80ed224f08c81e90c4013
+  data.tar.gz: 402ef37f8f0e22f6c7887df9d11665f79b1bd4ab16545c67b63a1fa2cd65d675
 SHA512:
-  metadata.gz: debbdc5fb438e7290748f825859dd432d75d19b4937ef5d749f66c0e899c0e6d9ba3e5287239898b1c773ec9c3832fed89050abacb913fee7171446211d015ea
-  data.tar.gz: 7e007f96fe6a1d712f9cb8766df8b844d1bcd61965e038fb28a3954b50b9d5d485bd7d6849627edc4a13902a94f2de9a0136f98adb4eaffabc194c701f8757fc
+  metadata.gz: 199b908dac06eee499d675bf44cf9d0c8df53968ee639a11f4f914c6ae2ac03281d01dce19cafe92c1427a03f342a93ce071556eccf11c612df8c8f41961f7ad
+  data.tar.gz: f65c63b39d3a6b2210ae02402f241951254f5f6c2c6eec108ba62c29ed8ad796bbb55362ca4e3710373cc911bd8b8eec4074464c4636bb1c1dd954e719c37549

data/README.adoc

@@ -23,16 +23,27 @@ 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 `RelatonW3c.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_w3c'
 => true
 
+RelatonW3c.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 item = RelatonW3c::W3cBibliography.get "W3C REC-json-ld11-20200716"
-[relaton-w3c] ("W3C REC-json-ld11-20200716") fetching...
-[relaton-w3c] ("W3C REC-json-ld11-20200716") found REC-json-ld11-20200716
+[relaton-w3c] (W3C REC-json-ld11-20200716) Fetching from Relaton repository ...
+[relaton-w3c] (W3C REC-json-ld11-20200716) Found: `REC-json-ld11-20200716`
 => #<RelatonW3c::W3cBibliographicItem:0x00007fc4ea03c6c0
 ...
 ----

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_w3c/config.rb

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

data/lib/relaton_w3c/data_parser.rb

@@ -222,7 +222,8 @@ module RelatonW3c
     # @return [String, nil] doctype
     #
     def parse_doctype
-      DOCTYPES[type] || DOCTYPES[type_from_link]
+      type = DOCTYPES[type] || DOCTYPES[type_from_link]
+      DocumentType.new(type: type) if type
     end
 
     #
@@ -434,7 +435,7 @@ module RelatonW3c
           rwg = RelatonBib::WorkGroup.new name: wg["name"]
           obj << RelatonBib::TechnicalCommittee.new(rwg)
         else
-          warn "Working group name not found for #{edg.home_page}"
+          Util.warn "WARNING: Working group name not found for: `#{edg.home_page}`"
         end
       end
       RelatonBib::EditorialGroup.new tc

data/lib/relaton_w3c/document_type.rb

@@ -0,0 +1,16 @@
+module RelatonW3c
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[groupNote technicalReport].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_w3c/hash_converter.rb

@@ -1,11 +1,12 @@
 module RelatonW3c
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      # @param item_hash [Hash]
-      # @return [RelatonW3c::W3cBibliographicItem]
-      def bib_item(item_hash)
-        W3cBibliographicItem.new(**item_hash)
-      end
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
+
+    # @param item_hash [Hash]
+    # @return [RelatonW3c::W3cBibliographicItem]
+    def bib_item(item_hash)
+      W3cBibliographicItem.new(**item_hash)
     end
   end
 end

data/lib/relaton_w3c/hit.rb

@@ -0,0 +1,7 @@
+module RelatonW3c
+  class Hit
+    def initialize(rows)
+      @array = rows.map { |r| Hit.new(**r) }
+    end
+  end
+end

data/lib/relaton_w3c/hit_collection.rb

@@ -0,0 +1,7 @@
+module RelatonW3c
+  class HitCollection < RelatonBib::HitCollection
+    def initialize(rows)
+      @array = rows.map { |r| Hit.new(**r) }
+    end
+  end
+end

data/lib/relaton_w3c/util.rb

@@ -0,0 +1,9 @@
+module RelatonW3c
+  module Util
+    extend RelatonBib::Util
+
+    def self.logger
+      RelatonW3c.configuration.logger
+    end
+  end
+end

data/lib/relaton_w3c/version.rb

@@ -1,3 +1,3 @@
 module RelatonW3c
-  VERSION = "1.16.0".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_w3c/w3c_bibliographic_item.rb

@@ -1,17 +1,8 @@
 module RelatonW3c
   class W3cBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[
-      candidateRecommendation groupNote proposedEditedRecommendation
-      proposedRecommendation recommendation retired workingDraft technicalReport
-    ].freeze
-
-    # @param doctype [String]
-    def initialize(**args)
-      if args[:doctype] && !TYPES.include?(args[:doctype])
-        warn "[relaton-w3c] invalid document type: #{args[:doctype]}"
-      end
-      super
-    end
+    # def initialize(**args)
+    #   super
+    # end
 
     #
     # Fetch flavor schema version

data/lib/relaton_w3c/w3c_bibliography.rb

@@ -39,15 +39,15 @@ module RelatonW3c
       # @param opts [Hash] options
       # @return [RelatonW3c::W3cBibliographicItem]
       def get(ref, _year = nil, _opts = {})
-        warn "[relaton-w3c] (\"#{ref}\") fetching..."
+        Util.warn "(#{ref}) Fetching from Relaton repository ..."
         result = search(ref)
         unless result
-          warn "[relaton-w3c] (\"#{ref}\") not found."
+          Util.warn "(#{ref}) Not found."
           return
         end
 
         found = result.docnumber
-        warn "[relaton-w3c] (\"#{ref}\") found #{found}"
+        Util.warn "(#{ref}) Found: `#{found}`"
         result
       end
     end

data/lib/relaton_w3c/xml_parser.rb

@@ -8,10 +8,10 @@ module RelatonW3c
       # @returtn [Hash]
       def item_data(item)
         data = super
-        ext = item.at "./ext"
-        return data unless ext
+        # ext = item.at "./ext"
+        # return data unless ext
 
-        data[:doctype] = ext.at("./doctype")&.text
+        # data[:doctype] = ext.at("./doctype")&.text
         data
       end
 

data/lib/relaton_w3c.rb

@@ -1,6 +1,9 @@
 require "relaton_bib"
 require "relaton/index"
 require "relaton_w3c/version"
+require "relaton_w3c/config"
+require "relaton_w3c/util"
+require "relaton_w3c/document_type"
 require "relaton_w3c/w3c_bibliography"
 require "relaton_w3c/w3c_bibliographic_item"
 require "relaton_w3c/xml_parser"
@@ -16,9 +19,9 @@ module RelatonW3c
   # Returns hash of XML reammar
   # @return [String]
   def self.grammar_hash
-    gem_path = File.expand_path "..", __dir__
-    grammars_path = File.join gem_path, "grammars", "*"
-    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
-    Digest::MD5.hexdigest grammars
+    # gem_path = File.expand_path "..", __dir__
+    # grammars_path = File.join gem_path, "grammars", "*"
+    # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest RelatonW3c::VERSION + RelatonBib::VERSION # grammars
   end
 end

data/relaton_w3c.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mechanize", "~> 2.8.0"
   spec.add_dependency "rdf", "~> 3.2.0"
   spec.add_dependency "rdf-normalize", "~> 0.5.0"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.0"
   spec.add_dependency "relaton-index", "~> 0.2.4"
   spec.add_dependency "rubyzip", "~> 2.3.0"
   spec.add_dependency "shex", "~> 0.7.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-w3c
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: linkeddata
@@ -72,14 +72,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
@@ -164,12 +164,17 @@ files:
 - grammars/relaton-w3c.rng
 - lib/relaton_w3c.rb
 - lib/relaton_w3c/bibxml_parser.rb
+- lib/relaton_w3c/config.rb
 - lib/relaton_w3c/data_fetcher.rb
 - lib/relaton_w3c/data_index.rb
 - lib/relaton_w3c/data_parser.rb
+- lib/relaton_w3c/document_type.rb
 - lib/relaton_w3c/hash_converter.rb
+- lib/relaton_w3c/hit.rb
+- lib/relaton_w3c/hit_collection.rb
 - lib/relaton_w3c/processor.rb
 - lib/relaton_w3c/pubid.rb
+- lib/relaton_w3c/util.rb
 - lib/relaton_w3c/version.rb
 - lib/relaton_w3c/w3c_bibliographic_item.rb
 - lib/relaton_w3c/w3c_bibliography.rb