pubid-nist 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7f47e08604ec704f0cf6468e57bf119027caf37ccba4043269374d2e9381a3
-  data.tar.gz: ec580488f65954d7fcbbfff5dd17e0cdc2dc88f7d07cb81d0bada5812beae2fe
+  metadata.gz: 9ac016ca575f6b9815da56cb9424c1ba9bce844f494822e8bf407d9bb51de4cd
+  data.tar.gz: 5fe93360f4980550e766cffc5b7c0ad6ae00124fa818cfd6ac4ba6b6eb2bf445
 SHA512:
-  metadata.gz: d3c2ec778fb99af9427532d92404c60fef8a4e1f65342ab61b0925ade00849c9e151604e2bc2b3cf2d71877dbad840c017c581036e0dc22b1a307bafd06ae2f4
-  data.tar.gz: 787c614f6716d8cc8044821c1ff90ae1afebbe2731673adef5aef5150fa77a5e8d32d633f7367d2929620578d84ed6b6bb81e39367e422f017704d2b34cc65e0
+  metadata.gz: afdb479f21109aaf05b75d9ae2d0d783b347fe2cea4734e18ec01cabfe3129bba69cb36e444f9005d12bb153516097642147a3a464ee576f1b9866ce03030eaf
+  data.tar.gz: 9a41dd6a27fda08447e56b1c128971fec36057739fd48a802ac503af1078247addf9329fe4a9d9b2a839d3e827b39be60108f536f39633eb798152ef431cff8c

data/lib/pubid/nist/addendum.rb

@@ -0,0 +1,21 @@
+
+module Pubid::Nist
+  class Addendum < Identifier
+    def_delegators 'Pubid::Nist::Addendum', :type
+
+    attr_accessor :base
+
+    def initialize(base:, number: nil)
+      @number = number
+      @base = base
+    end
+
+    def self.type
+      { key: :add, title: "Addendum" }
+    end
+
+    def self.get_renderer_class
+      Renderer::Addendum
+    end
+  end
+end

data/lib/pubid/nist/edition.rb

@@ -1,26 +1,38 @@
 module Pubid::Nist
-  class Edition
-    attr_accessor :year, :month, :day, :parsed, :sequence
+  class Edition < Pubid::Core::Entity
+    attr_accessor :year, :month, :day, :parsed, :number
 
-    def initialize(parsed: nil, year: nil, month: nil, day: nil, sequence: nil)
+    def initialize(parsed: nil, year: nil, month: nil, day: nil, number: nil)
       @parsed = parsed
       @year = year
       @month = month
       @day = day
-      @sequence = sequence
+      @number = number
     end
 
-    def to_s
-      result = (@sequence && [@sequence]) || []
-      if @day
-        result << Date.new(@year, @month, @day).strftime("%Y%m%d")
-      elsif @month
-        result << Date.new(@year, @month).strftime("%Y%m")
-      elsif @year
-        result << Date.new(@year).strftime("%Y")
-      end
+    def to_s(format: :short)
 
-      result.join("-")
+      if format == :long
+        result = (@number && ["Edition #{@number}"]) || []
+        if @day
+          result << Date.new(@year, @month, @day).strftime("(%B %d, %Y)")
+        elsif @month
+          result << Date.new(@year, @month).strftime("(%B %Y)")
+        elsif @year
+          result << Date.new(@year).strftime("(%Y)")
+        end
+        result.join(" ")
+      else
+        result = (@number && [@number]) || []
+        if @day
+          result << Date.new(@year, @month, @day).strftime("%Y%m%d")
+        elsif @month
+          result << Date.new(@year, @month).strftime("%Y%m")
+        elsif @year
+          result << Date.new(@year).strftime("%Y")
+        end
+        result.join("-")
+      end
     end
   end
 end

data/lib/pubid/nist/identifier.rb

@@ -1,24 +1,31 @@
 # frozen_string_literal: true
 
 require "json"
+require "forwardable"
 
 UPDATE_CODES = YAML.load_file(File.join(File.dirname(__FILE__), "../../../update_codes.yaml"))
 
 module Pubid::Nist
   class Identifier < Pubid::Core::Identifier::Base
-    attr_accessor :serie, :code, :revision, :publisher, :version, :volume,
+    extend Forwardable
+    attr_accessor :series, :code, :revision, :publisher, :version, :volume,
                   :part, :addendum, :stage, :translation,
                   :edition, :supplement, :update,
                   :section, :appendix, :errata, :index, :insert
 
-    def initialize(publisher: "NIST", serie:, number: nil, stage: nil, supplement: nil,
-                   edition_month: nil, edition_year: nil, edition_day: nil, update: nil, **opts)
-      @publisher = publisher.is_a?(Publisher) ? publisher : Publisher.new(publisher: publisher)
-      @serie = serie.is_a?(Serie) ? serie : Serie.new(serie: serie)
+    def initialize(publisher: "NIST", series:, number: nil, stage: nil, supplement: nil,
+                   edition_month: nil, edition_year: nil, edition_day: nil, update: nil,
+                   edition: nil, **opts)
+      @publisher = publisher.is_a?(Publisher) ? publisher : Publisher.new(publisher: publisher.to_s)
+      @series = series.is_a?(Series) ? series : Series.new(series: series)
       @code = number
       @stage = Stage.new(**stage) if stage
       @supplement = (supplement.is_a?(Array) && "") || supplement
-      @edition = parse_edition(edition_month, edition_year, edition_day) if edition_month || edition_year
+      if edition_month || edition_year
+        @edition = parse_edition(edition_month, edition_year, edition_day)
+      elsif edition
+        @edition = Edition.new(number: edition)
+      end
       @update = update
       opts.each { |key, value| send("#{key}=", value.to_s) }
     end
@@ -54,7 +61,7 @@ module Pubid::Nist
       document.instance_variables.each do |var|
         val = document.instance_variable_get(var)
         current_val = instance_variable_get(var)
-        if [:@serie, :@publisher].include?(var) ||
+        if [:@series, :@publisher].include?(var) ||
             (val && current_val.nil?) ||
             (val && current_val.to_s.length < val.to_s.length)
           instance_variable_set(var, val)
@@ -73,7 +80,7 @@ module Pubid::Nist
 
     # @param without_edition [Boolean] render pubid without rendering edition
     def to_s(format = :short, without_edition: false)
-      self.class.get_renderer_class.new(to_h).render(format: format, without_edition: without_edition)
+      self.class.get_renderer_class.new(to_h(deep: false)).render(format: format, without_edition: without_edition)
     end
 
     def to_json(*args)
@@ -98,11 +105,6 @@ module Pubid::Nist
         new(**opts)
       end
 
-      # def transform(params)
-      #   identifier_params = get_transformer_class.new.apply(params)
-      #
-      #   Identifier.create(**identifier_params)
-      # end
       def transform(params)
         # run transform through each element,
         # like running transformer.apply(number: 1) and transformer.apply(year: 1999)
@@ -114,11 +116,12 @@ module Pubid::Nist
           get_transformer_class.new.apply({ k => v }, params)
         end.inject({}, :merge)
 
+        if identifier_params[:addendum]
+          return Addendum.new(base: new(
+            **identifier_params.dup.tap { |h| h.delete(:addendum) }
+          ), **identifier_params[:addendum])
+        end
 
-        # identifier_params = params.map do |k, v|
-        #   get_transformer_class.new.apply({k => v}, params).to_a.first
-        # end.compact.to_h
-        #
         new(**identifier_params)
       end
 
@@ -131,7 +134,7 @@ module Pubid::Nist
       end
 
       def get_renderer_class
-        Renderer
+        Renderer::Base
       end
     end
   end

data/lib/pubid/nist/nist_tech_pubs.rb

@@ -45,7 +45,13 @@ module Pubid::Nist
       def parse_docid(doc)
         id = doc.at("publisher_item/item_number", "publisher_item/identifier")
                &.text&.sub(%r{^/}, "")
-        doi = doc.at("doi_data/doi").text.gsub("10.6028/", "")
+        if id == "NBS BH 10"
+          # XXX: "doi" attribute is missing for doi_data
+          doi = "NBS.BH.10"
+        else
+          doi = doc.at("doi_data/doi").text.gsub("10.6028/", "")
+        end
+
         title = doc.at("titles/title").text
         title += " #{doc.at('titles/subtitle').text}" if doc.at("titles/subtitle")
         case doi

data/lib/pubid/nist/parser.rb

@@ -1,17 +1,12 @@
 module Pubid::Nist
-  class Parser < Parslet::Parser
+  class Parser < Pubid::Core::Parser
     attr_accessor :parsed
 
     rule(:series) do
-      ((SERIES["long"].keys
-                     .sort_by(&:length).reverse
-                     .flatten
-                     .reduce do |acc, s|
-          (acc.is_a?(String) ? str(acc) : acc) | str(s)
-        end).as(:series) |
-        (SERIES["mr"].values.reduce do |acc, s|
-          (acc.is_a?(String) ? str(acc) : acc) | str(s)
-        end).as(:series_mr)) >> any.repeat.as(:remaining)
+      (array_to_str(SERIES["long"].keys.sort_by(&:length).reverse.flatten).as(:series) |
+        array_to_str(SERIES["mr"].values).as(:series_mr) |
+        ((str("NBS") | str("NIST")).as(:publisher) >> (space | dot) >> array_to_str(SERIES["long"].keys.sort_by(&:length).reverse.flatten).as(:series))) >>
+        any.repeat.as(:remaining)
     end
 
     root(:series)
@@ -23,13 +18,24 @@ module Pubid::Nist
                else
                  SERIES["mr"].key(parsed[:series_mr].to_s)
                end
-      parser = find_parser(series)
-      parsed = parser.new.parse(parsed[:remaining].to_s)
-      parsed.is_a?(Array) ? parsed << { series: series } : parsed.merge({ series: series })
+      publisher = parsed[:publisher]
+      parser = find_parser(publisher, series)
+      begin
+        parsed = parser.new.parse(parsed[:remaining].to_s)
+      rescue Parslet::ParseFailed
+        # for PubID 1.0 identifier series specific parser might fail,
+        # so parse using Default parser which is comply with PubID 1.0
+        parsed = Parsers::Default.new.parse(parsed[:remaining].to_s)
+      end
+      if publisher
+        parsed.is_a?(Array) ? parsed << { series: series, publisher: publisher } : parsed.merge({ series: series, publisher: publisher })
+      else
+        parsed.is_a?(Array) ? parsed << { series: series } : parsed.merge({ series: series })
+      end
     end
 
-    def find_parser(series)
-      PARSERS_CLASSES[series] || Pubid::Nist::Parsers::Default
+    def find_parser(publisher, series)
+      PARSERS_CLASSES[series] || PARSERS_CLASSES["#{publisher} #{series}"] || Pubid::Nist::Parsers::Default
     end
   end
 end

data/lib/pubid/nist/parsers/{nbs_circ.rb → circ.rb}

@@ -1,9 +1,9 @@
 module Pubid::Nist
   module Parsers
-    class NbsCirc < Default
+    class Circ < Default
       rule(:revision) do
         ((str("rev") >> (words >> year_digits).as(:revision)) |
-          (str("r") >> digits.as(:revision))
+          (str("r") >> (digits | (words >> year_digits)).as(:revision))
         )
       end
 

data/lib/pubid/nist/parsers/{nbs_crpl.rb → crpl.rb}

@@ -1,12 +1,12 @@
 module Pubid::Nist
   module Parsers
-    class NbsCrpl < Default
+    class Crpl < Default
       rule(:first_report_number) do
-        (digits >> str("-m").maybe).as(:first_report_number)
+        (digits >> (str("-m") | str("-M")).maybe).as(:first_report_number)
       end
 
       rule(:part) do
-        str("_") >> (digits >> str("-") >> digits).as(:part)
+        (str("_") | str("pt")) >> (digits >> str("-") >> digits).as(:part)
       end
 
       rule(:supplement) do

data/lib/pubid/nist/parsers/{nbs_csm.rb → csm.rb}

@@ -1,11 +1,11 @@
 module Pubid::Nist
   module Parsers
-    class NbsCsm < Default
+    class Csm < Default
       rule(:identifier) do
         (str(" ") | str(".")) >> report_number.maybe >> parts.repeat.as(:parts)
       end
 
-      rule(:part_prefixes) { str("n") }
+      rule(:part_prefixes) { str("n") | str("pt") }
     end
   end
 end

data/lib/pubid/nist/parsers/default.rb

@@ -19,11 +19,11 @@ module Pubid::Nist
       end
 
       rule(:supplement) do
-        (str("supp") | str("sup")) >> match('\d').repeat.as(:supplement)
+        (str("supp") | str("sup")) >> match('[A-Z\d]').repeat.as(:supplement)
       end
 
       rule(:errata) do
-        str("-").maybe >> str("errata").as(:errata)
+        str("-").maybe >> (str("errata") | str("err")).as(:errata)
       end
 
       rule(:index) do
@@ -40,7 +40,7 @@ module Pubid::Nist
       end
 
       rule(:stage) do
-        (space >> (array_to_str(STAGES["id"].keys + STAGES["id"].keys.map(&:upcase)).as(:id) >>
+        ((space | dot) >> (array_to_str(STAGES["id"].keys + STAGES["id"].keys.map(&:upcase)).as(:id) >>
           array_to_str(STAGES["type"].keys + STAGES["type"].keys.map(&:upcase)).as(:type)).as(:stage))
       end
 
@@ -68,7 +68,7 @@ module Pubid::Nist
       rule(:part_prefixes) { str("pt") | str("p") }
 
       rule(:part) do
-        part_prefixes >> digits.as(:part)
+        part_prefixes >> (digits >> (str("-") >> digits).maybe).as(:part)
       end
 
       rule(:revision) do
@@ -99,7 +99,8 @@ module Pubid::Nist
       end
 
       rule(:addendum) do
-        (str("-add") | str(".add-1")).as(:addendum)
+        (str("-add") | str(".add") | str(" Add.")) >>
+          (str(" ") | str("-")).maybe >> (digits | str("")).as(:number).as(:addendum)
       end
 
       rule(:section) do

data/lib/pubid/nist/parsers/fips.rb

@@ -1,8 +1,15 @@
-require_relative "nbs_fips"
-
 module Pubid::Nist
   module Parsers
-    class Fips < NbsFips
+    class Fips < Default
+      rule(:edition) do
+        str("-") >> (
+          (month_letters.as(:edition_month) >> year_digits.as(:edition_year)) |
+            year_digits.as(:edition_year) |
+          (month_letters.as(:edition_month) >> match('\d').repeat(2, 2).as(:edition_day) >>
+            str("/") >> year_digits.as(:edition_year))
+        ) |
+        (str("e") >> year_digits.as(:edition_year) >> month_digits.as(:edition_month).maybe)
+      end
     end
   end
 end

data/lib/pubid/nist/parsers/{nist_gcr.rb → gcr.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NistGcr < Default
+    class Gcr < Default
       rule(:report_number) do
         (digits >>
           str("-") >> digits >> (str("-") >> digits).maybe).as(:report_number)

data/lib/pubid/nist/parsers/{nbs_hb.rb → hb.rb}

@@ -1,15 +1,7 @@
 module Pubid::Nist
   module Parsers
-    class NbsHb < Default
-      # found patterns:
-      # 44e2-1955 -> 44e2
-      # 146v1-1991
-      # 105-1-1990 -> 105-1e1990
-      # 111r1977 / 146v1
-      # 130-1979 -> 130e1979
-      # 105-8 -> 105-8
-      # 28supp1957pt1
-      # 67suppFeb1965
+    class Hb < Default
+      rule(:number_suffix) { match("[a-zA-Z]") }
 
       rule(:edition) do
         (str("supp") >> str("").as(:supplement) >>

data/lib/pubid/nist/parsers/{nbs_mp.rb → mp.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NbsMp < Default
+    class Mp < Default
       rule(:edition) do
         (str("e") >> digits.as(:edition)) | (str("(") >> digits.as(:edition) >> str(")"))
       end

data/lib/pubid/nist/parsers/{nist_ncstar.rb → ncstar.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NistNcstar < Default
+    class Ncstar < Default
       rule(:number_suffix) { match("[abcdefghijA-Z]") }
     end
   end

data/lib/pubid/nist/parsers/{nist_owmwp.rb → owmwp.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NistOwmwp < Default
+    class Owmwp < Default
       rule(:report_number) do
         digits_with_suffix.as(:first_report_number) >>
           (str("-") >> (digits_with_suffix >> (str("-") >> digits_with_suffix).maybe)

data/lib/pubid/nist/parsers/{nbs_rpt.rb → rpt.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NbsRpt < Default
+    class Rpt < Default
       rule(:report_number) do
         (month_letters >>
           str("-") >> (month_letters >> year_digits)).as(:report_number) |

data/lib/pubid/nist/parsers/{nist_sp.rb → sp.rb}

@@ -1,6 +1,6 @@
 module Pubid::Nist
   module Parsers
-    class NistSp < Default
+    class Sp < Default
       rule(:version) do
         (((str("ver") | str(" Ver. ") | str(" Version ")) >> (digits >> (str(".") >> digits).repeat).as(:version)) |
           (str("v") >>
@@ -50,10 +50,12 @@ module Pubid::Nist
       end
 
       rule(:volume) do
-        (str("v") | str(" Vol. ")) >> digits.as(:volume)
+        # hack for NBS SP 535v2a-l vs NBS SP 535v2m-z
+        # https://github.com/metanorma/pubid-nist/issues/98
+        (str("v") | str(" Vol. ")) >> (digits >> (str("a-l") | str("m-z")).maybe >> match("[A-Z]").repeat).as(:volume)
       end
 
-      rule(:part_prefixes) { str("pt") | str("p") | str(" Part ") }
+      rule(:part_prefixes) { str("pt") | str("p") | str("P") | str(" Part ") }
     end
   end
 end

data/lib/pubid/nist/parsers/tn.rb

@@ -0,0 +1,17 @@
+module Pubid::Nist
+  module Parsers
+    class Tn < Default
+      # rule(:report_number) do
+      #   first_report_number
+      # end
+
+      rule(:edition_prefixes) do
+        str("-") | str("e")
+      end
+
+      rule(:second_report_number) do
+        year_digits.absent? >> (digits_with_suffix | str("A")).as(:second_report_number)
+      end
+    end
+  end
+end

data/lib/pubid/nist/publisher.rb

@@ -2,7 +2,7 @@ PUBLISHERS = YAML.load_file(File.join(File.dirname(__FILE__),
                                       "../../../publishers.yaml"))
 
 module Pubid::Nist
-  class Publisher
+  class Publisher < Pubid::Core::Entity
     attr_accessor :publisher
 
     def initialize(publisher:)
@@ -17,10 +17,6 @@ module Pubid::Nist
       PUBLISHERS[format.to_s][@publisher]
     end
 
-    def ==(other)
-      other.publisher == @publisher
-    end
-
     def self.publishers_keys
       PUBLISHERS["long"].keys
     end

data/lib/pubid/nist/renderer/addendum.rb

@@ -0,0 +1,20 @@
+require_relative "base"
+
+module Pubid::Nist::Renderer
+  class Addendum < Base
+    def render_identifier(params, opts)
+       # = "%{base}" % params
+      result = params[:base].to_s(opts[:format])
+      case opts[:format]
+      when :long
+        "Addendum to #{result}"
+      when :abbrev
+        "Add. to #{result}"
+      when :short
+        "#{result} Add."
+      when :mr
+        "#{result}.add-1"
+      end
+    end
+  end
+end