relaton-bib 1.13.15 → 1.14.0

data/grammars/biblio.rng

@@ -33,9 +33,10 @@
       <param name="pattern">([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))?</param>
     </data>
   </define>
-  <start>
-    <ref name="bibitem"/>
-  </start>
+  <!-- start = bibitem -->
+  <define name="BibData">
+    <ref name="BibliographicItem"/>
+  </define>
   <define name="status">
     <element name="status">
       <ref name="stage"/>
@@ -73,8 +74,14 @@
       <text/>
     </element>
   </define>
-  <define name="script">
+  <define name="locale">
     <a:documentation>ISO-639</a:documentation>
+    <element name="locale">
+      <text/>
+    </element>
+  </define>
+  <define name="script">
+    <a:documentation>ISO-3166</a:documentation>
     <element name="script">
       <text/>
     </element>
@@ -93,6 +100,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -136,6 +146,9 @@
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -158,27 +171,30 @@
   </define>
   <define name="contributor">
     <element name="contributor">
-      <zeroOrMore>
+      <oneOrMore>
         <ref name="role"/>
-      </zeroOrMore>
+      </oneOrMore>
       <ref name="ContributorInfo"/>
     </element>
   </define>
   <define name="role">
     <element name="role">
-      <optional>
-        <attribute name="type">
-          <choice>
-            <value>author</value>
-            <value>performer</value>
-            <value>publisher</value>
-            <value>editor</value>
-            <value>adapter</value>
-            <value>translator</value>
-            <value>distributor</value>
-          </choice>
-        </attribute>
-      </optional>
+      <attribute name="type">
+        <choice>
+          <value>author</value>
+          <value>performer</value>
+          <value>publisher</value>
+          <value>editor</value>
+          <value>adapter</value>
+          <value>translator</value>
+          <value>distributor</value>
+          <value>realizer</value>
+          <value>owner</value>
+          <value>authorizer</value>
+          <value>enabler</value>
+          <value>subject</value>
+        </choice>
+      </attribute>
       <zeroOrMore>
         <ref name="roledescription"/>
       </zeroOrMore>
@@ -500,6 +516,17 @@
   </define>
   <define name="localityStack">
     <element name="localityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="locality"/>
       </zeroOrMore>
@@ -512,6 +539,17 @@
   </define>
   <define name="sourceLocalityStack">
     <element name="sourceLocalityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="sourceLocality"/>
       </zeroOrMore>
@@ -614,6 +652,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>
@@ -650,6 +691,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -705,6 +749,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>
@@ -741,6 +788,9 @@
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
+    <zeroOrMore>
+      <ref name="locale"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="script"/>
     </zeroOrMore>
@@ -857,6 +907,9 @@
     <optional>
       <attribute name="language"/>
     </optional>
+    <optional>
+      <attribute name="locale"/>
+    </optional>
     <optional>
       <attribute name="script"/>
     </optional>
@@ -937,6 +990,9 @@
       <optional>
         <attribute name="language"/>
       </optional>
+      <optional>
+        <attribute name="locale"/>
+      </optional>
       <optional>
         <attribute name="script"/>
       </optional>

data/grammars/versions.json

@@ -0,0 +1,31 @@
+{
+"relaton-models": "v1.2.1",
+"basicdoc-models": "v1.0.1",
+"metanorma-requirements-models": "v1.0.0",
+"relaton-model-ieee": "v1.0.0",
+"relaton-model-iso": "v1.0.0",
+"relaton-model-iec": "v1.0.0",
+"relaton-model-bsi": "v1.0.0",
+"relaton-model-gb": "v1.0.0",
+"relaton-model-mpfa": "v1.0.0",
+"relaton-model-bipm": "v1.0.0",
+"relaton-model-w3c": "v1.0.0",
+"relaton-model-3gpp": "v1.0.1",
+"relaton-model-csa": "v1.0.0",
+"relaton-model-cc": "v1.0.0",
+"relaton-model-ietf": "v1.0.0",
+"relaton-model-iho": "v1.0.0",
+"relaton-model-itu": "v1.0.0",
+"relaton-model-m3aawg": "v1.0.0",
+"relaton-model-nist": "v1.0.0",
+"relaton-model-ribose": "v1.0.0",
+"relaton-model-ogc": "v1.0.1",
+"relaton-model-un": "v1.0.0",
+"relaton-model-cen": "v1.0.1",
+"relaton-model-ecma": "v1.0.0",
+"relaton-model-cie": "v1.0.0",
+"relaton-model-iana": "v1.0.0",
+"relaton-model-omg": "v1.0.0",
+"relaton-model-oasis": "v1.0.0",
+"date": "2022-12-01T15:03:50Z"
+}

data/lib/relaton_bib/bibliographic_item.rb

@@ -286,6 +286,24 @@ module RelatonBib
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
+    #
+    # Fetch schema version
+    #
+    # @return [String] schema version
+    #
+    def schema
+      @schema ||= schema_versions["relaton-models"]
+    end
+
+    #
+    # Read schema versions from file
+    #
+    # @return [Hash{String=>String}] schema versions
+    #
+    def schema_versions
+      JSON.parse File.read(File.join(__dir__, "../../grammars/versions.json"))
+    end
+
     # @param hash [Hash]
     # @return [RelatonBipm::BipmBibliographicItem]
     def self.from_hash(hash)
@@ -303,19 +321,19 @@ module RelatonBib
       end
     end
 
-    # @param id [RelatonBib::DocumentIdentifier]
-    # @param attribute [boolean, nil]
+    # @param identifier [RelatonBib::DocumentIdentifier]
+    # @param attribute [Boolean, nil]
     # @return [String]
-    def makeid(id, attribute)
+    def makeid(identifier, attribute)
       return nil if attribute && !@id_attribute
 
-      id ||= @docidentifier.reject { |i| i.type == "DOI" }[0]
-      return unless id
+      identifier ||= @docidentifier.reject { |i| i.type == "DOI" }[0]
+      return unless identifier
 
       # contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
       # idstr = "#{contribs}#{delim}#{id.project_number}"
       # idstr = id.project_number.to_s
-      idstr = id.id.gsub(/:/, "-").gsub(/\s/, "")
+      idstr = identifier.id.gsub(/[:\/]/, "-").gsub(/\s/, "")
       # if id.part_number&.size&.positive? then idstr += "-#{id.part_number}"
       idstr.strip
     end
@@ -370,8 +388,9 @@ module RelatonBib
     end
 
     # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def to_hash(embedded: false) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       hash = {}
+      hash["schema-version"] = schema unless embedded
       hash["id"] = id if id
       hash["title"] = title.to_hash if title&.any?
       hash["link"] = single_element_array(link) if link&.any?
@@ -417,6 +436,7 @@ module RelatonBib
       if structuredidentifier&.presence?
         hash["structuredidentifier"] = structuredidentifier.to_hash
       end
+      hash["ext"] = { "schema-version" => ext_schema } if !embedded && respond_to?(:ext_schema)
       hash
     end
 
@@ -733,7 +753,7 @@ module RelatonBib
     # @option opts [String] :lang language
     def render_xml(**opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       root = opts[:bibdata] ? :bibdata : :bibitem
-      xml = opts[:builder].send(root) do |builder|
+      xml = opts[:builder].send(root) do |builder| # rubocop:disable Metrics/BlockLength
         builder.fetched fetched if fetched
         title.to_xml(**opts)
         formattedref&.to_xml builder
@@ -776,17 +796,19 @@ module RelatonBib
         if block_given? then yield builder
         elsif opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||
                                  structuredidentifier&.presence?)
-          builder.ext do |b|
+          ext = builder.ext do |b|
             b.doctype doctype if doctype
             b.subdoctype subdoctype if subdoctype
             editorialgroup&.to_xml b
             ics.each { |i| i.to_xml b }
             structuredidentifier&.to_xml b
           end
+          ext["schema-version"] = ext_schema if !opts[:embedded] && respond_to?(:ext_schema)
         end
       end
       xml[:id] = id if id && !opts[:bibdata] && !opts[:embedded]
       xml[:type] = type if type
+      xml["schema-version"] = schema unless opts[:embedded]
       xml
     end
 

data/lib/relaton_bib/document_relation.rb

@@ -72,7 +72,7 @@ module RelatonBib
 
     # @return [Hash]
     def to_hash # rubocop:disable Metrics/AbcSize
-      hash = { "type" => type, "bibitem" => bibitem.to_hash }
+      hash = { "type" => type, "bibitem" => bibitem.to_hash(embedded: true) }
       hash["description"] = description.to_hash if description
       hash["locality"] = single_element_array(locality) if locality&.any?
       if source_locality&.any?

data/lib/relaton_bib/hit_collection.rb

@@ -24,7 +24,11 @@ module RelatonBib
       @fetched = false
     end
 
-    # @return [RelatonIso::HitCollection]
+    #
+    # Fetches hits from the data source
+    #
+    # @return [self] self object
+    #
     def fetch
       workers = WorkersPool.new 4
       workers.worker(&:fetch)
@@ -37,23 +41,35 @@ module RelatonBib
       self
     end
 
-    # @param opts [Hash]
+    #
+    # Renders the collection as XML
+    #
+    # @param opts [Hash] options
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
-    # @option opts [Boolean] :bibdata
+    # @option opts [Boolean] :bibdata render bibdata if true
     # @option opts [String, Symbol] :lang language
-    # @return [String] XML
+    #
+    # @return [String] XML representation of the collection
+    #
     def to_xml(**opts)
       builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
         xml.documents do
           @array.each do |hit|
             hit.fetch
-            hit.to_xml **opts.merge(builder: xml)
+            hit.to_xml(**opts.merge(builder: xml))
           end
         end
       end
       builder.to_xml
     end
 
+    #
+    # Selects matching hits and returns a new collection
+    #
+    # @param [Proc] &block proc to select hits
+    #
+    # @return [RelatonBib::HitCollection] new hit collection
+    #
     def select(&block)
       me = deep_dup
       array_dup = instance_variable_get(:@array).deep_dup
@@ -67,11 +83,20 @@ module RelatonBib
       self
     end
 
+    #
+    # Returns String representation of the collection
+    #
+    # @return [String] String representation of the collection
+    #
     def to_s
       inspect
     end
 
-    # @return [String]
+    #
+    # Returns String representation of the collection
+    #
+    # @return [String] String representation of the collection
+    #
     def inspect
       "<#{self.class}:#{format('%#.14x', object_id << 1)} @ref=#{@text} @fetched=#{@fetched}>"
     end

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.13.15".freeze
+  VERSION = "1.14.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.13.15
+  version: 1.14.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -229,9 +229,10 @@ files:
 - bin/setup
 - docs/hash.adoc
 - grammars/basicdoc.rng
+- grammars/biblio-compile.rng
+- grammars/biblio-standoc.rng
 - grammars/biblio.rng
-- grammars/isodoc.rng
-- grammars/reqt.rng
+- grammars/versions.json
 - lib/relaton_bib.rb
 - lib/relaton_bib/bib_item_locality.rb
 - lib/relaton_bib/biblio_note.rb
@@ -280,7 +281,7 @@ homepage: https://github.com/relaton/relaton-bib
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -295,8 +296,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: 'RelatonBib: Ruby XMLDOC impementation.'
 test_files: []