relaton-3gpp 1.14.2 → 1.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c370da51e60205972942b3d8567a6f8d1b74b22b6efde4812976f83850e2059
-  data.tar.gz: 909ac4c1e51f580233af81c3b874fcaaa29b928b11ca93a3bb844f4d82b95391
+  metadata.gz: 207139041595ff473f6d1372793a3ee8142c6b456d208be33c68f50e1c7b8961
+  data.tar.gz: ff9c7606fcc605644880263e4be2befe1e460a174b6c7ae92d27f12e86b03b14
 SHA512:
-  metadata.gz: ab35c2f45c7be11762d5a851cba16e8cfe030ad8c57fc0aeae469f035c1be12a4faae7ff777b731eb83daea13e3c14c8f4ed2573cbe9c5324e53ba24f5f40469
-  data.tar.gz: 802c5f0df1e473b26ccbd87c1947f2227af41aadabf3db5dfbb254e1b8a0707cfff953261ec9908dada636a613718e6ac6c0fb1d1d7e58e8704e881ec5a85f69
+  metadata.gz: 203d9cdb69126f86d801f5ed93c2df91af6f876644846d22d79ba749e11b90804f7de660a2ea1b4ec2795866fa15c3670daa911dd915f78cd0696bf7933ab728
+  data.tar.gz: d20cf590d0e16a30475a9a51b5431d6b467e66c490fc32145d46521da56bef995d249de98bb09919e3442fc7f542f9730fc0f9092afd45a8d29f2f913f870b96

data/.github/workflows/rake.yml

@@ -5,6 +5,7 @@ name: rake
 on:
   push:
     branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -10,8 +10,9 @@ on:
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
+
 
 jobs:
   release:

data/.gitignore

@@ -6,9 +6,11 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
 Gemfile.lock
 .vscode/
 .rspec_status
+status_smg_3GPP*

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 Rails:
   Enabled: false

data/Gemfile

@@ -6,7 +6,13 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.7"
+gem "equivalent-xml", "~> 0.6"
+gem "rubocop", "~> 1.23.0"
+gem "rubocop-performance", "~> 1.12.0"
+gem "rubocop-rails", "~> 2.12.0"
+gem "ruby-jing", "~> 0.0.2"
+gem "simplecov", "~> 0.21.2"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.18.0"

data/README.adoc

@@ -132,12 +132,13 @@ There is a 3GPP dataset ftp://www.3gpp.org/Information/Databases/Spec_Status/[la
 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:
 
+- `source` - a data source name. Possible values are: `status-smg-3GPP` and `status-smg-3GPP-force`. The first one only downloads a dataset if it's updated. The second one forces this gem to download the latest dataset.
 - `output` - folder to save documents (default './data').
 - `format` - a format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
 
 [source,ruby]
 ----
-Relaton3GPP::DataFetcher.fetch output: "data", format: "yaml"
+Relaton3GPP::DataFetcher.fetch "status-smg-3GPP" output: "data", format: "yaml"
 Started at: 2021-12-10 19:58:46 +0100
 Stopped at: 2021-12-10 20:08:03 +0100
 Done in: 557 sec.

data/grammars/basicdoc.rng

@@ -522,7 +522,6 @@
       <value>tip</value>
       <value>important</value>
       <value>caution</value>
-      <value>statement</value>
     </choice>
   </define>
   <define name="figure">

data/grammars/biblio.rng

@@ -216,6 +216,9 @@
       <optional>
         <ref name="fullname"/>
       </optional>
+      <zeroOrMore>
+        <ref name="credential"/>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="affiliation"/>
       </zeroOrMore>
@@ -232,6 +235,11 @@
       <ref name="FullNameType"/>
     </element>
   </define>
+  <define name="credential">
+    <element name="credential">
+      <text/>
+    </element>
+  </define>
   <define name="FullNameType">
     <choice>
       <group>
@@ -305,7 +313,9 @@
       <zeroOrMore>
         <ref name="affiliationdescription"/>
       </zeroOrMore>
-      <ref name="organization"/>
+      <optional>
+        <ref name="organization"/>
+      </optional>
     </element>
   </define>
   <define name="affiliationname">
@@ -1316,7 +1326,7 @@
       <value>commentaryOf</value>
       <value>hasCommentary</value>
       <value>related</value>
-      <value>complements</value>
+      <value>hasComplement</value>
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>

data/lib/relaton_3gpp/bibliography.rb

@@ -4,13 +4,18 @@ module Relaton3gpp
   # Methods for search IANA standards.
   module Bibliography
     # SOURCE = "http://xml2rfc.tools.ietf.org/public/rfc/bibxml-3gpp-new/"
-    SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-3gpp/main/data/"
+    SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-3gpp/main/"
+    INDEX_FILE = "index-v1.yaml"
 
     # @param text [String]
     # @return [RelatonBib::BibliographicItem]
     def search(text) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      file = text.sub(/^3GPP\s/, "").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
-      url = "#{SOURCE}#{file}.yaml"
+      index = Relaton::Index.find_or_create "3GPP", url: "#{SOURCE}index-v1.zip", file: INDEX_FILE
+      row = index.search(text.sub(/^3GPP\s/, "")).min_by { |r| r[:id] }
+      return unless row
+
+      # file = text.sub(/^3GPP\s/, "").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
+      url = "#{SOURCE}#{row[:file]}"
       resp = Net::HTTP.get_response URI(url)
       return unless resp.code == "200"
 

data/lib/relaton_3gpp/data_fetcher.rb

@@ -19,17 +19,22 @@ module Relaton3gpp
       @files = []
     end
 
+    def index
+      @index ||= Relaton::Index.find_or_create "3gpp", file: "index-v1.yaml"
+    end
+
     #
     # Initialize fetcher and run fetch
     #
+    # @param [Strin] source source name
     # @param [Strin] output directory to save files, default: "data"
     # @param [Strin] format format of output files (xml, yaml, bibxml), default: yaml
     #
-    def self.fetch(output: "data", format: "yaml")
+    def self.fetch(source, output: "data", format: "yaml")
       t1 = Time.now
       puts "Started at: #{t1}"
       FileUtils.mkdir_p output
-      new(output, format).fetch
+      new(output, format).fetch(source == "status-smg-3GPP-force")
       t2 = Time.now
       puts "Stopped at: #{t2}"
       puts "Done in: #{(t2 - t1).round} sec."
@@ -38,8 +43,10 @@ module Relaton3gpp
     #
     # Parse documents
     #
-    def fetch # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      file = get_file
+    # @param [Boolean] renewal force to update all documents
+    #
+    def fetch(renewal) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      file = get_file renewal
       return unless file
 
       Zip::File.open(file) do |zip_file|
@@ -53,19 +60,25 @@ module Relaton3gpp
       specrels = dbs["Specs_GSM+3G_release-info"]
       releases = dbs["Releases"]
       tstatus = dbs["temp-status"]
-      FileUtils.rm_f File.join(@output, "/*") if dbs["2001-04-25_schedule"].any?
+      if renewal && dbs["2001-04-25_schedule"].any?
+        FileUtils.rm_f File.join(@output, "/*") # if renewal && dbs["2001-04-25_schedule"].any?
+        index.remove_all # if renewal
+      end
       dbs["2001-04-25_schedule"].each do |row|
         fetch_doc row, specs, specrels, releases, tstatus
       end
       File.write CURRENT, @current.to_yaml, encoding: "UTF-8"
+      index.save
     end
 
     #
     # Get file from FTP
     #
+    # @param [Boolean] renewal force to update all documents
+    #
     # @return [String] file name
     #
-    def get_file # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def get_file(renewal) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       @current = YAML.load_file CURRENT if File.exist? CURRENT
       @current ||= {}
       n = 0
@@ -75,8 +88,10 @@ module Relaton3gpp
         ftp.login
         ftp.chdir "/Information/Databases/Spec_Status/"
         d, t, _, file = ftp.list("*.zip").first.split
-        dt = DateTime.strptime("#{d} #{t}", "%m-%d-%y %I:%M%p")
-        return if file == @current["file"] && dt == DateTime.parse(@current["date"])
+        unless renewal
+          dt = DateTime.strptime("#{d} #{t}", "%m-%d-%y %I:%M%p")
+          return if file == @current["file"] && dt == DateTime.parse(@current["date"])
+        end
 
         ftp.getbinaryfile file
       rescue Net::ReadTimeout => e
@@ -129,6 +144,7 @@ module Relaton3gpp
       else
         @files << file
       end
+      index.add_or_update bib.docnumber, file
       File.write file, c, encoding: "UTF-8"
     end
 

data/lib/relaton_3gpp/processor.rb

@@ -9,7 +9,7 @@ module Relaton3gpp
       @prefix = "3GPP"
       @defaultprefix = %r{^3GPP\s}
       @idtype = "3GPP"
-      @datasets = %w[status-smg-3GPP]
+      @datasets = %w[status-smg-3GPP status-smg-3GPP-force]
     end
 
     # @param code [String]
@@ -23,13 +23,13 @@ module Relaton3gpp
     #
     # Fetch all the documents from http://xml2rfc.tools.ietf.org/public/rfc/bibxml-3gpp-new/
     #
-    # @param [String] _source source name
+    # @param [String] source source name
     # @param [Hash] opts
     # @option opts [String] :output directory to output documents
     # @option opts [String] :format
     #
-    def fetch_data(_source, opts)
-      DataFetcher.fetch(**opts)
+    def fetch_data(source, opts)
+      DataFetcher.fetch(source, **opts)
     end
 
     # @param xml [String]
@@ -50,5 +50,12 @@ module Relaton3gpp
     def grammar_hash
       @grammar_hash ||= ::Relaton3gpp.grammar_hash
     end
+
+    #
+    # Remove index file
+    #
+    def remove_index_file
+      Relaton::Index.find_or_create("3GPP", url: true, file: Bibliography::INDEX_FILE).remove_file
+    end
   end
 end

data/lib/relaton_3gpp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Relaton3gpp
-  VERSION = "1.14.2"
+  VERSION = "1.14.4"
 end

data/lib/relaton_3gpp.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "net/http"
+require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_3gpp/version"
 require_relative "relaton_3gpp/release"

data/relaton_3gpp.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "RelatonIana: Ruby XMLDOC impementation."
-  spec.description   = "RelatonIana: Ruby XMLDOC impementation."
-  spec.homepage      = "https://github.com/relaton/relaton-iana"
+  spec.summary       = "Relaton3gpp: Ruby XMLDOC impementation."
+  spec.description   = "Relaton3gpp: Ruby XMLDOC impementation."
+  spec.homepage      = "https://github.com/relaton/relaton-3gpp"
   spec.license       = "BSD-2-Clause"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 
@@ -35,17 +35,10 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rubocop", "~> 1.23.0"
-  spec.add_development_dependency "rubocop-performance", "~> 1.12.0"
-  spec.add_development_dependency "rubocop-rails", "~> 2.12.0"
-  spec.add_development_dependency "ruby-jing", "~> 0.0.2"
-  spec.add_development_dependency "simplecov", "~> 0.21.2"
-  spec.add_development_dependency "vcr", "~> 6.0.0"
-  spec.add_development_dependency "webmock", "~> 3.14.0"
 
   spec.add_dependency "mdb", "~> 0.5.0"
   spec.add_dependency "net-ftp", "~> 0.1.0"
   spec.add_dependency "relaton-bib", "~> 1.14.0"
+  spec.add_dependency "relaton-index", "~> 0.2.0"
   spec.add_dependency "rubyzip", "~> 2.3.0"
 end

metadata

@@ -1,169 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: relaton-3gpp
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.14.4
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2023-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.23.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.12.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: ruby-jing
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-- !ruby/object:Gem::Dependency
-  name: webmock
+  name: mdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
-  type: :development
+        version: 0.5.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: mdb
+  name: net-ftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: net-ftp
+  name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
-  name: relaton-bib
+  name: relaton-index
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
-description: 'RelatonIana: Ruby XMLDOC impementation.'
+description: 'Relaton3gpp: Ruby XMLDOC impementation.'
 email:
 - open.source@ribose.com
 executables: []
@@ -213,12 +115,12 @@ files:
 - lib/relaton_3gpp/version.rb
 - lib/relaton_3gpp/xml_parser.rb
 - relaton_3gpp.gemspec
-homepage: https://github.com/relaton/relaton-iana
+homepage: https://github.com/relaton/relaton-3gpp
 licenses:
 - BSD-2-Clause
 metadata:
-  homepage_uri: https://github.com/relaton/relaton-iana
-post_install_message:
+  homepage_uri: https://github.com/relaton/relaton-3gpp
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -226,15 +128,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
-summary: 'RelatonIana: Ruby XMLDOC impementation.'
+summary: 'Relaton3gpp: Ruby XMLDOC impementation.'
 test_files: []