pubid-iho 1.15.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01f5399345d0c833d5ad0242b5fd0c6d81e32d302816bdcfbf9066afb7b35850
+  data.tar.gz: b367f737353afc92cbc93d61fc92c6d4f47296db7edd054a7a8d61f1b710fd92
+SHA512:
+  metadata.gz: 4676d43aaa9349f610d54e5ab9a566719485e4cbf7e354954269782410e3cf673d1b5339d2add2886d9de97ef4472b6895a36a31cc8f72ee1685b3c837391264
+  data.tar.gz: 1d934efc20a0f636cc0b7b7a04ac3c853a4927704c2cdc78df25f8a3bed7c58b069d399ec3c8d7d54528960c49fc05fbe17bb4e7c1fc807dac2a00681e3e69f2

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,44 @@
+= IHO publication identifiers ("IHO PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and render IHO (International
+Hydrographic Organization) publication identifiers.
+
+== Usage
+
+=== Parsing
+
+[source,ruby]
+----
+require "pubid-iho"
+
+pubid = Pubid::Iho::Identifier.parse("IHO S-100 5.2.0")
+pubid.to_s
+# => "IHO S-100 5.2.0"
+
+pubid = Pubid::Iho::Identifier.parse("IHO S-100 Part 1 1.0.0")
+pubid.to_s
+# => "IHO S-100 Part 1 1.0.0"
+
+pubid = Pubid::Iho::Identifier.parse("IHO S-65 Ap. B 1.2.0")
+pubid.to_s
+# => "IHO S-65 Ap. B 1.2.0"
+----
+
+The `IHO` prefix is optional on input and added on render:
+
+[source,ruby]
+----
+Pubid::Iho::Identifier.parse("S-44 5.0.0").to_s
+# => "IHO S-44 5.0.0"
+----
+
+=== Identifier creation
+
+[source,ruby]
+----
+pubid = Pubid::Iho::Identifier.create(type: "S", number: "100", part: "1", version: "1.0.0")
+pubid.to_s
+# => "IHO S-100 Part 1 1.0.0"
+----

data/lib/pubid/iho/errors.rb

@@ -0,0 +1,4 @@
+module Pubid::Iho
+  module Errors
+  end
+end

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

@@ -0,0 +1,42 @@
+module Pubid::Iho
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      attr_accessor :version, :appendix
+
+      def self.type
+        { key: :iho }
+      end
+
+      def initialize(type:, publisher: "IHO", version: nil, part: nil, appendix: nil, **opts)
+        super(**opts.merge(publisher: publisher))
+        @part = part.to_s if part
+        @version = version.to_s if version
+        @appendix = appendix.to_s if appendix
+        if type
+          unless Identifier.config.type_names.map { |_, v| v[:short] }.include?(type.to_s)
+            raise Pubid::Core::Errors::WrongTypeError, "Type '#{type}' is not available"
+          end
+          @type = type.to_s
+        end
+      end
+
+      class << self
+        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
+      end
+    end
+  end
+end

data/lib/pubid/iho/identifier.rb

@@ -0,0 +1,24 @@
+module Pubid::Iho
+  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/iho/parser.rb

@@ -0,0 +1,34 @@
+module Pubid::Iho
+  class Parser < Pubid::Core::Parser
+    rule(:series) do
+      array_to_str(%w[S P M B C]).as(:type)
+    end
+
+    rule(:number_suffix) do
+      (str(":") >> digits) | (str("/") >> digits) | (dash >> digits) | match("[A-Z]")
+    end
+
+    rule(:number) do
+      (digits >> number_suffix.maybe).as(:number)
+    end
+
+    rule(:appendix) do
+      space >> str("Ap.") >> space >> (digits | match("[A-Z]")).as(:appendix)
+    end
+
+    rule(:part) do
+      space >> str("Part") >> space >> (digits | match("[A-Z]")).as(:part)
+    end
+
+    rule(:version) do
+      space >> (digits >> dot >> digits >> dot >> digits).as(:version)
+    end
+
+    rule(:identifier) do
+      (str("IHO") >> space).maybe >> series >> dash >> number >>
+        appendix.maybe >> part.maybe >> version.maybe
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

@@ -0,0 +1,19 @@
+module Pubid::Iho::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    def render_identifier(params)
+      "%{publisher} %{type}-%{number}%{appendix}%{part}%{version}" % params
+    end
+
+    def render_part(part, _opts, _params)
+      " Part #{part}"
+    end
+
+    def render_appendix(appendix, _opts, _params)
+      " Ap. #{appendix}"
+    end
+
+    def render_version(version, _opts, _params)
+      " #{version}"
+    end
+  end
+end

data/lib/pubid/iho/version.rb

@@ -0,0 +1,5 @@
+module Pubid
+  module Iho
+    VERSION = "1.15.14".freeze
+  end
+end

data/lib/pubid/iho.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+  module Iho
+  end
+end
+
+require "pubid-core"
+
+require_relative "iho/version"
+require_relative "iho/errors"
+require_relative "iho/identifier"
+require_relative "iho/identifier/base"
+require_relative "iho/renderer/base"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Iho::Identifier::Base
+config.types = [Pubid::Iho::Identifier::Base]
+
+config.type_names = {
+  s: {
+    long: "Standards and Specifications",
+    short: "S",
+  },
+  p: {
+    long: "Publication",
+    short: "P",
+  },
+  m: {
+    long: "Miscellaneous Publication",
+    short: "M",
+  },
+  b: {
+    long: "Bibliographic Publication",
+    short: "B",
+  },
+  c: {
+    long: "Circular Letter",
+    short: "C",
+  },
+}
+Pubid::Iho::Identifier.set_config(config)
+
+require_relative "iho/parser"

data/lib/pubid-iho.rb

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: pubid-iho
+version: !ruby/object:Gem::Version
+  version: 1.15.14
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-04-28 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.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.15.14
+description: Library to generate, parse and manipulate IHO PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-iho.rb
+- lib/pubid/iho.rb
+- lib/pubid/iho/errors.rb
+- lib/pubid/iho/identifier.rb
+- lib/pubid/iho/identifier/base.rb
+- lib/pubid/iho/parser.rb
+- lib/pubid/iho/renderer/base.rb
+- lib/pubid/iho/version.rb
+homepage: https://github.com/metanorma/pubid-iho
+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 IHO PubID.
+test_files: []