pubid-jis 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaeab5258bdddf833c4ab9918d0973abfb23993ac3e6433b9fd73e4c9c6b2f6d
+  data.tar.gz: ef707e6ec8b8d989b2376a46266388c4a9fdb1f577b25b991accf56dcc772877
+SHA512:
+  metadata.gz: 450467f6397bad16e962d7b15628d1cb8b91d169cf5d6d76b551593b63a99df3a1910bfd415b97ac805964c6b31eb3ca76649f3c0c3d9caeb599fc1e55d4c1dc
+  data.tar.gz: 1a1ba91e716740b9d1e9b135a9c72e3dca0f351ce0682d9fc92bf763e3438df6d706be880f15f6e5f2821c14032c273ebe45de0c36d89ce02a681aadca7797d7

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 @@
+= JIS publication identifiers ("JIS PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize JIS publication
+identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-jis gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-jis"
+
+pubid = Pubid::Jis::Identifier.create(number: 1234, series: "A", part: 1, year: 1999, language: "E")
+pubid.to_s
+
+=> "JIS A 1234-1:1999(E)"
+----

data/lib/pubid/jis/errors.rb

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

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

@@ -0,0 +1,24 @@
+require_relative "../renderer/amendment"
+
+module Pubid::Jis
+  module Identifier
+    class Amendment < Base
+      attr_accessor :base
+
+      def_delegators 'Pubid::Jis::Identifier::Amendment', :type
+
+      def initialize(base: nil, **opts)
+        super(**opts)
+        @base = base
+      end
+
+      def self.type
+        { key: :amd, title: "Amendment", short: "AMD" }
+      end
+
+      def self.get_renderer_class
+        Renderer::Amendment
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'forwardable'
+
+module Pubid::Jis
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      attr_accessor :series, :all_parts
+      extend Forwardable
+
+      def self.type
+        { key: :jis, title: "Japanese Industrial Standard" }
+      end
+
+      # @param month [Integer] document's month
+      # @param edition [String] document's edition version, e.g. "3.0", "1.0"
+      def initialize(publisher: "JIS", series: nil, part: nil, all_parts: false, **opts)
+        super(**opts.merge(publisher: publisher))
+        @series = series if series
+        @part = part if part
+        @all_parts = all_parts
+      end
+
+      def all_parts?
+        all_parts
+      end
+
+      def ==(other)
+        if all_parts? || other.all_parts?
+          return get_params.reject { |k, _| [:part, :all_parts].include?(k) } ==
+            other.get_params.reject { |k, _| [:part, :all_parts].include?(k) }
+        end
+
+        super
+      end
+
+      class << self
+        def transform_supplements(supplements_params, base_params)
+          supplements = supplements_params.map do |supplement|
+            Identifier.create(number: supplement[:number], year: supplement[:year],
+                              type: supplement[:type], base: Identifier.create(**base_params))
+          end
+
+          return supplements.first if supplements.count == 1
+
+          raise Errors::SupplementParsingError, "more than one or none supplements provided"
+        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)
+
+          if identifier_params[:supplements]
+            return transform_supplements(
+              identifier_params[:supplements],
+              identifier_params.dup.tap { |h| h.delete(:supplements) }
+            )
+          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/jis/identifier/technical_report.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/technical_report"
+
+module Pubid::Jis
+  module Identifier
+    class TechnicalReport < Base
+      def_delegators 'Pubid::Jis::Identifier::TechnicalReport', :type
+
+      def self.type
+        { key: :tr, title: "Technical Report", short: "TR" }
+      end
+
+      def self.get_renderer_class
+        Renderer::TechnicalReport
+      end
+    end
+  end
+end

data/lib/pubid/jis/identifier/technical_specification.rb

@@ -0,0 +1,17 @@
+require_relative "../renderer/technical_specification"
+
+module Pubid::Jis
+  module Identifier
+    class TechnicalSpecification < Base
+      def_delegators 'Pubid::Jis::Identifier::TechnicalSpecification', :type
+
+      def self.type
+        { key: :ts, title: "Technical Specification", short: "TS" }
+      end
+
+      def self.get_renderer_class
+        Renderer::TechnicalSpecification
+      end
+    end
+  end
+end

data/lib/pubid/jis/identifier.rb

@@ -0,0 +1,12 @@
+module Pubid::Jis
+  module Identifier
+    class << self
+      include Pubid::Core::Identifier
+
+      # @see Pubid::Identifier::Base.parse
+      def parse(*args)
+        Base.parse(*args)
+      end
+    end
+  end
+end

data/lib/pubid/jis/parser.rb

@@ -0,0 +1,48 @@
+module Pubid::Jis
+  class Parser < Pubid::Core::Parser
+
+    rule(:type) do
+      str("/").maybe >>
+        array_to_str(Identifier.config.types.map { |type| type.type[:short] }.compact).as(:type)
+    end
+
+    rule(:space) do
+      str(" ") | str("　")
+    end
+
+    rule(:dash) do
+      str("-") | str("ｰ")
+    end
+
+    rule(:colon) do
+      str(":") | str("：")
+    end
+
+    rule(:series) do
+      match("[A-Z]").as(:series)
+    end
+
+    rule(:part) do
+      (dash >> digits.as(:part)).repeat
+    end
+
+    rule(:all_parts) do
+      (str("(規格群)") | str("（規格群）")).as(:all_parts)
+    end
+
+    rule(:language) do
+      str("(") >> match("[A-Z]").as(:language) >> str(")")
+    end
+
+    rule(:amendment) do
+      (str("/") >> str("AMD").as(:type) >> space >> digits.as(:number) >> colon >> year).repeat(1).as(:supplements)
+    end
+
+    rule(:identifier) do
+      str("JIS").maybe >> space? >> type.maybe >> space? >> series >> space? >> digits.as(:number) >> part >>
+        (colon >> year).maybe >> language.maybe >> all_parts.maybe >> amendment.maybe
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+module Pubid::Jis::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    TYPE = "".freeze
+
+    def render_identifier(params)
+      "%{publisher}%{series} %{number}%{part}%{year}%{all_parts}" % params
+    end
+
+    def render_series(series, _opts, _params)
+      " #{series}"
+    end
+
+    def render_part(part, opts, _params)
+      return "-#{part.reverse.join('-')}" if part.is_a?(Array)
+
+      "-#{part}"
+    end
+
+    def render_all_parts(all_parts, _opts, _params)
+      "（規格群）" if all_parts
+    end
+  end
+end

data/lib/pubid/jis/renderer/technical_report.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Jis::Renderer
+  class TechnicalReport < Base
+    def render_identifier(params)
+      "%{publisher} TR%{series} %{number}%{part}%{year}%{all_parts}" % params
+    end
+  end
+end

data/lib/pubid/jis/renderer/technical_specification.rb

@@ -0,0 +1,9 @@
+require_relative "base"
+
+module Pubid::Jis::Renderer
+  class TechnicalSpecification < Base
+    def render_identifier(params)
+      "%{publisher} TS%{series} %{number}%{part}%{year}%{all_parts}" % params
+    end
+  end
+end

data/lib/pubid/jis/version.rb

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

data/lib/pubid/jis.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+end
+
+require "pubid-core"
+
+require_relative "jis/errors"
+require_relative "jis/identifier/base"
+require_relative "jis/identifier/technical_report"
+require_relative "jis/identifier/technical_specification"
+require_relative "jis/identifier/amendment"
+require_relative "jis/renderer/base"
+require_relative "jis/renderer/technical_report"
+require_relative "jis/renderer/technical_specification"
+require_relative "jis/renderer/amendment"
+require_relative "jis/parser"
+require_relative "jis/identifier"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Jis::Identifier::Base
+config.types = [Pubid::Jis::Identifier::Base, Pubid::Jis::Identifier::TechnicalReport,
+                Pubid::Jis::Identifier::TechnicalSpecification, Pubid::Jis::Identifier::Amendment]
+config.type_names = {}.freeze
+Pubid::Jis::Identifier.set_config(config)

data/lib/pubid-jis.rb

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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: pubid-jis
+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.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Library to generate, parse and manipulate JIS PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-jis.rb
+- lib/pubid/jis.rb
+- lib/pubid/jis/errors.rb
+- lib/pubid/jis/identifier.rb
+- lib/pubid/jis/identifier/amendment.rb
+- lib/pubid/jis/identifier/base.rb
+- lib/pubid/jis/identifier/technical_report.rb
+- lib/pubid/jis/identifier/technical_specification.rb
+- lib/pubid/jis/parser.rb
+- lib/pubid/jis/renderer/amendment.rb
+- lib/pubid/jis/renderer/base.rb
+- lib/pubid/jis/renderer/technical_report.rb
+- lib/pubid/jis/renderer/technical_specification.rb
+- lib/pubid/jis/version.rb
+homepage: https://github.com/metanorma/pubid-jis
+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 JIS PubID.
+test_files: []