relaton-w3c 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd2bd393c6f3a1073dd4cd4f87cae650480dbfdcc1547de6e65b75827bf4c32a
-  data.tar.gz: 4c50438e1a8bbfab465d3919f052ee0aca35078e30a7cb0062b77d5f4610a1a2
+  metadata.gz: b926b01fe435fae1a7362c382eb9a6cd142cd05473356055cd412cf9a3cb28ec
+  data.tar.gz: 8733bb55355b3dd269e634aeba684c1246fabb21e191dff0120c40d842b23f36
 SHA512:
-  metadata.gz: efecf91aece9898474823bd4f5725a0aeec965c27e1de6da6e50eb6a4b4d6c5219efefa20d4d05d5ce97af1058448377a1dfcefe6fd84b08a372d1eaf186bb2b
-  data.tar.gz: d5bcb404c04bb5d23e75ddbda7ef2936772b27b324f399bf0759b44f76c352fe505a6685a3e1a956f18fc9332855db7b347e6a51a4ed5a55df29472689f8c0c5
+  metadata.gz: 40317cab07cd4eb66e8ce13248c14850f39e2c1a3a120830eca93277cbb7183ee7c798ef0d38c42ffcfee19b6032e13c63f8add264aef4c24815ac73ee32c7c6
+  data.tar.gz: 0400a3321875de097a3c8de4733e79f86d8909a93c9de657eacf32709fb289f4e68964a69b700927dc61fccc814506f4781e494f552e2c2248bcf6636d5a592c

data/.github/workflows/ubuntu.yml

@@ -35,4 +35,5 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |
+          unset JAVA_TOOL_OPTIONS
           bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
-  Enabled: true
+  Enabled: false

data/README.adoc

@@ -10,7 +10,7 @@ Add this line to your application's Gemfile:
 
 [source,ruby]
 ----
-gem 'relaton_w3c'
+gem 'relaton-w3c'
 ----
 
 And then execute:
@@ -19,14 +19,16 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install relaton_w3c
+    $ gem install relaton-w3c
 
 == Usage
 
 === Search for a standard using keywords
 
+[source,ruby]
 ----
 require 'relaton_w3c'
+=> true
 
 hits = RelatonW3c::W3cBibliography.search("W3C JSON-LD 1.1")
 => <RelatonW3c::HitCollection:0x007f93b5e4ff48 @ref=W3C JSON-LD 1.1 @fetched=false>
@@ -38,40 +40,43 @@ item = hits[0].fetch
 
 === XML serialization
 
+[source,ruby]
 ----
 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 id="CR-json-ld11-20200316" 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.
 
+[source,ruby]
 ----
 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>
+      <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
+[source,ruby]
 ----
 RelatonW3c::W3cBibliography.get "W3C JSON-LD 1.1"
 [relaton-w3c] ("W3C JSON-LD 1.1") fetching...
@@ -81,6 +86,7 @@ RelatonW3c::W3cBibliography.get "W3C JSON-LD 1.1"
 ----
 
 === Get document by title and type
+[source,ruby]
 ----
 RelatonW3c::W3cBibliography.get "W3C Candidate Recommendation JSON-LD 1.1"
 [relaton-w3c] ("W3C Candidate Recommendation JSON-LD 1.1") fetching...
@@ -90,6 +96,7 @@ RelatonW3c::W3cBibliography.get "W3C Candidate Recommendation JSON-LD 1.1"
 ----
 
 === Get document by title and short type
+[source,ruby]
 ----
 RelatonW3c::W3cBibliography.get "W3C CR JSON-LD 1.1"
 [relaton-w3c] ("W3C CR JSON-LD 1.1") fetching...
@@ -99,6 +106,7 @@ RelatonW3c::W3cBibliography.get "W3C CR JSON-LD 1.1"
 ----
 
 === Get document by title, type, and date
+[source,ruby]
 ----
 RelatonW3c::W3cBibliography.get "W3C WD JSON-LD 1.1 2019-10-18"
 [relaton-w3c] ("W3C WD JSON-LD 1.1 2019-10-18") fetching...
@@ -108,6 +116,7 @@ RelatonW3c::W3cBibliography.get "W3C WD JSON-LD 1.1 2019-10-18"
 ----
 
 === Create bibliographic item from XML
+[source,ruby]
 ----
 RelatonW3c::XMLParser.from_xml File.read('spec/fixtures/cr_json_ld11.xml')
 => #<RelatonW3c::W3cBibliographicItem:0x007f9381efce98
@@ -115,6 +124,7 @@ RelatonW3c::XMLParser.from_xml File.read('spec/fixtures/cr_json_ld11.xml')
 ----
 
 === Create bibliographic item from YAML
+[source,ruby]
 ----
 hash = YAML.load_file 'spec/fixtures/cr_json_ld11.yml'
 => {"title"=>

data/lib/relaton_w3c/hit_collection.rb

@@ -45,7 +45,12 @@ module RelatonW3c
       /(?<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)
+        (hit["title"].casecmp?(title) ||
+          hit["link"].split("/").last.match?(/-#{title}-/)) &&
+          type_date_filter(hit, type, date)
+      end
+      if result.empty?
+        result = data.select { |h| h["link"].split("/").last.match? /#{title}/ }
       end
       result.map { |h| Hit.new(h, self) }
     end
@@ -54,7 +59,7 @@ module RelatonW3c
     # @param type [String]
     # @param date [String]
     # @return [TrueClass, FalseClass]
-    def type_date_filter(hit, type, date)
+    def type_date_filter(hit, type, date) # rubocop:disable Metrics/AbcSize
       if type && hit["type"] != short_type(type) || date && hit["date"] != date
         history = get_history hit, type, date
         return false unless history.any?

data/lib/relaton_w3c/scrapper.rb

@@ -13,11 +13,12 @@ module RelatonW3c
 
       # @param hit [Hash]
       # @return [RelatonW3c::W3cBibliographicItem]
-      def parse_page(hit)
+      def parse_page(hit) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         resp = Net::HTTP.get_response URI.parse(hit["link"])
         doc = resp.code == "200" ? Nokogiri::HTML(resp.body) : nil
         W3cBibliographicItem.new(
           type: "standard",
+          docid: fetch_docid(hit),
           fetched: Date.today.to_s,
           language: ["en"],
           script: ["Latn"],
@@ -28,28 +29,38 @@ module RelatonW3c
           doctype: fetch_doctype(hit, doc),
           contributor: fetch_contributor(hit, doc),
           relation: fetch_relation(doc),
-          keyword: hit["keyword"],
+          keyword: hit["keyword"]
         )
       end
 
       private
 
+      # @param hit [Hash]
+      # @return [Array<RelatonBib::DocumentIdentifier>]
+      def fetch_docid(hit)
+        id = hit["link"].split("/").last
+        [RelatonBib::DocumentIdentifier.new(id: id, type: "W3C")]
+      end
+
       # @param hit [Hash]
       # @param doc [Nokogiri::HTML::Document]
       # @return [Array<RelatonBib::TypedTitleString>]
-      def fetch_title(hit, doc)
+      def fetch_title(hit, doc) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         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" }
-        elsif hit["title"]
+          title = doc.at("//*[contains(@id, 'title')]")&.text
+          titles << { content: title, type: "main" } if title && !title.empty?
+          subtitle = doc.at(
+            "//h2[@id='subtitle']|//p[contains(@class, 'subline')]"
+          )&.text
+          titles << { content: subtitle, tipe: "subtitle" } if subtitle
+        end
+        if titles.empty? && hit["title"]
           titles << { content: hit["title"], type: "main" }
         end
         titles.map do |t|
           title = RelatonBib::FormattedString.new(
-            content: t[:content], language: "en", script: "Latn",
+            content: t[:content], language: "en", script: "Latn"
           )
           RelatonBib::TypedTitleString.new(type: t[:type], title: title)
         end
@@ -75,10 +86,27 @@ module RelatonW3c
       # @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]
+        on = hit["datepub"] || doc&.at("//h2/time[@datetime]")&.attr(:datetime)
+        on ||= fetch_date1(doc) || fetch_date2(doc)
         [RelatonBib::BibliographicDate.new(type: "published", on: on)] if on
       end
 
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [String]
+      def fetch_date1(doc)
+        d = doc&.at("//h2[@property='dc:issued']")&.attr(:content)
+        d&.match(/\d{4}-\d{2}-\d{2}/)&.to_s
+      end
+
+      # @param doc [Nokogiri::HTML::Document, NilClass]
+      # @return [String]
+      def fetch_date2(doc)
+        d = doc&.at("//h2[contains(@id, 'w3c-recommendation')]")
+        return unless d
+
+        Date.parse(d.attr(:id.match(/\d{2}-\w+-\d{4}/).to_s)).to_s
+      end
+
       # @param hit [Hash]
       # @param doc [Nokogiri::HTML::Document, NilClass]
       # @return [String]
@@ -96,17 +124,19 @@ module RelatonW3c
       # @param hit [Hash]
       # @param doc [Nokogiri::HTML::Document, NilClass]
       # @return [Array<RelatonBib::ContributionInfo>]
-      def fetch_contributor(hit, doc)
+      def fetch_contributor(hit, doc) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
         if doc
-          editors = find_contribs(doc, "Editors").map do |ed|
-            parse_contrib ed, "editor"
+          editors = find_contribs(doc, "Editors").reduce([]) do |mem, ed|
+            c = parse_contrib ed, "editor"
+            mem << c if c
+            mem
           end
-          contribs = find_contribs(doc, "Authors").reduce(editors) do |mem, athr|
-            ed = mem.detect { |e| e[:id] && e[:id] == athr["data-editor-id"] }
+          contribs = find_contribs(doc, "Authors").reduce(editors) do |mem, ath|
+            ed = mem.detect { |e| e[:id] && e[:id] == ath["data-editor-id"] }
             if ed
               ed[:role] << { type: "author" }
             else
-              mem << parse_contrib(athr, "author")
+              mem << parse_contrib(ath, "author")
             end
             mem
           end
@@ -131,6 +161,8 @@ module RelatonW3c
       # @return [Hash]
       def parse_contrib(element, type)
         p = element.at("a")
+        return unless p
+
         contrib = {
           name: p.text,
           url: p[:href],

data/lib/relaton_w3c/version.rb

@@ -1,3 +1,3 @@
 module RelatonW3c
-  VERSION = "1.2.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/lib/relaton_w3c/w3c_bibliographic_item.rb

@@ -5,35 +5,12 @@ module RelatonW3c
       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
       super **args
-      # @doctype = args[:doctype]
-    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/relaton_w3c.gemspec

@@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", ">= 1.2.0"
+  spec.add_dependency "relaton-bib", ">= 1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-w3c
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.0
 description: 'RelatonIso: retrieve W3C Standards for bibliographic using the IsoBibliographicItem
   model'
 email:
@@ -162,7 +162,7 @@ licenses:
 - BSD-2-Clause
 metadata:
   homepage_uri: https://github.com/relaton/relaton-wc3
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonIso: retrieve W3C Standards for bibliographic using the IsoBibliographicItem
   model'