relaton-iec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e177f80a42aba2a914d20cf5ff1318bbb5799ef
+  data.tar.gz: 0421c70701e9b18c34efb723f1880841ffb8fa2b
+SHA512:
+  metadata.gz: 481e8b07607ad1846c7e935dd61274e60d16483b8d3113f0b474edad1fea26c2cfe25ff2dc8d63f07dd1a2ad43235cfd7bb89f5a5da4d1ee143a4d68124f112b
+  data.tar.gz: d34a555b072f86d185a2fee197e50e6286fae7083ca88da39c091508efca53ac2f9487473b41d469838d0906997f5b8fa2572e768da2551e0bf7deb20d98b10e

data/.gitignore

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

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/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+os:
+- linux
+- osx
+rvm:
+- 2.5
+- 2.4
+- 2.3
+- ruby-head
+before_install: 
+- gem install bundler -v 2.0.1
+- bundle update
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in relaton_iec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    relaton-iec (0.1.0)
+      addressable
+      relaton-iso-bib (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    debase (0.2.2)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    hashdiff (0.3.8)
+    isoics (0.1.7)
+    json (2.1.0)
+    method_source (0.9.2)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.1.0)
+    rake (10.5.0)
+    relaton-bib (0.1.6)
+      addressable
+      nokogiri (~> 1.8.4)
+    relaton-iso-bib (0.1.0)
+      isoics (~> 0.1.6)
+      nokogiri (~> 1.8.4)
+      relaton-bib (~> 0.1.5)
+      ruby_deep_clone (~> 0.8.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby-debug-ide (0.6.1)
+      rake (>= 0.8.1)
+    ruby_deep_clone (0.8.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.1)
+  debase
+  equivalent-xml (~> 0.6)
+  pry-byebug
+  rake (~> 10.0)
+  relaton-iec!
+  rspec (~> 3.0)
+  ruby-debug-ide
+  simplecov
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,52 @@
+= RelatonIec: retrieve IEC Standards for bibliographic use using the BibliographicItem model
+
+image:https://img.shields.io/gem/v/relaton_iec.svg["Gem Version", link="https://rubygems.org/gems/relaton_iec"]
+image:https://img.shields.io/travis/metanorma/relaton_iec/master.svg["Build Status", link="https://travis-ci.com/metanorma/relaton_iec"]
+image:https://ci.appveyor.com/api/projects/status/ewepoefhla5h76p7?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/relaton_iec"]
+image:https://codeclimate.com/github/metanorma/relaton_iec/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton_iec"]
+
+RelatonIec 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 IEC Standards from https://www.iec.ch, and access such metadata through the `IsoBibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton_iec'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relaton_iec
+
+== Usage
+
+Refer to https://github.com/metanorma/relaton-iso/blob/master/README.adoc: the usage interface is identical.
+
+== 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).
+
+
+== Exceptional Citations
+
+This gem retrieves bibliographic descriptions of ISO documents by doing searches on the ISO website, http://www.iso.org, and screenscraping the document that matches the queried document identifier. The following documents are not returned as search results from the ISO website, and the gem returns manually generated references to them.
+
+* `IEV`: used in the metanorma-iso gem to reference Electropedia entries generically. Is resolved to an "all parts" reference to IEC 60050, which in turn is resolved into the specific documents cited by their top-level clause.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-iec.
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].

data/Rakefile

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

data/appveyor.yml

@@ -0,0 +1,30 @@
+version: '{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 24
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: _trunk
+
+matrix:
+  allow_failures:
+    - RUBY_VERSION: _trunk
+
+install:
+  - ps: . { iwr -useb https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/appveyor.ps1 } | iex
+  - refreshenv
+
+build_script:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle update
+  - bundle install
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "relaton_iec"
+
+# 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/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/processor.rb

@@ -0,0 +1,23 @@
+require "relaton/processor"
+
+module Relaton
+  module RelatonIec
+    class Processor < Relaton::Processor
+
+      def initialize
+        @short = :relaton_iec
+        @prefix = "IEC"
+        @defaultprefix = %r{^(IEC)[ /]|^IEV($| )}
+        @idtype = "IEC"
+      end
+
+      def get(code, date, opts)
+        ::RelatonIec::IecBibliography.get(code, date, opts)
+      end
+
+      def from_xml(xml)
+        RelatonIsoBib::XMLParser.from_xml xml
+      end
+    end
+  end
+end

data/lib/relaton_iec.rb

@@ -0,0 +1,10 @@
+require "relaton_iec/version"
+require "relaton_iec/iec_bibliography"
+if defined? Relaton
+  require_relative "relaton/processor"
+  Relaton::Registry.instance.register(Relaton::RelatonIec::Processor)
+end
+
+module RelatonIec
+  # Your code goes here...
+end

data/lib/relaton_iec/hit.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RelatonIec
+  # Hit.
+  class Hit
+    # @return [Isobib::HitCollection]
+    attr_reader :hit_collection
+
+    # @return [Array<Hash>]
+    attr_reader :hit
+
+    # @param hit [Hash]
+    # @param hit_collection [Isobib:HitCollection]
+    def initialize(hit, hit_collection = nil)
+      @hit            = hit
+      @hit_collection = hit_collection
+    end
+
+    # Parse page.
+    # @return [Isobib::IsoBibliographicItem]
+    def fetch
+      @fetch ||= Scrapper.parse_page @hit
+    end
+
+    # @return [String]
+    def to_s
+      inspect
+    end
+
+    # @return [String]
+    def inspect
+      "<#{self.class}:#{format('%#.14x', object_id << 1)} "\
+      "@text=\"#{@hit_collection&.text}\" "\
+      "@fetched=\"#{!@fetch.nil?}\" "\
+      "@fullIdentifier=\"#{@fetch&.shortref(nil)}\" "\
+      "@title=\"#{@hit[:code]}\">"
+    end
+
+    # @return [String]
+    def to_xml(opts = {})
+      #if builder
+        #fetch.to_xml builder, opts
+      #else
+        builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          fetch.to_xml xml, opts
+        end
+        builder.doc.root.to_xml
+      #end
+    end
+  end
+end

data/lib/relaton_iec/hit_collection.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "relaton_iec/hit"
+require "addressable/uri"
+
+module RelatonIec
+  # Page of hit collection.
+  class HitCollection < Array
+
+    DOMAIN = "https://webstore.iec.ch"
+
+    # @return [TrueClass, FalseClass]
+    attr_reader :fetched
+
+    # @return [String]
+    attr_reader :text
+
+    # @return [String]
+    attr_reader :year
+
+    # @param ref_nbr [String]
+    # @param year [String]
+    def initialize(ref_nbr, year = nil) #(text, hit_pages = nil)
+      @text = ref_nbr
+      @year = year
+      from, to = nil
+      if year
+        from = Date.strptime year, "%Y"
+        to   = from.next_year.prev_day
+      end
+      url  = "#{DOMAIN}/searchkey&RefNbr=#{ref_nbr}&From=#{from}&To=#{to}&start=1"
+      doc  = Nokogiri::HTML OpenURI.open_uri(::Addressable::URI.parse(url).normalize)
+      hits = doc.css("ul.search-results > li").map do |h|
+        link  = h.at('a[@href!="#"]')
+        code  = link.text.tr [194, 160].pack("c*").force_encoding("UTF-8"), ""
+        title = h.xpath("text()").text.gsub(/[\r\n]/, "")
+        url   = DOMAIN + link[:href]
+        Hit.new({ code: code, title: title, url: url }, self)
+      end
+      concat hits
+      # concat(hits.map { |h| Hit.new(h, self) })
+      @fetched = false
+      # @hit_pages = hit_pages
+    end
+
+    # @return [RelatonIec::HitCollection]
+    def fetch
+      workers = RelatonBib::WorkersPool.new 4
+      workers.worker(&:fetch)
+      each do |hit|
+        workers << hit
+      end
+      workers.end
+      workers.result
+      @fetched = true
+      self
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      "<#{self.class}:#{format('%#.14x', object_id << 1)} @fetched=#{@fetched}>"
+    end
+  end
+end