relaton-ecma 1.7.pre1

data/grammars/reqt.rng

@@ -0,0 +1,165 @@
+<?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="subsequence"/>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </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">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </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="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>
+    <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_ecma.rb

@@ -0,0 +1,17 @@
+require "nokogiri"
+require "open-uri"
+require "relaton_bib"
+require "relaton_ecma/version"
+require "relaton_ecma/scrapper"
+require "relaton_ecma/ecma_bibliography"
+
+module RelatonEcma
+  # 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/lib/relaton_ecma/ecma_bibliography.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal:true
+
+module RelatonEcma
+  # IETF bibliography module
+  module EcmaBibliography
+    class << self
+      # @param code [String] the ECMA standard Code to look up (e..g "ECMA-6")
+      # @return [RelatonBib::BibliographicEcma]
+      def search(code)
+        Scrapper.scrape_page code
+      end
+
+      # @param code [String] the ECMA standard Code to look up (e..g "ECMA-6")
+      # @param year [String] not used
+      # @param opts [Hash] not used
+      # @return [RelatonBib::BibliographicItem] Relaton of reference
+      def get(code, _year = nil, _opts = {})
+        warn "[relaton-ecma] (\"#{code}\") fetching..."
+        result = search code
+        if result
+          warn "[relaton-ecma] (\"#{code}\") found #{result.docidentifier.first.id}"
+        else
+          warn "[relaton-ecma] WARNING no match found online for #{code}. "\
+          "The code must be exactly like it is on the standards website."
+        end
+        result
+      end
+    end
+  end
+end

data/lib/relaton_ecma/processor.rb

@@ -0,0 +1,39 @@
+require "relaton/processor"
+
+module RelatonEcma
+  class Processor < Relaton::Processor
+    def initialize
+      @short = :relaton_ecma
+      @prefix = "ECMA"
+      @defaultprefix = /^ECMA(-|\s)/
+      @idtype = "ECMA"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def get(code, date, opts)
+      ::RelatonEcma::EcmaBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonBib::BibliographicItem]
+    def from_xml(xml)
+      ::RelatonBib::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonBib::BibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonBib::HashConverter.hash_to_bib(hash)
+      ::RelatonBib::BibliographicItem.new item_hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonEcma.grammar_hash
+    end
+  end
+end

data/lib/relaton_ecma/scrapper.rb

@@ -0,0 +1,99 @@
+module RelatonEcma
+  module Scrapper
+    ENDPOINT = "https://www.ecma-international.org/publications/standards/".freeze
+
+    class << self
+      # @param code [String]
+      # @return [RelatonBib::BibliographicItem]
+      def scrape_page(code) # rubocop:disable Metrics/AbcSize
+        num = /\d+$/.match(code).to_s.rjust 3, "0"
+        url = ENDPOINT + code.capitalize.sub(/\d+$/, num) + ".htm"
+        doc = Nokogiri::HTML OpenURI.open_uri url
+        parse_page doc, code, url
+      rescue OpenURI::HTTPError => e
+        return if e.io.status.first == "404"
+
+        raise RelatonBib::RequestError, "No document found for #{code} reference. #{e.message}"
+      end
+
+      private
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @param code [String]
+      # @param url [String]
+      # @retrurn [RelatonBib::BibliographicItem]
+      def parse_page(doc, code, url)
+        RelatonBib::BibliographicItem.new(
+          type: "standard", docid: fetch_docid(code), language: ["en"], script: ["Latn"],
+          link: fetch_link(doc, url), title: fetch_title(doc), abstract: fetch_abstract(doc),
+          date: fetch_date(doc), relation: fetch_relation(doc), place: ["Geneva"],
+          edition: fetch_edition(doc), doctype: "document"
+        )
+      end
+
+      # @param code [String]
+      # @return [Array<RelatonBib::DocumentIdentifier>]
+      def fetch_docid(code)
+        [RelatonBib::DocumentIdentifier.new(type: "ECMA", id: code)]
+      end
+
+      # @param doc [Nokogiri::HTM::Document]
+      # @param url [String]
+      # @return [Array<RelatonBib::TypedUri>]
+      def fetch_link(doc, url)
+        link = [RelatonBib::TypedUri.new(type: "src", content: url)]
+        ref = doc.at('//tr[@class="STbody"]/td/a')
+        link << RelatonBib::TypedUri.new(type: "doi", content: ref[:href]) if ref
+        link
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<Hash>]
+      def fetch_title(doc)
+        doc.xpath('//span[@class="STsubtitle"]').map do |t|
+          { content: t.text.strip, language: "en", script: "Latn" }
+        end
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<RelatonBib::FormattedString>]
+      def fetch_abstract(doc)
+        a = doc.xpath('//p[@class="STdescription"]').map do |a|
+          a.text.strip.squeeze(" ").gsub /\r\n/, ""
+        end.join "\n"
+        return [] if a.empty?
+
+        [RelatonBib::FormattedString.new(content: a, language: "en", script: "Latn")]
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<RelatonBib::BibliographicDate>]
+      def fetch_date(doc)
+        doc.xpath('//span[@class="STedition"]').map do |d|
+          date = d.text.match(/(?<=\()\w+\s\d{4}(?=\))/).to_s
+          RelatonBib::BibliographicDate.new type: "published", on: date
+        end
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [String]
+      def fetch_edition(doc)
+        doc.at('//span[@class="STedition"]')&.text&.strip&.match(/^\d+(?=th)/)&.to_s
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<Hash>]
+      def fetch_relation(doc)
+        history = doc.at "//p[contains(., 'historical')]/a"
+        return [] unless history
+
+        rel_doc = Nokogiri::HTML OpenURI.open_uri(ENDPOINT + history[:href])
+        rel_doc.xpath("//tr[@class='STbody']/td[1]/*").map do |rel|
+          fref = RelatonBib::FormattedRef.new content: rel.text, language: "en", script: "Latn"
+          bibitem = RelatonBib::BibliographicItem.new formattedref: fref
+          { type: "updates", bibitem: bibitem }
+        end
+      end
+    end
+  end
+end

data/lib/relaton_ecma/version.rb

@@ -0,0 +1,3 @@
+module RelatonEcma
+  VERSION = "1.7.pre1".freeze
+end

data/relaton_ecma.gemspec

@@ -0,0 +1,41 @@
+require_relative "lib/relaton_ecma/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "relaton-ecma"
+  spec.version       = RelatonEcma::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonIetf: retrieve ECMA Standards for bibliographic use "\
+                       "using the BibliographicItem model"
+  spec.description   = <<~DESCRIPTION
+    RelatonEcma: retrieve ECMA Standards for bibliographic use 
+    using the BibliographicItem model.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/metanorma/relaton-ecma"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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{^(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 "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", "~> 1.7.0"
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: relaton-ecma
+version: !ruby/object:Gem::Version
+  version: 1.7.pre1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !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: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: "RelatonEcma: retrieve ECMA Standards for bibliographic use \nusing the
+  BibliographicItem model.\n"
+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/basicdoc.rng
+- grammars/biblio.rng
+- grammars/isodoc.rng
+- grammars/reqt.rng
+- lib/relaton_ecma.rb
+- lib/relaton_ecma/ecma_bibliography.rb
+- lib/relaton_ecma/processor.rb
+- lib/relaton_ecma/scrapper.rb
+- lib/relaton_ecma/version.rb
+- relaton_ecma.gemspec
+homepage: https://github.com/metanorma/relaton-ecma
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/relaton-ecma
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: 'RelatonIetf: retrieve ECMA Standards for bibliographic use using the BibliographicItem
+  model'
+test_files: []