relaton-etsi 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6e4ba041c037da56897365348dd11adedc34ea8f92cef0f762995bb7613d8fe
-  data.tar.gz: ddf0f3bef8c7d2292ce6a9e34c6d0b70b04df1ad0c5c5d7f2497b81b686080e0
+  metadata.gz: 7e6de56729e08a6ed75056d304e5bf59b79882496c0e86edf99ba144ef56e3ac
+  data.tar.gz: fc98cc4219dba9e46e33a25217eab20d2ce97512229b619bdf7984e8f8d078ba
 SHA512:
-  metadata.gz: 238a85539e7e015d69242fb759a6d36c22186c664a15b8dc6d1069ed3583bec2517a42860da7f74005f0c68981c985bb1e2c9e6aa4ee419bfdcf0d1e4bbf6271
-  data.tar.gz: edfbe1047d23e749c92294ff2cf2b5365344a8873b38c05ed37d1b1af77b6e56e2b6bf1ec6b98e6e835bfde3c22f1bfb8170b23548570c308e1eced5235d6c25
+  metadata.gz: 45a0d19f40ad27cd253bbabdeeda09585df5354ffbcc5b24a92ece33a1afb3fa4c1ca77d58bae5d99fc71ef7c086f317a18236345d60cb0184bf79a33d91a861
+  data.tar.gz: c7c6c1ea3ba9544809ea59b0c90b891efea0d6212c342788e8723c970a2321d3f9912395bd2ea86ecedf9f0db9e868ced450491039f2f479dad013e056c1d04b

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 `RelatonEtsi.configure` block.
+=== Search for a standard using keywords
 
 [source,ruby]
 ----
 require 'relaton_etsi'
 => true
 
-RelatonEtsi.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
 item = RelatonEtsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")
 [relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Fetching from Relaton repository ...
 [relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Found: `ETSI GS ZSM 012 V1.1.1 (2022-12)`
@@ -156,6 +145,10 @@ Done in: 204 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonEtsi 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

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -163,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>
@@ -715,27 +799,36 @@
   </define>
   <define name="ruby">
     <element name="ruby">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="rp"/>
-          <ref name="rt"/>
-        </choice>
-      </zeroOrMore>
+      <choice>
+        <ref name="ruby_pronunciation"/>
+        <ref name="ruby_annotation"/>
+      </choice>
+      <choice>
+        <text/>
+        <ref name="ruby"/>
+      </choice>
     </element>
   </define>
-  <define name="rp">
-    <element name="rp">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_pronunciation">
+    <element name="pronunciation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
-  <define name="rt">
-    <element name="rt">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_annotation">
+    <element name="annotation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
   <define name="br">
@@ -930,18 +1023,12 @@
     </optional>
     <optional>
       <attribute name="width">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="height">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
@@ -956,6 +1043,14 @@
       </attribute>
     </optional>
   </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
+  </define>
   <define name="video">
     <element name="video">
       <attribute name="id">

data/grammars/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/grammars/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -870,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/relaton_etsi/bibliography.rb

@@ -32,14 +32,14 @@ module RelatonEtsi
     # @param opts [Hash] options
     # @return [RelatonEtsi::BibliographicItem]
     def get(ref, _year = nil, _opts = {})
-      Util.warn "(#{ref}) Fetching from Relaton repository ..."
+      Util.info "Fetching from Relaton repository ...", key: ref
       result = search(ref)
       unless result
-        Util.warn "(#{ref}) Not found."
+        Util.info "Not found.", key: ref
         return
       end
 
-      Util.warn "(#{ref}) Found: `#{result.docidentifier[0].id}`"
+      Util.info "Found: `#{result.docidentifier[0].id}`", key: ref
       result
     end
 

data/lib/relaton_etsi/data_parser.rb

@@ -1,7 +1,7 @@
 module RelatonEtsi
   class DataParser
-    ATTRS = %i[id title docnumber link date docid version status keyword editorialgroup
-               doctype abstract language script].freeze
+    ATTRS = %i[id title docnumber link date docid version status contributor
+               keyword editorialgroup doctype abstract language script].freeze
 
     def initialize(row)
       @row = row
@@ -57,6 +57,15 @@ module RelatonEtsi
       RelatonBib::DocumentStatus.new(stage: status)
     end
 
+    def contributor
+      name = RelatonBib::LocalizedString.new(
+        "European Telecommunications Standards Institute", "en", "Latn"
+      )
+      abbrev = RelatonBib::LocalizedString.new("ETSI", "en", "Latn")
+      entity = RelatonBib::Organization.new name: [name], abbreviation: abbrev
+      [RelatonBib::ContributionInfo.new(entity: entity, role: [{ type: "publisher" }])]
+    end
+
     def keyword
       @row["Keywords"].split(",")
     end

data/lib/relaton_etsi/document_type.rb

@@ -34,13 +34,13 @@ module RelatonEtsi
     def check_type(type)
       return if DOCTYPES.value? type
 
-      Util.warn "WARNING: invalid doctype: `#{type}`"
+      Util.warn "invalid doctype: `#{type}`"
     end
 
     def check_abbreviation(abbreviation)
       return if abbreviation.nil? || DOCTYPES.key?(abbreviation)
 
-      Util.warn "WARNING: invalid doctype abbreviation: `#{abbreviation}`"
+      Util.warn "invalid doctype abbreviation: `#{abbreviation}`"
     end
   end
 end

data/lib/relaton_etsi/hash_converter.rb

@@ -10,5 +10,9 @@ module RelatonEtsi
     def bib_item(item_hash)
       BibliographicItem.new(**item_hash)
     end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
+    end
   end
 end

data/lib/relaton_etsi/util.rb

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

data/lib/relaton_etsi/version.rb

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

data/lib/relaton_etsi/xml_parser.rb

@@ -23,6 +23,10 @@ module RelatonEtsi
         BibliographicItem.new(**item_hash)
       end
 
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
+
       # def fetch_status(item)
       #   status = item.at "./status"
       #   return unless status

data/lib/relaton_etsi.rb

@@ -6,7 +6,6 @@ require "csv"
 require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_etsi/version"
-require_relative "relaton_etsi/config"
 require_relative "relaton_etsi/util"
 require_relative "relaton_etsi/pubid"
 require_relative "relaton_etsi/document_type"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-etsi
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +73,6 @@ files:
 - lib/relaton_etsi.rb
 - lib/relaton_etsi/bibliographic_item.rb
 - lib/relaton_etsi/bibliography.rb
-- lib/relaton_etsi/config.rb
 - lib/relaton_etsi/data_fetcher.rb
 - lib/relaton_etsi/data_parser.rb
 - lib/relaton_etsi/document_type.rb
@@ -90,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'RelatonEtsi: retrieve ETSI Standards for bibliographic using the BibliographicItem

data/lib/relaton_etsi/config.rb

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