relaton-oasis 1.10.0

data/lib/relaton_oasis/data_part_parser.rb

@@ -0,0 +1,131 @@
+module RelatonOasis
+  class DataPartParser
+    include RelatonOasis::DataParserUtils
+
+    #
+    # Initialize parser.
+    #
+    # @param [Nokogiri::HTML::Element] node docment node
+    #
+    def initialize(node)
+      @node = node
+      @text = node.xpath(
+        "./strong/following-sibling::text()|./span/strong/../following-sibling::text()",
+      ).text.strip
+      t = @node.at("./span[@class='citationTitle' or @class='citeTitle']|./em|./i")
+      @title = if t then t.text
+               else
+                 @text.match(/(?<content>.+)\s(?:Edited|\d{2}\s\w+\d{4})/)[:content]
+               end.strip
+    end
+
+    #
+    # Parse document.
+    #
+    # @return [RelatonOasis::OasisBibliographicItem] bibliographic item
+    #
+    def parse # rubocop:disable Metrics/MethodLength
+      RelatonOasis::OasisBibliographicItem.new(
+        fetched: Date.today.to_s,
+        type: "standard",
+        doctype: parse_doctype,
+        title: parse_title,
+        docid: parse_docid,
+        link: parse_link,
+        docnumber: parse_docnumber,
+        date: parse_date,
+        # abstract: parse_abstract,
+        language: ["en"],
+        script: ["Latn"],
+        # editorialgroup: parse_editorialgroup,
+        relation: parse_relation,
+        contributor: parse_contributor,
+        technology_area: parse_technology_area,
+      )
+    end
+
+    #
+    # Pase title.
+    #
+    # @return [Array<RelatonBib::TypedTitleString>] title
+    #
+    def parse_title
+      [RelatonBib::TypedTitleString.new(type: "main", content: @title, language: "en", script: "Latn")]
+    end
+
+    #
+    # Parse document number.
+    #
+    # @return [String] document number
+    #
+    def parse_docnumber
+      ref = @node.at("./span[@class='citationLabel']/strong|./strong|b/span")
+      num = ref.text.match(/[^\[\]]+/).to_s
+      # some part references need to be added by "Pt" to be distinguishable from root doc
+      num += "-Pt" if %w[CMIS-v1.1 DocBook-5.0 XACML-V3.0 mqtt-v3.1.1 OData-JSON-Format-v4.0].include?(num)
+      parse_spec num
+    end
+
+    #
+    # Parse link.
+    #
+    # @return [Array<RelatonBib::TypedTitleString>] link
+    #
+    def parse_link
+      l = @node.at("./a")
+      [RelatonBib::TypedUri.new(type: "src", content: l[:href])]
+    end
+
+    #
+    # Parse date.
+    #
+    # @return [Array<RelatonBib::BibliographicDate>] bibliographic dates
+    #
+    def parse_date
+      /(?<on>\d{1,2}\s\w+\s\d{4})/ =~ @text
+      [RelatonBib::BibliographicDate.new(on: Date.parse(on).to_s, type: "issued")]
+    end
+
+    # def parse_abstract
+    #   /\d{2}\s\w+\s\d{4}\.\s(?<content>.+)\sLatest\sversion/ =~ @text
+    #   [RelatonBib::FormattedString.new(content: content, language: "en", script: "Latn")]
+    # end
+
+    #
+    # Parse contributor.
+    #
+    # @return [Array<RelatonBib::ContributionInfo>] contributors
+    #
+    def parse_contributor
+      @text.match(/(?<=Edited\sby\s)[^.]+/).to_s.split(/,\s|,?\sand\s/).map do |c|
+        forename, surname = c.split
+        fn = RelatonBib::LocalizedString.new(forename, "en", "Latn")
+        sn = RelatonBib::LocalizedString.new(surname, "en", "Latn")
+        name = RelatonBib::FullName.new(surname: sn, forename: [fn])
+        entity = RelatonBib::Person.new(name: name)
+        RelatonBib::ContributionInfo.new(role: [type: "editor"], entity: entity)
+      end
+    end
+
+    #
+    # Parse relation.
+    #
+    # @return [Array<RelatonBib::DocumentRelation>] document relations
+    #
+    def parse_relation
+      parser = DataParser.new @node.at("./ancestor::details")
+      fref = RelatonBib::FormattedRef.new(content: parser.parse_docid[0].id)
+      bib = RelatonOasis::OasisBibliographicItem.new(formattedref: fref)
+      [RelatonBib::DocumentRelation.new(type: "partOf", bibitem: bib)]
+    end
+
+    #
+    # Parse technology area.
+    #
+    # @return [Array<String>] technology areas
+    #
+    def parse_technology_area
+      super @node.at("./ancestor::details")
+    end
+  end
+end

data/lib/relaton_oasis/hash_converter.rb

@@ -0,0 +1,15 @@
+module RelatonOasis
+  class HashConverter < RelatonBib::HashConverter
+    @@acronyms = nil
+
+    class << self
+      private
+
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        OasisBibliographicItem.new(**item_hash)
+      end
+    end
+  end
+end

data/lib/relaton_oasis/oasis_bibliographic_item.rb

@@ -0,0 +1,81 @@
+module RelatonOasis
+  class OasisBibliographicItem < RelatonBib::BibliographicItem
+    AREAS = %w[Cloud Content-Technologies Cybersecurity e-Business eGov/Legal
+               Emergency-Management Energy Information-Modeling IoT
+               Lifecycle-Integration Localization Messaging Privacy/Identity
+               Security SOA Web-Services].freeze
+
+    attr_reader :technology_area
+
+    #
+    # Initialize OasisBibliographicItem.
+    #
+    # @param [Array<String>] technology_area technology areas
+    #
+    def initialize(**args)
+      @technology_area = args.delete(:technology_area) || []
+      uta = @technology_area.reject { |a| AREAS.include? a }
+      if uta.any?
+        warn "[relaton-oasis] WARNING Unknown technology area: #{uta.join(', ')}"
+        warn "[relaton-oasis] (Valid values are: #{AREAS.join(', ')})"
+      end
+      super
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBipm::BipmBibliographicItem]
+    def self.from_hash(hash)
+      item_hash = ::RelatonOasis::HashConverter.hash_to_bib(hash)
+      new(**item_hash)
+    end
+
+    #
+    # Render bibliographic item as XML.
+    #
+    # @param opts [Hash] options
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata true if bibdata is rendered
+    # @option opts [String] :lang language code
+    #
+    # @return [String] XML representation of bibliographic item
+    #
+    def to_xml(**opts)
+      super(**opts) do |b|
+        if opts[:bibdata] && technology_area.any?
+          b.ext do
+            b.doctype doctype if doctype
+            editorialgroup&.to_xml b
+            technology_area.each { |ta| b.send :"technology-area", ta }
+          end
+        end
+      end
+    end
+
+    #
+    # Render bibliographic item as Hash.
+    #
+    # @return [Hash] bibliographic item as Hash
+    #
+    def to_hash
+      hash = super
+      hash["technology_area"] = technology_area if technology_area.any?
+      hash
+    end
+
+    #
+    # Render bibliographic item as AsciiBib.
+    #
+    # @param prefix [String] prefix
+    #
+    # @return [String] bibliographic item as AsciiBib
+    #
+    def to_asciibib(prefix = "")
+      pref = prefix.empty? ? prefix : "#{prefix}."
+      out = super
+      technology_area.each do |ta|
+        out += "#{pref}technology_area:: #{ta}\n"
+      end
+      out
+    end
+  end
+end

data/lib/relaton_oasis/oasis_bibliography.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RelatonOasis
+  # Class methods for search Cenelec standards.
+  class OasisBibliography
+    ENDPOINT = "https://raw.githubusercontent.com/relaton/relaton-data-oasis/main/data/"
+
+    class << self
+      # @param text [String]
+      # @return [RelatonOasis::HitCollection]
+      def search(text, _year = nil)
+        /^(?:OASIS\s)?(?<code>.+)/ =~ text
+        agent = Mechanize.new
+        resp = agent.get "#{ENDPOINT}#{code.upcase}.yaml"
+        return unless resp.code == "200"
+
+        hash = YAML.safe_load resp.body
+        OasisBibliographicItem.from_hash hash
+      rescue Mechanize::ResponseCodeError => e
+        return if e.response_code == "404"
+
+        raise RelatonBib::RequestError, e.message
+      end
+
+      # @param code [String] the CEN standard Code to look up
+      # @param year [String] the year the standard was published (optional)
+      # @param opts [Hash] options; restricted to :all_parts if all-parts
+      #   reference is required
+      # @return [RelatonOasis::OasisBibliographicItem, nil]
+      def get(code, year = nil, _opts = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+        warn "[relaton-oasis] (#{code} fetching..."
+        bibitem = search code, year
+        if bibitem
+          docid = bibitem.docidentifier.detect(&:primary).id
+          warn "[relaton-oasis] (#{code}) found #{docid}"
+          bibitem
+        else
+          warn "[relaton-oasis] (#{code}) not found"
+        end
+      end
+    end
+  end
+end

data/lib/relaton_oasis/processor.rb

@@ -0,0 +1,51 @@
+require "relaton/processor"
+
+module RelatonOasis
+  class Processor < Relaton::Processor
+    def initialize # rubocop:disable Lint/MissingSuper
+      @short = :relaton_oasis
+      @prefix = "OASIS"
+      @defaultprefix = %r{^OASIS\s}
+      @idtype = "OASIS"
+      @datasets = %w[oasis-open]
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, date, opts)
+      ::RelatonOasis::OasisBibliography.get(code, date, opts)
+    end
+
+    #
+    # Fetch all the documents from https://www.oasis-open.org/standards/
+    #
+    # @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)
+      ::RelatonOasis::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def hash_to_bib(hash)
+      ::RelatonOasis::OasisBibliographicItem.from_hash hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonOasis.grammar_hash
+    end
+  end
+end

data/lib/relaton_oasis/version.rb

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

data/lib/relaton_oasis/xml_parser.rb

@@ -0,0 +1,25 @@
+module RelatonOasis
+  class XMLParser < RelatonBib::XMLParser
+    class << self
+      private
+
+      # Override RelatonBib::XMLParser#item_data method.
+      # @param node [Nokogiri::XML::Element]
+      # @returtn [Hash]
+      def item_data(node)
+        data = super
+        ext = node.at "./ext"
+        return data unless ext
+
+        data[:technology_area] = ext.xpath("./technology-area").map &:text
+        data
+      end
+
+      # @param item_hash [Hash]
+      # @return [RelatonBib::BibliographicItem]
+      def bib_item(item_hash)
+        OasisBibliographicItem.new(**item_hash)
+      end
+    end
+  end
+end

data/lib/relaton_oasis.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "mechanize"
+require "relaton_bib"
+require_relative "relaton_oasis/version"
+require_relative "relaton_oasis/oasis_bibliographic_item"
+require_relative "relaton_oasis/xml_parser"
+require_relative "relaton_oasis/hash_converter"
+require_relative "relaton_oasis/oasis_bibliography"
+require_relative "relaton_oasis/data_fetcher"
+require_relative "relaton_oasis/data_parser_utils"
+require_relative "relaton_oasis/data_parser"
+require_relative "relaton_oasis/data_part_parser"
+
+module RelatonOasis
+  class Error < StandardError; end
+  # Your code goes here...
+
+  # 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_oasis.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/relaton_oasis/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "relaton-oasis"
+  spec.version       = RelatonOasis::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonOasis: retrieve OASIS Standards for bibliographic use "\
+                       "using the BibliographicItem model"
+  spec.description   = "RelatonOasis: retrieve OASIS Standards for bibliographic use "\
+                       "using the BibliographicItem model"
+  spec.homepage      = "https://github.com/metanorma/relaton-oasis"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # 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"]
+
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "ruby-jing"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr", "~> 5.0.0"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "mechanize"
+  spec.add_dependency "relaton-bib", "~> 1.10.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: relaton-oasis
+version: !ruby/object:Gem::Version
+  version: 1.10.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-18 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: 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: rubocop-performance
+  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: rubocop-rails
+  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: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.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: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: 'RelatonOasis: retrieve OASIS Standards for bibliographic use using the
+  BibliographicItem model'
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- grammars/basicdoc.rng
+- grammars/biblio.rng
+- grammars/isodoc.rng
+- grammars/reqt.rng
+- lib/relaton_oasis.rb
+- lib/relaton_oasis/data_fetcher.rb
+- lib/relaton_oasis/data_parser.rb
+- lib/relaton_oasis/data_parser_utils.rb
+- lib/relaton_oasis/data_part_parser.rb
+- lib/relaton_oasis/hash_converter.rb
+- lib/relaton_oasis/oasis_bibliographic_item.rb
+- lib/relaton_oasis/oasis_bibliography.rb
+- lib/relaton_oasis/processor.rb
+- lib/relaton_oasis/version.rb
+- lib/relaton_oasis/xml_parser.rb
+- relaton_oasis.gemspec
+homepage: https://github.com/metanorma/relaton-oasis
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/relaton-oasis
+  source_code_uri: https://github.com/metanorma/relaton-oasis
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: 'RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem
+  model'
+test_files: []