relaton-bsi 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 021f994bae1987a1d8dadd5b1c9425bdcb1aad9c69d62d3e4cb3d388d55bd6d7
-  data.tar.gz: c96491e47dcd93b9281bd1deed2c5e0d1f72984c0aea401966e919dc4634b7a9
+  metadata.gz: 572e54dcc3a988ddc73f8a558b4e9c61fe7cbedb72de7cf766b75e3f8d17ed5b
+  data.tar.gz: b823fdaa3769c709e4dfe753a95c20e0de246d81f74f305f143e87db6c2d95bb
 SHA512:
-  metadata.gz: e6b400c1153a40ede7766a6fce3be936114806d600d620eeaceb90ef521c439cb125ae3b53ca27df1dd536ed94366a33fce85e5aedfe0374ab0ebc7231a744e1
-  data.tar.gz: 51bc43147ec74f564d0e37aa97c29622b46554e4d4adba720ef46f1271827e16efd4bd7c23a4c239151d9ff42c97cceee009d35c9a67c9358f967002549e960f
+  metadata.gz: 29b72f522e23bc75c3bd6fd5fbf3ad68ea2b56eff41748cfe6343387934a6f9c9d836cf9ecd8ae716e02e8aa24f265ab4263b13208e21a36c29a0d1d0e10ba51
+  data.tar.gz: 70a33418abcf63835650873bb1166c2f7a930cdb4514bbc66fefadd957044f5b4f5b6086596d2b3e319ad0ed039e80584bf74fdae1f6f25b48be9b3135e977ab

data/README.adoc

@@ -27,13 +27,24 @@ 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 `RelatonBsi.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_bsi'
 => true
 
+RelatonBsi.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 hit_collection = RelatonBsi::BsiBibliography.search("BS EN ISO 8848")
 => <RelatonBsi::HitCollection:0x007fead49fe1f8 @ref=BS EN ISO 8848 @fetched=false>
 
@@ -89,14 +100,14 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonBsi::BsiBibliography.get "BS EN ISO 8848:2021"
-[relaton-bsi] ("BS EN ISO 8848:2021") fetching...
-[relaton-bsi] ("BS EN ISO 8848:2021") found BS EN ISO 8848:2021
+[relaton-bsi] (BS EN ISO 8848:2021) Fetching from shop.bsigroup.com ...
+[relaton-bsi] (BS EN ISO 8848:2021) Found: `BS EN ISO 8848:2021`
 => #<RelatonBsi::BsiBibliographicItem:0x007feb14814ca8
 ...
 
 RelatonBsi::BsiBibliography.get "BS EN ISO 8848", "2021"
-[relaton-bsi] ("BS EN ISO 8848") fetching...
-[relaton-bsi] ("BS EN ISO 8848") found BS EN ISO 8848:2021
+[relaton-bsi] (BS EN ISO 8848) Fetching from shop.bsigroup.com ...
+[relaton-bsi] (BS EN ISO 8848) Found: `BS EN ISO 8848:2021`
 => #<RelatonBsi::BsiBibliographicItem:0x007feaf59188a8
 ...
 ----

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_bsi/bsi_bibliographic_item.rb

@@ -1,12 +1,5 @@
 module RelatonBsi
   class BsiBibliographicItem < RelatonIsoBib::IsoBibliographicItem
-    DOCTYPES = %w[
-      british-standard draft-for-development published-document privately-subscribed-standard
-      publicly-available-specification flex-standard international-standard technical-specification
-      technical-report guide international-workshop-agreement industry-technical-agreement
-      standard european-workshop-agreement fast-track-standard
-    ].freeze
-
     SUBDOCTYPES = %w[specification method-of-test method-of-specifying vocabulary code-of-practice].freeze
 
     def initialize(**args) # rubocop:disable Metrics/AbcSize

data/lib/relaton_bsi/bsi_bibliography.rb

@@ -53,13 +53,13 @@ module RelatonBsi
       private
 
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
-        y = code_parts(code)[:year]
-        id = year && !y ? "#{code}:#{year}" : code
-        Util.warn "WARNING: no match found online for `#{id}`. " \
-                  "The code must be exactly like it is on the standards website."
+        # y = code_parts(code)[:year]
+        # id = year && !y ? "#{code}:#{year}" : code
+        # Util.warn "WARNING: no match found online for `#{id}`. " \
+        #           "The code must be exactly like it is on the standards website."
         unless missed_years.empty?
-          Util.warn "(There was no match for `#{year}`, though there " \
-                    "were matches found for `#{missed_years.join('`, `')}`.)"
+          Util.warn "There was no match for `#{year}`, though there " \
+                    "were matches found for `#{missed_years.join('`, `')}`."
         end
         # if /\d-\d/.match? code
         #   warn "[relaton-bsi] The provided document part may not exist, or "\
@@ -82,8 +82,11 @@ module RelatonBsi
       #
       def search_filter(code)
         cp = code_parts code
-        Util.warn "(#{code}) fetching..."
-        return [] unless cp
+        Util.warn "(#{code}) Fetching from shop.bsigroup.com ..."
+        unless cp
+          Util.warn "(#{code}) Could not parse the reference"
+          return []
+        end
 
         search(code).filter_hits!(cp)
       end
@@ -112,9 +115,10 @@ module RelatonBsi
         result = search_filter(code) || return
         ret = results_filter(result, year)
         if ret[:ret]
-          Util.warn "(#{code}) found `#{ret[:ret].docidentifier.first&.id}`"
+          Util.warn "(#{code}) Found: `#{ret[:ret].docidentifier.first&.id}`"
           ret[:ret]
         else
+          Util.warn "(#{code}) No found"
           fetch_ref_err(code, year, ret[:years])
         end
       end

data/lib/relaton_bsi/document_type.rb

@@ -0,0 +1,21 @@
+module RelatonBsi
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      british-standard draft-for-development published-document privately-subscribed-standard
+      publicly-available-specification flex-standard international-standard technical-specification
+      technical-report guide international-workshop-agreement industry-technical-agreement
+      standard european-workshop-agreement fast-track-standard expert-commentary
+    ].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_bsi/hash_converter.rb

@@ -1,16 +1,21 @@
 module RelatonBsi
-  class HashConverter < RelatonIsoBib::HashConverter
-    class << self
-      private
+  module HashConverter
+    include RelatonIsoBib::HashConverter
+    extend self
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param item [Hash]
-      # @retirn [RelatonBsi::BsiBibliographicItem]
-      def bib_item(item)
-        BsiBibliographicItem.new(**item)
-      end
+    private
+
+    #
+    # Ovverides superclass's method
+    #
+    # @param item [Hash]
+    # @retirn [RelatonBsi::BsiBibliographicItem]
+    def bib_item(item)
+      BsiBibliographicItem.new(**item)
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_bsi/processor.rb

@@ -10,7 +10,7 @@ module RelatonBsi
     end
 
     # @param code [String]
-    # @param date [String, NilClass] year
+    # @param date [String, nil] year
     # @param opts [Hash]
     # @return [RelatonBsi::BsiBibliographicItem]
     def get(code, date, opts)

data/lib/relaton_bsi/scrapper.rb

@@ -183,6 +183,10 @@ module RelatonBsi
       # @return [String] doctype
       #
       def fetch_doctype(hit)
+        DocumentType.new(type: doctype(hit))
+      end
+
+      def doctype(hit)
         case hit.hit[:code]
         when /(^|\s)Flex\s/ then "flex-standard"
         when /(^|\s)PAS\s/ then "publicly-available-specification"

data/lib/relaton_bsi/version.rb

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

data/lib/relaton_bsi.rb

@@ -4,6 +4,7 @@ require "relaton_iso_bib"
 require_relative "relaton_bsi/version"
 require "relaton_bsi/config"
 require "relaton_bsi/util"
+require "relaton_bsi/document_type"
 require "relaton_bsi/bsi_bibliography"
 require "relaton_bsi/bsi_bibliographic_item"
 require "relaton_bsi/scrapper"

data/relaton_bsi.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "algolia", "~> 2.3.0"
   spec.add_dependency "graphql", "1.13.6"
   spec.add_dependency "graphql-client", "~> 0.16.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bsi
 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: algolia
@@ -58,14 +58,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
 description: 'RelatonBsi: retrieve BSI Standards for bibliographic use using the BibliographicItem
   model'
 email:
@@ -95,6 +95,7 @@ files:
 - lib/relaton_bsi/bsi_bibliographic_item.rb
 - lib/relaton_bsi/bsi_bibliography.rb
 - lib/relaton_bsi/config.rb
+- lib/relaton_bsi/document_type.rb
 - lib/relaton_bsi/hash_converter.rb
 - lib/relaton_bsi/hit.rb
 - lib/relaton_bsi/hit_collection.rb