pubid-iso 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1f95297e422efe82291fd2570ba264ca9daf1b6304dc3050ae7aebcff532739
+  data.tar.gz: '08f400bc76e43847ae0ae0b7d0c516de05a6a9bdc1dce60abd9b69ca9745b05e'
+SHA512:
+  metadata.gz: 6d2f14cbb013fc0e9097178bc9cf7c3b5255f21699c0e904cbd8bb4aec159464f451c679e5d2f4a24aee9c3c3397d8b882f3fbb89c096104c17da51bfe6cf4f7
+  data.tar.gz: 3d263a1fad953c7e508b2d1936fda41fd4d827f09eb81fecc6b3379acb23502d6852cdaa99860717714934af262eb01a13039b00871af2ef8f11cf97b738e3df

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,2 @@
+= ISO publication identifiers ("ISO PubID")
+

data/lib/pubid/iso/errors.rb

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

data/lib/pubid/iso/identifier.rb

@@ -0,0 +1,46 @@
+module Pubid::Iso
+  class Identifier
+    STAGES = { NP: 10,
+               WD: 20,
+               CD: 30,
+               DIS: 40,
+               FDIS: 50,
+               PRF: 50,
+               IS: 60,
+               Fpr: 50 }.freeze
+
+    attr_accessor :number, :publisher, :copublisher, :stage, :substage, :part,
+                  :type, :year, :edition, :iteration, :supplements, :language
+
+    def initialize(stage: nil, supplements: nil, **opts)
+      if stage
+        @stage = STAGES[stage.to_sym]
+        @substage = 0
+      end
+
+      # XXX: temporary hack for ISO/IEC 19794-7:2014/Amd 1:2015/CD Cor 1 parsing
+      supplements&.each do |supplement|
+        if supplement[:stage]
+          @stage = STAGES[Transformer.new.apply(stage: supplement[:stage].to_s)[:stage].to_sym]
+          @substage = 0
+        end
+      end
+
+      @supplements = supplements
+
+      opts.each { |key, value| send("#{key}=", value.is_a?(Array) && value || value.to_s) }
+    end
+
+    def urn
+      URN.new(self)
+    end
+
+    def self.parse(code)
+      new(**Parser.new.parse(code).map do |k, v|
+        Transformer.new.apply(k => v).to_a.first
+      end.to_h)
+    rescue Parslet::ParseFailed => failure
+      raise Pubid::Iso::Errors::ParseError, "#{failure.message}\ncause: #{failure.parse_failure_cause.ascii_tree}"
+    end
+  end
+end

data/lib/pubid/iso/parser.rb

@@ -0,0 +1,103 @@
+# from https://github.com/relaton/relaton-iso/issues/47#issuecomment-512251416
+# ISO {num}-{docpart}:{year} - docpart and year are optional. docpart is [\w-]+
+#   ISO/{stage} {num}-{docpart}:{year} or ISO/{subprefix} {stage} {num}:{year} - stages are WD, CD, DIS, FDIS, AWI
+# ISO/{subprefix} {stage} {num}-{docpart}:{year} - subpefixes are IEC, IEEE, IEC/IEEE, TR, R. Any other?
+# ISO {num}:{year}/{correction} {cornum}:{coryear} - corrections are Amd, DAmd, Cor. coryear is optional
+# ISO {num}:{year}/{corstage} {correction} {cornum}:{coryear} - corstages are CD, NP, AWI, PRF, WD, DIS. Any others?
+
+module Pubid::Iso
+  # ISO/IEC FDIS 7816-6
+  # ISO/IEC/IEEE 15289:2019
+  #
+  # Stage 10: NP (non-public)
+  # Stage 20: WD (non-public)
+  # Stage 30: CD
+  # Stage 40: DIS
+  # Stage 50: FDIS
+  # Stage 50.60: PRF ("proof") (non-public)
+  # Stage 60: IS
+  class Parser < Parslet::Parser
+    rule(:digits) do
+      match('\d').repeat(1)
+    end
+
+    rule(:stage) do
+      (str("NP") | str("WD") | str("CD") | str("DIS") | str("FDIS") | str("PRF") |
+        str("IS") | str("AWI") | str("FD") | str("D")).as(:stage)
+    end
+
+    # TYPES = {
+    #   "TS" => "technical-specification",
+    #   "TR" => "technical-report",
+    #   "PAS" => "publicly-available-specification",
+    #   "Guide" => "guide",
+    # }.freeze
+    # DATA|GUIDE|ISP|IWA|PAS|R|TR|TS|TTA
+    #       # type          = "data" / "guide" / "isp" / "iwa" /
+    #       #   "pas" / "r" / "tr" / "ts" / "tta"
+    rule(:type) do
+      (str("DATA") | str("ISP") | str("IWA") | str("R") | str("TTA") |
+        str("TS") | str("TR") | str("PAS") | str("Guide")).as(:type)
+    end
+
+    rule(:year) do
+      match('\d').repeat(4, 4)
+    end
+
+    rule(:part) do
+      (str("-") | str("/")) >> str(" ").maybe >>
+        (match['[\dA-Z]'] | str("-")).repeat(1).as(:part)
+    end
+
+    rule(:originator) do
+      organization.as(:publisher) >>
+        (str(" ").maybe >> str("/") >> organization.as(:copublisher)).maybe
+    end
+
+    rule(:organization) do
+      str("IEC/IEEE") | str("IEC") | str("IEEE") | str("CIW") | str("SAE") |
+        str("CIE") | str("ASME") | str("ASTM") | str("OECD") | str("ISO") |
+        str("IWA") | str("HL7")
+    end
+
+    rule(:edition) do
+      str(" ") >> ((str("ED") | str("Ed ") | str("Ed.")) >>
+        digits.as(:edition) | str("Ed").as(:edition))
+    end
+
+    rule(:iteration) do
+      str(".") >> digits.as(:iteration)
+    end
+
+    rule(:supplement) do
+      (str("/") | str(" ")).maybe >>
+        (str("Amd") | str("AMD") | str("Cor") | str("COR")).as(:supplement) >>
+        str(" ") >>
+        digits.as(:supplement_version) >>
+        (str(":") >> digits.as(:supplement_number)).maybe
+    end
+
+    rule(:language) do
+      str("(") >> match["a-z"].repeat(1).as(:language) >> str(")")
+    end
+
+    rule(:identifier) do
+      str("Fpr").as(:stage).maybe >>
+        # Withdrawn e.g: WD/ISO 10360-5:2000
+        str("WD/").maybe >>
+        originator >> ((str(" ") | str("/")) >>
+        # for ISO/FDIS
+        (type | stage)).maybe >>
+        # for ISO/IEC WD TS 25025
+        str(" ").maybe >> ((stage | type) >> str(" ")).maybe >>
+        digits.as(:number) >> part.maybe >> iteration.maybe >>
+        (str(" ").maybe >> str(":") >> year).maybe >>
+        ((str("/") >> stage).maybe >>
+        supplement).repeat.as(:supplements) >>
+        edition.maybe >>
+        language.maybe
+    end
+
+    rule(:root) { identifier }
+  end
+end

data/lib/pubid/iso/transformer.rb

@@ -0,0 +1,19 @@
+module Pubid::Iso
+  class Transformer < Parslet::Transform
+    rule(edition: "Ed") do
+      { edition: "1" }
+    end
+
+    rule(stage: simple(:stage)) do
+      { stage: case stage
+               when "D"
+                 "DIS"
+               when "FD"
+                 "FDIS"
+               else
+                 stage
+               end
+      }
+    end
+  end
+end

data/lib/pubid/iso/urn.rb

@@ -0,0 +1,69 @@
+module Pubid::Iso
+  class URN
+    attr_accessor :identifier
+
+    def initialize(identifier)
+      @identifier = identifier
+    end
+
+    def to_s
+      # docidentifier = originator [":" type] ":" docnumber [":" partnumber]
+      # [[":" status] ":" edition]
+      # [":" docversion] [":" language]
+
+      "urn:iso:std:#{originator}#{type}:#{identifier.number}#{part}#{stage}#{edition}#{supplement}#{language}"
+    end
+
+    def part
+      ":-#{identifier.part}" if identifier.part
+    end
+
+    def stage
+      ":stage-#{identifier.stage}.#{sprintf('%02d', identifier.substage)}#{iteration}" if identifier.stage
+    end
+
+    def originator
+      # originator    = "iso" / "iso-iec" / "iso-cie" / "iso-astm" /
+      #   "iso-ieee" / "iec"
+
+      if identifier.copublisher
+        "#{identifier.publisher.downcase}-#{identifier.copublisher.downcase.gsub('/', '-')}"
+      else
+        identifier.publisher.downcase
+      end
+    end
+
+    def edition
+      ":ed-#{identifier.edition}" if identifier.edition
+    end
+
+    def iteration
+      ".v#{identifier.iteration}" if identifier.iteration
+    end
+
+    def type
+      # type          = "data" / "guide" / "isp" / "iwa" /
+      #   "pas" / "r" / "tr" / "ts" / "tta"
+
+      if identifier.type
+        ":#{identifier.type.downcase}"
+      end
+    end
+
+    def supplement
+      identifier.supplements&.map do |supplement|
+        if supplement[:supplement_number]
+          ":#{supplement[:supplement].to_s.downcase}:#{supplement[:supplement_number]}:v#{supplement[:supplement_version]}"
+        else
+          ":#{supplement[:supplement].to_s.downcase}:v#{supplement[:supplement_version]}"
+        end
+      end&.join
+    end
+
+    def language
+      if identifier.language
+        ":#{identifier.language}"
+      end
+    end
+  end
+end

data/lib/pubid/iso/version.rb

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

data/lib/pubid/iso.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+  module Iso
+
+  end
+end
+
+require_relative "iso/errors"
+require_relative "iso/parser"
+require_relative "iso/transformer"
+require_relative "iso/urn"
+require_relative "iso/identifier"

data/lib/pubid-iso.rb

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

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: pubid-iso
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-06 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'
+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-iso.rb
+- lib/pubid/iso.rb
+- lib/pubid/iso/errors.rb
+- lib/pubid/iso/identifier.rb
+- lib/pubid/iso/parser.rb
+- lib/pubid/iso/transformer.rb
+- lib/pubid/iso/urn.rb
+- lib/pubid/iso/version.rb
+homepage: https://github.com/metanorma/pubid-iso
+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.3
+signing_key:
+specification_version: 4
+summary: Library to generate, parse and manipulate ISO PubID.
+test_files: []