pubid-nist 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac016ca575f6b9815da56cb9424c1ba9bce844f494822e8bf407d9bb51de4cd
-  data.tar.gz: 5fe93360f4980550e766cffc5b7c0ad6ae00124fa818cfd6ac4ba6b6eb2bf445
+  metadata.gz: a1a579d52c77ed138efc4352a7a1f52a9be517819ef79d816228bb7e5904495b
+  data.tar.gz: 5e1203bd61307d98fa6afe777023c844f95f5155fe3bd06b20d5fd211114421c
 SHA512:
-  metadata.gz: afdb479f21109aaf05b75d9ae2d0d783b347fe2cea4734e18ec01cabfe3129bba69cb36e444f9005d12bb153516097642147a3a464ee576f1b9866ce03030eaf
-  data.tar.gz: 9a41dd6a27fda08447e56b1c128971fec36057739fd48a802ac503af1078247addf9329fe4a9d9b2a839d3e827b39be60108f536f39633eb798152ef431cff8c
+  metadata.gz: 36c798beadee2c359302da93d7372e61008601993dd578b358bec059c91bd469b4e19223ecf31b511077eae1b9b2f5b5b947400c34a23e7c2a4c5abccd8118d3
+  data.tar.gz: b1451a7d681a2f7a2a345c390c731c031074f1a211136c13bc06eac34cd278bdf8e752cf64b35f391b8cfd0793fb0c5ee953515696fb81dd5ee982f554f5a871

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

@@ -0,0 +1,23 @@
+
+module Pubid::Nist
+  module Identifier
+    class Addendum < Base
+      def_delegators 'Pubid::Nist::Identifier::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
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "json"
+require "forwardable"
+
+UPDATE_CODES = YAML.load_file(File.join(File.dirname(__FILE__), "../../../../update_codes.yaml"))
+
+module Pubid::Nist
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      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", 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
+        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
+
+      def parse_edition(edition_month, edition_year, edition_day)
+        if edition_month
+          date = Date.parse("#{edition_day || '01'}/#{edition_month}/#{edition_year}")
+          if edition_day
+            Edition.new(month: date.month, year: date.year, day: date.day)
+          else
+            Edition.new(month: date.month, year: date.year)
+          end
+        else
+          Edition.new(year: edition_year.to_i)
+        end
+      end
+
+      # returns weight based on amount of defined attributes
+      def weight
+        instance_variables.inject(0) do |sum, var|
+          sum + (instance_variable_get(var).nil? ? 0 : 1)
+        end
+      end
+
+      def ==(other)
+        other.instance_variables.each do |var|
+          return false if instance_variable_get(var) != other.instance_variable_get(var)
+        end
+        true
+      end
+
+      def merge(document)
+        document.instance_variables.each do |var|
+          val = document.instance_variable_get(var)
+          current_val = instance_variable_get(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)
+          end
+        end
+
+        self
+      end
+
+      def self.update_old_code(code)
+        UPDATE_CODES.each do |from, to|
+          code = code.gsub(from.match?(/^\/.*\/$/) ? Regexp.new(from[1..-2]) : from, to)
+        end
+        code
+      end
+
+      # @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(deep: false)).render(format: format, without_edition: without_edition)
+      end
+
+      def to_json(*args)
+        result = {
+          styles: {
+            short: to_s(:short),
+            abbrev: to_s(:abbrev),
+            long: to_s(:long),
+            mr: to_s(:mr),
+          }
+        }
+
+        instance_variables.each do |var|
+          val = instance_variable_get(var)
+          result[var.to_s.gsub('@', '')] = val unless val.nil?
+        end
+        result.to_json(*args)
+      end
+
+      class << self
+        def create(**opts)
+          new(**opts)
+        end
+
+        def transform(params)
+          # run transform through each element,
+          # like running transformer.apply(number: 1) and transformer.apply(year: 1999)
+          # instead of running transformer on whole hash, like running transformer.apply({ number: 1, year: 1999 })
+          # where rule for number or year only will be not applied
+          # transformation only applied to rules matching the whole hash
+
+          identifier_params = params.map do |k, v|
+            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
+
+          new(**identifier_params)
+        end
+
+        def get_parser_class
+          Parser
+        end
+
+        def get_transformer_class
+          Transformer
+        end
+
+        def get_renderer_class
+          Renderer::Base
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifier.rb

@@ -1,140 +1,10 @@
-# 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
-    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", 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
-      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
-
-    def parse_edition(edition_month, edition_year, edition_day)
-      if edition_month
-        date = Date.parse("#{edition_day || '01'}/#{edition_month}/#{edition_year}")
-        if edition_day
-          Edition.new(month: date.month, year: date.year, day: date.day)
-        else
-          Edition.new(month: date.month, year: date.year)
-        end
-      else
-        Edition.new(year: edition_year.to_i)
-      end
-    end
-
-    # returns weight based on amount of defined attributes
-    def weight
-      instance_variables.inject(0) do |sum, var|
-        sum + (instance_variable_get(var).nil? ? 0 : 1)
-      end
-    end
-
-    def ==(other)
-      other.instance_variables.each do |var|
-        return false if instance_variable_get(var) != other.instance_variable_get(var)
-      end
-      true
-    end
-
-    def merge(document)
-      document.instance_variables.each do |var|
-        val = document.instance_variable_get(var)
-        current_val = instance_variable_get(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)
-        end
-      end
-
-      self
-    end
-
-    def self.update_old_code(code)
-      UPDATE_CODES.each do |from, to|
-        code = code.gsub(from.match?(/^\/.*\/$/) ? Regexp.new(from[1..-2]) : from, to)
-      end
-      code
-    end
-
-    # @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(deep: false)).render(format: format, without_edition: without_edition)
-    end
-
-    def to_json(*args)
-      result = {
-        styles: {
-          short: to_s(:short),
-          abbrev: to_s(:abbrev),
-          long: to_s(:long),
-          mr: to_s(:mr),
-        }
-      }
-
-      instance_variables.each do |var|
-        val = instance_variable_get(var)
-        result[var.to_s.gsub('@', '')] = val unless val.nil?
-      end
-      result.to_json(*args)
-    end
-
+  module Identifier
     class << self
-      def create(**opts)
-        new(**opts)
-      end
-
-      def transform(params)
-        # run transform through each element,
-        # like running transformer.apply(number: 1) and transformer.apply(year: 1999)
-        # instead of running transformer on whole hash, like running transformer.apply({ number: 1, year: 1999 })
-        # where rule for number or year only will be not applied
-        # transformation only applied to rules matching the whole hash
-
-        identifier_params = params.map do |k, v|
-          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
-
-        new(**identifier_params)
-      end
-
-      def get_parser_class
-        Parser
-      end
-
-      def get_transformer_class
-        Transformer
-      end
+      include Pubid::Core::Identifier
 
-      def get_renderer_class
-        Renderer::Base
+      def parse(*args)
+        Base.parse(*args)
       end
     end
   end

data/lib/pubid/nist/stage.rb

@@ -6,6 +6,9 @@ module Pubid::Nist
 
     def initialize(id:, type:)
       @id, @type = id.to_s.downcase, type.to_s.downcase
+
+      raise ArgumentError, "id cannot be #{id.inspect}" unless STAGES['id'].key?(@id)
+      raise ArgumentError, "type cannot be #{type.inspect}" unless STAGES['type'].key?(@type)
     end
 
     def to_s(format = :short)
@@ -20,9 +23,5 @@ module Pubid::Nist
         "(#{STAGES['id'][@id]} #{STAGES['type'][@type]})"
       end
     end
-
-    def nil?
-      @id.nil? && @type.nil?
-    end
   end
 end

data/lib/pubid/nist/version.rb

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

data/lib/pubid/nist.rb

@@ -10,6 +10,7 @@ module Pubid
   end
 end
 
+require_relative "nist/identifier"
 require_relative "nist/series"
 require_relative "nist/parsers/default"
 require_relative "nist/update"
@@ -29,10 +30,16 @@ end.map do |parser_class|
   [parser.name.split("::").last.gsub(/(.)([A-Z])/, '\1 \2').upcase, parser]
 end.to_h
 
-require_relative "nist/identifier"
+require_relative "nist/identifier/base"
 require_relative "nist/publisher"
 require_relative "nist/stage"
 require_relative "nist/errors"
 require_relative "nist/nist_tech_pubs"
 require_relative "nist/edition"
-require_relative "nist/addendum"
+require_relative "nist/identifier/addendum"
+
+config = Pubid::Core::Configuration.new
+config.stages = YAML.load_file(File.join(File.dirname(__FILE__), "../../stages.yaml"))
+config.default_type = Pubid::Nist::Identifier::Base
+config.types = [Pubid::Nist::Identifier::Addendum]
+Pubid::Nist::Identifier.set_config(config)

data/series.yaml

@@ -26,7 +26,7 @@ long:
   NCSTAR: National Construction Safety Team Act Reports
   NSRDS: National Standard Reference Data Series
   NSRDS-NBS: National Standard Reference Data Series
-  IR: Interagency or Internal Report
+  IR: IR
   OWMWP: Office of Weights and Measures White Papers
   PC: Photographic Laboratory Circulars
   RPT: Reports

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-nist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,10 +165,11 @@ 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/identifier/addendum.rb
+- lib/pubid/nist/identifier/base.rb
 - lib/pubid/nist/nist_tech_pubs.rb
 - lib/pubid/nist/parser.rb
 - lib/pubid/nist/parsers/circ.rb

data/lib/pubid/nist/addendum.rb

@@ -1,21 +0,0 @@
-
-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