relaton-3gpp 1.9.0

data/lib/relaton_3gpp/parser.rb

@@ -0,0 +1,244 @@
+module Relaton3gpp
+  class Parser
+    #
+    # Document parser initalization
+    #
+    # @param [Hash] row row
+    # @param [Array<Hash>] specrels Spec + Release table
+    # @param [Array<Hash>] relaeases Releases table
+    # @param [Array<Hash>] specs Specs table
+    #
+    def initialize(row, specs, specrels, releases) # rubocop:disable Metrics/AbcSize
+      @row = row
+      @spec = specs.detect { |s| s[:Number] == row[:spec] }
+      if @spec
+        @specrel = specrels.detect do |sr|
+          sr[:Spec] == row[:spec] && sr[:Release] == row[:release]
+        end
+        @rel = releases.detect { |r| r[:Release_code] == row[:release] }
+      end
+    end
+
+    #
+    # Initialize document parser and run it
+    #
+    # @param [Hash] row row
+    # @param [Array<Hash>] specrels Spec + Release table
+    # @param [Array<Hash>] relaeases Releases table
+    # @param [Array<Hash>] specs Specs table
+    #
+    # @return [RelatonBib:BibliographicItem, nil] bibliographic item
+    #
+    def self.parse(row, specs, specrels, relaeases)
+      new(row, specs, specrels, relaeases).parse
+    end
+
+    #
+    # Parse document
+    #
+    # @return [Relaton3gpp:BibliographicItem, nil] bibliographic item
+    #
+    def parse # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      return unless @spec && @row[:"3guId"]
+
+      Relaton3gpp::BibliographicItem.new(
+        type: "standard",
+        fetched: Date.today.to_s,
+        language: ["en"],
+        script: ["Latn"],
+        title: parse_title,
+        link: parse_link,
+        abstract: parse_abstract,
+        docid: parse_docid,
+        docnumber: number,
+        date: parse_date,
+        doctype: @spec[:Type],
+        editorialgroup: parse_editorialgroup,
+        biblionote: parse_note,
+        docstatus: parse_status,
+        radiotechnology: parse_radiotechnology,
+        common_ims_spec: @spec[:ComIMS] == "1",
+        # internal: @spec[:"For publication"] == "0",
+        release: parse_release,
+        # contributor: contributor,
+      )
+    end
+
+    #
+    # Parse title
+    #
+    # @return [RelatonBib::TypedTitleStringCollection] title
+    #
+    def parse_title
+      t = RelatonBib::TypedTitleString.new content: @spec[:Title], type: "main"
+      RelatonBib::TypedTitleStringCollection.new [t]
+    end
+
+    #
+    # Parse link
+    #
+    # @return [Array<RelatonBib::TypedUri>] link
+    #
+    def parse_link
+      return [] unless @row[:location]
+
+      content = @row[:location].split("#").last
+      [RelatonBib::TypedUri.new(type: "src", content: content)]
+    end
+
+    #
+    # Parse abstract
+    #
+    # @return [Array<RelatonBib::FormattedString>] 
+    #
+    def parse_abstract
+      return [] unless @spec[:description]
+
+      [RelatonBib::FormattedString.new(content: @spec[:description])]
+    end
+
+    #
+    # Parse docidentifier
+    #
+    # @return [Arra<RelatonBib::DocumentIdentifier>] docidentifier
+    #
+    def parse_docid
+      [
+        RelatonBib::DocumentIdentifier.new(type: "3GPP", id: "3GPP #{number}"),
+        RelatonBib::DocumentIdentifier.new(type: "rapporteurId",
+                                           id: @spec[:"rapporteur id"]),
+      ]
+    end
+
+    #
+    # Generate number
+    #
+    # @return [String] number
+    #
+    def number
+      "#{@spec[:Type]} #{@row[:spec]}:#{@row[:release]}/#{version}"
+    end
+
+    #
+    # Version
+    #
+    # @return [String] version
+    #
+    def version
+      "#{@row[:MAJOR_VERSION_NB]}.#{@row[:TECHNICAL_VERSION_NB]}.#{@row[:EDITORIAL_VERSION_NB]}"
+    end
+
+    #
+    # Parse date
+    #
+    # @return [Array<RelatonBib::BibliographicDate>] date
+    #
+    def parse_date
+      d = []
+      if @row[:completed]
+        cd = Date.parse(@row[:completed]).to_s
+        d << RelatonBib::BibliographicDate.new(type: "created", on: cd)
+      end
+      if @spec[:"title verified"]
+        td = Date.parse(@spec[:"title verified"]).to_s
+        d << RelatonBib::BibliographicDate.new(type: "confirmed", on: td)
+      end
+      d
+    end
+
+    #
+    # Parse editorialgroup
+    #
+    # @return [RelatonBib::EditorialGroup] editorialgroups
+    #
+    def parse_editorialgroup # rubocop:disable Metrics/MethodLength
+      wgp = RelatonBib::WorkGroup.new(name: @spec[:"WG prime"], type: "prime")
+      eg = [RelatonBib::TechnicalCommittee.new(wgp)]
+      if @spec[:"WG other"]
+        wgo = RelatonBib::WorkGroup.new(name: @spec[:"WG other"], type: "other")
+        eg << RelatonBib::TechnicalCommittee.new(wgo)
+      end
+      if @spec[:"former WG"]
+        wgf = RelatonBib::WorkGroup.new(name: @spec[:"former WG"], type: "former")
+        eg << RelatonBib::TechnicalCommittee.new(wgf)
+      end
+      RelatonBib::EditorialGroup.new eg
+    end
+
+    #
+    # Parse note
+    #
+    # @return [RelatonBib::BiblioNoteCollection] notes
+    #
+    def parse_note
+      n = []
+      if @specrel && @specrel[:remarks]
+        n << RelatonBib::BiblioNote.new(type: "remark", content: @specrel[:remarks])
+      end
+      if @row[:comment]
+        n << RelatonBib::BiblioNote.new(type: "comment", content: @row[:comment])
+      end
+      RelatonBib::BiblioNoteCollection.new n
+    end
+
+    #
+    # Prase status
+    #
+    # @return [RelatnoBib::DocumentStatus, nil] status
+    #
+    def parse_status
+      if @specrel && @specrel[:withdrawn] == "1"
+        RelatonBib::DocumentStatus.new stage: "withdrawn"
+      elsif @spec[:"For publication"] == "1"
+        RelatonBib::DocumentStatus.new stage: "published"
+      end
+    end
+
+    #
+    # Parse radio technology
+    #
+    # @return [String] radio technology
+    #
+    def parse_radiotechnology
+      if @spec[:"2g"] == "1" then "2G"
+      elsif @spec[:"3g"] == "1" then "3G"
+      elsif @spec[:LTE] == "1" then "LTE"
+      elsif @spec[:"5G"] == "1" then "5G"
+      end
+    end
+
+    def parse_release # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      if @rel
+        project_start = Date.parse(@rel[:"rel-proj-start"]).to_s if @rel[:"rel-proj-start"]
+        project_end = Date.parse(@rel[:"rel-proj-end"]).to_s if @rel[:"rel-proj-end"]
+      end
+      Release.new(
+        version2g: @rel[:version_2g],
+        version3g: @rel[:version_3g],
+        defunct: @rel[:defunct] == "1",
+        wpm_code_2g: @rel[:wpm_code_2g],
+        wpm_code_3g: @rel[:wpm_code_3g],
+        freeze_meeting: @rel[:"freeze meeting"],
+        freeze_stage1_meeting: @rel[:Stage1_freeze],
+        freeze_stage2_meeting: @rel[:Stage2_freeze],
+        freeze_stage3_meeting: @rel[:Stage3_freeze],
+        close_meeting: @rel[:Closed],
+        project_start: project_start,
+        project_end: project_end,
+      )
+    end
+
+    #
+    # Create contributor
+    #
+    # @return [Array<RelatonBib::Contribution>] contributor
+    #
+    # def contributor
+    #   org = RelatonBib::Organization.new(
+    #     name: "Internet Assigned Numbers Authority", abbreviation: "IANA",
+    #   )
+    #   role = { type: "publisher" }
+    #   [RelatonBib::ContributionInfo.new(entity: org, role: [role])]
+    # end
+  end
+end

data/lib/relaton_3gpp/processor.rb

@@ -0,0 +1,54 @@
+require "relaton/processor"
+
+module Relaton3gpp
+  class Processor < Relaton::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]
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, date, opts)
+      ::Relaton3gpp::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(**opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonBib::BibliographicItem]
+    def from_xml(xml)
+      ::Relaton3gpp::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::Relaton3gpp::HashConverter.hash_to_bib(hash)
+      ::Relaton3gpp::BibliographicItem.new(**item_hash)
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::Relaton3gpp.grammar_hash
+    end
+  end
+end

data/lib/relaton_3gpp/release.rb

@@ -0,0 +1,65 @@
+module Relaton3gpp
+  class Release
+    #
+    # Initialize release.
+    #
+    # @param [String] version2g
+    # @param [String] version3g
+    # @param [Boolean] defunct
+    # @param [String] wpn_code_2g
+    # @param [String] wpn_code_3g
+    # @param [String] freeze_stage1_meeting
+    # @param [String] freeze_stage2_meeting
+    # @param [String] freeze_stage3_meeting
+    # @param [String] close_meeting
+    # @param [String] project_start
+    # @param [String] project_end
+    #
+    def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      @version2g = args[:version2g]
+      @version3g = args[:version3g]
+      @defunct = args[:defunct]
+      @wpm_code_2g = args[:wpm_code_2g]
+      @wpm_code_3g = args[:wpm_code_3g]
+      @freeze_meeting = args[:freeze_meeting]
+      @freeze_stage1_meeting = args[:freeze_stage1_meeting]
+      @freeze_stage2_meeting = args[:freeze_stage2_meeting]
+      @freeze_stage3_meeting = args[:freeze_stage3_meeting]
+      @close_meeting = args[:close_meeting]
+      @project_start = args[:project_start]
+      @project_end = args[:project_end]
+    end
+
+    #
+    # Render XML.
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      builder.release do
+        builder.version2G @version2g if @version2g
+        builder.version3G @version3g if @version3g
+        builder.defunct @defunct if @defunct
+        builder.send "wpm-code-2G", @wpm_code_2g if @wpm_code_2g
+        builder.send "wpm-code-3G", @wpm_code_3g if @wpm_code_3g
+        builder.send "freeze-meeting", @freeze_meeting if @freeze_meeting
+        builder.send "freeze-stage1-meeting", @freeze_stage1_meeting if @freeze_stage1_meeting
+        builder.send "freeze-stage2-meeting", @freeze_stage2_meeting if @freeze_stage2_meeting
+        builder.send "freeze-stage3-meeting", @freeze_stage3_meeting if @freeze_stage3_meeting
+        builder.send "close-meeting", @close_meeting if @close_meeting
+        builder.send "project-start", @project_start if @project_start
+        builder.send "project-end", @project_end if @project_end
+      end
+    end
+
+    def to_hash
+      hash = {}
+      instance_variables.each do |var|
+        unless instance_variable_get(var).nil? 
+          hash[var.to_s.delete("@")] = instance_variable_get var
+        end
+      end
+      hash
+    end
+  end
+end

data/lib/relaton_3gpp/version.rb

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

data/lib/relaton_3gpp/xml_parser.rb

@@ -0,0 +1,58 @@
+module Relaton3gpp
+  class XMLParser < RelatonBib::XMLParser
+    class << self
+      private
+
+      #
+      # Parse XML to hash
+      #
+      # @param [Nokofiri::XML::Element] bibitem
+      #
+      # @return [Hash]
+      #
+      def item_data(bibitem)
+        hash = super
+        ext = bibitem.at "./ext"
+        if ext
+          hash[:radiotechnology] = ext.at("./radiotechnology")&.text
+          hash[:common_ims_spec] = ext.at("./common-ims-spec")&.text
+          hash[:release] = fetch_release(ext)
+        end
+        hash
+      end
+
+      #
+      # Ftech release information
+      #
+      # @param [Nokogiri::XML::Element] ext
+      #
+      # @return [Relaton3gpp::Release] release
+      #
+      def fetch_release(ext) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+        release = ext.at("./release")
+        return unless release
+
+        hash = {}
+        hash[:version2g] = release.at("./version2G")&.text
+        hash[:version3g] = release.at("./version3G")&.text
+        hash[:defunct] = release.at("./defunct")&.text
+        hash[:wpm_code_2g] = release.at("./wpm-code-2G")&.text
+        hash[:wpm_code_3g] = release.at("./wpm-code-3G")&.text
+        hash[:freeze_meeting] = release.at("./freeze-meeting")&.text
+        hash[:freeze_stage1_meeting] = release.at("./freeze-stage1-meeting")&.text
+        hash[:freeze_stage2_meeting] = release.at("./freeze-stage2-meeting")&.text
+        hash[:freeze_stage3_meeting] = release.at("./freeze-stage3-meeting")&.text
+        hash[:close_meeting] = release.at("./close-meeting")&.text
+        hash[:project_start] = release.at("./project-start")&.text
+        hash[:project_end] = release.at("./project-end")&.text
+        Release.new(**hash)
+      end
+
+      # @param item_hash [Hash]
+      # @return [RelatonSgpp::BibliographicItem]
+      def bib_item(item_hash)
+        BibliographicItem.new(**item_hash)
+      end
+    end
+  end
+end

data/lib/relaton_3gpp.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "relaton_bib"
+require_relative "relaton_3gpp/version"
+require_relative "relaton_3gpp/release"
+require_relative "relaton_3gpp/bibliographic_item"
+require_relative "relaton_3gpp/hash_converter"
+require_relative "relaton_3gpp/xml_parser"
+require_relative "relaton_3gpp/bibliography"
+require_relative "relaton_3gpp/parser"
+require_relative "relaton_3gpp/data_fetcher"
+
+module Relaton3gpp
+  class Error < StandardError; end
+
+  # 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 grammars
+  end
+end

data/relaton_3gpp.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "lib/relaton_3gpp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "relaton-3gpp"
+  spec.version       = Relaton3gpp::VERSION
+  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.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # 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 "relaton-bib", "~> 1.9.0"
+  spec.add_dependency "rubyzip", "~> 2.3.0"
+end