pubid-ccsds 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 193f9b9e47d7c18988db0a3443b52cee6dd5afedfeb9977119ef8b8ba02d4b93
+  data.tar.gz: 9776b5d64ff1baf0649038a95f20f61efe3c66c05eabaf6fb7b5d9b012442818
+SHA512:
+  metadata.gz: 32de5a456214ee004c4f94c7a803f31d7b5405c1963f1c1cd3a3fa5547e5e9f0484fc3aa7c7c024882dd9a66732e4594b3a4fc397bbd467e5c3c04cd6b88744a
+  data.tar.gz: 7aa1a35efe5c5eac4fb39d1e85f1317cd373fc5ae2e0b78b815579aa94ea1c46fcccf0eb32a9992d71fd2614a5333d4f8d097b57044a4def850a463e45ae4a00

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 ("CCSDS PubID")
+
+== Purpose
+
+This gem implements a mechanism to parse and utilize CCSDS publication
+identifiers.
+
+== Use cases to support
+
+. generate updated PubID
+
+== Usage
+
+=== Identifier creation
+
+Basic usage of the pubid-ccsds gem starts with the `Identifier#create` method.
+
+[source,ruby]
+----
+require "pubid-ccsds"
+
+pubid = Pubid::Ccsds::Identifier.create(number: 1234, part: 1, type: "B", edition: 2)
+pubid.to_s
+
+=> "CCSDS 1234.1-B-2"
+----

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

@@ -0,0 +1,55 @@
+require 'forwardable'
+
+module Pubid::Ccsds
+  module Identifier
+    class Base < Pubid::Core::Identifier::Base
+      extend Forwardable
+
+      attr_accessor :series, :retired, :book_color
+
+      def self.type
+        { key: :ccsds, title: "The Consultative Committee for Space Data Systems" }
+      end
+
+      def initialize(publisher: "CCSDS", book_color: nil, part: nil,
+                     series: nil, retired: nil, **opts)
+        super(**opts.merge(publisher: publisher))
+        @book_color = book_color
+        @part = part || 0
+        @series = series
+        @retired = retired
+      end
+
+      class << self
+        def transform_supplements(type, identifier_params)
+          Identifier.create(
+            type: type,
+            base: transform(
+              **identifier_params.dup.tap { |h| h.delete(type) }),
+            **identifier_params[type],
+            )
+        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)
+
+          %i(corrigendum).each do |type|
+            return transform_supplements(type, identifier_params) if identifier_params[type]
+          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/ccsds/identifier/corrigendum.rb

@@ -0,0 +1,22 @@
+module Pubid::Ccsds
+  module Identifier
+    class Corrigendum < Base
+      def_delegators 'Pubid::Ccsds::Identifier::Corrigendum', :type
+
+      attr_accessor :base
+
+      def initialize(base: nil, **opts)
+        super(**opts)
+        @base = base
+      end
+
+      def self.type
+        { key: :corrigendum, title: "Corrigendum" }
+      end
+
+      def self.get_renderer_class
+        Renderer::Corrigendum
+      end
+    end
+  end
+end

data/lib/pubid/ccsds/identifier.rb

@@ -0,0 +1,12 @@
+module Pubid::Ccsds
+  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/ccsds/parser.rb

@@ -0,0 +1,39 @@
+module Pubid::Ccsds
+  class Parser < Pubid::Core::Parser
+
+    rule(:book_color) do
+      dash >> match["BGMYO"].as(:book_color)
+    end
+
+    rule(:edition) do
+      dash >> digits.as(:edition)
+    end
+
+    rule(:part) do
+      (dot >> digits.as(:part)).repeat(1)
+    end
+
+    rule(:series) do
+      match["A-Z"].as(:series)
+    end
+
+    rule(:retired) do
+      str("-S").as(:retired)
+    end
+
+    rule(:corrigendum) do
+      space >> str("Cor. ") >> digits.as(:number).as(:corrigendum)
+    end
+
+    rule(:language) do
+      space >> dash >> space >> words.as(:language) >> space >> str("Translated")
+    end
+
+    rule(:identifier) do
+      str("CCSDS") >> space >> series.maybe >> digits.as(:number) >> part >>
+        book_color >> edition >> retired.maybe >> corrigendum.maybe >> language.maybe
+    end
+
+    rule(:root) { identifier }
+  end
+end

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

@@ -0,0 +1,29 @@
+module Pubid::Ccsds::Renderer
+  class Base < Pubid::Core::Renderer::Base
+    TYPE = "".freeze
+
+    def render_identifier(params)
+      "%{publisher} %{series}%{number}%{part}%{book_color}%{edition}%{retired}" % params
+    end
+
+    def render_part(part, _opts, _params)
+      ".#{part}"
+    end
+
+    def render_book_color(book_color, _opts, _params)
+      "-#{book_color}"
+    end
+
+    def render_edition(edition, _opts, _params)
+      "-#{edition}"
+    end
+
+    def render_retired(retired, _opts, _params)
+      "-S" if retired
+    end
+
+    def render_language(language, opts, _params)
+      " - #{language} Translated"
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Pubid::Ccsds::Renderer
+  class Corrigendum < Base
+    def render_identifier(params)
+      "%{base} Cor. %{number}" % params
+    end
+  end
+end

data/lib/pubid/ccsds/version.rb

@@ -0,0 +1,5 @@
+module Pubid
+  module Ccsds
+    VERSION = "0.1.2".freeze
+  end
+end

data/lib/pubid/ccsds.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "parslet"
+
+module Pubid
+end
+
+require "pubid-core"
+
+require_relative "ccsds/identifier/base"
+require_relative "ccsds/identifier/corrigendum"
+require_relative "ccsds/renderer/base"
+require_relative "ccsds/renderer/corrigendum"
+require_relative "ccsds/parser"
+require_relative "ccsds/identifier"
+
+config = Pubid::Core::Configuration.new
+config.default_type = Pubid::Ccsds::Identifier::Base
+config.types = [Pubid::Ccsds::Identifier::Base,
+                Pubid::Ccsds::Identifier::Corrigendum]
+config.type_names = {}.freeze
+Pubid::Ccsds::Identifier.set_config(config)

data/lib/pubid-ccsds.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: pubid-ccsds
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-19 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: 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.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+description: Library to generate, parse and manipulate CCSDS PubID.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid-ccsds.rb
+- lib/pubid/ccsds.rb
+- lib/pubid/ccsds/identifier.rb
+- lib/pubid/ccsds/identifier/base.rb
+- lib/pubid/ccsds/identifier/corrigendum.rb
+- lib/pubid/ccsds/parser.rb
+- lib/pubid/ccsds/renderer/base.rb
+- lib/pubid/ccsds/renderer/corrigendum.rb
+- lib/pubid/ccsds/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.3.26
+signing_key: 
+specification_version: 4
+summary: Library to generate, parse and manipulate CCSDS PubID.
+test_files: []