pubid-etsi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: accb82a61ec1980ce258834e0a471599f1efea7bcda45d7aecf192c050b25d60
+  data.tar.gz: 3660ac602ce7823b64e543dbd514ca1fb58f4e24438740097e7bd898dbfccfad
+SHA512:
+  metadata.gz: dc4e5e2b684c156a3aa8bbb9086866dcf995e4a39be44456098a55aacdd39da8c7e5279ca13b3e9855edef8d4f06d5ebaba8dd8d6e8ebdf594657a16f498e691
+  data.tar.gz: 938a8735a7dd5cad1e67638b3523e7e4d5b82d36d0643e3073f631bd336e54daac4678d3d743d78b7b0c9a0ac3df04840805ba1bfcf16d96717ad01eb997aefc

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 @@
+= ETSI publication identifiers ("ETSI PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize ETSI publication
+identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-ccsds gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-etsi"
+
+pubid = Pubid::Etsi::Identifier.create(type: "EN", number: 1234, minor: 123, part: 4, version: "1.2.3", date: "1999-01")
+pubid.to_s
+
+=> "ETSI EN 1234 123-4 V1.2.3 (1999-01)"
+----

data/lib/pubid/etsi/errors.rb

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

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

@@ -0,0 +1,11 @@
+module Pubid::Etsi
+  module Identifier
+    class Amendment < Supplement
+      def_delegators 'Pubid::Etsi::Identifier::Amendment', :type
+
+      def self.type
+        { key: :amendment, title: "Amendment" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require 'forwardable'
+
+module Pubid::Etsi
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      extend Forwardable
+
+      attr_accessor :version, :published
+
+      def self.type
+        { key: :etsi }
+      end
+
+      def initialize(type:, published:, publisher: "ETSI", version: nil, part: nil, **opts)
+        super(**opts.merge(publisher: publisher))
+        @published = published
+        @version = version
+        @part = part
+        if type
+          unless Identifier.config.type_names.map { |_, v| v[:short] }.include?(type)
+            raise Pubid::Core::Errors::WrongTypeError, "Type '#{type}' is not available"
+          end
+          @type = type
+        end
+      end
+
+      class << self
+        def transform_supplements(type, identifier_params)
+          Identifier.create(
+            type: type,
+            base: transform(
+              **identifier_params.dup.tap { |h| h.delete(type) },
+            ),
+            **identifier_params[type],
+          )
+        end
+
+        # Use Identifier#create to resolve identifier's type class
+        def transform(params)
+          identifier_params = params.map do |k, v|
+            get_transformer_class.new.apply(k => v)
+          end.inject({}, :merge)
+
+          %i(amendment corrigendum).each do |type|
+            return transform_supplements(type, identifier_params) if identifier_params[type]
+          end
+          Identifier.create(**identifier_params)
+        end
+
+        def get_parser_class
+          Parser
+        end
+
+        def get_renderer_class
+          Renderer::Base
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Pubid::Etsi
+  module Identifier
+    class Corrigendum < Supplement
+      def_delegators 'Pubid::Etsi::Identifier::Corrigendum', :type
+
+      def self.type
+        { key: :corrigendum, title: "Corrigendum" }
+      end
+    end
+  end
+end

data/lib/pubid/etsi/identifier/supplement.rb

@@ -0,0 +1,16 @@
+module Pubid::Etsi
+  module Identifier
+    class Supplement < Base
+      attr_accessor :base
+
+      def initialize(base:, number:)
+        @base = base
+        @number = number
+      end
+
+      def to_h
+        @base.to_h.merge(self.type[:key] => super)
+      end
+    end
+  end
+end

data/lib/pubid/etsi/identifier.rb

@@ -0,0 +1,25 @@
+module Pubid::Etsi
+  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|
+          if identifier_type.type_match?(parameters)
+            return identifier_type.new(**parameters.reject { |k, _| k == :type })
+          end
+        end
+
+        @config.default_type.new(**parameters)
+      end
+
+    end
+  end
+end

data/lib/pubid/etsi/parser.rb

@@ -0,0 +1,58 @@
+module Pubid::Etsi
+  class Parser < Pubid::Core::Parser
+    TYPE_NAMES = Identifier.config.type_names.map { |_, v| v[:short] }
+    rule(:edition) do
+      dash >> (digits >> (dot >> digits).maybe).as(:edition)
+    end
+
+    rule(:part) do
+      (dash.ignore >> (digits | match("[A-Z]").repeat(3, 3))).as(:part).repeat(1)
+    end
+
+    rule(:type) do
+      array_to_str(TYPE_NAMES).as(:type)
+    end
+
+    rule(:version) do
+      str("V") >> match("[0-9\.]").repeat(1).as(:version)
+    end
+
+    rule(:published_date) do
+      str("(") >> (year_digits >> dash >> month_digits).as(:published) >> str(")")
+    end
+
+    rule(:edition) do
+      str("ed.") >> digits.as(:edition)
+    end
+
+    rule(:amendment) do
+      str("/A") >> digits.as(:number).as(:amendment)
+    end
+
+    rule(:corrigendum) do
+      str("/C") >> digits.as(:number).as(:corrigendum)
+    end
+
+    rule(:number) do
+      (
+        # for identifiers like ETSI GTS GSM 02.01 V5.5.0
+        (str("GSM ").maybe.ignore >> match('[\d]').repeat(2, 2) >> dot >>
+          match('[\d]').repeat(2, 2)) |
+          (match('[A-Za-z\d]').repeat(3, 3) >>
+          (dash >> match("[A-Z]").repeat(3, 3)).maybe >>
+          (space >> match('\d').repeat(3, 3)).maybe)
+      ).as(:number)
+    end
+
+    # ETSI ETR 299-1 ed.1 (1996-09)
+    # ETSI ETR 298 ed.1 (1996-09)
+    #
+    rule(:identifier) do
+      str("ETSI") >> space >> type >> space >>
+        number >> part.maybe >> amendment.maybe >> corrigendum.maybe >> space >>
+        (version | edition) >> space >> published_date
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

@@ -0,0 +1,37 @@
+module Pubid::Etsi::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    TYPE = "".freeze
+
+    def render_identifier(params)
+      "%{publisher} %{type} %{number}%{part}%{amendment}%{corrigendum}%{version}%{edition}%{published}" % params
+    end
+
+    def render_version(version, _opts, _params)
+      " V#{version}"
+    end
+
+    def render_published(published, _opts, _params)
+      " (#{published})"
+    end
+
+    def render_edition(edition, _opts, _params)
+      " ed.#{edition}"
+    end
+
+    def render_part(part, _opts, _params)
+      if part.is_a?(Array)
+        "-#{part.join("-")}"
+      else
+        "-#{part}"
+      end
+    end
+
+    def render_amendment(amendment, _opts, _params)
+      "/A#{amendment[:number]}"
+    end
+
+    def render_corrigendum(corrigendum, _opts, _params)
+      "/C#{corrigendum[:number]}"
+    end
+  end
+end

data/lib/pubid/etsi/version.rb

@@ -0,0 +1,5 @@
+module Pubid
+  module Etsi
+    VERSION = "0.0.2".freeze
+  end
+end

data/lib/pubid/etsi.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "parslet"
+require "yaml"
+
+module Pubid
+  module Etsi
+
+  end
+end
+
+require "pubid-core"
+
+require_relative "etsi/identifier"
+require_relative "etsi/identifier/base"
+require_relative "etsi/identifier/supplement"
+require_relative "etsi/identifier/amendment"
+require_relative "etsi/identifier/corrigendum"
+require_relative "etsi/renderer/base"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Etsi::Identifier::Base
+config.types = [Pubid::Etsi::Identifier::Base,
+                Pubid::Etsi::Identifier::Amendment,
+                Pubid::Etsi::Identifier::Corrigendum]
+
+config.type_names = {
+  en: {
+    long: "European Standard",
+    short: "EN",
+  },
+  es: {
+    long: "ETSI Standard",
+    short: "ES",
+  },
+  eg: {
+    long: "ETSI Guide",
+    short: "EG",
+  },
+  ts: {
+    long: "Technical Specification",
+    short: "TS",
+  },
+  etr: {
+    long: "European telecommunications report",
+    short: "ETR",
+  },
+  ets: {
+    long: "European telecommunications standard",
+    short: "ETS",
+  },
+  iets: {
+    long: "Provisional ETS",
+    short: "I-ETS",
+  },
+  tbr: {
+    long: "Technical Basis for Regulation",
+    short: "TBR",
+  },
+  tcrtr: {
+    long: "Technical Committee Report - Technical Report",
+    short: "TCRTR",
+  },
+  net: {
+    long: "Norme Européenne de Télécommunication",
+    short: "NET",
+  },
+  gr: {
+    long: "Group Report",
+    short: "GR",
+  },
+  gs: {
+    long: "Group Specification",
+    short: "GS",
+  },
+  sr: {
+    long: "Special Report",
+    short: "SR",
+  },
+  tr: {
+    long: "Technical Report",
+    short: "TR",
+  },
+  gts: {
+    long: "GSM Technical Specification",
+    short: "GTS",
+  }
+}
+Pubid::Etsi::Identifier.set_config(config)
+
+require_relative "etsi/parser"

data/lib/pubid-etsi.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pubid-etsi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-13 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: 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.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+description: Library to generate, parse and manipulate ETSI PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-etsi.rb
+- lib/pubid/etsi.rb
+- lib/pubid/etsi/errors.rb
+- lib/pubid/etsi/identifier.rb
+- lib/pubid/etsi/identifier/amendment.rb
+- lib/pubid/etsi/identifier/base.rb
+- lib/pubid/etsi/identifier/corrigendum.rb
+- lib/pubid/etsi/identifier/supplement.rb
+- lib/pubid/etsi/parser.rb
+- lib/pubid/etsi/renderer/base.rb
+- lib/pubid/etsi/version.rb
+homepage: https://github.com/metanorma/pubid-etsi
+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.3.26
+signing_key: 
+specification_version: 4
+summary: Library to generate, parse and manipulate ETSI PubID.
+test_files: []