filegen 0.0.1 → 0.1.1

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/cache/

data/.rdebugrc

@@ -0,0 +1,7 @@
+set listsize 30
+set history save on
+set history size 99999
+set history filename ~/.rdebug_history
+set autolist
+set autoeval
+set autoreload

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--order rand
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: 
+  - config/rubocop-enabled.yml
+  - config/rubocop-disabled.yml
+
+AllCops:
+  Includes:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+  Excludes:
+    - vendor/**

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/spec/"
+  add_filter "/tmp"
+  add_filter "/db"
+  add_filter "/vendor"
+
+  add_group "lib", "lib"
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without development
+rvm:
+    - 1.9.3
+    - 2.0.0
+    - 2.1.0
+script: bundle exec rake test:coveralls

data/.yardopts

@@ -0,0 +1,6 @@
+-o doc/yard
+--verbose
+-
+LICENSE.md
+README.md
+README.DEVELOPER.md

data/Gemfile

@@ -2,3 +2,33 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in filegen.gemspec
 gemspec
+
+group :test do
+  gem 'aruba', git: 'https://github.com/cucumber/aruba.git'
+  gem 'cucumber'
+  gem 'fuubar'
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'rubocop'
+  gem 'coveralls'
+end
+
+group :development do
+  gem 'debugger'
+  gem 'awesome_print'
+  gem 'debugger-completion'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem 'pry-doc'
+  gem 'tmrb'
+  gem 'yard'
+  gem 'github-markup'
+  gem 'redcarpet'
+end
+
+gem 'rake', group: [:development, :test]
+gem 'fedux_org-stdlib', group: [:development, :test]
+gem 'bundler', '~> 1.3', group: [:development, :test]
+gem 'erubis', group: [:development, :test]
+gem 'versionomy', group: [:development, :test]
+gem 'activesupport', group: [:development, :test]

data/{LICENSE.txt → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Dennis Günnewig
+Copyright (c) 2014 Dennis Günnewig, VR Netze GmbH
 
 MIT License
 

data/README.DEVELOPER.md

@@ -0,0 +1,28 @@
+# Filegen (Developer Readme)
+
+## Utilities
+
+* Code coverage: simplecov
+* Code quality: rubocop
+* Documentation: yard
+* Tasks: rake
+* Testing: rspec, cucumber + aruba
+* Testing-Helper: fedux_org-stdlib
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your tests
+4. Commit your changes (`git commit -am 'Add some tests for feature'`)
+5. Write your code
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Make sure all tests pass (`bundle exec rspec && bundle exec cucumber`)
+8. Make sure rubocop does not find any offences (`rubocop`) 
+9. Push to the branch (`git push origin my-new-feature`)
+10. Create new Pull Request
+11. Make sure all tests pass on travis
+
+Commits must not...
+* change the version-number
+* contain rubocop:disable-comments

data/README.md

@@ -1,6 +1,11 @@
 # Filegen
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/dg-vrnetze/filegen.png?branch=master)](https://travis-ci.org/dg-vrnetze/filegen)
+[![Code Climate](https://codeclimate.com/github/dg-vrnetze/filegen.png)](https://codeclimate.com/github/dg-vrnetze/filegen)
+
+Have you ever felt the need to generate files based on environment variables or
+yaml files? If your answer is yes, then `filegen` can be quite helpful for
+you. If your answer is no, than sorry Ma'am, this gem is not for you.
 
 ## Installation
 
@@ -16,14 +21,108 @@ Or install it yourself as:
 
     $ gem install filegen
 
+This gem ships with an executable called `filegen`. It makes the power of ERB
+available on the commandline.
+
 ## Usage
 
-TODO: Write usage instructions here
+### General advice
+
+Please make sure you have an ERB-template available. It needs to end with
+`.erb`! Place in anywhere you like. It's important that the name of variable in
+the template matches the name of environment variable or yaml-key: wording,
+case. The lookup is case-sensitive. If you want to get access to the variable,
+you need to use the `lookup`-method.
+
+```
+lookup(<variable>)
+```
+
+If you want to write the output to a file you need
+to redirect stdout with `>`. Otherwise it will output the content on `$stdout`.
+
+### Variable lookup
+
+The default order of data sources to lookup a variable,  is: 1st environment
+variable and 2nd yaml file. The yaml file needs be given as command line argument
+see below at [Generate a file based on YAML file](#yaml).
+
+The order of data sources can be changed by using:
+
+```
+--data-sources env,yaml
+--data-sources yaml,env
+```
+
+A short cut for `--data-sources` is `-d`. This option can also be used to ommit
+a data source. But it makes sense only for the enviroment data source today,
+because the yaml data source is only added if a yaml file name is given on the
+commandline
+
+```
+--data-sources yaml
+```
+
+
+
+
+### Generate a file based on Environment Variables
+
+The content of `template.erb`:
+
+```erb
+Hello my name is: <%= lookup('NAME') %>
+```
+
+After that you can use it with filegen.
+
+```bash
+NAME=Karl filegen template.erb > file
+```
+
+And get the following result.
+
+```text
+Hello my name is: Karl
+```
+
+### Generate a file based on YAML file
+<a id="yaml"></a>
+
+The content of `template.erb`:
+
+```erb
+Hello my name is: <%= lookup('NAME') %>
+```
+
+Additionally you need to create a `YAML`-file - e.g. `names.yaml`.
+
+```yaml
+---
+NAME: Karl
+```
+
+After that you can use it with filegen.
+
+```bash
+#short format
+filegen -y names.yaml template.erb > file
+
+#long format
+filegen --yaml-file names.yaml template.erb > file
+```
+
+And get the following result. 
+
+```text
+Hello my name is: Karl
+```
+
+## Future
+
+* Maybe I will add additional data sources. Please see the
+  [Moneta](https://github.com/minad/moneta)-gem for possible candidates.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Please have a look at the {file:README.DEVELOPER.md developer readme}

data/Rakefile

@@ -1 +1,60 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+
+require 'fedux_org/stdlib/rake'
+
+require 'filegen/version'
+
+def software
+  'filegen'
+end
+
+def version
+  Filegen::VERSION
+end
+
+def root_directory
+  File.expand_path('../', __FILE__)
+end
+
+def tar_file
+  File.join(pkg_directory, "#{software}-#{version}.tar.gz")
+end
+
+def tmp_directory
+  File.join(root_directory, 'tmp', "#{software}-#{version}")
+end
+
+def gem_file
+  File.join(root_directory, 'pkg', "#{software}-#{version}.gem")
+end
+
+def pkg_directory
+  File.join(root_directory, 'pkg')
+end
+
+task :default => 'gem:build'
+
+file gem_file => 'gem:build'
+
+file tmp_directory do
+  FileUtils.mkdir_p tmp_directory
+end
+
+namespace :gem do
+  desc 'build tar file'
+  task :package => [gem_file, tmp_directory] do
+    FileUtils.mv File.join(pkg_directory,"#{software}-#{version}.gem"), tmp_directory 
+
+    Dir.chdir('tmp') do
+      sh "tar -czf #{tar_file} #{File.basename tmp_directory}"
+    end
+  end
+end
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+
+namespace :test do
+  desc 'Test with coveralls'
+  task :coveralls => ['test:rspec', 'test:cucumber', 'coveralls:push']
+end

data/bin/filegen

@@ -3,4 +3,4 @@
 
 require 'filegen'
 
-Filegen::Runner.new(ARGV).run
+Filegen::Runner.new(ARGV).execute!

data/config/rubocop-enabled.yml

@@ -0,0 +1,140 @@
+AccessModifierIndentation:
+  Enabled: true
+
+Alias:
+  Enabled: true
+
+AlignParameters:
+  Enabled: true
+
+Blocks:
+  Enabled: true
+
+BracesAroundHashParameters:
+  Enabled: true
+
+CharacterLiteral:
+  Enabled: true
+
+ClassVars:
+  Enabled: true
+
+CollectionMethods:
+  Enabled: true
+
+ColonMethodCall:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+CaseEquality:
+  Enabled: true
+
+EmptyLinesAroundBody:
+  Enabled: true
+
+Encoding:
+  Enabled: true
+
+Eval:
+  Enabled: true
+
+FinalNewline:
+  Enabled: true
+
+HashSyntax:
+  Enabled: true
+
+IfUnlessModifier:
+  Enabled: true
+
+IndentationWidth:
+  Enabled: true
+
+Lambda:
+  Enabled: true
+
+LeadingCommentSpace:
+  Enabled: true
+
+LineLength:
+  Max: 188
+
+MethodLength:
+  Max: 23
+
+ParenthesesAroundCondition:
+  Enabled: true
+
+PerlBackrefs:
+  Enabled: true
+
+RaiseArgs:
+  Enabled: true
+
+RedundantSelf:
+  Enabled: true
+
+RegexpLiteral:
+  Enabled: true
+
+Semicolon:
+  Enabled: true
+
+SignalException:
+  Enabled: true
+
+SingleLineBlockParams:
+  Enabled: true
+
+SpaceAfterComma:
+  Enabled: true
+
+SpaceAfterControlKeyword:
+  Enabled: true
+
+SpaceAfterNot:
+  Enabled: true
+
+SpaceAroundBlockBraces:
+  Enabled: true
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+SpaceAroundOperators:
+  Enabled: true
+
+SpaceInsideBrackets:
+  Enabled: true
+
+SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+SpaceInsideParens:
+  Enabled: true
+
+SpecialGlobalVars:
+  Enabled: true
+
+StringLiterals:
+  Enabled: true
+
+TrailingBlankLines:
+  Enabled: true
+
+TrailingWhitespace:
+  Enabled: true
+
+TrivialAccessors:
+  Enabled: true
+
+UselessAssignment:
+  Enabled: true
+
+WordArray:
+  Enabled: true