filegen 0.2.1 → 0.2.2

data/.rubocop.yml

@@ -8,3 +8,4 @@ AllCops:
     - '**/Rakefile'
   Excludes:
     - vendor/**
+    - lib/filegen/version.rb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.2: 2014-01-14
+  * Better error messages if template file name is missing
+  * Refactoring of ui messages
+  * Cleaning up rubocop offences
+
 0.2.1: 2014-01-14
   * Add documentation for default value support
 

data/features/error_handling.feature

@@ -0,0 +1,28 @@
+Feature: Error handling
+
+  As a user
+  I want to get good error message
+  In order to fix my mistakes
+
+  Scenario: Missing file name
+    When I run `filegen`
+    Then the output should contain:
+    """
+    Template file name is missing.
+    """
+
+  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
+    """
+

data/features/evaluate_template.feature

@@ -29,21 +29,6 @@ Feature: Evaluate Template
     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:
     """

data/lib/filegen.rb

@@ -4,8 +4,10 @@ require 'moneta'
 require 'optparse'
 require 'forwardable'
 require 'ostruct'
+require 'logger'
 
 require 'filegen/version'
+require 'filegen/ui'
 require 'filegen/runner'
 require 'filegen/options'
 require 'filegen/data'

data/lib/filegen/data.rb

@@ -23,7 +23,7 @@ module Filegen
     #   The variable to lookup
     # @return [String]
     #   The value of the variable
-    def lookup(variable, default_value='')
+    def lookup(variable, default_value = '')
       try_to_fetch_unless_found_or_end(variable) || default_value
     end
 

data/lib/filegen/data_source_builder.rb

@@ -43,7 +43,7 @@ module Filegen
 
     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?
+      fail Exceptions::DataSourcesAreInvalid, "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/exceptions.rb

@@ -3,6 +3,15 @@ module Filegen
   # Exceptions
   module Exceptions
     # raised if order arguments are invalid
-    class InvalidDataSources < Exception; end
+    class DataSourcesAreInvalid < RuntimeError; end
+
+    # raised if one forgot to tell the script the template name
+    class TemplateNameIsMissing < RuntimeError; end
+
+    # raised if template given on commandline does not exist
+    class TemplateDoesNotExist < RuntimeError; end
+
+    # raised if one uses an invalid template name (missing erb)
+    class TemplateNameIsInvalid < RuntimeError; end
   end
 end

data/lib/filegen/options.rb

@@ -14,6 +14,8 @@ module Filegen
     #   The array which contains the commandline arguments
     def initialize(argv)
       @params = parse_options(argv)
+
+      validate_params
     end
 
     # Source template
@@ -21,8 +23,6 @@ module Filegen
     # @return [File]
     #   Returns a file handle for the template
     def source
-      validate_source
-
       File.new(params.template)
     end
 
@@ -44,10 +44,20 @@ module Filegen
 
     private
 
+    def validate_params
+      validate_source
+    end
+
+    # rubocop:disable MethodLength
     def parse_options(argv)
       params = OpenStruct.new
       parser = OptionParser.new
 
+      parser.banner = 'Usage: filegen [options] <template>'
+
+      parser.separator ''
+      parser.separator 'Specific options:'
+
       params.data_sources = [:env]
       params.data_source_builders = {}
       params.data_source_builders[:env]  = DataSources::Environment.new
@@ -62,6 +72,9 @@ module Filegen
         params.data_sources = l.map(&:to_sym)
       end
 
+      parser.separator ''
+      parser.separator 'Common options:'
+
       parser.on_tail('-h', '--help', 'Show this message') do
         $stderr.puts parser
         exit
@@ -76,10 +89,16 @@ module Filegen
 
       params
     end
+    # rubocop:enable MethodLength
 
     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?
+      fail Exceptions::TemplateNameIsMissing, 'Template file name is missing.' if empty?
+      fail Exceptions::TemplateDoesNotExist, "File \"#{params.template}\" does not exist" unless exists?
+      fail Exceptions::TemplateNameIsInvalid, "File \"#{params.template}\" is not a valid erb template: file ending erb" unless erb_template?
+    end
+
+    def empty?
+      params.template.nil?
     end
 
     def exists?

data/lib/filegen/runner.rb

@@ -4,7 +4,7 @@ module Filegen
   class Runner
     private
 
-    attr_reader :options, :generator
+    attr_reader :argv
 
     public
 
@@ -20,19 +20,20 @@ module Filegen
     # @param [Kernel] kernel
     #  Kernel class
     def initialize(argv, stdin = $stdin, stdout = $stdout, stderr = $stderr, kernel = Kernel)
-      $stdin, $stdout, $stderr, @kernel = stdin, stdout, stderr, kernel
-
-      @options   = Options.new(argv)
-      @generator = ErbGenerator.new(Data.new(@options.data_sources))
+      @argv, $stdin, $stdout, Ui.logger, @kernel = argv, stdin, stdout, stderr, kernel
     end
 
     # Execute runner
     def execute!
       begin
+        options   = Options.new(argv)
+
+        generator = ErbGenerator.new(Data.new(options.data_sources))
         generator.compile(options.source, options.destination)
+
         exitstatus = 0
       rescue RuntimeError => e
-        $stderr.puts e.message
+        Filegen::Ui.error e.message
         exitstatus = 1
       end
 

data/lib/filegen/ui.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Filegen
+  # Methods for ui
+  module Ui
+    @logger = ::Logger.new($stderr)
+
+    class << self
+      attr_reader :logger
+
+      def formated_logger
+        logger.formatter = proc { |severity, datetime, _, msg|
+          sprintf("%s %s: %s\n", datetime, severity, msg)
+        }
+
+        logger
+      end
+
+      def logger=(output = $stderr)
+        @logger = ::Logger.new(output)
+      end
+
+      # Output warnings
+      def warning(*args)
+        formated_logger.warn(*args)
+      end
+
+      # Output messages
+      def message(*args)
+        formated_logger.info(*args)
+      end
+
+      # Output errors
+      def error(*args)
+        formated_logger.error(*args)
+      end
+    end
+  end
+end

data/lib/filegen/version.rb

@@ -1,4 +1,4 @@
 #main Filegen
 module Filegen
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/data_source_builder_spec.rb

@@ -21,7 +21,7 @@ describe DataSourceBuilder do
       allow(params).to receive(:data_source_builders).and_return({})
       allow(params).to receive(:yaml_file).and_return('')
 
-      expect { DataSourceBuilder.new(params) }.to raise_error Exceptions::InvalidDataSources
+      expect { DataSourceBuilder.new(params) }.to raise_error Exceptions::DataSourcesAreInvalid
     end
 
     it 'supports order of data sources: env first' do

data/spec/options_spec.rb

@@ -4,7 +4,8 @@ require 'spec_helper'
 describe Options do
   context '#destination' do
     it 'returns an io handle' do
-      options = Options.new([])
+      template_file = create_file('template.erb')
+      options = Options.new([template_file])
       expect(options.destination).to respond_to(:puts)
     end
   end
@@ -18,15 +19,12 @@ describe Options do
     end
 
     it 'raises an exception if file does not exist' do
-      options = Options.new(['template_file'])
-      expect { options.source }.to raise_error RuntimeError
+      expect { Options.new(['template_file']) }.to raise_error Exceptions::TemplateDoesNotExist
     end
 
     it 'raises an exception if file does not have a erb-extension' do
       template_file = create_file('template')
-
-      options = Options.new([template_file])
-      expect { options.source }.to raise_error RuntimeError
+      expect { Options.new([template_file]) }.to raise_error Exceptions::TemplateNameIsInvalid
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filegen
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -52,6 +52,7 @@ files:
 - config/rubocop-disabled.yml
 - config/rubocop-enabled.yml
 - cucumber.yml
+- features/error_handling.feature
 - features/evaluate_template.feature
 - features/output_meta_data.feature
 - features/step_definitions.rb
@@ -67,6 +68,7 @@ files:
 - lib/filegen/exceptions.rb
 - lib/filegen/options.rb
 - lib/filegen/runner.rb
+- lib/filegen/ui.rb
 - lib/filegen/version.rb
 - rubocop-todo.yml
 - scripts/terminal
@@ -109,6 +111,7 @@ specification_version: 3
 summary: This helper takes an erb template and provides access to environment variables
   and a yaml file within that template
 test_files:
+- features/error_handling.feature
 - features/evaluate_template.feature
 - features/output_meta_data.feature
 - features/step_definitions.rb