filegen 0.0.1 → 0.1.1

data/lib/filegen/runner.rb

@@ -1,22 +1,42 @@
 # encoding: utf-8
 module Filegen
+  # Commandline from end
   class Runner
+    private
+
     attr_reader :options, :generator
 
-    def initialize(argv)
-      @options = Options.new(argv)
-      @generator = ErbGenerator.new(Env.new.my_binding)
+    public
+
+    # Create runner
+    # @param [Array] argv
+    #  Commandline arguments
+    # @param [IO] stdin
+    #  Stdin
+    # @param [IO] stdout
+    #  Stdout
+    # @param [IO] stderr
+    #  Stderr
+    # @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))
     end
 
-    def run
+    # Execute runner
+    def execute!
       begin
-        generator.compile(options.source,options.destination)
-      rescue Exception => e
-        puts e.message
-        exit 1
+        generator.compile(options.source, options.destination)
+        exitstatus = 0
+      rescue RuntimeError => e
+        $stderr.puts e.message
+        exitstatus = 1
       end
 
-      exit 0
+      @kernel.exit(exitstatus)
     end
   end
 end

data/lib/filegen/version.rb

@@ -1,3 +1,4 @@
+#main Filegen
 module Filegen
-  VERSION = "0.0.1"
+  VERSION = '0.1.1'
 end

data/rubocop-todo.yml

@@ -0,0 +1,144 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+AccessModifierIndentation:
+  Enabled: true
+
+Alias:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+Blocks:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+Eval:
+  Enabled: false
+
+FinalNewline:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IndentationWidth:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LeadingCommentSpace:
+  Enabled: false
+
+LineLength:
+  Max: 188
+
+MethodLength:
+  Max: 23
+
+ParenthesesAroundCondition:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RedundantSelf:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+Semicolon:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SpaceAfterComma:
+  Enabled: false
+
+SpaceAfterControlKeyword:
+  Enabled: false
+
+SpaceAfterNot:
+  Enabled: false
+
+SpaceAroundBlockBraces:
+  Enabled: false
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+SpaceAroundOperators:
+  Enabled: false
+
+SpaceInsideBrackets:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+SpaceInsideParens:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+TrailingBlankLines:
+  Enabled: false
+
+TrailingWhitespace:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+UselessAssignment:
+  Enabled: false
+
+WordArray:
+  Enabled: false

data/scripts/terminal

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'tmrb'
+
+tmux = TmRb::Multiplexer.new
+# creates an empty window
+tmux.new_session(session_name: 'filegen')
+
+tmux.new_window(name: 'code', command: 'vim -c :NERDTree lib')
+tmux.new_window(name: 'spec', command: 'vim -c :NERDTree spec')
+tmux.start

data/spec/data_source_builder_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe DataSourceBuilder do
+  context '#sources' do
+    it 'returns data sources' do
+      yaml_builder = double('yaml_builder')
+      env_builder = double('env_builder')
+
+      params = double('params')
+      allow(params).to receive(:data_sources).and_return([:yaml, :env])
+      allow(params).to receive(:data_source_builders).and_return(yaml: yaml_builder, env: env_builder)
+      allow(params).to receive(:yaml_file).and_return('')
+
+      expect { DataSourceBuilder.new(params) }.not_to raise_error
+    end
+
+    it 'raises an exception on invalid input' do
+      params = double('params')
+      allow(params).to receive(:data_sources).and_return([:yaml, 'garbage'])
+      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
+    end
+
+    it 'supports order of data sources: env first' do
+      yaml_builder = double('yaml_builder')
+      env_builder = double('env_builder')
+
+      params = double('params')
+      allow(params).to receive(:data_sources).and_return([:env, :yaml])
+      allow(params).to receive(:data_source_builders).and_return(yaml: yaml_builder, env: env_builder)
+      allow(params).to receive(:yaml_file).and_return('')
+
+      builder = DataSourceBuilder.new(params)
+      expect(builder.sources.first).to be(env_builder)
+    end
+
+    it 'supports order of data sources: yaml first' do
+      yaml_builder = double('yaml_builder')
+      env_builder = double('env_builder')
+
+      params = double('params')
+      allow(params).to receive(:data_sources).and_return([:yaml, :env])
+      allow(params).to receive(:data_source_builders).and_return(yaml: yaml_builder, env: env_builder)
+      allow(params).to receive(:yaml_file).and_return('')
+
+      builder = DataSourceBuilder.new(params)
+      expect(builder.sources.first).to be yaml_builder
+    end
+  end
+end

data/spec/data_sources/environment_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe DataSources::Environment do
+  context '#fetch' do
+    it 'retrieves environment variables' do
+      in_environment 'MY_NAME' => 'Karl' do
+        source = DataSources::Environment.new
+        expect(source.fetch('MY_NAME')).to eq('Karl')
+      end
+    end
+
+    it 'returns nil if variable cannot be found' do
+      in_environment 'MY_NAME' => 'Karl' do
+        source = DataSources::Environment.new
+        expect(source.fetch('NOT_MY_NAME')).to be_nil
+      end
+    end
+  end
+end

data/spec/data_sources/yaml_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe DataSources::Yaml do
+  context '#fetch' do
+    it 'retrieves variables from yaml file' do
+      file = create_file('blub.yaml', <<-EOF.strip_heredoc
+                         ---
+                         MY_NAME: Karl
+                         EOF
+                        )
+      source = DataSources::Yaml.new(file)
+      expect(source.fetch('MY_NAME')).to eq('Karl')
+    end
+
+    it 'returns nil if variable cannot be found' do
+      file = create_file('blub.yaml', <<-EOF.strip_heredoc
+                         ---
+                         MY_NAME: Karl
+                         EOF
+                        )
+      source = DataSources::Yaml.new(file)
+      expect(source.fetch('NOT_MY_NAME')).to be_nil
+    end
+
+    it 'returns nil if file cannot be found' do
+      source = DataSources::Yaml.new('not valid file')
+      expect(source.fetch('NOT_MY_NAME')).to be_nil
+    end
+  end
+end

data/spec/data_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Filegen::Data do
+  context '#instance_binding' do
+    it 'let you variables' do
+      source = double('DataSource')
+      expect(source).to receive(:fetch).with('MY_NAME').and_return('Karl')
+
+      data = Filegen::Data.new(source)
+      # rubocop:disable Eval
+      result = eval('lookup("MY_NAME")', data.instance_binding)
+      # rubocop:enable Eval
+      expect(result).to eq('Karl')
+    end
+  end
+
+  context '#lookup' do
+    it 'provides access to variables' do
+      source = double('DataSource')
+      expect(source).to receive(:fetch).with('MY_NAME').and_return('Karl')
+
+      data = Filegen::Data.new(source)
+      expect(data.lookup('MY_NAME')).to eq('Karl')
+    end
+
+    it 'supports multiple data sources: first has match' do
+      source1 = double('DataSource1')
+      expect(source1).to receive(:fetch).with('MY_NAME').and_return('Egon')
+
+      source2 = double('DataSource2')
+      expect(source2).not_to receive(:fetch)
+
+      data = Filegen::Data.new([source1, source2])
+      expect(data.lookup('MY_NAME')).to eq('Egon')
+    end
+
+    it 'supports multiple data sources: last has match' do
+      source1 = double('DataSource1')
+      expect(source1).to receive(:fetch).with('MY_NAME').and_return(nil)
+
+      source2 = double('DataSource2')
+      expect(source2).to receive(:fetch).with('MY_NAME').and_return('Egon')
+
+      data = Filegen::Data.new([source1, source2])
+      expect(data.lookup('MY_NAME')).to eq('Egon')
+    end
+
+    it 'returns "" if none matches' do
+      source1 = double('DataSource1')
+      expect(source1).to receive(:fetch).with('MY_NAME').and_return(nil)
+
+      source2 = double('DataSource2')
+      expect(source2).to receive(:fetch).with('MY_NAME').and_return(nil)
+
+      data = Filegen::Data.new([source1, source2])
+      expect(data.lookup('MY_NAME')).to eq('')
+    end
+  end
+end

data/spec/erb_generator_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ErbGenerator do
+  context '#compile' do
+    it 'needs a source and a target' do
+      data = double('binding')
+      allow(data).to receive(:instance_binding) do
+        Class.new do
+          def name
+            'Karl'
+          end
+
+          def instance_binding
+            binding
+          end
+        end.new.instance_binding
+      end
+
+      source = double('source')
+      allow(source).to receive(:encoding)
+      allow(source).to receive(:read).and_return('Hello <%= name %>')
+
+      destination = double('destination')
+      expect(destination).to receive(:puts).with('Hello Karl')
+
+      gen = ErbGenerator.new(data)
+      gen.compile(source, destination)
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Options do
+  context '#destination' do
+    it 'returns an io handle' do
+      options = Options.new([])
+      expect(options.destination).to respond_to(:puts)
+    end
+  end
+
+  context '#source' do
+    it 'returns an io handle' do
+      template_file = create_file('template.erb')
+
+      options = Options.new([template_file])
+      expect(options.source).to respond_to(:read)
+    end
+
+    it 'raises an exception if file does not exist' do
+      options = Options.new(['template_file'])
+      expect { options.source }.to raise_error RuntimeError
+    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
+    end
+  end
+end