pubid-bsi 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a23f485f876d0c481d572df9a92cb60e2a61e1572f93605723366d341f2d7704
-  data.tar.gz: 10d63e91c4330d2a0f1192a46d7062b252308c4a1ec75946379d89d6e90d87a9
+  metadata.gz: 93e79aa30559f8e41d5b9cb74e4b3d5e808188a615d8f3311fadfdf6709d58e4
+  data.tar.gz: e544f503afb1e40eb7ba2cec6efa945357bac3e72234e0ffe05f5f87ce2c07ad
 SHA512:
-  metadata.gz: 871a55125a1691fe020e80574de9ac45d526d736427d5b736625458b45004174f12288ef244e37ec10c06d4c4a60d59fbce4653d8f1ee83d06044850f0bad7fc
-  data.tar.gz: eb5570d84e4cdb28c460aac841ce3e8813fda6ce13328004d30891801070ec78d5f871dc4a392156f28d68d8a6a87575453c1ada18c8aba6b0f2d6478f3ed02a
+  metadata.gz: 7cde8daf524af5296c9ed7ace2eb757b47ddeec768eee945d47a7eb3d305e12fa1495d9a88497a63ee6895bd4e12cdaa49a0d578fb44599252739d3e975a4da2
+  data.tar.gz: 208451435217ad215d3209799d929d14329cc7d026e4d532667732a4900b227327190ea78fdf39ed8cdf57fb3903abed97223bfbe49308630cc3fa8de44189c8

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

@@ -3,30 +3,72 @@ require 'forwardable'
 module Pubid::Bsi
   module Identifier
     class Base < Pubid::Core::Identifier::Base
-      attr_accessor :month, :supplement, :adopted
+      attr_accessor :month, :supplement, :adopted, :tracked_changes, :translation, :pdf
+
       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)
+                     supplement: nil, number: nil, adopted: nil,
+                     expert_commentary: false, tracked_changes: false,
+                     translation: nil, pdf: false, **opts)
+
         super(**opts.merge(publisher: publisher, number: number))
         @month = month if month
         @edition = edition if edition
         @supplement = supplement
         @adopted = adopted
+        @tracked_changes = tracked_changes
+        @translation = translation
+        @pdf = pdf
       end
 
       class << self
+        def transform_hash(params)
+          params.map do |k, v|
+            get_transformer_class.new.apply(k => v.is_a?(Hash) ? transform_hash(v) : v)
+          end.inject({}, :merge)
+        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)
+          identifier_params = transform_hash(params)
+
+          if identifier_params[:national_annex]
+            return transform_national_annex(
+              identifier_params[:national_annex],
+              identifier_params.dup.tap { |h| h.delete(:national_annex) })
+          end
+
+          return transform_expert_commentary(identifier_params) if identifier_params[:expert_commentary]
+
+          return transform_collection(identifier_params) if identifier_params[:second_number]
 
           Identifier.create(**identifier_params)
         end
 
+        def transform_collection(params)
+          first_identifier_params =
+            params.reject { |k, _| %i[second_number year supplement].include?(k) }
+          second_identifier_params = first_identifier_params.dup
+          second_identifier_params[:number] = params[:second_number]
+          Collection.new(identifiers: [Identifier.create(**first_identifier_params),
+                                       Identifier.create(**second_identifier_params)],
+                         **params.slice(:supplement, :year))
+        end
+
+        def transform_expert_commentary(base_params)
+          Identifier.create(type: :ec,
+                            base: Identifier.create(**base_params))
+        end
+
+        def transform_national_annex(params, base_params)
+          Identifier.create(type: params[:type],
+                            supplement: params[:supplement],
+                            base: Identifier.create(**base_params))
+        end
+
         def get_parser_class
           Parser
         end

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

@@ -0,0 +1,22 @@
+module Pubid::Bsi
+  module Identifier
+    class Collection < Base
+      def_delegators 'Pubid::Bsi::Identifier::Collection', :type
+
+      attr_accessor :identifiers
+
+      def initialize(identifiers:, **args)
+        @identifiers = identifiers
+        super(publisher: nil, number: nil, **args)
+      end
+
+      def self.type
+        { key: :collection, title: "Collection" }
+      end
+
+      def to_s
+        Renderer::Collection.new(get_params).render
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Pubid::Bsi
+  module Identifier
+    class ExpertCommentary < Base
+      attr_accessor :base
+
+      def_delegators 'Pubid::Bsi::Identifier::ExpertCommentary', :type
+
+      def initialize(base: nil, **opts)
+        super(**opts)
+        @base = base
+      end
+
+      def self.type
+        { key: :ec, title: "Expert Commentary", short: "ExComm" }
+      end
+
+      def self.get_renderer_class
+        Renderer::ExpertCommentary
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Pubid::Bsi
+  module Identifier
+    class NationalAnnex < Base
+      attr_accessor :base
+
+      def_delegators 'Pubid::Bsi::Identifier::NationalAnnex', :type
+
+      def initialize(base: nil, **opts)
+
+        super(**opts)
+        @base = base
+      end
+
+      def self.type
+        { key: :na, title: "National Annex", short: "NA" }
+      end
+
+      def self.get_renderer_class
+        Renderer::NationalAnnex
+      end
+    end
+  end
+end

data/lib/pubid/bsi/parser.rb

@@ -1,7 +1,11 @@
 module Pubid::Bsi
   class Parser < Pubid::Core::Parser
+    rule(:year) do
+      match('\d').repeat(2, 4).as(:year)
+    end
+
     rule(:type) do
-      array_to_str(Identifier.config.types.map { |type| type.type[:short] }.compact).as(:type)
+      national_annex.maybe >> array_to_str(Identifier.config.types.map { |type| type.type[:short] }.compact).as(:type)
     end
 
     rule(:part) do
@@ -13,17 +17,46 @@ module Pubid::Bsi
     end
 
     rule(:supplement) do
-      (str("+") >> match("[AC]").as(:type) >> digits.as(:number) >> str(":") >> year).as(:supplement)
+      (str("+") >> match("[AC]").as(:type) >> digits.as(:number) >> (str(":") >> year).maybe).as(:supplement)
+    end
+
+    rule(:expert_commentary) do
+      space >> str("ExComm").as(:expert_commentary)
+    end
+
+    rule(:tracked_changes) do
+      str(" - TC").as(:tracked_changes)
+    end
+
+    rule(:national_annex) do
+      (str("NA").as(:type) >> supplement.maybe >> str(" to ").ignore).as(:national_annex)
+    end
+
+    rule(:translation) do
+      # space >> (match("[A-Z]").repeat(1).as(:translation) >> str(" TRANSLATION"))
+      space >> ((str("(") >> match("[A-Za-z]").repeat(1).as(:translation) >>
+        (space >> (str("Translation") | str("version"))).maybe >> str(")")) |
+        (match("[A-Z]").repeat(1).as(:translation) >> str(" TRANSLATION"))
+      )
+    end
+
+    rule(:pdf) do
+      space >> str("PDF").as(:pdf)
+    end
+
+    rule(:second_number) do
+      str("/") >> digits.as(:second_number)
     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)
-        )
+          (digits.as(:number) >> second_number.maybe >> part.maybe >> (space >> edition).maybe >>
+            (space? >> str(":") >> year >> (dash >> month_digits.as(:month)).maybe).maybe) |
+            # exclude expert_commentary and translation from adopted scope
+            (expert_commentary.absent? >> translation.absent? >> space? >>
+              match("[^+ ]").repeat(1)).repeat.as(:adopted)
+        ) >> supplement.maybe >> expert_commentary.maybe >> tracked_changes.maybe >> translation.maybe >> pdf.maybe
     end
 
     rule(:root) { identifier }

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

@@ -3,9 +3,10 @@ module Pubid::Bsi::Renderer
     TYPE = "".freeze
 
     def render_identifier(params)
-      return "%{publisher} %{adopted}" % params unless params[:adopted].to_s.empty?
+      suffix = "%{supplement}%{tracked_changes}%{translation}%{pdf}" % params
+      return "%{publisher} %{adopted}#{suffix}" % params unless params[:adopted].to_s.empty?
 
-      "%{publisher} %{number}%{part}%{edition}%{year}%{month}%{supplement}" % params
+      "%{publisher} %{number}%{part}%{edition}%{year}%{month}#{suffix}" % params
     end
 
     def render_month(month, _opts, _params)
@@ -19,5 +20,17 @@ module Pubid::Bsi::Renderer
     def render_supplement(supplement, _opts, _params)
       supplement.to_s
     end
+
+    def render_tracked_changes(tracked_changes, _opts, _params)
+      " - TC" if tracked_changes
+    end
+
+    def render_translation(translation, _opts, _params)
+      " (#{translation})"
+    end
+
+    def render_pdf(pdf, _opts, _params)
+      " PDF" if pdf
+    end
   end
 end

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

@@ -0,0 +1,15 @@
+module Pubid::Bsi::Renderer
+  class Collection < Pubid::Core::Renderer::Base
+    def render_identifier(params)
+      "%{identifiers}%{year}%{supplement}" % params
+    end
+
+    def render_supplement(supplement, _opts, _params)
+      supplement.to_s
+    end
+
+    def render_identifiers(identifiers, _opts, _params)
+      "#{identifiers.first}/" + identifiers[1..-1].map(&:number).join("/")
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class ExpertCommentary < Base
+    def render_identifier(params)
+      "%{base} ExComm" % params
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require_relative "base"
+
+module Pubid::Bsi::Renderer
+  class NationalAnnex < Base
+
+    def render_identifier(params)
+      "NA%{supplement} to %{base}" % params
+    end
+  end
+end

data/lib/pubid/bsi/transformer.rb

@@ -4,6 +4,14 @@ require_relative "renderer/base"
 module Pubid::Bsi
   class Transformer < Parslet::Transform
     rule(supplement: subtree(:supplement)) do |context|
+      if context[:supplement][:year] && context[:supplement][:year].to_s.length == 2
+        context[:supplement][:year] = if context[:supplement][:year].to_i > 50
+                                        "19#{context[:supplement][:year]}"
+                                      else
+                                        "20#{context[:supplement][:year]}"
+                                      end
+      end
+
       { supplement:
           case context[:supplement][:type]
           when "A"
@@ -17,7 +25,15 @@ module Pubid::Bsi
     rule(adopted: subtree(:adopted)) do |context|
       { adopted: Pubid::Iec::Identifier.parse(context[:adopted].to_s) }
     rescue Pubid::Core::Errors::ParseError
+      begin
       { adopted: Pubid::Iso::Identifier.parse(context[:adopted].to_s) }
+      rescue Pubid::Core::Errors::ParseError
+        { adopted: Pubid::Cen::Identifier.parse(context[:adopted].to_s) }
+      end
+    end
+
+    rule(translation: simple(:translation)) do
+      { translation: translation.to_s.downcase.capitalize }
     end
   end
 end

data/lib/pubid/bsi/version.rb

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

data/lib/pubid/bsi.rb

@@ -8,6 +8,7 @@ end
 require "pubid-core"
 require "pubid-iso"
 require "pubid-iec"
+require "pubid-cen"
 
 require_relative "bsi/errors"
 require_relative "bsi/transformer"
@@ -19,6 +20,9 @@ require_relative "bsi/identifier/draft_document"
 require_relative "bsi/identifier/flex"
 require_relative "bsi/identifier/amendment"
 require_relative "bsi/identifier/corrigendum"
+require_relative "bsi/identifier/national_annex"
+require_relative "bsi/identifier/expert_commentary"
+require_relative "bsi/identifier/collection"
 require_relative "bsi/renderer/base"
 require_relative "bsi/renderer/publicly_available_specification"
 require_relative "bsi/renderer/published_document"
@@ -26,6 +30,9 @@ require_relative "bsi/renderer/draft_document"
 require_relative "bsi/renderer/flex"
 require_relative "bsi/renderer/amendment"
 require_relative "bsi/renderer/corrigendum"
+require_relative "bsi/renderer/national_annex"
+require_relative "bsi/renderer/expert_commentary"
+require_relative "bsi/renderer/collection"
 require_relative "bsi/parser"
 require_relative "bsi/identifier"
 
@@ -37,7 +44,10 @@ config.types = [Pubid::Bsi::Identifier::BritishStandard,
                 Pubid::Bsi::Identifier::PublishedDocument,
                 Pubid::Bsi::Identifier::DraftDocument,
                 Pubid::Bsi::Identifier::Amendment,
-                Pubid::Bsi::Identifier::Corrigendum]
+                Pubid::Bsi::Identifier::Corrigendum,
+                Pubid::Bsi::Identifier::NationalAnnex,
+                Pubid::Bsi::Identifier::ExpertCommentary,
+                Pubid::Bsi::Identifier::Collection]
 config.type_names = {
                       bs: {
                         long: "British Standard",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubid-bsi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,42 +100,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: pubid-iso
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: pubid-iec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: pubid-cen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: Library to generate, parse and manipulate ISO PubID.
 email:
 - open.source@ribose.com
@@ -154,17 +168,23 @@ files:
 - lib/pubid/bsi/identifier/amendment.rb
 - lib/pubid/bsi/identifier/base.rb
 - lib/pubid/bsi/identifier/british_standard.rb
+- lib/pubid/bsi/identifier/collection.rb
 - lib/pubid/bsi/identifier/corrigendum.rb
 - lib/pubid/bsi/identifier/draft_document.rb
+- lib/pubid/bsi/identifier/expert_commentary.rb
 - lib/pubid/bsi/identifier/flex.rb
+- lib/pubid/bsi/identifier/national_annex.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/collection.rb
 - lib/pubid/bsi/renderer/corrigendum.rb
 - lib/pubid/bsi/renderer/draft_document.rb
+- lib/pubid/bsi/renderer/expert_commentary.rb
 - lib/pubid/bsi/renderer/flex.rb
+- lib/pubid/bsi/renderer/national_annex.rb
 - lib/pubid/bsi/renderer/publicly_available_specification.rb
 - lib/pubid/bsi/renderer/published_document.rb
 - lib/pubid/bsi/transformer.rb