pubid-cen 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e1da29b88d15117361e26282da95f073c8027ff11e82b1dc2e68a8e5481231f
+  data.tar.gz: 4e262d7c9e52228f282e82b794d6036a7fdf85d59854fa6be1025da067af54ed
+SHA512:
+  metadata.gz: 210ce4b95af59951c42d34cadfafe657b07af6ea3fe29bf7a3c82453fb7c0e4552b1f4f04e26f1852ae9b7e0785ed94e386743da07ff2f0b3641b31c3496602e
+  data.tar.gz: c6f3e4cc992bb794e619d30bf9eef992f5bddb5dc7dd1c91f7675439db78ed5e62a7103b3ad444385a2e11a14db985a5d8483920c113345a064940f192580877

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,26 @@
+= JIS publication identifiers ("CEN PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize CEN publication
+identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-cen gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-cen"
+
+pubid = Pubid::Cen::Identifier.create(number: 1234, part: 1, year: 1999)
+pubid.to_s
+
+=> "EN 1234-1:1999"
+----

data/lib/pubid/cen/errors.rb

@@ -0,0 +1,5 @@
+module Pubid::Cen
+  module Errors
+    class ParseTypeError < StandardError; end
+  end
+end

data/lib/pubid/cen/identifier/amendment.rb

@@ -0,0 +1,21 @@
+module Pubid::Cen
+  module Identifier
+    class Amendment < Base
+      def_delegators 'Pubid::Cen::Identifier::Amendment', :type
+      attr_accessor :base
+
+      def initialize(base: nil, **opts)
+        super(**opts)
+        @base = base
+      end
+
+      def self.type
+        { key: :amd, title: "Amendment" }
+      end
+
+      def self.get_renderer_class
+        Renderer::Amendment
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require 'forwardable'
+
+module Pubid::Cen
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      extend Forwardable
+
+      attr_accessor :supplements
+
+      def self.type
+        { key: :en, title: "European Norm" }
+      end
+
+      # @param month [Integer] document's month
+      # @param edition [String] document's edition version, e.g. "3.0", "1.0"
+      def initialize(publisher: "EN", part: nil, stage: nil, incorporated_supplements: nil, **opts)
+        super(**opts.merge(publisher: publisher))
+        @part = part if part
+        @stage = Identifier.parse_stage(stage) if stage
+        @supplements = incorporated_supplements
+      end
+
+      class << self
+        def transform(params)
+          identifier_params = params.map do |k, v|
+            get_transformer_class.new.apply(k => v)
+          end.inject({}, :merge)
+
+          if identifier_params[:supplement]
+            return transform_supplement(
+              identifier_params[:supplement],
+              identifier_params.dup.tap { |h| h.delete(:supplement) }
+            )
+          end
+
+          Identifier.create(**identifier_params)
+        end
+
+        def transform_supplement(supplement_params, base_params)
+          Identifier.create(number: supplement_params[:number],
+                            year: supplement_params[:year],
+                            type: supplement_params[:type],
+                            base: Identifier.create(**base_params))
+        end
+
+        def get_parser_class
+          Parser
+        end
+
+        def get_renderer_class
+          Renderer::Base
+        end
+
+        def get_transformer_class
+          Transformer
+        end
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/cen_workshop_agreement.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/guide"
+
+module Pubid::Cen
+  module Identifier
+    class CenWorkshopAgreement < Base
+      def_delegators 'Pubid::Cen::Identifier::CenWorkshopAgreement', :type
+
+      def self.get_renderer_class
+        Renderer::CenWorkshopAgreement
+      end
+
+      def self.type
+        { key: :cwa, title: "Cen Workshop Agreement", short: "CWA" }
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/corrigendum.rb

@@ -0,0 +1,21 @@
+module Pubid::Cen
+  module Identifier
+    class Corrigendum < Base
+      def_delegators 'Pubid::Cen::Identifier::Corrigendum', :type
+      attr_accessor :base
+
+      def initialize(number: nil, base: nil, **opts)
+        super(**opts.merge(number: number))
+        @base = base
+      end
+
+      def self.type
+        { key: :cor, title: "corrigendum" }
+      end
+
+      def self.get_renderer_class
+        Renderer::Corrigendum
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/guide.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/guide"
+
+module Pubid::Cen
+  module Identifier
+    class Guide < Base
+      def_delegators 'Pubid::Cen::Identifier::Guide', :type
+
+      def self.get_renderer_class
+        Renderer::Guide
+      end
+
+      def self.type
+        { key: :guide, title: "Guide", short: "Guide" }
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/harmonization_document.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/guide"
+
+module Pubid::Cen
+  module Identifier
+    class HarmonizationDocument < Base
+      def_delegators 'Pubid::Cen::Identifier::HarmonizationDocument', :type
+
+      def self.get_renderer_class
+        Renderer::HarmonizationDocument
+      end
+
+      def self.type
+        { key: :hd, title: "Harmonization Document", short: "HD" }
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/technical_report.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/technical_report"
+
+module Pubid::Cen
+  module Identifier
+    class TechnicalReport < Base
+      def_delegators 'Pubid::Cen::Identifier::TechnicalReport', :type
+
+      def self.type
+        { key: :tr, title: "Technical Report", short: "TR" }
+      end
+
+      def self.get_renderer_class
+        Renderer::TechnicalReport
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier/technical_specification.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/technical_specification"
+
+module Pubid::Cen
+  module Identifier
+    class TechnicalSpecification < Base
+      def_delegators 'Pubid::Cen::Identifier::TechnicalSpecification', :type
+
+      def self.type
+        { key: :ts, title: "Technical Specification", short: "TS" }
+      end
+
+      def self.get_renderer_class
+        Renderer::TechnicalSpecification
+      end
+    end
+  end
+end

data/lib/pubid/cen/identifier.rb

@@ -0,0 +1,22 @@
+module Pubid::Cen
+  module Identifier
+    class << self
+      include Pubid::Core::Identifier
+
+      # @see Pubid::Identifier::Base.parse
+      def parse(*args)
+        Base.parse(*args)
+      end
+
+      def resolve_identifier(parameters = {})
+        return @config.default_type.new(**parameters) if parameters[:type].nil?
+
+        @config.types.each do |identifier_type|
+          return identifier_type.new(**parameters) if identifier_type.type_match?(parameters)
+        end
+
+        raise Errors::ParseTypeError, "cannot parse type #{parameters[:type]}"
+      end
+    end
+  end
+end

data/lib/pubid/cen/parser.rb

@@ -0,0 +1,47 @@
+module Pubid::Cen
+  class Parser < Pubid::Core::Parser
+    rule(:part) do
+      (str("-") >> digits.as(:part)).repeat
+    end
+
+    rule(:organization) do
+      str("EN") | str("CEN") | str("CLC")
+    end
+
+    rule(:originator) do
+      organization.as(:publisher) >>
+        (space? >> (str("/") | str("-")) >> organization.as(:copublisher)).repeat
+    end
+
+    rule(:type) do
+      (str("/") | space).maybe >>
+        array_to_str(
+          Identifier.config.types.map { |type| [type.type[:short], type.type[:short]&.upcase] }
+                    .flatten.compact).as(:type)
+    end
+
+    rule(:stage) do
+      (str("pr") | str("Fpr")).as(:stage)
+    end
+
+    rule(:supplement_matcher) do
+      ((str("AC").as(:type) >> digits.as(:number).maybe) |
+        (str("A").as(:type) >> digits.as(:number))) >> str(":") >> year
+    end
+
+    rule(:incorporated_supplement) do
+      str("+") >> supplement_matcher.as(:incorporated_supplements)
+    end
+
+    rule(:supplement) do
+      str("/") >> supplement_matcher.as(:supplement)
+    end
+
+    rule(:identifier) do
+      stage.maybe >> originator.maybe >> type.maybe >> space >> digits.as(:number) >> part >>
+        (str(":") >> year).maybe >> supplement.maybe >> incorporated_supplement.repeat
+    end
+
+    rule(:root) { identifier }
+  end
+end

data/lib/pubid/cen/renderer/amendment.rb

@@ -0,0 +1,15 @@
+require_relative "base"
+
+module Pubid::Cen
+  module Renderer
+    class Amendment < Pubid::Core::Renderer::Base
+      def render_identifier(params)
+        if params[:base].is_a?(Identifier::Base)
+          "%{base}/A%{number}%{year}" % params
+        else
+          "+A%{number}%{year}" % params
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Pubid::Cen::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    def render_identifier(params)
+      "%{stage}%{publisher}%{type} %{number}%{part}%{year}%{supplements}" % params
+    end
+
+    def render_type(type, _opts, _params)
+      ""
+    end
+
+    def render_part(part, opts, _params)
+      return "-#{part.reverse.join('-')}" if part.is_a?(Array)
+
+      "-#{part}"
+    end
+
+    def sort_supplements(supplements)
+      supplements.sort_by { |a| (a.year * 100) + a.number.to_i }
+    end
+
+    def render_supplements(supplements, _opts, _params)
+      sort_supplements(supplements).join
+    end
+  end
+end

data/lib/pubid/cen/renderer/cen_workshop_agreement.rb

@@ -0,0 +1,13 @@
+require_relative "base"
+
+module Pubid::Cen::Renderer
+  class CenWorkshopAgreement < Base
+    def render_publisher(publisher, _opts, params)
+      ""
+    end
+
+    def render_type(type, _opts, _params)
+      "CWA"
+    end
+  end
+end

data/lib/pubid/cen/renderer/corrigendum.rb

@@ -0,0 +1,15 @@
+require_relative "base"
+
+module Pubid::Cen
+  module Renderer
+    class Corrigendum < Pubid::Core::Renderer::Base
+      def render_identifier(params)
+        if params[:base].is_a?(Identifier::Base)
+          "%{base}/AC%{number}%{year}" % params
+        else
+          "+AC%{number}%{year}" % params
+        end
+      end
+    end
+  end
+end

data/lib/pubid/cen/renderer/guide.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Cen::Renderer
+  class Guide < Base
+    def render_type(type, _opts, _params)
+      " Guide"
+    end
+  end
+end

data/lib/pubid/cen/renderer/harmonization_document.rb

@@ -0,0 +1,13 @@
+require_relative "base"
+
+module Pubid::Cen::Renderer
+  class HarmonizationDocument < Base
+    def render_publisher(publisher, _opts, params)
+      ""
+    end
+
+    def render_type(type, _opts, _params)
+      "HD"
+    end
+  end
+end

data/lib/pubid/cen/renderer/technical_report.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Cen::Renderer
+  class TechnicalReport < Base
+    def render_type(type, _opts, _params)
+      "/TR"
+    end
+  end
+end

data/lib/pubid/cen/renderer/technical_specification.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Cen::Renderer
+  class TechnicalSpecification < Base
+    def render_type(type, _opts, _params)
+      "/TS"
+    end
+  end
+end

data/lib/pubid/cen/transformer.rb

@@ -0,0 +1,40 @@
+require_relative "identifier/base"
+require_relative "renderer/base"
+
+module Pubid::Cen
+  class Transformer < Parslet::Transform
+    rule(incorporated_supplements: subtree(:incorporated_supplements)) do |context|
+      if context[:incorporated_supplements].is_a?(Array)
+        { incorporated_supplements: context[:incorporated_supplements].map do |supplement|
+            convert_supplement(supplement)
+          end
+         }
+      else
+        { incorporated_supplements: [convert_supplement(context[:incorporated_supplements])] }
+      end
+    end
+
+    rule(supplement: subtree(:supplement)) do |context|
+      context[:supplement][:type] = convert_supplement_type(context[:supplement][:type])
+      context
+    end
+
+    def self.convert_supplement(supplement)
+      case supplement[:type]
+      when "A"
+        Identifier::Amendment.new(**supplement)
+      when "AC"
+        Identifier::Corrigendum.new(**supplement)
+      end
+    end
+
+    def self.convert_supplement_type(type)
+      case type
+      when "A"
+        :amd
+      when "AC"
+        :cor
+      end
+    end
+  end
+end

data/lib/pubid/cen/version.rb

@@ -0,0 +1,5 @@
+module Pubid
+  module Cen
+    VERSION = "0.1.1".freeze
+  end
+end

data/lib/pubid/cen.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+end
+
+require "pubid-core"
+
+require_relative "cen/errors"
+require_relative "cen/transformer"
+require_relative "cen/identifier/base"
+require_relative "cen/identifier/technical_specification"
+require_relative "cen/identifier/technical_report"
+require_relative "cen/identifier/guide"
+require_relative "cen/identifier/amendment"
+require_relative "cen/identifier/corrigendum"
+require_relative "cen/identifier/cen_workshop_agreement"
+require_relative "cen/identifier/harmonization_document"
+require_relative "cen/renderer/base"
+require_relative "cen/renderer/technical_specification"
+require_relative "cen/renderer/technical_report"
+require_relative "cen/renderer/guide"
+require_relative "cen/renderer/amendment"
+require_relative "cen/renderer/corrigendum"
+require_relative "cen/renderer/cen_workshop_agreement"
+require_relative "cen/renderer/harmonization_document"
+require_relative "cen/parser"
+require_relative "cen/identifier"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Cen::Identifier::Base
+config.types = [Pubid::Cen::Identifier::Base,
+                Pubid::Cen::Identifier::TechnicalSpecification,
+                Pubid::Cen::Identifier::TechnicalReport,
+                Pubid::Cen::Identifier::Guide,
+                Pubid::Cen::Identifier::Amendment,
+                Pubid::Cen::Identifier::Corrigendum,
+                Pubid::Cen::Identifier::CenWorkshopAgreement,
+                Pubid::Cen::Identifier::HarmonizationDocument]
+config.type_names = {}.freeze
+config.stages = { "abbreviations" => { "Fpr" => [], "pr" => [] } }
+
+Pubid::Cen::Identifier.set_config(config)

data/lib/pubid-cen.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "pubid/cen"

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: pubid-cen
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lightly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pubid-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Library to generate, parse and manipulate CEN PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-cen.rb
+- lib/pubid/cen.rb
+- lib/pubid/cen/errors.rb
+- lib/pubid/cen/identifier.rb
+- lib/pubid/cen/identifier/amendment.rb
+- lib/pubid/cen/identifier/base.rb
+- lib/pubid/cen/identifier/cen_workshop_agreement.rb
+- lib/pubid/cen/identifier/corrigendum.rb
+- lib/pubid/cen/identifier/guide.rb
+- lib/pubid/cen/identifier/harmonization_document.rb
+- lib/pubid/cen/identifier/technical_report.rb
+- lib/pubid/cen/identifier/technical_specification.rb
+- lib/pubid/cen/parser.rb
+- lib/pubid/cen/renderer/amendment.rb
+- lib/pubid/cen/renderer/base.rb
+- lib/pubid/cen/renderer/cen_workshop_agreement.rb
+- lib/pubid/cen/renderer/corrigendum.rb
+- lib/pubid/cen/renderer/guide.rb
+- lib/pubid/cen/renderer/harmonization_document.rb
+- lib/pubid/cen/renderer/technical_report.rb
+- lib/pubid/cen/renderer/technical_specification.rb
+- lib/pubid/cen/transformer.rb
+- lib/pubid/cen/version.rb
+homepage: https://github.com/metanorma/pubid-cen
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Library to generate, parse and manipulate CEN PubID.
+test_files: []