relaton-w3c 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29e39d8865d85f66950a933d07c2606dae58d379635cd3abb62215c3110db90c
+  data.tar.gz: 1e170849762c44614f050a9faffa89b15d80b55e1c679d5aadcaf9449a5ec92e
+SHA512:
+  metadata.gz: 99c2c28235d23eb86ac7d365fe6cc57394bab3d7712985164bc395355665664dda8f976d93170aec7a2f06965f35aad8b70f5f47e2b783a70cbe1a6f13fcfc1c
+  data.tar.gz: 9376b168be74974acbbac842b0a4819ea9f03ae8c07c5ddb1dace03753a4e049b3e0cbb07cdf239b168831787106b7a511106335d20bb4789250b5d93590d55f

data/.github/workflows/macos.yml

@@ -0,0 +1,38 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,38 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,41 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Checkout submodules
+        shell: bash
+        run: |
+          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
+          git submodule sync --recursive
+          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle update
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
+.vscode/

data/.hound.yml

@@ -0,0 +1,2 @@
+rubocop:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.3
+Rails:
+  Enabled: true

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton_w3c.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,147 @@
+= RelatonW3c
+
+RelatonW3c is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+
+You can use it to retrieve metadata of W3C Standards from https://w3.org, and access such metadata through the `W3cBibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton_w3c'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install relaton_w3c
+
+== Usage
+
+=== Search for a standard using keywords
+
+----
+require 'relaton_w3c'
+
+hits = RelatonW3c::W3cBibliography.search("W3C JSON-LD 1.1")
+=> <RelatonW3c::HitCollection:0x007f93b5e4ff48 @ref=W3C JSON-LD 1.1 @fetched=false>
+
+item = hits[0].fetch
+=> #<RelatonW3c::W3cBibliographicItem:0x007f93a58a0670
+...
+----
+
+=== XML serialization
+
+----
+item.to_xml
+=> "<bibitem type="standard">
+        <fetched>2020-04-07</fetched>
+        <title type="main" format="text/plain" language="en" script="Latn">JSON-LD 1.1</title>
+        <title format="text/plain" language="en" script="Latn">A JSON-based Serialization for Linked Data</title>
+        <uri type="src">https://www.w3.org/TR/2020/CR-json-ld11-20200316/</uri>
+        <date type="published">
+            <on>2020</on>
+        </date>
+        ...
+    </bibitem>"
+----
+
+With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element.
+
+----
+item.to_xml bibdata: true
+=> "<bibdata type="standard">
+        <fetched>2020-04-07</fetched>
+        <title type="main" format="text/plain" language="en" script="Latn">JSON-LD 1.1</title>
+        <title format="text/plain" language="en" script="Latn">A JSON-based Serialization for Linked Data</title>
+        <uri type="src">https://www.w3.org/TR/2020/CR-json-ld11-20200316/</uri>
+        <date type="published">
+            <on>2020</on>
+        </date>
+        ...
+        <ext>
+            <doctype>candidateRecommendation</doctype>
+        </ext>
+    </bibdata>"
+----
+
+=== Get document by title
+----
+RelatonW3c::W3cBibliography.get "W3C JSON-LD 1.1"
+[relaton-w3c] ("W3C JSON-LD 1.1") fetching...
+[relaton-w3c] ("W3C JSON-LD 1.1") found JSON-LD 1.1
+=> #<RelatonW3c::W3cBibliographicItem:0x007f93b655bb48
+...
+----
+
+=== Get document by title and type
+----
+RelatonW3c::W3cBibliography.get "W3C Candidate Recommendation JSON-LD 1.1"
+[relaton-w3c] ("W3C Candidate Recommendation JSON-LD 1.1") fetching...
+[relaton-w3c] ("W3C Candidate Recommendation JSON-LD 1.1") found JSON-LD 1.1
+=> #<RelatonW3c::W3cBibliographicItem:0x007f9357199b90
+...
+----
+
+=== Get document by title and short type
+----
+RelatonW3c::W3cBibliography.get "W3C CR JSON-LD 1.1"
+[relaton-w3c] ("W3C CR JSON-LD 1.1") fetching...
+[relaton-w3c] ("W3C CR JSON-LD 1.1") found JSON-LD 1.1
+=> #<RelatonW3c::W3cBibliographicItem:0x007f93b6d37dd0
+...
+----
+
+=== Get document by title, type, and date
+----
+RelatonW3c::W3cBibliography.get "W3C WD JSON-LD 1.1 2019-10-18"
+[relaton-w3c] ("W3C WD JSON-LD 1.1 2019-10-18") fetching...
+[relaton-w3c] ("W3C WD JSON-LD 1.1 2019-10-18") found JSON-LD 1.1
+=> #<RelatonW3c::W3cBibliographicItem:0x007f9345a198b8
+...
+----
+
+=== Create bibliographic item from XML
+----
+RelatonW3c::XMLParser.from_xml File.read('spec/fixtures/cr_json_ld11.xml')
+=> #<RelatonW3c::W3cBibliographicItem:0x007f9381efce98
+...
+----
+
+=== Create bibliographic item from YAML
+----
+hash = YAML.load_file 'spec/fixtures/cr_json_ld11.yml'
+=> {"title"=>
+  [{"type"=>"main", "content"=>"JSON-LD 1.1", "language"=>"en", "script"=>"Latn", "format"=>"text/plain"},
+...
+
+bib_hash = RelatonW3c::HashConverter.hash_to_bib hash
+=> {:title=>
+  [{:type=>"main", :content=>"JSON-LD 1.1", :language=>"en", :script=>"Latn", :format=>"text/plain"},
+...
+
+RelatonW3c::W3cBibliographicItem.new bib_hash
+=> #<RelatonW3c::W3cBibliographicItem:0x007f9381ec6a00
+...
+----
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton_w3c.
+
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "relaton_w3c"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/relaton_w3c.rb

@@ -0,0 +1,22 @@
+require "relaton_bib"
+require "relaton_w3c/version"
+require "relaton_w3c/w3c_bibliography"
+require "relaton_w3c/w3c_bibliographic_item"
+require "relaton_w3c/hit_collection"
+require "relaton_w3c/hit"
+require "relaton_w3c/scrapper"
+require "relaton_w3c/xml_parser"
+require "relaton_w3c/hash_converter"
+
+module RelatonW3c
+  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/lib/relaton_w3c/hash_converter.rb

@@ -0,0 +1,4 @@
+module RelatonW3c
+  class HashConverter < RelatonBib::HashConverter
+  end
+end

data/lib/relaton_w3c/hit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RelatonW3c
+  # Hit.
+  class Hit < RelatonBib::Hit
+    #
+    # Parse page.
+    #
+    # @param lang [String, NilClass]
+    # @return [RelatonW3c::W3cBibliographicItem]
+    def fetch(_lang = nil)
+      @fetch ||= Scrapper.parse_page hit
+    end
+  end
+end

data/lib/relaton_w3c/hit_collection.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module RelatonW3c
+  # Page of hit collection.
+  class HitCollection < RelatonBib::HitCollection
+    TYPES = {
+      "CR" => "Candidate Recommendation",
+      "NOTE" => "Group Note",
+      "PER" => "Proposed Edited Recommendation",
+      "PR" => "Proposed Recommendation",
+      "REC" => "Recommendation",
+      "RET" => "Retired",
+      "WD" => "Working Draft",
+    }.freeze
+    DOMAIN = "https://www.w3.org"
+    DATADIR = File.expand_path(".relaton/w3c", Dir.home).freeze
+    DATAFILE = File.expand_path("bibliograhy.yml", DATADIR).freeze
+
+    # @param ref [String] reference to search
+    def initialize(ref)
+      %r{
+        ^(W3C\s)?
+        (?<type>(CR|NOTE|PER|PR|REC|RET|WD|Candidate\sRecommendation|
+          Group\sNote|Proposed\sEdited\sRecommendation|Proposed\sRecommendation|
+          Recommendation|Retired|Working\sDraft))? # type
+        \s?
+        (?<title_date>.+) # title_date
+      }x =~ ref
+      super
+      @array = from_yaml title_date, type
+    end
+
+    private
+
+    #
+    # Fetch data form yaml
+    #
+    # @param title_date [String]
+    # @param type [String]
+    # @return [Array<Hash>]
+    def from_yaml(title_date, type)
+      /(?<title>.+)\s(?<date>\d{4}-\d{2}-\d{2})$/ =~ title_date
+      title ||= title_date
+      result = data.select do |hit|
+        hit["title"] == title && type_date_filter(hit, type, date)
+      end
+      result.map { |h| Hit.new(h, self) }
+    end
+
+    # @param hit [Hash]
+    # @param type [String]
+    # @param date [String]
+    # @return [TrueClass, FalseClass]
+    def type_date_filter(hit, type, date)
+      if type && hit["type"] != short_type(type) || date && hit["date"] != date
+        history = get_history hit, type, date
+        return false unless history.any?
+
+        hit["type"] = short_type type
+        hit["datepub"] = history.first.at("td").text
+        hit["link"] = history.first.at("a")[:href]
+      end
+      true
+    end
+
+    # @param hit [Hash]
+    # @param type [String]
+    # @param date [String]
+    # @return [Array<Nokogiri::XML::Element>, Nokogiri::HTML::NodeSet]
+    def get_history(hit, type, date)
+      resp = Net::HTTP.get URI.parse(HitCollection::DOMAIN + hit["history"])
+      history_doc = Nokogiri::HTML resp
+      history = history_doc.xpath(
+        "//table//a[contains(.,'#{long_type(type)}')]/../..",
+      )
+      return filter_history_by_date(history, history_doc, type, date) if date
+
+      history
+    end
+
+    # @param history [Nokogiri::XML::NodeSet]
+    # @param history_doc [Nokogiri::HTML::NodeSet]
+    # @param type [String]
+    # @param date [String]
+    # @return [Array<Nokogiri::XML::Element>, Nokogiri::HTML::NodeSet]
+    def filter_history_by_date(history, history_doc, type, date)
+      if type
+        history.select do |h|
+          h.at("td[@class='table_datecol']").text == date
+        end
+      else
+        history_doc.xpath(
+          "//table//td[@class='table_datecol'][.='#{date}']/..",
+        )
+      end
+    end
+
+    #
+    # Convetr long type name to short
+    #
+    # @param type [String]
+    # @return [String]
+    def short_type(type)
+      tp = TYPES.select { |k,v| v == type }.keys
+      tp.first || type
+    end
+
+    #
+    # Convert shot type name to long
+    #
+    # @param [String]
+    # @return [String]
+    def long_type(type)
+      TYPES[type] || type
+    end
+
+    #
+    # Fetches YAML data
+    #
+    # @return [Hash]
+    def data
+      FileUtils.mkdir_p DATADIR
+      ctime = File.ctime DATAFILE if File.exist? DATAFILE
+      fetch_data if !ctime || ctime.to_date < Date.today
+      @data ||= YAML.safe_load File.read(DATAFILE, encoding: "UTF-8")
+    end
+
+    #
+    # fetch data form server and save it to file.
+    #
+    def fetch_data
+      resp = Net::HTTP.get_response URI.parse(DOMAIN + "/TR/")
+      # return if there aren't any changes since last fetching
+      return unless resp.code == "200"
+
+      doc = Nokogiri::HTML resp.body
+      @data = doc.xpath("//ul[@id='container']/li").map do |h_el|
+        link = h_el.at("h2/a")
+        pubdetails = h_el.at("p[@class='pubdetails']")
+        fetch_hit h_el, link, pubdetails
+      end
+      File.write DATAFILE, @data.to_yaml, encoding: "UTF-8"
+    end
+
+    # @param h_el [Nokogiri::XML::Element]
+    # @param link [Nokogiri::XML::Element]
+    # @param pubdetails [Nokogiri::XML::Element]
+    def fetch_hit(h_el, link, pubdetails)
+      datepub = pubdetails.at("text()").text.match(/\d{4}-\d{2}-\d{2}/).to_s
+      editor = h_el.xpath("ul[@class='editorlist']/li").map { |e| e.text.strip }
+      keyword = h_el.xpath("ul[@class='taglist']/li").map { |e| e.text.strip }
+      {
+        "title" => link.text.gsub("\u00a0", " "),
+        "link" => link[:href],
+        "type" => h_el.at("div").text.upcase,
+        "workgroup" => h_el.xpath("p[@class='deliverer']").map(&:text),
+        "datepub" => datepub,
+        "history" => pubdetails.at("a[text()='History']")[:href],
+        "editor" => editor,
+        "keyword" => keyword,
+      }
+    end
+  end
+end

data/lib/relaton_w3c/processor.rb

@@ -0,0 +1,41 @@
+require "relaton/processor"
+
+module RelatonW3c
+  class Processor < Relaton::Processor
+    attr_reader :idtype
+
+    def initialize
+      @short = :relaton_w3c
+      @prefix = "W3C"
+      @defaultprefix = %r{^W3C\s}
+      @idtype = "W3C"
+    end
+
+    # @param code [String]
+    # @param date [String, NilClass] year
+    # @param opts [Hash]
+    # @return [RelatonW3C::W3cBibliographicItem]
+    def get(code, date, opts)
+      ::RelatonW3c::W3cBibliography.get(code, date, opts)
+    end
+
+    # @param xml [String]
+    # @return [RelatonCalconnect::CcBibliographicItem]
+    def from_xml(xml)
+      ::RelatonW3c::XMLParser.from_xml xml
+    end
+
+    # @param hash [Hash]
+    # @return [RelatonIsoBib::CcBibliographicItem]
+    def hash_to_bib(hash)
+      item_hash = ::RelatonW3c::HashConverter.hash_to_bib(hash)
+      ::RelatonW3c::W3cBibliographicItem.new item_hash
+    end
+
+    # Returns hash of XML grammar
+    # @return [String]
+    def grammar_hash
+      @grammar_hash ||= ::RelatonW3c.grammar_hash
+    end
+  end
+end

data/lib/relaton_w3c/scrapper.rb

@@ -0,0 +1,183 @@
+module RelatonW3c
+  class Scrapper
+    class << self
+      DOCTYPES = {
+        "CR" => "candidateRecommendation",
+        "NOTE" => "groupNote",
+        "PER" => "proposedEditedRecommendation",
+        "PR" => "proposedRecommendation",
+        "REC" => "recommendation",
+        "RET" => "retired",
+        "WD" => "workingDraft",
+      }.freeze
+
+      # @param hit [Hash]
+      # @return [RelatonW3c::W3cBibliographicItem]
+      def parse_page(hit)
+        resp = Net::HTTP.get_response URI.parse(hit["link"])
+        doc = resp.code == "200" ? Nokogiri::HTML(resp.body) : nil
+        W3cBibliographicItem.new(
+          type: "standard",
+          fetched: Date.today.to_s,
+          language: ["en"],
+          script: ["Latn"],
+          title: fetch_title(hit, doc),
+          abstract: fetch_abstract(doc),
+          link: fetch_link(hit),
+          date: fetch_date(hit, doc),
+          doctype: fetch_doctype(hit, doc),
+          contributor: fetch_contributor(hit, doc),
+          relation: fetch_relation(doc),
+          keyword: hit["keyword"],
+        )
+      end
+
+      private
+
+      # @param hit [Hash]
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<RelatonBib::TypedTitleString>]
+      def fetch_title(hit, doc)
+        titles = []
+        if doc
+          title = doc.at("//h1[@id='title']").text
+          titles << { content: title, type: "main" }
+          subtitle = doc.at("//h2[@id='subtitle']").text
+          titles << { content: subtitle, tipe: "subtitle" }
+        else
+          titles << { content: hit["title"], type: "main" }
+        end
+        titles.map do |t|
+          title = RelatonBib::FormattedString.new(
+            content: t[:content], language: "en", script: "Latn",
+          )
+          RelatonBib::TypedTitleString.new(type: t[:type], title: title)
+        end
+      end
+
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [Array<RelatonBib::FormattedString>]
+      def fetch_abstract(doc)
+        return [] unless doc
+
+        content = doc.at("//h2[.='Abstract']/following-sibling::p").text
+        [RelatonBib::FormattedString.new(content: content, language: "en",
+                                         script: "Latn")]
+      end
+
+      # @param hit [Hash]
+      # @return [Array<RelatonBib::TypedUri>]
+      def fetch_link(hit)
+        [RelatonBib::TypedUri.new(type: "src", content: hit["link"])]
+      end
+
+      # @param hit [Hash]
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [Array<RelatonBib::BibliographicDate>]
+      def fetch_date(hit, doc)
+        on = hit["datepub"] || doc && doc.at("//h2/time[@datetime]")[:datetime]
+        [RelatonBib::BibliographicDate.new(type: "published", on: on)] if on
+      end
+
+      # @param hit [Hash]
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [String]
+      def fetch_doctype(hit, doc)
+        if hit["type"]
+          DOCTYPES[hit["type"]]
+        elsif doc
+          type = HitCollection::TYPES.detect do |_k, v|
+            doc.at("//h2[contains(., '#{v}')]/time[@datetime]")
+          end
+          DOCTYPES[type&.first]
+        end
+      end
+
+      # @param hit [Hash]
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [Array<RelatonBib::ContributionInfo>]
+      def fetch_contributor(hit, doc)
+        if doc
+          editors = find_contribs(doc, "Editors").map do |ed|
+            parse_contrib ed, "editor"
+          end
+          contribs = find_contribs(doc, "Authors").reduce(editors) do |mem, athr|
+            ed = mem.detect { |e| e[:id] && e[:id] == athr["data-editor-id"] }
+            if ed
+              ed[:role] << { type: "author" }
+            else
+              mem << parse_contrib(athr, "author")
+            end
+            mem
+          end
+          contribs.map { |c| contrib_info c }
+        else
+          hit["editor"].map do |ed|
+            contrib_info name: ed, role: [{ type: "editor" }]
+          end
+        end
+      end
+
+      # @param doc [Nokogiri::NTML::Document]
+      # @param type [String]
+      # @return [Array<Nokogiri::XML::Element]
+      def find_contribs(doc, type)
+        doc.xpath("//dt[contains(.,'#{type}')]/following-sibling::dd"\
+                  "[preceding-sibling::dt[1][contains(.,'#{type}')]]")
+      end
+
+      # @param element [Nokogiri::XML::Element]
+      # @param type [String]
+      # @return [Hash]
+      def parse_contrib(element, type)
+        p = element.at("a")
+        contrib = {
+          name: p.text,
+          url: p[:href],
+          role: [{ type: type }],
+          id: element["data-editor-id"],
+        }
+        org = element.at("a[2]")
+        contrib[:org] = { name: org.text, url: org[:href] } if org
+        contrib
+      end
+
+      # @param name [String]
+      # @param url [String, NilClass]
+      # @param role [Array<Hash>]
+      # @parma org [Hash]
+      # @return [RelatonBib::ContributionInfo]
+      def contrib_info(**args)
+        completename = RelatonBib::LocalizedString.new(args[:name])
+        name = RelatonBib::FullName.new completename: completename
+        af = []
+        if args[:org]
+          org = RelatonBib::Organization.new args[:org]
+          af << RelatonBib::Affiliation.new(organization: org)
+        end
+        en = RelatonBib::Person.new name: name, url: args[:url], affiliation: af
+        RelatonBib::ContributionInfo.new entity: en, role: args[:role]
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [Array<RelatonBib::DocumentRelation>]
+      def fetch_relation(doc)
+        return [] unless doc && (link = recommendation_link(doc))
+
+        hit = { "link" => link }
+        item = parse_page hit
+        [RelatonBib::DocumentRelation.new(type: "obsoleted", bibitem: item)]
+      end
+
+      # @param doc [Nokogiri::HTML::Document]
+      # @return [String, NilClass]
+      def recommendation_link(doc)
+        recom = doc.at("//dt[.='Latest Recommendation:']",
+                       "//dt[.='Previous Recommendation:']")
+        return unless recom
+
+        recom.at("./following-sibling::dd/a")[:href]
+      end
+    end
+  end
+end

data/lib/relaton_w3c/version.rb

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

data/lib/relaton_w3c/w3c_bibliographic_item.rb

@@ -0,0 +1,39 @@
+module RelatonW3c
+  class W3cBibliographicItem < RelatonBib::BibliographicItem
+    TYPES = %w[
+      candidateRecommendation groupNote proposedEditedRecommendation
+      proposedRecommendation recommendation retired workingDraft
+    ].freeze
+
+    attr_reader :doctype
+
+    # @param doctype [String]
+    def initialize(**args)
+      if args[:doctype] && !TYPES.include?(args[:doctype])
+        warn "[relaton-w3c] invalid document type: #{args[:doctype]}"
+      end
+      @doctype = args.delete :doctype
+      super **args
+    end
+
+    # @param builder [Nokogiri::XML::Builder, NilClass]
+    # @param opts [Hash]
+    # @option opts [TrueClass, FalseClass, NilClass] bibdata
+    def to_xml(builder = nil, **opts)
+      super builder, **opts do |b|
+        if opts[:bibdata] && doctype
+          b.ext do |e|
+            e.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_w3c/w3c_bibliography.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RelatonW3c
+  # Class methods for search W3C standards.
+  class W3cBibliography
+    class << self
+      # @param text [String]
+      # @return [RelatonW3c::HitCollection]
+      def search(text)
+        HitCollection.new text
+      rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+             EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+             Net::ProtocolError, OpenSSL::SSL::SSLError, Errno::ETIMEDOUT
+        raise RelatonBib::RequestError,
+              "Could not access #{HitCollection::DOMAIN}"
+      end
+
+      # @param ref [String] the W3C standard Code to look up
+      # @param year [String, NilClass] not used
+      # @param opts [Hash] options
+      # @return [RelatonW3c::W3cBibliographicItem]
+      def get(ref, _year = nil, _opts = {})
+        warn "[relaton-w3c] (\"#{ref}\") fetching..."
+        result = search(ref)
+        return unless result.any?
+
+        ret = result.first.fetch
+        warn "[relaton-w3c] (\"#{ref}\") found #{ret.title.first.title.content}"
+        ret
+      end
+    end
+  end
+end

data/lib/relaton_w3c/xml_parser.rb

@@ -0,0 +1,32 @@
+module RelatonW3c
+  class XMLParser < RelatonBib::XMLParser
+    class << self
+      # @param xml [String]
+      # @return [RelatonW3c::W3cBibliographicItem, NilClass]
+      def from_xml(xml)
+        doc = Nokogiri::XML xml
+        doc.remove_namespaces!
+        item = doc.at("/bibitem|/bibdata")
+        if item
+          W3cBibliographicItem.new(item_data(item))
+        else
+          warn "[relaton-w3c] can't find bibitem or bibdata element in the XML"
+        end
+      end
+
+      private
+
+      # Override RelatonBib::XMLParser.item_data method.
+      # @param item [Nokogiri::XML::Element]
+      # @returtn [Hash]
+      def item_data(item)
+        data = super
+        ext = item.at "./ext"
+        return data unless ext
+
+        data[:doctype] = ext.at("./doctype")&.text
+        data
+      end
+    end
+  end
+end

data/relaton_w3c.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "relaton_w3c/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "relaton-w3c"
+  spec.version       = RelatonW3c::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "RelatonIso: retrieve W3C Standards for bibliographic "\
+                       "use using the IsoBibliographicItem model"
+  spec.description   = "RelatonIso: retrieve W3C Standards for bibliographic "\
+                       "use using the IsoBibliographicItem model"
+  spec.homepage      = "https://github.com/relaton/relaton-wc3"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://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{^(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 "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.9.2"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: relaton-w3c
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-07 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: 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.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: 'RelatonIso: retrieve W3C Standards for bibliographic use using 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"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/relaton_w3c.rb
+- lib/relaton_w3c/hash_converter.rb
+- lib/relaton_w3c/hit.rb
+- lib/relaton_w3c/hit_collection.rb
+- lib/relaton_w3c/processor.rb
+- lib/relaton_w3c/scrapper.rb
+- lib/relaton_w3c/version.rb
+- lib/relaton_w3c/w3c_bibliographic_item.rb
+- lib/relaton_w3c/w3c_bibliography.rb
+- lib/relaton_w3c/xml_parser.rb
+- relaton_w3c.gemspec
+homepage: https://github.com/relaton/relaton-wc3
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/relaton/relaton-wc3
+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: 'RelatonIso: retrieve W3C Standards for bibliographic use using the IsoBibliographicItem
+  model'
+test_files: []