folder_template 0.1.1 → 1.0.0

data/test_data/rubygem/expected_output/_.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  # - jruby
+  # - rbx-2

data/test_data/rubygem/expected_output/folder_name.gemspec

@@ -0,0 +1,37 @@
+# =============================================================================
+#
+# MODULE      : folder_name.gemspec
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+
+require_relative 'lib/folder_name/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'folder_name'
+  spec.version      = FolderName::VERSION
+  spec.authors      = ["<<test_user>>"]
+  spec.email        = [""]
+  spec.summary      = ""
+  spec.description  = %q{
+                      }.gsub( /\s+/, ' ').strip
+  spec.homepage     = ""
+
+  spec.files        = Dir['[A-Z]*', 'rakefile.rb', '*.gemspec'].reject { |f| f =~ /.lock/ }
+  spec.files        += Dir['bin/**', 'lib/**/*.rb', 'test/**/*.rb', 'spec/**/*.rb', 'features/**/*.rb']
+  spec.executables  = spec.files.grep( %r{^bin/} ) { |f| File.basename(f) }
+  spec.test_files   = spec.files.grep( %r{^(test|spec|features)/} )
+
+  # spec.add_runtime_dependency 'facets', '~> 3.0'
+  # spec.add_runtime_dependency 'mustache', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'watch', '~> 0.1'
+  spec.add_development_dependency 'rr', '~> 1.1'
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+end

data/test_data/rubygem/expected_output/lib/folder_name/version.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_name/version.rb
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+module FolderName
+  VERSION = '0.0.1'
+end

data/test_data/rubygem/expected_output/lib/folder_name.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_name.rb
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+
+
+require_relative 'folder_name/version.rb'

data/test_data/rubygem/expected_output/rakefile.rb

@@ -0,0 +1,56 @@
+# =============================================================================
+#
+# MODULE      : rakefile.rb
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+PROJECT_CONTEXT = {
+  project_name:       "folder_name",
+  project_namespace:  "FolderName",
+  copyright_owner:    "<<test_user>>",
+  copyright_year:     "<<test_year>>",
+}
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = false
+end
+
+
+
+begin
+  require 'watch'
+  w = `tput cols`.to_i || 80
+
+  def tty_red(str);           "\e[31m#{str}\e[0m" end
+  def tty_green(str);         "\e[32m#{str}\e[0m" end
+  def tty_blink(str);         "\e[5m#{str}\e[25m" end
+  def tty_reverse_color(str); "\e[7m#{str}\e[27m" end
+
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :autotest do
+    Watch.new( '**/*.rb' ) do
+      success = system "clear && rake test"
+
+      puts tty_green( "-" * w ) if success
+      puts tty_reverse_color(tty_red( "-" * w )) if !success
+    end
+  end
+
+  desc 'Alias for rake autotest'
+  task watch: [:autotest]
+
+rescue LoadError
+  puts "'rake autotest' unavailable"
+end
+
+task default: [:test, :build]

data/test_data/rubygem/expected_output/test/_test_env.rb

@@ -0,0 +1,27 @@
+# =============================================================================
+#
+# MODULE      : test/_test_env.rb
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'fileutils'
+require 'pp'
+require 'rr'
+
+require 'lib/folder_name.rb'
+
+# Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+
+module Minitest::Assertions
+  def assert_custom( expected, actual )
+    assert false, "assert_custom() always fails\n" +
+                  "  Expected: #{expected.inspect}\n" +
+                  "  Actak:    #{actual.inspect}\n"
+  end
+end

data/test_data/rubygem/expected_output/test/test_version.rb

@@ -0,0 +1,23 @@
+# =============================================================================
+#
+# MODULE      : test/test_version.rb
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+module FolderName
+
+  describe Version do
+    subject { VERSION }
+
+    it "is definied as a string" do
+      subject.must_be_instance_of String
+    end
+  end
+
+end

data/test_data/rubygem/template_definition/context.rb

@@ -0,0 +1,13 @@
+# rubygem/context.rb
+
+let( :_ )                   { "" }
+let( :project_name )        { folder_name }
+let( :project_namespace )   { folder_name.capitalize.camelcase }
+let( :username )            { `id -F`.strip }
+let( :copyright_owner )     { username }
+let( :copyright_year )      { Time.now.year }
+
+# Overwrite for constant output for test puprose
+let( :_ )                   { "_" }
+let( :username )            { "<<test_user>>" }
+let( :copyright_year )      { "<<test_year>>" }

data/test_data/rubygem/template_definition/template/Gemfile

@@ -0,0 +1,13 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+
+source 'https://rubygems.org'
+gemspec

data/test_data/rubygem/template_definition/template/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+
+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/test_data/rubygem/template_definition/template/README.md

@@ -0,0 +1,108 @@
+# FolderTemplate
+
+[![Gem Version](https://badge.fury.io/rb/folder_template.svg)](https://badge.fury.io/rb/folder_template)
+[![Build Status](https://travis-ci.org/marcus999/folder_template.svg?branch=master)](https://travis-ci.org/marcus999/folder_template)
+[![Code Climate](https://codeclimate.com/github/Marcus999/folder_template/badges/gpa.svg)](https://codeclimate.com/github/Marcus999/folder_template)
+[![Issue Count](https://codeclimate.com/github/Marcus999/folder_template/badges/issue_count.svg)](https://codeclimate.com/github/Marcus999/folder_template)
+
+
+
+
+FolderTemplate is a minimalistic template engine that generates files and
+folders structure from a template folder layout. It includes a simple variable
+expansion syntax, automatically injects variables for filename and basename,
+and can optionally append content to existing files.
+
+
+## Template definitions
+
+- Templates are defined as files and folders on disk
+- Variables are surrounded with double curly: `{{variable}}`
+- Variables can be part of filenames, folder names, and file content
+- Template filename with a `>>` prefix will append their content to an existing file
+
+
+## Usage
+
+```ruby
+require 'folder_template'
+
+template = FolderTemplate::TemplateFolder.new( template_path )
+fs = FolderTemplate::FsAdapter.new( output_path, opts... )
+env = Hash.new.merge( project_name:"my_project", ... )
+
+template.generate( fs, env )
+```
+
+
+## FsAdapter
+
+All filesystem operation are abstracted through an `FsAdapter` object that
+performs final filename expansion, and execute all filesystem manipulations.
+
+The `FsAdapter` interface is composed of 3 methods; any class implementing
+those 3 methods can be used in place of the default `FsAdapter` object to
+perform the necessary filesystem operations.
+
+```ruby
+def makedirs( dirname )
+def write_to_file( filename, content )
+def append_to_file( filename, content )
+```
+
+Default implementation of `FsAdapter` accepts a few options:
+
+| Option             | Default | Description           |
+| ------------------ |---------|-----------------------|
+| `verbose`          | `false` | When `true`, log each operation that is performed |
+| `overwrite_files`  | `false` | When `true`, replace existing files with content generated from template |
+
+
+
+
+
+
+
+
+
+
+
+# Project
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/__project__`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '__project__'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install __project__
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/__project__/fork )
+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 a new Pull Request

data/test_data/rubygem/template_definition/template/lib/{{project_name}}/version.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+module {{project_namespace}}
+  VERSION = '0.0.1'
+end

data/test_data/rubygem/template_definition/template/lib/{{project_name}}.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+
+require_relative '{{project_name}}/version.rb'

data/test_data/rubygem/template_definition/template/rakefile.rb

@@ -0,0 +1,56 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+PROJECT_CONTEXT = {
+  project_name:       "{{project_name}}",
+  project_namespace:  "{{project_namespace}}",
+  copyright_owner:    "{{copyright_owner}}",
+  copyright_year:     "{{copyright_year}}",
+}
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = false
+end
+
+
+
+begin
+  require 'watch'
+  w = `tput cols`.to_i || 80
+
+  def tty_red(str);           "\e[31m#{str}\e[0m" end
+  def tty_green(str);         "\e[32m#{str}\e[0m" end
+  def tty_blink(str);         "\e[5m#{str}\e[25m" end
+  def tty_reverse_color(str); "\e[7m#{str}\e[27m" end
+
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :autotest do
+    Watch.new( '**/*.rb' ) do
+      success = system "clear && rake test"
+
+      puts tty_green( "-" * w ) if success
+      puts tty_reverse_color(tty_red( "-" * w )) if !success
+    end
+  end
+
+  desc 'Alias for rake autotest'
+  task watch: [:autotest]
+
+rescue LoadError
+  puts "'rake autotest' unavailable"
+end
+
+task default: [:test, :build]

data/test_data/rubygem/template_definition/template/test/_test_env.rb

@@ -0,0 +1,27 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'fileutils'
+require 'pp'
+require 'rr'
+
+require 'lib/{{project_name}}.rb'
+
+# Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+
+module Minitest::Assertions
+  def assert_custom( expected, actual )
+    assert false, "assert_custom() always fails\n" +
+                  "  Expected: #{expected.inspect}\n" +
+                  "  Actak:    #{actual.inspect}\n"
+  end
+end

data/test_data/rubygem/template_definition/template/test/test_version.rb

@@ -0,0 +1,23 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+module {{project_namespace}}
+
+  describe Version do
+    subject { VERSION }
+
+    it "is definied as a string" do
+      subject.must_be_instance_of String
+    end
+  end
+
+end

data/test_data/rubygem/template_definition/template/{{_}}.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- test/

data/test_data/rubygem/template_definition/template/{{_}}.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/tmp/