relaton-bipm 1.4.0

data/lib/relaton_bipm/processor.rb

@@ -0,0 +1,41 @@
+require "relaton/processor"
+
+module RelatonBipm
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize
+      @short = :relaton_bipm
+      @prefix = "BIPM"
+      @defaultprefix = %r{^BIPM\s}
+      @idtype = "BIPM"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def get(code, date, opts)
+      ::RelatonBipm::BipmBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def from_xml(xml)
+      ::RelatonBipm::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonBipm::HashConverter.hash_to_bib(hash)
+      ::RelatonBipm::BipmBibliographicItem.new item_hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonBipm.grammar_hash
+    end
+  end
+end

data/lib/relaton_bipm/project_team.rb

@@ -0,0 +1,48 @@
+module RelatonBipm
+  class ProjectTeam
+    COMMITTEES = %w[cgpm cipm bipm ccauv ccem ccl ccm ccpr ccqm ccri cct cctf
+                    ccu ccl-cctfwg jcgm jcrb jctlm inetqi].freeze
+
+    # @return [String]
+    attr_reader :committee
+
+    # @return [RelatonBib::FormattedString]
+    attr_reader :workgroup
+
+    # @param committee [String]
+    # @param workgroup [RelatonBib::FormattedString]
+    def initialize(committee:, workgroup:)
+      unless COMMITTEES.include? committee
+        warn "[relaton-bipm] Warning: invalid committee: #{committee}. "\
+        "It should be one of: #{COMMITTEES}"
+      end
+      @committee = committee
+      @workgroup = workgroup
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.send "project-group" do |b|
+        b.committee committee
+        b.workgroup { workgroup.to_xml b }
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      { "committee" => committee, "workgroup" => workgroup.to_hash }
+    end
+
+    # @param prefix [String]
+    # 2param count [Integer]
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      pref += "project_group"
+      out = count > 1 ? "#{pref}::\n" : ""
+      out += "#{pref}.committee:: #{committee}\n"
+      out += workgroup.to_asciibib prefix
+      out
+    end
+  end
+end

data/lib/relaton_bipm/version.rb

@@ -0,0 +1,3 @@
+module RelatonBipm
+  VERSION = "1.4.0".freeze
+end

data/lib/relaton_bipm/xml_parser.rb

@@ -0,0 +1,86 @@
+module RelatonBipm
+  class XMLParser < RelatonBib::XMLParser
+    class << self
+      private
+
+      # Override RelatonBib::XMLParser.item_data method.
+      # @param item [Nokogiri::XML::Element]
+      # @returtn [Hash]
+      def item_data(item)
+        data = super
+        ext = item.at "./ext"
+        return data unless ext
+
+        data[:project_group] = fetch_project_group ext
+        data[:commentperiod] = fetch_commentperiond ext
+        data
+      end
+
+      # @param item_hash [Hash]
+      # @return [RelatonBipm::BipmBibliographicItem]
+      def bib_item(item_hash)
+        BipmBibliographicItem.new item_hash
+      end
+
+      def fetch_project_group(ext)
+        ext.xpath("./project-group").map do |pg|
+          wg = pg.at "workgroup"
+          workgroup = RelatonBib::FormattedString.new(
+            content: wg.text, language: wg[:language], script: wg[:script],
+            format: wg[:format]
+          )
+          ProjectTeam.new(committee: pg.at("committee").text,
+                          workgroup: workgroup)
+        end
+      end
+
+      # @param item [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::FormattedString>]
+      def fetch_titles(item)
+        item.xpath("./title").map do |t|
+          RelatonBib::FormattedString.new(
+            content: t.text, language: t[:language], script: t[:script],
+            format: t[:format]
+          )
+        end
+      end
+
+      def fetch_dates(item) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+        item.xpath("./date").reduce([]) do |a, d|
+          type = d[:type].to_s.empty? ? "published" : d[:type]
+          if (on = d.at("on"))
+            a << BibliographicDate.new(type: type, on: on.text,
+                                       to: d.at("to")&.text)
+          elsif (from = d.at("from"))
+            a << BibliographicDate.new(type: type, from: from.text,
+                                       to: d.at("to")&.text)
+          end
+        end
+      end
+
+      # @param item [Nokogiri::XML::Element]
+      # @param klass [RelatonBipm::DocumentRelation.class]
+      # @return [Array<RelatonBib::DocumentRelation>]
+      def fetch_relations(item, klass = DocumentRelation)
+        super
+      end
+
+      # @param item [Nokogiri::XML::Element]
+      # @return [RelatonBipm::DocumentStatus]
+      def fetch_status(item)
+        status = item.at("./status")
+        return unless status
+
+        DocumentStatus.new status.text
+      end
+
+      # @param ext [Nokogiri::XML::Element]
+      # @return [RelatonIho::CommentPeriod, nil]
+      def fetch_commentperiond(ext)
+        return unless ext && (cp = ext.at "commentperiod")
+
+        CommentPeriond.new from: cp.at("from")&.text, to: cp.at("to")&.text
+      end
+    end
+  end
+end

data/relaton_bipm.gemspec

@@ -0,0 +1,46 @@
+require_relative "lib/relaton_bipm/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "relaton-bipm"
+  spec.version       = RelatonBipm::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonBipm: retrieve BIPM Standards for "\
+                       "bibliographic use using the BibliographicItem model"
+  spec.description   = "RelatonBipm: retrieve BIPM Standards for "\
+                       "bibliographic use using the BibliographicItem model"
+  spec.homepage      = "https://github.com/relaton/relaton-bipm"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/relaton/relaton-bipm"
+  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "byebug"
+  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 "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "relaton-bib", ">= 1.4.1"
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: relaton-bipm
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: 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
+    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: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  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: simplecov
+  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: vcr
+  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: webmock
+  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: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: 'RelatonBipm: retrieve BIPM Standards for bibliographic use using the
+  BibliographicItem model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/macos.yml"
+- ".github/workflows/ubuntu.yml"
+- ".github/workflows/windows.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- grammars/basicdoc.rng
+- grammars/biblio.rng
+- grammars/isodoc.rng
+- grammars/reqt.rng
+- lib/relaton_bipm.rb
+- 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/document_relation.rb
+- lib/relaton_bipm/document_status.rb
+- lib/relaton_bipm/hash_converter.rb
+- lib/relaton_bipm/processor.rb
+- lib/relaton_bipm/project_team.rb
+- lib/relaton_bipm/version.rb
+- lib/relaton_bipm/xml_parser.rb
+- relaton_bipm.gemspec
+homepage: https://github.com/relaton/relaton-bipm
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/relaton/relaton-bipm
+  source_code_uri: https://github.com/relaton/relaton-bipm
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: 'RelatonBipm: retrieve BIPM Standards for bibliographic use using the BibliographicItem
+  model'
+test_files: []