templater 0.1.5 → 0.1.6

data/lib/templater/actions/file.rb

@@ -57,7 +57,7 @@ module Templater
     
       # removes the destination file
       def revoke!
-        ::FileUtils.rm(destination)
+        ::FileUtils.rm(destination, :force => true)
       end
   
     end

data/lib/templater/actions/template.rb

@@ -61,7 +61,7 @@ module Templater
     
       # removes the destination file
       def revoke!
-        ::FileUtils.rm(destination)
+        ::FileUtils.rm(destination, :force => true)
       end
       
     end

data/lib/templater/cli/generator.rb

@@ -39,7 +39,7 @@ module Templater
               if option[:options][:as] == :boolean
                 opts.on("--#{name}", option[:options][:desc]) do |s|
                   options[option[:name]] = s
-                end                
+                end
               else
                 opts.on("--#{name} OPTION", option[:options][:desc]) do |s|
                   options[option[:name]] = s.gsub('-', '_').to_sym
@@ -50,7 +50,6 @@ module Templater
         end
 
         self.help if @options[:help]
-        self.help if arguments.first == 'help'
         self.version if @options[:version]
 
         # Try to instantiate a generator, if the arguments to it were incorrect: show a help message

data/lib/templater/generator.rb

@@ -97,7 +97,7 @@ module Templater
       # :desc<Symbol>:: Provide a description for this argument
       def argument(n, name, options={}, &block)
         self.arguments[n] = {
-          :name => name,
+          :name => name.to_sym,
           :options => options,
           :block => block
         }
@@ -179,7 +179,7 @@ module Templater
       #   end
       def invoke(name, options={}, &block)
         self.invocations << {
-          :name => name,
+          :name => name.to_sym,
           :options => options,
           :block => block
         }
@@ -226,7 +226,7 @@ module Templater
         source, destination = source + 't', source if args.size == 1
         
         self.templates << {
-          :name => name,
+          :name => name.to_sym,
           :options => options,
           :source => source,
           :destination => destination,
@@ -250,7 +250,7 @@ module Templater
         source, destination = source, source if args.size == 1
         
         self.files << {
-          :name => name,
+          :name => name.to_sym,
           :options => options,
           :source => source,
           :destination => destination,
@@ -259,12 +259,22 @@ module Templater
         }
       end
       
-      def empty_directory(name, path = nil)
-        path = name.to_s unless path
+      # Adds an empty directory that will be created when the generator is run.
+      #
+      # === Parameters
+      # name<Symbol>:: The name of this empty directory
+      # destination<String>:: The destination where the empty directory will be created
+      # options<Hash>:: Options for this empty directory
+      # &block<Proc>:: A block to execute when the generator is instantiated
+      def empty_directory(name, *args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        destination = args.first
         
         self.empty_directories << {
-          :name        => name,
-          :destination => path
+          :name => name.to_sym,
+          :destination => destination,
+          :options => options,
+          :block => block
         }
       end
                        
@@ -385,12 +395,11 @@ module Templater
     # === Raises
     # Templater::ArgumentError:: If the arguments are invalid
     def initialize(destination_root, options = {}, *args)
-      # FIXME: options as a second argument is kinda stupid, since it forces silly syntax, but since *args
-      # might contain hashes, I can't come up with another way of making this unambiguous. 
       @destination_root = destination_root
       @arguments = []
       @options = options
       
+      # Initialize options to their default values.
       self.class.options.each do |option|
         @options[option[:name]] ||= option[:options][:default]
       end
@@ -437,11 +446,10 @@ module Templater
     # === Returns
     # [Templater::Actions::Template]:: The found templates.
     def templates
-      templates = self.class.templates.map do |t|
-        template = Templater::Proxy.new(self, t[:name], t[:source], t[:destination], &t[:block]).to_template
-        match_options?(t[:options]) ? template : nil
+      self.class.templates.inject([]) do |templates, template|
+        templates << Templater::Proxy.new(self, template).to_template if match_options?(template[:options])
+        templates
       end
-      templates.compact
     end
     
     # Finds and returns all files whose options match the generator options.
@@ -449,11 +457,10 @@ module Templater
     # === Returns
     # [Templater::Actions::File]:: The found files.
     def files
-      files = self.class.files.map do |t|
-        file = Templater::Proxy.new(self, t[:name], t[:source], t[:destination], &t[:block]).to_file
-        match_options?(t[:options]) ? file : nil
+      self.class.files.inject([]) do |files, file|
+        files << Templater::Proxy.new(self, file).to_file if match_options?(file[:options])
+        files
       end
-      files.compact
     end
 
     # Finds and returns all empty directories generator creates.
@@ -461,9 +468,10 @@ module Templater
     # === Returns
     # [Templater::Actions::File]:: The found files.
     def empty_directories
-      self.class.empty_directories.map do |t|
-        Templater::Proxy.new(self, t[:name], nil, t[:destination], &t[:block]).to_empty_directory
-      end.compact
+      self.class.empty_directories.inject([]) do |empty_directories, action|
+        empty_directories << Templater::Proxy.new(self, action).to_empty_directory if match_options?(action[:options])
+        empty_directories
+      end
     end    
     
     # Finds and returns all templates whose options match the generator options.
@@ -471,18 +479,20 @@ module Templater
     # === Returns
     # [Templater::Generator]:: The found templates.
     def invocations
-      if self.class.manifold
-        invocations = self.class.invocations.map do |invocation|
-          generator = self.class.manifold.generator(invocation[:name])
-          if generator and invocation[:block]
-            instance_exec(generator, &invocation[:block])
-          elsif generator and match_options?(invocation[:options])
-            generator.new(destination_root, options, *@arguments)
+      return [] unless self.class.manifold
+      
+      self.class.invocations.inject([]) do |invocations, invocation|
+        generator = self.class.manifold.generator(invocation[:name])
+        
+        if generator and match_options?(invocation[:options])
+          
+          if invocation[:block]
+            invocations << instance_exec(generator, &invocation[:block])
+          else 
+            invocations << generator.new(destination_root, options, *@arguments)
           end
         end
-        invocations.compact
-      else
-        []
+        invocations
       end
     end
     
@@ -551,7 +561,7 @@ module Templater
     end
     
     def match_options?(options)
-      options.all? { |key, value| get_option(key) == value }
+      options.all? { |key, value| self.send(key) == value }
     end
         
     def valid_argument?(arg, options, &block)

data/lib/templater/proxy.rb

@@ -2,9 +2,11 @@ module Templater
   
   class Proxy #:nodoc:
     
-    def initialize(generator, name, source, destination, &block)
-      @generator, @block, @source, @destination = generator, block, source, destination
-      @name = name.to_sym
+    def initialize(generator, action={})
+      @generator = generator
+      @block = action[:block]
+      @source, @destination = action[:source], action[:destination]
+      @name = action[:name]
     end
     
     def source(*source)

data/lib/templater/spec/helpers.rb

@@ -0,0 +1,67 @@
+module Templater
+  module Spec
+    module Helpers
+
+      class InvokeMatcher
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          found = nil
+          @actual.invocations.each { |i| found = i if i.class == @expected }
+
+          if @with
+            return found && (@with == found.arguments)
+          else
+            return found
+          end
+        end
+
+        def with(*arguments)
+          @with = arguments
+          return self
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to invoke #{@expected.inspect} with #{@with}, but it didn't"
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} not to invoke #{@expected.inspect} with #{@with}, but it did"
+        end
+      end
+
+      def invoke(expected)
+        InvokeMatcher.new(expected)
+      end
+
+      class CreateMatcher
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          @actual.actions.map{|t| t.destination }.include?(@expected)
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to create #{@expected.inspect}, but it didn't"
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} not to create #{@expected.inspect}, but it did"
+        end
+      end
+
+      def create(expected)
+        CreateMatcher.new(expected)
+      end
+
+    end # Helpers
+  end # Spec
+end # Templater

data/lib/templater.rb

@@ -40,6 +40,6 @@ module Templater
   class MalformattedArgumentError < ArgumentError #:nodoc:
   end
   
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
   
 end

data/spec/file_spec.rb

@@ -88,4 +88,10 @@ describe Templater::Actions::File, '#revoke!' do
     File.exists?(result_path('path/to/subdir/test2.rbs')).should be_false
   end
   
+  it "should do nothing when the destination file doesn't exist" do
+    file = Templater::Actions::File.new(:monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs'))
+    
+    lambda { file.revoke! }.should_not raise_error
+  end
+  
 end

data/spec/generator/{argument_spec.rb → arguments_spec.rb}

@@ -130,3 +130,84 @@ describe Templater::Generator, '.argument' do
   end
 
 end
+
+describe Templater::Generator, '.argument as array' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.argument(0, :monkey)
+    @generator_class.argument(1, :llama, :as => :array)
+  end
+  
+  it "should allow assignment of arrays" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', %w(an array))
+    
+    instance.monkey.should == 'a monkey'
+    instance.llama[0].should == 'an'
+    instance.llama[1].should == 'array'
+    
+    instance.llama = %w(another donkey)
+    instance.llama[0].should == 'another'
+    instance.llama[1].should == 'donkey'
+  end
+  
+  it "should convert a single argument to an array" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'test')
+    instance.llama[0].should == 'test'
+  end
+  
+  it "should consume the remaining arguments and convert them to an array" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'test', 'silver', 'river')
+    instance.llama[0].should == 'test'
+    instance.llama[1].should == 'silver'
+    instance.llama[2].should == 'river'
+  end
+  
+  it "should raise error if the argument is not an array" do
+    instance = @generator_class.new('/tmp')
+    lambda { instance.llama = :not_an_array }.should raise_error(Templater::MalformattedArgumentError)
+  end
+
+end
+
+describe Templater::Generator, '.argument as hash' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.argument(0, :monkey)
+    @generator_class.argument(1, :llama, :as => :hash)
+  end
+  
+  it "should allow assignment of hashes" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', { :hash => 'blah' })
+    
+    instance.monkey.should == 'a monkey'
+    instance.llama[:hash].should == 'blah'
+    
+    instance.llama = { :me_s_a => :hash }
+    instance.llama[:me_s_a].should == :hash
+  end
+  
+  it "should convert a key/value pair to a hash" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'test:unit')
+    instance.llama['test'].should == 'unit'
+  end
+  
+  it "should consume the remaining arguments and convert them to a hash if they are key/value pairs" do
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'test:unit', 'john:silver', 'river:road')
+    instance.llama['test'].should == 'unit'
+    instance.llama['john'].should == 'silver'
+    instance.llama['river'].should == 'road'
+  end
+  
+  it "should raise an error if one of the remaining arguments is not a key/value pair" do
+    lambda { @generator_class.new('/tmp', {}, 'a monkey', 'a:llama', 'duck:llama', 'not_a_pair', 'pair:blah') }.should raise_error(Templater::MalformattedArgumentError)
+  end
+  
+  it "should raise error if the argument is neither a hash nor a key/value pair" do
+    lambda { @generator_class.new('/tmp', {}, 'a monkey', 23) }.should raise_error(Templater::MalformattedArgumentError)
+    instance = @generator_class.new('/tmp')
+    lambda { instance.llama = :not_a_hash }.should raise_error(Templater::MalformattedArgumentError)
+  end
+
+end

data/spec/generator/empty_directories_spec.rb

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, ".empty_directory" do
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+  
+  it "should add an empty_directory" do
+    @generator_class.empty_directory(:my_empty_directory, 'path/to/destination.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:source_root).and_return('/tmp/source')
+    
+    @instance.empty_directory(:my_empty_directory).destination.should == '/tmp/destination/path/to/destination.rb'
+    @instance.empty_directory(:my_empty_directory).should be_an_instance_of(Templater::Actions::EmptyDirectory)
+  end
+  
+  it "should add a empty_directory and convert an instruction encoded in the destination" do
+    @generator_class.empty_directory(:my_empty_directory, 'template/%another_method%.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.should_receive(:another_method).at_least(:once).and_return('beast')
+    
+    @instance.empty_directory(:my_empty_directory).destination.should == "/tmp/destination/template/beast.rb"
+    @instance.empty_directory(:my_empty_directory).should be_an_instance_of(Templater::Actions::EmptyDirectory)
+  end
+  
+  it "should add an empty directory with a block" do
+    @generator_class.empty_directory(:my_empty_directory) do
+      destination "gurr#{Process.pid.to_s}.rb"
+    end
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.empty_directory(:my_empty_directory).destination.should == "/tmp/destination/gurr#{Process.pid.to_s}.rb"
+    @instance.empty_directory(:my_empty_directory).should be_an_instance_of(Templater::Actions::EmptyDirectory)
+  end
+  
+  it "should add an empty directory with a complex block" do
+    @generator_class.empty_directory(:my_empty_directory) do
+      destination 'gurr', "gurr#{something}.rb"
+    end
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:something).and_return('anotherthing')
+    
+    @instance.empty_directory(:my_empty_directory).destination.should == "/tmp/destination/gurr/gurranotherthing.rb"
+    @instance.empty_directory(:my_empty_directory).should be_an_instance_of(Templater::Actions::EmptyDirectory)
+  end
+  
+  it "should add a empty_directory and leave an encoded instruction be if it doesn't exist as a method" do
+    @generator_class.empty_directory(:my_empty_directory, 'template/%some_method%.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.empty_directory(:my_empty_directory).destination.should == "/tmp/destination/template/%some_method%.rb"
+    @instance.empty_directory(:my_empty_directory).should be_an_instance_of(Templater::Actions::EmptyDirectory)
+  end
+end
+
+describe Templater::Generator, '#empty_directories' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "should return all empty directories" do
+    @generator_class.empty_directory(:blah1, 'blah.rb')
+    @generator_class.empty_directory(:blah2, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.empty_directories[0].name.should == :blah1
+    instance.empty_directories[1].name.should == :blah2
+  end
+  
+  it "should not return empty directories with an option that does not match." do
+    @generator_class.option :framework, :default => :rails
+    
+    @generator_class.empty_directory(:merb, 'blah.rb', :framework => :merb)
+    @generator_class.empty_directory(:rails, 'blah2.rb', :framework => :rails)
+    @generator_class.empty_directory(:none, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+
+    instance.empty_directories[0].name.should == :rails
+    instance.empty_directories[1].name.should == :none
+
+    instance.framework = :merb
+    instance.empty_directories[0].name.should == :merb
+    instance.empty_directories[1].name.should == :none
+
+    instance.framework = :rails
+    instance.empty_directories[0].name.should == :rails
+    instance.empty_directories[1].name.should == :none
+    
+    instance.framework = nil
+    instance.empty_directories[0].name.should == :none
+  end
+end
+
+describe Templater::Generator, '#empty_directory' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "should find a empty_directory by name" do
+    @generator_class.empty_directory(:blah1, 'blah.rb')
+    @generator_class.empty_directory(:blah2, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.empty_directory(:blah1).name.should == :blah1
+    instance.empty_directory(:blah1).destination.should == '/tmp/blah.rb'
+  end
+  
+  it "should not return a empty_directory with an option that does not match." do
+    @generator_class.send(:attr_accessor, :framework)
+    
+    @generator_class.empty_directory(:merb, 'blah.rb', :framework => :merb)
+    @generator_class.empty_directory(:rails, 'blah2.rb', :framework => :rails)
+    @generator_class.empty_directory(:none, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+
+    instance.framework = :rails
+    instance.empty_directory(:rails).name.should == :rails
+    instance.empty_directory(:merb).should be_nil
+    instance.empty_directory(:none).name.should == :none
+
+    instance.framework = :merb
+    instance.empty_directory(:rails).should be_nil
+    instance.empty_directory(:merb).name.should == :merb
+    instance.empty_directory(:none).name.should == :none
+
+    instance.framework = nil
+    instance.empty_directory(:rails).should be_nil
+    instance.empty_directory(:merb).should be_nil
+    instance.empty_directory(:none).name.should == :none
+  end
+end