pubid-nist 0.2.4 → 0.3.0

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

@@ -0,0 +1,202 @@
+module Pubid::Nist
+  module Renderer
+    class Base < Pubid::Core::Renderer::Base
+      def render_base_identifier(**opts)
+        prerender(**opts)
+
+        render_identifier(@prerendered_params, opts)
+      end
+
+      def render_identifier(params, opts)
+        case opts[:format]
+        when :short, :mr
+          "%{series}%{code}%{volume}%{part}%{edition}%{revision}%{version}"\
+          "%{supplement}%{section}%{appendix}%{errata}%{index}%{insert}%{update}"\
+          "%{stage}%{translation}" % params
+        else
+          "%{series}%{code}%{stage}%{volume}%{part}%{edition}%{revision}%{version}"\
+          "%{supplement}%{section}%{appendix}%{errata}%{index}%{insert}%{update}"\
+          "%{translation}" % params
+        end
+      end
+
+      def render_series(series, opts, params)
+        if series.to_s(opts[:format]).include?(params[:publisher].to_s(opts[:format]))
+          return series.to_s(opts[:format])
+        end
+
+        "#{params[:publisher].to_s(opts[:format])}" +
+          (opts[:format] == :mr ? "." : " ") +
+          "#{series.to_s(opts[:format])}"
+      end
+
+      def render_code(code, opts, _params)
+        (opts[:format] == :mr ? "." : " ") + code.to_s
+      end
+
+      def render_edition(edition, opts, _params)
+        return if opts[:without_edition]
+
+        case opts[:format]
+        when :long
+          " #{edition.to_s(format: :long)}"
+        when :abbrev
+          " Ed. " + edition.to_s
+        when :short, :mr
+          "e" + edition.to_s
+        end
+      end
+
+      def render_revision(revision, opts, _params)
+        case opts[:format]
+        when :long
+          ", Revision "
+        when :abbrev
+          ", Rev. "
+        when :short, :mr
+          "r"
+        end + (revision == '' ? '1' : revision).to_s
+      end
+
+      def render_version(version, opts, _params)
+        case opts[:format]
+        when :long
+          ", Version "
+        when :abbrev
+          ", Ver. "
+        when :short, :mr
+          "ver"
+        end + version
+      end
+
+      def render_volume(volume, opts, params)
+        case opts[:format]
+        when :long
+          ", Volume "
+        when :abbrev
+          ", Vol. "
+        when :short
+          params[:code] ? "v" : " v"
+        when :mr
+          params[:code] ? "v" : ".v"
+        end + volume
+      end
+
+      def render_update(update, opts, _params)
+        update_text = update.number.to_s
+        update_text += "-#{update.year}" if update.year
+        update_text += sprintf("%02d", update.month) if update.month
+
+        case opts[:format]
+        when :long
+          " Update #{update_text}"
+        when :abbrev
+          " Upd. #{update_text}"
+        when :short
+          "/Upd#{update_text}"
+        when :mr
+          ".u#{update_text}"
+        end
+      end
+
+      def render_translation(translation, opts, _params)
+        case opts[:format]
+        when :long, :abbrev
+          " (#{translation.upcase})"
+        when :mr
+          ".#{translation}"
+        when :short
+          " #{translation}"
+        end
+      end
+
+      def render_part(part, opts, _params)
+        case opts[:format]
+        when :long
+          " Part "
+        when :abbrev
+          " Pt. "
+        when :short, :mr
+          "pt"
+        end + part
+      end
+
+      def render_supplement(supplement, opts, _params)
+        case opts[:format]
+        when :long
+          " Supplement "
+        when :abbrev
+          " Suppl. "
+        when :short, :mr
+          "sup"
+        end + supplement
+      end
+
+      def render_appendix(appendix, opts, _params)
+        case opts[:format]
+        when :long
+          " Appendix "
+        when :abbrev
+          " App. "
+        when :short, :mr
+          "app"
+        end
+      end
+
+      def render_section(section, opts, _params)
+        case opts[:format]
+        when :long
+          " Section "
+        when :abbrev
+          " Sec. "
+        when :short, :mr
+          "sec"
+        end + section
+      end
+
+      def render_errata(errata, opts, _params)
+        case opts[:format]
+        when :long
+          " Errata "
+        when :abbrev
+          " Err. "
+        when :short, :mr
+          "err"
+        end
+      end
+
+      def render_index(index, opts, _params)
+        case opts[:format]
+        when :long
+          " Index "
+        when :abbrev
+          " Index. "
+        when :short, :mr
+          "indx"
+        end
+      end
+
+      def render_insert(insert, opts, _params)
+        case opts[:format]
+        when :long
+          " Insert "
+        when :abbrev
+          " Ins. "
+        when :short, :mr
+          "ins"
+        end
+      end
+
+      def render_stage(stage, opts, _params)
+        case opts[:format]
+        when :mr
+          "."
+        when :short
+          " "
+        else
+          " "
+        end + stage.to_s(opts[:format])
+      end
+    end
+  end
+end

data/lib/pubid/nist/series.rb

@@ -0,0 +1,30 @@
+SERIES = YAML.load_file(File.join(File.dirname(__FILE__), "../../../series.yaml"))
+
+module Pubid::Nist
+  class Series
+    attr_accessor :series, :parsed
+
+    def initialize(series:, parsed: nil)
+      raise Errors::SerieInvalidError, "#{series} is not valid series" unless SERIES["long"].key?(series)
+
+      @series = series
+      @parsed = parsed
+    end
+
+    def to_s(format = :short)
+      # return SERIES["abbrev"][@serie] ||
+      return @series if format == :short
+
+      result = SERIES[format.to_s][@series]
+      return @series if result.nil? && format == :mr
+
+      return SERIES["long"][@series] if result.nil?
+
+      result
+    end
+
+    def ==(other)
+      other.series == @series
+    end
+  end
+end

data/lib/pubid/nist/stage.rb

@@ -1,7 +1,7 @@
 STAGES = YAML.load_file(File.join(File.dirname(__FILE__), "../../../stages.yaml"))
 
 module Pubid::Nist
-  class Stage
+  class Stage < Pubid::Core::Entity
     attr_accessor :id, :type
 
     def initialize(id:, type:)
@@ -17,7 +17,7 @@ module Pubid::Nist
       when :mr
         "#{@id}#{@type}"
       else
-        "#{STAGES['id'][@id]} #{STAGES['type'][@type]}"
+        "(#{STAGES['id'][@id]} #{STAGES['type'][@type]})"
       end
     end
 

data/lib/pubid/nist/transformer.rb

@@ -10,8 +10,16 @@ module Pubid::Nist
     end
 
     rule(series: subtree(:series)) do |context|
-      { serie: Serie.new(serie: context[:series].to_s.gsub(".", " ")),
-        publisher: Publisher.parse(context[:series]) }
+      if context[:publisher]
+        if context[:series]
+          { series: Series.new(series: context[:series].to_s.gsub(".", " ")) }
+        else
+          {}
+        end
+      else
+        { series: Series.new(series: context[:series].to_s.gsub(".", " ")),
+          publisher: Publisher.parse(context[:series]) }
+      end
     end
 
     # remove :second_report_number from output

data/lib/pubid/nist/update.rb

@@ -1,5 +1,5 @@
 module Pubid::Nist
-  class Update
+  class Update < Pubid::Core::Entity
     attr_accessor :number, :year, :month
 
     def initialize(number: nil, year: nil, month: nil)

data/lib/pubid/nist/version.rb

@@ -1,5 +1,5 @@
 module Pubid
   module Nist
-    VERSION = "0.2.4".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/lib/pubid/nist.rb

@@ -10,12 +10,13 @@ module Pubid
   end
 end
 
-require_relative "nist/serie"
+require_relative "nist/series"
 require_relative "nist/parsers/default"
 require_relative "nist/update"
 require_relative "nist/transformer"
 require_relative "nist/parser"
-require_relative "nist/renderer"
+require_relative "nist/renderer/base"
+require_relative "nist/renderer/addendum"
 
 Dir[File.join(__dir__, 'nist/parsers', '*.rb')].each do |file|
   require file
@@ -34,3 +35,4 @@ require_relative "nist/stage"
 require_relative "nist/errors"
 require_relative "nist/nist_tech_pubs"
 require_relative "nist/edition"
+require_relative "nist/addendum"

data/series.yaml

@@ -1,137 +1,115 @@
 long:
-  NIST AMS: Advanced Manufacturing Standard
-  NIST BSS: Building Science Series
-  NBS BSS: Building Science Series
-  NBS BMS: Building Material Structures Report
+  AMS: Advanced Manufacturing Series
+  BSS: Building Science Series
+  BMS: Building Material Structures Report
   NBS BRPD-CRPL-D: Basic Radio Propagation Predictions Series
-  NBS BH: Building and Housing Reports
-  NBS CRPL: Central Radio Propagation Laboratory Reports
+  BH: Building and Housing
+  CRPL: Central Radio Propagation Laboratory Reports
   NBS CRPL-F-A: CRPL Ionospheric Data
   NBS CRPL-F-B: CRPL Solar-Geophysical Data
   NBS IP: CRPL Ionospheric Predictions
-  NBS CIRC: Circulars
+  CIRC: Circulars
   NBS CIS: Consumer Information Series
-  NBS CS: Commercial Standards
+  CS: Commercial Standards
   NBS CS-E: Commercial Standards (emergency)
-  NBS CSM: Commercial Standards Monthly
-  NBS FIPS: Federal Information Processing Standards Publication
+  CSM: Commercial Standards Monthly
   FIPS: Federal Information Processing Standards Publication
-  NIST GCR: Grant/Contract Reports
-  NBS GCR: Grant/Contract Reports
-  NIST HB: Handbook
-  NBS HB: Handbook
+  GCR: Grant/Contract Reports
+  HB: Handbooks
   NBS HR: Hydraulic Research in the United States
   NBS IRPL: Interservice Radio Propagation Laboratory
   ITL Bulletin: ITL Bulletin
   NIST LC: Letter Circular
   NBS LC: Letter Circular
-  NIST MN: Monograph
-  NBS MN: Monograph
-  NBS MP: Miscellaneous Publications
-  NIST NCSTAR: National Construction Safety Team Report
-  NIST NSRDS: National Standard Reference Data Series
+  MONO: Monograph
+  MP: Miscellaneous Publications
+  NCSTAR: National Construction Safety Team Act Reports
+  NSRDS: National Standard Reference Data Series
   NSRDS-NBS: National Standard Reference Data Series
-  NIST IR: Interagency or Internal Report
-  NBS IR: Interagency or Internal Report
-  NIST OWMWP: Office of Weights and Measures White Papers
-  NBS PC: Photographic Circulars
-  NBS RPT: Reports
+  IR: Interagency or Internal Report
+  OWMWP: Office of Weights and Measures White Papers
+  PC: Photographic Laboratory Circulars
+  RPT: Reports
   NIST PS: Voluntary Product Standards
-  NBS SIBS: Special Interior Ballistics Studies
+  SIBS: Special Interior Ballistics Studies
   NBS PS: Voluntary Product Standards
-  NIST SP: Special Publication
-  NBS SP: Special Publication
-  NIST TN: Technical Note
-  NBS TN: Technical Note
-  NBS TIBM: Technical Information on Building Materials
-  NIST TTB: Technology Transfer Brief
+  SP: Special Publication
+  TN: Technical Notes
+  TIBM: Technical Information on Building Materials for Use in the Design of Low Cost Housing
+  TTB: Technology Transfer Briefs
   NIST DCI: Data Collection Instruments
-  NIST EAB: Economic Analysis Brief
+  EAB: Economic Analysis Brief
   NIST Other: Other
-  CSRC White Paper: Cybersecurity Resource Center White Paper
+  CSWP: Cybersecurity White Papers
   CSRC Book: Cybersecurity Resource Center Book
   CSRC Use Case: Cybersecurity Resource Center Use Case
   CSRC Building Block: Cybersecurity Resource Center Building Block
   JPCRD: Journal of Physical and Chemical Reference Data
   JRES: Journal of Research of NIST
 abbrev:
-  NIST AMS: Adv. Man. Ser
-  NIST BSS: Bldg. Sci. Ser.
-  NBS BSS: Bldg. Sci. Ser.
-  NBS FIPS: Federal Inf. Process. Stds.
+  AMS: Adv. Man. Ser
+  BSS: Bldg. Sci. Ser.
   FIPS: Federal Inf. Process. Stds.
-  NIST HB: Handb.
-  NBS HB: Handb.
-  NIST MN: Monogr.
-  NBS MN: Monogr.
-  NIST NCSTAR: Natl. Constr. Tm. Act Rpt.
-  NIST NSRDS: Natl. Stand. Ret. Data Ser.
+  HB: Handb.
+  MONO: Monogr.
+  NCSTAR: Natl. Constr. Tm. Act Rpt.
+  NSRDS: Natl. Stand. Ret. Data Ser.
   NSRDS-NBS: Natl. Stand. Ret. Data Ser.
   NIST PS: Prod. Stand.
   NBS PS: Prod. Stand.
-  NIST SP: Spec. Publ.
-  NBS SP: Spec. Publ.
-  NIST TN: Tech. Note
-  NBS TN: Tech. Note
+  SP: Spec. Publ.
+  TN: Tech. Note
   NIST DCI: Data Collect. Instr.
   NIST Other: Other
-  CSRC White Paper: CSWP
+  CSWP: CSWP
   CSRC Book: CSRC Book
   CSRC Use Case: CSRC Use Case
   CSRC Building Block: CSRC Building Block
   JPCRD: J. Phys. & Chem. Ref. Data
   JRES: J. Res. Natl. Inst. Stan.
 mr:
-  NIST AMS: NIST.AMS
-  NIST BSS: NIST.BSS
-  NBS BSS: NBS.BSS
-  NBS BMS: NBS.BMS
+  AMS: AMS
+  BSS: BSS
+  BMS: BMS
   NBS BRPD-CRPL-D: NBS.BRPD-CRPL-D
-  NBS BH: NBS.BH
-  NBS CRPL: NBS.CRPL
+  BH: BH
+  CRPL: CRPL
   NBS CRPL-F-A: NBS.CRPL-F-A
   NBS CRPL-F-B: NBS.CRPL-F-B
   NBS IP: NBS.IP
-  NBS CIRC: NBS.CIRC
+  CIRC: CIRC
   NBS CIS: NBS.CIS
-  NBS CS: NBS.CS
+  CS: CS
   NBS CS-E: NBS.CS-E
-  NBS CSM: NBS.CSM
-  NBS FIPS: NBS.FIPS
-  FIPS: NIST.FIPS
-  NIST GCR: NIST.GCR
-  NBS GCR: NBS.GCR
-  NIST HB: NIST.HB
-  NBS HB: NBS.HB
+  CSM: CSM
+  FIPS: FIPS
+  GCR: GCR
+  HB: HB
   NBS HR: NBS.HR
   NBS IRPL: NBS.IRPL
   ITL Bulletin: NIST.ITLB
   NIST LC: NIST.LC
   NBS LC: NBS.LC
-  NIST MN: NIST.MN
-  NBS MN: NBS.MN
-  NBS MP: NBS.MP
-  NIST NCSTAR: NIST.NCSTAR
-  NIST NSRDS: NIST.NSRDS
+  MONO: MN
+  MP: MP
+  NCSTAR: NCSTAR
+  NSRDS: NSRDS
   NSRDS-NBS: NBS.NSRDS
-  NIST IR: NIST.IR
-  NBS IR: NBS.IR
-  NIST OWMWP: NIST.OWMWP
-  NBS PC: NBS.PC
-  NBS RPT: NBS.RPT
+  IR: IR
+  OWMWP: OWMWP
+  PC: PC
+  RPT: RPT
   NIST PS: NIST.PS
-  NBS SIBS: NBS.SIBS
+  SIBS: SIBS
   NBS PS: NBS.PS
-  NIST SP: NIST.SP
-  NBS SP: NBS.SP
-  NIST TN: NIST.TN
-  NBS TN: NBS.TN
-  NBS TIBM: NBS.TIBM
-  NIST TTB: NIST.TTB
+  SP: SP
+  TN: TN
+  TIBM: TIBM
+  TTB: TTB
   NIST DCI: NIST.DCI
-  NIST EAB: NIST.EAB
+  EAB: EAB
   NIST Other: NIST.O
-  CSRC White Paper: NIST.CSWP
+  CSWP: CSWP
   CSRC Book: NIST.CSB
   CSRC Use Case: NIST.CSUC
   CSRC Building Block: NIST.CSBB

data/update_codes.yaml

@@ -1,15 +1,15 @@
-NBS MONO: NBS MN
-NIST MONO: NIST MN
+NBS MN: NBS MONO
+NIST MN: NIST MONO
 NIST MP: NBS MP
 NIST SP 260-162 2006ed.: NIST SP 260-162e2006
 NBS CIRC 154suprev: NBS CIRC 154r1sup
 NBS CIRC supJun1925-Jun1926: NBS CIRC 24e7sup2
 NBS CIRC supJun1925-Jun1927: NBS CIRC 24e7sup3
-NBS CIRC sup: NBS CIRC 24e7sup
+/^NBS CIRC sup$/: NBS CIRC 24e7sup
 NBS CIRC e2: NBS CIRC 2e2
 NBS CIRC 25sup-1924: NBS CIRC 25sup
 NIST SP 260-126 rev 2013: NIST SP 260-126r2013
-NIST CSWP: CSRC White Paper
+NIST CSRC White Paper: NIST CSWP
 NIST SP 800-56ar: NIST SP 800-56Ar1
 NIST.LCIRC: NIST.LC
 NBS.LCIRC: NBS.LC

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-nist
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.3
+        version: 1.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.3
+        version: 1.12.2
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -165,36 +165,32 @@ files:
 - exe/pubid-nist
 - lib/pubid-nist.rb
 - lib/pubid/nist.rb
+- lib/pubid/nist/addendum.rb
 - lib/pubid/nist/edition.rb
 - lib/pubid/nist/errors.rb
 - lib/pubid/nist/identifier.rb
 - lib/pubid/nist/nist_tech_pubs.rb
 - lib/pubid/nist/parser.rb
+- lib/pubid/nist/parsers/circ.rb
+- lib/pubid/nist/parsers/crpl.rb
+- lib/pubid/nist/parsers/csm.rb
 - lib/pubid/nist/parsers/default.rb
 - lib/pubid/nist/parsers/fips.rb
-- lib/pubid/nist/parsers/nbs_bh.rb
-- lib/pubid/nist/parsers/nbs_circ.rb
-- lib/pubid/nist/parsers/nbs_crpl.rb
-- lib/pubid/nist/parsers/nbs_csm.rb
-- lib/pubid/nist/parsers/nbs_fips.rb
-- lib/pubid/nist/parsers/nbs_hb.rb
+- lib/pubid/nist/parsers/gcr.rb
+- lib/pubid/nist/parsers/hb.rb
+- lib/pubid/nist/parsers/mp.rb
 - lib/pubid/nist/parsers/nbs_ir.rb
 - lib/pubid/nist/parsers/nbs_lc.rb
-- lib/pubid/nist/parsers/nbs_mn.rb
-- lib/pubid/nist/parsers/nbs_mp.rb
-- lib/pubid/nist/parsers/nbs_rpt.rb
-- lib/pubid/nist/parsers/nbs_sp.rb
-- lib/pubid/nist/parsers/nbs_tn.rb
-- lib/pubid/nist/parsers/nist_gcr.rb
-- lib/pubid/nist/parsers/nist_hb.rb
+- lib/pubid/nist/parsers/ncstar.rb
 - lib/pubid/nist/parsers/nist_ir.rb
-- lib/pubid/nist/parsers/nist_ncstar.rb
-- lib/pubid/nist/parsers/nist_owmwp.rb
-- lib/pubid/nist/parsers/nist_sp.rb
-- lib/pubid/nist/parsers/nist_tn.rb
+- lib/pubid/nist/parsers/owmwp.rb
+- lib/pubid/nist/parsers/rpt.rb
+- lib/pubid/nist/parsers/sp.rb
+- lib/pubid/nist/parsers/tn.rb
 - lib/pubid/nist/publisher.rb
-- lib/pubid/nist/renderer.rb
-- lib/pubid/nist/serie.rb
+- lib/pubid/nist/renderer/addendum.rb
+- lib/pubid/nist/renderer/base.rb
+- lib/pubid/nist/series.rb
 - lib/pubid/nist/stage.rb
 - lib/pubid/nist/transformer.rb
 - lib/pubid/nist/update.rb

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

@@ -1,6 +0,0 @@
-module Pubid::Nist
-  module Parsers
-    class NbsBh < Default
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-module Pubid::Nist
-  module Parsers
-    class NbsFips < 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))
-        )
-      end
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-module Pubid::Nist
-  module Parsers
-    class NbsMn < Default
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Pubid::Nist
-  module Parsers
-    class NbsSp < Default
-      rule(:part_prefixes) do
-        str("p") | str("P")
-      end
-
-      rule(:volume) do
-        str("v") >> (match('[\da-z-]').repeat(1) >> match("[A-Z]").repeat).as(:volume)
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-module Pubid::Nist
-  module Parsers
-    class NbsTn < Default
-      rule(:second_report_number) do
-        (digits_with_suffix | str("A")).as(:second_report_number)
-      end
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-require_relative "nbs_hb"
-
-module Pubid::Nist
-  module Parsers
-    class NistHb < NbsHb
-      rule(:number_suffix) { match("[a-zA-Z]") }
-    end
-  end
-end