relaton-3gpp 1.9.0

data/grammars/reqt.rng

@@ -0,0 +1,205 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="model"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="subject"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="reqinherit"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+        <ref name="component"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/relaton_3gpp/bibliographic_item.rb

@@ -0,0 +1,74 @@
+module Relaton3gpp
+  class BibliographicItem < RelatonBib::BibliographicItem
+    DOCTYPES = %w[TR TS].freeze
+    DOCSUBTYPES = %w[spec release].freeze
+    RADIOTECHNOLOGIES = %w[2G 3G LTE 5G].freeze
+
+    #
+    # Initialize bibliographic item.
+    #
+    # @param [String] radiotechnology
+    # @param [Boolean] common_ims_spec
+    # @param [Relaton3gpp::Release] release
+    #
+    def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      @radiotechnology = args.delete(:radiotechnology)
+      if @radiotechnology && !RADIOTECHNOLOGIES.include?(@radiotechnology)
+        warn "[relaton-3gpp] Unknown radiotechnology type: #{@radiotechnology}"
+        warn "[relaton-3gpp] Possible radiotechnology types: #{RADIOTECHNOLOGIES.join ' '}"
+      end
+      @common_ims_spec = args.delete(:common_ims_spec)
+      @release = args.delete(:release)
+      if args[:doctype].nil? then warn "[relaton-3gpp] doctype is missing"
+      elsif !DOCTYPES.include?(args[:doctype])
+        warn "[relaton-3gpp] Unknown doctype: #{args[:doctype]}"
+        warn "[relaton-3gpp] Possible doctypes: #{DOCTYPES.join ' '}"
+      end
+      if args[:docsubtype] && !DOCSUBTYPES.include?(args[:docsubtype])
+        warn "[relaton-3gpp] Unknown docsubtype: #{args[:docsubtype]}"
+        warn "[relaton-3gpp] Possible docsubtypes: #{DOCSUBTYPES.join ' '}"
+      end
+      super(**args)
+    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?
+          b.ext do
+            b.doctype doctype if doctype
+            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 if @release
+          end
+        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
+      hash = super
+      hash["radiotechnology"] = @radiotechnology if @radiotechnology
+      hash["common-ims-spec"] = @common_ims_spec if @common_ims_spec
+      hash["release"] = @release.to_hash if @release
+      hash
+    end
+  end
+end

data/lib/relaton_3gpp/bibliography.rb

@@ -0,0 +1,44 @@
+# 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/data/"
+
+    # @param text [String]
+    # @return [RelatonBib::BibliographicItem]
+    def search(text) # rubocop:disable Metrics/MethodLength
+      file = text.sub(/^3GPP\s/, "").gsub(/[\s,:\/]/, "_").squeeze("_").upcase
+      url = "#{SOURCE}#{file}.yaml"
+      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)
+      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 = {})
+      warn "[relaton-3gpp] (\"#{ref}\") fetching..."
+      result = search(ref)
+      unless result
+        warn "[relaton-3gpp] (\"#{ref}\") not found"
+        return
+      end
+
+      warn "[relaton-3gpp] (\"#{ref}\") found #{result.docidentifier[0].id}"
+      result
+    end
+
+    extend Bibliography
+  end
+end

data/lib/relaton_3gpp/data_fetcher.rb

@@ -0,0 +1,135 @@
+require "fileutils"
+require "net/ftp"
+require "zip"
+require "mdb"
+
+module Relaton3gpp
+  class DataFetcher
+    CURRENT = "current.yaml".freeze
+    #
+    # Data fetcher initializer
+    #
+    # @param [String] output directory to save files
+    # @param [String] format format of output files (xml, yaml, bibxml)
+    #
+    def initialize(output, format)
+      @output = output
+      @format = format
+      @ext = format.sub(/^bib/, "")
+      @files = []
+    end
+
+    #
+    # Initialize fetcher and run fetch
+    #
+    # @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")
+      t1 = Time.now
+      puts "Started at: #{t1}"
+      FileUtils.mkdir_p output unless Dir.exist? output
+      new(output, format).fetch
+      t2 = Time.now
+      puts "Stopped at: #{t2}"
+      puts "Done in: #{(t2 - t1).round} sec."
+    end
+
+    #
+    # Parse documents
+    #
+    def fetch # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      file = get_file
+      return unless file
+
+      Zip::File.open(file) do |zip_file|
+        enntry = zip_file.glob("status_smg_3GPP.mdb").first
+        File.open("status_smg_3GPP.mdb", "wb") do |f|
+          f.write enntry.get_input_stream.read
+        end
+      end
+      dbs = Mdb.open "status_smg_3GPP.mdb"
+      specs = dbs["Specs_GSM+3G"]
+      specrels = dbs["Specs_GSM+3G_release-info"]
+      releases = dbs["Releases"]
+      dbs["2001-04-25_schedule"].each do |row|
+        fetch_doc row, specs, specrels, releases
+      end
+      File.write CURRENT, @current.to_yaml, encoding: "UTF-8"
+    end
+
+    #
+    # Get file from FTP
+    #
+    # @return [String] file name
+    #
+    def get_file # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      @current = YAML.load_file CURRENT if File.exist? CURRENT
+      @current ||= {}
+      ftp = Net::FTP.new("www.3gpp.org")
+      ftp.resume = true
+      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"])
+
+      ftp.getbinaryfile file
+      @current["file"] = file
+      @current["date"] = dt.to_s
+      file
+    end
+
+    #
+    # Fetch document
+    #
+    # @param [Hash] row row from mdb
+    # @param [Mdb] dbs mdb
+    #
+    # @return [Relaton3gpp::BibliographicItem, nil] bibliographic item
+    #
+    def fetch_doc(row, specs, specrels, releases)
+      doc = Parser.parse row, specs, specrels, releases
+      save_doc doc
+    rescue StandardError => e
+      warn "Error: #{e.message}"
+      warn "PubID: #{row[:spec]}:#{row[:release]}/#{row[:MAJOR_VERSION_NB]}."\
+           "#{row[:TECHNICAL_VERSION_NB]}.#{row[:EDITORIAL_VERSION_NB]}"
+      warn e.backtrace[0..5].join("\n")
+    end
+
+    #
+    # Save document to file
+    #
+    # @param [RelatonW3c::W3cBibliographicItem, nil] bib bibliographic item
+    #
+    def save_doc(bib) # rubocop:disable Metrics/MethodLength
+      return unless bib
+
+      c = case @format
+          when "xml" then bib.to_xml(bibdata: true)
+          when "yaml" then bib.to_hash.to_yaml
+          else bib.send("to_#{@format}")
+          end
+      file = file_name(bib)
+      if @files.include? file
+        warn "File #{file} already exists. Document: #{bib.docnumber}"
+      else
+        @files << file
+      end
+      File.write file, c, encoding: "UTF-8"
+    end
+
+    #
+    # Generate file name
+    #
+    # @param [RelatonW3c::W3cBibliographicItem] bib bibliographic item
+    #
+    # @return [String] file name
+    #
+    def file_name(bib)
+      name = bib.docnumber.gsub(/[\s,:\/]/, "_").squeeze("_").upcase
+      File.join @output, "#{name}.#{@ext}"
+    end
+  end
+end

data/lib/relaton_3gpp/hash_converter.rb

@@ -0,0 +1,21 @@
+module Relaton3gpp
+  class HashConverter < RelatonBib::HashConverter
+    class << self
+      def hash_to_bib(args, nested = false)
+        hash = super
+        release_hash_to_bib(hash)
+        hash
+      end
+
+      def release_hash_to_bib(hash)
+        hash[:release] &&= Release.new(**hash[:release])
+      end
+
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        BibliographicItem.new(**item_hash)
+      end
+    end
+  end
+end