folder_template 0.1.1 → 1.0.0

data/templates/rubygem/template/{{_}}.travis.yml

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

data/templates/rubygem/template/{{project_name}}.gemspec

@@ -0,0 +1,37 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+require_relative 'lib/{{project_name}}/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name         = '{{project_name}}'
+  spec.version      = {{project_namespace}}::VERSION
+  spec.authors      = ["{{copyright_owner}}"]
+  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/_test_env.rb

@@ -1,31 +1,31 @@
 # =============================================================================
-#  
+#
 # MODULE      : test/_test_env.rb
 # PROJECT     : RubyProjectGenerator
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
 
 require 'minitest/autorun'
+require 'minitest/reporters'
 require 'fileutils'
 require 'pp'
 require 'rr'
 
 require 'lib/folder_template.rb'
 
+# Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
 
 
 module Minitest::Assertions
   def assert_folders_match( expected_folder, actual_folder )
     diffs = _diff_folders( expected_folder, actual_folder )
-    assert diffs.empty?,
-      "Expected folders content to match:\n#{diffs}\n"
-      # "Expected folders to match:\nexpected: #{expected_folder.inspect}\nactual: #{expected_folder.inspect}\ndiffs:\n#{diffs}"
+    assert diffs.empty?, "Expected folders content to match:\n#{diffs}\n"
   end
-  
+
 private
   def _diff_folders( expected_folder, actual_folder )
     `diff -r -u --exclude=.DS_Store #{expected_folder} #{actual_folder}`
   end
-end
+end

data/test/test_context.rb

@@ -0,0 +1,116 @@
+
+# =============================================================================
+#
+# MODULE      : test/ruby_project_generator/template_string.rb
+# PROJECT     : RubyProjectGenerator
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+
+module FolderTemplate
+  describe Context do
+
+    describe "it implements DSL to support value lazzy definition" do
+      let( :filename ) { 'path/to/context_file' }
+      let( :content ) { "let( :bbb ) { aaa + 1 if aaa }" }
+      subject { Context.load_from_content( content, filename ) }
+
+      it "holds definition for values declared in context DSL file" do
+        subject.merge!( aaa:123 )
+        subject[:bbb].must_equal( 124 )
+      end
+    end
+
+
+    describe "it behaves like a Hash" do
+      subject {
+        ctx = Context.new
+        ctx.let( :bbb ) { aaa + 1 }
+        ctx.let( :aaa ) { 123 }
+        ctx
+      }
+
+      it "supports value accessor with symbols" do
+        subject[:bbb].must_equal( 124 )
+      end
+
+      it "supports value assignment with symbols" do
+        subject[:aaa] = 112
+        subject[:aaa].must_equal( 112 )
+      end
+
+      it "updates evaluation of dependent variables after value assignment" do
+        subject[:aaa] = 112
+        subject[:bbb].must_equal( 113 )
+      end
+
+      it "responds to values like a Hash" do
+        Set.new(subject.values).must_equal( Set.new([123, 124]) )
+      end
+
+      it "responds to each like a Hash" do
+        kv_pairs = subject.each.to_a
+        kv_pairs.must_equal( [[:bbb, 124], [:aaa, 123]] )
+      end
+    end # it behaves like a Hash
+
+
+    describe "it can be copies with all definies variables" do
+      subject {
+        ctx = Context.new
+        ctx.let( :ccc ) { aaa + bbb }
+        ctx.let( :aaa ) { 123 }
+        ctx
+      }
+
+      it "creates an independant contexts for each copy" do
+        ctx1 = subject.dup
+        ctx2 = subject.dup
+        ctx1[:bbb] = 1
+        ctx2[:bbb] = 2
+        ctx1[:ccc].must_equal( 124 )
+        ctx2[:ccc].must_equal( 125 )
+      end
+
+      it "merge() creates a duplicated instance of the conext" do
+        ctx1 = subject.merge( bbb:1 )
+        ctx2 = subject.merge( bbb:2 )
+        ctx1[:ccc].must_equal( 124 )
+        ctx2[:ccc].must_equal( 125 )
+      end
+    end
+
+
+    describe "it caches pre-evaluated values" do
+      subject { Context.new }
+
+      it "evaluates values only once" do
+        subject.let( :aaa ) { 123 }
+        subject.aaa.must_equal( 123 )
+        subject.definitions.delete( :aaa )
+        subject.aaa.must_equal( 123 )
+      end
+
+      it "clears cached values when variables are re-declared" do
+        subject.let( :aaa ) { 123 }
+        subject.aaa.must_equal( 123 )
+        subject.let( :aaa ) { 124 }
+        subject.aaa.must_equal( 124 )
+      end
+
+      it "re-evalutes dependant values after a change of definition" do
+        subject.let( :aaa ) { 123 }
+        subject.let( :bbb ) { aaa + 1 }
+        subject.bbb.must_equal( 124 )
+        subject.let( :aaa ) { 124 }
+        subject.bbb.must_equal( 125 )
+      end
+    end
+
+  end # describe Context
+end

data/test/test_fs_adapter.rb

@@ -1,8 +1,8 @@
 # =============================================================================
-#  
+#
 # MODULE      : lib/ruby_project_generator/test_fs_adapter.rb
 # PROJECT     : RubyProjectGenerator
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
@@ -16,41 +16,39 @@ module FolderTemplate
   describe FsAdapter do
     let( :tmpdir ) { "tmp" }
     subject { FsAdapter.new( tmpdir ) }
-  
+
     before do
       stub(FileUtils).makedirs()
       stub(File).open()
       stub(File).write()
     end
-  
+
     describe "when calling makedirs()" do
       it "expands filename and calls FileUtils.makedirs()" do
         mock(FileUtils).makedirs( File.join( tmpdir, "aaa/bbb" ) )
         subject.makedirs( "aaa/bbb" )
       end
     end
-    
+
     describe "when calling write_to_file()" do
       it "expands filename, creates containing folder and calls File.write()" do
         expected_filename = File.join( tmpdir, "aaa/bbb" )
         mock(FileUtils).makedirs( File.dirname( expected_filename ) )
         mock(File).write( expected_filename, "bbb" )
-      
+
         subject.write_to_file( "aaa/bbb", "bbb" )
       end
     end
-    
+
     describe "when calling append_to_file()" do
       it "expands filename, opens file for append and appends content" do
         expected_filename = File.join( tmpdir, "aaa/bbb" )
         mock(FileUtils).makedirs( File.dirname( expected_filename ) )
         mock(File).open( expected_filename, "a" )
-      
+
         subject.append_to_file( "aaa/bbb", "bbb" )
       end
     end
   end
 
 end
-
-

data/test/test_setup_folder_cmd.rb

@@ -0,0 +1,44 @@
+# =============================================================================
+#
+# MODULE      : lib/ruby_project_generator/test_setup_folder_cmd.rb
+# PROJECT     : RubyProjectGenerator
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require '_test_env.rb'
+
+
+module FolderTemplate
+  describe SetupFolderCmd do
+
+    it "requires a least two command line arguments" do
+      err = assert_raises RuntimeError do
+        SetupFolderCmd.new()
+      end
+      err.message.must_match /missing/i
+      err.message.must_match /required/i
+      err.message.must_match /arguments/i
+    end
+
+    it "extracts target_path and template_name from argument list" do
+      cmd = SetupFolderCmd.new( '.', 'rubygem' )
+      cmd.target_path.must_equal( File.expand_path( '.' ) )
+      cmd.template_name.must_equal( 'rubygem' )
+    end
+
+    it "parses variables definition" do
+      cmd = SetupFolderCmd.new( '.', 'rubygem', 'aaa=123', 'bbb=234' )
+      cmd.variables.must_equal( { aaa:'123', bbb:'234' } )
+    end
+
+    it "locates the template directory based on the requested name" do
+      cmd = SetupFolderCmd.new( '.', 'rubygem', 'aaa=123', 'bbb=234' )
+      cmd.template_path.wont_be_nil
+      TemplateFolder.validate_template_path( cmd.template_path ).must_equal true
+    end
+
+  end # describe SetupFolderCmd
+end # module FolderTemplate

data/test/test_template_folder.rb

@@ -1,8 +1,8 @@
 # =============================================================================
-#  
+#
 # MODULE      : lib/ruby_project_generator/version.rb
 # PROJECT     : RubyProjectGenerator
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
@@ -14,23 +14,20 @@ require '_test_env.rb'
 module FolderTemplate
 
   describe TemplateFolder do
-    let( :data_base_path )        { File.join( FolderTemplate::BASE_PATH, 'test', 'data' ) }
-    let( :template )              { TemplateFolder.new( File.join( data_base_path, data_test_name, 'template' ) ) }
+    let( :data_base_path )        { File.join( FolderTemplate::BASE_PATH, 'test_data' ) }
+    let( :template )              { TemplateFolder.new( File.join( data_base_path, data_test_name, 'template_definition' ) ) }
     let( :expected_output_path )  { File.join( data_base_path, data_test_name, 'expected_output' ) }
     let( :actual_output_path )    { File.join( data_base_path, data_test_name, 'actual_output' ) }
-    let( :base_env ) { Hash.new.merge(  project_name:       'project_aaa',
-                                        project_namespace:  'ProjectAaa',
-                                        copyright_owner:    'Me',
-                                        copyright_year:     'YEAR' ) }
 
     before do
       FileUtils.rm_rf( actual_output_path )
       FileUtils.makedirs( actual_output_path )
     end
-    
-    describe "test1" do
-      let( :data_test_name ) { 'test1' }
-      let( :env ) { base_env.merge( class_filename:'cls_fn', class_name:'ClsName' ) }
+
+
+    describe "rubygem" do
+      let( :data_test_name ) { 'rubygem' }
+      let( :env ) { {}.merge( folder_name:'folder_name' ) }
 
       it "" do
         fs = FsAdapter.new( actual_output_path, verbose:false )
@@ -40,23 +37,21 @@ module FolderTemplate
       end
     end
 
-    describe "test_append" do
-      let( :data_test_name ) { 'test_append' }
-      let( :env ) { base_env }
-
-      it "" do
-        fs = FsAdapter.new( actual_output_path, verbose:false )
-        template.generate(  fs, env.merge( class_filename:'cls1_fn', class_name:'Cls1Name') )
-        template.generate(  fs, env.merge( class_filename:'cls2_fn', class_name:'Cls2Name') )
-        template.generate(  fs, env.merge( class_filename:'cls3_fn', class_name:'Cls3Name') )
-        
-        assert_folders_match( expected_output_path, actual_output_path )
-      end
-    end
+    # describe "test_append" do
+    #   let( :data_test_name ) { 'test_append' }
+    #   let( :env ) { base_env }
+    #
+    #   it "" do
+    #     fs = FsAdapter.new( actual_output_path, verbose:false )
+    #     template.generate(  fs, env.merge( class_filename:'cls1_fn', class_name:'Cls1Name') )
+    #     template.generate(  fs, env.merge( class_filename:'cls2_fn', class_name:'Cls2Name') )
+    #     template.generate(  fs, env.merge( class_filename:'cls3_fn', class_name:'Cls3Name') )
+    #
+    #     assert_folders_match( expected_output_path, actual_output_path )
+    #   end
+    # end
 
 
   end # describe TemplateFolder
 
 end
-
-

data/test/test_template_string.rb

@@ -1,8 +1,8 @@
 # =============================================================================
-#  
+#
 # MODULE      : test/ruby_project_generator/template_string.rb
 # PROJECT     : RubyProjectGenerator
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
@@ -13,11 +13,11 @@ require '_test_env.rb'
 
 module FolderTemplate
   describe TemplateString do
-    
+
     describe "when initialized with a string" do
       let(:template_string) { "prefix {{arg1}} infix {{arg2}} suffix" }
       subject { TemplateString.new( template_string )}
-    
+
       it "parses template string into an Array" do
         subject.content.must_be_kind_of Array
       end
@@ -34,12 +34,12 @@ module FolderTemplate
       it "extracts variables from definition string" do
         subject.variables.must_equal Set.new( [:arg1, :arg2] )
       end
-      
+
       it "evaluates to original template string" do
         "#{subject}".must_equal template_string
       end
     end
-    
+
 
     describe "when initialized special string" do
       it "finds all variables" do
@@ -52,12 +52,13 @@ module FolderTemplate
         strings = template.content.select{ |s| String === s }
         strings.must_equal( [" prefix ", " suffix "])
       end
+
     end
 
     describe "calling expand" do
       let(:template_string) { "prefix {{arg1}} infix {{arg2}} suffix" }
       subject { TemplateString.new( template_string )}
-    
+
       it "expands variables using environment" do
         "#{subject.expand( arg1:"aaa", arg2:"bbb")}".must_equal "prefix aaa infix bbb suffix"
       end
@@ -86,9 +87,22 @@ module FolderTemplate
         end
         "#{result}".must_equal "prefix aaa infix  suffix"
       end
+
     end
-    
-  end # describe TemplateString
-end
 
+    describe "when using bare undersore variable" do
+      let(:template_string) { "{{_}}.gitignore" }
+      subject { TemplateString.new( template_string )}
 
+      it "accepts bare underscore variable" do
+        subject.variables.must_equal Set.new( [:_] )
+      end
+
+      it "can expand bare underscore to nothing" do
+        result = subject.expand( _: "" )
+        "#{result}".must_equal ".gitignore"
+      end
+    end
+
+  end # describe TemplateString
+end

data/test_data/rubygem/actual_output/Gemfile

@@ -0,0 +1,13 @@
+# =============================================================================
+#
+# MODULE      : Gemfile
+# PROJECT     : FolderName
+# DESCRIPTION :
+#
+# Copyright (c) <<test_year>>, <<test_user>>.  All rights reserved.
+# =============================================================================
+
+
+
+source 'https://rubygems.org'
+gemspec

data/test_data/rubygem/actual_output/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) <<test_year>>, <<test_user>>.  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/actual_output/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/actual_output/_.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/actual_output/_.gitignore

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