pubid 1.15.21 → 2.0.0.alpha.10

data/lib/pubid/nist/identifiers/internal_report.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NIST Interagency Report (IR) / NISTIR
+      # Examples:
+      # - "NIST IR 8115" = Interagency Report 8115
+      # - "NIST IR 8115r1" = Interagency Report 8115 revision 1
+      # - "NBS IR 73-197" = NBS Interagency Report 73-197
+      class InteragencyReport < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["IR", "NIST IR", "NBS IR"],
+            stage_code: "published",
+            type_code: "ir",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :ir,
+            web: :interagency_report, title: "NIST Interagency Report", short: "IR" }
+          end
+        end
+
+        def series_code
+          "IR"
+        end
+
+        # Override to_s to normalize MR input to short format by default
+        # But allow explicit format requests (e.g., format: :mr)
+        # @param format [Symbol, Hash, nil] output format
+        # @return [String] formatted identifier
+        def to_s(format = nil)
+          # `super` is handed a SYMBOL below, so the base's annotation hook
+          # never sees the flag. Capture it here and wrap what comes back —
+          # exactly once, because the base returned plain text.
+          annotated = format.is_a?(Hash) ? format[:annotated] : nil
+
+          # Handle both keyword argument (hash) and positional argument (symbol/string)
+          effective_format = if format.is_a?(Hash)
+                               format[:format]
+                             else
+                               format
+                             end
+
+          # If explicit format is specified, use it. Otherwise, default to short.
+          rendered = if effective_format.nil?
+                       super(:short)
+                     else
+                       super(effective_format)
+                     end
+
+          annotate_plain_render(rendered, annotated: annotated)
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/letter_circular.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NBS LC (Letter Circular)
+      # Examples:
+      # - "NBS LC 378" - Basic letter circular
+      # - "NBS LCIRC 378g" - With LCIRC variant, letter suffix
+      # - "NBS LC 378G" - Letter suffix uppercase
+      # - "NBS LC 378sup12/1926" - With supplement date
+      # - "NBS LC 378r11/1925" - With revision date
+      # - "NBS LC 378(sp)" - With language code
+      class LetterCircular < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["LCIRC"], # Single definition of truth
+            stage_code: "published",
+            type_code: "lc",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :lc,
+            web: :letter_circular, title: "Letter Circular", short: "LCIRC" }
+          end
+        end
+
+        def default_publisher
+          "NBS"
+        end
+
+        # series_code returns the normalized series name for rendering
+        # LCIRC normalizes to LC for standard rendering
+        def series_code
+          "LC"
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/miscellaneous_publication.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NBS MP (Miscellaneous Publication) Identifier
+      # Examples:
+      # - "NBS MP 39e1" - Edition with "e" notation
+      # - "NBS MP 260e1965" - Edition with year as edition ID
+      # NOTE: Parenthetical edition format (e.g., "39(1)") does NOT exist for MP identifiers
+      class MiscellaneousPublication < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["MP", "NBS MP"],
+            stage_code: "published",
+            type_code: "mp",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :mp,
+            web: :miscellaneous_publication, title: "Miscellaneous Publication", short: "MP" }
+          end
+        end
+
+        def default_publisher
+          "NBS"
+        end
+
+        def series_code
+          "MP"
+        end
+
+        # A caller passing `annotated:` reaches this positional parameter as a
+        # Hash — Ruby converts keywords for a method that accepts none. The same
+        # idiom `Identifiers::Base#to_s` uses.
+        def to_s(format = :short)
+          annotated = format.is_a?(Hash) ? format[:annotated] : nil
+          format = format[:format] || :short if format.is_a?(Hash)
+
+          rendered = case format
+                     when :mr
+                       to_mr_style
+                     else
+                       to_short_style
+                     end
+
+          annotate_plain_render(rendered, annotated: annotated)
+        end
+
+        public
+
+        def to_short_style
+          result = "#{default_publisher} #{series_code}"
+          result += " #{number.value}" if number
+          result += append_short_components
+          result
+        end
+
+        def to_mr_style
+          result = "#{default_publisher}.#{series_code}"
+          result += ".#{number.value}" if number
+          result += append_mr_components
+          result
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/monograph.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NBS/NIST MONO (Monograph) Identifier
+      # Examples:
+      # - "NBS MONO 158" - Basic monograph
+      # - "NIST MONO 178" - NIST monograph
+      # - "NBS MONO 128pt1" - Monograph with part
+      # - "NIST MONO 1-1F" - Monograph with letter suffix
+      # - "NIST MONO 1-2Bv1" - Monograph with letter suffix and volume
+      class Monograph < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["MONO", "NBS MONO", "NIST MONO"],
+            stage_code: "published",
+            type_code: "mono",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :mono,
+            web: :monograph, title: "Monograph", short: "MONO" }
+          end
+        end
+
+        def series_code
+          "MONO"
+        end
+
+        def to_s(format = nil)
+          # `super` is handed a SYMBOL below, so the base's annotation hook
+          # never sees the flag. Capture it here and wrap what comes back —
+          # exactly once, because the base returned plain text.
+          annotated = format.is_a?(Hash) ? format[:annotated] : nil
+
+          # Handle both keyword argument (hash) and positional argument (symbol/string)
+          effective_format = if format.is_a?(Hash)
+                               format[:format]
+                             else
+                               format
+                             end
+
+          # If explicit format is specified, use it. Otherwise, default to short.
+          rendered = if effective_format.nil?
+                       super(:short)
+                     elsif effective_format == :mr
+                       to_mr_style
+                     else
+                       super(effective_format)
+                     end
+
+          annotate_plain_render(rendered, annotated: annotated)
+        end
+
+        private
+
+        def to_mr_style
+          # "NBS.MN.158" or "NIST.MN.1-1b" (per NIST PubID spec, page 36)
+          # Note: MR format uses MN, not MONO (MONO is for human-readable only)
+          result = (publisher || default_publisher).to_s
+          result += ".MN" # MR format uses MN per spec
+          result += ".#{number}" if number
+          # Append the shared component tail (part, volume, supplement,
+          # edition, ...) so distinct monographs do not collide. Letter-suffix
+          # variants (e.g. "1-1F") carry the letter inside the compound number
+          # and have no separate Part component, so this does not double them.
+          result += append_mr_components
+          result
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/ncstar.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NIST NCSTAR (National Construction Safety Team Act Reports)
+      # Examples:
+      # - "NIST NCSTAR 1-1Cv1" → "NIST NCSTAR 1-1Cv1" (round-trips)
+      # - "NIST NCSTAR 1-1b" → "NIST NCSTAR 1-1B" (normalizes letter)
+      # - "NIST NCSTAR 1-1cv1" → "NIST NCSTAR 1-1Cv1" (normalizes letter, keeps v1 format)
+      class Ncstar < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["NCSTAR", "NIST NCSTAR"],
+            stage_code: "published",
+            type_code: "ncstar",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :ncstar,
+              title: "National Construction Safety Team Act Reports", short: "NCSTAR" }
+          end
+        end
+
+        def series_code
+          "NCSTAR"
+        end
+
+        # NCSTAR-specific: do NOT expand Cv patterns to ", Volume" format
+        # The base class would render "1-1Cv1" as is, which is correct for NCSTAR
+        # No custom rendering needed - just inherit from Identifier
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/nsrds.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NBS NSRDS (National Standard Reference Data Series)
+      # Examples:
+      # - "NBS NSRDS 1" - Basic NSRDS
+      # - "NSRDS-NBS 1" - With hyphen prefix
+      # - "NBS NSRDS 1p1" - With part notation
+      class Nsrds < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["NSRDS", "NBS NSRDS"],
+            stage_code: "published",
+            type_code: "nsrds",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :nsrds, title: "National Standard Reference Data Series",
+              short: "NSRDS" }
+          end
+        end
+
+        def default_publisher
+          "NBS"
+        end
+
+        def series_code
+          "NSRDS"
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/owmwp.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NIST OWMWP (Office of Weights and Measures Workshop Proceedings)
+      # Examples:
+      # - "NIST OWMWP 06-13-2018" - Date-based format MM-DD-YYYY
+      class Owmwp < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["OWMWP", "NIST OWMWP"],
+            stage_code: "published",
+            type_code: "owmwp",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :owmwp,
+              title: "Office of Weights and Measures Workshop Proceedings", short: "OWMWP" }
+          end
+        end
+
+        def series_code
+          "OWMWP"
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/report.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NBS RPT (Report) Identifier
+      # Examples:
+      # - "NBS RPT 8079" - Basic report
+      # - "NBS RPT 9350sup" - Report with supplement
+      # - "NBS RPT Oct-Dec1950" - Report with date range
+      # - "NBS RPT ADHOC" - Ad hoc report
+      # - "NBS RPT div9" - Division report
+      # - "NBS RPT 4817-A" - Report with letter suffix
+      class Report < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["RPT", "NBS RPT"],
+            stage_code: "published",
+            type_code: "rpt",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :rpt,
+            web: :report, title: "NBS Report", short: "RPT" }
+          end
+        end
+
+        def default_publisher
+          "NBS"
+        end
+
+        def series_code
+          "RPT"
+        end
+
+        # A caller passing `annotated:` reaches this positional parameter as a
+        # Hash — Ruby converts keywords for a method that accepts none. The same
+        # idiom `Identifiers::Base#to_s` uses.
+        def to_s(format = :short)
+          annotated = format.is_a?(Hash) ? format[:annotated] : nil
+          format = format[:format] || :short if format.is_a?(Hash)
+
+          rendered = case format
+                     when :mr
+                       to_mr_style
+                     else
+                       to_short_style
+                     end
+
+          annotate_plain_render(rendered, annotated: annotated)
+        end
+
+        private
+
+        def to_short_style
+          result = "#{default_publisher} #{series_code}"
+          result += " #{number}" if number
+          result += append_short_components
+          result
+        end
+
+        def to_mr_style
+          result = "#{default_publisher}.#{series_code}"
+          result += ".#{number}" if number
+          result += append_mr_components
+          result
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/special_publication.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NIST Special Publication (SP)
+      # Examples:
+      # - "NIST SP 800-53" = Special Publication 800-53
+      # - "NIST SP 800-53r5" = Special Publication 800-53 revision 5
+      # - "NIST SP 800-57pt1r4" = Special Publication 800-57 part 1 revision 4
+      class SpecialPublication < Identifier
+        # Per Appendix A.2 of the NIST PubID Syntax (April 2022), the SP series
+        # is subdivided into named subseries. The subseries number is the
+        # leading token of a report-num like "800-53" or "1190GB-12". The
+        # Builder exposes this as `identifier.subseries` so callers can query
+        # which subseries a document belongs to.
+        SP_SUBSERIES = %w[
+          250 260 300 400 480 500 700 800 823 960 1190GB 1200 1500 1800 1900 2000 2100
+        ].freeze
+
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["SP", "NIST SP", "NBS SP"], # Compound series
+            stage_code: "published",
+            type_code: "sp",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :sp,
+            web: :special_publication, title: "NIST Special Publication", short: "SP" }
+          end
+        end
+
+        def series_code
+          "SP"
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers/technical_note.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      # NIST Technical Note (TN)
+      # Examples:
+      # - "NIST TN 1234" = Technical Note 1234
+      # - "NBS TN 567" = NBS Technical Note 567
+      class TechnicalNote < Identifier
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            abbr: ["TN", "NIST TN", "NBS TN"],
+            stage_code: "published",
+            type_code: "tn",
+          ),
+        ].freeze
+
+        class << self
+          def typed_stages
+            TYPED_STAGES
+          end
+
+          def type
+            { key: :tn,
+            web: :technical_note, title: "NIST Technical Note", short: "TN" }
+          end
+        end
+
+        def series_code
+          "TN"
+        end
+
+        # Override update_component setter to add default year for TN dash-prefix updates
+        def update_component=(value)
+          super
+
+          # TN-SPECIFIC: Add default year to "-upd" pattern (no year/month)
+          # Pattern: "NIST TN 2150-upd" → update gets default year=2021, month=02
+          if value && value.prefix == "dash" && !value.year
+            # Create new Update with default year 2021 and month 02
+            default_update = Components::Update.new(
+              number: value.number || "1",
+              year: "2021",
+              month: "02",
+              prefix: "slash",
+            )
+            # Set both update and update_component to the new object
+            super(default_update)
+            self.update = default_update
+          end
+        end
+
+        def to_s(format = nil)
+          # TN-SPECIFIC: Add default year to "-upd" pattern (no year/month)
+          # Pattern: "NIST TN 2150-upd" → "NIST TN 2150/Upd1-202102"
+          # This is a special TN pattern where -upd gets default number=1 and year=202102
+          if update_component && !update_component.year && update_component.prefix == "dash"
+            # Create new Update with default year 202102 (February 2021)
+            # This ensures both rendering and attribute access work correctly
+            self.update = Components::Update.new(number: update_component.number || "1",
+                                                 year: "2021", month: "02", prefix: "slash")
+            self.update_component = update
+          end
+
+          # Call parent implementation
+          super
+        end
+
+        public
+
+        def to_short_style
+          # Call parent implementation
+          result = super
+
+          # TN-SPECIFIC: For edition years (not with edition number), use 'e' prefix instead of dash
+          # Pattern: "NIST TN 1297-1993" → "NIST TN 1297e1993"
+          # But only if edition_year is set and edition is NOT set
+          if !edition && edition_year
+            # Replace the last occurrence of "-YYYY" with "eYYYY"
+            # This handles both "-1993" and "-Feb1985" formats
+            result = result.sub(/-(\d{4})$/, 'e\1')
+            result = result.sub(/-([A-Za-z]{3,9})(\d{4})$/, 'e\1\2')
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/pubid/nist/identifiers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Nist
+    module Identifiers
+      autoload :Circular, "#{__dir__}/identifiers/circular"
+      autoload :CircularSupplement, "#{__dir__}/identifiers/circular_supplement"
+      autoload :CommercialStandard, "#{__dir__}/identifiers/commercial_standard"
+      autoload :CommercialStandardEmergency,
+               "#{__dir__}/identifiers/commercial_standard_emergency"
+      autoload :CommercialStandardsMonthly,
+               "#{__dir__}/identifiers/commercial_standards_monthly"
+      autoload :CrplReport, "#{__dir__}/identifiers/crpl_report"
+      autoload :DatedDocument, "#{__dir__}/identifiers/dated_document"
+      autoload :FederalInformationProcessingStandards,
+               "#{__dir__}/identifiers/federal_information_processing_standards"
+      autoload :GrantContractorReport,
+               "#{__dir__}/identifiers/grant_contractor_report"
+      autoload :Handbook, "#{__dir__}/identifiers/handbook"
+      autoload :InteragencyReport, "#{__dir__}/identifiers/internal_report"
+      autoload :LetterCircular, "#{__dir__}/identifiers/letter_circular"
+      autoload :MiscellaneousPublication,
+               "#{__dir__}/identifiers/miscellaneous_publication"
+      autoload :Monograph, "#{__dir__}/identifiers/monograph"
+      autoload :Ncstar, "#{__dir__}/identifiers/ncstar"
+      autoload :Nsrds, "#{__dir__}/identifiers/nsrds"
+      autoload :Owmwp, "#{__dir__}/identifiers/owmwp"
+      autoload :Report, "#{__dir__}/identifiers/report"
+      autoload :SpecialPublication, "#{__dir__}/identifiers/special_publication"
+      autoload :TechnicalNote, "#{__dir__}/identifiers/technical_note"
+    end
+  end
+end