filegen 0.0.1 → 0.1.1

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: -t @wip:3
+all: -t ~@wip

data/features/evaluate_template.feature

@@ -0,0 +1,134 @@
+Feature: Evaluate Template
+
+  As a user
+  I want to evaluate a template
+  In order to generate a file
+
+  Scenario: Existing file
+    Given a file named "template.erb" with:
+    """
+    Hello World!
+    """
+    When I successfully run `filegen template.erb`
+    Then the output should contain:
+    """
+    Hello World!
+    """
+
+  Scenario: Uses env variables in template
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('NAME') %>!
+    """
+    And I set the environment variables to:
+      | variable | value |
+      | NAME     | Karl  |
+    When I successfully run `filegen template.erb`
+    Then the output should contain:
+    """
+    Hello Karl
+    """
+
+  Scenario: Non existing file
+    When I run `filegen template1.erb`
+    Then the stderr should contain:
+    """
+    File "template1.erb" does not exist
+    """
+
+  Scenario: Non erb file
+    Given an empty file named "template1.abc"
+    When I run `filegen template1.abc`
+    Then the stderr should contain:
+    """
+    File "template1.abc" is not a valid erb template: file ending erb
+    """
+
+  Scenario: YAML file as input (short)
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('name') %>!
+    """
+    And a file named "input.yaml" with:
+    """
+    ---
+    name: Karl
+    """
+    When I run `filegen -y input.yaml template.erb`
+    Then the output should contain:
+    """
+    Hello Karl!
+    """
+
+  Scenario: YAML file as input (long)
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('name') %>!
+    """
+    And a file named "input.yaml" with:
+    """
+    ---
+    name: Karl
+    """
+    When I run `filegen --yaml-file input.yaml template.erb`
+    Then the output should contain:
+    """
+    Hello Karl!
+    """
+  
+  Scenario: Define order of data sources for lookup (env first)
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('NAME') %>!
+    """
+    And a file named "input.yaml" with:
+    """
+    ---
+    NAME: Karl
+    """
+    And I set the environment variables to:
+      | variable | value |
+      | NAME     | Egon  |
+    When I run `filegen --yaml-file input.yaml --data-sources env,yaml template.erb`
+    Then the output should contain:
+    """
+    Hello Egon!
+    """
+
+  Scenario: Define order of data sources for lookup (yaml first)
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('NAME') %>!
+    """
+    And a file named "input.yaml" with:
+    """
+    ---
+    NAME: Karl
+    """
+    And I set the environment variables to:
+      | variable | value |
+      | NAME     | Egon  |
+    When I run `filegen --yaml-file input.yaml --data-sources yaml,env template.erb`
+    Then the output should contain:
+    """
+    Hello Karl!
+    """
+
+  Scenario: Leaving out a data source
+    Given a file named "template.erb" with:
+    """
+    Hello <%= lookup('NAME') %>!
+    """
+    And a file named "input.yaml" with:
+    """
+    ---
+    NAME: Karl
+    """
+    And I set the environment variables to:
+      | variable | value |
+      | NAME     | Egon  |
+    When I run `filegen --yaml-file input.yaml --data-sources yaml template.erb`
+    Then the output should contain:
+    """
+    Hello Karl!
+    """

data/features/output_meta_data.feature

@@ -0,0 +1,20 @@
+Feature: Output metadata
+
+  As a user
+  I want to get some meta data about the script
+  In order to use it better
+
+#  Scenario: Version (short)
+#    Given I successfully run `filegen -v`
+#    Then the output should contain:
+#    """
+#    Version:
+#    """
+#
+#  Scenario: Version (long)
+#    Given I successfully run `filegen --version`
+#    Then the output should contain:
+#    """
+#    Version:
+#    """
+#

data/features/step_definitions.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+Then /then environment contains the following variables/ do
+  $stderr.printf("%20s | %-20s\n", 'key', 'value')
+  $stderr.printf("%20s+%-20s\n", '-' * 21 , '-' * 21)
+
+  ENV.to_hash.sort_by { |key, value| key }.each do |key, value|
+    $stderr.printf("%20s | %-20s\n", key, value)
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+
+unless ENV['CI'] == 'true'
+  require 'debugger'
+  require 'pry'
+end
+
+require 'simplecov'
+SimpleCov.command_name 'cucumber'
+
+require 'filegen'
+include Filegen
+
+require 'aruba'
+require 'aruba/in_process'
+require 'aruba/cucumber'
+
+Aruba::InProcess.main_class = Filegen::Runner
+Aruba.process = Aruba::InProcess

data/filegen.gemspec

@@ -4,20 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'filegen/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "filegen"
+  spec.name          = 'filegen'
   spec.version       = Filegen::VERSION
-  spec.authors       = ["Dennis Günnewig"]
-  spec.email         = ["dg1@vrnetze.de"]
+  spec.authors       = ['Dennis Günnewig']
+  spec.email         = ['dg1@vrnetze.de']
   spec.description   = %q{Evaluate erb templates}
-  spec.summary       = %q{This helper takes an erb template and provides access to environment variables within that template}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.summary       = %q{This helper takes an erb template and provides access to environment variables and a yaml file within that template}
+  spec.homepage      = 'https://github.com/dg-vrnetze/filegen'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'moneta'
 end

data/lib/filegen.rb

@@ -1,9 +1,19 @@
+# encoding: utf-8
 require 'erb'
+require 'moneta'
+require 'optparse'
+require 'forwardable'
+require 'ostruct'
 
 require 'filegen/version'
 require 'filegen/runner'
 require 'filegen/options'
-require 'filegen/env'
+require 'filegen/data'
 require 'filegen/erb_generator'
+require 'filegen/data_source_builder'
+require 'filegen/data_sources/environment'
+require 'filegen/data_sources/yaml'
+require 'filegen/exceptions'
 
+# Main class
 module Filegen; end

data/lib/filegen/data.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# Main Class
+module Filegen
+  # This class is used as context for the erb-template
+  class Data
+    private
+
+    attr_reader :data_sources
+
+    public
+
+    # Create context class
+    #
+    # @param [Array,DataSource] data_sources
+    #   The data sources which should be available for variable lookup
+    def initialize(data_sources)
+      @data_sources = Array(data_sources)
+    end
+
+    # Lookup a variable within the data sources
+    #
+    # @param [String] variable
+    #   The variable to lookup
+    # @return [String]
+    #   The value of the variable
+    def lookup(variable)
+      try_to_fetch_unless_found_or_end(variable)
+    end
+
+    # Make the binding of the class available
+    # @return [Binding]
+    def instance_binding
+      binding
+    end
+
+    private
+
+    def try_to_fetch_unless_found_or_end(variable)
+      result = nil
+
+      data_sources.each do |s|
+        (result = s.fetch(variable)) && (return result)
+      end
+
+      ''
+    end
+  end
+end

data/lib/filegen/data_source_builder.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module Filegen
+  # Build data sources
+  class DataSourceBuilder
+    private
+
+    attr_reader :params
+
+    public
+
+    # @!attribute [r] sources
+    #   Return the sources generated
+    attr_reader :sources
+
+    # Create the data source builder
+    #
+    # @param [OpenStruct] params
+    #   the params instance which contains all parameter of the commandline utility
+    def initialize(params)
+      @params = params
+
+      validate_data_sources
+
+      @sources = []
+      chosen_data_sources.each do |o|
+        @sources << known_data_source_builders[o]
+      end
+    end
+
+    private
+
+    def chosen_data_sources
+      params.data_sources
+    end
+
+    def known_data_source_builders
+      params.data_source_builders
+    end
+
+    def allowed_data_sources
+      known_data_source_builders.keys
+    end
+
+    def validate_data_sources
+      invalid_data_sources = chosen_data_sources - allowed_data_sources
+      fail Exceptions::InvalidDataSources, "Unknown data source#{invalid_data_sources.size > 1 ? 's' : ''} \"#{invalid_data_sources.join(', ')}\" found." unless invalid_data_sources.empty?
+    end
+  end
+end

data/lib/filegen/data_sources.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module Filegen
+  # Contains all data sources which can be used in template
+  module DataSources; end
+end

data/lib/filegen/data_sources/environment.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Filegen
+  module DataSources
+    # Data source which makes environment variables available
+    class Environment
+      extend Forwardable
+
+      # @!method fetch(key, default_value=nil)
+      #    Fetch value for key from data source
+      def_delegator :@source, :fetch, :fetch
+
+      # Create data source
+      def initialize
+        @source = Moneta.build do
+          use :Transformer, key: :to_s, value: []
+          adapter :Memory, backend: ENV
+        end
+      end
+    end
+  end
+end

data/lib/filegen/data_sources/yaml.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+module Filegen
+  module DataSources
+    # Data source which makes yaml files available
+    class Yaml
+      extend Forwardable
+
+      # @!method fetch(key, default_value=nil)
+      #    Fetch value for key from data source.
+      def_delegator :@source, :fetch, :fetch
+
+      # Create data source
+      def initialize(file)
+        @source = Moneta.new(:YAML, file: file)
+      end
+    end
+  end
+end

data/lib/filegen/erb_generator.rb

@@ -1,15 +1,30 @@
 # encoding: utf-8
 module Filegen
+  # Used to generate the template
   class ErbGenerator
-    attr_reader :template_binding
+    private
 
-    def initialize(template_binding)
-      @template_binding = template_binding
+    attr_reader :data
+
+    public
+
+    # Create erb generator
+    #
+    # @param [Data] data
+    #   The data class to be used within the template
+    def initialize(data)
+      @data = data
     end
 
-    def compile(source,destination)
-      destination.puts ERB.new(source).result(template_binding)
+    # Compile the template
+    #
+    # @param [IO] source
+    #   The source template to be used
+    # @param [IO] destination
+    #   The output io handle
+    def compile(source, destination)
+      erb = ERB.new(source.read)
+      destination.puts erb.result(data.instance_binding)
     end
   end
-
 end

data/lib/filegen/exceptions.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module Filegen
+  # Exceptions
+  module Exceptions
+    # raised if order arguments are invalid
+    class InvalidDataSources < Exception; end
+  end
+end

data/lib/filegen/options.rb

@@ -1,24 +1,95 @@
 # encoding: utf-8
 module Filegen
+  # Commandline parser
   class Options
-    attr_reader :template
+    private
 
+    attr_reader :params
+
+    public
+
+    # Create commandline parser
+    #
+    # @param [Array] argv
+    #   The array which contains the commandline arguments
     def initialize(argv)
-      @template = argv.first.to_s
+      @params = parse_options(argv)
     end
 
+    # Source template
+    #
+    # @return [File]
+    #   Returns a file handle for the template
     def source
-      return File.read(template) if valid_template?
+      validate_source
 
-      fail "File does not exist or is not a erb file!"
+      File.new(params.template)
     end
 
+    # Destination for output
+    #
+    # @return [IO]
+    #   Returns a file handle for the output
     def destination
       $stdout
     end
 
-    def valid_template?
-      File.exists?(template) && /.erb$/ === File.basename(template)
+    # The data sources which can be used
+    #
+    # @return [Array]
+    #   An array of data sources which can be used
+    def data_sources
+      DataSourceBuilder.new(params).sources
+    end
+
+    private
+
+    def parse_options(argv)
+      params = OpenStruct.new
+      parser = OptionParser.new
+
+      params.data_sources = [:env]
+      params.data_source_builders = {}
+      params.data_source_builders[:env]  = DataSources::Environment.new
+
+      parser.on('-y', '--yaml-file FILE', 'YAML-file to look for variables') do |f|
+        params.yaml_file = f
+        params.data_sources << :yaml
+        params.data_source_builders[:yaml] = DataSources::Yaml.new(params.yaml_file)
+      end
+
+      parser.on('-d', '--data-sources a,b', Array,  'Order for variable lookup: yaml, env (default: env or env,yaml if yaml-file-option is given)') do |l|
+        params.data_sources = l.map(&:to_sym)
+      end
+
+      parser.on_tail('-h', '--help', 'Show this message') do
+        $stderr.puts parser
+        exit
+      end
+
+      parser.on_tail('-v', '--version', 'Show version') do
+        $stderr.puts Filegen::VERSION
+        exit
+      end
+
+      params.template = parser.parse(argv).first
+
+      params
+    end
+
+    def validate_source
+      fail "File \"#{params.template}\" does not exist" unless exists?
+      fail "File \"#{params.template}\" is not a valid erb template: file ending erb" unless erb_template?
+    end
+
+    def exists?
+      File.exists?(params.template)
+    end
+
+    def erb_template?
+      # rubocop:disable CaseEquality
+      /.erb$/ === File.basename(params.template)
+      # rubocop:enable CaseEquality
     end
   end
 end