pubid-core 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5961503e7e921ca44202798588badd95d5977fd62fbf98275777770439b5da17
-  data.tar.gz: 2840650728ca920a51a615d2ee81e2884607e485e7740fdd4fc4279cb34cb6fd
+  metadata.gz: e4f9bff0cb4e318de8dab3eb5c8155cb5fe3c560cc24d0616cb38f71a9a83d1c
+  data.tar.gz: 306cc2e013df2f7d236ef62b45fdaccc0038d8e220827898e817a8b2d47dc19e
 SHA512:
-  metadata.gz: 9a956ff7eb7a323b86e3c8656e4396d0c8af503a89f05c96dbd9ff3cc37ec1f6f43ae8a1111eb6c1437b98d3a846f62e0a72b658e2d89a207099351327953c2e
-  data.tar.gz: d55c54c9dc464c01af7bda543bf482d82472ab169101759b510793824e4ee963725e43fe5a486c05627f886f0111e7525fff05d1bd3beafe7612dbe93abe2b87
+  metadata.gz: a8845cff2602c572ccf3a8bc081aa8f326dcaa0384c06353dd1ca842ae94405acc821b12b3fdb9c7eb14c70da61c9abcee2297d01a94a56125e8298411cf9f72
+  data.tar.gz: 78a9452536f524523c470d09973490bb6d2f7c634c531e05dc4150a92ef21bffedb3b0a3bb65c1a32afae17c4c3eee63dd5c0fc055549d80bf7cf9bbd491edeb

data/lib/pubid/core/identifier.rb

@@ -4,7 +4,23 @@ module Pubid::Core
                   :type, :year, :edition, :language, :amendments,
                   :corrigendums
 
-    def initialize(amendments: nil, corrigendums: nil, **opts)
+    # Creates new identifier from options provided:
+    # @param publisher [String] document's publisher, eg. "ISO"
+    # @param copublisher [String,Array<String>] document's copublisher, eg. "IEC"
+    # @param number [Integer] document's number, eg. "1234"
+    # @param part [String] document's part and subparts, eg. "1", "1-1A", "2-3D"
+    # @param type [String] document's type, eg. "TR", "TS"
+    # @param year [Integer] document's year, eg. "2020"
+    # @param edition [Integer] document's edition, eg. "1"
+    # @param language [String] document's translation language
+    #   (available languages: "ru", "fr", "en", "ar")
+    # @param amendments [Array<Amendment>] document's amendments
+    # @param corrigendums [Array<Corrigendum>] document's corrigendums
+    # @see Amendment
+    # @see Corrigendum
+    def initialize(publisher:, number:, copublisher: nil, part: nil, type: nil,
+                   year: nil, edition: nil, language: nil, amendments: nil,
+                   corrigendums: nil)
       if amendments
         @amendments = if amendments.is_a?(Array)
                         amendments.map do |amendment|
@@ -24,9 +40,17 @@ module Pubid::Core
                         end
       end
 
-      opts.each { |key, value| send("#{key}=", value.is_a?(Parslet::Slice) && value.to_s || value) }
+      @publisher = publisher.to_s
+      @number = number
+      @copublisher = copublisher if copublisher
+      @part = part.to_s if part
+      @type = type.to_s if type
+      @year = year.to_i if year
+      @edition = edition.to_i if edition
+      @language = language.to_s if language
     end
 
+    # @return [String] Rendered URN identifier
     def urn
       Renderer::Urn.new(get_params).render
     end
@@ -35,36 +59,16 @@ module Pubid::Core
       instance_variables.map { |var| [var.to_s.gsub("@", "").to_sym, instance_variable_get(var)] }.to_h
     end
 
+    # Render identifier using default renderer
     def to_s
       self.class.get_renderer_class.new(get_params).render
     end
 
     class << self
-      def get_amendment_class
-        Amendment
-      end
-
-      def get_corrigendum_class
-        Corrigendum
-      end
-
-      def get_renderer_class
-        Renderer::Base
-      end
-
-      def get_transformer_class
-        Transformer
-      end
-
-      def update_old_code(code)
-        return code unless defined?(UPDATE_CODES)
-
-        UPDATE_CODES.each do |from, to|
-          code = code.gsub(from.match?(/^\/.*\/$/) ? Regexp.new(from[1..-2]) : /^#{Regexp.escape(from)}$/, to)
-        end
-        code
-      end
-
+      # Parses given identifier
+      # @param code_or_params [String, Hash] code or hash from parser
+      #   eg. "ISO 1234", { }
+      # @return [Pubid::Core::Identifier] identifier
       def parse(code_or_params)
         params = code_or_params.is_a?(String) ?
                    get_parser_class.new.parse(update_old_code(code_or_params)) : code_or_params
@@ -92,6 +96,31 @@ module Pubid::Core
       rescue Parslet::ParseFailed => failure
         raise Errors::ParseError, "#{failure.message}\ncause: #{failure.parse_failure_cause.ascii_tree}"
       end
+
+      def get_amendment_class
+        Amendment
+      end
+
+      def get_corrigendum_class
+        Corrigendum
+      end
+
+      def get_renderer_class
+        Renderer::Base
+      end
+
+      def get_transformer_class
+        Transformer
+      end
+
+      def update_old_code(code)
+        return code unless defined?(UPDATE_CODES)
+
+        UPDATE_CODES.each do |from, to|
+          code = code.gsub(from.match?(/^\/.*\/$/) ? Regexp.new(from[1..-2]) : /^#{Regexp.escape(from)}$/, to)
+        end
+        code
+      end
     end
   end
 end

data/lib/pubid/core/parser.rb

@@ -41,5 +41,11 @@ module Pubid::Core
     rule(:year_month) do
       year_digits >> dash >> month_digits
     end
+
+    def array_to_str(array)
+      array.reduce(str(array.first)) do |acc, value|
+        acc | str(value)
+      end
+    end
   end
 end

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

@@ -34,9 +34,12 @@ module Pubid::Core::Renderer
       render_identifier(params)
     end
 
+    def render_base(params, prefix = "")
+      "%{publisher}%{copublisher}#{prefix} %{number}" % params
+    end
+
     def render_identifier(params)
-      "%{publisher}%{copublisher}%{type}%{stage} %{number}%{part}%{iteration}"\
-        "%{year}%{edition}%{amendments}%{corrigendums}%{language}" % params
+      render_base(params)
     end
 
     def render_copublisher(copublisher, _opts, _params)
@@ -58,21 +61,6 @@ module Pubid::Core::Renderer
       corrigendums.sort.map(&:render_pubid).join("+")
     end
 
-    def render_type(type, opts, params)
-      if params[:copublisher]
-        " #{type}"
-      else
-        "/#{type}"
-      end
-    end
-
-    def render_stage(stage, opts, params)
-      if params[:copublisher]
-        " #{stage}"
-      else
-        "/#{stage}"
-      end
-    end
 
     def render_part(part, opts, _params)
       "-#{part}"
@@ -89,13 +77,5 @@ module Pubid::Core::Renderer
         "(#{language})"
       end
     end
-    
-    def render_edition(edition, _opts, _params)
-      " ED#{edition}"
-    end
-
-    def render_iteration(iteration, _opts, _params)
-      ".#{iteration}"
-    end
   end
 end

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

@@ -1,18 +1,12 @@
 module Pubid::Core::Renderer
   class Urn < Base
-    STAGES = { PWI: 0,
-               NP: 10,
-               AWI: 20,
-               WD: 20.20,
-               CD: 30,
-               DIS: 40,
-               FDIS: 50,
-               PRF: 50,
-               IS: 60 }.freeze
+
+    def render_base(params)
+      "urn:iso:std:%{publisher}%{copublisher}%{type}:%{number}%{part}" % params
+    end
 
     def render_identifier(params)
-      "urn:iso:std:%{publisher}%{copublisher}%{type}:%{number}%{part}%{stage}"\
-      "%{urn_stage}%{corrigendum_stage}%{iteration}%{edition}%{amendments}%{corrigendums}%{language}" % params
+      render_base(params)
     end
 
     def render_publisher(publisher, _opts, _params)
@@ -20,7 +14,7 @@ module Pubid::Core::Renderer
     end
 
     def render_copublisher(copublisher, _opts, _params)
-      return "-#{copublisher.downcase}" unless copublisher.is_a?(Array)
+      return "-#{copublisher.to_s.downcase}" unless copublisher.is_a?(Array)
 
       copublisher.map(&:to_s).sort.map do |copublisher|
         "-#{copublisher.downcase}"
@@ -47,15 +41,6 @@ module Pubid::Core::Renderer
       ":#{language}"
     end
 
-    def render_stage(stage, _opts, _params)
-      return ":stage-#{sprintf('%05.2f', stage)}" if stage.is_a?(Float)
-
-      ":stage-#{sprintf('%05.2f', STAGES[stage.to_sym])}"
-    end
-
-    def render_urn_stage(stage, opts, params)
-      render_stage(stage, opts, params)
-    end
 
     def render_corrigendum_stage(stage, opts, params)
       render_stage(stage, opts, params)

data/lib/pubid/core/supplement.rb

@@ -3,6 +3,9 @@ module Pubid::Core
     include Comparable
     attr_accessor :version, :number
 
+    # Creates new supplement with provided version and optional number
+    # @param version [Integer]
+    # @param number [Integer]
     def initialize(version:, number: nil)
       @version, @number = version&.to_i, number&.to_i
     end

data/lib/pubid/core/version.rb

@@ -1,5 +1,5 @@
 module Pubid
   module Core
-    VERSION = "0.2.2".freeze
+    VERSION = "1.0.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-core
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake