relaton-iec 1.14.4 → 1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7830e8be677e5014f3d20ad93e21a603ca91e9e5e091ec479cafb60819ca550d
-  data.tar.gz: 4689ce387b5c991f4d8ca0461c4eeb37a5f76df03e979d715d0c574c12602305
+  metadata.gz: 22c30d32d348985a90f88d21872741162ebef459ccff4fc118597f196e53f4b9
+  data.tar.gz: 5a265ce8efceee119c822824eb347ace8aeedd9f695b23b7270a22d150da3678
 SHA512:
-  metadata.gz: 5e1d2ad522df02eb85df1b8e84f24d44e7de3e476019ddcc8b65db5b3105b699b6213bef67e6e543039c48ed62fb6806a434b1feb35618059cdc9aa0a78009f4
-  data.tar.gz: 97963e6ce622bf1c6ee27847e935339d4582689658cb31f6d875d11aa8049680b1237e73bfa8c1f52ccdbcd03bc218e5b79ffd27afed7524a6e9461ac2d5bf72
+  metadata.gz: f6f4575283e266b8f35c28b88ff70ec1653c35222e6283d62385c883c459a3a65b096b5ed7495b68a40f4b99760f2e741d59ce4c370556180d0e41bc3d04f529
+  data.tar.gz: 76d9702d3434cf7a7c3b1dfc4e03e9be53ca2e49c801c5dc2060b7574e3d3c023ade59074daeb628a00eb57e1792860d8d35073228594baf0e897917d2b3c9d1

data/.github/workflows/release.yml

@@ -7,7 +7,8 @@ on:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
         required: true
         default: 'skip'
   repository_dispatch:

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 .vscode/
+/vendor/
 .rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
 
 # rspec failure tracking

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 Rails:
   Enabled: false

data/Gemfile

@@ -5,7 +5,10 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in relaton_iec.gemspec
 gemspec
 
+gem "equivalent-xml", "~> 0.6"
 gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
 gem "ruby-jing"
 gem "simplecov"
 gem "vcr"

data/grammars/biblio.rng

@@ -1283,7 +1283,7 @@
       <value>mergedInto</value>
       <value>splits</value>
       <value>splitInto</value>
-      <value>instance</value>
+      <value>instanceOf</value>
       <value>hasInstance</value>
       <value>exemplarOf</value>
       <value>hasExemplar</value>

data/lib/relaton_iec/config.rb

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

data/lib/relaton_iec/data_parser.rb

@@ -238,7 +238,7 @@ module RelatonIec
       when "TR" then "technical-report"
       when "TS" then "technical-specification"
       when "PAS" then "publicly-available-specification"
-      when "SRD" then "system-reference-delivrabble"
+      when "SRD" then "system-reference-deliverable"
       else @pub["stdType"].downcase
       end
     end

data/lib/relaton_iec/iec_bibliographic_item.rb

@@ -6,7 +6,7 @@ module RelatonIec
       guide industry-technical-agreement system-reference-deliverable
     ].freeze
 
-    DOCSUBTYPES = %w[specification method-of-test vocabulary code-of-practice].freeze
+    SUBDOCTYPES = %w[specification method-of-test vocabulary code-of-practice].freeze
 
     FUNCTION = %w[emc safety enviroment quality-assurance].freeze
 
@@ -34,15 +34,13 @@ module RelatonIec
     #
     def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if args[:function] && !FUNCTION.include?(args[:function])
-        warn "[relaton-iec] WARNING: invalid function \"#{args[:function]}\""
-        warn "[relaton-iec] allowed function values are: #{FUNCTION.join(', ')}"
+        Util.warn "WARNING: invalid function `#{args[:function]}`"
+        Util.warn "allowed function values are: `#{FUNCTION.join('`, `')}`"
       end
       if args[:updates_document_type] &&
           !DOCTYPES.include?(args[:updates_document_type])
-        warn "[relaton-iec] WARNING: invalid updates_document_type "\
-             "\"#{args[:updates_document_type]}\""
-        warn "[relaton-iec] allowed updates_document_type values are: "\
-             "#{DOCTYPES.join(', ')}"
+        Util.warn "WARNING: invalid updates_document_type `#{args[:updates_document_type]}`"
+        Util.warn "allowed updates_document_type values are: `#{DOCTYPES.join('`, `')}`"
       end
       @function = args.delete :function
       @updates_document_type = args.delete :updates_document_type

data/lib/relaton_iec/iec_bibliography.rb

@@ -41,34 +41,91 @@ module RelatonIec
 
       private
 
+      # @param pubid [String]
+      # @param year [String]
+      # @param missed_years [Array<String>]
+      def warn_missing_years(pubid, year, missed_years)
+        id = ref_with_year(pubid, year)
+        Util.warn "(#{id}) TIP: No match for edition year `#{year}`, " \
+                  "but matches exist for `#{missed_years.uniq.join('`, `')}`."
+      end
+
       # @param code [String]
       # @param year [String]
       # @param missed_years [Array<String>]
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
-        id = year ? "#{code}:#{year}" : code
-        warn "[relaton-iec] WARNING: no match found online for #{id}. " \
-             "The code must be exactly like it is on the standards website."
-        unless missed_years.empty?
-          warn "[relaton-iec] (There was no match for #{year}, though there " \
-               "were matches found for #{missed_years.join(', ')}.)"
+        id = ref_with_year(code, year)
+
+        Util.warn "(#{id}) Not found. The identifier must be exactly as shown on the IEC Webstore."
+
+        if year && missed_years.any?
+          warn_missing_years(code, year, missed_years)
         end
-        if /\d-\d/.match? code
-          warn "[relaton-iec] The provided document part may not exist, or " \
-               "the document may no longer be published in parts."
+
+        # TODO: change this to pubid-iec
+        has_part = /\d-\d/.match?(code)
+        if has_part
+          Util.warn "(#{id}) TIP: If it cannot be found, the document may no longer be published in parts."
+
         else
-          warn "[relaton-iec] If you wanted to cite all document parts for " \
-               "the reference, use \"#{code} (all parts)\".\nIf the document " \
-               "is not a standard, use its document type abbreviation (TS, " \
-               "TR, PAS, Guide)."
+          Util.warn "(#{id}) TIP: If you wish to cite all document parts for " \
+                    "the reference, use `#{code} (all parts)`."
+        end
+
+        # TODO: streamline after integration with pubid-iec
+        doctypes = %w(TS TR PAS SRD TEC STTR WP Guide OD CS CA)
+        selected_doctype = doctypes.select do |t|
+          code.include?("#{t} ")
         end
+        unless selected_doctype
+          Util.warn "(#{id}) TIP: If the document is not an International Standard, use its " \
+                    "deliverable type abbreviation `#{doctypes.join('`, `')}`."
+        end
+
         nil
       end
 
       # @param ref [String]
+      # @param year [String]
+      # @return [String]
+      def ref_with_year(ref, year)
+        year ? [ref, year].join(":") : ref
+      end
+
+      # @param ref [String]
+      # @param year [String, nil]
+      # @return [RelatonIec::HitCollection]
+      # def search_filter(ref, year) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      #   rp1 = ref_parts ref.upcase
+      #   year ||= rp1[:year]
+      #   corr = rp1[:corr]&.sub " ", ""
+      #   warn "[relaton-iec] (\"#{ref_with_year(ref, year)}\") Fetching from IEC..."
+      #   result = search(rp1[:code], year)
+      #   code = result.text.dup
+      #   if result.empty? && /(?<=\d-)(?<part>[\w-]+)/ =~ rp1[:code]
+      #     # try to search packaged standard
+      #     result = search rp1[:code], year, part
+      #     pkg_std = result.any?
+      #   end
+      #   result = search rp1[:code] if result.empty?
+      #   if pkg_std
+      #     code.sub!(/(?<=\d-)#{part}/, part[0])
+      #   else
+      #     code.sub!(/-[-\d]+/, "")
+      #   end
+      #   result.select do |i|
+      #     rp2 = ref_parts i.hit[:code]
+      #     code2 = if pkg_std
+      #               rp2[:code].sub(/(?<=\d-\d)\d+/, "")
+      #             else
+      #               rp2[:code].sub(/-[-\d]+/, "")
+      #             end
+      #     code == code2 && rp1[:bundle] == rp2[:bundle] && corr == rp2[:corr]
+      #   end
       # @return [RelatonIec::HitCollection]
-      def search_filter(ref)
+      def search_filter(ref, year)
         code = ref.split(":").first
-        warn "[relaton-iec] (\"#{ref}\") fetching..."
+        Util.warn "(#{ref_with_year(ref, year)}) Fetching from IEC..."
         search(code)
       end
 
@@ -184,21 +241,25 @@ module RelatonIec
       # @param year [String, nil]
       # @param opts [Hash]
       # @return [RelatonIec::IecBibliographicItem, nil]
-      def iecbib_get(ref, year, opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        result = search_filter(ref) || return
-        ret = results_filter(result, ref, year, opts)
-        if ret[:ret]
-          if ret[:missed_parts] && !opts[:all_parts]
-            warn "[relaton-iec] WARNING: #{ref} found as #{ret[:ret].docidentifier.first.id} " \
-                 "but also contain parts. If you wanted to cite all document " \
-                 "parts for the reference, use \"#{ref} (all parts)\""
-          else
-            warn "[relaton-iec] (\"#{ref}\") found #{ret[:ret].docidentifier.first.id}"
-          end
-          ret[:ret]
-        else
-          fetch_ref_err(ref, year, ret[:years])
+      def iecbib_get(code, year, opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        result = search_filter(code, year) || return
+        ret = results_filter(result, code, year, opts)
+
+        return fetch_ref_err(code, year, ret[:years]) unless ret[:ret]
+
+        id = ref_with_year(code, year)
+        docid = ret[:ret].docidentifier.first.id
+
+        if id == docid then Util.warn "(#{id}) Found exact match."
+        else Util.warn "(#{id}) Found `#{docid}`."
         end
+
+        if ret[:missed_parts]
+          Util.warn "(#{id}) TIP: `#{code}` also contains other parts, " \
+                    "if you want to cite all parts, use `#{code} (all parts)`."
+        end
+
+        ret[:ret]
       end
     end
   end

data/lib/relaton_iec/index.rb

@@ -48,7 +48,7 @@ module RelatonIec
     #
     # Last change date
     #
-    # @return [String] <description>
+    # @return [String, nil] last change date or nil if index is empty
     #
     def last_change
       return unless @index.any?

data/lib/relaton_iec/util.rb

@@ -0,0 +1,9 @@
+module RelatonIec
+  module Util
+    extend RelatonBib::Util
+
+    def self.logger
+      RelatonIec.configuration.logger
+    end
+  end
+end

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "1.14.4".freeze
+  VERSION = "1.16.1".freeze
 end

data/lib/relaton_iec/xml_parser.rb

@@ -27,7 +27,7 @@ module RelatonIec
       # @param item_hash [Hash]
       # @return [RelatonIec::IecBibliographicItem]
       def bib_item(item_hash)
-        IecBibliographicItem.new **item_hash
+        IecBibliographicItem.new(**item_hash)
       end
     end
   end

data/lib/relaton_iec.rb

@@ -7,6 +7,8 @@ require "relaton/index"
 require "relaton_iso_bib"
 require "relaton_iec/hit"
 require "relaton_iec/version"
+require "relaton_iec/config"
+require "relaton_iec/util"
 require "relaton_iec/iec_bibliography"
 require "relaton_iec/iec_bibliographic_item"
 require "relaton_iec/xml_parser"
@@ -20,10 +22,10 @@ module RelatonIec
     # Returns hash of XML reammar
     # @return [String]
     def grammar_hash
-      gem_path = File.expand_path "..", __dir__
-      grammars_path = File.join gem_path, "grammars", "*"
-      grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
-      Digest::MD5.hexdigest grammars
+      # gem_path = File.expand_path "..", __dir__
+      # grammars_path = File.join gem_path, "grammars", "*"
+      # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+      Digest::MD5.hexdigest RelatonIec::VERSION + RelatonIsoBib::VERSION + RelatonBib::VERSION # grammars
     end
 
     # @param code [String]

data/relaton_iec.gemspec

@@ -21,14 +21,10 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
-
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "addressable"
   spec.add_dependency "relaton-index", "~> 0.2.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.14.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.16.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iec
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.16.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +109,7 @@ files:
 - lib/relaton_iec/basic_block/stem.rb
 - lib/relaton_iec/basic_block/table.rb
 - lib/relaton_iec/basic_block/text_element.rb
+- lib/relaton_iec/config.rb
 - lib/relaton_iec/data_fetcher.rb
 - lib/relaton_iec/data_parser.rb
 - lib/relaton_iec/hash_converter.rb
@@ -162,6 +121,7 @@ files:
 - lib/relaton_iec/processor.rb
 - lib/relaton_iec/statuses.yml
 - lib/relaton_iec/tc_sc_officers_note.rb
+- lib/relaton_iec/util.rb
 - lib/relaton_iec/version.rb
 - lib/relaton_iec/xml_parser.rb
 - relaton_iec.gemspec
@@ -177,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="