grundstein 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4417958b338d6b06e0c0e6fa6a60785705341f27
+  data.tar.gz: 9ac05330efb49ec5e851fba82e59dd546b940abb
+SHA512:
+  metadata.gz: 24f6b4cc484a02fc65b9cbbcd7782617cb14d1043c2ad8eb3fec07e808f916c5ee329a57a9a9aa0eef9b86d5fdeedb95427b5cb4979094cc5267495d1f0163f4
+  data.tar.gz: ccd5d10005905732a05324ac6ce8b6b608fe83388ebc062d37abf1c47adcfed5b50e22aa747c5fec6b7b47ce5bef5f662392f2af3752d6888613086a224c028e

data/.gitignore

@@ -0,0 +1,14 @@
+/.vagrant
+/.bundle
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+mkmf.log
+doc/api
+grundstein-*.gem

data/.rubocop.yml

@@ -0,0 +1,46 @@
+# See a complete description of the checks (named "cops") here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'generators/**/*'
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grundstein.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.Development.md

@@ -0,0 +1,179 @@
+# Development
+
+## How generators work
+
+Each generator has a directory in the `generators` folder. The generator's name is determined by the directory's name.
+Directories starting with `.` or `#` are ignored. All others must have a `_generator.rb` file.
+In there...
+
+- ...must be a `def run` method.
+- ...must be a `def spec` method which returns a hash with at least `{desc: '....'}`.
+- ...may be a `def caveats` method which returns a string to be displayed after the generator has run.
+- ...can be arbitrary other methods or declarations.
+
+Example:
+
+```ruby
+# file: generators/fancy/_generator.rb
+def run
+  doc_existed = directory('doc') # ensure doc folder is there
+  template('newfile') # finds `newfile` in the generator folder and copies it to the project
+  template('doc/.keep') unless doc_existed # and that there is a .keep if needed
+  template('probably_existing_file', assume_append: true)
+
+  info("EXIST", "YEEY") if File.exists?(File.join(@project_path, 'yeey')) # use Ruby methods
+  answer = ask("You?  ") # use HighLine methods
+end
+
+def caveats
+  res = <<CAVEATS
+Please run `bundle install` in your project.
+CAVEATS
+  return res
+end
+
+def spec
+  return { desc: 'does some fancy stuff' }
+end
+```
+
+### Generator context
+
+The generator script is guaranteed to include:
+
+- Ruby's standard methods (standard library) 
+- [HighLine](https://github.com/JEG2/highline) gem (`require 'highline/import'` was run)
+- [Thor](https://github.com/erikhuda/thor) gem loaded.
+- The following helpers:
+
+```ruby
+@generator_path # root path of the generator e.g. `.../generators/sdoc/`
+@working_path # path of the current working directory (may be != to @project_path)
+@project_path # root path of the project (with the .git in it)
+
+# Ensures that the project has the directory given.
+# This method returns if the directory already existed.
+def directory(relative_project_path)
+end
+
+# Processes the template found at `relative_project_path` and copies it to the project.
+# Relative_template_path determines the path of the template relative to the generator's root.
+# If `destination_path` is nil, the destination path will be determined by appending `relative_template_path` to `@project_path`.
+# If `destination_path` is given, it may be an absolute path or a relative path (to `@project_path`).
+# In case the destination file already exists, the user will be queried what to do (append, overwrite, skip or print).
+# If `assume_append` is true, the user is not queried and the template will be appended.
+def template(relative_template_path, destination_path: nil, assume_append: false) # rubocop:disable Metrics/CyclomaticComplexity, 
+end
+
+# Prints out a message.
+def info(action, message)
+end
+
+# Sets a variable with the given `name` and `value` to be available for all future templates.
+def template_context(name, value)
+end
+```
+
+Please see `lib/grundstein/generator/environment.rb` for more.
+
+## Templates
+
+Grundstein uses [mustache](https://mustache.github.io/) as template engine.
+Please see an extensive description [here](https://mustache.github.io/mustache.5.html).
+
+There are a few variables guaranteed to be present:
+
+- `existed?` and `new_file?` as boolean values determining if a new file has just been created.
+- `project_path`, `generator_path` and `working_path`. Description, please see above
+- You can also use `template_context(name, value)` in your generator's run method to add other variables.  
+  (use a question mark at the end of the name for boolean values).
+
+Example:
+
+```ruby
+def run
+  template_context("rails?", agree("Do you intend to use Rails?  ")) # note the two spaces at the end
+  template_context("name", ask("You name?  "))
+end
+# ...
+```
+
+```ruby
+# Author: {{name}}
+
+{{#new_file?}}
+source 'https://rubygems.org'
+{{/new_file?}}
+
+gem 'sdoc'
+{{#rails?}}
+gem 'rails'
+{{/rails?}}
+```
+
+## Testing
+
+```bash
+# you should test your generators in a new project
+cd /tmp/
+git init myproject
+cd myproject/
+RUBYLIB='/vagrant/lib:$RUBYLIB' bin/grundstein add rubocop
+```
+
+## API documentation
+
+We are using the [sdoc](https://github.com/voloko/sdoc) generator which is based on [rdoc](https://github.com/rdoc/rdoc).
+You may generate the documentation via `rake rdoc` and then find it in `doc/api`.
+
+For documenting methods and classes we use [markdown](https://daringfireball.net/projects/markdown/). Just add a comment above a class, method or attribute.
+If you are not familiar with markdown, please see this [cheat sheet](http://nestacms.com/docs/creating-content/markdown-cheat-sheet).  
+Here a quick example:
+
+```ruby
+# This is a mountain in the landscape.
+# It has seasons and simulates weather.
+class Mountain
+  # The hight of the mountain [meter].
+  attr_accessor :height
+  
+  # Constructor.
+  # The `height` is measured in meters.
+  # If snow is true, we can build ski lifts.
+  def initialize(height, snow=false)
+  end
+  
+  # Changes the weather on the mountain and sends a letter to the weather god.
+  # `season` can be either `:summer`, `:spring`, `:fall` or `:winter`.
+  # The letter to the weather god will include the desired `min_temp` or `max_temp`.
+  #
+  #     m = Mountain.new(1000)    # this is some example code
+  #     m.change_season(:summer) 
+  def change_season(season, min_temp: -10, max_temp: 30)
+  end
+
+  # Whenever rain occures, the block will be executed.
+  # **WARNING**: Will be called from another thread.
+  #
+  # _yields_ temperature, rain_amount
+  def rain_handler(&block) 
+    yield 1, 2
+  end
+end
+```
+
+## Code Style
+
+We are using this [Rubocop](https://github.com/bbatsov/rubocop) to enforce coding style.
+
+```bash
+rake rubocop # Run before each commit/push
+rake rubocop:auto_correct # auto-corrects issues where it can
+
+rubocop --only Style/TrailingBlankLines --auto-correct # correct only a single offense type
+```
+
+If you are a hundred percent sure you are doing the right thing, you can disable checking. Either
+
+- disable them for a particular line/method/class with: `# rubocop:disable Metrics/LineLength, Style/StringLiterals`
+- or disable rubocop for the full file: `# rubocop:disable all`

data/README.md

@@ -0,0 +1,47 @@
+# Grundstein
+
+[![GitHub license](https://img.shields.io/github/license/motine/grunstein.svg?style=flat-square)]()
+[![Gem](https://img.shields.io/gem/v/grundstein.svg?style=flat-square)]()
+
+I was annoyed to do the same work over and over.
+Often, I found myself to create the same `Vagrantfile`, `.gitignore` or `Gemfile` for each new project.
+Grundstein automates this step in a very simple way: We have (smart) templates which are copied to your repo.
+These templates are (in Rails fashion) called generators.
+
+**Examples**
+
+- You can call something like `grundstein vagrant` and you get a Vagrantfile and a little note in your README.
+- When you call `grundstein rubocop` you get a .rubocop file with some defaults and a few lines in your Rakefile.
+
+**Principles**
+
+- Don't be smart detecting stuff, ask! (some stuff might not have been created by the developer yet)
+- Generate rather more useful stuff than too few: A user can delete quicker than adding new stuff.
+- Show the user what is happening and what needs to be done next.
+- If in doubt, append.
+
+**Pro Tip**: Commit before running generators. Then review the changes via `git diff` or a [visual git tool](https://desktop.github.com/).
+
+## Installation
+
+Please make sure you have `git >= 1.7` installed. Then run:
+
+```bash
+gem install grundstein
+```
+
+## Usage
+
+The project's root folder is determined based on the current working directory.
+If there is no `.git` directory in the current directory, the script will try to move up until it finds a `.git`.
+Hence, **the project must be a git repository**.
+
+```bash
+grundstein list # see all generators
+cd myproject
+grundstein add rubocop
+```
+
+## Contribute & Development
+
+Please see `README.Development.md`.

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rdoc/task"
+require 'sdoc'
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError => _
+  STDERR.puts "Rubocop rake tasks not added, because gem not available." # you can remove this note if you want
+end
+
+Rake::RDocTask.new do |rdoc| # options are documented here: http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Task.html
+  rdoc.rdoc_dir = 'doc/api'
+  rdoc.generator = 'sdoc'
+  rdoc.markup = 'markdown'
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include("README.md", "bin/*", "lib/**/*.rb")
+  rdoc.template = 'rails' # change default from 'sdoc' to 'rails' style
+  # rdoc.options.push('--quiet') # see more options here: http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Options.html
+end

data/Vagrantfile

@@ -0,0 +1,28 @@
+# -*- mode: ruby -*-
+
+NAME = 'grundstein'.freeze
+
+DEPS = <<SCRIPT.freeze
+dnf -y install git vim-enhanced
+dnf -y install ruby ruby-devel rubygem-bundler
+SCRIPT
+
+BUNDLE = <<SCRIPT.freeze
+pushd /vagrant
+bundle install
+SCRIPT
+
+Vagrant.configure("2") do |config|
+  config.vm.hostname = NAME
+
+  config.vm.box = "fedora/23-cloud-base" # see below for virtual box
+  config.vm.provision :shell, inline: DEPS
+  config.vm.provision :shell, inline: BUNDLE, privileged: false
+
+  config.vm.provider "virtualbox" do |vb, override|
+    override.vm.synced_folder ".", "/vagrant", type: "virtualbox"
+    vb.name = NAME
+    vb.memory = 2048
+    vb.cpus = 2
+  end
+end

data/bin/grundstein

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'grundstein'
+Grundstein::Runner.start

data/generators/rubocop/.rubocop.yml

@@ -0,0 +1,52 @@
+# See a complete description of the checks (named "cops") here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+{{#rails?}}
+Rails:
+  Enabled: true
+
+# Style/Documentation:
+#   Enabled: false
+{{/rails?}}
+    
+# Metrics/LineLength:
+#   Enabled: false
+#
+# Style/StringLiterals:
+#   Enabled: false
+#
+# Style/SpaceAroundEqualsInParameterDefault:
+#   Enabled: false
+#
+# Style/RedundantReturn:
+#   Enabled: false
+#
+# Style/BracesAroundHashParameters:
+#   Enabled: false
+#
+# Style/RedundantSelf:
+#   Enabled: false
+#
+# Style/SignalException:
+#   Enabled: false
+#
+# Style/EachWithObject:
+#   Enabled: false
+#
+# Style/RegexpLiteral:
+#   Enabled: false
+#
+# Metrics/AbcSize:
+#   Enabled: false
+#
+# Style/TrailingUnderscoreVariable:
+#   Enabled: false
+#
+# Style/NegatedWhile:
+#   Enabled: false
+#
+# Style/WordArray:
+#   Enabled: false
+  

data/generators/rubocop/Gemfile

@@ -0,0 +1,7 @@
+{{#new_file?}}
+source 'https://rubygems.org'
+{{/new_file?}}
+
+group :development do
+  gem 'rubocop', require: false
+end

data/generators/rubocop/README.Development.md

@@ -0,0 +1,15 @@
+## Code Style
+
+We are using this [Rubocop](https://github.com/bbatsov/rubocop) to enforce coding style.
+
+```bash
+rake rubocop # Run before each commit/push
+rake rubocop:auto_correct # auto-corrects issues where it can
+
+rubocop --only Style/TrailingBlankLines --auto-correct # correct only a single offense type
+```
+
+If you are a hundred percent sure you are doing the right thing, you can disable checking. Either
+
+- disable them for a particular line/method/class with: `# rubocop:disable Metrics/LineLength, Style/StringLiterals`
+- or disable rubocop for the full file: `# rubocop:disable all`

data/generators/rubocop/Rakefile

@@ -0,0 +1,6 @@
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError => _
+  STDERR.puts "Rubocop rake tasks not added, because gem not available." # you can remove this note if you want
+end

data/generators/rubocop/_generator.rb

@@ -0,0 +1,27 @@
+def run
+  template_context("rails?", agree("Do you intend to use Rails?  "))
+  template('.rubocop.yml')
+  template('Gemfile', assume_append: true)
+  template('Rakefile', assume_append: true)
+  template('README.Development.md', assume_append: true)
+end
+
+def caveats
+  res = <<CAVEATS
+Please run `bundle install` in your project.
+  
+You can use `rubocop --auto-gen-config` to automatically create `.rubocop_todo.yml`.
+In your `.rubocop.yml` you can then add `inherit_from: .rubocop_todo.yml` to include it.
+More info: https://github.com/bbatsov/rubocop#automatically-generated-configuration
+
+
+If you are using a CI, you may want to include something like `bundle exec rubocop`.
+CAVEATS
+  return res
+end
+
+def spec
+  return {
+    desc: 'rubocop style checker'
+  }
+end

data/generators/sdoc/.gitignore

@@ -0,0 +1 @@
+doc/api

data/generators/sdoc/Gemfile

@@ -0,0 +1,5 @@
+{{#new_file?}}
+source 'https://rubygems.org'
+{{/new_file?}}
+
+gem 'sdoc', '~> 0.4.1'

data/generators/sdoc/README.Development.md

@@ -0,0 +1,40 @@
+## API documentation
+
+We are using the [sdoc](https://github.com/voloko/sdoc) generator which is based on [rdoc](https://github.com/rdoc/rdoc).
+You may generate the documentation via `rake rdoc` and then find it in `doc/api`.
+
+For documenting methods and classes we use [markdown](https://daringfireball.net/projects/markdown/). Just add a comment above a class, method or attribute.
+If you are not familiar with markdown, please see this [cheat sheet](http://nestacms.com/docs/creating-content/markdown-cheat-sheet).  
+Here a quick example:
+
+```ruby
+# This is a mountain in the landscape.
+# It has seasons and simulates weather.
+class Mountain
+  # The hight of the mountain [meter].
+  attr_accessor :height
+  
+  # Constructor.
+  # The `height` is measured in meters.
+  # If snow is true, we can build ski lifts.
+  def initialize(height, snow=false)
+  end
+  
+  # Changes the weather on the mountain and sends a letter to the weather god.
+  # `season` can be either `:summer`, `:spring`, `:fall` or `:winter`.
+  # The letter to the weather god will include the desired `min_temp` or `max_temp`.
+  #
+  #     m = Mountain.new(1000)    # this is some example code
+  #     m.change_season(:summer) 
+  def change_season(season, min_temp: -10, max_temp: 30)
+  end
+
+  # Whenever rain occures, the block will be executed.
+  # **WARNING**: Will be called from another thread.
+  #
+  # _yields_ temperature, rain_amount
+  def rain_handler(&block) 
+    yield 1, 2
+  end
+end
+```

data/generators/sdoc/README.md

@@ -0,0 +1,3 @@
+{{#new_file?}}
+Run `grundstein readme` to create a `README.md`.
+{{/new_file?}}

data/generators/sdoc/Rakefile

@@ -0,0 +1,12 @@
+require "rdoc/task"
+require 'sdoc'
+
+Rake::RDocTask.new do |rdoc| # options are documented here: http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Task.html
+  rdoc.rdoc_dir = 'doc/api'
+  rdoc.generator = 'sdoc'
+  rdoc.markup = 'markdown'
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include("README.md", "bin/*", "lib/**/*.rb")
+  rdoc.template = 'rails' # change default from 'sdoc' to 'rails' style
+  # rdoc.options.push('--quiet') # see more options here: http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Options.html
+end

data/generators/sdoc/_generator.rb

@@ -0,0 +1,25 @@
+def run
+  doc_existed = directory('doc') # ensure doc folder is there
+  template('doc/.keep') unless doc_existed # and that there is a .keep if needed
+  template('.gitignore', assume_append: true)
+  template('Gemfile', assume_append: true)
+  template('Rakefile', assume_append: true)
+  template('README.Development.md', assume_append: true)
+  template('README.md', assume_append: true)
+end
+
+def caveats
+  res = <<CAVEATS
+Please run `bundle install` in your project.
+
+Rdoc is very free-form.
+If you prefer a stricter way for documenting you code, please take a look at yardoc.org.
+Especially in larger projects, a stricter style may be better suited.
+
+CAVEATS
+  return res
+end
+
+def spec
+  return { desc: 'rdoc rake task using sdoc template' }
+end

data/grundstein.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grundstein/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grundstein'
+  spec.version       = Grundstein::VERSION
+  spec.authors       = ['Tom Rothe']
+  spec.email         = ['info@tomrothe.de']
+  spec.summary       = 'Automates adding common files to your project.'
+  spec.description   = 'Grundstein automates adding common files by we adding (smart) templates. E.g. add a Vagrantfile, a .gitignore, or a sinatra app.'
+  spec.homepage      = 'https://github.com/motine/grundstein'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_runtime_dependency 'thor', '~> 0.19.1'
+  spec.add_runtime_dependency 'highline', '~> 1.7'
+  spec.add_runtime_dependency 'mustache', '~> 1.0'
+  spec.add_runtime_dependency 'git', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.37.2'
+  spec.add_development_dependency 'sdoc', '~> 0.4.1'
+end

data/lib/grundstein.rb

@@ -0,0 +1,11 @@
+require_relative 'grundstein/version'
+
+module Grundstein # rubocop:disable Style/Documentation
+  def self.lib_path
+    File.expand_path('..', __FILE__)
+  end
+end
+
+require_relative 'grundstein/refinements'
+require_relative 'grundstein/generator'
+require_relative 'grundstein/runner'

data/lib/grundstein/generator.rb

@@ -0,0 +1,9 @@
+require_relative 'generator/errors'
+require_relative 'generator/repository'
+require_relative 'generator/environment'
+require_relative 'generator/loader'
+
+module Grundstein
+  module Generator # rubocop:disable Style/Documentation
+  end
+end

data/lib/grundstein/generator/environment.rb

@@ -0,0 +1,104 @@
+require 'mustache'
+require 'fileutils'
+
+module Grundstein
+  module Generator
+    # This class is used to create the envrionment for the generator file.
+    # This class is instanciated by the Generator::Loader.
+    # Then `extend_from_file` is called. This will then load all methods available in that file into this object.
+    # From there on the Loader can interact with the generator (e.g. call `run`)
+    class Environment
+      using Grundstein::Refinements::ColoredStrings
+
+      def initialize
+        @template_vars = {}
+      end
+
+      # Takes a kwargs and sets instance variables in the environment and makes them available as template variables.
+      # Called by Generator::Loader.
+      def set_context(**vars) # rubocop:disable Style/AccessorMethodName
+        vars.each do |var, value|
+          self.instance_variable_set("@#{var}".to_sym, value)
+          @template_vars[var] = value
+        end
+      end
+
+      # Loads the script from the given path and adds the methods to this class.
+      # Called by Generator::Loader.
+      def extend_from_file(path)
+        self.instance_eval(File.read(path))
+      end
+
+      # This may be overridden by the `_generator.rb`.
+      def caveats
+        return ''
+      end
+
+      # Prints out a message.
+      def info(action, message)
+        puts "  #{action.ljust(10).c_info} #{message}"
+      end
+
+      # Sets a variable with the given `name` and `value` to be available for all future templates.
+      def template_context(name, value)
+        @template_vars[name] = value
+      end
+
+      # Ensures that the project has the directory given.
+      # This method returns if the directory already existed.
+      def directory(relative_project_path)
+        path = File.expand_path(relative_project_path, @project_path)
+        exists = Dir.exist?(path)
+        if exists
+          info("EXIST", path)
+        else
+          info("CREATE", path)
+          FileUtils.mkdir_p(path)
+        end
+        return exists
+      end
+
+      # Convenience method for the generator
+      # Processes the template found at `relative_project_path` and copies it to the project.
+      # Relative_template_path determines the path of the template relative to the generator's root
+      # If `destination_path` is nil, the destination path will be determined by appending `relative_template_path` to `@project_path`.
+      # If `destination_path` is given, it may be an absolute path or a relative path (to `@project_path`).
+      # In case the destination file already exists, the user will be queried what to do (append, overwrite, skip or print).
+      # If `assume_append` is true, the user is not queried and the template will be appended.
+      def template(relative_template_path, destination_path: nil, assume_append: false) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+        template_path = File.join(@generator_path, relative_template_path)
+        raise GeneratorRunError, "Could not find template '#{relative_template_path}'." unless File.exist?(template_path)
+
+        destination_path = File.expand_path(relative_template_path, @project_path) if destination_path.nil?
+        exists = File.exist?(destination_path)
+
+        rendered_template = Mustache.render(File.read(template_path), @template_vars.merge(new_file?: !exists))
+
+        append = true
+        if exists && !assume_append
+          choose do |menu|
+            menu.prompt = "#{destination_path.c_warning} already exists. "
+            menu.layout = :one_line
+            menu.choice(:append) {}
+            menu.choice(:overwrite) { append = false }
+            menu.choice(:skip) do
+              info("SKIP", destination_path)
+              return
+            end
+            menu.choice(:print) do
+              puts ">>>" * 20 + destination_path
+              puts rendered_template
+              puts "<<<" * 20 + destination_path
+              return
+            end
+          end
+          puts
+        end
+        File.open(destination_path, append ? 'a' : 'w') do |f|
+          f.puts(rendered_template)
+        end
+        info((exists && append) ? "APPEND" : "CREATE", destination_path)
+      end
+    end
+  end
+end

data/lib/grundstein/generator/errors.rb

@@ -0,0 +1,12 @@
+module Grundstein
+  module Generator
+    class GeneratorError < StandardError
+    end
+    class GeneratorNotFoundError < GeneratorError
+    end
+    class GeneratorMalformedError < GeneratorError
+    end
+    class GeneratorRunError < GeneratorError
+    end
+  end
+end

data/lib/grundstein/generator/loader.rb

@@ -0,0 +1,89 @@
+module Grundstein
+  module Generator
+    # This class encapsulates the logic to load a generator.
+    # It sets up a Generator::Envrionment and interacts with it.
+    # It is also responsible to determine paths.
+    class Loader
+      using Grundstein::Refinements::ColoredStrings
+
+      SCRIPT_NAME = '_generator.rb'.freeze
+      DIR_EXPECTED_IN_PROJECT_ROOT = '.git'.freeze
+
+      # Loads the generator.
+      def initialize(generator_name)
+        @generator_name = generator_name
+        @env = load_environment
+        @env.set_context(generator_path: generator_path, working_path: working_path, project_path: project_root_path)
+      end
+
+      # Executes the generator's run method.
+      def run # rubocop:disable Metrics/MethodLength
+        raise GeneratorMalformedError, "Generator script '#{@generator_name}' does not have a 'run' method." unless @env.respond_to?(:run)
+        begin
+          puts "Running #{@generator_name.c_gen}"
+          puts "Working path: #{working_path}"
+          puts "Project path: #{project_root_path}"
+          puts
+          @env.run
+          puts
+          puts @env.caveats.c_warning
+        rescue => e
+          raise GeneratorRunError, "[#{@generator_name}] #{e.message}"
+        end
+      end
+
+      def name
+        return @generator_name
+      end
+
+      def info
+        raise GeneratorMalformedError, "Generator script '#{@generator_name}' does not have an 'info' method." unless @env.respond_to?(:spec)
+        spec = @env.spec
+        raise GeneratorMalformedError, "Generator script '#{@generator_name}' does include :desc in the 'info' result." unless spec.is_a?(Hash) && spec[:desc].is_a?(String)
+        return spec
+      end
+
+      # short hand for info[:desc]
+      def desc
+        return info[:desc]
+      end
+
+      protected
+
+      # Creates a Generator::Environment for the generator_name given in the constructor.
+      def load_environment
+        env = Grundstein::Generator::Environment.new
+        path = self.generator_script_path
+        raise GeneratorNotFoundError, "Generator named '#{@generator_name}' could not be found." unless Dir.exist?(File.dirname(path))
+        raise GeneratorNotFoundError, "Generator named '#{@generator_name}' has no #{SCRIPT_NAME} script." unless File.exist?(path)
+        env.extend_from_file(path)
+        return env
+      end
+
+      def working_path
+        return Dir.pwd
+      end
+
+      def generator_path
+        return Generator::Repository.instance.generator_path(@generator_name)
+      end
+
+      def generator_script_path
+        return File.join(self.generator_path, SCRIPT_NAME)
+      end
+
+      def project_root_path
+        return @project_root_path unless @project_root_path.nil?
+        dir = Dir.pwd
+        loop do
+          raise GeneratorRunError, "Could not determine project path (no .git found here or above)." if dir == '/'
+          if Dir.exist?(File.join(dir, DIR_EXPECTED_IN_PROJECT_ROOT))
+            @project_root_path = dir
+            return dir
+          end
+          dir = File.dirname(dir)
+        end
+      end
+    end
+  end
+end

data/lib/grundstein/generator/repository.rb

@@ -0,0 +1,82 @@
+require 'git'
+
+module Grundstein
+  module Generator
+    # Manages the generator repository. Implemented as a singleton (see `instance` method).
+    # It uses git to keep the repository up to date.
+    # It will check the repo out to '~/.grundstein'.
+    # It also creates a file in this directory named 'last_update' where the timestamp of the last update is kept.
+    # If this time stamp is too long ago, it will update the repo.
+    #
+    # Use this class by using the instance method: `Generator::Repository.instance`
+    class Repository
+      OUTDATED_THRESHOLD = 1 # day(s)
+
+      using Grundstein::Refinements::ColoredStrings
+
+      def self.instance
+        @instance ||= Repository.new(File.expand_path("~/.grundstein"))
+        return @instance
+      end
+
+      # Iteratates through all generators and yields the block with the |name, desc|.
+      def generators
+        result = []
+        Dir.foreach(generators_path) do |dir|
+          next if dir.start_with?('.', '#')
+          result << dir
+        end
+        return result
+      end
+
+      def generators_path
+        return File.join(@path, 'generators')
+      end
+
+      def generator_path(name)
+        return File.join(generators_path, name)
+      end
+
+      protected
+
+      # The constructor will check if the repository is there and create it if necessary.
+      # If the repo is outdated, it will update it.
+      def initialize(path)
+        @path = path
+        @git = Git.open(@path) # , :log => Logger.new(STDOUT))
+        update if outdated?
+      rescue ArgumentError => _
+        setup
+        retry
+      end
+
+      def outdated?
+        return DateTime.parse(File.read(last_update_file_path)) < (DateTime.now - OUTDATED_THRESHOLD)
+      rescue => _
+        return true
+      end
+
+      def update
+        puts "Updating generator repository..."
+        @git.pull
+        File.write(last_update_file_path, DateTime.now.to_s)
+      end
+
+      def setup
+        puts "Initializing generator repository...".c_warning
+        @git = Git.init(@path)
+        @git.add_remote('origin', 'https://github.com/motine/grundstein.git')
+
+        # TODO: make sure git > 1.7
+        # let's only checkout the generators
+        @git.config('core.sparsecheckout', true)
+        File.write(File.join(@git.repo.path, 'info', 'sparse-checkout'), 'generators')
+        update
+      end
+
+      def last_update_file_path
+        return File.join(@path, 'last_update')
+      end
+    end
+  end
+end

data/lib/grundstein/refinements.rb

@@ -0,0 +1 @@
+require_relative 'refinements/colored_strings'

data/lib/grundstein/refinements/colored_strings.rb

@@ -0,0 +1,26 @@
+require 'highline'
+
+module Grundstein
+  module Refinements
+    # Add namespaced refinement for the color scheme (we are not using HighLine's stuff like `ColorScheme` or `HighLine.colorize_strings`).
+    module ColoredStrings
+      refine String do
+        def c_gen
+          HighLine.color(self, :blue, :bold)
+        end
+
+        def c_info
+          HighLine.color(self, :green, :bold)
+        end
+
+        def c_warning
+          HighLine.color(self, :yellow, :bold)
+        end
+
+        def c_error
+          HighLine.color(self, :red, :bold)
+        end
+      end
+    end
+  end
+end

data/lib/grundstein/runner.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'highline/import'
+
+module Grundstein
+  # Entry point for the command line interface.
+  class Runner < Thor
+    using Grundstein::Refinements::ColoredStrings
+
+    desc :list, 'Lists all available generators.'
+    def list
+      Generator::Repository.instance.generators.each do |name|
+        gen = Generator::Loader.new(name)
+        puts "  #{gen.name.ljust(20).c_gen} #{gen.desc}"
+      end
+    rescue Generator::GeneratorError => e
+      puts "ERROR: #{e.to_s.c_error}"
+    end
+
+    desc 'add NAME', 'Runs the given generator in the current directory.'
+    def add(generator_name)
+      generator = Generator::Loader.new(generator_name)
+      generator.run
+    rescue Generator::GeneratorError => e
+      puts "ERROR: #{e.to_s.c_error}"
+      # TODO: ask stuff (https://github.com/JEG2/highline)
+      # e.g.: gitignore will ask you if your intend to use Vagrant or Ruby or C...
+    end
+  end
+end

data/lib/grundstein/version.rb

@@ -0,0 +1,3 @@
+module Grundstein
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: grundstein
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Rothe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: Grundstein automates adding common files by we adding (smart) templates.
+  E.g. add a Vagrantfile, a .gitignore, or a sinatra app.
+email:
+- info@tomrothe.de
+executables:
+- grundstein
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.Development.md
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/grundstein
+- generators/#vagrant/ask_for_ubuntu_or_fedora
+- generators/rubocop/.rubocop.yml
+- generators/rubocop/Gemfile
+- generators/rubocop/README.Development.md
+- generators/rubocop/Rakefile
+- generators/rubocop/_generator.rb
+- generators/sdoc/.gitignore
+- generators/sdoc/Gemfile
+- generators/sdoc/README.Development.md
+- generators/sdoc/README.md
+- generators/sdoc/Rakefile
+- generators/sdoc/_generator.rb
+- generators/sdoc/doc/.keep
+- grundstein.gemspec
+- lib/grundstein.rb
+- lib/grundstein/generator.rb
+- lib/grundstein/generator/environment.rb
+- lib/grundstein/generator/errors.rb
+- lib/grundstein/generator/loader.rb
+- lib/grundstein/generator/repository.rb
+- lib/grundstein/refinements.rb
+- lib/grundstein/refinements/colored_strings.rb
+- lib/grundstein/runner.rb
+- lib/grundstein/version.rb
+homepage: https://github.com/motine/grundstein
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Automates adding common files to your project.
+test_files: []