relaton-3gpp 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cb4d367d6487eb29deffcb0805e874e089ee23b296879ab64e0d0697e3d29f4
+  data.tar.gz: 520706a92250b455c31e8ed63def3573da3c67d8d7329c027186e5ab66330cbc
+SHA512:
+  metadata.gz: 0350b940358a6fe6793e6c18361a61befd891b7efa814d73c88fd612123b174f7ffea185ccfdd65711873a3f75697108c60a15d85446a2d8091bf3f1c97c377a
+  data.tar.gz: e0a8e4c26623f84b997862ebc3c66c0f2c665dfea62cef07d0db8601431b0340d2778b782ee730d6cf248411b6056f7f5073be7823580bd7e60072ce79137b91

data/.github/workflows/rake.yml

@@ -0,0 +1,36 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      # https://github.com/ruby-debug/debase/issues/89#issuecomment-686827382
+      - if: matrix.os == 'macos-latest' && matrix.ruby == '2.5'
+        run: echo BUNDLE_BUILD__DEBASE="--with-cflags=\"-Wno-error=implicit-function-declaration\"" >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
+Gemfile.lock
+.vscode/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+require: rubocop-rails
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.5
+Rails:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton_3gpp.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,170 @@
+= Relaton3gpp
+
+Relaton3gpp is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+
+You can use it to retrieve metadata of W3C Standards from https://w3.org, and access such metadata through the `W3cBibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton-3gpp'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install relaton-3gpp
+
+== Usage
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
+require 'relaton_3gpp'
+=> true
+
+item = Relaton3gpp::Bibliography.get "3GPP TR 00.01U:UMTS/3.0.0"
+[relaton-3gpp] ("3GPP TR 00.01U:UMTS/3.0.0") fetching...
+[relaton-3gpp] ("3GPP TR 00.01U:UMTS/3.0.0") found 3GPP TR 00.01U:UMTS/3.0.0
+=> #<Relaton3gpp::BibliographicItem:0x00007f92d94264e0
+...
+----
+
+=== XML serialization
+
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="3GPPTR00.01U-UMTS/3.0.0" type="standard">
+  <fetched>2021-12-09</fetched>
+  <title type="main" format="text/plain">Work programme for the standardization of Universal Mobile Telecommunications System (UMTS)</title>
+  <uri type="src">http://www.3gpp.org/ftp/Specs/archive/00_series/00.01U/0001U-300.zip</uri>
+  <docidentifier type="3GPP">3GPP TR 00.01U:UMTS/3.0.0</docidentifier>
+  <docidentifier type="rapporteurId">2261</docidentifier>
+  <docnumber>TR 00.01U:UMTS/3.0.0</docnumber>
+  <language>en</language>
+  <script>Latn</script>
+  <status>
+    <stage>withdrawn</stage>
+  </status>
+</bibitem>"
+----
+
+With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element.
+
+[source,ruby]
+----
+item.to_xml bibdata: true
+=> "<bibdata type="standard">
+  <fetched>2021-12-09</fetched>
+  <title type="main" format="text/plain">Work programme for the standardization of Universal Mobile Telecommunications System (UMTS)</title>
+  <uri type="src">http://www.3gpp.org/ftp/Specs/archive/00_series/00.01U/0001U-300.zip</uri>
+  <docidentifier type="3GPP">3GPP TR 00.01U:UMTS/3.0.0</docidentifier>
+  <docidentifier type="rapporteurId">2261</docidentifier>
+  <docnumber>TR 00.01U:UMTS/3.0.0</docnumber>
+  <language>en</language>
+  <script>Latn</script>
+  <status>
+    <stage>withdrawn</stage>
+  </status>
+  <ext>
+    <doctype>TR</doctype>
+    <editorialgroup>
+      <technical-committee type="prime">SMG5</technical-committee>
+    </editorialgroup>
+    <radiotechnology>3G</radiotechnology>
+    <release>
+      <version2G>3</version2G>
+      <version3G>3</version3G>
+      <defunct>true</defunct>
+      <freeze-meeting>SMG-28</freeze-meeting>
+      <freeze-stage1-meeting>SMG-28</freeze-stage1-meeting>
+      <freeze-stage2-meeting>SMG-28</freeze-stage2-meeting>
+      <freeze-stage3-meeting>SMG-28</freeze-stage3-meeting>
+      <close-meeting>SP-28</close-meeting>
+      <project-end>1999-02-12</project-end>
+    </release>
+  </ext>
+</bibdata>"
+----
+
+=== Typed links
+
+Some of 3GPP documents have `src` type link.
+
+[source,ruby]
+----
+item.link.first.type
+=> "src"
+
+item.link.first.content
+==> #<Addressable::URI:0x320 URI:http://www.3gpp.org/ftp/Specs/archive/00_series/00.01U/0001U-300.zip>
+----
+
+=== Create bibliographic item from XML
+[source,ruby]
+----
+RelatonW3c::XMLParser.from_xml File.read('spec/fixtures/cr_json_ld11.xml')
+=> #<RelatonW3c::W3cBibliographicItem:0x007f9381efce98
+...
+----
+
+=== Create bibliographic item from YAML
+[source,ruby]
+----
+hash = YAML.load_file 'spec/fixtures/bib.yaml'
+=> {"id"=>"3GPPTR00.01U-UMTS/3.0.0",
+ "title"=>{"type"=>"main", "content"=>"Work programme for the standardization of Universal Mobile Telecommunications System (UMTS)", "format"=>"text/plain"},
+...
+
+bib_hash = Relaton3gpp::HashConverter.hash_to_bib hash
+=> {:id=>"3GPPTR00.01U-UMTS/3.0.0",
+ :title=>
+  #<RelatonBib::TypedTitleStringCollection:0x00007f92aa8cdf40
+   @array=[{:type=>"main", :content=>"Work programme for the standardization of Universal Mobile Telecommunications System (UMTS)", :format=>"text/plain"}]>,
+...
+
+Relaton3gpp::BibliographicItem.new(**bib_hash)
+=> #<Relaton3gpp::BibliographicItem:0x00007f92d953cbe0
+...
+----
+
+=== Fetch data
+
+There is a 3GPP dataset ftp://www.3gpp.org/Information/Databases/Spec_Status/[latest *.zip] which can be converted into RelatonXML/BibXML/BibYAML formats.
+
+The method `Relaton3GPP::DataFetcher.fetch(output: "data", format: "yaml")` converts all the documents from the dataset and save them to the `./data` folder in YAML format.
+Arguments:
+
+- `output` - folder to save documents (default './data').
+- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
+
+[source,ruby]
+----
+Relaton3GPP::DataFetcher.fetch
+Started at: 2021-12-10 19:58:46 +0100
+Stopped at: 2021-12-10 20:08:03 +0100
+Done in: 557 sec.
+=> nil
+----
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton_3gpp.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "relaton_3gpp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/grammars/3gpp.rng

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="isodoc.rng">
+    <start>
+      <ref name="iso-standard"/>
+    </start>
+    <define name="DocumentType">
+      <choice>
+        <value>TR</value>
+        <value>TS</value>
+      </choice>
+    </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>spec</value>
+        <value>release</value>
+      </choice>
+    </define>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="radiotechnology"/>
+      </optional>
+      <optional>
+        <ref name="common-ims-spec"/>
+      </optional>
+      <optional>
+        <ref name="internal"/>
+      </optional>
+      <optional>
+        <ref name="release"/>
+      </optional>
+    </define>
+  </include>
+  <define name="RadioTechnologyType">
+    <choice>
+      <value>2G</value>
+      <value>3G</value>
+      <value>LTE</value>
+      <value>5G</value>
+    </choice>
+  </define>
+  <define name="radiotechnology">
+    <element name="radiotechnology">
+      <ref name="RadioTechnologyType"/>
+    </element>
+  </define>
+  <define name="common-ims-spec">
+    <element name="common-ims-spec">
+      <data type="boolean"/>
+    </element>
+  </define>
+  <define name="internal">
+    <element name="internal">
+      <data type="boolean"/>
+    </element>
+  </define>
+  <define name="release">
+    <element name="release">
+      <element name="version2G">
+        <text/>
+      </element>
+      <element name="version3G">
+        <text/>
+      </element>
+      <element name="defunct">
+        <data type="boolean"/>
+      </element>
+      <element name="wpm-code-2G">
+        <text/>
+      </element>
+      <element name="wpm-code-3G">
+        <text/>
+      </element>
+      <element name="freeze-meeting">
+        <text/>
+      </element>
+      <element name="freeze-stage1-meeting">
+        <text/>
+      </element>
+      <element name="freeze-stage2-meeting">
+        <text/>
+      </element>
+      <element name="freeze-stage3-meeting">
+        <text/>
+      </element>
+      <element name="close-meeting">
+        <text/>
+      </element>
+      <element name="project-start">
+        <data type="date"/>
+      </element>
+      <element name="project-end">
+        <data type="date"/>
+      </element>
+    </element>
+  </define>
+</grammar>