pubid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd779f3a277fdc04a542443c5c636061fb2b112eca6799681f3b256c535800d7
+  data.tar.gz: feba7c57f219a063c29f7322a2d3a946c1b734b81876d5c1cf89136e0a00fdc3
+SHA512:
+  metadata.gz: 8a757e63f5d98c06d453cf1369a2a85e507482e9036e17fde6c6092aa555c59b25fc2343e20c97d223765fb159a542c250a2291ae79f2489810b5660ccdb917f
+  data.tar.gz: debfe72e6c57c45da4a1a296b905328a7a61f1fedda71d310f26719341b19bed85335f56118faeae4b5985ca481e2de1581ab0a1be327a04720216273e5bfbc7

data/LICENSE.txt

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2022, 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,127 @@
+= IEEE publication identifiers ("IEEE PubID")
+
+== Purpose
+
+Implements a mechanism to parse and utilize IEEE publication identifers.
+
+== Historic identifier patterns
+
+There are at least two major "pattern series" of identifiers due to historical reasons: old (type I) and new (type II).
+This implementation attempts to support both types of publication identifier patterns.
+
+== Use cases to support
+
+* analyze a pattern of type I idetifier
+* parse type II idetifier into components
+* generate a filename from the components similar to type I pattern
+
+== Elements of the PubID
+
+=== Publisher
+
+|===
+| Name | Abbrev
+
+| Institute of Electrical and Electronics Engineers
+| IEEE
+
+|===
+
+=== Report number
+
+`{number}` - is a set of one or more digits and optional letters
+
+=== Part
+
+`{part}` - is a set of digits and optional letters; starts with a digit; if a letter or letters are present then they are in the end; optional
+
+=== Subpart
+
+`{subpart}` - is a set of digits and optional letters; optional, many subparts are possible
+
+=== Year
+
+`{year}` - is a set of 4 digits; optional
+
+=== Corrigendum & Amendment
+
+`{cor}` - is a corrigendum or an amendments with the pattern `Cor {cornum}-{year}` or `Amd {cornum}:{year}` where {cornum} is a set of digits; optional
+
+== Type I pattern
+
+[source]
+----
+{publisher} {type} {series} {number}{part}.{subpart}{year} {edition}/{conform}/{correction}
+----
+
+* `{publisher}` IEEE
+* `{type}` one of the values: `Standard`, `Std`, `Draft`, `Draft Standard`, `Draft Supplement` ^*^
+* `{series}` one of the values: `ISO/IEC`, `ISO/IEC/IEEE` ^*^
+* `{number}` set of digits optionally prefixed with uppercase letter and optionally suffixed  with letter
+* `{part}` from 1 to 2 digits prefixed with `.` or `-` and optionally suffixed with up to 4 letters ^*^
+* `{subpart}` 1 digit optionally suffixed with a letter ^*^
+* `{year}` 4 digits prefixed with `-`, `:`, ` - `, or breakspace ^*^
+* `{edition}` prefix `Edition` followed by a reference in brackets or prefix `First edition` followed by date in format `YYYY-MM-DD` ^*^
+* `{conform}` prefix `Conformance` followed by 2 digits, dash, and 4 digits year ^*^
+* `{correction}` prefix `Cor` optionally followed by breakspace, or prefix `Amd` followed by `.`, followed by from 1 to 2 digits, dash and 4 digits year ^*^
+
+(*) - optional
+
+An identifier can be composed of 2 other identifiers with breakspace delimiter. Only the first identifier needs to cnatain puplisher, for the secont it's optional
+
+Following RegEx expression parses 100% of identifiers from the type I https://xml2rfc.tools.ietf.org/public/rfc/bibxml-ieee/[dataset]:
+[source,regex]
+
+----
+{
+  ^IEEE\s
+  ((?<type1>Standard|Std|Draft(\sStandard|\sSupplement)?)\s)?
+  ((?<series>ISO\/IEC(\/IEEE)?)\s)?
+  (?<number1>[A-Z]?\d+[[:alpha:]]?)
+  ([.-](?<part1>\d{1,2}(?!\d)[[:alpha:]]{0,4}))?
+  (\.(?<subpart1>\d[[:alpha:]]?))?
+  (?<year1>([-:]|\s-\s|,\s)\d{4})?
+  (\s(IEEE\s(?<type2>Std)\s)?(?<number2>[A-Z]?\d+[[:alpha:]]?)
+    ([.-](?<part2>\d{1,2}(?!\d)[[:alpha:]]{0,4}))?
+    ([.](?<subpart2>\d[[:alpha:]]?))?
+    (?<year2>([-:.]|_-|\s-\s|,\s)\d{4})?)?
+  (\s(?<edition>Edition(\s\([^)]+\))?|First\sedition\s[\d-]+))?
+  (\/(?<conform>Conformance\d{2})-(?<confyear>\d{4}))?
+  (\/(?<correction>(Cor\s?|(Amd\.)\d{1,2})
+    (?<coryear>(:|-|:-)\d{4}))?$
+}x
+----
+
+== Pasing PubID elements from type II identifiers
+
+To parse PubID elements from the type II pattern identifiers we can use a RegEx expression:
+
+[source,regex]
+----
+{
+  ^IEEE\s(?<number1>\w+(\.[A-Z]\d|\sHBK)?)
+  (?<part1>(\.|\s)\d{1,4}[[:alpha:],]{0,7}|-\d?[A-Z]+|-\d(?=[-.]))?
+  (?<subpart11>\.\d{1,3}[a-z]?|-\d{5}[a-z]?|-\d+(?=[-:_]))?
+  (?<subpart12>\.\d|-\d+(?=-))?
+  (?<year1>([-:.]|_-|\s-)\d{4})?
+  (\/(?<number2>([A-Z]?\d+[a-z]?|Conformance\d+))
+    ((\.|-)(?<part2>\d{1,3}[a-z]?)(?!\d))?
+    (\.(?<subpart21>\d{1,2}))?)?
+  (\/(?<number3>\d+)(\.(?<part3>\d))?)?
+  (?<year2>([-:.]|_-|\s-)\d{4})?
+  ((\/|_|-|\s\/)(?<correction>(Cor|(?i)Amd(?-i))(\s|\.|\.\s)?\d{1,2})
+    (?<coryear>(:|-|:-|_[A-Z][a-z]{2}_)\d{4}(-\d{4})?)?)?$
+}x
+----
+
+This RegEx expession covers 99% of the identifiers from the type II bibxml-ieee https://xml2rfc.tools.ietf.org/public/rfc/bibxml-ieee-new/[dataset].
+
+== File name generator
+
+For type I identifiers file names are generated by replacing symbols `/`, `\`, `,`, `'`, `"`, `(`, `)`, and breakspace with symbol `_`. Sequences of multiple sybols `_` should be squized to one symbol.
+
+For type II identifiers it needs to parse PubID elements than join the elements in order:
+
+----
+IEEE.{number1}_{part1}.{subpart11}.{subpart12}-{year1}_{number2}_{part2}.{subpart21}_{number3}_{part3}-{year2}_{correction}-{coryear}
+----

data/lib/pubid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pubid
+  VERSION = "0.1.0"
+end

data/lib/pubid.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "pubid/version"
+
+module Pubid
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: pubid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-17 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'
+description: Library to generate, parse and manipulate PubIDs.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.adoc
+- lib/pubid.rb
+- lib/pubid/version.rb
+homepage: https://github.com/metanorma/pubid-ieee
+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 PubIDs.
+test_files: []