folder_template 0.1.1

data/test/test_template_folder.rb

@@ -0,0 +1,62 @@
+# =============================================================================
+#  
+# MODULE      : lib/ruby_project_generator/version.rb
+# PROJECT     : RubyProjectGenerator
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+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( :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' ) }
+
+      it "" do
+        fs = FsAdapter.new( actual_output_path, verbose:false )
+        template.generate(  fs, env )
+
+        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_folder_entry.rb

@@ -0,0 +1,147 @@
+# =============================================================================
+#  
+# 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 TemplateFolderEntry do
+    
+    describe "when initialized for directory entry" do
+      let(:filename)    { "lib/{{project_name}}" }
+      let(:content)     { nil }
+      subject           { TemplateFolderEntry.new( filename, content ) }
+
+      it "parses filename into a TemplateString" do
+        subject.filename_template.must_be_kind_of TemplateString
+      end
+
+      it "parses filename correctly" do
+        "#{subject.filename_template}".must_equal filename
+      end
+
+      it "sets content_template to nil" do
+        subject.content_template.must_be_nil
+      end
+
+      
+      describe "when asking for variables" do
+        it "returns filename variables" do
+          subject.variables.must_equal subject.filename_template.variables
+        end
+      end
+      
+      describe "when calling generate" do
+        let(:fs) { MiniTest::Mock.new }
+        let(:env) { Hash.new.merge( project_name:"aaa", class_filename:"bbb" ) }
+
+        it "expands content and filename and invokes fs.write_to_file()" do
+          expected_filename = subject.filename_template.expand( env ).to_s
+          fs.expect :makedirs, nil, [expected_filename]
+
+          subject.generate( fs, env )
+        end
+      end
+      
+    end
+
+    describe "when initialized for file entry" do
+      let(:filename)    { "lib/{{project_name}}/{{project_name}}.rb" }
+      let(:content)     { "# {{filename}}\n\nrequire_relative 'lib/{{project_name}}/{{class_filename}}.rb'" }
+      subject           { TemplateFolderEntry.new( filename, content ) }
+      
+      it "parses filename into a TemplateString" do
+        subject.filename_template.must_be_kind_of TemplateString
+      end
+
+      it "parses filename correctly" do
+        "#{subject.filename_template}".must_equal filename
+      end
+
+      it "prases content into TemplateString" do
+        subject.content_template.must_be_kind_of TemplateString
+      end
+
+      it "parses content correctly" do
+        "#{subject.content_template}".must_equal content
+      end
+      
+      describe "when asking for variables" do
+        it "returns a union set of filename and content variables" do
+          expected_variables = subject.filename_template.variables + subject.content_template.variables
+          subject.variables.must_equal expected_variables
+        end
+      end
+      
+      describe "when calling generate" do
+        let(:fs) { MiniTest::Mock.new }
+        let(:env) { Hash.new.merge( project_name:"aaa", class_filename:"bbb" ) }
+
+        it "expands content and filename and invokes fs.write_to_file()" do
+          expected_filename = subject.filename_template.expand( env ).to_s
+          expected_content = subject.content_template.expand( env.merge( filename:expected_filename) ).to_s
+          fs.expect :write_to_file, nil, [expected_filename, expected_content]
+
+          subject.generate( fs, env )
+        end
+      end
+    end
+
+    describe "when initialized for append entry" do
+      let(:filename)    { "lib/>>{{project_name}}.rb" }
+      let(:content)     { "# {{filename}}\n\nrequire_relative 'lib/{{project_name}}/{{class_filename}}.rb'" }
+      subject           { TemplateFolderEntry.new( filename, content ) }
+
+      it "parses filename into a TemplateString" do
+        subject.filename_template.must_be_kind_of TemplateString
+      end
+
+      it "removes append marker from filename template" do
+        "#{subject.filename_template}".must_equal filename.gsub( ">>", "" )
+      end
+
+      it "marks entry as append" do
+        subject.append.must_equal true
+      end
+
+      it "prases content into TemplateString" do
+        subject.content_template.must_be_kind_of TemplateString
+      end
+
+      it "parses content correctly" do
+        "#{subject.content_template}".must_equal content
+      end
+
+
+      describe "when asking for variables" do
+        it "returns a union set of filename and content variables" do
+          expected_variables = subject.filename_template.variables + subject.content_template.variables
+          subject.variables.must_equal expected_variables
+        end
+      end
+
+      describe "when calling generate" do
+        let(:fs) { MiniTest::Mock.new }
+        let(:env) { Hash.new.merge( project_name:"aaa", class_filename:"bbb" ) }
+
+        it "expands content and filename and invokes fs.write_to_file()" do
+          expected_filename = subject.filename_template.expand( env ).to_s
+          expected_content = subject.content_template.expand( env.merge( filename:expected_filename) ).to_s
+          fs.expect :append_to_file, nil, [expected_filename, expected_content]
+
+          subject.generate( fs, env )
+        end
+      end
+    end
+
+  end # describe TemplateString
+end
+
+

data/test/test_template_string.rb

@@ -0,0 +1,94 @@
+# =============================================================================
+#  
+# 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 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
+
+      it "splits definition into Strings and Symbols" do
+        content_types = Set.new( subject.content.map { |e| e.class } )
+        content_types.must_equal Set.new( [String, Symbol] )
+      end
+
+      it "splits definition into constituant parts" do
+        subject.content.must_equal ["prefix ", :arg1, " infix ", :arg2, " suffix"]
+      end
+
+      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
+        template = TemplateString.new( "{{arg0}}{{arg1}} prefix {{arg2}}{{arg3}} suffix {{arg4}}{{arg5}}" )
+        template.variables.must_equal Set.new( [:arg0, :arg1, :arg2, :arg3, :arg4, :arg5] )
+      end
+
+      it "keeps only non empty strings" do
+        template = TemplateString.new( "{{arg0}}{{arg1}} prefix {{arg2}}{{arg3}} suffix {{arg4}}{{arg5}}" )
+        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
+
+      it "preserves undefined variables" do
+        "#{subject.expand( arg1:"aaa" )}".must_equal "prefix aaa infix {{arg2}} suffix"
+      end
+
+      it "passes undefined variables to block" do
+        result = subject.expand( arg1:"aaa" ) do |variable|
+          "<#{variable}>"
+        end
+        "#{result}".must_equal "prefix aaa infix <arg2> suffix"
+      end
+
+      it "preserves template variable when block returns nil" do
+        result = subject.expand( arg1:"aaa" ) do |variable|
+          nil
+        end
+        "#{result}".must_equal "prefix aaa infix {{arg2}} suffix"
+      end
+
+      it "removes undefined variables when block returns empty string" do
+        result = subject.expand( arg1:"aaa" ) do |variable|
+          ""
+        end
+        "#{result}".must_equal "prefix aaa infix  suffix"
+      end
+    end
+    
+  end # describe TemplateString
+end
+
+

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: folder_template
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marc-Antoine Argenton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-10 00:00:00.000000000 Z
+dependencies:
+- !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: watch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 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.
+email:
+- maargenton.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- folder_template.gemspec
+- lib/folder_template.rb
+- lib/folder_template/fs_adapter.rb
+- lib/folder_template/template_folder.rb
+- lib/folder_template/template_folder_entry.rb
+- lib/folder_template/template_string.rb
+- lib/folder_template/version.rb
+- rakefile.rb
+- test/_test_env.rb
+- test/data/test1/actual_output/lib/project_aaa.rb
+- test/data/test1/actual_output/lib/project_aaa/cls_fn.rb
+- test/data/test1/actual_output/test_/_test_cls_fn.rb
+- test/data/test1/expected_output/lib/project_aaa.rb
+- test/data/test1/expected_output/lib/project_aaa/cls_fn.rb
+- test/data/test1/expected_output/test_/_test_cls_fn.rb
+- test/data/test1/template/lib/>>{{project_name}}.rb
+- test/data/test1/template/lib/{{project_name}}/{{class_filename}}.rb
+- test/data/test1/template/test_/_test_{{class_filename}}.rb
+- test/data/test_append/actual_output/lib/project_aaa.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls1_fn.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls2_fn.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls3_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls1_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls2_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls3_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls1_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls2_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls3_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls1_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls2_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls3_fn.rb
+- test/data/test_append/template/lib/>>{{project_name}}.rb
+- test/data/test_append/template/lib/{{project_name}}/{{class_filename}}.rb
+- test/data/test_append/template/test_/_test_{{class_filename}}.rb
+- test/test_fs_adapter.rb
+- test/test_template_folder.rb
+- test/test_template_folder_entry.rb
+- test/test_template_string.rb
+homepage: ''
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple and generic folder structure template engine
+test_files:
+- test/_test_env.rb
+- test/data/test1/actual_output/lib/project_aaa.rb
+- test/data/test1/actual_output/lib/project_aaa/cls_fn.rb
+- test/data/test1/actual_output/test_/_test_cls_fn.rb
+- test/data/test1/expected_output/lib/project_aaa.rb
+- test/data/test1/expected_output/lib/project_aaa/cls_fn.rb
+- test/data/test1/expected_output/test_/_test_cls_fn.rb
+- test/data/test1/template/lib/>>{{project_name}}.rb
+- test/data/test1/template/lib/{{project_name}}/{{class_filename}}.rb
+- test/data/test1/template/test_/_test_{{class_filename}}.rb
+- test/data/test_append/actual_output/lib/project_aaa.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls1_fn.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls2_fn.rb
+- test/data/test_append/actual_output/lib/project_aaa/cls3_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls1_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls2_fn.rb
+- test/data/test_append/actual_output/test_/_test_cls3_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls1_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls2_fn.rb
+- test/data/test_append/expected_output/lib/project_aaa/cls3_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls1_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls2_fn.rb
+- test/data/test_append/expected_output/test_/_test_cls3_fn.rb
+- test/data/test_append/template/lib/>>{{project_name}}.rb
+- test/data/test_append/template/lib/{{project_name}}/{{class_filename}}.rb
+- test/data/test_append/template/test_/_test_{{class_filename}}.rb
+- test/test_fs_adapter.rb
+- test/test_template_folder.rb
+- test/test_template_folder_entry.rb
+- test/test_template_string.rb