relaton-bipm 1.11.8 → 1.11.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f54a255e430e5079420ef5a4073baa326b29cbb3d687406b9c940fd1ad7406
-  data.tar.gz: 2e26e487ef00db549f1fa10075c27de47c520b38544c3e408274299805aae4ff
+  metadata.gz: e11a60de824e9077a64e3b8ac31a578a9c5255a41ea8175d61b42186b6ef9eb6
+  data.tar.gz: a179822bd35ada0812119e508b756c5a4edba82bf34352d2ba9c4fff4a9b4be6
 SHA512:
-  metadata.gz: b20367d802b0f7b46794cc28d149c411ec8f7ec88af5b22195b465051eb28fcd4ae5f49fdcf41a78a8651f79d197a4a96f861ab126801563dfaf8c089b0e5c06
-  data.tar.gz: c06515b865194bf25520c942025419a0502eb03bff3bc80c9ebb649c91634210cf89afc239319278d81f105cb2af726349ce0c9c4aebfc3ff72c0f6bed90d261
+  metadata.gz: bd9b8ced31703af3b6ceedefc793da7f1d009750f2fc8c75292690244fd3b2c426ea1d6e39ff358425031fa35d96db4db81fa48c03766448186fd2e990fe7827
+  data.tar.gz: 5f719b30f70141397bffda7d72e1add612099b05cc36daef4fcaa3143c2513a7a2750d39c084a92f30c1fe70438fa5e651e8973feb90d60c97d50bede3fd141d

data/README.adoc

@@ -33,6 +33,61 @@ Or install it yourself as:
 
 === Search for a standard using keywords
 
+==== References for Si-Brochure documents
+
+`BIPM {DOCUMENT_NAME}`
+
+Allowed document names are:
+
+- guide-ccem-ampere-realization
+- guide-ccl-metre-realization-1
+- guide-ccl-metre-realization-2
+- guide-ccl-metre-realization-3
+- guide-ccm-kilogram-calibration
+- guide-ccm-kilogram-dissemination
+- mep-ampere-definition
+- mep-candela-definition
+- mep-candela-rapport
+- mep-kelvin-absolute-uncertainty
+- mep-kelvin-absolute
+- mep-kelvin-definition
+- mep-kelvin-lt-johnson-noise
+- mep-kelvin-relative
+- mep-kilogram-definition
+- mep-metre-definition
+- mep-mole-definition
+- mep-second-definition
+- si-brochure
+- sib-a4
+
+==== Reference structire for Metrologia documents
+
+`BIPM Metrologia {JOURNAL} {VOLUME} {ISSUE} {ARTICLE}`
+
+- `{JOURNAL}` - number of journal, required
+- `{VOLUME}` - number of volume, optional
+- `{ISSUE}` - number of issue, optional
+- `{ARTICLE}` - number of article, optional
+
+==== Reference structures for CCTF (CCDS), CGMP, CIPM documents
+
+- `{BODY} {TYPE} {YEAR}-{2_DIGITS_NUMBER}`
+- `{BODY} {TYPE} {NUMBER} ({YEAR})` or `{BODY} {TYPE} {NUMBER} {YEAR}`
+- `{BODY} {TYPE} {MEETING_NUMBER}-{2_DIGITS_NUMBER}`
+- `{BODY} {TYPE} ({YEAR})` or `{BODY} {TYPE} {YEAR}` - in case only one Resolution/Decision/Declaration/Recommendation is available for the year
+- `{BODY} Meeting {MEETING_NUMBER}` or French version `{BODY} Réunion {MEETING_NUMBER}`
+
+The parts of the structures:
+
+- `{BODY}` - could be `CCTF` (or old named `CCDS`), CGMP, or CIMP
+- `{TYPE}` - could be English word: `Resolution`, `Decision`, `Declaration`, `Recommendation`; or French word: `Résolution`, `Décision`, `Déclaration`, `Recommandation`
+- `{YEAR}` - year of Resolution/Decision/Declaration/Recommendation
+- `{NUMBER}` - number of Resolution/Decision/Declaration/Recommendation
+- `{2_DIGITS_NUMBER}` - two digits number of Resolution/Decision/Declaration/Recommendatio with lead zero if needs
+- `{MEETING_NUMBER}` - number of mieeting
+
+==== Examples
+
 [source,ruby]
 ----
 require 'relaton_bipm'
@@ -78,7 +133,7 @@ RelatonBipm::BipmBibliography.get "CGPM Resolution 1889"
 => #<RelatonBipm::BipmBibliographicItem:0x00007ff0d1ffae50
 ...
 
-# get CIPM decision
+# get CIPM decision by year and decision number
 RelatonBipm::BipmBibliography.get "CIPM Decision 2012-01"
 [relaton-bipm] ("CIPM Decision 2012-01") fetching...
 [relaton-bipm] ("CIPM Decision 2012-01") found CIPM Decision 1 (2012)
@@ -91,6 +146,13 @@ RelatonBipm::BipmBibliography.get "CIPM Decision 1 (2012)"
 => #<RelatonBipm::BipmBibliographicItem:0x00007fb6b9bbec08
 ...
 
+# get CIPM decision by meeting number and decision number
+RelatonBipm::BipmBibliography.get "CIPM Decision 101-01"
+[relaton-bipm] ("CIPM Decision 101-01") fetching...
+[relaton-bipm] ("CIPM Decision 101-01") found CIPM Decision 1 (2012)
+=> #<RelatonBipm::BipmBibliographicItem:0x00007f9ef2acc400
+...
+
 # get CIPM recommendation
 RelatonBipm::BipmBibliography.get "CIPM Recommendation (1948)"
 [relaton-bipm] ("CIPM Recommendation (1948)") fetching...

data/lib/relaton_bipm/bipm_bibliographic_item.rb

@@ -63,8 +63,8 @@ module RelatonBipm
             b.doctype doctype if doctype
             editorialgroup&.to_xml b
             comment_period&.to_xml b
-            b.send "si-aspect", si_aspect if si_aspect
-            b.send "meeting-note", meeting_note if meeting_note
+            b.send :"si-aspect", si_aspect if si_aspect
+            b.send :"meeting-note", meeting_note if meeting_note
             structuredidentifier&.to_xml b
           end
         end
@@ -76,7 +76,7 @@ module RelatonBipm
       hash = super
       hash["comment_period"] = comment_period.to_hash if comment_period
       hash["si_aspect"] = si_aspect if si_aspect
-      hash["meeting-note"] = meeting_note if meeting_note
+      hash["meeting_note"] = meeting_note if meeting_note
       hash
     end
 

data/lib/relaton_bipm/bipm_bibliography.rb

@@ -2,7 +2,7 @@ require "mechanize"
 
 module RelatonBipm
   class BipmBibliography
-    GH_ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-bipm/master/data/".freeze
+    GH_ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-bipm/master/".freeze
     IOP_DOMAIN = "https://iopscience.iop.org".freeze
     SUBSTITUTES = {
       "Déclaration" => "Declaration",
@@ -52,18 +52,15 @@ module RelatonBipm
           "#{$2}-#{$1.to_s.rjust(2, '0')}"
         end
         SUBSTITUTES.each { |fr, en| rf.sub! fr, en }
-        path_parts = rf.split.map &:downcase
-        path_parts.insert(1, "meeting") unless path_parts[1] == "meeting"
-        url = "#{GH_ENDPOINT}#{path_parts.join '/'}.yaml"
+        path = Index.new.search rf
+        return unless path
+
+        url = "#{GH_ENDPOINT}#{path}"
         resp = agent.get url
         check_response resp
         return unless resp.code == "200"
 
-        yaml = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new("3.1.0.pre1")
-                 YAML.safe_load(resp.body, permitted_classes: [Date])
-               else
-                 YAML.safe_load(resp.body, [Date])
-               end
+        yaml = RelatonBipm.parse_yaml resp.body, [Date]
         bib_hash = HashConverter.hash_to_bib yaml
         BipmBibliographicItem.new(**bib_hash)
       end

data/lib/relaton_bipm/index.rb

@@ -0,0 +1,68 @@
+module RelatonBipm
+  class Index
+    #
+    # Initialize index
+    #
+    def initialize
+      read_index_file || get_index_from_gh
+    end
+
+    #
+    # Search index entry
+    #
+    # @param [String] ref reference
+    #
+    # @return [String] path to document file
+    #
+    def search(ref)
+      @index.detect { |key, _| key.include? ref }&.last
+    end
+
+    private
+
+    #
+    # Create dir if need and return path to index file
+    #
+    # @return [String] path to index file
+    #
+    def path
+      @path ||= begin
+        dir = File.join Dir.home, ".relaton", "bipm"
+        FileUtils.mkdir_p dir unless Dir.exist? dir
+        File.join dir, "index.yaml"
+      end
+    end
+
+    #
+    # Read index from file if it exists and not outdated
+    #
+    # @return [Hash, nil] index content
+    #
+    def read_index_file
+      return if !File.exist?(path) || File.ctime(path).to_date < Date.today
+
+      @index = RelatonBipm.parse_yaml File.read(path, encoding: "UTF-8")
+    end
+
+    #
+    # Save index to file
+    #
+    # @return [<Type>] <description>
+    #
+    def save_index_file
+      File.write path, @index.to_yaml, encoding: "UTF-8"
+    end
+
+    #
+    # Get index from a GitHub repository
+    #
+    # @return [Hash] index content
+    #
+    def get_index_from_gh # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      resp = Zip::InputStream.new URI("#{BipmBibliography::GH_ENDPOINT}index.zip").open
+      zip = resp.get_next_entry
+      @index = RelatonBipm.parse_yaml zip.get_input_stream.read
+      save_index_file
+    end
+  end
+end

data/lib/relaton_bipm/version.rb

@@ -1,3 +1,3 @@
 module RelatonBipm
-  VERSION = "1.11.8".freeze
+  VERSION = "1.11.9".freeze
 end

data/lib/relaton_bipm.rb

@@ -1,3 +1,5 @@
+require "zip"
+require "fileutils"
 require "relaton_bib"
 require "relaton_bipm/version"
 require "relaton_bipm/editorial_group"
@@ -11,16 +13,35 @@ require "relaton_bipm/bipm_bibliographic_item"
 require "relaton_bipm/bipm_bibliography"
 require "relaton_bipm/hash_converter"
 require "relaton_bipm/xml_parser"
+require "relaton_bipm/index"
 
 module RelatonBipm
   class Error < StandardError; end
 
   # Returns hash of XML reammar
   # @return [String]
-  def self.grammar_hash
+  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
   end
+
+  #
+  # Parse yaml content
+  #
+  # @param [String] yaml content
+  #
+  # @return [Hash] data
+  #
+  def parse_yaml(yaml, classes = [])
+    # Newer versions of Psych uses the `permitted_classes:` parameter
+    if YAML.method(:safe_load).parameters.map(&:last).include? :permitted_classes
+      YAML.safe_load(yaml, permitted_classes: classes)
+    else
+      YAML.safe_load(yaml, classes)
+    end
+  end
+
+  extend self
 end

data/relaton_bipm.gemspec

@@ -45,5 +45,6 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   spec.add_dependency "mechanize", "~> 2.8.0"
   spec.add_dependency "relaton-bib", "~> 1.11.0"
+  spec.add_dependency "rubyzip", "~> 2.3.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.11.8
+  version: 1.11.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: serrano
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +199,7 @@ files:
 - lib/relaton_bipm/document_relation.rb
 - lib/relaton_bipm/editorial_group.rb
 - lib/relaton_bipm/hash_converter.rb
+- lib/relaton_bipm/index.rb
 - lib/relaton_bipm/processor.rb
 - lib/relaton_bipm/structured_identifier.rb
 - lib/relaton_bipm/version.rb