config_file_generator 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8b1aaf6ed337b0a74b5bba665c7f4ca79e7563f
-  data.tar.gz: 386af82dee4680bf09267a9bb6d94ac2ca659ae5
+  metadata.gz: bdf04ec67c26d7e8a7752c2d9ef5401f4bad492f
+  data.tar.gz: c0e1a90ed153e57a729e19433b58d4c7dfcbd516
 SHA512:
-  metadata.gz: a72fa690c64ad7071da7abb4e759bf66b3a3f4291d3f2d215f69c361dc9364116d05f8d3128e1f59b7d5bce2350e50fcaf9b722a8416ea26611c19aa28ee9432
-  data.tar.gz: 2a721f4b48284ffb8ffecbb2fde0bf09c20bc9e5095274666d1f1362e252d35674c00cd9f82ec956ff19321fedfdaec896822f5556c814e25b497b0c61db2b74
+  metadata.gz: f0f581ac3ae740d7a097f1aca21deaebae79d11c973bb5eae3ffde84e611f722871be0c9de981525e1d6e3c6f6b09ba84172e751c9a49f4977bc8423aadcabb4
+  data.tar.gz: 59103c6aa983d4f4f3685f0385964ce2ba1b9d3fb71af0e12808b3805b54ab18018df6b7f09b82c2b888d11d40854f324cbef9b279e277349060524e3c453153

data/lib/config_file_generator.rb

@@ -3,29 +3,56 @@ require 'fileutils'
 require 'ostruct'
 require 'yaml'
 
+
 class ConfigFileGenerator
   include ERB::Util
   attr_accessor :environment, :template, :date
 
   # Set up our instance variables so that we can pass them to the template.
   def initialize(template_path: 'deployment/templates', vars: File.join(template_path, 'vars.yml'))
-    @template_vars = load_vars(vars)
     @templates = find_templates(template_path)
+    @template_vars = load_vars(vars)
   end
 
-  # Load variables for use within the templates.
-  # Accepts either a file path or a Hash.
-  def load_vars(vars)
-    if File.file?(vars)
-      YAML.load(File.read(vars))
-    elsif vars.is_a?(Hash)
-      vars
+  # Parse the templates given to the class.
+  # If an output directory is given to this function, write out the parsed templates to files within that
+  #    directory with the same name, without the ".erb"
+  #    Directory structure is also preserved.
+  # If an output directory isn't given, just print out the parsed templates to stdout.
+  #   Basically, this allows for a "dry run" which is useful for testing that your templates are looking solid.
+  def generate(environment, output_directory: File.join('deployment', environment), dry_run: false)
+    if dry_run == true or dry_run.to_s.downcase == 'true'
+      puts "Running generate() in dry_run. Printing parsed templates to stdout instead of to a file:"
+      for template in @templates
+        # Fail early if the template uses variables that weren't passed in.
+        check_required_vars(template, environment)
+        puts "\n~~~~~~~~~~ #{template} ~~~~~~~~~~\n\n"
+        puts render(template, environment)
+      end
     else
-      raise "Either a Hash or a file path is required to load template variables from. " + \
-            "Instead received: #{vars}"
+      for template in @templates
+        # Fail early if the template uses variables that weren't passed in.
+        check_required_vars(template, environment)
+        begin
+          file_name = File.join(output_directory, File.basename(template, '.erb'))
+          File.open(file_name, 'w+') do |f|
+            f.write(render(template, environment))
+          end
+        rescue Errno::ENOENT # if directory path doesn't exist, create it
+          FileUtils.mkdir_p(File.dirname(file_name))
+          retry
+        end
+
+      end
     end
   end
 
+
+  #####################################################
+  #  Private Methods, currently listed in call-order  #
+  #####################################################
+  private
+
   # Returns an array of templates.
   # If a directory is passed in, then it returns all files within that directory (recursively).
   # If a file is passed in, then just that file is returned.
@@ -42,14 +69,23 @@ class ConfigFileGenerator
     end
   end
 
-  def read(file_path)
-    File.read(file_path)
+  # Load variables for use within the templates.
+  # Accepts either a file path or a Hash.
+  def load_vars(vars)
+    if File.file?(vars)
+      YAML.load(File.read(vars))
+    elsif vars.is_a?(Hash)
+      vars
+    else
+      raise "Either a Hash or a file path is required to load template variables from. " + \
+            "Instead received: #{vars}"
+    end
   end
 
   # Get all of the variables used within the template so that we can let the user know which
   # variables they need to be passing in.
   def get_vars_used_in_template(template)
-    read(template).scan(/<%= ?([a-z]+[0-9a-z_]*)/i).uniq.flatten
+    File.read(template).scan(/<%= ?([a-z]+[0-9a-z_]*)/i).uniq.flatten
   end
 
   # Check that the caller passed in one of every variable that is needed by the template. If not, raise.
@@ -71,43 +107,7 @@ class ConfigFileGenerator
   #   must pass render() your class's private binding() instance method (which Ruby provides) as done here.
   def render(template, environment)
     vars = OpenStruct.new(@template_vars[environment]).instance_eval { binding }
-    ERB.new(read(template)).result(vars)
-  end
-
-  # Parse the templates given to the class.
-  # If an output directory is given to this function, write out the parsed templates to files within that
-  #    directory with the same name, without the ".erb"
-  #    Directory structure is also preserved.
-  # If an output directory isn't given, just print out the parsed templates to stdout.
-  #   Basically, this allows for a "dry run" which is useful for testing that your templates are looking solid.
-  def generate(environment, output_directory: File.join('deployment', environment), dry_run: false)
-
-    if dry_run
-      puts "Running generate() in dry_run. Printing parsed templates to stdout instead of to a file:"
-      for template in @templates
-        # Fail early if the template uses variables that weren't passed in.
-        check_required_vars(template, environment)
-        puts "\n~~~~~~~~~~ #{template} ~~~~~~~~~~\n\n"
-        puts render(template, environment)
-      end
-    else
-      for template in @templates
-        # Fail early if the template uses variables that weren't passed in.
-        check_required_vars(template, environment)
-        begin
-          file_name = File.join(output_directory, File.basename(template, '.erb'))
-          File.open(file_name, 'w+') do |f|
-            f.write(render(template, environment))
-          end
-        rescue Errno::ENOENT # if directory path doesn't exist, create it
-          FileUtils.mkdir_p(File.dirname(file_name))
-          retry
-        end
-
-      end
-    end
-
+    ERB.new(File.read(template)).result(vars)
   end
 
-  private :check_required_vars, :find_templates, :get_vars_used_in_template, :load_vars, :read, :render
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config_file_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Austin Curtis