pubid-bsi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a23f485f876d0c481d572df9a92cb60e2a61e1572f93605723366d341f2d7704
+  data.tar.gz: 10d63e91c4330d2a0f1192a46d7062b252308c4a1ec75946379d89d6e90d87a9
+SHA512:
+  metadata.gz: 871a55125a1691fe020e80574de9ac45d526d736427d5b736625458b45004174f12288ef244e37ec10c06d4c4a60d59fbce4653d8f1ee83d06044850f0bad7fc
+  data.tar.gz: eb5570d84e4cdb28c460aac841ce3e8813fda6ce13328004d30891801070ec78d5f871dc4a392156f28d68d8a6a87575453c1ada18c8aba6b0f2d6478f3ed02a

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,51 @@
+= BSI publication identifiers ("BSI PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize BSI publication
+identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-bsi gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-bsi"
+
+pubid = Pubid::Bsi::Identifier.create(number: 1234, part: 1, year: 1999)
+pubid.to_s
+
+=> "BS 1234-1:1999"
+----
+
+=== With document type
+
+[source,ruby]
+----
+pubid = Pubid::Bsi::Identifier.create(type: :pas, number: 1234)
+pubid.to_s
+
+=> "PAS 1234"
+----
+
+=== Identifier's class and type
+
+`Identifier#parse` resolves a parsed identifier according to the type.
+
+[source,ruby]
+----
+Pubid::Iso::Identifier.parse("PAS 1234").class
+# => Pubid::Bsi::Identifier::PubliclyAvailableSpecification
+Pubid::Iso::Identifier.parse("PAS 1234").type
+# => {:key=>:pas, :title=>"Publicly Available Specification"}
+Pubid::Iso::Identifier.parse("BS 1234").class
+# => Pubid::Bsi::Identifier::BritishStandard
+Pubid::Iso::Identifier.parse("BS 1234").type
+# => {:key=>:bs, :title=>"British Standard"}

data/lib/pubid/bsi/errors.rb

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

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

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

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

@@ -0,0 +1,44 @@
+require 'forwardable'
+
+module Pubid::Bsi
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      attr_accessor :month, :supplement, :adopted
+      extend Forwardable
+
+      # @param month [Integer] document's month
+      # @param edition [String] document's edition version, e.g. "3.0", "1.0"
+      def initialize(publisher: "BS", month: nil, edition: nil,
+                     supplement: nil, number: nil, adopted: nil, **opts)
+        super(**opts.merge(publisher: publisher, number: number))
+        @month = month if month
+        @edition = edition if edition
+        @supplement = supplement
+        @adopted = adopted
+      end
+
+      class << self
+        # 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)
+
+          Identifier.create(**identifier_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/bsi/identifier/british_standard.rb

@@ -0,0 +1,11 @@
+module Pubid::Bsi
+  module Identifier
+    class BritishStandard < Base
+      def_delegators 'Pubid::Bsi::Identifier::BritishStandard', :type
+
+      def self.type
+        { key: :bs, title: "British Standard", short: "BS" }
+      end
+    end
+  end
+end

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

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

data/lib/pubid/bsi/identifier/draft_document.rb

@@ -0,0 +1,15 @@
+module Pubid::Bsi
+  module Identifier
+    class DraftDocument < Base
+      def_delegators 'Pubid::Bsi::Identifier::DraftDocument', :type
+
+      def self.type
+        { key: :dd, title: "Draft Document", short: "DD" }
+      end
+
+      def self.get_renderer_class
+        Renderer::DraftDocument
+      end
+    end
+  end
+end

data/lib/pubid/bsi/identifier/flex.rb

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

data/lib/pubid/bsi/identifier/publicly_available_specification.rb

@@ -0,0 +1,15 @@
+module Pubid::Bsi
+  module Identifier
+    class PubliclyAvailableSpecification < Base
+      def_delegators 'Pubid::Bsi::Identifier::PubliclyAvailableSpecification', :type
+
+      def self.type
+        { key: :pas, title: "Publicly Available Specification", short: "PAS" }
+      end
+
+      def self.get_renderer_class
+        Renderer::PubliclyAvailableSpecification
+      end
+    end
+  end
+end

data/lib/pubid/bsi/identifier/published_document.rb

@@ -0,0 +1,15 @@
+module Pubid::Bsi
+  module Identifier
+    class PublishedDocument < Base
+      def_delegators 'Pubid::Bsi::Identifier::PublishedDocument', :type
+
+      def self.type
+        { key: :pd, title: "Published Document", short: "PD" }
+      end
+
+      def self.get_renderer_class
+        Renderer::PublishedDocument
+      end
+    end
+  end
+end

data/lib/pubid/bsi/identifier.rb

@@ -0,0 +1,18 @@
+module Pubid::Bsi
+  module Identifier
+    class << self
+      include Pubid::Core::Identifier
+
+      # @see Pubid::Identifier::Base.parse
+      def parse(*args)
+        Pubid::Iec::Identifier.parse(*args)
+      rescue Pubid::Core::Errors::ParseError
+        begin
+          Base.parse(*args)
+        rescue Pubid::Core::Errors::ParseError
+          Pubid::Iso::Identifier.parse(*args)
+        end
+      end
+    end
+  end
+end

data/lib/pubid/bsi/parser.rb

@@ -0,0 +1,31 @@
+module Pubid::Bsi
+  class Parser < Pubid::Core::Parser
+    rule(:type) do
+      array_to_str(Identifier.config.types.map { |type| type.type[:short] }.compact).as(:type)
+    end
+
+    rule(:part) do
+      str("-") >> digits.as(:part)
+    end
+
+    rule(:edition) do
+      str("v") >> (digits >> dot >> digits).as(:edition)
+    end
+
+    rule(:supplement) do
+      (str("+") >> match("[AC]").as(:type) >> digits.as(:number) >> str(":") >> year).as(:supplement)
+    end
+
+    rule(:identifier) do
+      str("BSI ").maybe >> type >> space >>
+        (
+          (digits.as(:number) >> part.maybe >> (space >> edition).maybe >>
+            (space? >> str(":") >> year >> (dash >> month_digits.as(:month)).maybe).maybe >>
+            supplement.maybe) |
+          match(".").repeat(1).as(:adopted)
+        )
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class Amendment < Pubid::Core::Renderer::Base
+    def render_identifier(params)
+      "+A%{number}%{year}" % params
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Pubid::Bsi::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    TYPE = "".freeze
+
+    def render_identifier(params)
+      return "%{publisher} %{adopted}" % params unless params[:adopted].to_s.empty?
+
+      "%{publisher} %{number}%{part}%{edition}%{year}%{month}%{supplement}" % params
+    end
+
+    def render_month(month, _opts, _params)
+      "-#{month}"
+    end
+
+    def render_edition(edition, _opts, _params)
+      " v#{edition}"
+    end
+
+    def render_supplement(supplement, _opts, _params)
+      supplement.to_s
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class Corrigendum < Pubid::Core::Renderer::Base
+    def render_identifier(params)
+      "+C%{number}%{year}" % params
+    end
+  end
+end

data/lib/pubid/bsi/renderer/draft_document.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class DraftDocument < Base
+
+    TYPE = "DD".freeze
+
+    def render_publisher(_publisher, _, _)
+      TYPE
+    end
+  end
+end

data/lib/pubid/bsi/renderer/flex.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class Flex < Base
+
+    TYPE = "Flex".freeze
+
+    def render_publisher(_publisher, _, _)
+      "BSI #{TYPE}"
+    end
+  end
+end

data/lib/pubid/bsi/renderer/publicly_available_specification.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class PubliclyAvailableSpecification < Base
+
+    TYPE = "PAS".freeze
+
+    def render_publisher(_publisher, _, _)
+      TYPE
+    end
+  end
+end

data/lib/pubid/bsi/renderer/published_document.rb

@@ -0,0 +1,12 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class PublishedDocument < Base
+
+    TYPE = "PD".freeze
+
+    def render_publisher(_publisher, _, _)
+      TYPE
+    end
+  end
+end

data/lib/pubid/bsi/transformer.rb

@@ -0,0 +1,23 @@
+require_relative "identifier/base"
+require_relative "renderer/base"
+
+module Pubid::Bsi
+  class Transformer < Parslet::Transform
+    rule(supplement: subtree(:supplement)) do |context|
+      { supplement:
+          case context[:supplement][:type]
+          when "A"
+            Identifier::Amendment.new(**context[:supplement])
+          when "C"
+            Identifier::Corrigendum.new(**context[:supplement])
+          end
+       }
+    end
+
+    rule(adopted: subtree(:adopted)) do |context|
+      { adopted: Pubid::Iec::Identifier.parse(context[:adopted].to_s) }
+    rescue Pubid::Core::Errors::ParseError
+      { adopted: Pubid::Iso::Identifier.parse(context[:adopted].to_s) }
+    end
+  end
+end

data/lib/pubid/bsi/type.rb

@@ -0,0 +1,17 @@
+module Pubid::Bsi
+  class Type < Pubid::Core::Type
+
+    DEFAULT_TYPE = :bs
+
+    TYPE_NAMES = {
+      bs: {
+        long: "British Standard",
+        short: "BS",
+      },
+      pas: {
+        long: "Publicly Available Specification",
+        short: "PAS",
+      },
+    }.freeze
+  end
+end

data/lib/pubid/bsi/version.rb

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

data/lib/pubid/bsi.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+end
+
+require "pubid-core"
+require "pubid-iso"
+require "pubid-iec"
+
+require_relative "bsi/errors"
+require_relative "bsi/transformer"
+require_relative "bsi/identifier/base"
+require_relative "bsi/identifier/british_standard"
+require_relative "bsi/identifier/publicly_available_specification"
+require_relative "bsi/identifier/published_document"
+require_relative "bsi/identifier/draft_document"
+require_relative "bsi/identifier/flex"
+require_relative "bsi/identifier/amendment"
+require_relative "bsi/identifier/corrigendum"
+require_relative "bsi/renderer/base"
+require_relative "bsi/renderer/publicly_available_specification"
+require_relative "bsi/renderer/published_document"
+require_relative "bsi/renderer/draft_document"
+require_relative "bsi/renderer/flex"
+require_relative "bsi/renderer/amendment"
+require_relative "bsi/renderer/corrigendum"
+require_relative "bsi/parser"
+require_relative "bsi/identifier"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Bsi::Identifier::BritishStandard
+config.types = [Pubid::Bsi::Identifier::BritishStandard,
+                Pubid::Bsi::Identifier::Flex,
+                Pubid::Bsi::Identifier::PubliclyAvailableSpecification,
+                Pubid::Bsi::Identifier::PublishedDocument,
+                Pubid::Bsi::Identifier::DraftDocument,
+                Pubid::Bsi::Identifier::Amendment,
+                Pubid::Bsi::Identifier::Corrigendum]
+config.type_names = {
+                      bs: {
+                        long: "British Standard",
+                        short: "BS",
+                      },
+                      pas: {
+                        long: "Publicly Available Specification",
+                        short: "PAS",
+                      },
+                    }.freeze
+Pubid::Bsi::Identifier.set_config(config)

data/lib/pubid-bsi.rb

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

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: pubid-bsi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-01 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.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: pubid-iso
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: pubid-iec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Library to generate, parse and manipulate ISO PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-bsi.rb
+- lib/pubid/bsi.rb
+- lib/pubid/bsi/errors.rb
+- lib/pubid/bsi/identifier.rb
+- lib/pubid/bsi/identifier/amendment.rb
+- lib/pubid/bsi/identifier/base.rb
+- lib/pubid/bsi/identifier/british_standard.rb
+- lib/pubid/bsi/identifier/corrigendum.rb
+- lib/pubid/bsi/identifier/draft_document.rb
+- lib/pubid/bsi/identifier/flex.rb
+- lib/pubid/bsi/identifier/publicly_available_specification.rb
+- lib/pubid/bsi/identifier/published_document.rb
+- lib/pubid/bsi/parser.rb
+- lib/pubid/bsi/renderer/amendment.rb
+- lib/pubid/bsi/renderer/base.rb
+- lib/pubid/bsi/renderer/corrigendum.rb
+- lib/pubid/bsi/renderer/draft_document.rb
+- lib/pubid/bsi/renderer/flex.rb
+- lib/pubid/bsi/renderer/publicly_available_specification.rb
+- lib/pubid/bsi/renderer/published_document.rb
+- lib/pubid/bsi/transformer.rb
+- lib/pubid/bsi/type.rb
+- lib/pubid/bsi/version.rb
+homepage: https://github.com/metanorma/pubid-bsi
+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 ISO PubID.
+test_files: []