pubid-core 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1e2dbeb108d767054166d4fec9c0bb64e5c3a7ebb8811dc4f97de4c6cea4e93
-  data.tar.gz: 0aa8be27d6b839e6e985d8ce1a376d6fbe55ef07e87a664ac902c455e937c887
+  metadata.gz: fe1c8b6b0226decbdfd993caaf75ad8e673ea91c86a78c4fa380d82ac8119d1c
+  data.tar.gz: 5d07cdca4cdaf9febed8cb1e2d1bc18ffc503d6ad09359cb2002e4aaae13a2cc
 SHA512:
-  metadata.gz: 06b053ef1516f1fbe0524171fbc27afd6659e301cabb6692fb46be8b746807f6e21e081c48bc10f8cb1be282607154a7f084850f117c62e3748f8e2de1b25922
-  data.tar.gz: d3f441ccc72743f752b81eb993c7c71088442c1c53376412553a809464473048a29e80503673962d6b496dd9efc1979ed191f35dea08d9f3f19032073bba3711
+  metadata.gz: 7c7db091d747e05faab9c3cfb4ef42f3e65064e027cd5875eb888c5397852a286f03388da9941491a5eca184c00cdcf30a74b3185254e4343aee82b597abf9c0
+  data.tar.gz: 3fceacbe396c2c8f627fd602f95132667162742e0d274f7fe649f323ef81c43e3684ad42fc626c8a841c41e1a81ce570b077a530685a9445a9b4eb92e21ce8e7

data/lib/pubid/core/errors.rb

@@ -1,5 +1,8 @@
 module Pubid::Core
   module Errors
     class ParseError < StandardError; end
+    class HarmonizedStageCodeInvalidError < StandardError; end
+    class StageInvalidError < StandardError; end
+    class HarmonizedStageRenderingError < StandardError; end
   end
 end

data/lib/pubid/core/harmonized_stage_code.rb

@@ -0,0 +1,79 @@
+module Pubid::Core
+  class HarmonizedStageCode
+    include Comparable
+    # attr_accessor :stage, :substage
+    attr_accessor :stages
+
+    DESCRIPTIONS = STAGES_CONFIG["codes_description"]
+    DRAFT_STAGES = STAGES_CONFIG["draft_codes"]
+    CANCELED_STAGES = STAGES_CONFIG["canceled_codes"]
+    PUBLISHED_STAGES = STAGES_CONFIG["published_codes"]
+    STAGES_NAMES = STAGES_CONFIG["stage_codes"]
+    SUBSTAGES_NAMES = STAGES_CONFIG["substage_codes"]
+
+    # @param stage_or_code [String,Array<String>] stage number or whole harmonized code with substage
+    #   or list or stages for fuzzy stages eg. "10", 10, "20.20", ["10.20", "20.20"]
+    #   or stage name eg. "proposal", "approval"
+    # @param substage [Integer, String] eg. "00", 0
+    #   or substage name eg. "registration", "start_of_main_action"
+    def initialize(stage_or_code, substage = "00")
+      @stages = if stage_or_code.is_a?(Array)
+                  stage_or_code
+                elsif stage_or_code.is_a?(String) && DESCRIPTIONS.key?(stage_or_code)
+                  [stage_or_code]
+                  # when stage is stage name
+                elsif STAGES_NAMES.key?(stage_or_code.to_s)
+                  ["#{STAGES_NAMES[stage_or_code.to_s]}.#{SUBSTAGES_NAMES[substage.to_s]}"]
+                else
+                  # stage is number
+                  ["#{stage_or_code}.#{substage}"]
+                end
+      validate_stages
+    end
+
+    def validate_stages
+      @stages.each do |stage|
+        # raise an error when stage is wrong
+        raise Errors::HarmonizedStageCodeInvalidError unless DESCRIPTIONS.key?(stage)
+      end
+    end
+
+    def to_s
+      if fuzzy?
+        return "draft" if @stages.all? { |s| DRAFT_STAGES.include?(s) || CANCELED_STAGES.include?(s) }
+
+        return "published" if @stages.all? { |s| PUBLISHED_STAGES.include?(s) }
+
+        raise Errors::HarmonizedStageRenderingError, "cannot render fuzzy stages"
+      else
+        @stages.first
+      end
+    end
+
+    def ==(other)
+      (stages & other.stages) == other.stages
+    end
+
+    def fuzzy?
+      @stages.length > 1
+    end
+
+    def stage
+      raise Errors::HarmonizedStageRenderingError, "cannot render stage for fuzzy stages" if fuzzy?
+
+      return nil if @stages.empty?
+
+      @stages.first.split(".").first
+    end
+
+    def substage
+      raise Errors::HarmonizedStageRenderingError, "cannot render substage for fuzzy stages" if fuzzy?
+
+      @stages.first.split(".").last
+    end
+
+    def description
+      DESCRIPTIONS[to_s]
+    end
+  end
+end

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

@@ -85,10 +85,6 @@ module Pubid::Core::Renderer
       end
     end
 
-    def render_base(params, prefix = "")
-      "%{publisher}#{prefix} %{number}" % params
-    end
-
     def render_identifier(params)
       render_base(params)
     end

data/lib/pubid/core/stage.rb

@@ -0,0 +1,98 @@
+module Pubid::Core
+  class Stage
+    attr_accessor :abbr, :harmonized_code
+
+    STAGES = STAGES_CONFIG["abbreviations"]
+
+    # @param abbr [String, Symbol] abbreviation eg. :PWI, :WD
+    # @param harmonized_code [String, Float, HarmonizedStageCode]
+    def initialize(abbr: nil, harmonized_code: nil)
+      @abbr = abbr&.to_s
+
+      if harmonized_code
+        @harmonized_code = if harmonized_code.is_a?(HarmonizedStageCode)
+                             harmonized_code
+                           else
+                             HarmonizedStageCode.new(harmonized_code)
+                           end
+        @abbr ||= lookup_abbr(@harmonized_code.stages)
+      end
+
+      if abbr
+        raise Errors::StageInvalidError, "#{abbr} is not valid stage" unless STAGES.key?(abbr.to_s)
+
+        @harmonized_code ||= HarmonizedStageCode.new(lookup_code(abbr))
+      end
+    end
+
+    # Lookup for abbreviated code by numeric stage code
+    # @param lookup_code [String, Array] stage code or array of stage codes,
+    #   e.g. "00.00", "20.20", ["00.00", "00.20"]
+    def lookup_abbr(lookup_code)
+      lookup_code = lookup_code.first if lookup_code.is_a?(Array) && lookup_code.count == 1
+
+      STAGES.each do |abbr, codes|
+        case codes
+        when Array
+          if lookup_code.is_a?(Array)
+            return abbr if codes == lookup_code
+          else
+            return abbr if codes.include?(lookup_code)
+          end
+          # codes.each do |code|
+          #   return abbr if code == lookup_code
+          # end
+        when lookup_code
+          return abbr
+        end
+      end
+
+      nil
+    end
+
+    def lookup_code(lookup_abbr)
+      STAGES[lookup_abbr.to_s]
+    end
+
+    def self.parse(stage)
+      if /\A[\d.]+\z/.match?(stage)
+        Stage.new(harmonized_code: stage)
+      else
+        raise Errors::StageInvalidError unless stage.is_a?(Symbol) || stage.is_a?(String) || stage.is_a?(Parslet::Slice)
+
+        Stage.new(abbr: stage.to_s)
+      end
+    end
+
+    # @return [Boolean] true if stage exists
+    def self.has_stage?(stage)
+      if stage.is_a?(Stage)
+        STAGES.key?(stage.abbr.to_sym)
+      else
+        STAGES.key?(stage.to_s) || /\A[\d.]+\z/.match?(stage)
+      end
+    end
+
+    # Compares one stage with another
+    def ==(other)
+      other&.harmonized_code == harmonized_code
+    end
+
+    # Return stage name, eg. "Draft International Standard" for "DIS"
+    def name
+      STAGES_CONFIG["names"][abbr.to_s]
+    end
+
+    # @param with_prf [Boolean]
+    # @return [Boolean] false if there are output for abbreviation should be produced
+    def empty_abbr?(with_prf: false)
+      return true if abbr == "PRF" && !with_prf
+
+      abbr.nil?
+    end
+
+    def to_s(opts = {})
+      abbr unless empty_abbr?(**opts)
+    end
+  end
+end

data/lib/pubid/core/version.rb

@@ -1,5 +1,5 @@
 module Pubid
   module Core
-    VERSION = "1.4.0".freeze
+    VERSION = "1.5.0".freeze
   end
 end

data/lib/pubid/core.rb

@@ -9,3 +9,5 @@ require_relative "core/transformer"
 require_relative "core/renderer/base"
 require_relative "core/renderer/urn"
 require_relative "core/identifier"
+require_relative "core/harmonized_stage_code"
+require_relative "core/stage"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-core
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -68,10 +68,12 @@ files:
 - lib/pubid/core/amendment.rb
 - lib/pubid/core/corrigendum.rb
 - lib/pubid/core/errors.rb
+- lib/pubid/core/harmonized_stage_code.rb
 - lib/pubid/core/identifier.rb
 - lib/pubid/core/parser.rb
 - lib/pubid/core/renderer/base.rb
 - lib/pubid/core/renderer/urn.rb
+- lib/pubid/core/stage.rb
 - lib/pubid/core/supplement.rb
 - lib/pubid/core/transformer.rb
 - lib/pubid/core/version.rb