relaton-3gpp 1.20.0 → 2.0.0.pre.alpha.1

data/lib/relaton/3gpp/processor.rb

@@ -0,0 +1,60 @@
+module Relaton
+  module ThreeGpp
+    class Processor < Relaton::Core::Processor
+      attr_reader :idtype
+
+      def initialize # rubocop:disable Lint/MissingSuper
+        @short = :relaton_3gpp
+        @prefix = "3GPP"
+        @defaultprefix = %r{^3GPP\s}
+        @idtype = "3GPP"
+        @datasets = %w[status-smg-3GPP status-smg-3GPP-force]
+      end
+
+      # @param code [String]
+      # @param date [String, NilClass] year
+      # @param opts [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def get(code, date, opts)
+        Bibliography.get(code, date, opts)
+      end
+
+      #
+      # Fetch all the documents from http://xml2rfc.tools.ietf.org/public/rfc/bibxml-3gpp-new/
+      #
+      # @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(source, **opts)
+      end
+
+      # @param xml [String]
+      # @return [RelatonBib::BibliographicItem]
+      def from_xml(xml)
+        Item.from_xml xml
+      end
+
+      # @param yaml [String]
+      # @return [Relaton::ThreeGpp::Item]
+      def from_yaml(yaml)
+        Item.from_yaml(yaml)
+      end
+
+      # Returns hash of XML grammar
+      # @return [String]
+      def grammar_hash
+        @grammar_hash ||= ThreeGpp.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
+end

data/lib/relaton/3gpp/release.rb

@@ -0,0 +1,33 @@
+module Relaton
+  module ThreeGpp
+    class Release < Lutaml::Model::Serializable
+      attribute :version2g, :string
+      attribute :version3g, :string
+      attribute :defunct, :boolean
+      attribute :wpm_code_2g, :string
+      attribute :wpm_code_3g, :string
+      attribute :freeze_meeting, :string
+      attribute :freeze_stage1_meeting, :string
+      attribute :freeze_stage2_meeting, :string
+      attribute :freeze_stage3_meeting, :string
+      attribute :close_meeting, :string
+      attribute :project_start, :date
+      attribute :project_end, :date
+
+      xml do
+        map_element "version2G", to: :version2g
+        map_element "version3G", to: :version3g
+        map_element "defunct", to: :defunct
+        map_element "wpm-code-2G", to: :wpm_code_2g
+        map_element "wpm-code-3G", to: :wpm_code_3g
+        map_element "freeze-meeting", to: :freeze_meeting
+        map_element "freeze-stage1-meeting", to: :freeze_stage1_meeting
+        map_element "freeze-stage2-meeting", to: :freeze_stage2_meeting
+        map_element "freeze-stage3-meeting", to: :freeze_stage3_meeting
+        map_element "close-meeting", to: :close_meeting
+        map_element "project-start", to: :project_start
+        map_element "project-end", to: :project_end
+      end
+    end
+  end
+end

data/lib/relaton/3gpp/util.rb

@@ -0,0 +1,8 @@
+module Relaton
+  module ThreeGpp
+    module Util
+      extend Relaton::Bib::Util
+      PROGNAME = "relaton-3gpp".freeze
+    end
+  end
+end

data/lib/relaton/3gpp/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Relaton
+  module ThreeGpp
+    VERSION = "2.0.0-alpha.1"
+  end
+end

data/lib/relaton/3gpp.rb

@@ -0,0 +1,23 @@
+require "net/http"
+require "relaton/index"
+require "relaton/core"
+require "relaton/bib"
+require_relative "3gpp/version"
+require_relative "3gpp/util"
+require_relative "3gpp/item"
+require_relative "3gpp/bibitem"
+require_relative "3gpp/bibdata"
+require_relative "3gpp/bibliography"
+
+module Relaton
+  module ThreeGpp
+    # Returns hash of XML reammar
+    # @return [String]
+    def self.grammar_hash
+      # gem_path = File.expand_path "..", __dir__
+      # grammars_path = File.join gem_path, "grammars", "*"
+      # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+      Digest::MD5.hexdigest ThreeGpp::VERSION + Relaton::Bib::VERSION # grammars
+    end
+  end
+end

data/relaton_3gpp.gemspec

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative "lib/relaton_3gpp/version"
+require_relative "lib/relaton/3gpp/version"
 
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = "relaton-3gpp"
-  spec.version       = Relaton3gpp::VERSION
+  spec.version       = Relaton::ThreeGpp::VERSION
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "Relaton3gpp: Ruby XMLDOC impementation."
-  spec.description   = "Relaton3gpp: Ruby XMLDOC impementation."
+  spec.summary       = "Relaton::3gpp: Ruby XMLDOC impementation."
+  spec.description   = "Relaton::3gpp: Ruby XMLDOC impementation."
   spec.homepage      = "https://github.com/relaton/relaton-3gpp"
   spec.license       = "BSD-2-Clause"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 
@@ -38,6 +38,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   spec.add_dependency "csv"
   spec.add_dependency "net-ftp", "~> 0.1.0"
-  spec.add_dependency "relaton-bib", "~> 1.20.0"
+  spec.add_dependency "relaton-bib", "~> 2.0.0-alpha.2"
+  spec.add_dependency "relaton-core", "~> 0.0.6"
   spec.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-3gpp
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 2.0.0.pre.alpha.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 2.0.0.pre.alpha.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 2.0.0.pre.alpha.2
+- !ruby/object:Gem::Dependency
+  name: relaton-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
-description: 'Relaton3gpp: Ruby XMLDOC impementation.'
+description: 'Relaton::3gpp: Ruby XMLDOC impementation.'
 email:
 - open.source@ribose.com
 executables: []
@@ -90,18 +104,20 @@ files:
 - grammars/biblio.rng
 - grammars/relaton-3gpp-compile.rng
 - grammars/relaton-3gpp.rng
-- lib/relaton_3gpp.rb
-- lib/relaton_3gpp/bibliographic_item.rb
-- lib/relaton_3gpp/bibliography.rb
-- lib/relaton_3gpp/data_fetcher.rb
-- lib/relaton_3gpp/document_type.rb
-- lib/relaton_3gpp/hash_converter.rb
-- lib/relaton_3gpp/parser.rb
-- lib/relaton_3gpp/processor.rb
-- lib/relaton_3gpp/release.rb
-- lib/relaton_3gpp/util.rb
-- lib/relaton_3gpp/version.rb
-- lib/relaton_3gpp/xml_parser.rb
+- lib/relaton/3gpp.rb
+- lib/relaton/3gpp/bibdata.rb
+- lib/relaton/3gpp/bibitem.rb
+- lib/relaton/3gpp/bibliography.rb
+- lib/relaton/3gpp/data_fetcher.rb
+- lib/relaton/3gpp/doctype.rb
+- lib/relaton/3gpp/ext.rb
+- lib/relaton/3gpp/item.rb
+- lib/relaton/3gpp/item_data.rb
+- lib/relaton/3gpp/parser.rb
+- lib/relaton/3gpp/processor.rb
+- lib/relaton/3gpp/release.rb
+- lib/relaton/3gpp/util.rb
+- lib/relaton/3gpp/version.rb
 - relaton_3gpp.gemspec
 homepage: https://github.com/relaton/relaton-3gpp
 licenses:
@@ -116,15 +132,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: 'Relaton3gpp: Ruby XMLDOC impementation.'
+summary: 'Relaton::3gpp: Ruby XMLDOC impementation.'
 test_files: []

data/lib/relaton_3gpp/bibliographic_item.rb

@@ -1,98 +0,0 @@
-module Relaton3gpp
-  class BibliographicItem < RelatonBib::BibliographicItem
-    DOCSUBTYPES = %w[spec release].freeze
-    RADIOTECHNOLOGIES = %w[2G 3G LTE 5G].freeze
-
-    # @return [String, nil]
-    attr_reader :radiotechnology, :release
-
-    #
-    # Initialize bibliographic item.
-    #
-    # @param [String, nil] radiotechnology
-    # @param [Boolean] common_ims_spec
-    # @param [Relaton3gpp::Release, nil] release
-    #
-    def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      Util.warn "Doctype is missing" if args[:type].nil?
-      @radiotechnology = args.delete(:radiotechnology)
-      if @radiotechnology && !RADIOTECHNOLOGIES.include?(@radiotechnology)
-        Util.warn "Unknown radiotechnology type: `#{@radiotechnology}`"
-        Util.warn "Possible radiotechnology types: `#{RADIOTECHNOLOGIES.join '`, `'}`"
-      end
-      @common_ims_spec = args.delete(:common_ims_spec)
-      @release = args.delete(:release)
-      if args[:docsubtype] && !DOCSUBTYPES.include?(args[:docsubtype])
-        Util.warn "Unknown docsubtype: `#{args[:docsubtype]}`"
-        Util.warn "Possible docsubtypes: `#{DOCSUBTYPES.join '`, `'}`"
-      end
-      super(**args)
-    end
-
-    #
-    # Fetch the flavor shcema version
-    #
-    # @return [String] schema version
-    #
-    def ext_schema
-      @ext_schema ||= schema_versions["relaton-model-3gpp"]
-    end
-
-    #
-    # @override RelatonBib::BibliographicItem#makeid
-    #
-    # @param [RelatonBib::DocumentIdentifier, nil] identifier <description>
-    # @param [Boolean, nil] attribute true if the ID attribute is needed
-    #
-    # @return [String, nil] id
-    #
-    def makeid(identifier, attribute)
-      super&.sub(/^3GPP/, "")
-    end
-
-    # @param opts [Hash]
-    # @option opts [Nokogiri::XML::Builder] :builder XML builder
-    # @option opts [Boolean] :bibdata
-    # @option opts [String] :lang language
-    # @return [String] XML
-    def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      super do |b|
-        if block_given? then yield b
-        elsif opts[:bibdata] && has_ext_attrs?
-          ext = b.ext do
-            doctype&.to_xml b
-            b.subdoctype subdoctype if subdoctype
-            editorialgroup&.to_xml b
-            ics.each { |i| i.to_xml b }
-            b.radiotechnology radiotechnology if radiotechnology
-            b.send :"common-ims-spec", @common_ims_spec if @common_ims_spec
-            release&.to_xml b
-          end
-          ext["schema-version"] = ext_schema unless opts[:embedded]
-        end
-      end
-    end
-
-    def has_ext_attrs? # rubocop:disable Metrics/CyclomaticComplexity
-      doctype || subdoctype || editorialgroup || ics.any? || radiotechnology ||
-        @common_ims_spec || release
-    end
-
-    #
-    # Convert to hash.
-    #
-    # @return [Hash
-    #
-    def to_hash(embedded: false)
-      hash = super
-      hash["ext"]["radiotechnology"] = radiotechnology if radiotechnology
-      hash["ext"]["common-ims-spec"] = @common_ims_spec if @common_ims_spec
-      hash["ext"]["release"] = release.to_hash if release
-      hash
-    end
-
-    def has_ext?
-      super || radiotechnology || @common_ims_spec || release
-    end
-  end
-end

data/lib/relaton_3gpp/bibliography.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-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/"
-    INDEX_FILE = "index-v1.yaml"
-
-    # @param text [String]
-    # @return [RelatonBib::BibliographicItem]
-    def search(text) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      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"
-
-      hash = YAML.safe_load resp.body
-      bib_hash = Relaton3gpp::HashConverter.hash_to_bib(hash)
-      bib_hash[:fetched] = Date.today.to_s
-      Relaton3gpp::BibliographicItem.new(**bib_hash)
-    rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
-           EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
-           Net::ProtocolError, Errno::ETIMEDOUT => e
-      raise RelatonBib::RequestError, e.message
-    end
-
-    # @param ref [String] the W3C standard Code to look up
-    # @param year [String, NilClass] not used
-    # @param opts [Hash] options
-    # @return [RelatonBib::BibliographicItem]
-    def get(ref, _year = nil, _opts = {})
-      Util.info "Fetching from Relaton repository ...", key: ref
-      result = search(ref)
-      unless result
-        Util.info "Not found.", key: ref
-        return
-      end
-
-      Util.info "Found: `#{result.docidentifier[0].id}`", key: ref
-      result
-    end
-
-    extend Bibliography
-  end
-end