relaton-iec 1.14.3 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d00653dcd13da1fbfe251bd51366bcb0e038980a6a5598e8d06e90e93c25a5c
-  data.tar.gz: 1f70ddc26bc98c7a8da254e8eb7b31a28508c06763ebc3ab4de44dfc008b5465
+  metadata.gz: 407e0b683664d9b9e59bcbf2dadbbcc3b3289df9d16354cf7704b27529169020
+  data.tar.gz: dc55bf895de7f08f93f9430c348d562903567df12f5e93c1a7916082c4742ed5
 SHA512:
-  metadata.gz: b4b1f3a22cfa10e630795cebe87ee63ef4e803f4ca276d1f94b37ab09e940d9abc430ab66fbd80e781c1dd8055dd948209f767449139d23bbc42ecbe4e4501cf
-  data.tar.gz: 9ad6a0084b3144ffde1c06237265ca2a6e73ae3762c4dc210ae199a70bdd931866f3db0dfdc1ebbbf17d3714942c33346dc9fb8ae1233910433ba6391bdd7281
+  metadata.gz: f4d1c322f0fd0d0f4a5d21c6cebd43f1f8556d34cd096f547da2c16e8f4a437294be845812b35fa1880c0d790092ae13926bd65fbb9d6a24d6c53263417fb3b4
+  data.tar.gz: ff11597b0da5425a9c402d2da4926200703636b7d88a305299e6d59897e0835f1f68ca2b65f01f94e8f6ff4950e726957bd52ce5624ec712ab67c8f2a794e229

data/.github/workflows/rake.yml

@@ -5,6 +5,7 @@ name: rake
 on:
   push:
     branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -7,11 +7,13 @@ 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'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
+
 
 jobs:
   release:

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/basicdoc.rng

@@ -522,7 +522,6 @@
       <value>tip</value>
       <value>important</value>
       <value>caution</value>
-      <value>statement</value>
     </choice>
   </define>
   <define name="figure">

data/grammars/biblio.rng

@@ -216,6 +216,9 @@
       <optional>
         <ref name="fullname"/>
       </optional>
+      <zeroOrMore>
+        <ref name="credential"/>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="affiliation"/>
       </zeroOrMore>
@@ -232,6 +235,11 @@
       <ref name="FullNameType"/>
     </element>
   </define>
+  <define name="credential">
+    <element name="credential">
+      <text/>
+    </element>
+  </define>
   <define name="FullNameType">
     <choice>
       <group>
@@ -305,7 +313,9 @@
       <zeroOrMore>
         <ref name="affiliationdescription"/>
       </zeroOrMore>
-      <ref name="organization"/>
+      <optional>
+        <ref name="organization"/>
+      </optional>
     </element>
   </define>
   <define name="affiliationname">
@@ -1273,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>
@@ -1316,7 +1326,7 @@
       <value>commentaryOf</value>
       <value>hasCommentary</value>
       <value>related</value>
-      <value>complements</value>
+      <value>hasComplement</value>
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>

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/hit_collection.rb

@@ -8,13 +8,13 @@ module RelatonIec
   class HitCollection < RelatonBib::HitCollection
     def_delegators :@array, :detect, :map
 
-    # DOMAIN = "https://webstore.iec.ch"
+    INDEX_FILE = "index1.yaml"
 
     # @param ref [String]
     # @param year [String, nil]
     def initialize(ref, year = nil)
       super ref, year
-      @index = Relaton::Index.find_or_create :IEC, url: "#{Hit::GHURL}index1.zip" , file: "index1.yaml"
+      @index = Relaton::Index.find_or_create :IEC, url: "#{Hit::GHURL}index1.zip" , file: INDEX_FILE
       @array = fetch_from_gh
     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
 
@@ -39,9 +39,9 @@ module RelatonIec
       end
       if args[:updates_document_type] &&
           !DOCTYPES.include?(args[:updates_document_type])
-        warn "[relaton-iec] WARNING: invalid updates_document_type "\
+        warn "[relaton-iec] WARNING: invalid updates_document_type " \
              "\"#{args[:updates_document_type]}\""
-        warn "[relaton-iec] allowed updates_document_type values are: "\
+        warn "[relaton-iec] allowed updates_document_type values are: " \
              "#{DOCTYPES.join(', ')}"
       end
       @function = args.delete :function

data/lib/relaton_iec/iec_bibliography.rb

@@ -41,34 +41,97 @@ 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)
+        warn "[relaton-iec] (\"#{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)
+
+        warn "[relaton-iec] (\"#{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
+          warn "[relaton-iec] (\"#{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)."
+          warn "[relaton-iec] (\"#{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
+          warn "[relaton-iec] (\"#{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..."
+        warn "[relaton-iec] (\"#{ref_with_year(ref, year)}\") Fetching from IEC..."
         search(code)
       end
 
@@ -184,21 +247,29 @@ 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]
+      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
+          warn "[relaton-iec] (\"#{id}\") Found exact match."
         else
-          fetch_ref_err(ref, year, ret[:years])
+          warn "[relaton-iec] (\"#{id}\") Found (\"#{docid}\")."
         end
+
+        if ret[:missed_parts]
+          warn "[relaton-iec] (\"#{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/processor.rb

@@ -53,5 +53,12 @@ module RelatonIec
     def urn_to_code(code)
       RelatonIec.urn_to_code code
     end
+
+    #
+    # Remove index file
+    #
+    def remove_index_file
+      Relaton::Index.find_or_create(:IEC, url: true, file: HitCollection::INDEX_FILE).remove_file
+    end
   end
 end

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "1.14.3".freeze
+  VERSION = "1.16.0".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/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.1.6"
-  spec.add_dependency "relaton-iso-bib", "~> 1.14.0"
+  spec.add_dependency "relaton-index", "~> 0.2.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.3
+  version: 1.16.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-09-03 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
@@ -72,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: relaton-iso-bib
   requirement: !ruby/object:Gem::Requirement
     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
@@ -169,7 +127,7 @@ homepage: https://github.com/metanorma/relaton-iec
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -177,15 +135,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem
   model'