templater 0.1.6 → 0.2

data/lib/templater/spec/helpers.rb

@@ -46,7 +46,7 @@ module Templater
         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)
+          @actual.all_actions.map{|t| t.destination }.include?(@expected)
         end
 
         def failure_message

data/spec/actions/empty_directory_spec.rb

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) / '..' / 'spec_helper'
+
+describe Templater::Actions::EmptyDirectory 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 '.new' do
+    it "sets name and destination" do
+      Templater::Actions::EmptyDirectory.new(@generator, :monkey, '/path/to/destination').
+      name.should == :monkey
+    end
+
+    it 'sets destination' do
+      Templater::Actions::EmptyDirectory.new(@generator, :monkey, '/path/to/destination').
+      destination.should == '/path/to/destination'    
+    end
+  end
+
+  describe '#relative_destination' do
+    it "returns the destination relative to the generator's destination root" do
+      @generator.stub!(:destination_root).and_return('/path/to')
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, '/path/to/destination/with/some/more/subdirs')
+      file.relative_destination.should == 'destination/with/some/more/subdirs'
+    end
+  end
+
+  describe '#render' do
+    it 'does nothing for empty directories?'
+  end
+
+  describe '#exists?' do
+
+    it "should exist if the destination file exists" do  
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('erb.rbs'))
+      file.should be_exists
+    end
+
+    it "should not exist if the destination file does not exist" do  
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('some_weird_file.rbs'))
+      file.should_not be_exists
+    end
+  end
+
+  describe '#identical' do
+    it "should not be identical if the destination file doesn't exist" do  
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('some_weird/path/that_does/not_exist'))
+      file.should_not be_identical
+    end
+
+    it "should not be identical if the destination file is not identical to the source file" do
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('simple_erb.rbs'))
+      file.should be_exists
+      file.should be_identical
+    end
+
+    it "should be identical if the destination file is identical to the source file" do
+      file= Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('file.rbs'))
+      file.should be_exists
+      file.should be_identical
+    end
+  end
+
+  describe '#invoke!' do
+    it "should copy the source file to the destination" do
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('path/to/subdir/test2.rbs'))
+
+      file.invoke!
+
+      File.exists?(result_path('path/to/subdir/test2.rbs')).should be_true
+    end
+    
+    it "should trigger before and after callbacks" do
+      @options = { :before => :ape, :after => :elephant }
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('path/to/subdir/test2.rbs'), @options)
+
+      @generator.should_receive(:ape).with(file).ordered
+      @generator.should_receive(:elephant).with(file).ordered
+
+      file.invoke!
+
+      File.exists?(result_path('path/to/subdir/test2.rbs')).should be_true
+    end
+    
+    after do
+      FileUtils.rm_rf(result_path('path'))
+    end
+  end
+
+  describe '#revoke!' do
+    it "removes the destination directory" do
+      file = Templater::Actions::EmptyDirectory.new(@generator, :monkey, result_path('path/to/empty/subdir/'))
+
+      file.invoke!
+      File.exists?(result_path('path/to/empty/subdir/')).should be_true
+
+      file.revoke!
+      File.exists?(result_path('path/to/empty/subdir/')).should be_false
+    end
+  end
+
+end

data/spec/actions/file_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) / '..' / 'spec_helper'
+
+describe Templater::Actions::File 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 '.new' do
+    it "should set name, source and destination" do
+      file = Templater::Actions::File.new(@generator, :monkey, '/path/to/source', '/path/to/destination')
+      file.name.should == :monkey
+      file.source.should == '/path/to/source'
+      file.destination.should == '/path/to/destination'
+    end
+  end
+
+  describe '#relative_destination' do
+    it "should get the destination relative to the generator's destination root" do
+      @generator.stub!(:destination_root).and_return('/path/to')
+      file = Templater::Actions::File.new(@generator, :monkey, '/path/to/source', '/path/to/destination/with/some/more/subdirs')
+      file.relative_destination.should == 'destination/with/some/more/subdirs'
+    end
+  end
+
+  describe '#render' do
+    it "should output the file" do  
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), '/path/to/destination')
+      file.render.should == "test<%= 1+1 %>test"
+    end
+  end
+
+  describe '#exists?' do
+    it "should exist if the destination file exists" do  
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple.rbt'), result_path('erb.rbs'))
+      file.should be_exists
+    end
+
+    it "should not exist if the destination file does not exist" do  
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple.rbt'), result_path('some_weird_file.rbs'))
+      file.should_not be_exists
+    end
+  end
+
+  describe '#identical' do
+    it "should not be identical if the destination file doesn't exist" do  
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('some_weird_file.rbs'))
+      file.should_not be_identical
+    end
+
+    it "should not be identical if the destination file is not identical to the source file" do
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('simple_erb.rbs'))
+      file.should be_exists
+      file.should_not be_identical
+    end
+
+    it "should be identical if the destination file is identical to the source file" do
+      file= Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('file.rbs'))
+      file.should be_exists
+      file.should be_identical
+    end
+  end
+
+  describe '#invoke!' do
+    it "should copy the source file to the destination" do
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs'))
+
+      file.invoke!
+
+      File.exists?(result_path('path/to/subdir/test2.rbs')).should be_true
+      FileUtils.identical?(template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs')).should be_true
+    end
+    
+    it "should trigger before and after callbacks" do
+      @options = { :before => :ape, :after => :elephant }
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs'), @options)
+
+      @generator.should_receive(:ape).with(file).ordered
+      @generator.should_receive(:elephant).with(file).ordered
+
+      file.invoke!
+    end
+    
+    after do
+      FileUtils.rm_rf(result_path('path'))
+    end
+  end
+
+  describe '#revoke!' do
+    it "should remove the destination file" do
+      file = Templater::Actions::File.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs'))
+
+      file.invoke!
+
+      File.exists?(result_path('path/to/subdir/test2.rbs')).should be_true
+      FileUtils.identical?(template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs')).should be_true
+
+      file.revoke!
+
+      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(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test2.rbs'))
+
+      lambda { file.revoke! }.should_not raise_error
+    end
+  end
+
+end

data/spec/actions/template_spec.rb

@@ -0,0 +1,141 @@
+require File.dirname(__FILE__) / '..' / 'spec_helper'
+
+describe Templater::Actions::Template 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 '.new' do
+    it "should set name, source and destination" do
+      template = Templater::Actions::Template.new(@generator, :monkey, '/path/to/source', '/path/to/destination')
+      template.name.should == :monkey
+      template.source.should == '/path/to/source'
+      template.destination.should == '/path/to/destination'
+    end
+  end
+
+  describe '#relative_destination' do
+    it "should get the destination relative to the generator's destination root" do
+      @generator.stub!(:destination_root).and_return('/path/to')
+      template = Templater::Actions::Template.new(@generator, :monkey, '/path/to/source', '/path/to/destination/with/some/more/subdirs')
+      template.relative_destination.should == 'destination/with/some/more/subdirs'
+    end
+  end
+
+  describe '#render' do
+    it "should render a simple template" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple.rbt'), '/path/to/destination')
+      template.render.should == "Hello World"
+    end
+
+    it "should render some basic erb" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), '/path/to/destination')
+      template.render.should == "test2test"
+    end
+
+    it "should render some erb and convert erb literals" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('literals_erb.rbt'), '/path/to/destination')
+      template.render.should == "test2test<%= 1+1 %>blah"
+    end
+
+    it "should render some erb fetching stuff from the context" do
+      @generator.should_receive(:funkydoodle).and_return('_doodle_')
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('erb.rbt'), '/path/to/destination')
+      template.render.should == "test_doodle_blah"
+    end
+  end
+
+  describe '#exists?' do
+    it "should exist if the destination file exists" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple.rbt'), result_path('erb.rbs'))
+      template.should be_exists
+    end
+
+    it "should not exist if the destination file does not exist" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple.rbt'), result_path('some_weird_file.rbs'))
+      template.should_not be_exists
+    end
+  end
+
+  describe '#identical' do
+    before do
+      @context = class << self; self end
+    end
+
+    it "should not be identical if the destination file doesn't exist" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('some_weird_file.rbs'))
+      template.should_not be_identical
+    end
+
+    it "should not be identical if the rendered content does not match the content of the file" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('random.rbs'))
+      template.should be_exists
+      template.should_not be_identical
+    end
+
+    it "should be identical if the rendered content matches the content of the file" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('simple_erb.rbs'))
+      template.should be_exists
+      template.should be_identical
+    end
+  end
+
+  describe '#invoke!' do
+    it "should render the template and copy it to the destination" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('test.rbs'))
+
+      template.invoke!
+
+      File.exists?(result_path('test.rbs')).should be_true
+      File.read(result_path('test.rbs')).should == "test2test"
+    end
+
+    it "should render the template and copy it to the destination, creating any required subdirectories" do  
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test.rbs'))
+
+      template.invoke!
+
+      File.exists?(result_path('path/to/subdir/test.rbs')).should be_true
+      File.read(result_path('path/to/subdir/test.rbs')).should == "test2test"
+    end
+    
+    it "should trigger before and after callbacks" do
+      @options = { :before => :ape, :after => :elephant }
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('path/to/subdir/test.rbs'), @options)
+
+      @generator.should_receive(:ape).with(template).ordered
+      @generator.should_receive(:elephant).with(template).ordered
+
+      template.invoke!
+    end
+    
+    after do
+      FileUtils.rm_rf(result_path('path'))
+    end
+  end
+
+  describe '#revoke!' do
+    it "should remove the destination file" do
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('test.rbs'))
+
+      template.invoke!
+
+      File.exists?(result_path('test.rbs')).should be_true
+      File.read(result_path('test.rbs')).should == "test2test"
+
+      template.revoke!
+
+      File.exists?(result_path('test.rbs')).should be_false
+    end
+
+    it "should do nothing when the destination file doesn't exist" do
+      template = Templater::Actions::Template.new(@generator, :monkey, template_path('simple_erb.rbt'), result_path('test.rbs'))
+
+      lambda { template.revoke! }.should_not raise_error
+    end
+  end
+
+end

data/spec/generator/actions_spec.rb

@@ -4,59 +4,108 @@ describe Templater::Generator, '#actions' do
 
   before do
     @generator_class = Class.new(Templater::Generator)
-    @generator_class.class_eval do
-      def source_root
-        '/tmp/source'
-      end
-    end
+    @generator_class.stub!(:source_root).and_return('/tmp/source')
+  end
+
+  it "should return all actions" do    
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.template :two, 'template2.rb'
+    @generator_class.file :three, 'file1.rb'
+    @generator_class.empty_directory :four, 'file2.rb'
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.actions.should have_names(:one, :two, :three, :four)
+  end
+  
+  it "should return only a certain type of action" do
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.template :two, 'template2.rb'
+    @generator_class.file :three, 'file1.rb'
+    @generator_class.empty_directory :four, 'file2.rb'
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.actions(:templates).should have_names(:one, :two)
+  end
+end
+
+describe Templater::Generator, '#all_actions' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.stub!(:source_root).and_return('/tmp/source')
+    
+    @generator_class2 = Class.new(Templater::Generator)
+    @generator_class2.stub!(:source_root).and_return('/tmp/source')
     
-    @generator1 = mock('a generator')
-    @instance1 = mock('an instance of the generator')
-    @generator1.stub!(:new).and_return(@instance1)
-    @generator2 = mock('another generator')
-    @instance2 = mock('an instance of another generator')
-    @generator2.stub!(:new).and_return(@instance2)
+    @generator_class3 = Class.new(Templater::Generator)
+    @generator_class3.stub!(:source_root).and_return('/tmp/source')    
     
-    @manifold = mock('a manifold')
-    @manifold.stub!(:generator).with(:one).and_return(@generator1)
-    @manifold.stub!(:generator).with(:two).and_return(@generator2)
-    @manifold.stub!(:generator).with(:three).and_return(@generator3)
+    @manifold = Object.new
+    @manifold.extend Templater::Manifold
+    @manifold.add(:one, @generator_class)
+    @manifold.add(:two, @generator_class2)
+    @manifold.add(:three, @generator_class3)
+  end
+
+  it "should return all actions" do    
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.template :two, 'template2.rb'
+    @generator_class.file :three, 'file1.rb'
+    @generator_class.empty_directory :four, 'file2.rb'
+    instance = @generator_class.new('/tmp')
     
-    @generator_class.stub!(:manifold).and_return(@manifold)
+    instance.all_actions.should have_names(:one, :two, :three, :four)
   end
+  
+  it "should return only a certain type of action" do
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.template :two, 'template2.rb'
+    @generator_class.file :three, 'file1.rb'
+    @generator_class.empty_directory :four, 'file2.rb'
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.all_actions(:templates).should have_names(:one, :two)
+  end
+  
+  it "should return all actions recursively for all invocations" do
+    @generator_class.invoke :two
+    @generator_class2.invoke :three
+    
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.file :two, 'file1.rb'
+    @generator_class.empty_directory :three, 'file2.rb'
+
+    @generator_class2.file :four, 'file2.rb'
+    @generator_class2.template :five, 'file2.rb'
+    
+    @generator_class3.template :six, 'fds.rb'
+    @generator_class3.empty_directory :seven, 'dfsd.rb'
 
-  it "should return all templates and files" do    
     instance = @generator_class.new('/tmp')
-    instance.should_receive(:templates).at_least(:once).and_return(['template1', 'template2'])
-    instance.should_receive(:files).at_least(:once).and_return(['file1', 'file2'])
     
-    instance.actions.should include('template1')
-    instance.actions.should include('template2')
-    instance.actions.should include('file1')
-    instance.actions.should include('file2')
+    instance.all_actions.should have_names(:one, :two, :three, :four, :five, :six, :seven)
   end
   
-  it "should return all templates and files recursively for all invocations" do
+  it "should return only a certain type of actions recursively for all invocations" do
+    @generator_class.invoke :two
+    @generator_class2.invoke :three
+    
+    @generator_class.template :one, 'template1.rb'
+    @generator_class.file :two, 'file1.rb'
+    @generator_class.empty_directory :three, 'file2.rb'
+
+    @generator_class2.file :four, 'file2.rb'
+    @generator_class2.template :five, 'file2.rb'
+    
+    @generator_class3.template :six, 'fds.rb'
+    @generator_class3.empty_directory :seven, 'dfsd.rb'
+
     instance = @generator_class.new('/tmp')
-    instance.should_receive(:templates).at_least(:once).and_return(['template1', 'template2'])
-    instance.should_receive(:files).at_least(:once).and_return(['file1', 'file2'])
-    instance.should_receive(:empty_directories).at_least(:once).and_return(['public', 'bin'])
-    instance.should_receive(:invocations).at_least(:once).and_return([@instance1, @instance2])
-    
-    @instance1.should_receive(:actions).at_least(:once).and_return(['subtemplate1', 'subfile1'])
-    @instance2.should_receive(:actions).at_least(:once).and_return(['subtemplate2', 'subfile2'])
-    
-    instance.actions.should include('template1')
-    instance.actions.should include('template2')
-    instance.actions.should include('subtemplate1')
-    instance.actions.should include('subtemplate2')
-    instance.actions.should include('file1')
-    instance.actions.should include('file2')
-    instance.actions.should include('subfile1')
-    instance.actions.should include('subfile2')
-
-    instance.actions.should include('public')
-    instance.actions.should include('bin')    
+    
+    instance.all_actions(:templates).should have_names(:one, :five, :six)
   end
   
 end