folder_template 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57f1ea5e547be1744282bff8cd884c09025ce012
-  data.tar.gz: 2aab075e18769cc2c8fecaf5207ca790e0e8f698
+  metadata.gz: 626ca58b9e4faf9f2cb6ba96da02cba05864bfbd
+  data.tar.gz: 52f57ef1f7d0fbd8e093af2576baa9d4aaf3f17f
 SHA512:
-  metadata.gz: b33c362595bc85d82e41bb541dff05d47f1d47a6ad995e414e46726b5dc8f5ba84e871e6d6c0df34be9cedb0780cfcbcdf6619da5386095a7d37be8675e44d2c
-  data.tar.gz: 561c584694d6c79071b507f7d06f6e47826aa3fd99695444e68c90aaf12b9e4f8f1abf382cdd2ef173d228a01f3ecc687b618fae4411d8088b5e25e84f049215
+  metadata.gz: 04bb836061c35a0664cca5e46146e5232b6c148706b9f74faa1f1dd976b8e93760e1e127f1487dc330e297b3c39bfacfa9962bec4e7ed8282d7cb080bb94fca4
+  data.tar.gz: 38e9911a5d5dd67d83ef891d4cc22c260eecd05652b80f5b83035b6c3f22cd8998173f9f80b80b81072969bbd71f3e1d5e17bebb094e96dea0b3a74542e7c63d

data/Gemfile

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

data/README.md

@@ -1,8 +1,11 @@
 # 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)
+[![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
@@ -53,3 +56,13 @@ Default implementation of `FsAdapter` accepts a few options:
 | ------------------ |---------|-----------------------|
 | `verbose`          | `false` | When `true`, log each operation that is performed |
 | `overwrite_files`  | `false` | When `true`, replace existing files with content generated from template |
+
+
+
+## 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/bin/setup_folder

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/folder_template.rb'
+
+FolderTemplate::SetupFolderCmd.run( ARGV )

data/folder_template.gemspec

@@ -25,14 +25,18 @@ Gem::Specification.new do |spec|
 
   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.files        += Dir['test_data/**/*']
+  spec.files        += Dir['templates/**/*']
   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 '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/lib/folder_template/context.rb

@@ -0,0 +1,124 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/context.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+module FolderTemplate
+  class Context
+    attr_reader :definitions
+
+    def initialize()
+      @definitions = Hash.new()
+      @values_cache = {}
+    end
+
+    def initialize_copy( other )
+      @definitions = other.definitions.dup
+      @values_cache = {}
+    end
+
+    def self.load( filename )
+      load_from_content( File.read( filename ), filename )
+    end
+
+    def self.load_from_content( content, filename )
+      ctx = new
+      ctx.instance_eval( content, filename )
+      ctx
+    end
+
+
+
+    # -----------------------------------
+    # Hash-like API
+    # -----------------------------------
+
+    def [](key)
+      return _value_for_key( key )
+    end
+
+    def []=( key, value )
+      @definitions[key] = value
+      _clear_values_cache()
+      self
+    end
+
+    def keys
+      return @definitions.keys
+    end
+
+    def values
+      return @definitions.keys.map { |k| _value_for_key(k) }
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+      @definitions.keys.each do |k|
+        v = _value_for_key(k)
+        yield k, v
+      end
+    end
+
+    def merge!( h )
+      h.each do |k,v|
+        @definitions[k] = v
+      end
+      _clear_values_cache()
+      self
+    end
+
+    def merge( h )
+      self.dup.merge!( h )
+    end
+
+
+    # -----------------------------------
+    # DSL exposed methods
+    # -----------------------------------
+
+    def let( key, &definition )
+      @definitions[key] = definition
+      _clear_values_cache()
+      self
+    end
+
+
+
+    # -----------------------------------
+    # Support methods for DSL implementation
+    # -----------------------------------
+
+    def method_missing( method, *args )
+      return super unless args.empty?
+      _value_for_key( method )
+    end
+
+  private
+    def _value_for_key( key )
+      return @values_cache[key] if @values_cache.include?( key )
+      value = _evaluate_value_for_key( key )
+      @values_cache[key] = value
+      value
+    end
+
+    def _evaluate_value_for_key( key )
+      value = @definitions[key]
+      case value
+      when Proc
+        instance_eval( &value )
+      else
+        value
+      end
+    end
+
+    def _clear_values_cache
+      @values_cache = {} if !@values_cache.empty?
+    end
+
+  end # class Context
+end # module FolderTemplate

data/lib/folder_template/fs_adapter.rb

@@ -1,8 +1,8 @@
 # =============================================================================
-#  
+#
 # MODULE      : lib/folder_template/fs_adapter.rb
 # PROJECT     : FolderTemplate
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
@@ -25,11 +25,11 @@ module FolderTemplate
       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] )
+
+      if ( File.exist?( target ) && ! opts[:overwrite_files] )
         puts "Skiping file #{filename} ..." if opts[:verbose]
       else
         puts "Generating file #{filename} ..." if opts[:verbose]
@@ -40,25 +40,11 @@ module FolderTemplate
 
     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
-
-
-
-
-
-
-
-
-
-
-
-
-
 
+end

data/lib/folder_template/setup_folder_cmd.rb

@@ -0,0 +1,52 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/setup_folder_cmd.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+module FolderTemplate
+  class SetupFolderCmd
+    attr_reader :target_path
+    attr_reader :template_name
+    attr_reader :variables
+
+    attr_reader :registry
+    attr_reader :template_path
+
+    def initialize( *args )
+      parse_args( args.flatten )
+      @registry = TemplateRegistry.registry_with_default_locations()
+      @template_path = registry.path_for_template( template_name )
+    end
+
+    def self.run( *args, **env )
+      self.new( args ).run( env )
+    end
+
+
+    def run( **env )
+      template = FolderTemplate::TemplateFolder.new( template_path )
+      fs = FolderTemplate::FsAdapter.new( target_path, verbose:true )
+      template.generate( fs, variables.merge( target_path:target_path ).merge( env ) )
+    end
+
+  private
+    def parse_args( args )
+      raise "Missing required target_path and template_name arguments" unless args.count >= 2
+
+      @target_path = File.expand_path( args.shift )
+      @template_name = args.shift
+
+      @variables = {}
+      args.delete_if do |s|
+        m = /(\w+)=(.*)/.match(s)
+        @variables[m[1].to_sym] = m[2] if m
+        m
+      end
+    end
+  end # class SetupFolderCmd
+end # module FolderTemplate

data/lib/folder_template/template_folder.rb

@@ -1,8 +1,8 @@
 # =============================================================================
-#  
+#
 # MODULE      : lib/folder_template/template_folder.rb
 # PROJECT     : FolderTemplate
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
@@ -10,29 +10,42 @@
 module FolderTemplate
 
   class TemplateFolder
-    attr_reader :entries
-    
+    attr_reader :base_path
+    attr_reader :file_templates
+    attr_reader :context
+
     def initialize( path )
-      @entries = _load_template( path )
+      @base_path = path
+
+      file_templates_path = File.join( path, "template" )
+      @file_templates = _load_template( file_templates_path )
+
+      context_filename = File.join( path, "context.rb" )
+      @context = Context.load( context_filename ) if File.readable?( context_filename )
+      @context ||= Context.new
     end
-    
+
     def variables
-      @variables ||= entries.each_with_object( Set.new ) do |e, variables|
+      @variables ||= @file_templates.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 )
+    def generate( fs, env )
+      file_templates.each do |entry|
+        entry.generate( fs, context.merge( env ) )
       end
     end
-    
+
+    def self.validate_template_path( path )
+      File.readable?( File.join( path.to_s, "context.rb" ) ) &&
+          File.directory?( File.join( path.to_s, "template" ) )
+    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 )
@@ -42,17 +55,3 @@ module FolderTemplate
   end # class TemplateFolder
 
 end
-
-
-
-
-
-
-
-
-
-
-
-
-
-

data/lib/folder_template/template_folder_entry.rb

@@ -29,7 +29,7 @@ module FolderTemplate
     end
 
 
-    def generate( fs, **env )
+    def generate( fs, env )
       filename = filename_template.expand( env ).to_s
       basename = File.basename( filename, File.extname( filename ) )
 

data/lib/folder_template/template_registry.rb

@@ -0,0 +1,71 @@
+# =============================================================================
+#
+# MODULE      : lib/folder_template/template_registry.rb
+# PROJECT     : FolderTemplate
+# DESCRIPTION :
+#
+# Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
+# =============================================================================
+
+
+
+module FolderTemplate
+  class TemplateRegistry
+
+    attr_reader :template_locations
+
+    def initialize
+      @template_locations = {}
+    end
+
+    def self.registry_with_default_locations()
+      r = TemplateRegistry.new
+      r.scan_location( File.join( BASE_PATH, "templates" ) )
+      r.scan_location( File.expand_path( "~/.folder_template" ) )
+      r
+    end
+
+    def scan_location( path )
+      _list_template_folders( path ).each do |path|
+        _register_template_path( path )
+      end
+      self
+    end
+
+    def path_for_template( template_name )
+      path_list = @template_locations[template_name]
+      path_list.first if path_list
+    end
+
+    # def upscan_location( base_path )
+    # end
+
+
+  private
+    def _list_template_folders( base_path )
+      Dir[File.join( base_path, "*")].select do |path|
+        File.directory?(path) && TemplateFolder.validate_template_path( path )
+      end
+    end
+
+    def _register_template_path( path )
+      template_name = File.basename( path )
+      @template_locations[template_name] ||= []
+      @template_locations[template_name].unshift( path )
+    end
+
+
+    # def upscan_directories( start_path )
+    #   path = File.expand_path( start_path )
+    #   result = []
+    #   loop do
+    #     result << path
+    #     parent_path = File.dirname( path )
+    #     break if parent_path == path
+    #     path = parent_path
+    #   end
+    #   result
+    # end
+
+  end # class TemplateLocator
+end # module FolderTemplate

data/lib/folder_template/template_string.rb

@@ -17,7 +17,7 @@ module FolderTemplate
         @content = _parse( template )
       when Array
         @content = template.select do |fragment|
-          !fragment.nil? && !fragment.empty?
+          !fragment.nil? && !fragment.to_s.empty?
         end
       when TemplateString
         @content = template.content
@@ -28,7 +28,7 @@ module FolderTemplate
       @variables ||= _extract_variables( @content )
     end
 
-    def expand( **env )
+    def expand( env )
       fragments = content.map do |fragment|
         case fragment
         when Symbol
@@ -36,7 +36,7 @@ module FolderTemplate
         else
           fragment
         end
-      end.select { |fragment| !fragment.nil? && !fragment.empty? }
+      end.select { |fragment| !fragment.nil? && !fragment.to_s.empty? }
       TemplateString.new( fragments )
     end
 
@@ -53,7 +53,7 @@ module FolderTemplate
       result = []
       tail = template
       loop do
-        head, token, tail = tail.partition( VARIABLE_PATTERN )
+        head, _token, tail = tail.partition( VARIABLE_PATTERN )
         result << head if !head.empty?
         break if $1.nil?
         result << $1.to_sym

data/lib/folder_template/version.rb

@@ -8,5 +8,5 @@
 # =============================================================================
 
 module FolderTemplate
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

data/lib/folder_template.rb

@@ -1,13 +1,15 @@
 # =============================================================================
-#  
+#
 # MODULE      : lib/ruby_project_generator.rb
 # PROJECT     : RubyProjectGenerator
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
 
 require 'fileutils'
+require 'facets'
+
 
 module FolderTemplate
   BASE_PATH = File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) )
@@ -18,3 +20,7 @@ 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'
+require_relative 'folder_template/context.rb'
+
+require_relative 'folder_template/template_registry.rb'
+require_relative 'folder_template/setup_folder_cmd.rb'

data/rakefile.rb

@@ -1,42 +1,110 @@
 # =============================================================================
-#  
+#
 # MODULE      : rakefile.rb
 # PROJECT     : FolderTemplate
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) 2016, Marc-Antoine Argenton.  All rights reserved.
 # =============================================================================
 
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
+task default: [:test, :build]
+
 Rake::TestTask.new do |t|
   t.libs << '.' << 'test'
   t.test_files = FileList['test/**/test_*.rb']
   t.verbose = false
 end
 
+
+
+# ----------------------------------------------------------------------------
+# Definitions to help formating 'rake watch' results
+# ----------------------------------------------------------------------------
+
+TERM_WIDTH = `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
+
+def print_separator( success = true )
+  if success
+    puts tty_green( "-" * TERM_WIDTH )
+  else
+    puts tty_reverse_color(tty_red( "-" * TERM_WIDTH ))
+  end
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definition of watch task, that monitors the project folder for any relevant
+# file change and runs the unit test of the project.
+# ----------------------------------------------------------------------------
+
 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
+  task :watch 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
+      print_separator( success )
     end
   end
 
-rescue Exception => e
+rescue LoadError
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :watch do
+    puts
+    puts "'rake watch' requires the watch gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install watch"
+    puts " or "
+    puts "    sudo gem install watch"
+    puts
+    fail
+  end
 end
 
-task :default => [:test, :build]
+
+
+# ----------------------------------------------------------------------------
+# Definition of add_class[class_name] task, that uses folder_template to add
+# a new class to a ruvy project
+# ----------------------------------------------------------------------------
+
+PROJECT_CONTEXT = {
+  project_name:       "folder_template",
+  project_namespace:  "FolderTemplate",
+  copyright_owner:    "Marc-Antoine Argenton",
+  copyright_year:     "2016",
+}
+
+begin
+  require_relative 'lib/folder_template'
+
+  task :add_class, :class_name do |t, args|
+    context = PROJECT_CONTEXT.merge( name:args[:class_name])
+    FolderTemplate::SetupFolderCmd.run( '.', 'rubyclass', context )
+  end
+rescue LoadError
+  task :add_class, :class_name do |t, args|
+    puts
+    puts "'rake add_class[class_name]' task requires the folder_template gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install folder_template"
+    puts " or "
+    puts "    sudo gem install folder_template"
+    puts
+    fail
+  end
+end