pubid-plateau 1.15.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 249d895ac2ce20122cd153efa3cf6dee4e23ff1c057a3b80963d410f63a31ee2
+  data.tar.gz: b484768bf5fde435042cc49cdec3091e037a53bfd081a49ddf8edb7d80afb1fc
+SHA512:
+  metadata.gz: e3f195da3a5c6cb5c051ffc13ef7eeef7fd2b1780163c94e70e9315b2993f034c25326bff0cd4f91e123c0dc7a1d51cc7ffe47a7bbb4d2248b944ba7af5802d7
+  data.tar.gz: d3d981fe9277ad89765e16d5ec53ef9ffa041c693e479906077a0a0562fd8a2a8f71c06f5a11ed762ecfb1612f4669159a73e376cda148ba137049c1cc13af3b

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,42 @@
+= PLATEAU publication identifiers ("Plateau PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize Plateau publication identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-plateau gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-plateau"
+
+pubid = Pubid::Plateau::Identifier.create(type: :handbook, number: 1, annex: 1, edition: 1.2)
+pubid.to_s
+
+=> "PLATEAU Handbook #01-1 第1.2版"
+----
+
+== Handbook 11 update
+
+Handbook 11 has 2 parts for editions 1 to 3:
+
+* （民間活用編） used to be Handbook 06 editions 1 to 3
+* （公共活用編） used to be Handbook 04 editions 1 to 3
+
+Only from edition 4 they are combined into Handbook 11.
+
+In case when provided Handbook 11 editions 1 to 3, we convert it to Handbook 04 or 06.
+
+[example]
+====
+`PLATEAU Handbook #11 第1.0版（民間活用編）` =>
+`PLATEAU Handbook #06 第1.0版`
+====

data/lib/pubid/plateau/errors.rb

@@ -0,0 +1,5 @@
+module Pubid::Plateau
+  module Errors
+
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'forwardable'
+
+module Pubid::Plateau
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      extend Forwardable
+
+      attr_accessor :annex, :type
+
+      def self.type
+        { key: :plateau }
+      end
+
+      def initialize(number:, publisher: "PLATEAU", annex: nil, edition: nil, **opts)
+        @annex = annex if annex
+        @edition = edition if edition
+        super(**opts.merge(publisher: publisher, number: number.to_i))
+      end
+
+      class << self
+        def transform(params)
+          identifier_params = params.map do |k, v|
+            get_transformer_class.new.apply(k => v).to_a.first
+          end.to_h
+
+          Identifier.create(**identifier_params)
+        end
+
+        def get_parser_class
+          Parser
+        end
+
+        def get_renderer_class
+          Renderer::Base
+        end
+
+        def get_update_codes
+          UPDATE_CODES
+        end
+      end
+    end
+  end
+end

data/lib/pubid/plateau/identifier/handbook.rb

@@ -0,0 +1,15 @@
+module Pubid::Plateau
+  module Identifier
+    class Handbook < Base
+      def_delegators 'Pubid::Plateau::Identifier::Handbook', :type
+
+      def self.get_renderer_class
+        Renderer::Handbook
+      end
+
+      def self.type
+        { key: :handbook, title: "Handbook" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Pubid::Plateau
+  module Identifier
+    class TechnicalReport < Base
+      def_delegators 'Pubid::Plateau::Identifier::TechnicalReport', :type
+
+      def self.get_renderer_class
+        Renderer::TechnicalReport
+      end
+
+      def self.type
+        { key: :tr, title: "Technical Report", values: ["Technical Report"] }
+      end
+    end
+  end
+end

data/lib/pubid/plateau/identifier.rb

@@ -0,0 +1,12 @@
+module Pubid::Plateau
+  module Identifier
+    class << self
+      include Pubid::Core::Identifier
+
+      # @see Pubid::Identifier::Base.parse
+      def parse(*args)
+        Base.parse(*args)
+      end
+    end
+  end
+end

data/lib/pubid/plateau/parser.rb

@@ -0,0 +1,30 @@
+module Pubid::Plateau
+  class Parser < Pubid::Core::Parser
+    rule(:annex) do
+      (dash | str("_")) >> digits.as(:annex)
+    end
+
+    rule(:edition) do
+      space >> str("第") >> (digits >> str(".") >> digits).as(:edition) >> str("版")
+    end
+
+    rule(:type) do
+      (str("Handbook") | str("Technical Report")).as(:type)
+    end
+
+    # PLATEAU Handbook #00 第1.0版
+    rule(:number) do
+      str("#") >> digits.as(:number)
+    end
+
+    # ETSI ETR 299-1 ed.1 (1996-09)
+    # ETSI ETR 298 ed.1 (1996-09)
+    #
+    rule(:identifier) do
+      str("PLATEAU") >> space >> type >> space >>
+        number >> annex.maybe >> edition.maybe
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

@@ -0,0 +1,21 @@
+module Pubid::Plateau::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    TYPE = "".freeze
+
+    def render_identifier(params)
+      "%{publisher} #{self::class::TYPE} #%{number}%{annex}%{edition}" % params
+    end
+
+    def render_number(number, _opts, _params)
+      "%02d" % number.to_i
+    end
+
+    def render_annex(annex, _opts, _params)
+      "-#{annex}"
+    end
+
+    def render_edition(edition, _opts, _params)
+      " 第#{edition}版"
+    end
+  end
+end

data/lib/pubid/plateau/renderer/handbook.rb

@@ -0,0 +1,5 @@
+module Pubid::Plateau::Renderer
+  class Handbook < Base
+    TYPE = "Handbook".freeze
+  end
+end

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

@@ -0,0 +1,5 @@
+module Pubid::Plateau::Renderer
+  class TechnicalReport < Base
+    TYPE = "Technical Report".freeze
+  end
+end

data/lib/pubid/plateau/version.rb

@@ -0,0 +1,5 @@
+module Pubid
+  module Plateau
+    VERSION = "1.15.0".freeze
+  end
+end

data/lib/pubid/plateau.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "parslet"
+require "yaml"
+
+module Pubid
+  module Plateau
+    UPDATE_CODES = YAML.load_file(File.join(File.dirname(__FILE__), "../../update_codes.yaml"))
+  end
+end
+
+require "pubid-core"
+
+require_relative "plateau/identifier"
+require_relative "plateau/identifier/base"
+require_relative "plateau/identifier/handbook"
+require_relative "plateau/identifier/technical_report"
+require_relative "plateau/renderer/base"
+require_relative "plateau/renderer/handbook"
+require_relative "plateau/renderer/technical_report"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Plateau::Identifier::Base
+config.types = [Pubid::Plateau::Identifier::Handbook,
+                Pubid::Plateau::Identifier::TechnicalReport]
+
+Pubid::Plateau::Identifier.set_config(config)
+
+require_relative "plateau/parser"

data/lib/pubid-plateau.rb

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

data/update_codes.yaml

@@ -0,0 +1,6 @@
+"PLATEAU Handbook #11 第1.0版（民間活用編）": "PLATEAU Handbook #06 第1.0版"
+"PLATEAU Handbook #11 第1.0版（公共活用編）": "PLATEAU Handbook #04 第1.0版"
+"PLATEAU Handbook #11 第2.0版（民間活用編）": "PLATEAU Handbook #06 第2.0版"
+"PLATEAU Handbook #11 第2.0版（公共活用編）": "PLATEAU Handbook #04 第2.0版"
+"PLATEAU Handbook #11 第3.0版（民間活用編）": "PLATEAU Handbook #06 第3.0版"
+"PLATEAU Handbook #11 第3.0版（公共活用編）": "PLATEAU Handbook #04 第3.0版"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: pubid-plateau
+version: !ruby/object:Gem::Version
+  version: 1.15.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-04 00:00:00.000000000 Z
+dependencies:
+- !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.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+description: Library to generate, parse and manipulate PLATEAU PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-plateau.rb
+- lib/pubid/plateau.rb
+- lib/pubid/plateau/errors.rb
+- lib/pubid/plateau/identifier.rb
+- lib/pubid/plateau/identifier/base.rb
+- lib/pubid/plateau/identifier/handbook.rb
+- lib/pubid/plateau/identifier/technical_report.rb
+- lib/pubid/plateau/parser.rb
+- lib/pubid/plateau/renderer/base.rb
+- lib/pubid/plateau/renderer/handbook.rb
+- lib/pubid/plateau/renderer/technical_report.rb
+- lib/pubid/plateau/version.rb
+- update_codes.yaml
+homepage: https://github.com/metanorma/pubid-plateau
+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.5.22
+signing_key:
+specification_version: 4
+summary: Library to generate, parse and manipulate PLATEAU PubID.
+test_files: []