relaton-cli 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d4d41d778eecd0614bc7d9f086db2362d594725
-  data.tar.gz: 5a66a9da159d1c903c35764727e0755e52511919
+  metadata.gz: 5ed0978daca08db19cf521cb107ae61dd8813e83
+  data.tar.gz: 75351c878a675899a2940445f2bcbdc3a0f6c0c4
 SHA512:
-  metadata.gz: 429b613fd45f18bf24a5af73b01c4091dcfbb93e820af393af1b58c338e99a69f34a22adc6ac2a282e250ccf54827eb2fdb02ba5b759be34cc7a2c18fc4f2f21
-  data.tar.gz: affff06b90bfcd54bc299aedacf129cbf1e12181146fedda6300d6890b12fc7b05ee31492a8b68475da8de09410d55e43b413a8e0c0b46a82469b33bd834a447
+  metadata.gz: 1e3aa4062f36e4efa669168efd8d61d19cd3ea0b353829792db1773d86c40d7e78103758c03b726449095d92cf90b8a6dc48b12acb6e40de5686ed56ccc43c48
+  data.tar.gz: 81792ae0b803346660ea2f3cc1ccbea871b2223fdc32d13b864238b2f94e3dcc8c63a2a9d0df1ed9a34bd0191c63871af573806bc74ad79406025ee25f2366cc

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -6,11 +6,12 @@ os:
 - linux
 - osx
 rvm:
+- 2.6
 - 2.5
 - 2.4
 - ruby-head
 before_install: 
-- gem install bundler -v 2.0.1
+- gem install bundler -v "~> 2"
 - bundle update
 matrix:
   allow_failures:

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    relaton-cli (0.2.2)
+      liquid
+      relaton (~> 0.4)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    algoliasearch (1.26.0)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
+    byebug (10.0.2)
+    cnccs (0.1.3)
+    coderay (1.1.2)
+    debase (0.2.2)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.5)
+    diff-lcs (1.3)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    gb-agencies (0.0.5)
+    httpclient (2.8.3)
+    isoics (0.1.7)
+    json (2.2.0)
+    liquid (4.0.3)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    mixlib-shellout (2.4.4)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.1)
+    rake (12.3.2)
+    relaton (0.4.5)
+      algoliasearch
+      relaton-gb (~> 0.5.0)
+      relaton-iec (~> 0.3.0)
+      relaton-ietf (~> 0.5.0)
+      relaton-iso (~> 0.5.0)
+      relaton-iso-bib (~> 0.2.0)
+      relaton-itu (~> 0.2.0)
+      relaton-nist (~> 0.2.0)
+    relaton-bib (0.2.5)
+      addressable
+      nokogiri (~> 1.10)
+    relaton-gb (0.5.2)
+      cnccs (~> 0.1.1)
+      gb-agencies (~> 0.0.1)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iec (0.3.2)
+      addressable
+      relaton-iso-bib (~> 0.2.0)
+    relaton-ietf (0.5.5)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso (0.5.5)
+      relaton-iec (~> 0.3.0)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-iso-bib (0.2.4)
+      isoics (~> 0.1.6)
+      relaton-bib (~> 0.2.0)
+      ruby_deep_clone (~> 0.8.0)
+    relaton-itu (0.2.3)
+      relaton-iso-bib (~> 0.2.0)
+    relaton-nist (0.2.3)
+      relaton-bib (~> 0.2.0)
+      rubyzip
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-command (1.0.3)
+      mixlib-shellout (~> 2.0)
+      rspec (~> 3.2)
+      rspec-its (~> 1.2)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    ruby-debug-ide (0.7.0)
+      rake (>= 0.8.1)
+    ruby_deep_clone (0.8.0)
+    rubyzip (1.2.3)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 10.0)
+  debase
+  equivalent-xml (~> 0.6)
+  pry
+  rake (~> 12.0)
+  relaton-cli!
+  rspec (~> 3.0)
+  rspec-command (~> 1.0.3)
+  rspec-core (~> 3.4)
+  ruby-debug-ide
+
+BUNDLED WITH
+   2.0.1

data/appveyor.yml

@@ -7,6 +7,7 @@ cache:
 
 environment:
   matrix:
+    - RUBY_VERSION: 26
     - RUBY_VERSION: 25
     - RUBY_VERSION: 24
     - RUBY_VERSION: _trunk
@@ -22,6 +23,7 @@ install:
 build_script:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
   - set GIT_TERMINAL_PROMPT=0
+  - gem install bundler -v "~> 2"
   - bundle config --local path vendor/bundle
   - bundle update
   - bundle install

data/lib/relaton/bibcollection.rb

@@ -40,7 +40,7 @@ module Relaton
       author = find_text("./relaton-collection/contributor[role/@type = 'author']/organization/name", source)
 
       items = find_xpath("./relaton-collection/relation", source)&.map do |item|
-        bibdata = find("./bibdata", item)
+        bibdata = find("./bibdata | ./bibitem", item)
         klass = bibdata ? Bibdata : Bibcollection
         klass.from_xml(bibdata || item)
       end
@@ -70,7 +70,7 @@ module Relaton
       end
     end
 
-    def to_xml
+    def to_xml(opts = {})
       items.sort_by! do |b|
         b.doc_number
       end
@@ -89,7 +89,7 @@ module Relaton
       unless items.empty?
         items.each do |item|
           ret += "<relation type='partOf'>"
-          ret += item.to_xml
+          ret += item.to_xml(opts)
           ret += "</relation>\n"
         end
       end

data/lib/relaton/bibcollectionnew.rb

@@ -0,0 +1,119 @@
+require "relaton/element_finder"
+
+module Relaton
+  class BibcollectionNew
+    extend Relaton::ElementFinder
+
+    ATTRIBS = %i[
+      title
+      items
+      doctype
+      author
+    ]
+
+    attr_accessor *ATTRIBS
+
+    def initialize(options)
+      self.items = []
+      ATTRIBS.each do |k|
+        value = options[k] || options[k.to_s]
+        self.send("#{k}=", value)
+      end
+      self.items = (self.items || []).inject([]) do |acc,item|
+        acc << if item.is_a?(::Relaton::BibcollectionNew) ||
+          item.is_a?(::RelatonBib::BibliographicItem)
+          item
+        else
+          new_bib_item_class(item)
+        end
+      end
+      self
+    end
+
+    # arbitrary number, must sort after all bib items
+    def doc_number
+      9999999
+    end
+
+    def self.from_xml(source)
+      title = find_text("./relaton-collection/title", source)
+      author = find_text("./relaton-collection/contributor[role/@type = 'author']/organization/name", source)
+
+      items = find_xpath("./relaton-collection/relation", source)&.map do |item|
+        bibdata = find("./bibdata", item)
+        klass = bibdata ? Bibdata : BibcollectionNew
+        klass.from_xml(bibdata || item)
+      end
+
+      new(title: title, author: author, items: items)
+    end
+
+    def new_bib_item_class(options)
+      if options["items"]
+        ::Relaton::BibcollectionNew.new(options)
+      else
+        ::RelatonBib::BibliographicItem.new(options)
+      end
+    end
+
+    def items_flattened
+      items.sort_by! do |b|
+        b.docnumber
+      end
+
+      items.inject([]) do |acc,item|
+        if item.is_a? ::Relaton::BibcollectionNew
+          acc << item.items_flattened
+        else
+          acc << item
+        end
+      end
+    end
+
+    def to_xml(opts)
+      items.sort_by! do |b|
+        b.docnumber
+      end
+
+      collection_type = if doctype
+        "type=\"#{doctype}\""
+      else
+        'xmlns="https://open.ribose.com/relaton-xml"'
+      end
+
+      ret = "<relaton-collection #{collection_type}>"
+      ret += "<title>#{title}</title>" if title
+      if author
+        ret += "<contributor><role type='author'/><organization><name>#{author}</name></organization></contributor>"
+      end
+      unless items.empty?
+        items.each do |item|
+          ret += "<relation type='partOf'>"
+          ret += item.to_xml(opts)
+          ret += "</relation>\n"
+        end
+      end
+      ret += "</relaton-collection>\n"
+    end
+
+    def to_yaml
+      to_h.to_yaml
+    end
+
+    def to_h
+      items.sort_by! do |b|
+        b.doc_number
+      end
+
+      a = ATTRIBS.inject({}) do |acc, k|
+        acc[k.to_s] = send(k)
+        acc
+      end
+
+      a["items"] = a["items"].map(&:to_h)
+
+      { "root" => a }
+    end
+
+  end
+end

data/lib/relaton/bibdata.rb

@@ -61,7 +61,7 @@ module Relaton
       new(Relaton::XmlDocument.parse(source))
     end
 
-    def to_xml
+    def to_xml(opts = {})
       #datetype = stage&.casecmp("published") == 0 ? "published" : "circulated"
 
       ret = ref ? "<bibitem id= '#{ref}' type='#{doctype}'>\n" : "<bibdata type='#{doctype}'>\n"

data/lib/relaton/cli/base_convertor.rb

@@ -1,6 +1,7 @@
 require "fileutils"
 require "relaton/bibdata"
 require "relaton/bibcollection"
+require "relaton/bibcollectionnew"
 require "relaton/cli/xml_to_html_renderer"
 
 module Relaton
@@ -12,6 +13,7 @@ module Relaton
         @outdir = options.fetch(:outdir, nil)
         @writable = options.fetch(:write, true)
         @overwrite = options.fetch(:overwrite, true)
+        @default_filelabel = 0
 
         install_dependencies(options[:require] || [])
       end
@@ -64,9 +66,16 @@ module Relaton
         dependencies.each { |dependency| require(dependency) }
       end
 
+      def item_output(content, format)
+        case format.to_sym
+        when :to_yaml then content.to_yaml
+        when :to_xml then content.to_xml(date_format: :full)
+        end
+      end
+
       def convert_and_write(content, format)
         content = convert_content(content)
-        write_to_a_file(content.send(format.to_sym))
+        write_to_a_file(item_output(content, format))
         write_to_file_collection(content, format.to_sym)
       end
 
@@ -79,16 +88,40 @@ module Relaton
       end
 
       def write_to_file_collection(content, format)
-        if outdir && content.is_a?(Relaton::Bibcollection)
+        if outdir && (content.is_a?(Relaton::Bibcollection))
           FileUtils.mkdir_p(outdir)
-
           content.items_flattened.each do |item|
             collection = collection_filename(item.docidentifier_code)
-            write_to_a_file(item.send(format.to_sym), collection)
+            write_to_a_file(item_output(item, format), collection)
+          end
+        end
+        if outdir && (content.is_a?(Relaton::BibcollectionNew))
+          FileUtils.mkdir_p(outdir)
+          content.items_flattened.each do |item|
+            collection = collection_filename(extract_docid(item))
+            write_to_a_file(item_output(item, format), collection)
           end
         end
       end
 
+      def extract_docid(item)
+        @default_filelabel += 1
+        item.docidentifier.nil? and return @default_filelabel.to_s
+        item.docidentifier.is_a?(Array) or return @default_filelabel.to_s
+        item.docidentifier.empty? and return @default_filelabel.to_s
+        docidentifier_code(item.docidentifier[0].id)
+      end
+
+      # From http://gavinmiller.io/2016/creating-a-secure-sanitization-function/
+      FILENAME_BAD_CHARS = [ '/', '\\', '?', '%', '*', ':', '|', '"', '<', '>', '.', ' ' ]
+
+      def docidentifier_code(docidentifier)
+        return "" if docidentifier.nil?
+        a = FILENAME_BAD_CHARS.inject(docidentifier.downcase) do |result, bad_char|
+          result.gsub(bad_char, '-')
+        end
+      end
+
       def extension
         @extension ||= [".", options.fetch(:extension, default_ext)].join
       end

data/lib/relaton/cli/command.rb

@@ -1,6 +1,7 @@
 require "relaton/cli/relaton_file"
 require "relaton/cli/xml_convertor"
 require "relaton/cli/yaml_convertor"
+require "relaton/cli/yaml_convertor_new"
 require "fcntl"
 
 module Relaton
@@ -49,6 +50,17 @@ module Relaton
         Relaton::Cli::YAMLConvertor.to_xml(filename, options)
       end
 
+      desc "yaml2xmlnew YAML", "Convert Relaton YAML into Relaton Collection XML or separate files"
+      option :extension, aliases: :x, desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      option :prefix, aliases: :p, desc: "Filename prefix of individual Relaton XML files, defaults to empty"
+      option :outdir, aliases: :o,  desc: "Output to the specified directory with individual Relaton Bibdata XML files"
+      option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
+      option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
+
+      def yaml2xmlnew(filename)
+        Relaton::Cli::YAMLConvertorNew.to_xml(filename, options)
+      end
+
       desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
       option :extension, aliases: :x, desc: "File extension of Relaton YAML files, defaults to 'yaml'"
       option :prefix, aliases: :p, desc: "Filename prefix of Relaton XML files, defaults to empty"
@@ -78,11 +90,20 @@ module Relaton
         Relaton::Cli::YAMLConvertor.to_html(file, style, template)
       end
 
+      desc "yaml2htmlnew RELATON-INDEX-YAML", "Concatenate Relaton Collection YAML into HTML"
+      option :stylesheet, aliases: :s, desc: "Stylesheet file path for rendering HTML index"
+      option :templatedir, aliases: :t, desc: "Liquid template directory for rendering Relaton items and collection"
+      option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
+
+      def yaml2htmlnew(file, style = nil, template = nil)
+        Relaton::Cli::YAMLConvertorNew.to_html(file, style, template)
+      end
+
       private
 
       def fetch_document(code, options)
         if registered_types.include?(options[:type])
-          doc = Cli.relaton.fetch(code, options[:year])
+          doc = Cli.relaton.fetch(code, options[:year]&.to_s)
           doc ? doc.to_xml : "No matching bibliographic entry found"
         end
       rescue RelatonBib::RequestError => e

data/lib/relaton/cli/relaton_file.rb

@@ -116,7 +116,8 @@ module Relaton
             bib = nokogiri_document(bib.to_xml)
           elsif (rfc = xml.at("//rfc"))
             require "relaton_ietf/scrapper"
-            ietf = RelatonIetf::Scrapper.bib_item rfc, "rfc"
+            #ietf = RelatonIetf::Scrapper.bib_item rfc, "rfc"
+            ietf = RelatonIetf::Scrapper.fetch_rfc rfc
             bib = nokogiri_document ietf.to_xml(bibdata: true)
           else
             next
@@ -139,7 +140,8 @@ module Relaton
           doc = nokogiri_document(xml[:content])
           if (rfc = doc.at("//rfc"))
             require "relaton_ietf/scrapper"
-            ietf = RelatonIetf::Scrapper.bib_item rfc, "rfc"
+            #ietf = RelatonIetf::Scrapper.bib_item rfc, "rfc"
+            ietf = RelatonIetf::Scrapper.fetch_rfc rfc
             doc = nokogiri_document ietf.to_xml(bibdata: true)
           end
           bibdata_instance(doc, xml[:file]) if doc.root.name == "bibdata"

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "0.2.1".freeze
+    VERSION = "0.2.2".freeze
   end
 end

data/lib/relaton/cli/yaml_convertor_new.rb

@@ -0,0 +1,71 @@
+require "yaml"
+require "relaton/cli/base_convertor"
+require "relaton_bib"
+
+module Relaton
+  module Cli
+    class YAMLConvertorNew < Relaton::Cli::BaseConvertor
+      def to_xml
+        if writable
+          convert_and_write(file_content, :to_xml)
+        else
+          convert_content(file_content).to_xml(nil, date_format: :full)
+        end
+      end
+
+      # Convert to XML
+      #
+      # This interface allow us to convert any YAML file to XML.
+      # It only require us to provide a valid YAML file and it can
+      # do converstion using default attributes, but it also allow
+      # us to provide custom options to customize this converstion
+      # process.
+      #
+      # @param file [File] The complete path to a YAML file
+      # @param options [Hash] Options as hash key, value pairs.
+      #
+      def self.to_xml(file, options = {})
+        new(file, options).to_xml
+      end
+
+      private
+
+      def default_ext
+        "rxl"
+      end
+
+      def file_content
+        date_to_string(YAML.load_file(file))
+      end
+
+      def date_to_string(obj)
+        obj.is_a? Hash and
+          return obj.inject({}){|memo,(k,v)| memo[k] = date_to_string(v); memo}
+        obj.is_a? Array and
+          return obj.inject([]){|memo,v    | memo      << date_to_string(v); memo}
+        return obj.is_a?(Date) ? obj.to_s : obj
+      end
+
+      def convert_single_file(content)
+        RelatonBib::BibliographicItem.new(RelatonBib::hash_to_bib(content))
+      end
+
+      def convert_collection(content)
+        if content.has_key?("root")
+          content["root"]["items"] = content["root"]["items"].map do |i|
+            RelatonBib::hash_to_bib(i)
+          end
+          Relaton::BibcollectionNew.new(content["root"])
+        end
+      end
+
+      def xml_content(_raw_file)
+        convert_content(file_content).to_xml(date_format: :full)
+      end
+
+      def convert_content(content)
+        convert_collection(content) || convert_single_file(content)
+      end
+    end
+  end
+end

data/lib/relaton-cli.rb

@@ -1,4 +1,5 @@
 require_relative "relaton/bibcollection"
+require_relative "relaton/bibcollectionnew"
 require_relative "relaton/bibdata"
 require_relative "relaton/element_finder"
 require_relative "relaton/xml_document"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -194,6 +194,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - Rakefile
 - appveyor.yml
@@ -205,6 +206,7 @@ files:
 - i18n.yaml
 - lib/relaton-cli.rb
 - lib/relaton/bibcollection.rb
+- lib/relaton/bibcollectionnew.rb
 - lib/relaton/bibdata.rb
 - lib/relaton/cli.rb
 - lib/relaton/cli/_document.liquid
@@ -216,6 +218,7 @@ files:
 - lib/relaton/cli/xml_convertor.rb
 - lib/relaton/cli/xml_to_html_renderer.rb
 - lib/relaton/cli/yaml_convertor.rb
+- lib/relaton/cli/yaml_convertor_new.rb
 - lib/relaton/element_finder.rb
 - lib/relaton/xml_document.rb
 - relaton-cli.gemspec