relaton-bipm 1.5.0 → 1.7.1

data/lib/relaton_bipm/committee.rb

@@ -0,0 +1,60 @@
+module RelatonBipm
+  class Committee
+    # @return [String]
+    attr_reader :acronym
+
+    # @return [RelatonBib::LocalizedString]
+    attr_reader :content
+
+    # @param acronym [String]
+    # @param content [RelatonBib::LocalisedString, String, nil]
+    def initialize(acronym:, content: nil)
+      acronyms = YAML.load_file File.join(__dir__, "acronyms.yaml")
+      unless acronyms[acronym]
+        warn "[relaton-bipm] WARNING: invalid acronym: #{acronym}. Allowed "\
+        "values: #{acronyms.map { |k, _v| k }.join ', '}"
+      end
+
+      @acronym = acronym
+      @content = localized_content content, acronyms[acronym]
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.committee(acronym: acronym) { |b| content.to_xml b }
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [String]
+    def to_asciibib(prefix, count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "committee"
+      out = count > 1 ? "#{pref}::\n" : ""
+      out += "#{pref}.acronym:: #{acronym}\n"
+      out + content.to_asciibib(pref)
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = { "acronym" => acronym }
+      cnt = content.to_hash
+      if cnt.is_a? Array then hash["variants"] = cnt
+      elsif cnt.is_a? Hash then hash.merge! cnt
+      else hash["content"] = cnt
+      end
+      hash
+    end
+
+    private
+
+    def localized_content(cnt, acr)
+      if cnt.is_a? String
+        RelatonBib::LocalizedString.new cnt
+      elsif (cnt.nil? || cnt.empty?) && acr && acr["en"]
+        RelatonBib::LocalizedString.new(acr["en"], "en", "Latn")
+      else cnt
+      end
+    end
+  end
+end

data/lib/relaton_bipm/editorial_group.rb

@@ -2,21 +2,12 @@ module RelatonBipm
   class EditorialGroup
     include RelatonBib
 
-    COMMITTEES = %w[CGPM CIPM BIPM CCAUV CCEM CCL CCM CCPR CCQM CCRI CCT CCTF
-                    CCU CCL-CCT JCGM JCRB JCTLM INetQI].freeze
-
     # @return [Array<String>]
     attr_reader :committee, :workgroup
 
-    # @param committee [Array<String>]
-    # @param workgroup [Array<String>]
-    def initialize(committee:, workgroup:)
-      committee.each do |c|
-        unless COMMITTEES.include? c
-          warn "[relaton-bipm] invalid committee: #{c}"
-        end
-      end
-
+    # @param committee [Array<RelatonBipm::Committee>]
+    # @param workgroup [Array<RelatonBipm::WorkGroup>]
+    def initialize(committee:, workgroup: [])
       @committee = committee
       @workgroup = workgroup
     end
@@ -24,19 +15,19 @@ module RelatonBipm
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.editorialgroup do |b|
-        committee.each { |c| b.committee c }
-        workgroup.each { |c| b.workgroup c }
+        committee.each { |c| c.to_xml b }
+        workgroup.each { |c| c.to_xml b }
       end
     end
 
     # @param prefix [String]
     # @return [String]
-    def to_asciibib(prefix = "")
+    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize
       pref = prefix.empty? ? prefix : prefix + "."
       pref += "editorialgroup"
       out = ""
-      committee.each { |c| out += "#{pref}.committee:: #{c}\n" }
-      workgroup.each { |w| out += "#{pref}.workgroup:: #{w}\n" }
+      committee.each { |c| out += c.to_asciibib pref, committee.size }
+      workgroup.each { |w| out += w.to_asciibib pref, workgroup.size }
       out
     end
 

data/lib/relaton_bipm/hash_converter.rb

@@ -2,6 +2,8 @@ require "yaml"
 
 module RelatonBipm
   class HashConverter < RelatonBib::HashConverter
+    @@acronyms = nil
+
     class << self
       # @override RelatonIsoBib::HashConverter.hash_to_bib
       # @param args [Hash]
@@ -21,7 +23,7 @@ module RelatonBipm
       # @param item_hash [Hash]
       # @return [RelatonBib::BibliographicItem]
       def bib_item(item_hash)
-        BipmBibliographicItem.new item_hash
+        BipmBibliographicItem.new **item_hash
       end
 
       # @param ret [Hash]
@@ -30,7 +32,7 @@ module RelatonBipm
           RelatonBib::TypedTitleStringCollection.new
         ) do |m, t|
           m << if t.is_a? Hash
-                 RelatonBib::TypedTitleString.new(t)
+                 RelatonBib::TypedTitleString.new(**t)
                else
                  RelatonBib::TypedTitleString.new(content: t)
                end
@@ -39,7 +41,7 @@ module RelatonBipm
 
       # @param ret [Hash]
       def commentperiod_hash_to_bib(ret)
-        ret[:comment_period] &&= CommentPeriond.new(ret[:comment_period])
+        ret[:comment_period] &&= CommentPeriond.new(**ret[:comment_period])
       end
 
       # @param ret [Hash]
@@ -54,7 +56,7 @@ module RelatonBipm
       def dates_hash_to_bib(ret)
         super
         ret[:date] &&= ret[:date].map do |d|
-          BibliographicDate.new d
+          BibliographicDate.new **d
         end
       end
 
@@ -62,13 +64,37 @@ module RelatonBipm
       def relations_hash_to_bib(ret)
         super
         ret[:relation] &&= ret[:relation].map do |r|
-          RelatonBipm::DocumentRelation.new r
+          RelatonBipm::DocumentRelation.new **r
         end
       end
 
       # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        ret[:editorialgroup] &&= EditorialGroup.new ret[:editorialgroup]
+      def editorialgroup_hash_to_bib(ret) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        return unless ret[:editorialgroup]
+
+        cmt = ret[:editorialgroup][:committee].map do |c|
+          if (vars = committee_variants c).any?
+            content = RelatonBib::LocalizedString.new vars
+            Committee.new acronym: c[:acronym], content: content
+          else
+            Committee.new **c
+          end
+        end
+        wg = array(ret[:editorialgroup][:workgroup]).map do |w|
+          w.is_a?(Hash) ? WorkGroup.new(**w) : WorkGroup.new(content: w)
+        end
+        ret[:editorialgroup] = EditorialGroup.new committee: cmt, workgroup: wg
+      end
+
+      def committee_variants(cmt)
+        array(cmt[:variants]).each_with_object([]) do |v, a|
+          c = v[:content] || (ac = acronyms[cmt[:acronym]]) && ac[v[:language]]
+          a << RelatonBib::LocalizedString.new(c, v[:language], v[:script]) if c
+        end
+      end
+
+      def acronyms
+        @@acronyms ||= YAML.load_file File.join __dir__, "acronyms.yaml"
       end
 
       # @param ret [Hash]

data/lib/relaton_bipm/version.rb

@@ -1,3 +1,3 @@
 module RelatonBipm
-  VERSION = "1.5.0".freeze
+  VERSION = "1.7.1".freeze
 end

data/lib/relaton_bipm/workgroup.rb

@@ -0,0 +1,46 @@
+module RelatonBipm
+  class WorkGroup
+    # @return [String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :acronym
+
+    # @param content [String]
+    # @param acronym [String, nil]
+    def initialize(content:, acronym: nil)
+      @content = content
+      @acronym = acronym
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      xml = builder.workgroup content
+      xml[:acronym] = acronym if acronym
+    end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [String]
+    def to_asciibib(prefix, count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "workgroup"
+      if acronym
+        out = count > 1 ? "#{pref}::\n" : ""
+        out += "#{pref}.acronym:: #{acronym}\n"
+        out + "#{pref}.content:: #{content}\n"
+      else "#{pref}:: #{content}\n"
+      end
+    end
+
+    # @return [Hash, String]
+    def to_hash
+      if acronym
+        hash = { "content" => content }
+        hash["acronym"] = acronym
+        hash
+      else content
+      end
+    end
+  end
+end

data/lib/relaton_bipm/xml_parser.rb

@@ -13,13 +13,14 @@ module RelatonBipm
 
         data[:comment_period] = fetch_commentperiond ext
         data[:si_aspect] = ext.at("si-aspect")&.text
+        data[:meeting_note] = ext.at("meeting-note")&.text
         data
       end
 
       # @param item_hash [Hash]
       # @return [RelatonBipm::BipmBibliographicItem]
       def bib_item(item_hash)
-        BipmBibliographicItem.new item_hash
+        BipmBibliographicItem.new **item_hash
       end
 
       # @param item [Nokogiri::XML::Element]
@@ -63,21 +64,41 @@ module RelatonBipm
 
       # @param ext [Nokogiri::XML::Element]
       # @return [RelatonBipm::EditorialGroup, nil]
-      def fetch_editorialgroup(ext)
+      def fetch_editorialgroup(ext) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         return unless ext && (eg = ext.at "editorialgroup")
 
-        cm = eg.xpath("committee").map &:text
-        wg = eg.xpath("workgroup").map &:text
+        cm = eg.xpath("committee").map do |c|
+          vars = variants c
+          cnt = if vars.any?
+                  RelatonBib::LocalizedString.new vars
+                else
+                  RelatonBib::LocalizedString.new c.text, c[:language], c[:script]
+                end
+          Committee.new acronym: c[:acronym], content: cnt
+        end
+        wg = eg.xpath("workgroup").map do |w|
+          WorkGroup.new content: w.text, acronym: w[:acronym]
+        end
         EditorialGroup.new committee: cm, workgroup: wg
       end
 
+      # @TODO remove this method before next (1.7.0) relaton release
+      #   it's in the relaton-bib but hasn't released yet
+      # @param title [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::LocalizedString>]
+      def variants(elm)
+        elm.xpath("variant").map do |v|
+          RelatonBib::LocalizedString.new v.text, v[:language], v[:script]
+        end
+      end
+
       # @param ext [Nokogiri::XML::Element]
       # @return [RelatonBipm::StructuredIdentifier]
       def fetch_structuredidentifier(ext)
         return unless ext && (sid = ext.at("structuredidentifier"))
 
         StructuredIdentifier.new(
-          docnumber: sid.at("docnumber").text, part: sid.at("part")&.text,
+          docnumber: sid.at("docnumber")&.text, part: sid.at("part")&.text,
           appendix: sid.at("appendix")&.text
         )
       end

data/relaton_bipm.gemspec

@@ -33,15 +33,17 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "byebug"
-  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "ruby-debug-ide"
+  # spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "ruby-jing"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", "~> 1.5.0"
+  spec.add_dependency "mechanize", "~> 2.7.6"
+  spec.add_dependency "relaton-bib", "~> 1.7.0"
+  spec.add_dependency "serrano", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bipm
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
+  name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-jing
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,33 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: mechanize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.7.6
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.6
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: serrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.0'
 description: 'RelatonBipm: retrieve BIPM Standards for bibliographic use using the
   BibliographicItem model'
 email:
@@ -172,15 +172,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/macos.yml"
-- ".github/workflows/ubuntu.yml"
-- ".github/workflows/windows.yml"
+- ".github/workflows/rake.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/rspec
@@ -191,17 +189,19 @@ files:
 - grammars/isodoc.rng
 - grammars/reqt.rng
 - lib/relaton_bipm.rb
+- lib/relaton_bipm/acronyms.yaml
 - lib/relaton_bipm/bibliographic_date.rb
 - lib/relaton_bipm/bipm_bibliographic_item.rb
 - lib/relaton_bipm/bipm_bibliography.rb
 - lib/relaton_bipm/comment_periond.rb
+- lib/relaton_bipm/committee.rb
 - lib/relaton_bipm/document_relation.rb
-- lib/relaton_bipm/document_status.rb
 - lib/relaton_bipm/editorial_group.rb
 - lib/relaton_bipm/hash_converter.rb
 - lib/relaton_bipm/processor.rb
 - lib/relaton_bipm/structured_identifier.rb
 - lib/relaton_bipm/version.rb
+- lib/relaton_bipm/workgroup.rb
 - lib/relaton_bipm/xml_parser.rb
 - relaton_bipm.gemspec
 homepage: https://github.com/relaton/relaton-bipm