relaton-bsi 1.10.1 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bc18302007dac3a0b41311d87a1449cb05af51b4b15e17bcc8aac8a8d3c6d4
-  data.tar.gz: 479ce659cb6301c9069a7bf777e6f7ff5a260c8c8779611cdc9d8d8c9dcc9994
+  metadata.gz: e6526b98460dccb16324ffdbc6cea2309b8e1eda6b5c06ed8272c4bae289b5fa
+  data.tar.gz: 4d64f8b75a735c5ccfbacf3f03816b62ebd22ea4cb2d564ebbb67b87643fbaa2
 SHA512:
-  metadata.gz: 9bfd6ab367994e59c4546ce167aa45c43c97a92a514fc8e041408002238ffece31a7941384523755181e368e56df16b786272dcffedd44fe02936329ff7c90a0
-  data.tar.gz: 0122bcb6f9a3d7383853529bc7d217100fad9be0577c82960db31df70bfeff660c898b307fbfff76ad436072af35070cb4643a2ef927f2d831df6fded0df3db9
+  metadata.gz: b640a7761c3eab1336b54904b31ce8b68477b1736bce1ec2d5b1f4775f8f2c31d9b35e9608e48a922c957e62000c4860f1fecfcb743d6602f2becc5446a7ebab
+  data.tar.gz: 1f80f9e3e3a9a0f613bf239e57b53bb8c9a0e189e841d11d9668a479d959eaa1accbd78a8e6ede2e1a78103a04d2658417eed19ab92712ac693ae1921aafe10d

data/grammars/biblio.rng

@@ -677,6 +677,9 @@
     <zeroOrMore>
       <ref name="extent"/>
     </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
     <zeroOrMore>
       <ref name="accesslocation"/>
     </zeroOrMore>
@@ -922,9 +925,29 @@
       <text/>
     </element>
   </define>
+  <define name="sizevalue">
+    <element name="value">
+      <attribute name="type"/>
+      <text/>
+    </element>
+  </define>
+  <define name="bibliographic_size">
+    <element name="size">
+      <oneOrMore>
+        <ref name="sizevalue"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="extent">
     <element name="extent">
-      <ref name="BibItemLocality"/>
+      <choice>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="localityStack"/>
+        </zeroOrMore>
+      </choice>
     </element>
   </define>
   <define name="series">

data/grammars/bsi.rng

@@ -226,14 +226,14 @@
         <optional>
           <choice>
             <ref name="floating-title"/>
-            <ref name="section-title"/>
+            <ref name="floating-section-title"/>
           </choice>
         </optional>
         <ref name="clause"/>
         <optional>
           <choice>
             <ref name="floating-title"/>
-            <ref name="section-title"/>
+            <ref name="floating-section-title"/>
           </choice>
         </optional>
         <optional>
@@ -245,7 +245,7 @@
         <optional>
           <choice>
             <ref name="floating-title"/>
-            <ref name="section-title"/>
+            <ref name="floating-section-title"/>
           </choice>
         </optional>
         <optional>
@@ -254,7 +254,7 @@
         <optional>
           <choice>
             <ref name="floating-title"/>
-            <ref name="section-title"/>
+            <ref name="floating-section-title"/>
           </choice>
         </optional>
         <oneOrMore>
@@ -263,13 +263,26 @@
             <ref name="term-clause"/>
             <ref name="terms"/>
             <ref name="floating-title"/>
-            <ref name="section-title"/>
+            <ref name="floating-section-title"/>
           </choice>
         </oneOrMore>
       </element>
     </define>
   </include>
   <!-- end overrides -->
+  <define name="floating-section-title">
+    <element name="section-title">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="depth">
+        <data type="int"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="AdmonitionType" combine="choice">
     <value>commentary</value>
   </define>
@@ -316,17 +329,4 @@
       </zeroOrMore>
     </element>
   </define>
-  <!-- <define name="section-title">
-    <element name="section-title">
-      <attribute name="id">
-        <data type="ID"/>
-      </attribute>
-      <attribute name="depth">
-        <data type="int"/>
-      </attribute>
-      <zeroOrMore>
-        <ref name="TextElement"/>
-      </zeroOrMore>
-    </element>
-  </define> -->
 </grammar>

data/grammars/isodoc.rng

@@ -152,9 +152,7 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <oneOrMore>
-          <ref name="PureTextElement"/>
-        </oneOrMore>
+        <ref name="XrefBody"/>
       </element>
     </define>
     <define name="erefType">
@@ -188,6 +186,42 @@
         <ref name="PureTextElement"/>
       </oneOrMore>
     </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>
+      </element>
+    </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>
+      </element>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -1098,6 +1132,16 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="image" combine="choice">
+    <element name="svg">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="AnyElement"/>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="MultilingualRenderingType">
     <choice>
       <value>common</value>
@@ -2631,4 +2675,30 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="XrefBody">
+    <zeroOrMore>
+      <ref name="XrefTarget"/>
+    </zeroOrMore>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
+  </define>
+  <define name="XrefTarget">
+    <element name="location">
+      <attribute name="target">
+        <data type="string">
+          <param name="pattern">\i\c*|\c+#\c+</param>
+        </data>
+      </attribute>
+      <attribute name="connective">
+        <choice>
+          <value>and</value>
+          <value>or</value>
+          <value>from</value>
+          <value>to</value>
+          <value/>
+        </choice>
+      </attribute>
+    </element>
+  </define>
 </grammar>

data/lib/relaton_bsi/bsi_bibliography.rb

@@ -35,7 +35,7 @@ module RelatonBsi
       def get(code, year = nil, opts = {})
         # y = code.split(":")[1]
         year ||= code_parts(code)[:year]
-        ret = bib_get1(code, year, opts)
+        ret = bib_get(code, year, opts)
         return nil if ret.nil?
 
         ret = ret.to_most_recent_reference unless year || opts[:keep_year]
@@ -43,10 +43,27 @@ module RelatonBsi
         ret
       end
 
+      #
+      # Destruct code to its parts.
+      #
+      # @param [String] code document identifier
+      #
+      # @return [MatchData] parts of the code
+      #
+      def code_parts(code)
+        %r{
+          ^(?:BSI\s)?(?<code>(?:[A-Z]+\s)*[^:\s+]+)
+          (?::(?<year>\d{4}))?
+          (?:\+(?<a>[^:\s]+)(?::(?<y>\d{4}))?)?
+          (?:\s(?<rest>.+))?
+        }x.match code
+      end
+
       private
 
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
-        id = year ? "#{code}:#{year}" : code
+        y = code_parts(code)[:year]
+        id = year && !y ? "#{code}:#{year}" : code
         warn "[relaton-bsi] WARNING: no match found online for #{id}. "\
              "The code must be exactly like it is on the standards website."
         unless missed_years.empty?
@@ -65,29 +82,19 @@ module RelatonBsi
         nil
       end
 
-      def search_filter(code) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-        # %r{^(?:BSI\s)?(?<code1>[^:]+)} =~ code
-        # %r{^(?<code1>[^:]+)} =~ code.sub(/^BSI\s/, "")
-        cp1 = code_parts code
+      #
+      # Search for a BSI standard.
+      #
+      # @param [String] code the BSI standard Code to look up
+      #
+      # @return [RelatonBsi::HitCollection] a collection of hits
+      #
+      def search_filter(code)
+        cp = code_parts code
         warn "[relaton-bsi] (\"#{code}\") fetching..."
-        return [] unless cp1
-
-        result = search(code)
-        result.select do |i|
-          # %r{^(?<code2>[^:]+)} =~ i.hit[:code]
-          cp2 = code_parts i.hit[:code]
-          cp2[:code] == cp1[:code] && (!cp1[:a] || cp2[:a] == cp1[:a]) &&
-            (!cp1[:y] || cp2[:y] == cp1[:y])
-        end
-      end
+        return [] unless cp
 
-      def code_parts(code)
-        %r{
-          ^(?:BSI\s)?(?<code>[^:]+)
-          (?::(?<year>\d{4}))?
-          (?:\+(?<a>[^:]+):)?
-          (?::(?<y>\d{4}))?
-        }x.match code
+        search(code).filter_hits!(cp)
       end
 
       # Sort through the results from Isobib, fetching them three at a time,
@@ -96,10 +103,10 @@ module RelatonBsi
       # Only expects the first page of results to be populated.
       # Does not match corrigenda etc (e.g. ISO 3166-1:2006/Cor 1:2007)
       # If no match, returns any years which caused mismatch, for error reporting
-      def isobib_results_filter(result, year)
+      def results_filter(result, year)
         missed_years = []
         result.each do |r|
-          /:(?<pyear>\d{4})/ =~ r.hit[:code]
+          pyear = code_parts(r.hit[:code])[:year]
           if !year || year == pyear
             ret = r.fetch
             return { ret: ret } if ret
@@ -110,9 +117,9 @@ module RelatonBsi
         { years: missed_years }
       end
 
-      def bib_get1(code, year, _opts)
+      def bib_get(code, year, _opts)
         result = search_filter(code) || return
-        ret = isobib_results_filter(result, year)
+        ret = results_filter(result, year)
         if ret[:ret]
           warn "[relaton-bsi] (\"#{code}\") found #{ret[:ret].docidentifier.first&.id}"
           ret[:ret]

data/lib/relaton_bsi/hit_collection.rb

@@ -8,8 +8,12 @@ module RelatonBsi
   class HitCollection < RelatonBib::HitCollection
     DOMAIN = "https://shop.bsigroup.com"
 
-    # @param ref [String]
-    # @param year [String]
+    #
+    # Initialize a new HitCollection.
+    #
+    # @param ref [String] reference
+    # @param year [String] year
+    #
     def initialize(ref, year = nil)
       super ref, year
       config = Algolia::Search::Config.new(
@@ -19,18 +23,40 @@ module RelatonBsi
       client = Algolia::Search::Client.new config, logger: ::Logger.new($stderr)
       index = client.init_index "shopify_products"
       resp = index.search text # , facetFilters: "product_type:standard"
-      @array = hits resp[:hits]
+      @array = create_hits resp[:hits]
+    end
+
+    #
+    # Filter the search results for a BSI standard.
+    #
+    # @param [MatchData] code_parts parts of document identifier
+    #
+    # @return [self] filtered search results
+    #
+    def filter_hits!(code_parts)
+      hits = filter code_parts
+      hits = filter code_parts, skip_rest: true if hits.empty?
+      hits = filter code_parts, drop_amd: true if hits.empty?
+      @array = hits
+      self
     end
 
     private
 
-    # @param hits [Array<Hash>]
-    # @return [Array<RelatonBsi::Hit>]
-    def hits(hits) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      hits.map do |h|
+    #
+    # Create hits from search results.
+    #
+    # @param hits [Array<Hash>] search results
+    #
+    # @return [Array<RelatonBsi::Hit>] hits
+    #
+    def create_hits(hits) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      hits.each_with_object([]) do |h, obj|
+        next unless h[:meta][:global][:publishedDate]
+
         code = h[:meta][:global][:primaryDesignator]
-          .sub(/\s(?:LOOSELEAF|\(A5 LAMINATED\)|-\sTC$)/, "")
-        Hit.new(
+          .sub(/\s?(?:LOOSELEAF|\(A5 LAMINATED\)|-\s?TC$)/, "")
+        obj << Hit.new(
           {
             code: code,
             title: h[:title],
@@ -44,5 +70,24 @@ module RelatonBsi
         )
       end.sort_by { |h| h.hit[:date] }.reverse
     end
+
+    #
+    # Select hits that match the document identifier.
+    #
+    # @param [MatchData] code_parts parts of document identifier
+    # @param [Boolean] drop_amd drop amendments and corrigendums
+    # @param [Boolean] skip_rest skip rest suffix of document identifier
+    #
+    def filter(code_parts, drop_amd: false, skip_rest: false) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      @array.select do |i|
+        code = drop_amd ? i.hit[:code].sub(/\+[AC]\d+.*$/, "") : i.hit[:code]
+        cp = BsiBibliography.code_parts code
+        match = cp[:code] == code_parts[:code] && cp[:a] == code_parts[:a] &&
+          (!code_parts[:y] || cp[:y] == code_parts[:y]) &&
+          (skip_rest || cp[:rest] == code_parts[:rest])
+        i.hit[:code] = code if drop_amd && match
+        match
+      end
+    end
   end
 end

data/lib/relaton_bsi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonBsi
-  VERSION = "1.10.1"
+  VERSION = "1.11.1"
 end

data/relaton_bsi.gemspec

@@ -40,5 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "graphql", "1.13.6"
   spec.add_dependency "graphql-client", "~> 0.16.0"
   # spec.add_dependency "mechanize", "~> 2.8.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.10.1"
+  spec.add_dependency "relaton-iso-bib", "~> 1.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bsi
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.0
 description: 'RelatonBsi: retrieve BSI Standards for bibliographic use using the BibliographicItem
   model'
 email: