liquidoc 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b5d860a86e2b0c934b1cfc196df2a4ff6c92261eeea9770259716874f4b27f
-  data.tar.gz: 81e2e73815e12bccd7c4c09217ba1d86f6d8a96e4584842ebe2d2668958fe341
+  metadata.gz: 8f251c6530c83d406052a8adc81a10048a65be63f7041bb3a8d9e6031514f69a
+  data.tar.gz: 104ba3413ecc11bbee5afd5064ac818287a2a27164fb6943c65dbb41625359c3
 SHA512:
-  metadata.gz: b2c552ee847fc84d2a45333f00923c8a1d5305fa3db8a4c262b2ebfec7da234222471e7e5a88e72edff1b9c88213a092d9fc2caa083a671f56a05f406ccd3d7c
-  data.tar.gz: 60fa6c8196d38b609f5a59f8d922c89d25926d4122bb437e82b455a3c3ad2902b61bb6c9269e59acff97c425c6a11b02e0b7e97f2da1bc74409251098d43f2fd
+  metadata.gz: '09bacdea17f0eaa5e2f26db3705031801c05b3730d9ea82b37294351d1acc1a01110621ea301099d7f5b170e334c2aa3be5bace5d2e85f14c2819ffd12bdd5b2'
+  data.tar.gz: 33da833e1f3b747e87747edf4a731a04aea4bcc4da6ca48a5af8c6d7f4a25049c9ebaf5cbf89f51476e1c107e63ea08b2b5d60fa27fa956b48fa48ab3f14815f

data/lib/liquidoc.rb

@@ -10,6 +10,8 @@ require 'csv'
 require 'crack/xml'
 require 'fileutils'
 require 'jekyll'
+require 'open3'
+require 'highline'
 
 # ===
 # Table of Contents
@@ -53,6 +55,7 @@ require 'jekyll'
 @explicit = false
 @search_index = false
 @search_index_dry = ''
+@safemode = true
 
 # Instantiate the main Logger object, which is always running
 @logger = Logger.new(STDOUT)
@@ -95,6 +98,20 @@ def config_build config_file, config_vars={}, parse=false
     raise "ConfigFileError"
   end
   cfg = BuildConfig.new(config) # convert the config file to a new object called 'cfg'
+  if @safemode
+    commands = ""
+    cfg.steps.each do |step|
+      if step['action'] == "execute"
+        commands = commands + "> " + step['command'] + "\n"
+      end
+    end
+    unless commands.to_s.strip.empty?
+      puts "\nWARNING: This routine will execute the following shell commands:\n\n#{commands}"
+      ui = HighLine.new
+      answer = ui.ask("\nDo you approve? (YES/no): ")
+      raise "CommandExecutionsNotAuthorized" unless answer.strip == "YES"
+    end
+  end
   iterate_build(cfg)
 end
 
@@ -144,6 +161,9 @@ def iterate_build cfg
     when "deploy"
       @logger.warn "Deploy actions are limited and experimental."
       jekyll_serve(build)
+    when "execute"
+      @logger.info "Executing shell command: #{step.command}"
+      execute_command(step)
     else
       @logger.warn "The action `#{type}` is not valid."
     end
@@ -213,6 +233,23 @@ def explainer_init out=nil
   end
 end
 
+def generate_file content, target
+  base_path = File.dirname(target)
+  begin
+    FileUtils::mkdir_p(base_path) unless File.exists?(base_path)
+    File.open(target, 'w') { |file| file.write(content) } # saves file
+  rescue Exception => ex
+    @logger.error "Failed to save output.\n#{ex.class} #{ex.message}"
+    raise "FileNotBuilt"
+  end
+  if File.exists?(target)
+    @logger.info "File built: #{target}"
+  else
+    @logger.error "Hrmp! File not built."
+    raise "FileNotBuilt"
+  end
+end
+
 # ===
 # Core classes
 # ===
@@ -280,6 +317,10 @@ class BuildConfigStep
     return @step['options']
   end
 
+  def command
+    return @step['command']
+  end
+
   def stage
     return @step['stage']
   end
@@ -345,6 +386,8 @@ class BuildConfigStep
       reqs = ["source,target"]
     when "render"
       reqs = ["builds"]
+    when "execute"
+      reqs = ["command"]
     end
     for req in reqs
       if (defined?(@step[req])).nil?
@@ -745,20 +788,7 @@ def liquify datasrc, template_file, output, variables=nil
   end
   unless output.downcase == "stdout"
     output_file = output
-    base_path = File.dirname(output)
-    begin
-      FileUtils::mkdir_p(base_path) unless File.exists?(base_path)
-      File.open(output_file, 'w') { |file| file.write(rendered) } # saves file
-    rescue Exception => ex
-      @logger.error "Failed to save output.\n#{ex.class} #{ex.message}"
-      raise "FileNotBuilt"
-    end
-    if File.exists?(output_file)
-      @logger.info "File built: #{output_file}"
-    else
-      @logger.error "Hrmp! File not built."
-      raise "FileNotBuilt"
-    end
+    generate_file(rendered, output_file)
   else # if stdout
     puts "========\nOUTPUT: Rendered with template #{template_file}:\n\n#{rendered}\n"
   end
@@ -924,9 +954,6 @@ def asciidocify doc, build
   if build.backend == "pdf"
     @logger.info "Generating PDF. This can take some time..."
   end
-
-
-
   Asciidoctor.convert_file(
     doc.index,
     to_file: to_file,
@@ -1018,6 +1045,38 @@ def algolia_index_cmd build, apikey=nil, args
   end
 end
 
+# ===
+# Execute
+# ===
+
+def execute_command cmd
+  stdout, stderr, status = Open3.capture3(cmd.command)
+  failed = true if status.to_s.include?("exit 1")
+  unless cmd.options
+    puts stdout
+    puts stderr if failed
+  else
+    if failed && cmd.options['error']
+      @logger.warn cmd.options['error']['message'] if cmd.options['error']['message']
+      if cmd.options['error']['response'] == "exit"
+        @logger.error "Command failure: #{stderr}"
+        raise "CommandExecutionException"
+      end
+    end
+    if cmd.options['outfile']
+      contents = stdout
+      if cmd.options['outfile']
+        contents = "#{cmd.options['outfile']['prepend']}\n#{stdout}" if cmd.options['outfile']['prepend']
+        contents = "#{stdout}/n#{cmd.options['outfile']['append']}" if cmd.options['outfile']['append']
+        generate_file(contents, cmd.options['outfile']['path'])
+      end
+      if cmd.options['stdout']
+        puts stdout
+      end
+    end
+  end
+end
+
 # ===
 # Text manipulation Classes, Modules, procs, etc
 # ===
@@ -1224,6 +1283,10 @@ command_parser = OptionParser.new do|opts|
     @parseconfig = true
   end
 
+  opts.on("--unsafe", "Enable shell command executions without interactive check.") do
+    @safemode = false
+  end
+
   opts.on("-h", "--help", "Returns help.") do
     puts opts
     exit

data/lib/liquidoc/version.rb

@@ -1,3 +1,3 @@
 module Liquidoc
-  VERSION = "0.9.5"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquidoc
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors:
 - Brian Dominick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,132 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0.alpha.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0.alpha.16
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-asciidoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: LiquiDoc conveniently harnesses the power of Liquid templates, flat-file
   data formats such as YAML, JSON, XML, and CSV, as well as AsciiDoc markup and powerful
   Asciidoctor output capabilities -- all in a single command-line tool.
@@ -49,7 +175,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/liquidoc
-- lib/asciidoctor/xref-stripper-preprocessor.rb
 - lib/liquidoc.rb
 - lib/liquidoc/version.rb
 homepage: https://github.com/scalingdata/liquidoc
@@ -65,12 +190,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/lib/asciidoctor/xref-stripper-preprocessor.rb

@@ -1,13 +0,0 @@
-require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
-
-include Asciidoctor
-
-Extensions.register {
-  preprocessor {
-    process {|document, reader|
-      Reader.new reader.readlines.map {|l|
-        (l.empty? || (l.start_with? '=')) ? l : %(#{l} +)
-      }
-    }
-  }
-}