liquidoc 0.11.0 → 0.12.0.pre.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c893b7f373640a5bab823899f7236665074b94f2922bbb651fdddc859efffa9
-  data.tar.gz: b4574f73d3829fb88d005c4340917be3297d0bcc345e6a42870f959b9da69c55
+  metadata.gz: 40a1c127ce84efe07e6762641c2cc16d8248770cf8c8b2e65f5e1ae299ac5fa4
+  data.tar.gz: 35436583f8eb40766990bc1740ef60541160c7d2c4f67b1c71277e1f6f653d68
 SHA512:
-  metadata.gz: 1144cb86dcc7644e54f974a6d303e348f23250aa2015bc44a4b24d6e7627218da5485ca0bf09711136047a1f43df8682fdd504d90bd38f34779c8e52a37954e0
-  data.tar.gz: 3914f320195b2e9fe2376ff29d5730a8f17c38518b4f66f5cd6a5ee1a02ed054efe48bc69c25165ed795db2c813532501356db9ca2900ca824136518de9efe82
+  metadata.gz: 0ad1a76573b551921a54b4595a79621fbbef203f4506882ac30baa3fc71fb40a8a735981340e1f7c70755fb9f660a1aca71ebe4a04fcff56325fc7adbd62c0ee
+  data.tar.gz: 60072de6a7cd07e61dcbf73c43d88d6d816c0509400247c0ba2326a0f4d6eb80c4ad9084563ac34cfad71b4bbf9a0eab2433af7f28aa4ba8fd7afca5fe67dd2f

data/lib/liquidoc.rb

@@ -40,12 +40,11 @@ require 'highline'
 @configs_dir = @base_dir + '_configs'
 @templates_dir = @base_dir + '_templates/'
 @data_dir = @base_dir + '_data/'
-@data_file = nil
+@data_files = nil
 @attributes_file_def = '_data/asciidoctor.yml'
 @attributes_file = @attributes_file_def
 @pdf_theme_file = 'theme/pdf-theme.yml'
 @fonts_dir = 'theme/fonts/'
-@output_filename = 'index'
 @attributes = {}
 @passed_attrs = {}
 @passed_vars = {}
@@ -57,6 +56,7 @@ require 'highline'
 @search_index = false
 @search_index_dry = ''
 @safemode = true
+@render_count = 0
 
 # Instantiate the main Logger object, which is always running
 @logger = Logger.new(STDOUT)
@@ -67,6 +67,7 @@ end
 
 
 FileUtils::mkdir_p("#{@build_dir}") unless File.exists?("#{@build_dir}")
+FileUtils::rm_rf("#{@build_dir}/pre")
 FileUtils::mkdir_p("#{@build_dir}/pre") unless File.exists?("#{@build_dir}/pre")
 
 
@@ -75,17 +76,21 @@ 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, config_vars={}, parse=false
+def config_build config_file, config_vars={}, data_files=nil, parse=false
   @logger.debug "Using config file #{config_file}."
   validate_file_input(config_file, "config")
-  if config_vars.length > 0 or parse or contains_liquid(config_file)
+  if config_vars.length > 0 or data_files or parse or contains_liquid(config_file)
     @logger.debug "Config_vars: #{config_vars.length}"
   # 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)}"
-    vars = DataObj.new()
-    vars.add_data!("vars", config_vars)
-    liquify(vars, config_file, config_out)
+    data_obj = DataObj.new()
+    if data_files
+      payload = get_payload(data_files)
+      data_obj.add_payload!(payload)
+    end
+    data_obj.add_data!(config_vars, "vars")
+    liquify(data_obj, config_file, config_out)
     config_file = config_out
     @logger.debug "Config parsed! Using #{config_out} for build."
     validate_file_input(config_file, "config")
@@ -131,41 +136,23 @@ def iterate_build cfg
       data_obj = DataObj.new()
       if step.data
         data_files = DataFiles.new(step.data)
-        data_files.sources.each do |src|
-          begin
-            data = ingest_data(src) # Extract data from file
-          rescue Exception => ex
-            @logger.error "#{ex.class}: #{ex.message}"
-            raise "DataFileReadFail (#{src.file})"
-          end
-          begin # Create build.data
-            if data_files.sources.size == 1
-              data_obj.add_data!("", data) if data.is_a? Hash
-              # Insert arrays into the data. scope, and for backward compatibility, hashes as well
-              data_obj.add_data!("data", data)
-            else
-              data_obj.add_data!(src.name, data) # Insert object under self-named scope
-            end
-          rescue Exception => ex
-            @logger.error "#{ex.class}: #{ex.message}"
-            raise "DataIngestFail (#{src.file})"
-          end
-        end
+        payload = get_payload(data_files)
+        data_obj.add_payload!(payload)
       end
       builds.each do |bld|
         build = Build.new(bld, type, data_obj) # create an instance of the Build class; Build.new accepts a 'bld' hash & action 'type'
         if build.template
-          # Prep & perform a Liquid-parsed build build
+          # Prep & perform a Liquid-parsed build
           @explainer.info build.message
-          build.add_data!("vars", build.variables) if build.variables
+          build.add_data!(build.variables, "vars") if build.variables
           liquify(build.data, build.template, build.output) # perform the liquify operation
         else # Prep & perform a direct conversion
           # Delete nested data and vars objects
           build.data.remove_scope("data")
           build.data.remove_scope("vars")
           # Add vars from CLI or config args
-          build.data.add_data!("", build.variables) unless build.variables.empty?
-          build.data.add_data!("", @passed_vars) unless @passed_vars.empty?
+          build.data.add_data!(build.variables) unless build.variables.empty?
+          build.data.add_data!(@passed_vars) unless @passed_vars.empty?
           regurgidata(build.data, build.output)
         end
       end
@@ -479,8 +466,8 @@ class Build
     @data unless @data.nil?
   end
 
-  def add_data! obj, scope
-    @data.add_data!(obj, scope)
+  def add_data! data, scope=""
+    @data.add_data!(data, scope)
   end
 
   # def vars
@@ -602,7 +589,7 @@ class Build
     when "render"
       reqs = ["output"]
     end
-    for req in required
+    for req in reqs
       if (defined?(req)).nil?
         raise "ActionSettingMissing"
       end
@@ -612,6 +599,7 @@ class Build
 end # class Build
 
 class DataSrc
+  # Organizes metadata about an ingestible data source
   # initialization means establishing a proper hash for the 'data' param
   def initialize sources
     @datasrc = {}
@@ -679,9 +667,9 @@ end # class DataSrc
 # DataFiles
 class DataFiles
   # Accepts a single String, Hash, or Array
-  # String must be a filename
-  # Hash must contain :file and optionally :type and :pattern
-  # Array must contain filenames as strings
+  # String must be a path/filename
+  # Hash must contain file: and optionally type: and pattern:
+  # Array must contain path/filenames as strings
   # Returns array of DataSrc objects
   def initialize data_sources
     @data_sources = []
@@ -696,6 +684,7 @@ class DataFiles
   end
 
   def sources
+    # An Array of DataSrc objects
     @data_sources
   end
 
@@ -714,13 +703,14 @@ class DataObj
     @data = {"vars" => {}}
   end
 
-  def add_data! scope="", data
+  def add_data! data, scope=""
     # Merges data into existing scope or creates a new scope
     if scope.empty? # store new object at root of this object
       self.data.merge!data
     else # store new object as a subordinate, named object
-      if self.data.key?(scope) # merge into existing key
-        self.data[scope].merge!data
+      if self.data.key?(scope) # merge/append into existing object
+        self.data[scope].merge!data if self.data[scope].is_a? Hash
+        self.data[scope] << data if self.data[scope].is_a? Array
       else # create a new key named after the scope
         scoped_hash = { scope => data }
         self.data.merge!scoped_hash
@@ -728,6 +718,20 @@ class DataObj
     end
   end
 
+  def add_payload! payload
+    # Expects an Array of Hashes ([{name=>String, data=>Object},...])
+    if payload.size == 1
+      # If payload is a single Hash, store it at the root level (no scope)
+      self.add_data!(payload[0]['data']) if payload[0]['data'].is_a? Hash
+      # Insert arrays into the data. scope, and for backward compatibility, hashes as well
+      self.add_data!(payload[0]['data'], "data")
+    end
+    # For ALL payloads, create a self-named obj scope
+    payload.each do |obj|
+      self.add_data!(obj['data'], obj['name']) # Insert object under self-named scope
+    end
+  end
+
   def data
     @data
   end
@@ -770,7 +774,25 @@ end
 # PARSE-type build procs
 # ===
 
-# Pull in a semi-structured data file, converting contents to a Ruby hash
+def get_payload data_files
+  # data_files: a proper DataFile object
+  payload = []
+  data_files.sources.each do |src|
+    obj = {}
+    begin
+      data = ingest_data(src) # Extract data from file
+    rescue Exception => ex
+      @logger.error "#{ex.class}: #{ex.message}"
+      raise "DataFileReadFail (#{src.file})"
+    end
+    obj['name'] = src.name
+    obj['data'] = data
+    payload << obj
+  end
+  return payload
+end
+
+# Pull in a semi-structured data file, converting contents to a Ruby object
 def ingest_data datasrc
   raise "InvalidDataSrcObject" unless datasrc.is_a? DataSrc
   case datasrc.type
@@ -862,22 +884,26 @@ def liquify data_obj, template_file, output
   end
 end
 
-def cli_liquify data_file=nil, template_file=nil, output_file=nil, passed_vars
+def cli_liquify data_files=nil, template_file=nil, output_file=nil, passed_vars
   # converts command-line options into liquify or regurgidata inputs
   data_obj = DataObj.new()
-  if data_file
-    df = DataFiles.new(data_file)
-    ingested = ingest_data(df.sources[0])
-    data_obj.add_data!("", ingested)
+  if output_file
+    output = output_file
+  else
+    output = "stdout"
+  end
+  if data_files
+    payload = get_payload(data_files)
+    data_obj.add_payload!(payload)
   end
   if template_file
-    data_obj.add_data!("data", ingested) if df
-    data_obj.add_data!("vars", passed_vars) if passed_vars
-    liquify(data_obj, template_file, output_file)
+    # data_obj.add_data!(ingested, "data") if df
+    data_obj.add_data!(passed_vars, "vars") if passed_vars
+    liquify(data_obj, template_file, output)
   else
     data_obj.remove_scope("vars")
-    data_obj.add_data!("", passed_vars) if passed_vars
-    regurgidata(data_obj, output_file)
+    data_obj.add_data!(passed_vars) if passed_vars
+    regurgidata(data_obj, output)
   end
 end
 
@@ -999,6 +1025,8 @@ def derive_backend type, out_file
 end
 
 def render_doc doc, build
+  @render_count += 1
+  @logger.info "### Build ##{@render_count}"
   case build.backend
   when "html5", "pdf"
     asciidocify(doc, build)
@@ -1042,6 +1070,7 @@ def asciidocify doc, build
   # Perform the aciidoctor convert
   if build.backend == "pdf"
     @logger.info "Generating PDF. This can take some time..."
+    attrs.merge!({"pdf-theme"=>build.style}) if build.style
   end
   Asciidoctor.convert_file(
     doc.index,
@@ -1053,7 +1082,7 @@ def asciidocify doc, build
     safe: "unsafe",
     sourcemap: true,
     verbose: @verbose,
-    mkdirs: true
+    mkdirs: true,
   )
   @logger.info "Rendered file #{to_file}."
 end
@@ -1069,18 +1098,19 @@ def generate_site doc, build
     attrs.merge!(build.attributes) if build.attributes
     attrs = {"asciidoctor" => {"attributes" => attrs} }
     attrs_yaml = attrs.to_yaml # Convert it all back to Yaml, as we're going to write a file to feed back to Jekyll
-    File.open("#{@build_dir}/pre/_attributes.yml", 'w') { |file| file.write(attrs_yaml) }
-    build.add_config_file("#{@build_dir}/pre/_attributes.yml")
+    File.open("#{@build_dir}/pre/attributes_#{@render_count}.yml", 'w') { |file| file.write(attrs_yaml) }
+    build.add_config_file("#{@build_dir}/pre/attributes_#{@render_count}.yml")
     config_list = build.prop_files_array.join(',') # flatten the Array back down for the CLI
     quiet = "--quiet" if @quiet || @explicit
     if build.props['arguments']
-      opts_args_file = "#{@build_dir}/pre/jekyll_opts_args.yml"
+      opts_args_file = "#{@build_dir}/pre/jekyll_opts_args_#{@render_count}.yml"
       opts_args = build.props['arguments']
       File.open(opts_args_file, 'w') { |file|
       file.write(opts_args.to_yaml)}
       config_list << ",#{opts_args_file}"
     end
     base_args = "--config #{config_list}"
+    base_args += " --trace" if @verbose
     command = "bundle exec jekyll build #{base_args} #{quiet}"
     if @search_index
       # TODO enable config-based admin api key ingest once config is dynamic
@@ -1268,6 +1298,16 @@ module CustomFilters
     input.to_s.gsub(Regexp.new(regex), replacement.to_s)
   end
 
+  def to_yaml input
+    o = input.to_yaml
+    o = o.gsub(/^\-\-\-$\n/, "")
+    o
+  end
+
+  def to_json input
+    o = input.to_json
+    o
+  end
 end
 
 # register custom Liquid filters
@@ -1303,8 +1343,10 @@ command_parser = OptionParser.new do|opts|
     @config_file = @base_dir + n
   end
 
-  opts.on("-d PATH", "--data=PATH", "Semi-structured data source (input) path. Ex. path/to/data.yml. Required unless --config is called." ) do |n|
-    @data_file = @base_dir + n
+  opts.on("-d PATH[,PATH]", "--data=PATH[,PATH]", "Semi-structured data source (input) path or paths. Ex. path/to/data.yml or data/file1.yml,data/file2.json. Required unless --config is called; optional with config." ) do |n|
+    data_files = n.split(',')
+    data_files = data_files.map! {|file| @base_dir + file}
+    @data_files = DataFiles.new(data_files)
   end
 
   opts.on("-f PATH", "--from=PATH", "Directory to copy assets from." ) do |n|
@@ -1316,7 +1358,7 @@ command_parser = OptionParser.new do|opts|
   end
 
   opts.on("-o PATH", "--output=PATH", "Output file path for generated content. Ex. path/to/file.adoc. Required unless --config is called.") do |n|
-    @output_file = @base_dir + n
+    @output = @base_dir + n
   end
 
   opts.on("-t PATH", "--template=PATH", "Path to liquid template. Required unless --configuration is called." ) do |n|
@@ -1341,7 +1383,7 @@ command_parser = OptionParser.new do|opts|
   end
 
   opts.on("--stdout", "Puts the output in STDOUT instead of writing to a file.") do
-    @output_type = "stdout"
+    @output = "stdout"
   end
 
   opts.on("--deploy", "EXPERIMENTAL: Trigger a jekyll serve operation against the destination dir of a Jekyll render step.") do
@@ -1396,13 +1438,13 @@ explainer_init
 
 unless @config_file
   @logger.debug "Executing config-free build based on API/CLI arguments alone."
-  if @data_file
-    cli_liquify(@data_file, @template_file, @output_file, @passed_vars)
+  if @data_files
+    cli_liquify(@data_files, @template_file, @output, @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, @passed_vars, @parseconfig)
+  config_build(@config_file, @passed_vars, @data_files, @parseconfig)
 end

data/lib/liquidoc/version.rb

@@ -1,3 +1,3 @@
 module Liquidoc
-  VERSION = "0.11.0"
+  VERSION = "0.12.0-rc5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquidoc
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.pre.rc5
 platform: ruby
 authors:
 - Brian Dominick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: asciidoctor-pdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0.alpha.16
+        version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0.alpha.16
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: jekyll-asciidoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +177,7 @@ files:
 - bin/liquidoc
 - lib/liquidoc.rb
 - lib/liquidoc/version.rb
-homepage: https://github.com/scalingdata/liquidoc
+homepage: https://github.com/DocOps/liquidoc
 licenses:
 - MIT
 metadata: