templater 0.4.5 → 0.5.0

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2008 Jonas Nicklas
+Copyright (c) 2008 Michael S. Klishin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -68,7 +68,7 @@ This is how to create a very simple system for generating things:
   
 The generator classes override the source_root method to specify where templates will be located. All subclasses of Templater::Generator that have any actions must do this. The +template+ and +file+ methods add actions to the generator. In the first case, a template that is rendered with ERB and then put in its destination location, in the other case a file that is copied. +empty_directory+ action creates empty directory under destination root.
 
-Neither manifolds or generators actually do anything by themselves, they are just abstract represenations. The last line invokes the command-line-interface, which fetches the desired generator, tells it to render its templates and checks with the user if there are any problems. The generators can easily be used without the command-line-interface, so it is easy to construct an alternative interface.
+Neither manifolds or generators actually do anything by themselves, they are just abstract representations. The last line invokes the command-line-interface, which fetches the desired generator, tells it to render its templates and checks with the user if there are any problems. The generators can easily be used without the command-line-interface, so it is easy to construct an alternative interface.
 
 == Invoking other generators
 

data/ROADMAP

@@ -0,0 +1,35 @@
+Roadmap:
+
+0.5:
+
+* Custom actions (ex.: append/prepend to existing files).
+
+0.6:
+
+* Internals overview.
+* Plugins development guide.
+* Overall improvements in documentation.
+
+0.7:
+
+* Haml support.
+
+0.8:
+
+* Interactive UI.
+
+0.9:
+
+* Built-in generators generator.
+* Executable to run the generator above.
+* Clean up as much as possible before stabilization period.
+
+1.0:
+
+* Redundant spec coverage.
+* Generators in natural languages with Treetop. We can write generators using
+  plain text and use Cucumber-like steps to process actions.
+
+1.x:
+
+* Add magic template names for files.

data/Rakefile

@@ -8,8 +8,8 @@ require File.join(File.dirname(__FILE__), 'lib', 'templater')
 
 PLUGIN = "templater"
 NAME = "templater"
-AUTHOR = "Jonas Nicklas"
-EMAIL = "jonas.nicklas@gmail.com"
+AUTHOR = "Jonas Nicklas, Michael Klishin"
+EMAIL = "jonas.nicklas@gmail.com, michael.s.klishin@gmail.com"
 HOMEPAGE = "http://templater.rubyforge.org/"
 SUMMARY = "File generation system"
 
@@ -36,7 +36,7 @@ spec = Gem::Specification.new do |s|
   s.version = Templater::VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.extra_rdoc_files = ["README", "LICENSE", 'ROADMAP']
   s.summary = SUMMARY
   s.description = s.summary
   s.author = AUTHOR
@@ -44,7 +44,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = HOMEPAGE
   s.require_path = 'lib'
   s.autorequire = PLUGIN
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(LICENSE README Rakefile ROADMAP) + Dir.glob("{lib,spec}/**/*")
   
   s.add_dependency "highline", ">= 1.4.0"
   s.add_dependency "diff-lcs", ">= 1.1.2"
@@ -140,4 +140,4 @@ namespace :spec do
 end
 
 desc 'Default: run unit tests.'
-task :default => 'spec'
+task :default => 'spec'

data/lib/templater.rb

@@ -14,6 +14,7 @@ require path + 'actions/template'
 require path + 'actions/file'
 require path + 'actions/directory'
 require path + 'actions/empty_directory'
+require path + 'actions/evaluation'
 require path + 'description'
 require path + 'generator'
 require path + 'manifold'
@@ -44,6 +45,6 @@ module Templater
   class MalformattedArgumentError < ArgumentError #:nodoc:
   end
   
-  VERSION = '0.4.5'
+  VERSION = '0.5.0'
   
 end

data/lib/templater/actions/evaluation.rb

@@ -0,0 +1,21 @@
+module Templater
+  module Actions
+    class Evaluation < Action
+      attr_reader :generaor, :name, :options, :operation
+      
+      def initialize(generator, name, options = {}, &operation)
+        @generator, @name     = generator, name
+        @options              = options
+        @operation            = operation
+      end
+      
+      def render
+        self.generator.instance_eval(&operation) || ''
+      end
+
+      def identical?
+        false
+      end
+    end
+  end
+end

data/lib/templater/cli/generator.rb

@@ -5,11 +5,11 @@ module Templater
     class Generator
 
       def initialize(generator_name, generator_class, destination_root, name, version)
-        @generator_name = generator_name
+        @generator_name   = generator_name
         @destination_root = destination_root
-        @generator_class = generator_class
-        @name = name
-        @version = version
+        @generator_class  = generator_class
+        @name             = name
+        @version          = version
       end
 
       def version
@@ -20,11 +20,11 @@ module Templater
       # outputs a helpful message and quits
       def help
         puts "Usage: #{@name} #{@generator_name} [options] [args]"
-        puts ''
+        puts
         puts @generator_class.desc
-        puts ''
+        puts
         puts @options[:opts]
-        puts ''
+        puts
         exit
       end
 

data/lib/templater/description.rb

@@ -1,25 +1,23 @@
 module Templater
-  
+
   class Description
     attr_accessor :name, :options, :block
-    
+
     def initialize(name, options={}, &block)
       @name = name
       @options = options
       @block = block
-    end    
+    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
@@ -35,7 +33,7 @@ module Templater
         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
@@ -43,7 +41,7 @@ module Templater
         raise Templater::ArgumentError, invalid unless invalid == :not_invalid
       end
     end
-    
+
     def extract(argument)
       case options[:as]
       when :hash
@@ -60,11 +58,11 @@ module Templater
       end
       return argument
     end
-    
+
   end
-  
+
   class InvocationDescription < Description
-    
+
     def get(generator)
       klass = generator.class.manifold.generator(name)
       if klass and block
@@ -73,6 +71,6 @@ module Templater
         klass.new(generator.destination_root, generator.options, *generator.arguments)
       end
     end
-    
+
   end
-end
+end

data/lib/templater/generator.rb

@@ -308,6 +308,25 @@ module Templater
         end
       end
 
+      # Evaluates given block in the scope of generator. Useful for modification
+      # of existing files, for instance, Merb generators may update routing
+      # file or something.
+      #
+      # === Parameters
+      # name<Symbol>:: The name of this custom action
+      # options<Hash>:: Options for this custom action
+      # &block<Proc>:: A block to execute when the generator is instantiated
+      #
+      # === Options
+      # :before<Symbol>:: Name of a method to execute before this template is invoked
+      # :after<Symbol>:: Name of a method to execute after this template is invoked
+      def custom_action(name, *args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        actions[name] = ActionDescription.new(name, options) do |generator|
+          Actions::Evaluation.new(generator, name, options, &block)
+        end
+      end
+
       # An easy way to add many templates to a generator, each item in the list is added as a
       # template. The provided list can be either an array of Strings or a Here-Doc with templates
       # on individual lines.

data/spec/actions/custom_action_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, ".custom_action" do
+  before do
+    @generator_class = Templater::Generator
+    @generator_class.stub!(:source_root).and_return('/tmp/source')
+  end
+
+  it 'evaluates given block in context of generator' do
+    $custom_action_evaluation_result = "not called yet"
+    @generator_class.custom_action :update_routes_rb do
+      $custom_action_evaluation_result = source_root
+    end
+
+    @generator_class.new("/tmp/destination").render!
+    $custom_action_evaluation_result.should == "/tmp/source"
+  end
+end

data/spec/actions/evaluation_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Actions::Evaluation do
+  before do
+    @generator = mock('a generator')
+    @generator.stub!(:source_root).and_return('/tmp/source')
+    @generator.stub!(:destination_root).and_return('/tmp/destination')
+  end
+
+  describe '#render' do
+    it "returns result of block evaluation" do
+      evaluation = Templater::Actions::Evaluation.new(@generator, :monkey) do
+        "noop"
+      end
+      evaluation.render.should == "noop"
+    end
+
+    it "returns empty string when block returned nil" do
+      evaluation = Templater::Actions::Evaluation.new(@generator, :monkey) do
+        nil
+      end
+      evaluation.render.should == ""
+    end
+  end
+
+  describe "#identical?" do
+    it "always returns false" do
+      noop_evaluation = Templater::Actions::Evaluation.new(@generator, :monkey) do
+        "noop"
+      end
+
+      another_evaluation = Templater::Actions::Evaluation.new(@generator, :monkey) do
+        "noop"
+      end      
+
+      noop_evaluation.should_not be_identical
+      another_evaluation.should_not be_identical
+    end
+  end
+end

data/spec/options_parser_spec.rb

@@ -2,17 +2,17 @@ require File.dirname(__FILE__) + '/spec_helper'
 require "tempfile"
 
 describe Templater::CLI::Parser do
-  describe "given unknown option" do    
+  describe "given unknown option" do
     it "outputs a meaninful error message instead of just blowing up" do
       lambda do
         Templater::CLI::Parser.parse(["--this-option-is-unknown", "--second-unknown-option"])
       end.should_not raise_error
     end
-    
+
     it "lists unknown options" do
-      e = OptionParser::InvalidOption.new("--this-option-is-unknown", "--second-unknown-option")      
+      e = OptionParser::InvalidOption.new("--this-option-is-unknown", "--second-unknown-option")
       output = Templater::CLI::Parser.error_message(e)
-      
+
       output.should =~ /--this-option-is-unknown/
       output.should =~ /--second-unknown-option/
     end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: templater
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors: 
-- Jonas Nicklas
+- Jonas Nicklas, Michael Klishin
 autorequire: templater
 bindir: bin
 cert_chain: []
@@ -43,7 +43,7 @@ dependencies:
         version: 0.9.5
     version: 
 description: File generation system
-email: jonas.nicklas@gmail.com
+email: jonas.nicklas@gmail.com, michael.s.klishin@gmail.com
 executables: []
 
 extensions: []
@@ -51,17 +51,18 @@ extensions: []
 extra_rdoc_files: 
 - README
 - LICENSE
-- TODO
+- ROADMAP
 files: 
 - LICENSE
 - README
 - Rakefile
-- TODO
+- ROADMAP
 - lib/templater
 - lib/templater/actions
 - lib/templater/actions/action.rb
 - lib/templater/actions/directory.rb
 - lib/templater/actions/empty_directory.rb
+- lib/templater/actions/evaluation.rb
 - lib/templater/actions/file.rb
 - lib/templater/actions/template.rb
 - lib/templater/capture_helpers.rb
@@ -80,8 +81,10 @@ files:
 - lib/templater/spec/helpers.rb
 - lib/templater.rb
 - spec/actions
+- spec/actions/custom_action_spec.rb
 - spec/actions/directory_spec.rb
 - spec/actions/empty_directory_spec.rb
+- spec/actions/evaluation_spec.rb
 - spec/actions/file_spec.rb
 - spec/actions/template_spec.rb
 - spec/core_ext

data/TODO

@@ -1,3 +0,0 @@
-TODO:
-
-* Add magic template names for files as well