relaton-cli 0.1.0

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# 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:
+  # Thoughtbot's style guide from: https://github.com/thoughtbot/guides
+  - ".rubocop.tb.yml"
+  # Overrides from Ribose
+  - ".rubocop.ribose.yml"
+AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.5
+Rails:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,14 @@
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+  - ruby-head
+before_install:
+  - gem install bundler -v 1.16.1
+  - unset _JAVA_OPTIONS
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,9 @@
+= Relaton CLI (relaton-cli): Relaton Command-line Interface
+
+image:https://img.shields.io/gem/v/relaton-cli.svg["Gem Version", link="https://rubygems.org/gems/relaton-cli"]
+image:https://img.shields.io/travis/riboseinc/relaton-cli/master.svg["Build Status", link="https://travis-ci.org/riboseinc/relaton-cli"]
+image:https://codeclimate.com/github/riboseinc/relaton-cli/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/relaton-cli"]
+
+Documentation in development.
+
+Please refer to https://github.com/riboseinc/relaton.

data/Rakefile

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

data/exe/relaton-xml-html

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# Invoke as: ./relaton-doc FILENAME STYLESHEET RELATON-ROOT
+require "nokogiri"
+require "relaton/cli"
+
+unless ARGV.size == 3
+  warn "Invoke as: ./relaton-doc <relaton-xml> <stylesheet> <output-root>"
+  exit
+end
+
+filename = ARGV[0]
+stylesheet = ARGV[1]
+relaton_root = ARGV[2] || "relaton"
+
+file = File.read(ARGV[0], encoding: "utf-8")
+
+xml_to_html = Relaton::Cli::XmlToHtmlRenderer.new
+
+File.open(filename.sub(/\.xml$/, ".html"), "w:UTF-8") do |f|
+  f.write(xml_to_html.render(file, stylesheet, relaton_root))
+end
+

data/exe/relaton-yaml-xml

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require "yaml"
+require "optparse"
+# require "metanorma"
+# require "byebug"
+require "fileutils"
+
+
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner += " <file>"
+  opts.on(
+    '-t',
+    '--type TYPE',
+    "Type of standard to generate"
+  ) { |v| options[:type] = v.to_sym }
+
+  opts.on(
+    '-r',
+    '--require LIBRARY',
+    'Require LIBRARY prior to execution'
+  ) { |v|
+    options[:require] ||= []
+    options[:require] << v
+  }
+
+  opts.on(
+    '-R OUTDIR',
+    '--relaton-outdir OUTDIR',
+    "Create Relaton XML per item, within this output directory (e.g. {outdir}/{docid}.xml)"
+  ) { |v| options[:outdir] = v }
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+opt_parser.parse!(ARGV)
+options[:filename] = ARGV.pop
+
+if options[:require]
+  options[:require].each do |r|
+    require r
+  end
+end
+
+index_input = YAML.load_file(options[:filename])
+index_collection = Bibcollection.new(index_input["root"])
+
+# TODO real lookup of namespaces and root elements
+
+# Write out index.html
+outfilename = options[:filename].sub(/\.[^.]+$/, ".xml")
+File.open(outfilename, "w") do |f|
+  f.write index_collection.to_xml
+end
+
+outdir = options[:outdir] || "relaton"
+
+FileUtils.mkdir_p(outdir)
+# Write out relaton/#{id}.xml
+index_collection.items_flattened.each do |item|
+  filename = File.join(outdir, "#{item.docid_code}.xml")
+
+  File.open(filename, "w:UTF-8") do |f|
+    f.write(item.to_xml)
+  end
+
+end
+
+# cmd = "#{File.dirname(__FILE__)}/relaton-doc #{outfilename} #{ manifest["htmlstylesheet"] || '""' } #{ options[:relaton] || '""' }"
+# system cmd
+
+#processor = registry.find_processor(options[:type].to_sym)
+#ext = :html
+#file_extension = "html" || processor.output_formats[ext]
+#outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
+#isodoc_options = { suppressheadingnumbers: true }
+#isodoc_options[:htmlstylesheet] = manifest["htmlstylesheet"] if manifest["htmlstylesheet"]
+#processor.output(out, outfilename, ext, isodoc_options)

data/i18n.yaml

@@ -0,0 +1 @@
+label: label

data/lib/relaton/bibcollection.rb

@@ -0,0 +1,77 @@
+module Relaton
+  class Bibcollection
+    ATTRIBS = %i[
+      title
+      items
+      doctype
+    ]
+
+    attr_accessor *ATTRIBS
+
+    def initialize(options)
+      self.items = []
+      ATTRIBS.each do |k|
+        method = "#{k}="
+        value = options[k.to_s]
+        # puts "K #{method}"
+        # puts value.inspect
+
+        self.send("#{k}=", options[k.to_s])
+        # puts "SET! to #{self.send(k).inspect}"
+      end
+
+      # puts items.inspect
+      self.items = self.items.inject([]) do |acc,item|
+        acc << if item.is_a?(Bibcollection) || item.is_a?(Bibdata)
+          item
+        else
+          # puts "item.inspect #{item.inspect}"
+          new_bib_item_class(item)
+        end
+      end
+
+      self
+      # byebug
+    end
+
+    def new_bib_item_class(options)
+      if options["items"]
+        Bibcollection.new(options)
+      else
+        Bibdata.new(options)
+      end
+    end
+
+    def items_flattened
+
+      items.inject([]) do |acc,item|
+        if item.is_a? Bibcollection
+          acc << item.items_flattened
+        else
+          acc << item
+        end
+      end
+
+    end
+
+    def to_xml
+      collection_type = if doctype
+        "type=\"#{doctype}\""
+      else
+        'xmlns="http://riboseinc.com/isoxml"'
+      end
+
+      ret = "<relaton-collection #{collection_type}>"
+      ret += "<title>#{title}</title>" if title
+      unless items.empty?
+        items.each do |item|
+          ret += "<relation type='partOf'>"
+          ret += item.to_xml
+          ret += "</relation>\n"
+        end
+      end
+      ret += "</relaton-collection>\n"
+    end
+
+  end
+end

data/lib/relaton/bibdata.rb

@@ -0,0 +1,40 @@
+module Relaton
+  class Bibdata
+    attr_accessor *%i[
+      docid
+      doctype
+      title
+      stage
+      relation
+      uri
+      revdate
+      abstract
+      technical_committee
+    ]
+
+    def initialize(options)
+      options.each_pair do |k,v|
+        send("#{k.to_s}=", v)
+      end
+    end
+
+    def docid_code
+      docid.downcase.gsub(/[\s\/]/, "-") || ""
+    end
+
+    def to_xml
+      datetype = stage.casecmp("published") == 0 ? "published" : "updated"
+
+      ret = "<bibdata type='#{doctype}'>\n"
+      ret += "<title>#{title}</title>\n"
+      ret += "<uri>#{uri}</uri>\n"
+      ret += "<docidentifier>#{docid}</docidentifier>\n"
+      ret += "<date type='#{datetype}'><on>#{revdate}</on></date>\n" if revdate
+      ret += "<abstract>#{abstract}</abstract>\n" if abstract
+      ret += "<status>#{stage}</status>\n" if stage
+      ret += "<technical-committee>#{technical_committee}</technical-committee>\n" if technical_committee
+      ret += "</bibdata>\n"
+    end
+
+  end
+end

data/lib/relaton/cli.rb

@@ -0,0 +1,4 @@
+require "relaton"
+require_relative "bibcollection.rb"
+require_relative "bibdata"
+require_relative "cli/xml_to_html_renderer"

data/lib/relaton/cli/version.rb

@@ -0,0 +1,5 @@
+module Relaton
+  module Cli
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -0,0 +1,279 @@
+
+module Relaton::Cli
+  class XmlToHtmlRenderer
+
+    # require "byebug"; byebug
+    def ns(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
+
+    NOKOHEAD = <<~HERE.freeze
+    <!DOCTYPE html SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+    <html xmlns="http://www.w3.org/1999/xhtml">
+    <head></head>
+    <body></body>
+    </html>
+    HERE
+
+    # block for processing XML document fragments as XHTML,
+    # to allow for HTMLentities
+    def noko(&block)
+      doc = ::Nokogiri::XML.parse(NOKOHEAD)
+      fragment = doc.fragment("")
+      ::Nokogiri::XML::Builder.with fragment, &block
+      fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
+        l.gsub(/\s*\n/, "")
+      end
+    end
+
+    def script_cdata(result)
+      result.gsub(%r{<script>\s*<!\[CDATA\[}m, "<script>").
+        gsub(%r{\]\]>\s*</script>}, "</script>").
+        gsub(%r{<!\[CDATA\[\s*<script>}m, "<script>").
+        gsub(%r{</script>\s*\]\]>}, "</script>")
+    end
+
+    def render(file_content, css_path, relaton_root)
+      doc = Nokogiri::XML(file_content)
+      stylesheet = File.read(css_path)
+
+      result = noko do |xml|
+        xml.html do |html|
+          define_head(
+            html,
+            stylesheet,
+            doc&.at(ns("./relaton-collection/title"))&.text || "Untitled"
+          )
+          make_body html, doc, relaton_root
+        end
+      end.join("\n")
+
+      script_cdata(result)
+    end
+
+    def define_head(html, stylesheet, title)
+      html.head do |head|
+        head.title { |t| t << title }
+        head.style do |style|
+          style.comment "\n#{stylesheet}\n"
+        end
+        head.meta **{ "http-equiv": "Content-Type", content: "text/html", charset: "utf-8" }
+
+        [
+          "https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js",
+          "https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"
+        ].each do |url|
+          head.script **{ src: url, type: "text/javascript" } do |s|
+            s.text nil
+          end
+        end
+
+        [
+          {
+            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"
+          },
+          {
+            href: "https://use.fontawesome.com/releases/v5.0.8/css/solid.css",
+            integrity: "sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk",
+            crossorigin: "anonymous"
+          },
+          {
+            href: "https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css",
+            integrity: "sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P",
+            crossorigin: "anonymous"
+          }
+
+        ].each do |attribs|
+          head.link **attribs
+        end
+
+      end
+    end
+
+    def make_body(html, xml, relaton_root)
+      # require "byebug"; byebug
+      body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
+      html.body **body_attr do |body|
+        make_body1(body, xml)
+        make_body2(body, xml)
+        make_body3(body, xml, relaton_root)
+        scripts(body)
+      end
+    end
+
+    def make_body1(body, docxml)
+      body.div **{ class: "title-section" } do |div1|
+        div1 << <<~END
+      <header>
+        <div class="coverpage">
+          <div class="wrapper-top">
+            <div class="coverpage-doc-identity">
+              <div class="coverpage-title">
+                <span class="title-first">#{docxml&.at(ns("./relaton-collection/title"))&.text}</span>
+              </div>
+            </div>
+          </div>
+        <div>
+      </header>
+        END
+      end
+    end
+
+    def make_body2(body, docxml)
+      body.div **{ class: "prefatory-section" } do |div2|
+        div2.p { |p| p << "&nbsp;" } # placeholder
+      end
+    end
+
+    def make_body3(body, docxml, relaton_root)
+      # require "byebug"; byebug
+      body.main **{ class: "main-section" } do |div3|
+        docxml.xpath(ns("./relaton-collection/relation")).each do |x|
+          iterate(div3, x.at(ns("./bibdata | ./relaton-collection")), 2, relaton_root)
+        end
+      end
+
+      body.div **{ class: "copyright" } do |div1|
+        div1 << <<~END
+          <p class="year">
+            © The Calendaring and Scheduling Consortium, Inc.
+          </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. Permission can be requested from the address below.
+          </p>
+        END
+      end
+
+    end
+
+    def script
+      <<~"END"
+    <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>
+      END
+    end
+
+    def scripts(body)
+      body.parent.add_child script
+    end
+
+    EXTENSION_TYPES = [
+      {
+        text: "HTML",
+        extension: ".html"
+      },
+      {
+        text: "PDF",
+        extension: ".pdf"
+      },
+      {
+        text: "Word",
+        extension: ".doc"
+      },
+      {
+        text: "XML",
+        extension: ".xml"
+      }
+    ]
+
+    def uri_for_extension(uri, extension)
+      uri.sub(/\.[^.]+$/, extension.to_s)
+    end
+
+    def iterate(d0, bib, depth, relaton_root)
+      # require "byebug"; byebug
+      uri = bib.at(ns("./uri"))&.text
+      id = bib.at(ns("./docidentifier"))&.text
+      id_code = id.downcase.gsub(/[\s\/]/, "-") unless id.nil?
+      title = bib.at(ns("./title"))&.text
+
+      d0.div **{ class: bib.name == "bibdata" ? "document" : "doc-section" } do |d|
+        d.div **{ class: "doc-line" } do |d1|
+
+          d1.div **{ class: "doc-identifier" } do |d2|
+            d2.send "h#{depth}" do |h|
+              if uri
+                h.a **{ href: uri_for_extension(uri, :html) } do |a|
+                  a << id
+                end
+              else
+                h << id
+              end
+            end
+          end
+
+          d1.div **{ class: "doc-type-wrap" } do |d2|
+            d2.div bib.at(ns("./@type"))&.text, **{ class: "doc-type #{bib.at(ns("./@type"))&.text&.downcase}" }
+          end
+        end
+
+        d.div **{ class: "doc-title" } do |d1|
+          d1.send "h#{depth+1}" do |h|
+
+            if uri
+              h.a **{ href: uri_for_extension(uri, :html) } do |a|
+                a << title
+              end
+            else
+              h << title
+            end
+          end
+        end
+
+        d.div **{ class: "doc-info #{bib.at(ns("./status"))&.text&.downcase}" } do |d1|
+          d1.div bib.at(ns("./status"))&.text, **{ class: "doc-stage #{bib.at(ns("./status"))&.text&.downcase}" }
+          d1.div **{ class: "doc-dates" } do |d2|
+            if bib.at(ns("./date[@type = 'published']/on"))
+              d2.div bib.at(ns("./date[@type = 'published']/on"))&.text, **{ class: "doc-published" }
+            end
+            if bib.at(ns("./date[@type = 'updated']/on"))
+              d2.div bib.at(ns("./date[@type = 'updated']/on"))&.text, **{ class: "doc-updated" }
+            end
+          end
+        end
+
+        if id
+          d.div **{ class: "doc-bib" } do |d1|
+            d1.div **{ class: "doc-bib-relaton" } do |d2|
+              d2.a **{ href: URI.escape("#{relaton_root}/id/#{id_code}.xml") } do |a|
+                a << "Relaton XML"
+              end
+            end
+          end
+        end
+
+        if uri
+          d.div **{ class: "doc-access" } do |d1|
+
+            EXTENSION_TYPES.each do |attribs|
+              d1.div **{ class: "doc-access-button-#{attribs[:extension]}" } do |d2|
+                d2.a **{ href: uri_for_extension(uri, attribs[:extension]) } do |a|
+                  a << attribs[:text]
+                end
+              end
+            end
+          end
+        end
+
+        bib.xpath(ns("./relation")).each do |x|
+          iterate(d, x.at(ns("./bibdata | ./relaton-collection")), depth + 1, relaton_root)
+        end
+      end
+    end
+
+  end
+end