liquidoc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6d540613bd9ce63cedb817ae5faec345f8f1ef6
-  data.tar.gz: b8d3ebaae9154e2c06632288226f0d0d790cba60
+  metadata.gz: 84d0dce2c5baddc6b4b2c9d7a9dffe763ce32a73
+  data.tar.gz: 65d945dcfdb8480a72aa72650adf4e509e7834ed
 SHA512:
-  metadata.gz: 520b0885644503d9ef90e0283423c5eedfa3a53b2c3b6d920dcc60776e8173d770b64a80994e463cdb7a1c5411f1fc11e4d0b7ba43ec9687b349a82940067955
-  data.tar.gz: 760c4c9a0c6315f0c3488db65f839441a91e09e8e596c0c73ec9756443b2de21e21561154fe7db0511e81fdb598edf527567098f5cd6d62e184442d9241c256c
+  metadata.gz: d8e16dd3ae8c7851c1e7f24d0b5a684019d9b7f8e3b93efb8b8713b243e7692ef53150db619e34dc3247f4861e9dae335152aad51f1b754795cb95e59a1cfde8
+  data.tar.gz: a72ffb5946651195885fe70e25739c2476939fd9ebdfd637d96ef56896332fcde81b6cce7555ff311ef79c05890580f1940bfd2c264067fe5a6ae304e9b60d0a

data/lib/liquidoc.rb

@@ -35,32 +35,49 @@ end
 # ===
 
 # Pull in a semi-structured data file, converting contents to a Ruby hash
-def get_data data_file
-  case File.extname(data_file)
-  when ".yml"
+def get_data data
+  # data must be a hash produced by data_hashify()
+  if data['type']
+    if data['type'].downcase == "yaml"
+      data['type'] = "yml"
+    end
+    unless data['type'].downcase.match(/yml|json|xml|csv|regex/)
+      @logger.error "Declared data type must be one of: yaml, json, xml, csv, or regex."
+      raise "DataTypeUnrecognized"
+    end
+  else
+    unless data['ext'].match(/\.yml|\.json|\.xml|\.csv/)
+      @logger.error "Data file extension must be one of: .yml, .json, .xml, or .csv or else declared in config file."
+      raise "FileExtensionUnknown (#{data[ext]})"
+    end
+    data['type'] = data['ext']
+    data['type'].slice!(0) # removes leading dot char
+  end
+  case data['type']
+  when "yml"
     begin
-      return YAML.load_file(data_file)
+      return YAML.load_file(data['file'])
     rescue Exception => ex
       @logger.error "There was a problem with the data file. #{ex.message}"
     end
-  when ".json"
+  when "json"
     begin
-      return JSON.parse(File.read(data_file))
+      return JSON.parse(File.read(data['file']))
     rescue Exception => ex
       @logger.error "There was a problem with the data file. #{ex.message}"
     end
-  when ".xml"
+  when "xml"
     begin
-      data = Crack::XML.parse(File.read(data_file))
+      data = Crack::XML.parse(File.read(data['file']))
       return data['root']
     rescue Exception => ex
       @logger.error "There was a problem with the data file. #{ex.message}"
     end
-  when ".csv"
+  when "csv"
     output = []
     i = 0
     begin
-      CSV.foreach(data_file, headers: true, skip_blanks: true) do |row|
+      CSV.foreach(data['file'], headers: true, skip_blanks: true) do |row|
         output[i] = row.to_hash
         i = i+1
       end
@@ -69,8 +86,13 @@ def get_data data_file
     rescue
       @logger.error "The CSV format is invalid."
     end
-  else
-    @logger.error "The data file is an invalid type. Allowed: .yml, .json, .xml, and .csv."
+  when "regex"
+    if data['pattern']
+      return parse_regex(data['file'], data['pattern'])
+    else
+      @logger.error "You must supply a regex pattern with your free-form data file."
+      raise "MissingRegexPattern"
+    end
   end
 end
 
@@ -92,13 +114,13 @@ def config_build config_file
   validate_config_structure(config)
   if config['compile']
     for src in config['compile']
-      data = @base_dir + src['data']
+      data = src['data']
       for cfgn in src['builds']
         template = @base_dir + cfgn['template']
-        unless cfgn['output'] == "STDOUT" or @output_type == "STDOUT"
+        unless cfgn['output'].downcase == "stdout"
           output = @base_dir + cfgn['output']
         else
-          output = "STDOUT"
+          output = "stdout"
         end
         liquify(data, template, output)
       end
@@ -126,7 +148,7 @@ def validate_file_input file, type
   @logger.debug "Validating input file for #{type} file #{file}"
   error = false
   unless file.is_a?(String) and !file.nil?
-    error = "The #{type} file (#{file}) is not valid."
+    error = "The #{type} filename (#{file}) is not valid."
   else
     unless File.exists?(file)
       error = "The #{type} file (#{file}) was not found."
@@ -135,14 +157,14 @@ def validate_file_input file, type
   unless error
     @logger.debug "Input file validated for #{type} file #{file}."
   else
-    @logger.error
-    raise "Could not validate file input: #{error}"
+    @logger.error "Could not validate input file: #{error}"
+    raise "InvalidInput"
   end
 end
 
 def validate_config_structure config
   unless config.is_a? Hash
-    message =  "The configuration file is not properly structured; it is not a Hash"
+    message =  "The configuration file is not properly structured; it is not a hash"
     @logger.error message
     raise message
   else
@@ -153,16 +175,56 @@ def validate_config_structure config
 # TODO More validation needed
 end
 
+def data_hashify data_var
+  # TODO make datasource config a class
+  if data_var.is_a?(String)
+    data = {}
+    data['file'] = data_var
+    data['ext'] = File.extname(data_var)
+  else # add ext to the hash
+    data = data_var
+    data['ext'] = File.extname(data['file'])
+  end
+  return data
+end
+
+def parse_regex data_file, pattern
+  records = []
+  pattern_re = /#{pattern}/
+  @logger.debug "Using regular expression #{pattern} to parse data file."
+  groups = pattern_re.names
+  begin
+    File.open(data_file, "r") do |file_proc|
+      file_proc.each_line do |row|
+        matches = row.match(pattern_re)
+        if matches
+          row_h = {}
+          groups.each do |var| # loop over the named groups, adding their key & value to the row_h hash
+            row_h.merge!(var => matches[var])
+          end
+          records << row_h # add the row to the records array
+        end
+      end
+    end
+    output = {"data" => records}
+  rescue Exception => ex
+    @logger.error "Something went wrong trying to parse the free-form file. #{ex.class} thrown. #{ex.message}"
+    raise "Freeform parse error"
+  end
+  return output
+end
+
 # ===
 # Liquify BUILD methods
 # ===
 
 # Parse given data using given template, saving to given filename
-def liquify data_file, template_file, output_file
-  @logger.debug "Executing... liquify parsing operation on data file: #{data_file}, template #{template_file}, to #{output_file}."
-  validate_file_input(data_file, "data")
+def liquify data, template_file, output
+  @logger.debug "Executing liquify parsing operation."
+  data = data_hashify(data)
+  validate_file_input(data['file'], "data")
   validate_file_input(template_file, "template")
-  data = get_data(data_file) # gathers the data
+  data = get_data(data) # gathers the data
   begin
     template = File.read(template_file) # reads the template file
     template = Liquid::Template.parse(template) # compiles template
@@ -173,7 +235,8 @@ def liquify data_file, template_file, output_file
     @logger.error message
     raise message
   end
-  unless @output_type == "STDOUT"
+  unless output.downcase == "stdout"
+    output_file = output
     begin
       Dir.mkdir(@output_dir) unless File.exists?(@output_dir)
       File.open(output_file, 'w') { |file| file.write(rendered) } # saves file
@@ -369,7 +432,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_type = "stdout"
   end
 
   opts.on("-h", "--help", "Returns help.") do

data/lib/liquidoc/version.rb

@@ -1,3 +1,3 @@
 module Liquidoc
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liquidoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Dominick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler