pubid 1.15.21 → 2.0.0.alpha.10

data/lib/pubid/iec/identifiers/consolidated_identifier.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # Consolidated Identifier
+      # Single Responsibility: Represents a consolidated publication containing multiple documents
+      # Example: "IEC 60529:1989+AMD1:1999" contains [IS, AMD] as separate identifier objects
+      # This is MODEL-DRIVEN: stores the actual identifiers, not just renders with +
+      class ConsolidatedIdentifier < Identifier
+        attribute :identifiers, Identifier, polymorphic: true, collection: true
+
+        # Common fields are delegated to identifiers.first, so suppress the
+        # inherited common maps and serialize the wrapped identifiers (base
+        # document + supplements) instead. Route each nested hash back through
+        # Identifier.from_hash so its concrete subclass is reconstructed.
+        include Pubid::Iec::DelegatedFieldSuppression
+
+        key_value do
+          map "identifiers",
+              with: { to: :identifiers_to_kv, from: :identifiers_from_kv }
+        end
+
+        def identifiers_to_kv(model, doc)
+          return unless model.identifiers&.any?
+
+          doc.add_child(Lutaml::KeyValue::DataModel::Element.new(
+                          "identifiers", model.identifiers.map(&:to_hash)
+                        ))
+        end
+
+        def identifiers_from_kv(model, value)
+          model.identifiers = Array(value).map do |h|
+            ::Pubid::Iec::Identifier.from_hash(h)
+          end
+        end
+
+        # Delegate common attributes to first identifier (base document)
+        def publisher
+          identifiers&.first&.publisher
+        end
+
+        def copublishers
+          identifiers&.first&.copublishers
+        end
+
+        def code
+          identifiers&.first&.code
+        end
+
+        def number
+          identifiers&.first&.number
+        end
+
+        def date
+          identifiers&.first&.date
+        end
+
+        def stage
+          identifiers&.first&.stage
+        end
+
+        def typed_stage
+          identifiers&.first&.typed_stage
+        end
+
+        # Get the base document (first identifier)
+        def base_document
+          identifiers&.first
+        end
+
+        # The origin document. A consolidated bundle stores its members in
+        # `identifiers` (not `base`), so walk the first member to its root.
+        def root
+          identifiers&.first&.root || self
+        end
+
+        # Get all supplements (identifiers after first)
+        def supplements
+          identifiers&.drop(1) || []
+        end
+      end
+    end
+  end
+end

data/lib/pubid/iec/identifiers/corrigendum.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # Corrigendum Identifier
+      class Corrigendum < SupplementIdentifier
+        # `type` is NOT redeclared here — see the note on Amendment. The
+        # redeclaration assigned the Symbol `:cor` on the from_hash path.
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            code: :pwi_cor,
+            stage_code: :pwi,
+            type_code: :cor,
+            abbr: ["PWI Cor"],
+            name: "Preliminary Work Item Corrigendum",
+            harmonized_stages: %w[00.00 00.20 00.60 00.98 00.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :np_cor,
+            stage_code: :np,
+            type_code: :cor,
+            abbr: ["NP Cor"],
+            name: "New Proposal Corrigendum",
+            harmonized_stages: %w[10.00 10.20 10.60 10.92 10.98],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :anw_cor,
+            stage_code: :anw,
+            type_code: :cor,
+            abbr: ["ANW Cor"],
+            name: "Approved New Work Item Corrigendum",
+            harmonized_stages: %w[10.99 20.00],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :wdcor,
+            stage_code: :wd,
+            type_code: :cor,
+            abbr: ["WDCor"],
+            name: "Working Draft Corrigendum",
+            harmonized_stages: %w[20.20 20.60 20.98 20.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cdcor,
+            stage_code: :cd,
+            type_code: :cor,
+            abbr: ["CDCor"],
+            short_abbr: "CDCor",
+            long_abbr: "CD Cor",
+            name: "Committee Draft Corrigendum",
+            harmonized_stages: %w[30.00 30.20 30.60 30.92 30.98 30.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :dcor,
+            stage_code: :dcor,
+            type_code: :cor,
+            abbr: ["DCOR"],
+            short_abbr: "DCOR",
+            long_abbr: "DCor",
+            name: "Draft Corrigendum",
+            harmonized_stages: %w[40.00 40.20 40.60 40.92 40.98 40.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :fdcor,
+            stage_code: :fdcor,
+            type_code: :cor,
+            abbr: ["FDCOR", "PRF Cor"],
+            short_abbr: "FDCOR",
+            long_abbr: "FDCor",
+            name: "Final Draft Corrigendum",
+            harmonized_stages: %w[50.00 50.20 50.60 50.92 50.98 50.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :pubcor,
+            stage_code: :published,
+            type_code: :cor,
+            abbr: ["Cor", "COR"],
+            short_abbr: "COR",
+            long_abbr: "Cor",
+            name: "Corrigendum",
+            harmonized_stages: %w[60.00 60.60 90.20 90.60 90.92 90.93 90.99
+                                  95.20 95.60 95.92 95.99],
+          ),
+        ].freeze
+
+        def self.type
+          { key: :cor,
+            web: :corrigendum, title: "Corrigendum", short: "COR" }
+        end
+      end
+    end
+  end
+end

data/lib/pubid/iec/identifiers/fragment_identifier.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # Fragment Identifier
+      # Single Responsibility: Represents a specific fragment/part within an Amendment or Corrigendum
+      # Example: "IEC 60050-191/AMD2/FRAG2 ED1" = Fragment 2 of Amendment 2
+      # Fragments are independently approved and have their own lifecycle stages.
+      class FragmentIdentifier < Identifier
+        attribute :base, Identifier, polymorphic: true
+        attribute :fragment_number, :string
+        attribute :edition, ::Pubid::Components::Edition, default: -> {}
+        # Fragments have their own lifecycle; default to the published FRAG stage
+        # so an omitted "stage" reconstructs it on from_hash.
+        attribute :typed_stage, ::Pubid::Components::TypedStage,
+                  default: -> { self.class.published_typed_stage }
+
+        # number/date/publisher delegate to base, but the fragment's
+        # stage and edition are its own. Serialize the wrapped identifier under
+        # "base" plus the fragment number; suppress only the truly-delegated
+        # common maps (keep stage/edition from the inherited block).
+        key_value do
+          map "base", with: { to: :base_to_kv, from: :base_from_kv }
+          map "fragment_number", to: :fragment_number, render_default: false
+        end
+
+        def number_to_kv(_model, _doc); end
+        def part_to_kv(_model, _doc); end
+        def subpart_to_kv(_model, _doc); end
+        def stage_iteration_to_kv(_model, _doc); end
+        def year_to_kv(_model, _doc); end
+        def publisher_to_kv(_model, _doc); end
+        def copublishers_to_kv(_model, _doc); end
+
+        def base_to_kv(model, doc)
+          base = model.base
+          return unless base
+
+          doc.add_child(Lutaml::KeyValue::DataModel::Element.new("base",
+                                                                 base.to_hash))
+        end
+
+        def base_from_kv(model, value)
+          model.base = ::Pubid::Iec::Identifier.from_hash(value) if value
+        end
+
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            code: :pwi_frag,
+            stage_code: :pwi,
+            type_code: :frag,
+            abbr: ["PWI Frag"],
+            name: "Preliminary Work Item Fragment",
+            harmonized_stages: %w[00.00 00.20 00.60 00.98 00.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :np_frag,
+            stage_code: :np,
+            type_code: :frag,
+            abbr: ["NP Frag"],
+            name: "New Proposal Fragment",
+            harmonized_stages: %w[10.00 10.20 10.60 10.92 10.98],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :anw_frag,
+            stage_code: :anw,
+            type_code: :frag,
+            abbr: ["ANW Frag"],
+            name: "Approved New Work Item Fragment",
+            harmonized_stages: %w[10.99 20.00],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :wd_frag,
+            stage_code: :wd,
+            type_code: :frag,
+            abbr: ["WD Frag"],
+            name: "Working Draft Fragment",
+            harmonized_stages: %w[20.20 20.60 20.98 20.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cdfrag,
+            stage_code: :cd,
+            type_code: :frag,
+            abbr: ["CDFRAG"],
+            name: "Committee Draft Fragment",
+            harmonized_stages: %w[30.00 30.20 30.60 30.92 30.98 30.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :dfrag,
+            stage_code: :dfrag,
+            type_code: :frag,
+            abbr: ["DFRAG"],
+            name: "Draft Fragment",
+            harmonized_stages: %w[40.00 40.20 40.60 40.92 40.98 40.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :fdfrag,
+            stage_code: :fdfrag,
+            type_code: :frag,
+            abbr: ["FDFRAG", "PRF Frag"],
+            name: "Final Draft Fragment",
+            harmonized_stages: %w[50.00 50.20 50.60 50.92 50.98 50.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :frag,
+            stage_code: :published,
+            type_code: :frag,
+            abbr: ["FRAG"],
+            name: "Fragment",
+            harmonized_stages: %w[60.00 60.60 90.20 90.60 90.92 90.93 90.99
+                                  95.20 95.60 95.92 95.99],
+          ),
+        ].freeze
+
+        def self.type
+          { key: :frag,
+            web: :fragment_identifier, title: "Fragment", short: "FRAG" }
+        end
+
+        # Delegate common attributes to base
+        def publisher
+          base&.publisher
+        end
+
+        def copublishers
+          base&.copublishers
+        end
+
+        def code
+          base&.code
+        end
+
+        def number
+          base&.number
+        end
+
+        def date
+          base&.date
+        end
+
+        def stage
+          typed_stage&.to_stage || base&.stage
+        end
+      end
+    end
+  end
+end

data/lib/pubid/iec/identifiers/guide.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # Guide identifier class
+      # Single Responsibility: Represents IEC Guide documents
+      class Guide < Base
+        # Convert v1 hash-based TYPED_STAGES to v2 object-based
+        # From gems/pubid-iec/lib/pubid/iec/identifier/guide.rb
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            code: :pwi_guide,
+            stage_code: :pwi,
+            type_code: :guide,
+            abbr: ["PWI Guide"],
+            name: "Preliminary Work Item Guide",
+            harmonized_stages: %w[00.00 00.20 00.60 00.98 00.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :np_guide,
+            stage_code: :np,
+            type_code: :guide,
+            abbr: ["NP Guide"],
+            name: "New Proposal Guide",
+            harmonized_stages: %w[10.00 10.20 10.60 10.92 10.98],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :anw_guide,
+            stage_code: :anw,
+            type_code: :guide,
+            abbr: ["ANW Guide"],
+            name: "Approved New Work Item Guide",
+            harmonized_stages: %w[10.99 20.00],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :wd_guide,
+            stage_code: :wd,
+            type_code: :guide,
+            abbr: ["WD Guide"],
+            name: "Working Draft Guide",
+            harmonized_stages: %w[20.20 20.60 20.98 20.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cd_guide,
+            stage_code: :cd,
+            type_code: :guide,
+            abbr: ["CD Guide"],
+            name: "Committee Draft Guide",
+            harmonized_stages: %w[30.00 30.20 30.60 30.92 30.98 30.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :dguide,
+            stage_code: :draft,
+            type_code: :guide,
+            abbr: ["DGuide"],
+            name: "Draft Guide",
+            harmonized_stages: %w[40.00 40.20 40.60 40.92 40.98 40.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :fdguide,
+            stage_code: :final_draft,
+            type_code: :guide,
+            abbr: ["FDGuide", "PRF Guide"],
+            name: "Final Draft Guide",
+            harmonized_stages: %w[50.00 50.20 50.60 50.92 50.98 50.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :guide,
+            stage_code: :published,
+            type_code: :guide,
+            abbr: ["GUIDE", "Guide"],
+            name: "Guide",
+            harmonized_stages: %w[60.00 60.60 90.20 90.60 90.92 90.93 90.99
+                                  95.20 95.60 95.92 95.99],
+          ),
+        ].freeze
+
+        def self.type
+          { key: :guide, title: "Guide", short: %w[Guide GUIDE] }
+        end
+
+      end
+    end
+  end
+end

data/lib/pubid/iec/identifiers/international_standard.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # International Standard identifier class
+      # Single Responsibility: Represents IEC International Standard documents
+      class InternationalStandard < Base
+        # International Standards need a TypedStage with empty abbr for published standards
+        # From gems/pubid-iec/lib/pubid/iec/identifier/international_standard.rb
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            code: :pwi,
+            stage_code: :pwi,
+            type_code: :is,
+            abbr: %w[PWI NWIP BWG AWIN AMW],
+            name: "Preliminary Work Item",
+            harmonized_stages: %w[00.00 00.20 00.60 00.98 00.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :np,
+            stage_code: :np,
+            type_code: :is,
+            abbr: ["NP"],
+            name: "New Proposal",
+            harmonized_stages: %w[10.00 10.60 10.92 10.98],
+          ),
+          # PNW is a stage of its own, not an alias of PWI. IEC's portal and
+          # pubid-iec 1.x both give it harmonized code 10.20 ("New work item
+          # proposal"), which is why 10.20 is absent from :np above — the two
+          # must not both claim it, or a lookup by harmonized code is
+          # ambiguous. See issue #360 item 1.
+          Pubid::Components::TypedStage.new(
+            code: :pnw,
+            stage_code: :pnw,
+            type_code: :is,
+            abbr: ["PNW"],
+            name: "New work item proposal",
+            harmonized_stages: %w[10.20],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :anw,
+            stage_code: :anw,
+            type_code: :is,
+            abbr: ["ANW"],
+            name: "Approved New Work Item",
+            harmonized_stages: %w[10.99 20.00],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :wd,
+            stage_code: :wd,
+            type_code: :is,
+            abbr: ["WD"],
+            name: "Working Draft",
+            harmonized_stages: %w[20.20 20.60 20.98 20.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cd,
+            stage_code: :cd,
+            type_code: :is,
+            abbr: %w[CD 2CD 3CD 4CD 5CD 6CD 7CD 8CD 9CD
+                     ACD A2CD A3CD A4CD A5CD A6CD A7CD A8CD A9CD
+                     CDM],
+            name: "Committee Draft",
+            harmonized_stages: %w[30.00 30.20 30.60 30.92 30.98 30.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cdv,
+            stage_code: :cdv,
+            type_code: :is,
+            abbr: %w[CDV ACDV CCDV CDVM NCDV],
+            name: "Committee Draft for Vote",
+            harmonized_stages: %w[40.00 40.20 40.60 40.92 40.98 40.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :fdis,
+            stage_code: :fdis,
+            type_code: :is,
+            abbr: %w[FDIS PRF NFDIS NADIS RDISH RFDIS CFDIS],
+            name: "Final Draft International Standard",
+            harmonized_stages: %w[50.00 50.20 50.60 50.92 50.98 50.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :is,
+            stage_code: :published,
+            type_code: :is,
+            abbr: ["", "BPUB", "PPUB", "APUB", "WPUB", "DELPUB",
+                   "RR", "CAN"],
+            name: "International Standard",
+            harmonized_stages: %w[60.00 60.60 90.20 90.60 90.92 90.93 90.99
+                                  95.20 95.60 95.92 95.99],
+          ),
+        ].freeze
+
+        # Project stages specific to International Standards
+        # These are IEC-specific workflow stages
+        PROJECT_STAGES = {
+          afdis: {
+            abbr: "AFDIS",
+            name: "Approved for FDIS",
+            harmonized_stages: %w[40.99],
+          },
+          ccdv: {
+            abbr: "CCDV",
+            name: "Draft circulated as CDV",
+            harmonized_stages: %w[40.20],
+          },
+          cdvm: {
+            abbr: "CDVM",
+            name: "Rejected CDV to be discussed at a meeting",
+            harmonized_stages: %w[40.91],
+          },
+          cfdis: {
+            abbr: "CFDIS",
+            name: "Draft circulated as FDIS",
+            harmonized_stages: %w[50.20],
+          },
+          decfdis: {
+            abbr: "DECFDIS",
+            name: "FDIS at editing check",
+            harmonized_stages: %w[50.00],
+          },
+          ncdv: {
+            abbr: "NCDV",
+            name: "CDV rejected",
+            harmonized_stages: %w[40.91],
+          },
+          nfdis: {
+            abbr: "NFDIS",
+            name: "FDIS rejected",
+            harmonized_stages: %w[50.92],
+          },
+          prvc: {
+            abbr: "PRVC",
+            name: "Preparation of RVC",
+            harmonized_stages: %w[40.60],
+          },
+          prvd: {
+            abbr: "PRVD",
+            name: "Preparation of RVD",
+            harmonized_stages: %w[50.60],
+          },
+          rfdis: {
+            abbr: "RFDIS",
+            name: "FDIS received and registered",
+            harmonized_stages: %w[50.00],
+          },
+          tcdv: {
+            abbr: "TCDV",
+            name: "Translation of CDV",
+            harmonized_stages: %w[40.00],
+          },
+        }.freeze
+
+        def self.type
+          { key: :is,
+            web: :international_standard, title: "International Standard", short: nil }
+        end
+      end
+    end
+  end
+end

data/lib/pubid/iec/identifiers/interpretation_sheet.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Pubid
+  module Iec
+    module Identifiers
+      # Interpretation Sheet identifier class
+      # Single Responsibility: Represents IEC ISH documents
+      # Dual role: Can be primary document or supplement
+      class InterpretationSheet < SupplementIdentifier
+        # Convert v1 hash-based TYPED_STAGES to v2 object-based
+        # From gems/pubid-iec/lib/pubid/iec/identifier/interpretation_sheet.rb
+        TYPED_STAGES = [
+          Pubid::Components::TypedStage.new(
+            code: :pwi_ish,
+            stage_code: :pwi,
+            type_code: :ish,
+            abbr: ["PWI ISH"],
+            name: "Preliminary Work Item Interpretation Sheet",
+            harmonized_stages: %w[00.00 00.20 00.60 00.98 00.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :np_ish,
+            stage_code: :np,
+            type_code: :ish,
+            abbr: ["NP ISH"],
+            name: "New Proposal Interpretation Sheet",
+            harmonized_stages: %w[10.00 10.20 10.60 10.92 10.98],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :anw_ish,
+            stage_code: :anw,
+            type_code: :ish,
+            abbr: ["ANW ISH"],
+            name: "Approved New Work Item Interpretation Sheet",
+            harmonized_stages: %w[10.99 20.00],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :wd_ish,
+            stage_code: :wd,
+            type_code: :ish,
+            abbr: ["WD ISH"],
+            name: "Working Draft Interpretation Sheet",
+            harmonized_stages: %w[20.20 20.60 20.98 20.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :cdish,
+            stage_code: :cd,
+            type_code: :ish,
+            abbr: ["CDISH"],
+            name: "Committee Draft Interpretation Sheet",
+            harmonized_stages: %w[30.00 30.20 30.60 30.92 30.98 30.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :dish,
+            stage_code: :draft,
+            type_code: :ish,
+            abbr: ["DISH"],
+            name: "Draft Interpretation Sheet",
+            harmonized_stages: %w[50.00 50.20 50.60 50.92 50.98 50.99],
+          ),
+          Pubid::Components::TypedStage.new(
+            code: :ish,
+            stage_code: :published,
+            type_code: :ish,
+            abbr: ["ISH"],
+            name: "Interpretation Sheet",
+            harmonized_stages: %w[60.00 60.60 90.20 90.60 90.92 90.93 90.99
+                                  95.20 95.60 95.92 95.99],
+          ),
+        ].freeze
+
+        # Project stages specific to Interpretation Sheets
+        PROJECT_STAGES = {
+          decdish: {
+            abbr: "DECDISH",
+            name: "DISH at editing check",
+            harmonized_stages: %w[50.00],
+          },
+          prvdish: {
+            abbr: "PRVDISH",
+            name: "Preparation of RVDISH",
+            harmonized_stages: %w[50.60],
+          },
+          rdish: {
+            abbr: "RDISH",
+            name: "DISH received and registered",
+            harmonized_stages: %w[50.00],
+          },
+          tdish: {
+            abbr: "TDISH",
+            name: "Translation of DISH",
+            harmonized_stages: %w[50.00],
+          },
+        }.freeze
+
+        def self.type
+          { key: :ish,
+            web: :interpretation_sheet, title: "Interpretation Sheet", short: "ISH" }
+        end
+      end
+    end
+  end
+end