templater 0.1.6 → 0.2

data/README

@@ -11,15 +11,9 @@ Hierarchy is pretty simple: manifold has one or many public and private generato
 by end user. Generators have one or more action that specify what they do, where they take files, how they name resulting
 files and so forth.
 
-
 == Idea behind Templater
 
-Templater keeps declarations of generator inside it's body. You vary source and destinations of each action the way you want.
-There's no magical %variables% in filenames sprinkled across your generator, generator rules are simple, readable, concise
-and are in one place making it easy to take existing generator as example.
-
-This is how Templater is different from some other code/components generation frameworks.
-
+Templater is designed to be flexible and designed to be reflective. Generators created with templater are definitions of what goes where, they provide no interface for the user. This allows you to use templater generators inside your own code, or with the bundled CLI interface, or with your own interface.
 
 == Example
 
@@ -150,6 +144,18 @@ will result in
 
     4
     <%= 2 + 2 %>
+    
+== Callbacks
+
+Sometimes it might be desirable to add a callback to your actions, an example might be to chmod a binary file after it is created.
+
+    class MyGenerator < Templater::Generator
+      template :something, 'something.rb', :after => :chmod
+    
+      def chmod(action)
+        File.chmod(action.destination, 0750)
+      end
+    end
 
 == An advanced example
 

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake/gempackagetask'
 require 'rubygems/specification'
 require 'rake/rdoctask'
 require 'date'
+require 'spec/rake/spectask'
 require File.join(File.dirname(__FILE__), 'lib', 'templater')
 
 PLUGIN = "templater"
@@ -34,6 +35,7 @@ spec = Gem::Specification.new do |s|
   
   s.add_dependency "highline", ">= 1.4.0"
   s.add_dependency "diff-lcs", ">= 1.1.2"
+  s.add_dependency "extlib", ">= 0.9.5"
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -99,3 +101,31 @@ task :rcov do
     `#{command} 2>&1`
   end
 end
+
+file_list = FileList['spec/**/*_spec.rb']
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = file_list
+end
+
+namespace :spec do
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = file_list
+    t.rcov = true
+    t.rcov_dir = "doc/coverage"
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+  
+  desc "Generate an html report"
+  Spec::Rake::SpecTask.new('report') do |t|
+    t.spec_files = file_list
+    t.spec_opts = ["--format", "html:doc/reports/specs.html"]
+    t.fail_on_error = false
+  end
+
+end
+
+desc 'Default: run unit tests.'
+task :default => 'spec'

data/lib/templater.rb

@@ -1,17 +1,19 @@
 path = File.dirname(__FILE__) + '/templater/'
 
 require 'rubygems'
+require 'extlib'
 require 'highline'
 require "highline/import"
 require 'diff/lcs'
 
 require path + 'discovery'
 require path + 'capture_helpers'
+require path + 'actions/action'
 require path + 'actions/template'
 require path + 'actions/file'
 require path + 'actions/empty_directory'
+require path + 'description'
 require path + 'generator'
-require path + 'proxy'
 require path + 'manifold'
 require path + 'cli/parser'
 require path + 'cli/manifold'
@@ -40,6 +42,6 @@ module Templater
   class MalformattedArgumentError < ArgumentError #:nodoc:
   end
   
-  VERSION = '0.1.6'
+  VERSION = '0.2'
   
 end

data/lib/templater/actions/action.rb

@@ -0,0 +1,43 @@
+module Templater
+  module Actions
+    class Action
+  
+      attr_accessor :generator, :name, :source, :destination, :options
+  
+      def source=(source)
+        unless source.blank?
+          @source = ::File.expand_path(source, generator.source_root)
+        end
+      end
+      
+      def destination=(destination)
+        unless destination.blank?
+          @destination = ::File.expand_path(convert_encoded_instructions(destination), generator.destination_root)
+        end
+      end
+    
+      # Returns the destination path relative to Dir.pwd. This is useful for prettier output in interfaces
+      # where the destination root is Dir.pwd.
+      #
+      # === Returns
+      # String:: The destination relative to Dir.pwd
+      def relative_destination
+        @destination.relative_path_from(@generator.destination_root)
+      end
+      
+      protected
+      
+      def callback(name)
+        @generator.send(@options[name], self) if @options[name]
+      end
+      
+      def convert_encoded_instructions(filename)
+        filename.gsub(/%.*?%/) do |string|
+          instruction = string.match(/%(.*?)%/)[1]
+          @generator.respond_to?(instruction) ? @generator.send(instruction) : string
+        end
+      end
+      
+    end
+  end
+end

data/lib/templater/actions/empty_directory.rb

@@ -1,20 +1,19 @@
 module Templater
   module Actions
-    class EmptyDirectory
+    class EmptyDirectory < Action
 
-      attr_reader :name, :destination
-    
-      def initialize(name, destination)
-        @name, @destination = name, destination
-      end
-
-      # Returns the destination path relative to Dir.pwd. This is useful for prettier output in interfaces
-      # where the destination root is Dir.pwd.
-      #
-      # === Returns
-      # String:: The destination relative to Dir.pwd
-      def relative_destination
-        @destination.sub(::Dir.pwd + ::File::SEPARATOR, '')
+      # Builds a new Directory
+      # 
+      # === Parameters
+      # generator<Object>:: The generator
+      # name<Symbol>:: The name of this directory
+      # destination<String>:: Full path to the destination of this directory
+      # options<Hash{Symbol=>Symbol}:: Options, including callbacks.
+      def initialize(generator, name, destination, options={})
+        self.generator = generator
+        self.name = name
+        self.destination = destination
+        self.options = options
       end
 
       # Returns the contents of the source file as a String
@@ -43,13 +42,16 @@ module Templater
   
       # Renders the template and copies it to the destination.
       def invoke!
+        @generator.send(@options[:before], self) if @options[:before]
         ::FileUtils.mkdir_p(destination)
+        @generator.send(@options[:after], self) if @options[:after]
       end
     
       # removes the destination file
       def revoke!
         ::FileUtils.rm_rf(::File.expand_path(destination))
       end
+
     end # EmptyDirectory
   end # Actions
 end # Templater

data/lib/templater/actions/file.rb

@@ -1,28 +1,21 @@
 module Templater
   module Actions
-    class File
+    class File < Action
   
-      attr_accessor :name, :source, :destination
-  
-      # Builds a new file, given the name of the file and its source and destination.
+      # Builds a new file.
       #
       # === Parameters
-      # name<Symbol>:: The name of this template
-      # source<String>:: Full path to the source of this template
-      # destination<String>:: Full path to the destination of this template
-      def initialize(name, source, destination)
-        @name = name
-        @source = source
-        @destination = destination
-      end
-    
-      # Returns the destination path relative to Dir.pwd. This is useful for prettier output in interfaces
-      # where the destination root is Dir.pwd.
-      #
-      # === Returns
-      # String:: The destination relative to Dir.pwd
-      def relative_destination
-        @destination.sub(::Dir.pwd + ::File::SEPARATOR, '')
+      # generator<Object>:: The generator
+      # name<Symbol>:: The name of this file
+      # source<String>:: Full path to the source of this file
+      # destination<String>:: Full path to the destination of this file
+      # options<Hash{Symbol=>Symbol}:: Options, including callbacks.
+      def initialize(generator, name, source, destination, options={})
+        self.generator = generator
+        self.name = name
+        self.source = source
+        self.destination = destination
+        self.options = options
       end
 
       # Returns the contents of the source file as a String
@@ -51,15 +44,17 @@ module Templater
   
       # Renders the template and copies it to the destination.
       def invoke!
+        callback(:before)
         ::FileUtils.mkdir_p(::File.dirname(destination))
         ::FileUtils.copy_file(source, destination)
+        callback(:after)
       end
     
       # removes the destination file
       def revoke!
         ::FileUtils.rm(destination, :force => true)
       end
-  
+
     end
   end
 end

data/lib/templater/actions/template.rb

@@ -1,32 +1,21 @@
 module Templater
   module Actions
-    class Template
+    class Template < Action
   
-      attr_accessor :context, :name, :source, :destination, :options
-  
-      # Builds a new template, given the context (e.g. binding) in which the template will be rendered
-      # (usually a generator), the name of the template and its source and destination.
+      # Builds a new template.
       #
       # === Parameters
-      # context<Object>:: Context for rendering
+      # generator<Object>:: Context for rendering
       # name<Symbol>:: The name of this template
       # source<String>:: Full path to the source of this template
       # destination<String>:: Full path to the destination of this template
-      # render<Boolean>:: If set to false, will do a copy instead of rendering.
-      def initialize(context, name, source, destination)
-        @context = context
-        @name = name
-        @source = source
-        @destination = destination
-      end
-    
-      # Returns the destination path relative to Dir.pwd. This is useful for prettier output in interfaces
-      # where the destination root is Dir.pwd.
-      #
-      # === Returns
-      # String:: The destination relative to Dir.pwd
-      def relative_destination
-        @destination.sub(::Dir.pwd + ::File::SEPARATOR, '')
+      # options<Hash{Symbol=>Symbol}:: Options, including callbacks.
+      def initialize(generator, name, source, destination, options={})
+        self.generator = generator
+        self.name = name
+        self.source = source
+        self.destination = destination
+        self.options = options
       end
   
       # Renders the template using ERB and returns the result as a String.
@@ -34,7 +23,7 @@ module Templater
       # === Returns
       # String:: The rendered template.
       def render
-        ERB.new(::File.read(source), nil, '-').result(context.send(:binding))
+        ERB.new(::File.read(source), nil, '-').result(generator.send(:binding))
       end
 
       # Checks if the destination file already exists.
@@ -55,8 +44,10 @@ module Templater
   
       # Renders the template and copies it to the destination.
       def invoke!
+        @generator.send(@options[:before], self) if @options[:before]
         ::FileUtils.mkdir_p(::File.dirname(destination))
         ::File.open(destination, 'w') {|f| f.write render }
+        @generator.send(@options[:after], self) if @options[:after]
       end
     
       # removes the destination file

data/lib/templater/cli/generator.rb

@@ -5,8 +5,11 @@ module Templater
     class Generator
 
       def initialize(generator_name, generator_class, destination_root, name, version)
-        @destination_root, @generator_name, @generator_class = destination_root, generator_name, generator_class
-        @name, @version = name, version
+        @generator_name = generator_name
+        @destination_root = destination_root
+        @generator_class = generator_class
+        @name = name
+        @version = version
       end
 
       def version
@@ -27,6 +30,7 @@ module Templater
 
       def run(arguments)
         generator_class = @generator_class # FIXME: closure wizardry, there has got to be a better way than this?
+        
         @options = Templater::CLI::Parser.parse(arguments) do |opts, options|
           opts.separator "Options specific for this generator:"
           # the reason this is reversed is so that the 'main' generator will always have the last word
@@ -35,14 +39,14 @@ module Templater
             # Loop through this generator's options and add them as valid command line options
             # so that they show up in help messages and such
             generator.options.each do |option|
-              name = option[:name].to_s.gsub('_', '-')
-              if option[:options][:as] == :boolean
-                opts.on("--#{name}", option[:options][:desc]) do |s|
-                  options[option[:name]] = s
+              name = option.name.to_s.gsub('_', '-')
+              if option.options[:as] == :boolean
+                opts.on("--#{name}", option.options[:desc]) do |s|
+                  options[option.name] = s
                 end
               else
-                opts.on("--#{name} OPTION", option[:options][:desc]) do |s|
-                  options[option[:name]] = s.gsub('-', '_').to_sym
+                opts.on("--#{name} OPTION", option.options[:desc]) do |s|
+                  options[option.name] = s.gsub('-', '_').to_sym
                 end
               end
             end
@@ -72,7 +76,7 @@ module Templater
       end
 
       def step_through_templates
-        @generator.actions.each do |action|
+        @generator.all_actions.each do |action|
           if @options[:delete]
             action.revoke! unless @options[:pretend]
             say_status('deleted', action, :red)

data/lib/templater/core_ext/string.rb

@@ -1,4 +1,4 @@
-class String #:nodoc:
+class String
   
   def realign_indentation
     basis = self.index(/\S/) # find the first non-whitespace character

data/lib/templater/description.rb

@@ -0,0 +1,61 @@
+module Templater
+  
+  class Description
+    attr_accessor :name, :options, :block
+    
+    def initialize(name, options={}, &block)
+      @name = name
+      @options = options
+      @block = block
+    end    
+  end
+  
+  class ActionDescription < Description
+    
+    def compile(generator)
+      @block.call(generator)
+    end
+    
+  end
+  
+  class ArgumentDescription < Description
+    
+    # Checks if the given argument is valid according to this description
+    #
+    # === Parameters
+    # argument<Object>:: Checks if the given argument is valid.
+    # === Returns
+    # Boolean:: Validity of the argument
+    def valid?(argument)
+      if argument.nil? and options[:required]
+        raise Templater::TooFewArgumentsError
+      elsif not argument.nil?
+        if options[:as] == :hash and not argument.is_a?(Hash)
+          raise Templater::MalformattedArgumentError, "Expected the argument to be a Hash, but was '#{argument.inspect}'"
+        elsif options[:as] == :array and not argument.is_a?(Array)
+          raise Templater::MalformattedArgumentError, "Expected the argument to be an Array, but was '#{argument.inspect}'"
+        end
+           
+        invalid = catch :invalid do
+          block.call(argument) if block
+          throw :invalid, :not_invalid
+        end
+        raise Templater::ArgumentError, invalid unless invalid == :not_invalid
+      end
+    end
+    
+  end
+  
+  class InvocationDescription < Description
+    
+    def get(generator)
+      klass = generator.class.manifold.generator(name)
+      if klass and block
+        generator.instance_exec(klass, &block)
+      elsif klass
+        klass.new(generator.destination_root, generator.options, *generator.arguments)
+      end
+    end
+    
+  end
+end