relaton-cli 0.1.2 → 0.1.4

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "0.1.2".freeze
+    VERSION = "0.1.4".freeze
   end
 end

data/lib/relaton/cli/xml_convertor.rb

@@ -0,0 +1,41 @@
+require "nokogiri"
+require "relaton/cli/base_convertor"
+
+module Relaton
+  module Cli
+    class XMLConvertor < Relaton::Cli::BaseConvertor
+      def to_yaml
+        convert_and_write(file_content, :to_yaml)
+      end
+
+      # Convert to YAML
+      #
+      # This interface allow us to convert any XML file to YAML.
+      # It only require us to provide a valid XML 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 XML file
+      # @param options [Hash] Options as hash key, value pairs.
+      #
+      def self.to_yaml(file, options = {})
+        new(file, options).to_yaml
+      end
+
+      private
+
+      def default_ext
+        "yaml"
+      end
+
+      def convert_content(content)
+        Relaton::Bibcollection.from_xml(content)
+      end
+
+      def file_content
+        Nokogiri::XML(File.read(file, encoding: "utf-8"))
+      end
+    end
+  end
+end

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -35,26 +35,13 @@ module Relaton::Cli
     def render(index_xml)
       source = Nokogiri::XML(index_xml)
       bibcollection = ::Relaton::Bibcollection.from_xml(source)
-
-      # puts "@"*38
-      # puts bibcollection.inspect
-      # puts "@"*38
-
       locals = {
         css: @stylesheet,
         title: bibcollection.title,
         author: bibcollection.author,
-        documents: bibcollection.to_h[:items].map { |i| hash_to_liquid(i) },
+        documents: bibcollection.to_h["root"]["items"].map { |i| hash_to_liquid(i) },
         depth: 2
       }
-
-      # puts "template: #{template}"
-      # puts "B"*30
-      # puts "#{bibcollection.inspect}"
-      # puts "B"*30
-      # puts "#{bibcollection.items.size}"
-      # pp bibcollection.to_h[:items]
-
       Liquid::Template.parse(@template).render(hash_to_liquid(locals))
     end
 
@@ -63,5 +50,8 @@ module Relaton::Cli
       uri.sub(/\.[^.]+$/, ".#{extension.to_s}")
     end
 
+    def self.render(file, options)
+      new(options).render(file)
+    end
   end
 end

data/lib/relaton/cli/yaml_convertor.rb

@@ -0,0 +1,59 @@
+require "yaml"
+require "relaton/cli/base_convertor"
+
+module Relaton
+  module Cli
+    class YAMLConvertor < Relaton::Cli::BaseConvertor
+      def to_xml
+        if writable
+          convert_and_write(file_content, :to_xml)
+        else
+          convert_content(file_content).to_xml
+        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
+        YAML.load_file(file)
+      end
+
+      def convert_single_file(content)
+        Relaton::Bibdata.new(content)
+      end
+
+      def convert_collection(content)
+        if content.has_key?("root")
+          Relaton::Bibcollection.new(content["root"])
+        end
+      end
+
+      def xml_content(_raw_file)
+        convert_content(file_content).to_xml
+      end
+
+      def convert_content(content)
+        convert_collection(content) || convert_single_file(content)
+      end
+    end
+  end
+end

data/lib/relaton/cli.rb

@@ -1,4 +1,22 @@
+require "thor"
 require "relaton"
-require_relative "bibcollection.rb"
-require_relative "bibdata"
-require_relative "cli/xml_to_html_renderer"
+require_relative "cli/command"
+
+module Relaton
+  module Cli
+    def self.start(arguments)
+      Relaton::Cli::Command.start(arguments)
+    end
+
+    # Relaton
+    #
+    # Based on current setup, we need to initiate a Db instance to
+    # register all of it's supported processor backends. To make it
+    # easier we have added it as a class method so we can use this
+    # whenever necessary.
+    #
+    def self.relaton
+      @relaton ||= Relaton::Db.new("#{Dir.home}/.relaton/cache", nil)
+    end
+  end
+end

data/relaton-cli.gemspec

@@ -6,8 +6,8 @@ require "relaton/cli/version"
 Gem::Specification.new do |spec|
   spec.name          = "relaton-cli"
   spec.version       = Relaton::Cli::VERSION
-  spec.authors       = ['Ribose Inc.']
-  spec.email         = ['open.source@ribose.com']
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
 
   spec.summary       = %q{Relaton Command-line Interface}
   spec.description   = %q{Relaton Command-line Interface}
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 12.0"
@@ -30,9 +30,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec-command", "~> 1.0.3"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency 'rspec-core', "~> 3.4"
+  spec.add_development_dependency "rspec-core", "~> 3.4"
+  spec.add_development_dependency "pry"
 
-  spec.add_runtime_dependency 'relaton', "~> 0.2.4"
-  spec.add_runtime_dependency 'uuidtools'
-  spec.add_runtime_dependency 'liquid'
+  spec.add_runtime_dependency "relaton", "~> 0.3"
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "liquid"
+  # spec.add_runtime_dependency 'byebug'
 end

data/templates/_document.liquid

@@ -8,9 +8,9 @@
     <div class="doc-identifier">
       <h{{ depth }}>
       {% if document.html == "" %}
-        {{ document.docid }}
+        {{ document.docidentifier }}
       {% else %}
-        <a href="{{ document.html }}">{{ document.docid }}</a>
+        <a href="{{ document.html }}">{{ document.docidentifier }}</a>
       {% endif %}
       </h{{ depth }}>
     </div>
@@ -54,6 +54,11 @@
   </div>
 
   <div class="doc-access">
+  {% unless document.uri == blank or document.uri == nil %}
+    <div class="doc-access-button-uri">
+      <a href="{{ document.uri }}">URI</a>
+    </div>
+  {% endunless %}
   {% unless document.html == blank or document.html == nil %}
     <div class="doc-access-button-html">
       <a href="{{ document.html }}">HTML</a>

data/templates/_index.liquid

@@ -0,0 +1,53 @@
+<!DOCTYPE HTML>
+<html>
+  <head>
+    <title>{{ title }}</title>
+    <style>
+<!--
+{{ css }}
+-->
+    </style>
+    <meta http-equiv="Content-Type" content="text/html" charset="utf-8"/>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js" type="text/javascript"></script>
+    <script src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js" type="text/javascript"></script>
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700|Overpass:300,300i,600,900|Ek+Mukta:200" rel="stylesheet" type="text/css"/>
+    <link href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous"/>
+    <link href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous"/>
+  </head>
+  <body>
+    <header>
+      <div id="topbar-inner">
+        <div id="title-bar"><span>{{ author }}</span></div>
+      </div>
+      <div class="title-section">
+        <div class="coverpage">
+          <div class="wrapper-top">
+            <div class="coverpage-doc-identity">
+              <div class="coverpage-title"><span class="title-first">{{ title }}</span></div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </header>
+    <main class="main-section">
+    {% include 'document' for documents %}
+    </main>
+    <footer>
+      <div class="copyright">
+        <p class="year">&copy; {{ author }}</p>
+        <p class="message">All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.</p>
+      </div>
+    </footer>
+    <script>
+      $(document).ready(function() {
+        $('[id^=toc]').each(function () {
+           var currentToc = $(this);
+           var url = window.location.href;
+           currentToc.wrap("<a href='" + url + "#" + currentToc.attr("id") + "' <\/a>");
+        });
+      });
+      anchors.options = { placement: 'left' };
+      anchors.add('h1, h2, h3, h4');
+    </script>
+  </body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-29 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,22 +108,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: uuidtools
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -154,18 +168,14 @@ description: Relaton Command-line Interface
 email:
 - open.source@ribose.com
 executables:
-- relaton-concatenate
-- relaton-fetch
-- relaton-metanorma-extract
-- relaton-xml-html
-- relaton-yaml-xml
+- relaton
 extensions: []
 extra_rdoc_files:
 - README.adoc
 - LICENSE
 files:
-- ".rubocop.ribose.yml"
-- ".rubocop.tb.yml"
+- ".gitignore"
+- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -173,21 +183,24 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
-- exe/relaton-concatenate
-- exe/relaton-fetch
-- exe/relaton-metanorma-extract
-- exe/relaton-xml-html
-- exe/relaton-yaml-xml
+- bin/rspec
+- exe/relaton
 - i18n.yaml
 - lib/relaton/bibcollection.rb
 - lib/relaton/bibdata.rb
 - lib/relaton/cli.rb
 - lib/relaton/cli/_document.liquid
 - lib/relaton/cli/_index.liquid
+- lib/relaton/cli/base_convertor.rb
+- lib/relaton/cli/command.rb
+- lib/relaton/cli/relaton_file.rb
 - lib/relaton/cli/version.rb
+- lib/relaton/cli/xml_convertor.rb
 - lib/relaton/cli/xml_to_html_renderer.rb
+- lib/relaton/cli/yaml_convertor.rb
 - relaton-cli.gemspec
 - templates/_document.liquid
+- templates/_index.liquid
 homepage: https://github.com/riboseinc/relaton-cli
 licenses:
 - BSD-2-Clause
@@ -208,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Relaton Command-line Interface

data/.rubocop.ribose.yml

@@ -1,66 +0,0 @@
-AllCops:
-  Include:
-  - "**/*.rake"
-  - "**/Gemfile"
-  - "**/*.gemfile"
-  - "**/Rakefile"
-  - "**/*.rb"
-  Exclude:
-  - "vendor/**/*"
-  - "db/**/*"
-  - "tmp/**/*"
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-Rails:
-  Enabled: true
-Metrics/AbcSize:
-  Description: A calculated magnitude based on number of assignments, branches, and
-    conditions.
-  Enabled: true
-  Max: 15
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-Metrics/BlockNesting:
-  Description: Avoid excessive block nesting
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count
-  Enabled: true
-  Max: 3
-Metrics/ClassLength:
-  Description: Avoid classes longer than 100 lines of code.
-  Enabled: false
-  CountComments: false
-  Max: 100
-Metrics/CyclomaticComplexity:
-  Description: A complexity metric that is strongly correlated to the number of test
-    cases needed to validate a method.
-  Enabled: true
-  Max: 6
-Metrics/LineLength:
-  Description: Limit lines to 80 characters.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits
-  Enabled: true
-  Max: 80
-  AllowURI: true
-  URISchemes:
-  - http
-  - https
-Metrics/MethodLength:
-  Description: Avoid methods longer than 10 lines of code.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
-  Enabled: true
-  CountComments: true
-  Max: 10
-  Exclude:
-  - "spec/**/*"
-Metrics/ParameterLists:
-  Description: Avoid long parameter lists.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
-  Enabled: true
-  Max: 5
-  CountKeywordArgs: true
-Metrics/PerceivedComplexity:
-  Description: A complexity metric geared towards measuring complexity for a human
-    reader.
-  Enabled: true
-  Max: 7