relaton-cli 3.0.7 → 3.1.0

data/lib/relaton/cli/xml_convertor.rb

@@ -1,47 +0,0 @@
-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
-
-      # @param content [Nokogiri::XML::Document]
-      # @return [Hash]
-      def convert_content(content)
-        if %w[bibitem bibdata].include? content.root.name
-          Bibdata.from_xml(content)
-        else
-          Bibcollection.from_xml(content)
-        end
-      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

@@ -1,117 +0,0 @@
-require "nokogiri"
-require "liquid"
-
-module Relaton::Cli
-  class XmlToHtmlRenderer
-    def initialize(liquid_dir: nil, stylesheet: nil)
-      @liquid_dir = liquid_dir
-      @stylesheet = read_file(stylesheet)
-      init_liquid_template_and_filesystem
-    end
-
-    # @param index_xml [String] Relaton XML
-    # @return [String] HTML
-    def render(index_xml)
-      Liquid::Template
-        .parse(template)
-        .render(build_liquid_document(index_xml))
-    end
-
-    def uri_for_extension(uri, extension)
-      uri&.sub(/\.[^.]+$/, ".#{extension}")
-    end
-
-    # Render HTML
-    #
-    # This interface allow us to convert a Relaton XML to HTML
-    # using the specified liquid template and stylesheets. It
-    # also do some minor clean during this conversion.
-    #
-    # @param file [String] Relaton XML
-    # @param options [Hash]
-    # @return [String] HTML
-    def self.render(file, options)
-      new(**options).render(file)
-    end
-
-    private
-
-    attr_reader :stylesheet, :liquid_dir, :template
-
-    def read_file(file)
-      File.read(file, encoding: "utf-8")
-    end
-
-    # rubocop:disable Metrics/MethodLength
-    # @param source [String] Relaton XML
-    def build_liquid_document(source)
-      bibcollection = build_bibcollection(source)
-      hash_to_liquid(
-        depth: 2,
-        css: stylesheet,
-        title: bibcollection.title,
-        date: DateTime.now.to_s,
-        author: bibcollection.author,
-        documents: document_items(bibcollection)
-      )
-    end
-
-    def init_liquid_template_and_filesystem
-      file_system = Liquid::LocalFileSystem.new(liquid_dir)
-      @template = read_file(file_system.full_path("index"))
-
-      Liquid::Template.file_system = file_system
-    end
-
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-    # TODO: This should be recursive, but it's not
-    # @param hash [Hash]
-    # @option hash [Integer] :dept
-    # @option hash [String] :css path to stylesheet file
-    # @option hash [String] :title
-    # @option hash [String] :author
-    # @option hash [Array<Hash>] :documents
-    #
-    # @return [Hash]
-    def hash_to_liquid(hash)
-      hash.map do |key, value|
-        case key
-        when "title"
-          if value.is_a?(Array)
-            title = value.detect { |t| t["type"] == "main" } || value.first
-            v = title ? title["content"] : nil
-          elsif value.is_a?(Hash) then v = value["content"]
-          else v = value
-          end
-        when "docidentifier"
-          did = if value.is_a?(Array)
-                  value.detect { |d| (d["id"] || d["content"]).to_s !~ /^(http|https):\/\// } ||
-                    value.first
-                else value
-                end
-          v = did
-        else v = value
-        end
-        [key.to_s, empty2nil(v)]
-      end.to_h
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-
-    def empty2nil(value)
-      value unless value.is_a?(String) && value.empty? && !value.nil?
-    end
-
-    # @param source [String] Relaton XML
-    # @return [Relaton::Bibcollection]
-    def build_bibcollection(source)
-      Relaton::Bibcollection.from_xml(Nokogiri::XML(source))
-    end
-
-    # @param bibcollection [Relaton::Bibcollection]
-    # @return [Array<Hash>]
-    def document_items(bibcollection)
-      bibcollection.to_h["root"]["items"].map { |item| hash_to_liquid(item) }
-    end
-  end
-end

data/lib/relaton/cli/yaml_convertor.rb

@@ -1,102 +0,0 @@
-require "yaml"
-require "relaton/cli/base_convertor"
-require "relaton/bib"
-
-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 date_format: :full, bibdata: true
-        end
-      end
-
-      class << self
-        # 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 to_xml(file, options = {})
-          new(file, options).to_xml
-        end
-
-        # @param content [Hash] document in YAML format
-        # @return [RelatonBib::BibliographicItem,
-        #   RelatonIso::IsoBiblioraphicItem]
-        def convert_single_file(content)
-          flavor = content.dig("ext", "flavor") || doctype(content["docidentifier"])
-          if (processor = Relaton::Db::Registry.instance.by_type(flavor))
-            begin
-              processor.from_yaml content.to_yaml
-            rescue RuntimeError
-              Relaton::Bib::Item.from_yaml(content.to_yaml)
-            end
-          else
-            Relaton::Bib::Item.from_yaml(content.to_yaml)
-          end
-        end
-
-        private
-
-        # @param content [Hash]
-        # @return [String]
-        def doctype(docid)
-          did = docid.is_a?(Array) ? docid.fetch(0) : docid
-          return unless did
-
-          did["type"] || did.fetch("content")&.match(/^\w+/)&.to_s
-        end
-      end
-
-      private
-
-      def default_ext
-        "rxl"
-      end
-
-      def file_content
-        date_to_string(YAML.load_file(file))
-      end
-
-      def date_to_string(obj)
-        if obj.is_a? Hash
-          obj.reduce({}) do |memo, (k, v)|
-            memo[k] = date_to_string(v)
-            memo
-          end
-        elsif obj.is_a? Array
-          obj.reduce([]) { |memo, v| memo << date_to_string(v) }
-        else
-          obj.is_a?(Date) ? obj.to_s : obj
-        end
-      end
-
-      def convert_collection(content)
-        if content.has_key?("root")
-          content["root"]["items"] = content["root"]["items"].map do |i|
-            # RelatonBib::HashConverter::hash_to_bib(i)
-            self.class.convert_single_file(i)
-          end
-          Relaton::Bibcollection.new(content["root"])
-        end
-      end
-
-      def xml_content(_raw_file)
-        convert_content(file_content).to_xml(date_format: :full, bibdata: true)
-      end
-
-      def convert_content(content)
-        convert_collection(content) || self.class.convert_single_file(content)
-      end
-    end
-  end
-end

data/lib/relaton/cli.rb

@@ -1,113 +0,0 @@
-require "fileutils"
-require "thor"
-require "thor/hollaback"
-require_relative "cli/version"
-require_relative "cli/util"
-require_relative "cli/command"
-
-module Relaton
-  def self.db(dir = nil)
-    Cli.relaton dir
-  end
-
-  module Cli
-    class RelatonDb
-      include Singleton
-
-      DBCONF = "#{Dir.home}/.relaton/dbpath".freeze
-
-      # @param dir [String, nil]
-      # @return [Relaton::Db]
-      def db(dir)
-        if dir
-          FileUtils.mkdir_p File.dirname(DBCONF)
-          File.write DBCONF, dir, encoding: "UTF-8"
-          @db = Relaton::Db.new dir, nil
-        else
-          @db ||= Relaton::Db.new dbpath, nil
-        end
-      end
-
-      private
-
-      # @return [String] path to DB
-      def dbpath
-        if File.exist?(DBCONF)
-          File.read(DBCONF, encoding: "UTF-8")
-        else "#{Dir.home}/.relaton/cache"
-        end
-      end
-    end
-
-    class << self
-      def version
-        require "relaton/bib"
-        registry = Relaton::Db::Registry.instance
-        # Every flavor now ships inside the single `relaton` gem, so they all
-        # report Relaton::VERSION rather than a separate gem version.
-        puts "CLI => #{Relaton::Cli::VERSION}"
-        puts "relaton => #{Relaton::VERSION}"
-        puts "relaton-bib => #{Relaton::VERSION}"
-        registry.processors.each_key do |k|
-          name = k.to_s.sub("_", "-")
-          puts "#{name} => #{Relaton::VERSION}"
-        end
-      end
-
-      def 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.
-      #
-      # @param dir [String, nil]
-      # @return [Relaton::Db]
-      def relaton(dir)
-        RelatonDb.instance.db dir
-      end
-
-      # @param content [Nokogiri::XML::Document]
-      # @return [RelatonBib::BibliographicItem,
-      #   RelatonIsoBib::IsoBibliongraphicItem]
-      def parse_xml(doc)
-        doc.remove_namespaces! if doc.respond_to?(:remove_namespaces!)
-        if (proc = Cli.processor(doc))
-          proc.from_xml(doc.to_s)
-        else
-          Relaton::Bib::Item.from_xml(doc.to_s) rescue nil
-        end
-      end
-
-      # @param doc [Nokogiri::XML::Element]
-      # @return [RelatonIso::Processor, RelatonIec::Processor,
-      #   RelatonNist::Processor, RelatonIetf::Processot,
-      #   RelatonItu::Processor, RelatonGb::Processor,
-      #   RelatonOgc::Processor, RelatonCalconnect::Processor]
-      def processor(doc)
-        docid = doc.at "docidentifier"
-        proc = get_proc docid
-        return proc if proc
-
-        Relaton::Db::Registry.instance.by_type(docid&.text&.match(/^\w+/)&.to_s)
-      end
-
-      private
-
-      # @param doc [Nokogiri::XML::Element]
-      # @return [RelatonIso::Processor, RelatonIec::Processor,
-      #   RelatonNist::Processor, RelatonIetf::Processot,
-      #   RelatonItu::Processor, RelatonGb::Processor,
-      #   RelatonOgc::Processor, RelatonCalconnect::Processor]
-      def get_proc(docid)
-        return unless docid && docid[:type]
-
-        Relaton::Db::Registry.instance.by_type(docid[:type])
-      end
-    end
-  end
-end

data/lib/relaton/element_finder.rb

@@ -1,29 +0,0 @@
-module Relaton
-  module ElementFinder
-    attr_reader :document
-
-    def find_text(xpath, element = nil)
-      find(xpath, element)&.text
-    end
-
-    def find_html(xpath, element = nil)
-      find(xpath, element)&.inner_html
-    end
-
-    def find(xpath, element = nil)
-      (element || document).at(apply_namespace(xpath))
-    end
-
-    def find_xpath(xpath, element = nil)
-      element&.xpath(apply_namespace(xpath))
-    end
-
-    def apply_namespace(xpath)
-      xpath
-        .gsub(%r{/([a-zA-Z])}, "/xmlns:\\1")
-        .gsub(%r{::([a-zA-Z])}, "::xmlns:\\1")
-        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1")
-        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
-    end
-  end
-end

data/relaton-cli.gemspec

@@ -1,49 +0,0 @@
-# relaton-cli is released in lockstep with the combined `relaton` gem from this
-# repo. Derive the version (and the relaton dependency pin) from the single
-# source of truth — root lib/relaton/version.rb — so `gem bump` on that one file
-# re-stamps both gems. No separate version to hand-sync.
-root_version_file = File.expand_path("../../lib/relaton/version.rb", __dir__)
-relaton_version = File.read(root_version_file)[/VERSION\s*=\s*["']([^"']+)["']/, 1] or
-  raise "could not parse Relaton::VERSION from #{root_version_file}"
-
-Gem::Specification.new do |spec|
-  spec.name          = "relaton-cli"
-  spec.version       = relaton_version
-  spec.authors       = ["Ribose Inc."]
-  spec.email         = ["open.source@ribose.com"]
-
-  spec.summary       = "Relaton Command-line Interface"
-  spec.description   = "Relaton Command-line Interface"
-  spec.homepage      = "https://github.com/relaton/relaton"
-  spec.license       = "BSD-2-Clause"
-
-  # Ship lib/, exe/, templates/ and the COMPILED frontend, but not the frontend
-  # sources/tooling. `frontend/dist` is gitignored (built by `rake build_frontend`
-  # at package/release time), so `git ls-files` won't list it — append it
-  # explicitly. Reject the tracked `frontend/` sources so they don't bloat the gem.
-  spec.files         = (`git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|docs|frontend)/})
-  end + Dir.glob("frontend/dist/*")).uniq
-  spec.extra_rdoc_files = %w[docs/README.adoc LICENSE]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
-
-  spec.add_dependency "liquid", "~> 5"
-  # The CLI requires "pubid" directly to rescue Pubid::Errors::Error when a
-  # reference is unparseable (see command.rb / subcommand_collection.rb). It is
-  # already a runtime dep of `relaton`, but declare it here too so the require
-  # is self-supporting rather than dependent on relaton's transitive graph.
-  # Match the relaton gemspec floor (pessimistic, per house style): 2.0.4
-  # carries the IHO series identity components the data re-key keys on.
-  spec.add_dependency "pubid", "~> 2.0.4"
-  # relaton bundles every flavor plus Relaton::Bib, so depending on `relaton`
-  # alone is sufficient — relaton-bib is no longer published standalone.
-  spec.add_dependency "relaton", "= #{relaton_version}"
-  # Plain-text citation rendering (relaton-cli#94); the constraint mirrors
-  # the parent relaton gemspec's.
-  spec.add_dependency "relaton-render", ">= 3.0.0.pre.alpha.1", "< 4"
-  spec.add_dependency "thor"
-  spec.add_dependency "thor-hollaback"
-end

data/templates/_document.liquid

@@ -1,111 +0,0 @@
-{%- if document.items.size > 0 -%}
-<div class="doc-section">
-{%- else -%}
-<div class="document">
-{%- endif -%}
-
-  {%- if document.html != blank and document.html != nil -%}
-  {%-   assign default_link = document.html -%}
-  {%- elsif document.pdf != blank and document.pdf != nil -%}
-  {%-   assign default_link = document.pdf -%}
-  {%- elsif document.doc != blank and document.doc != nil -%}
-  {%-   assign default_link = document.doc -%}
-  {%- elsif document.xml != blank and document.xml != nil -%}
-  {%-   assign default_link = document.xml -%}
-  {%- else -%}
-  {%-   assign default_link = nil -%}
-  {%- endif -%}
-
-  <div class="doc-line">
-    <div class="doc-identifier">
-      <h{{ depth }}>
-      {% if default_link %}
-        <a href="{{ default_link }}">{{ document.docidentifier.content }}</a>
-      {% else %}
-        {{ document.docidentifier.content }}
-      {% endif %}
-      </h{{ depth }}>
-    </div>
-
-    <div class="doc-type-wrap">
-      <div class="doc-type {{ document.ext.doctype.content | downcase | split: " " | join: "-" }}">
-      {{ document.ext.doctype.content }}
-      </div>
-    </div>
-
-  {% if document.edition.content %}
-    <div class="doc-identifier">
-      Edition: {{ document.edition.content }}
-    </div>
-  {% endif %}
-  </div>
-
-  <div class="doc-title">
-    <h{{ depth | plus: 1 }}>
-      {% if default_link %}
-        <a href="{{ default_link }}">{{ document.title }}</a>
-      {% else %}
-        {{ document.title }}
-      {% endif %}
-    </h{{ depth | plus: 1 }}>
-  </div>
-
-  {% if document.status %}
-  <div class="doc-info {{ document.status.stage.content | downcase }}">
-    <div class="doc-stage {{ document.status.stage.content | downcase }}">
-      {% if document.status.substage %}
-        {{ document.status.stage.content }}.{{ document.status.substage.content }}
-      {% else %}
-        {{ document.status.stage.content }}
-      {% endif %}
-    </div>
-    <div class="doc-dates">
-      {% unless document.status.stage.content == "published" %}
-      <div class="doc-updated">
-      {% else %}
-      <div class="doc-published">
-      {% endunless %}
-        {{ document.revdate }}
-      </div>
-    </div>
-  </div>
-  {% endif %}
-
-  <div class="doc-bib">
-    <div class="doc-bib-relaton">
-      <a href="{{ document.rxl }}">Relaton XML</a>
-    </div>
-  </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>
-    </div>
-  {% endunless %}
-  {% unless document.pdf == blank or document.pdf == nil %}
-    <div class="doc-access-button-pdf">
-      <a href="{{ document.pdf }}">PDF</a>
-    </div>
-  {% endunless %}
-  {% unless document.doc == blank or document.doc == nil %}
-    <div class="doc-access-button-doc">
-      <a href="{{ document.doc }}">Word</a>
-    </div>
-  {% endunless %}
-  {% unless document.xml == blank or document.xml == nil %}
-    <div class="doc-access-button-xml">
-      <a href="{{ document.xml }}">XML</a>
-    </div>
-  {% endunless %}
-  </div>
-</div>
-
-{%- if document.items.size > 0 -%}
-  {%- include 'document' for document.items -%}
-{%- endif -%}

data/templates/_index.liquid

@@ -1,61 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <title>{{ title | strip_html }}</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">
-          <div class="doc-access">
-            Generated: {{ date }}
-          </div>
-          <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">
-        <div class="doc-access">
-          Generated: {{ date }}
-        </div>
-        <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>

data/templates/index/page.liquid

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>{{ title | strip_html }}</title>
-    {%- if description %}
-    <meta name="description" content="{{ description | escape }}">
-    {%- endif %}
-    <meta name="generator" content="relaton-cli index">
-    {%- if favicon %}
-    <link rel="icon" href="{{ favicon | escape }}"{% if favicon_type %} type="{{ favicon_type }}"{% endif %}>
-    {%- endif %}
-    <style>{{ css }}</style>
-  </head>
-  <body>
-    <div id="relaton-index-app" data-title="{{ title | escape }}" data-generated="{{ generated }}"{% if description %} data-description="{{ description | escape }}"{% endif %} data-total="{{ total }}" data-shards="{{ shards }}" data-shard-size="{{ shard_size }}" data-detail-shards="{{ detail_shards }}" data-detail-shard-size="{{ detail_shard_size }}"></div>
-    <script>{{ iife }}</script>
-  </body>
-</html>