liquidoc 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4e5e125a47213d06400c5fa08a7f95009b472919
-  data.tar.gz: 9bbdf6ec04f7d1d0b0a9fd2fbd803a8cdffb592b
+SHA256:
+  metadata.gz: 66391a246f45a5d814fa084fa90dd6d84e86fb5e871b6a539a77451fc1729d62
+  data.tar.gz: 7ccd14f246cc5b0577a81f4bdeff17bd9ecf38af6484c69d9cc3bca3695b3cfa
 SHA512:
-  metadata.gz: bc30b75e6d93d3cd449e1d568d0003e66ee8d2bd69800a7d320ba7944ebb163a2328fa54a502590de0dbe2a145fb1d92a63e9fe2af1c57cf2f0cf5a9889610f3
-  data.tar.gz: dbaeb400887aa6686a321d0e11a87103732361a755b5a34881e4a06f1b048c18ec4859bb2eafac1e34f55d26faea5a33b9154542f75ca917e27e39de98a6e8e2
+  metadata.gz: 02ba0eb644ca0f479b4383cf91eaadbac99cad397dd149d20841d06528338bddaf18fdfcb29ec1d9a8645076be5e2bb5fb87c7abbfce33e3773a882e714bc89a
+  data.tar.gz: fd785c1be75bbfa445190545ef7958307b1e32dbb1af5c27973b7bdddacff87413017b2cd6295acd7306b28a4181d9a226badf038687f3378ab4369ef3264900

data/lib/liquid_tags.rb

@@ -0,0 +1,12 @@
+require 'liquid'
+
+module LiquidTags
+  class IncludeTag < Liquid::Tag
+
+    def initialize(tag_name, markup, tokens)
+      super
+      @tag_name = tag_name
+      return "WORKING!"
+    end
+  end
+end

data/lib/liquidoc.rb

@@ -45,6 +45,9 @@ require 'jekyll'
 @output_filename = 'index'
 @attributes = {}
 @passed_attrs = {}
+@passed_vars = {}
+@passed_configvars = {}
+@parseconfig = false
 @verbose = false
 @quiet = false
 @explicit = false
@@ -66,8 +69,16 @@ FileUtils::mkdir_p("#{@build_dir}/pre") unless File.exists?("#{@build_dir}/pre")
 # ===
 
 # Establish source, template, index, etc details for build jobs from a config file
-def config_build config_file
+def config_build config_file, config_vars={}, parse=false
   @logger.debug "Using config file #{config_file}."
+  if config_vars or parse
+  # If config variables are passed on the CLI, we want to parse the config file
+  # and use the parsed version for the rest fo this routine
+    config_out = "#{@build_dir}/pre/#{File.basename(config_file)}"
+    liquify(nil,config_file, config_out, config_vars)
+    config_file = config_out
+    @logger.debug "Config parsed! Using #{config_out} for build."
+  end
   validate_file_input(config_file, "config")
   begin
     config = YAML.load_file(config_file)
@@ -92,12 +103,15 @@ def iterate_build cfg
     type = step.type
     case type # a switch to evaluate the 'action' parameter for each step in the iteration...
     when "parse"
-      data = DataSrc.new(step.data)
+      if step.data
+        data = DataSrc.new(step.data)
+      end
       builds = step.builds
-      for bld in builds
+      builds.each do |bld|
         build = Build.new(bld, type) # create an instance of the Build class; Build.new accepts a 'bld' hash & action 'type'
         if build.template
           @explainer.info build.message
+          build.add_vars!(@passed_vars) unless @passed_vars.empty?
           liquify(data, build.template, build.output, build.variables) # perform the liquify operation
         else
           regurgidata(data, build.output)
@@ -120,7 +134,7 @@ def iterate_build cfg
         render_doc(doc, build) # perform the render operation
       end
     when "deploy"
-      @logger.warn "Deploy actions are limited and experimental experimental."
+      @logger.warn "Deploy actions are limited and experimental."
       jekyll_serve(build)
     else
       @logger.warn "The action `#{type}` is not valid."
@@ -276,7 +290,11 @@ class BuildConfigStep
             text = ". #{stage}Draws data from `#{self.data[0]}`"
           end
         else
-          text = ". #{stage}Draws data from `#{self.data['file']}`"
+          if self.data
+            text = ". #{stage}Draws data from `#{self.data['file']}`"
+          else
+            text = ". #{stage}Uses data passed via CLI --var options."
+          end
         end
         text.concat("#{reason},") if reason
         text.concat(" and parses it as follows:")
@@ -356,6 +374,11 @@ class Build
     @build['variables']
   end
 
+  def add_vars! vars
+      vars.to_h unless vars.is_a? Hash
+      self.variables.merge!vars
+  end
+
   def message
     # dynamically build a message, possibly appending a reason
     unless @build['message']
@@ -664,9 +687,19 @@ end
 
 # Parse given data using given template, generating given output
 def liquify datasrc, template_file, output, variables=nil
-  input = get_data(datasrc)
-  nested = { "data" => get_data(datasrc)}
-  input.merge!nested
+  if datasrc
+    input = get_data(datasrc)
+    nested = { "data" => get_data(datasrc)}
+    input.merge!nested
+  end
+  if variables
+    if input
+      input.merge!variables
+    else
+      input = variables
+    end
+  end
+  @logger.error "Parse operations need at least a data file or variables." unless input
   validate_file_input(template_file, "template")
   if variables
     vars = { "vars" => variables }
@@ -906,6 +939,7 @@ end
 
 def jekyll_serve build
   # Locally serve Jekyll as per the primary Jekyll config file
+  @logger.debug "Attempting Jekyll serve operation."
   config_file = build.props['files'][0]
   if build.props['arguments']
     opts_args = build.props['arguments'].to_opts_args
@@ -1096,6 +1130,24 @@ command_parser = OptionParser.new do|opts|
     @jekyll_serve = true
   end
 
+  opts.on("--var KEY=VALUE", "For passing variables directly to the 'vars.' scope template via command line, for non-config builds only.") do |n|
+    pair = {}
+    k,v = n.split('=')
+      pair[k] = v
+    @passed_vars.merge!pair
+  end
+
+  opts.on("-x", "--cvar KEY=VALUE", "For sending variables to the 'vars.' scope of the config file and triggering Liquid parsing of config.") do |n|
+    pair = {}
+    k,v = n.split('=')
+      pair[k] = v
+    @passed_configvars.merge!pair
+  end
+
+  opts.on("--parse-config", "Preprocess the designated configuration file as a Liquid template. Superfluous when passing -x/--cvar arguments.") do
+    @parseconfig = true
+  end
+
   opts.on("-h", "--help", "Returns help.") do
     puts opts
     exit
@@ -1117,12 +1169,12 @@ explainer_init
 unless @config_file
   @logger.debug "Executing config-free build based on API/CLI arguments alone."
   if @data_file
-    liquify(@data_file, @template_file, @output_file)
+    liquify(@data_file, @template_file, @output_file, @passed_vars)
   end
   if @index_file
     @logger.warn "Rendering via command line arguments is not yet implemented. Use a config file."
   end
 else
   @logger.debug "Executing... config_build"
-  config_build(@config_file)
+  config_build(@config_file, @passed_configvars, @parseconfig)
 end

data/lib/liquidoc/version.rb

@@ -1,3 +1,3 @@
 module Liquidoc
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquidoc
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Brian Dominick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/liquidoc
+- lib/liquid_tags.rb
 - lib/liquidoc.rb
 - lib/liquidoc/version.rb
 homepage: https://github.com/scalingdata/liquidoc
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A highly configurable command-line tool for parsing data and content in common