relaton-ieee 1.12.6 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d518d9c4d21f989941f871c62682bdb996e8d060997e1211fb6bca708cfbd32
-  data.tar.gz: 6b160e9ed08862a141fd4068ce70be0a2cf5ea97196013d87c8cf9af0a4ea133
+  metadata.gz: fda50884de36443dda8e3963c57396ac334a1c5e70d433a02db5249fbcfea2bf
+  data.tar.gz: 7b8d5327947ec30d0a0d3a05d5a291305686eaf1de2a58675cbb2f0ff9478ce6
 SHA512:
-  metadata.gz: d8768c3e725410a80ccf1075e33491e1ff99b6c5051576e1441734d9ef31018ffc9077e3ec01ab0bcfb353efd43018a304aff0967beb2b9839a8271a0fdaaa9b
-  data.tar.gz: b79ca69d3aa30965fef5ce03b910739fa9e4f1816cbfe37b2d66ddb069b4134160f1c73ad2e603a69d214998e5a737819c7cf5949327491275767df25eab6835
+  metadata.gz: d401406eb5049882c1aec5ee87293c998ff45603876f9acc21ad4c5cf523d32abdbed278075740dfc4c863d7c3c6b7447c1c38b5222b441f03c45bc30fc3f252
+  data.tar.gz: 66d9e5789967dec4619da6145ff2d218a2fc5bce1b5fd8e00dc043366ff2758522ce40c921a5283e6bd0b294b3bdfcc0d86f93b0e692fe1eeac50580cb7d6cb9

data/grammars/biblio.rng

@@ -225,9 +225,9 @@
         <zeroOrMore>
           <ref name="forename"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="initial"/>
-        </zeroOrMore>
+        <optional>
+          <ref name="formatted-initials"/>
+        </optional>
         <ref name="surname"/>
         <zeroOrMore>
           <ref name="addition"/>
@@ -247,8 +247,8 @@
       <ref name="LocalizedString"/>
     </element>
   </define>
-  <define name="initial">
-    <element name="initial">
+  <define name="formatted-initials">
+    <element name="formatted-initials">
       <ref name="LocalizedString"/>
     </element>
   </define>
@@ -264,6 +264,9 @@
   </define>
   <define name="forename">
     <element name="forename">
+      <optional>
+        <attribute name="initial"/>
+      </optional>
       <ref name="LocalizedString"/>
     </element>
   </define>

data/grammars/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -1274,7 +1285,12 @@
   </define>
   <define name="span">
     <element name="span">
-      <attribute name="class"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -2493,6 +2509,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

data/lib/relaton_ieee/data_parser.rb

@@ -46,7 +46,7 @@ module RelatonIeee
         copyright: parse_copyright,
         language: ["en"],
         script: ["Latn"],
-        status: parse_status,
+        docstatus: parse_status,
         relation: parse_relation,
         link: parse_link,
         keyword: parse_keyword,
@@ -63,8 +63,8 @@ module RelatonIeee
     #
     def parse_title
       t = []
-      content = doc.at("./volume/article/title").text
-      if content =~ /\A(.+)\s-\sredline\z/i
+      content = CGI.unescapeHTML doc.at("./volume/article/title").text
+      if content =~ /\A(.+)\s[-\u2014]\sredline\z/i
         t << RelatonBib::TypedTitleString.new(content: $1, type: "title-main")
       end
       t << RelatonBib::TypedTitleString.new(content: content, type: "main")

data/lib/relaton_ieee/ieee_bibliographic_item.rb

@@ -12,14 +12,17 @@ module RelatonIeee
     #
     # @param [Hash] args
     # @option args [Boolean, nil] :trialuse Trial use
-    # @option args [Array<RelatonIeee::EditorialGroup>] :editorialgroup Editorial group
+    # @option args [Array<RelatonIeee::EditorialGroup>] :editorialgroup
+    #   Editorial group
     #
-    def initialize(**args)
+    def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if args[:doctype] && !TYPES.include?(args[:doctype])
-        warn "[relaton-ieee] doctype should be one of #{TYPES.join(', ')}"
+        warn "[relaton-ieee] invalid doctype \"#{args[:doctype]}\". " \
+             "It should be one of: #{TYPES.join(', ')}."
       end
       if args[:docsubtype] && !SUBTYPES.include?(args[:docsubtype])
-        warn "[relaton-ieee] docsubtype should be one of #{SUBTYPES.join(', ')}"
+        warn "[relaton-ieee] invalid docsubtype \"#{args[:docsubtype]}\". " \
+             "It should be one of: #{SUBTYPES.join(', ')}."
       end
       eg = args.delete(:editorialgroup)
       @trialuse = args.delete(:trialuse)

data/lib/relaton_ieee/ieee_bibliography.rb

@@ -3,10 +3,14 @@ module RelatonIeee
     class << self
       GH_URL = "https://raw.githubusercontent.com/relaton/relaton-data-ieee/main/data/".freeze
 
+      #
+      # Search IEEE bibliography item by reference.
+      #
       # @param code [String]
+      #
       # @return [RelatonIeee::HitCollection]
+      #
       def search(code)
-        # HitCollection.new text
         ref = code.sub(/Std\s/i, "").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
         url = "#{GH_URL}#{ref}.yaml"
         resp = Faraday.get url
@@ -17,77 +21,26 @@ module RelatonIeee
         raise RelatonBib::RequestError, "Could not access #{GH_URL}"
       end
 
+      #
+      # Get IEEE bibliography item by reference.
+      #
       # @param code [String] the IEEE standard Code to look up (e..g "528-2019")
       # @param year [String] the year the standard was published (optional)
       # @param opts [Hash] options
       #
       # @return [Hash, NilClass] returns { ret: RelatonBib::BibliographicItem }
       #   if document is found else returns NilClass
+      #
       def get(code, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         warn "[relaton-ieee] (\"#{code}\") fetching..."
         item = search(code)
-        # year ||= code.match(/(?<=-)\d{4}/)&.to_s
-        # ret = bib_results_filter(result, code, year)
-        if item # ret[:ret]
-          # item = ret[:ret].fetch
+        if item
           warn "[relaton-ieee] (\"#{code}\") found #{item.docidentifier.first.id}"
           item
-        # else
-        #   fetch_ref_err(code, year, ret[:years])
+        else
+          warn "[relaton-ieee] (\"#{code}\") not found"
         end
       end
-
-      private
-
-      # Sort through the results from RelatonIeee, fetching them three at a time,
-      # and return the first result that matches the code,
-      # matches the year (if provided), and which # has a title (amendments do not).
-      # 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
-      #
-      # @param result [RelatonIeee::HitCollection]
-      # @param opts [Hash] options
-      #
-      # @return [Hash]
-      # def bib_results_filter(result, ref, year) # rubocop:disable Metrics/AbcSize
-      #   rp1 = ref_parts ref
-      #   missed_years = []
-      #   result.each do |hit|
-      #     rp2 = ref_parts hit.hit[:ref]
-      #     next if rp1[:code] != rp2[:code] || rp1[:corr] != rp2[:corr]
-
-      #     return { ret: hit } if !year
-
-      #     return { ret: hit } if year.to_i == hit.hit[:year]
-
-      #     missed_years << hit.hit[:year]
-      #   end
-      #   { years: missed_years.uniq }
-      # end
-
-      # def ref_parts(ref)
-      #   %r{
-      #     ^(?:IEEE\s(?:Std\s)?)?
-      #     (?<code>[^-/]+)
-      #     (?:-(?<year>\d{4}))?
-      #     (?:/(?<corr>\w+\s\d+-\d{4}))?
-      #   }x.match ref
-      # end
-
-      # @param code [Strig]
-      # @param year [String]
-      # @param missed_years [Array<Strig>]
-      # def fetch_ref_err(code, year, missed_years)
-      #   id = year ? "#{code} year #{year}" : code
-      #   warn "[relaton-ieee] 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-ieee] (There was no match for #{year}, though there were matches "\
-      #       "found for #{missed_years.join(', ')}.)"
-      #   end
-      #   nil
-      # end
     end
   end
 end

data/lib/relaton_ieee/processor.rb

@@ -41,7 +41,7 @@ module RelatonIeee
     # @param hash [Hash]
     # @return [RelatonIeee::IeeeBibliographicItem]
     def hash_to_bib(hash)
-      ::RelatonIeee::IeeeBibliographicItem.new hash
+      ::RelatonIeee::IeeeBibliographicItem.new(**hash)
     end
 
     # Returns hash of XML grammar

data/lib/relaton_ieee/version.rb

@@ -1,3 +1,3 @@
 module RelatonIeee
-  VERSION = "1.12.6".freeze
+  VERSION = "1.13.0".freeze
 end

data/relaton_ieee.gemspec

@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_dependency "faraday", "~> 1.0"
-  spec.add_dependency "relaton-bib", "~> 1.12.0"
+  spec.add_dependency "relaton-bib", "~> 1.13.0"
   spec.add_dependency "rubyzip", "~> 2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ieee
 version: !ruby/object:Gem::Version
-  version: 1.12.6
+  version: 1.13.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +154,6 @@ files:
 - lib/relaton_ieee/editorial_group.rb
 - lib/relaton_ieee/hash_converter.rb
 - lib/relaton_ieee/hit.rb
-- lib/relaton_ieee/hit_collection.rb
 - lib/relaton_ieee/ieee_bibliographic_item.rb
 - lib/relaton_ieee/ieee_bibliography.rb
 - lib/relaton_ieee/processor.rb

data/lib/relaton_ieee/hit_collection.rb

@@ -1,42 +0,0 @@
-require "faraday"
-require "relaton_ieee/hit"
-require "fileutils"
-
-module RelatonIeee
-  class HitCollection < RelatonBib::HitCollection
-    # DOMAIN = "https://standards.ieee.org".freeze
-    GH_URL = "https://raw.githubusercontent.com/relaton/relaton-data-ieee/main/data/".freeze
-
-    # @param reference [Strig]
-    # @param opts [Hash]
-    def initialize(reference) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      super
-      ref = reference.gsub(/[\s,:\/]/, "_").squeeze("_").upcase
-      url = "#{GH_URL}#{ref}.yaml"
-      resp = Faraday.get url
-      hit = YAML.load resp.body
-      # code1 = reference.sub(/^IEEE\s(Std\s)?/, "")
-      # url = "#{DOMAIN}/wp-admin/admin-ajax.php"
-      # query = reference.gsub("/", " ")
-      # resp = Faraday.post url, { action: "ieee_cloudsearch", q: query }
-      # json = JSON.parse resp.body
-      # unless json["results"]
-      #   @array = []
-      #   return
-      # end
-
-      # @array = json["results"]["hits"]["hit"].reduce([]) do |s, hit|
-      #   flds = hit["fields"]
-      #   /^(?:\w+\s)?(?<code2>[A-Z\d.]+)(?:-(?<year>\d{4}))?/ =~ flds["meta_designation_l"]
-      #   next s unless code2 && code1 =~ %r{^#{code2}}
-
-      #   hit_data = {
-      #     ref: flds["meta_designation_l"],
-      #     year: year.to_i,
-      #     url: flds["doc_id_l"],
-      #   }
-      #   s << Hit.new(hit_data, self)
-      # end.sort_by { |h| h.hit[:year].to_s + h.hit[:url] }.reverse
-    end
-  end
-end