metanorma-cli 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6a9cbd149506055cfacef18d4d480b75c749ef06581c37a2f3867e5cb3c7efe
-  data.tar.gz: a5cb8f93eea8b289bcfb078a33f4469b7de71ae9177d547bb310e03915490675
+  metadata.gz: 8fa38ce1860b4256de0f9b4ce25208f31163d83868104767c173f506297613fa
+  data.tar.gz: 90b8fbd71d13c04c842152a4c3e398e2a8764f9e146ca108c060554248e82f60
 SHA512:
-  metadata.gz: b1132b67a377d9102dde1f195de27ae799e72d4129a613fcf81a662b6a75841935267a2777cc784f9f7964a9d176c8cffed9133367573f5b8942af01296f30f7
-  data.tar.gz: a778b63c1890eada45ab18be45a612caa23bf83aa02803fa9a89d5cf389ed404302f81cff9b866ecb430fb924ad228fdc34025276c0000c6049b4b52ad91a41b
+  metadata.gz: bcd81d875a2284810beb475c6034968119c135a8bc972ca5d09a57157c9d22c7c3e9c780867a6b1bf37675c1fc81cb6c1291460e868dd2e34b3e3a088be83815
+  data.tar.gz: 3019e193d3e6d9ece09644a965419f49470f6404de69e1c5e8726536cbc0581649f7ebaa6f7bec40798867c0f2f2a4b37b61a89586dd4212f6a391c5c168e1b1

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    metanorma-cli (1.1.6)
+    metanorma-cli (1.1.7)
+      git (~> 1.5)
       isodoc (~> 0.9.0)
       metanorma (~> 0.3.9)
       metanorma-acme (~> 1.1.0)
@@ -18,6 +19,7 @@ PATH
       metanorma-standoc (~> 1.1.0)
       metanorma-unece (~> 0.0.1)
       nokogiri (>= 1)
+      thor (~> 0.20.3)
 
 GEM
   remote: https://rubygems.org/
@@ -39,17 +41,17 @@ GEM
       nokogiri (>= 1.4.3)
     ffi (1.9.25)
     gb-agencies (0.0.5)
-    gbbib (0.4.3)
+    gbbib (0.4.4)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
       iso-bib-item (~> 0.4.2)
-    html2doc (0.8.9)
+    git (1.5.0)
+    html2doc (0.8.10)
       asciimath (~> 1.0.7)
       htmlentities (~> 4.3.4)
       image_size
       mime-types
       nokogiri
-      ruby-xslt
       thread_safe
       uuidtools
     htmlentities (4.3.4)
@@ -57,21 +59,21 @@ GEM
     iecbib (0.2.2)
       addressable
       iso-bib-item (~> 0.4.2)
-    ietfbib (0.4.5)
+    ietfbib (0.4.6)
       iso-bib-item (~> 0.4.2)
-    iev (0.2.1)
+    iev (0.2.2)
       nokogiri
     image_size (2.0.0)
     iso-639 (0.2.8)
-    iso-bib-item (0.4.4)
+    iso-bib-item (0.4.5)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
-    isobib (0.4.3)
+    isobib (0.4.4)
       algoliasearch
       iecbib (~> 0.2.1)
       iso-bib-item (~> 0.4.2)
-    isodoc (0.9.19)
+    isodoc (0.9.22)
       asciimath
       html2doc (~> 0.8.6)
       htmlentities (~> 4.3.4)
@@ -80,23 +82,22 @@ GEM
       nokogiri (>= 1)
       rake (~> 12.0)
       roman-numerals
-      ruby-xslt
       sassc (~> 1.12.1)
       thread_safe
       uuidtools
     isoics (0.1.7)
     json (2.2.0)
     liquid (4.0.3)
-    metanorma (0.3.10)
+    metanorma (0.3.11)
       asciidoctor
       htmlentities
-    metanorma-acme (1.1.3)
+    metanorma-acme (1.1.4)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       isodoc (~> 0.9.0)
       metanorma-standoc (~> 1.1.0)
       ruby-jing
-    metanorma-csand (1.1.3)
+    metanorma-csand (1.1.5)
       asciidoctor (~> 1.5.7)
       asciimath
       htmlentities (~> 4.3.4)
@@ -106,27 +107,27 @@ GEM
       mime-types
       nokogiri
       ruby-jing
-      ruby-xslt
       thread_safe
       uuidtools
-    metanorma-csd (1.1.3)
+    metanorma-csd (1.1.4)
       isodoc (~> 0.9.6)
       metanorma-standoc (~> 1.1.0)
-    metanorma-gb (1.1.4)
+    metanorma-gb (1.1.5)
       gb-agencies (~> 0.0.4)
+      htmlentities (~> 4.3.4)
       isodoc (~> 0.9.1)
       metanorma-iso (~> 1.1.0)
-      twitter_cldr
+      twitter_cldr (~> 4.4.4)
     metanorma-ietf (1.0.1)
       isodoc (~> 0.9.6)
       metanorma-standoc (~> 1.1.0)
-    metanorma-iso (1.1.4)
+    metanorma-iso (1.1.5)
       asciidoctor (~> 1.5.7)
       iev (~> 0.2.0)
       isodoc (~> 0.9.8)
       metanorma-standoc (~> 1.1.0)
       ruby-jing
-    metanorma-m3d (1.1.3)
+    metanorma-m3d (1.1.5)
       asciidoctor (~> 1.5.7)
       asciimath
       htmlentities (~> 4.3.4)
@@ -136,37 +137,36 @@ GEM
       mime-types
       nokogiri
       ruby-jing
-      ruby-xslt
       thread_safe
       uuidtools
-    metanorma-mpfd (0.1.9)
+    metanorma-mpfd (0.1.10)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       isodoc (~> 0.9.0)
       metanorma-standoc (~> 1.1.0)
       nokogiri
       twitter_cldr
-    metanorma-nist (0.0.5)
+    metanorma-nist (0.0.8)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       isodoc (~> 0.9.0)
       metanorma-standoc (~> 1.1.0)
       ruby-jing
       twitter_cldr
-    metanorma-ogc (0.0.7)
+    metanorma-ogc (0.0.9)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       iso-639
       isodoc (~> 0.9.0)
       metanorma-standoc (~> 1.1.0)
       ruby-jing
-    metanorma-rsd (1.1.3)
+    metanorma-rsd (1.1.4)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       isodoc (~> 0.9.0)
       metanorma-standoc (~> 1.1.0)
       nokogiri
-    metanorma-standoc (1.1.5)
+    metanorma-standoc (1.1.8)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.0)
@@ -176,7 +176,7 @@ GEM
       ruby-jing
       sterile (~> 1.0.14)
       unicode2latex (~> 0.0.1)
-    metanorma-unece (0.0.13)
+    metanorma-unece (0.0.14)
       asciidoctor (~> 1.5.7)
       htmlentities (~> 4.3.4)
       iso-639
@@ -187,9 +187,11 @@ GEM
       twitter_cldr
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
+    mime-types-data (3.2019.0331)
     mini_portile2 (2.3.0)
     mixlib-shellout (2.4.4)
+    nistbib (0.1.2)
+      iso-bib-item (~> 0.4.2)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     optout (0.0.2)
@@ -198,13 +200,14 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.3.2)
+    relaton (0.3.4)
       algoliasearch
       gbbib (~> 0.4.0)
       iecbib (~> 0.2.0)
       ietfbib (~> 0.4.2)
       iso-bib-item (~> 0.4.2)
       isobib (~> 0.4.0)
+      nistbib (~> 0.1.1)
     roman-numerals (0.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -216,10 +219,10 @@ GEM
       rspec-its (~> 1.2)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-its (1.2.0)
+    rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
     rspec-mocks (3.8.0)
@@ -228,9 +231,8 @@ GEM
     rspec-support (3.8.0)
     ruby-jing (0.0.1)
       optout (>= 0.0.2)
-    ruby-xslt (0.9.10)
     ruby_deep_clone (0.8.0)
-    sass (3.7.3)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -240,8 +242,9 @@ GEM
       sass (>= 3.3.0)
     sterile (1.0.14)
       nokogiri
+    thor (0.20.3)
     thread_safe (0.3.6)
-    twitter_cldr (4.4.3)
+    twitter_cldr (4.4.4)
       camertron-eprun
       cldr-plurals-runtime-rb (~> 1.0)
       tzinfo

data/appveyor.yml

@@ -1,5 +1,8 @@
 version: '{build}'
 
+cache:
+  - vendor/bundle
+
 environment:
   matrix:
     - RUBY_VERSION: 25
@@ -17,6 +20,8 @@ install:
 
 build_script:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - set GIT_TERMINAL_PROMPT=0
+  - bundle config --local path vendor/bundle
   - bundle update
   - bundle install
 
@@ -26,4 +31,4 @@ before_test:
   - bundle -v
 
 test_script:
-  - bundle exec rake
+  - bundle exec rake

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/exe/metanorma

@@ -1,5 +1,20 @@
 #!/usr/bin/env ruby
 
+# Note
+#
+# Currently, we are developing a new version for this CLI, and
+# to test it out we adding this environment variable. When the
+# `METANORMA_DEV_MODE` set to `true` then it will revert to the
+# old version of the CLI.
+#
+unless ENV.fetch("METANORMA_DEV_MODE", false) == "true"
+  require "bundler/setup"
+  require "metanorma/cli"
+
+  Metanorma::Cli.start(ARGV)
+  exit 0
+end
+
 require "optparse"
 require "metanorma"
 require "fileutils"
@@ -133,5 +148,4 @@ unless options[:filename]
 end
 
 filename = options[:filename]
-
 Metanorma::Compile.new().compile(filename, options)

data/lib/metanorma/cli.rb

@@ -1,5 +1,6 @@
-require "metanorma/cli/version"
 require "metanorma"
+require "metanorma/cli/version"
+require "metanorma/cli/command"
 
 module Metanorma
   module Cli
@@ -21,10 +22,8 @@ module Metanorma
     ]
 
     def self.load_flavors(flavor_names = SUPPORTED_GEMS)
-      # puts "[metanorma] detecting flavors:"
       flavor_names.each do |flavor|
         begin
-          # puts flavor
           require flavor
         rescue LoadError
           $stderr.puts "[metanorma] Error: flavor gem #{flavor} not present"
@@ -40,5 +39,38 @@ module Metanorma
       load_flavors(flavor_names)
     end
 
+    # Invoking commands
+    #
+    # In the Metanorma CLI, we've included some custom behavior,
+    # like exposing the compiation directly from the root command.
+    #
+    # So, for this use case we first check if the user is actually
+    # trying to compile a document or not, and based on that we'll
+    # compile the document or show the help documentation.
+    #
+    def self.start(arguments)
+      if find_command(arguments).empty?
+        arguments.unshift("compile")
+      end
+
+      Metanorma::Cli::Command.start(arguments)
+    end
+
+    def self.root
+      File.dirname(__dir__)
+    end
+
+    def self.templates_path
+      root_path.join("templates")
+    end
+
+    def self.root_path
+      Pathname.new(Cli.root).join("..")
+    end
+
+    def self.find_command(arguments)
+      commands = Metanorma::Cli::Command.all_commands.keys
+      commands.select { |cmd| arguments.include?(cmd) == true }
+    end
   end
 end

data/lib/metanorma/cli/command.rb

@@ -0,0 +1,75 @@
+require "thor"
+require "metanorma/cli/compiler"
+require "metanorma/cli/generator"
+require "metanorma/cli/git_template"
+
+module Metanorma
+  module Cli
+    class Command < Thor
+      desc "new NAME", "Create new Metanorma document"
+      option :type, aliases: "-t", required: true, desc: "Document type"
+      option :doctype, aliases: "-d", required: true, desc: "Metanorma doctype"
+      option :overwrite, aliases: "-r", desc: "Overwrite existing document"
+      option :template, aliases: "-g", desc: "Git hosted remote template skeleton"
+
+      def new(name)
+        create_new_document(name, options.dup)
+      end
+
+      desc "compile FILENAME", "Compile to a metanorma document"
+      option :type, aliases: "-t", desc: "Type of standard to generate"
+      option :extensions, aliases: "-x", type: :string, desc: "Type of extension to generate per type"
+      option :format, aliases: "-f", default: :asciidoc, desc: "Format of source file: eg. asciidoc"
+      option :require, aliases: "-r", type: :array, desc: "Require LIBRARY prior to execution"
+      option :wrapper, aliases: "-w", type: :boolean, desc: "Create wrapper folder for HTML output"
+      option :asciimath, aliases: "-a", type: :boolean, desc: "Keep Asciimath in XML output instead of converting it to MathM"
+      option :datauriimage, aliases: "-d", type: :boolean, desc: "Encode HTML output images as data URIs"
+      option :relaton, aliases: "-R", desc: "Export Relaton XML for document to nominated filename"
+      option :extract, aliases: "-e", desc: "Export sourcecode fragments from this document to nominated directory"
+      option :version, aliases: "-v", desc: "Print version of code (accompanied with -t)"
+
+      def compile(file_name = nil)
+        if file_name && !options[:version]
+          Metanorma::Cli::Compiler.compile(file_name, options.dup)
+
+        elsif options[:version]
+          invoke(:version, [], type: options[:type] || :iso, format: options[:format])
+
+        elsif options.keys.size >= 2
+          UI.say("Need to specify a file to process")
+
+        else
+          invoke :help
+        end
+      end
+
+      desc "version", "Version of the code"
+      option :type, aliases: "-t", required: true, desc: "Type of standard to generate"
+      option :format, aliases: "-f", default: :asciidoc, desc: "Format of source file: eg. asciidoc"
+
+      def version
+        if options[:format] == :asciidoc
+          UI.say(find_version(options[:type]))
+        end
+      end
+
+      private
+
+      def find_version(type)
+        require "metanorma-#{type}"
+        processor = Metanorma::Registry.instance.find_processor(type.to_sym)
+        processor.version
+      end
+
+      def create_new_document(name, options)
+        Metanorma::Cli::Generator.run(
+          name,
+          type: options[:type],
+          doctype: options[:doctype],
+          template: options[:template],
+          overwrite: options[:overwrite],
+        )
+      end
+    end
+  end
+end