folder_template 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57f1ea5e547be1744282bff8cd884c09025ce012
+  data.tar.gz: 2aab075e18769cc2c8fecaf5207ca790e0e8f698
+SHA512:
+  metadata.gz: b33c362595bc85d82e41bb541dff05d47f1d47a6ad995e414e46726b5dc8f5ba84e871e6d6c0df34be9cedb0780cfcbcdf6619da5386095a7d37be8675e44d2c
+  data.tar.gz: 561c584694d6c79071b507f7d06f6e47826aa3fd99695444e68c90aaf12b9e4f8f1abf382cdd2ef173d228a01f3ecc687b618fae4411d8088b5e25e84f049215

data/Gemfile

@@ -0,0 +1,11 @@
+# =============================================================================
+#  
+# MODULE      : Gemfile
+\# PROJECT     : FolderTemplate
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016, Marc-Antoine Argenton.  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/README.md

@@ -0,0 +1,55 @@
+# FolderTemplate
+
+[![Gem Version](https://badge.fury.io/rb/rr.svg)](http://badge.fury.io/rb/rr)
+[![Build Status](https://travis-ci.org/rr/rr.svg?branch=master)](https://travis-ci.org/rr/rr)
+[![Code Climate GPA](https://codeclimate.com/github/rr/rr.svg)](https://codeclimate.com/github/rr/rr)
+
+
+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 |

data/folder_template.gemspec

@@ -0,0 +1,38 @@
+# =============================================================================
+#
+# MODULE      : folder_template.gemspec
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+require_relative 'lib/folder_template/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'folder_template'
+  spec.version      = FolderTemplate::VERSION
+  spec.authors      = ["Marc-Antoine Argenton"]
+  spec.email        = ["maargenton.dev@gmail.com"]
+  spec.summary      = "Simple and generic folder structure template engine"
+  spec.description  = %q{ 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.
+                      }.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'
+end

data/lib/folder_template.rb

@@ -0,0 +1,20 @@
+# =============================================================================
+#  
+# MODULE      : lib/ruby_project_generator.rb
+# PROJECT     : RubyProjectGenerator
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+require 'fileutils'
+
+module FolderTemplate
+  BASE_PATH = File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) )
+end
+
+require_relative 'folder_template/version.rb'
+require_relative 'folder_template/fs_adapter.rb'
+require_relative 'folder_template/template_string.rb'
+require_relative 'folder_template/template_folder_entry.rb'
+require_relative 'folder_template/template_folder.rb'

data/lib/folder_template/fs_adapter.rb

@@ -0,0 +1,64 @@
+# =============================================================================
+#  
+# MODULE      : lib/folder_template/fs_adapter.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module FolderTemplate
+
+  class FsAdapter
+    attr_reader :base_path
+    attr_reader :opts
+
+    def initialize( base_path, **opts )
+      @base_path = base_path
+      @opts = opts
+    end
+
+    def makedirs( dirname )
+      target = File.join( base_path, dirname )
+      return if ( File.directory?( target ) )
+
+      puts "Creating diectory #{dirname} ..." if opts[:verbose]
+      FileUtils.makedirs( target )
+    end
+    
+    def write_to_file( filename, content )
+      target = File.join( base_path, filename )
+      
+      if ( File.exists?( target ) && ! opts[:overwrite_files] )
+        puts "Skiping file #{filename} ..." if opts[:verbose]
+      else
+        puts "Generating file #{filename} ..." if opts[:verbose]
+        FileUtils.makedirs( File.dirname( target ) )
+        File.write( target, content )
+      end
+    end
+
+    def append_to_file( filename, content )
+      target = File.join( base_path, filename )
+      
+      puts "Appending content to file #{filename} ..." if opts[:verbose]
+      FileUtils.makedirs( File.dirname( target ) )
+      File.open( target, "a" ) { |f| f.write( content ) }
+    end
+  end # class FsAdapter
+  
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/folder_template/template_folder.rb

@@ -0,0 +1,58 @@
+# =============================================================================
+#  
+# MODULE      : lib/folder_template/template_folder.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module FolderTemplate
+
+  class TemplateFolder
+    attr_reader :entries
+    
+    def initialize( path )
+      @entries = _load_template( path )
+    end
+    
+    def variables
+      @variables ||= entries.each_with_object( Set.new ) do |e, variables|
+        variables.merge( e.variables )
+      end
+    end
+
+    def generate( fs, **env )
+      entries.each do |entry|
+        entry.generate( fs, env )
+      end
+    end
+    
+
+  private
+    def _load_template( path )
+      prefix = File.join( path, "" )
+      
+      Dir[File.join( path, "**", "*")].map do |source|
+        filename = source.gsub( prefix, '' )
+        content = File.read( source ) if !File.directory?( source )
+        TemplateFolderEntry.new( filename, content )
+      end
+    end
+  end # class TemplateFolder
+
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/folder_template/template_folder_entry.rb

@@ -0,0 +1,59 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/template_folder.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module FolderTemplate
+
+  class TemplateFolderEntry
+    attr_reader :filename_template
+    attr_reader :content_template
+    attr_reader :append
+
+    def initialize( filename, content )
+      @append, filename = _filter_append_marker( filename )
+      @filename_template = TemplateString.new( filename )
+      @content_template = TemplateString.new( content ) if !content.nil?
+    end
+
+    def variables
+      @variables ||= [filename_template, content_template].reject do |t|
+        t.nil?
+      end.each_with_object( Set.new ) do |t, variables|
+        variables.merge( t.variables )
+      end
+    end
+
+
+    def generate( fs, **env )
+      filename = filename_template.expand( env ).to_s
+      basename = File.basename( filename, File.extname( filename ) )
+
+      if ( content_template )
+        local_env = env.merge( filename:filename, basename:basename )
+        content = content_template.expand( local_env ).to_s
+        if ( append )
+          fs.append_to_file( filename, content )
+        else
+          fs.write_to_file( filename, content )
+        end
+      else
+        fs.makedirs( filename )
+      end
+    end
+
+  private
+    def _filter_append_marker( filename )
+      basename = File.basename( filename )
+      dirname = File.dirname( filename )
+
+      return false, filename if !basename.start_with?( ">>" )
+      return true, File.join( dirname, basename[2..-1] )
+    end
+  end # class TemplateFolderEntry
+
+end

data/lib/folder_template/template_string.rb

@@ -0,0 +1,68 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/template_string.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module FolderTemplate
+  class TemplateString
+    attr_reader :content
+
+    def initialize( template )
+      case template
+      when String
+        @content = _parse( template )
+      when Array
+        @content = template.select do |fragment|
+          !fragment.nil? && !fragment.empty?
+        end
+      when TemplateString
+        @content = template.content
+      end
+    end
+
+    def variables
+      @variables ||= _extract_variables( @content )
+    end
+
+    def expand( **env )
+      fragments = content.map do |fragment|
+        case fragment
+        when Symbol
+          env[fragment] || (yield fragment if block_given?)|| fragment
+        else
+          fragment
+        end
+      end.select { |fragment| !fragment.nil? && !fragment.empty? }
+      TemplateString.new( fragments )
+    end
+
+    def to_s
+      @content.map do |fragment|
+        ("{{#{fragment}}}" if Symbol === fragment) || fragment
+      end.join
+    end
+
+  private
+    VARIABLE_PATTERN = /{{(\w+)}}/
+
+    def _parse( template )
+      result = []
+      tail = template
+      loop do
+        head, token, tail = tail.partition( VARIABLE_PATTERN )
+        result << head if !head.empty?
+        break if $1.nil?
+        result << $1.to_sym
+      end
+      result
+    end
+
+    def _extract_variables( content )
+      Set.new( content.select { |s| Symbol === s } )
+    end
+  end
+end

data/lib/folder_template/version.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/version.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+module FolderTemplate
+  VERSION = '0.1.1'
+end

data/rakefile.rb

@@ -0,0 +1,42 @@
+# =============================================================================
+#  
+# MODULE      : rakefile.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION : 
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+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
+
+rescue Exception => e
+end
+
+task :default => [:test, :build]