relaton-ecma 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79a0e5c939fec089e35a4f10ea7c62bdbc9ca1cea332dbbdb61cee01fc255b30
-  data.tar.gz: 5c9c499101971798f03ff2953bf5d4a7693a9edbac031bf7793ce568df97582c
+  metadata.gz: 638cd46fbc98517ba0a0668de0c0a6b3a9d7cd5a23a558cda74bd6d44a71c780
+  data.tar.gz: 449c085cd3ad3871fde55d371d43fd763438a731aaa588b1752df4d8da9d7350
 SHA512:
-  metadata.gz: 40bca3bd29a6fbd8c668ba2dca1ed9fedfeb03bc248162b5f5b702d1fd80bd32fc56c33e83e3c0a35e82eb9e4699dd84396c6f24e9bfa8cc9203639c6cee2ca4
-  data.tar.gz: 7eccd989b4bf12be08f519b8f7564aab8bdd823929e0c3206a903f5f0679460458e54ea89eb2ca7b2d75dd20b4845268b821d8fc4c5766ed1e27496e41c247b8
+  metadata.gz: 91ec74af039dcdd88dd0f9e23a204f8527356c85afd2f7f4a3a9d083073a991c421b27458cae7094decda5629a7f68aacf6562c7a000a919c53b73b28928aa55
+  data.tar.gz: cdf2165763797f45889e6183571b8ff7a9f572759ac1eba68a7063b6f5a9e529524a508c9ce44ba6b5db496966e7910728150c7487c0f63aaf2fda995ad730c0

data/README.adoc

@@ -29,6 +29,20 @@ 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 `RelatonEcma.configure` block.
+
+[source,ruby]
+----
+require 'relaton_ecma'
+=> true
+
+RelatonEcma.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
 === Fetch documents
 
 Documents can be fetched by reference. The structure of the reference depends on the type of the document. There are three types of documents:
@@ -45,27 +59,24 @@ ECMA mementos have the following reference structure: `ECMA MEM/{YEAR}`. Where:
 
 [source,ruby]
 ----
-require 'relaton_ecma'
-=> true
-
 # fetch ECMA standard
 item = RelatonEcma::EcmaBibliography.get 'ECMA-6'
-[relaton-ecma] ("ECMA-6") fetching...
-[relaton-ecma] ("ECMA-6") found ECMA-6
+[relaton-ecma] (ECMA-6) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-6) Found: `ECMA-6`
 #<RelatonEcma::BibliographicItem:0x00007fc645b11c10
 ...
 
 # fetch ECMA standard with edition and volume
 RelatonEcma::EcmaBibliography.get "ECMA-269 ed3 vol2"
-[relaton-ecma] ("ECMA-269 ed3 vol2") fetching...
-[relaton-ecma] ("ECMA-269 ed3 vol2") found ECMA-269
+[relaton-ecma] (ECMA-269 ed3 vol2) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269 ed3 vol2) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x0000000106ac8210
 ...
 
 # fetch the last edition of ECMA standard
 bib = RelatonEcma::EcmaBibliography.get "ECMA-269"
-[relaton-ecma] ("ECMA-269") fetching...
-[relaton-ecma] ("ECMA-269") found ECMA-269
+[relaton-ecma] (ECMA-269) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x000000010a408480
 ...
 
@@ -74,8 +85,8 @@ bib.edition.content
 
 # fetch the first volume of ECMA standard
 bib = RelatonEcma::EcmaBibliography.get "ECMA-269 ed3"
-[relaton-ecma] ("ECMA-269 ed3") fetching...
-[relaton-ecma] ("ECMA-269 ed3") found ECMA-269
+[relaton-ecma] (ECMA-269 ed3) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA-269 ed3) Found: `ECMA-269`
 => #<RelatonEcma::BibliographicItem:0x000000010a3ed0e0
 ...
 
@@ -84,22 +95,22 @@ bib.extent.first.reference_from
 
 # fetch ECMA technical report
 RelatonEcma::EcmaBibliography.get 'ECMA TR/18'
-[relaton-ecma] ("ECMA TR/18") fetching...
-[relaton-ecma] ("ECMA TR/18") found ECMA TR/18
+[relaton-ecma] (ECMA TR/18) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA TR/18) Found: `ECMA TR/18`
 => #<RelatonEcma::BibliographicItem:0x00007fc645c00cc0
 ...
 
 # fetch ECMA memento
 RelatonEcma::EcmaBibliography.get "ECMA MEM/2021"
-[relaton-ecma] ("ECMA MEM/2021") fetching...
-[relaton-ecma] ("ECMA MEM/2021") found ECMA MEM/2021
+[relaton-ecma] (ECMA MEM/2021) Fetching from Relaton repository ...
+[relaton-ecma] (ECMA MEM/2021) Found: `ECMA MEM/2021`
 => #<RelatonEcma::BibliographicItem:0x00007fc665b2f060
 ...
 
 # Return nil if a document doesn't exist.
 RelatonEcma::EcmaBibliography.get '1111'
-[relaton-ecma] ("1111") fetching...
-[relaton-ecma] WARNING no match found online for 1111. The code must be exactly like it is on the standards website.
+[relaton-ecma] (1111) Fetching from Relaton repository ...
+[relaton-ecma] (1111) Not found.
 => nil
 ----
 

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_ecma/data_parser.rb

@@ -1,7 +1,7 @@
 module RelatonEcma
   class DataParser
-    MATTRS = %i[docid title date link].freeze
-    ATTRS = MATTRS + %i[abstract relation edition].freeze
+    MATTRS = %i[docid title date link doctype].freeze
+    ATTRS = MATTRS + %i[abstract relation edition doctype].freeze
 
     #
     # Initialize parser
@@ -11,7 +11,7 @@ module RelatonEcma
     def initialize(hit)
       @hit = hit
       @bib = {
-        type: "standard", language: ["en"], script: ["Latn"], place: ["Geneva"], doctype: "document"
+        type: "standard", language: ["en"], script: ["Latn"], place: ["Geneva"]
       }
       @agent = Mechanize.new
     end
@@ -211,5 +211,11 @@ module RelatonEcma
       content = "\"Memento #{year}\" for year #{year}"
       [{ content: content, language: "en", script: "Latn" }]
     end
+
+    def fetch_doctype
+      RelatonBib::DocumentType.new type: "document"
+    end
+
+    alias_method :fetch_mem_doctype, :fetch_doctype
   end
 end

data/lib/relaton_ecma/ecma_bibliography.rb

@@ -40,14 +40,13 @@ module RelatonEcma
       # @param opts [Hash] not used
       # @return [RelatonEcma::BibliographicItem] Relaton of reference
       def get(code, _year = nil, _opts = {})
-        Util.warn "(#{code}) fetching..."
+        Util.warn "(#{code}) Fetching from Relaton repository ..."
         result = fetch_doc(code)
         if result
-          Util.warn "(#{code}) found `#{result.docidentifier.first.id}`"
+          Util.warn "(#{code}) Found: `#{result.docidentifier.first.id}`"
           # item
         else
-          Util.warn "(#{code}) WARNING no match found online for `#{code}`. " \
-                    "The code must be exactly like it is on the standards website."
+          Util.warn "(#{code}) Not found."
         end
         result
       end

data/lib/relaton_ecma/hash_converter.rb

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

data/lib/relaton_ecma/version.rb

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

data/relaton_ecma.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.require_paths = ["lib"]
 
   spec.add_dependency "mechanize", "~> 2.8.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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ecma
 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: 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