relaton-omg 0.1.0

data/lib/relaton_omg/hash_converter.rb

@@ -0,0 +1,6 @@
+module RelatonOmg
+  class HashConverter < RelatonBib::HashConverter
+    class << self
+    end
+  end
+end

data/lib/relaton_omg/omg_bibliographic_item.rb

@@ -0,0 +1,55 @@
+module RelatonOmg
+  class OmgBibliographicItem < RelatonBib::BibliographicItem
+    # @return [String, NilClass]
+    attr_reader :doctype
+
+    # @param doctype [String]
+    # @param keyword [Array<String>]
+    def initialize(**args)
+      @doctype = args.delete :doctype
+      # @keyword = args.delete(:keyword) || []
+      super
+    end
+
+    class << self
+      # @param file [String] path to YAML file
+      # @return [RelatonOmg::OmgBibliographicItem]
+      def from_yaml(file)
+        from_hash YAML.load_file(file)
+      end
+
+      # @param hash [Hash]
+      # @return [RelatonOmg::OmgBibliographicItem]
+      def from_hash(hash)
+        new RelatonOmg::HashConverter.hash_to_bib(hash)
+      end
+
+      # @param file [String] path to XML file
+      # @return [RelatonOmg::OmgBibliographicItem]
+      def from_xml(file)
+        XMLParser.from_xml File.read file, encoding: "UTF-8"
+      end
+    end
+
+    # @param builder
+    # @param opts [Hash]
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    def to_xml(builder = nil, **opts)
+      opts[:date_format] ||= :short
+      super builder, **opts do |b|
+        # if opts[:bibdata]
+        #   b.ext do
+        #     b.doctype doctype if doctype
+        #   end
+        # end
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      hash = super
+      hash["doctype"] = doctype if doctype
+      hash
+    end
+  end
+end

data/lib/relaton_omg/omg_bibliography.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal:true
+
+module RelatonOmg
+  # OMG bibliography module
+  module OmgBibliography
+    class << self
+      # @param code [String] the OMG standard reference
+      # @return [RelatonOmg::OmgBibliographicItem]
+      def search(text)
+        Scrapper.scrape_page text
+      end
+
+      # @param code [String] the OMG standard reference
+      # @param year [String] the year the standard was published (optional)
+      # @param opts [Hash] options
+      # @return [RelatonOmg::OmgBibliographicItem]
+      def get(code, _year = nil, _opts = {})
+        search code
+      end
+    end
+  end
+end

data/lib/relaton_omg/processor.rb

@@ -0,0 +1,40 @@
+require "relaton/processor"
+require "relaton_omg/xml_parser"
+
+module RelatonOmg
+  class Processor < Relaton::Processor
+    def initialize
+      @short = :relaton_omg
+      @prefix = "OMG"
+      @defaultprefix = /^OMG /
+      @idtype = "OMG"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonIetf::IetfBibliographicItem]
+    def get(code, date, opts)
+      ::RelatonOmg::OmgBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonIetf::IetfBibliographicItem]
+    def from_xml(xml)
+      ::RelatonOmg::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonIetf::IetfBibliographicItem]
+    def hash_to_bib(hash)
+      # item_hash = ::RelatonOmg::HashConverter.hash_to_bib(hash)
+      ::RelatonOmg::OmgBibliographicItem.from_hash hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonOmg.grammar_hash
+    end
+  end
+end

data/lib/relaton_omg/scrapper.rb

@@ -0,0 +1,124 @@
+require "nokogiri"
+
+module RelatonOmg
+  module Scrapper
+    URL_PATTERN = "https://www.omg.org/spec/"
+
+    class << self
+      def scrape_page(ref)
+        %r{OMG (?<acronym>[^\s]+)\s?(?<version>.*)} =~ ref
+        return unless acronym
+
+        url = URL_PATTERN + acronym
+        url += "/" + version if version
+        doc = Nokogiri::HTML open(URI(url))
+        OmgBibliographicItem.new item(doc, acronym)
+      rescue OpenURI::HTTPError => e
+        if e.io.status[0] == "404"
+          warn %{[relaton-omg] no document found for "#{ref}" reference.}
+          return
+        end
+
+        raise RelatonBib::RequestError, "Unable acces #{url} (#{e.io.status.join(" ")}"
+      end
+
+      private
+
+      def item(doc, acronym)
+        {
+          id: fetch_id(doc, acronym),
+          fetched: Date.today.to_s,
+          docid: fetch_docid(doc, acronym),
+          title: fetch_title(doc),
+          abstract: fetch_abstract(doc),
+          version: fetch_version(doc),
+          date: fetch_date(doc),
+          docstatus: fetch_status(doc),
+          link: fetch_link(doc),
+          relation: fetch_relation(doc),
+          keyword: fetch_keyword(doc),
+          license: fetch_license(doc)
+        }
+      end
+
+      def fetch_id(doc, acronym)
+        acronym + version(doc)
+      end
+
+      def fetch_title(doc)
+        content = doc.at('//dt[.="Title:"]/following-sibling::dd').text
+        title = RelatonBib::FormattedString.new content: content, language: "en", script: "Latn"
+        [RelatonBib::TypedTitleString.new(type: "main", title: title)]
+      end
+
+      def fetch_docid(doc, acronym)
+        id = [acronym]
+        if (ver = version(doc))
+          id << ver
+        end
+        [RelatonBib::DocumentIdentifier.new(id: id.join(" "), type: "OMG")]
+      end
+
+      def fetch_abstract(doc)
+        content = doc.at('//section[@id="document-metadata"]/p').text
+        [{ content: content, language: "en", script: "Latn" }]
+      end
+
+      def fetch_version(doc)
+        RelatonBib::BibliographicItem::Version.new pub_date(doc), [version(doc)]
+      end
+
+      def version(doc)
+        doc.at('//dt[.="Version:"]/following-sibling::dd/p/text()').text.strip
+      end
+
+      def fetch_date(doc)
+        [type: "published", on: pub_date(doc).to_s]
+      end
+
+      def pub_date(doc)
+        Date.parse doc.at('//dt[.="Publication Date:"]/following-sibling::dd').text.strip
+      end
+
+      def fetch_status(doc)
+        status = doc.at('//dt[.="Document Status:"]/following-sibling::dd')
+        stage = status.text.strip.match(/\w+/).to_s
+        RelatonBib::DocumentStatus.new(stage: stage)
+      end
+
+      def fetch_link(doc)
+        links = []
+        a = doc.at('//dt[.="This Document:"]/following-sibling::dd/a')
+        links << { type: "src", content: a[:href] } if a
+        pdf = doc.at('//a[@class="download-document"]')
+        links << { type: "pdf", content: pdf[:href] } if pdf
+        links
+      end
+
+      def fetch_relation(doc)
+        current_version = version(doc)
+        v = doc.xpath('//h2[.="History"]/following-sibling::section/div/table/tbody/tr')
+        v.reduce([]) do |mem, row|
+          ver = row.at("td").text
+          unless ver == current_version
+            acronym = row.at('td[3]/a')[:href].split("/")[4]
+            fref = RelatonBib::FormattedRef.new content: "OMG #{acronym} #{ver}"
+            bibitem = OmgBibliographicItem.new formattedref: fref
+            mem << { type: "obsoletes", bibitem: bibitem }
+          end
+          mem
+        end
+      end
+
+      def fetch_keyword(doc)
+        doc.xpath('//dt[.="Categories:"]/following-sibling::dd/ul/li/a/em').map &:text
+      end
+
+      def fetch_license(doc)
+        doc.xpath(
+          '//dt/span/a[contains(., "IPR Mode")]/../../following-sibling::dd/span'
+        ).map { |l| l.text.match(/[\w\s-]+/).to_s.strip }
+      end
+    end
+  end
+end

data/lib/relaton_omg/version.rb

@@ -0,0 +1,3 @@
+module RelatonOmg
+  VERSION = "0.1.0"
+end

data/lib/relaton_omg/xml_parser.rb

@@ -0,0 +1,25 @@
+require "nokogiri"
+
+module RelatonOmg
+  class XMLParser < RelatonBib::XMLParser
+    class << self
+      def from_xml(xml)
+        doc = Nokogiri::XML(xml)
+        doc.remove_namespaces!
+        ietfitem = doc.at("/bibitem|/bibdata")
+        RelatonOmg::OmgBibliographicItem.new(item_data(ietfitem))
+      end
+
+      private
+
+      def item_data(ietfitem)
+        data = super
+        # ext = ietfitem.at "./ext"
+        # return data unless ext
+
+        # data[:doctype] = ext.at("./doctype")&.text
+        data
+      end
+    end
+  end
+end

data/lib/relaton_omg.rb

@@ -0,0 +1,19 @@
+require "nokogiri"
+require "relaton_bib"
+require "relaton_omg/version"
+require "relaton_omg/scrapper"
+require "relaton_omg/omg_bibliography"
+require "relaton_omg/omg_bibliographic_item"
+require "relaton_omg/xml_parser"
+require "relaton_omg/hash_converter"
+
+module RelatonOmg
+  # 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_omg.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/relaton_omg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "relaton-omg"
+  spec.version       = RelatonOmg::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonOmg: retrieve OMG Standards for bibliographic use"\
+                       "using the IsoBibliographicItem model"
+  spec.description   = "RelatonOmg: retrieve OMG Standards for bibliographic use"\
+                       "using the IsoBibliographicItem model"
+  spec.homepage      = "https://github.com/relaton/relaton-ogn"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/relaton/relaton-ogn"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "debase"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "ruby-debug-ide"
+  spec.add_development_dependency "ruby-jing"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "relaton-bib", "~> 0.7.0"
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: relaton-omg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-jing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: relaton-bib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: 'RelatonOmg: retrieve OMG Standards for bibliographic useusing the IsoBibliographicItem
+  model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/macos.yml"
+- ".github/workflows/ubuntu.yml"
+- ".github/workflows/windows.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- grammars/biblio.rng
+- lib/relaton_omg.rb
+- lib/relaton_omg/hash_converter.rb
+- lib/relaton_omg/omg_bibliographic_item.rb
+- lib/relaton_omg/omg_bibliography.rb
+- lib/relaton_omg/processor.rb
+- lib/relaton_omg/scrapper.rb
+- lib/relaton_omg/version.rb
+- lib/relaton_omg/xml_parser.rb
+- relaton_omg.gemspec
+homepage: https://github.com/relaton/relaton-ogn
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/relaton/relaton-ogn
+  source_code_uri: https://github.com/relaton/relaton-ogn
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: 'RelatonOmg: retrieve OMG Standards for bibliographic useusing the IsoBibliographicItem
+  model'
+test_files: []