templater 0.1.1 → 0.1.2

data/spec/generator/files_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#files' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.class_eval do
+      def source_root
+        '/tmp/source'
+      end
+    end
+  end
+
+  it "should return all files" do
+    @generator_class.file(:blah1, 'blah.rb')
+    @generator_class.file(:blah2, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.files[0].name.should == :blah1
+    instance.files[1].name.should == :blah2
+  end
+  
+  it "should not return files with an option that does not match." do
+    @generator_class.option :framework, :default => :rails
+    
+    @generator_class.file(:merb, 'blah.rb', :framework => :merb)
+    @generator_class.file(:rails, 'blah2.rb', :framework => :rails)
+    @generator_class.file(:none, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+
+    instance.files[0].name.should == :rails
+    instance.files[1].name.should == :none
+
+    instance.framework = :merb
+    instance.files[0].name.should == :merb
+    instance.files[1].name.should == :none
+
+    instance.framework = :rails
+    instance.files[0].name.should == :rails
+    instance.files[1].name.should == :none
+    
+    instance.framework = nil
+    instance.files[0].name.should == :none
+  end
+end

data/spec/generator/generators_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.generators' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    
+    @g1 = Class.new(Templater::Generator)
+    @g2 = Class.new(Templater::Generator)
+    @g3 = Class.new(Templater::Generator)
+    @g4 = Class.new(Templater::Generator)
+
+    @manifold = mock('a manifold')
+    @manifold.stub!(:generator).with(:monkey).and_return(@g1)
+    @manifold.stub!(:generator).with(:blah).and_return(@g2)
+    @manifold.stub!(:generator).with(:duck).and_return(@g3)
+    @manifold.stub!(:generator).with(:llama).and_return(@g4)
+    @manifold.stub!(:generator).with(:i_dont_exist).and_return(nil)
+
+    @generator_class.manifold = @manifold
+    @g1.manifold = @manifold
+    @g2.manifold = @manifold
+    @g3.manifold = @manifold
+    @g4.manifold = @manifold
+  end
+
+  it "should return [self] when no manifold or invocations exist" do
+    @generator_class.manifold = nil
+    @generator_class.generators.should == [@generator_class]
+  end
+  
+  it "should return [self] when only invocations exist" do
+    @generator_class.manifold = nil
+    @generator_class.invoke(:monkey)
+    @generator_class.invoke(:blah)
+    @generator_class.generators.should == [@generator_class]
+  end
+  
+  it "should return a list of invoked generators" do        
+    @generator_class.invoke(:monkey)
+    @generator_class.invoke(:blah)
+    
+    @generator_class.generators.should == [@generator_class, @g1, @g2]
+  end
+  
+  it "should return a list of invoked generators recursively" do
+    @generator_class.invoke(:monkey)
+    @generator_class.invoke(:blah)
+    @g1.invoke(:duck)
+    @g3.invoke(:llama)
+    
+    @generator_class.generators.should == [@generator_class, @g1, @g3, @g4, @g2]
+  end
+  
+  it "should ignore invocations that do not exist in the manifold" do
+    @generator_class.invoke(:monkey)
+    @generator_class.invoke(:blah)
+    @g1.invoke(:duck)
+    @g3.invoke(:i_dont_exist)
+    
+    @generator_class.generators.should == [@generator_class, @g1, @g3, @g2]
+  end
+end

data/spec/generator/glob_spec.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.glob!' do
+  
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.stub!(:source_root).and_return(template_path('glob'))
+  end
+  
+  it "should add templates and files in the source_root based on if their extensions are in the template_extensions array" do
+    @generator_class.glob!()
+    
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.template(:arg_js).source.should == template_path('glob/arg.js')
+    @instance.template(:arg_js).destination.should == "/tmp/destination/arg.js"
+
+    @instance.template(:test_rb).source.should == template_path('glob/test.rb')
+    @instance.template(:test_rb).destination.should == "/tmp/destination/test.rb"
+    
+    @instance.file(:subfolder_jessica_alba_jpg).source.should == template_path('glob/subfolder/jessica_alba.jpg')
+    @instance.file(:subfolder_jessica_alba_jpg).destination.should == '/tmp/destination/subfolder/jessica_alba.jpg'
+  end
+  
+  it "should add templates and files with a different template_extensions array" do
+    @generator_class.glob!(nil, %w(jpg))
+    
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.file(:arg_js).source.should == template_path('glob/arg.js')
+    @instance.file(:arg_js).destination.should == "/tmp/destination/arg.js"
+
+    @instance.file(:test_rb).source.should == template_path('glob/test.rb')
+    @instance.file(:test_rb).destination.should == "/tmp/destination/test.rb"
+    
+    @instance.template(:subfolder_jessica_alba_jpg).source.should == template_path('glob/subfolder/jessica_alba.jpg')
+    @instance.template(:subfolder_jessica_alba_jpg).destination.should == '/tmp/destination/subfolder/jessica_alba.jpg'
+  end
+  
+  it "should add README and other stuff without an extension as templates if in the template_extensions array" do
+    @generator_class.glob!(nil, %w(README))
+    
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.template(:readme).source.should == template_path('glob/README')
+    @instance.template(:readme).destination.should == "/tmp/destination/README"
+  end
+  
+  it "should glob in a subdirectory" do
+    @generator_class.stub!(:source_root).and_return(template_path(""))
+    @generator_class.glob!('glob', %w(jpg))
+    
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.file(:glob_arg_js).source.should == template_path('glob/arg.js')
+    @instance.file(:glob_arg_js).destination.should == "/tmp/destination/glob/arg.js"
+
+    @instance.file(:glob_test_rb).source.should == template_path('glob/test.rb')
+    @instance.file(:glob_test_rb).destination.should == "/tmp/destination/glob/test.rb"
+    
+    @instance.template(:glob_subfolder_jessica_alba_jpg).source.should == template_path('glob/subfolder/jessica_alba.jpg')
+    @instance.template(:glob_subfolder_jessica_alba_jpg).destination.should == '/tmp/destination/glob/subfolder/jessica_alba.jpg'
+  end
+  
+  it "should add only the given templates and files" do
+    @generator_class.glob!()
+    
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.templates.map { |t| t.name }.should == [
+      :arg_js,
+      :readme,
+      :subfolder_monkey_rb,
+      :test_rb
+    ]
+    @instance.files.map { |f| f.name }.should == [
+      :subfolder_jessica_alba_jpg
+    ]
+  end
+  
+end

data/spec/generator/invocations_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#invocations' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.class_eval do
+      def source_root
+        '/tmp/source'
+      end
+    end
+    
+    @generator1 = mock('a generator for merb')
+    @instance1 = mock('an instance of the generator for merb')
+    @generator1.stub!(:new).and_return(@instance1)
+    @generator2 = mock('a generator for rails')
+    @instance2 = mock('an instance of the generator for rails')
+    @generator2.stub!(:new).and_return(@instance2)
+    @generator3 = mock('a generator for both')
+    @instance3 = mock('an instance of the generator for both')
+    @generator3.stub!(:new).and_return(@instance3)
+    
+    @manifold = mock('a manifold')
+    @manifold.stub!(:generator).with(:merb).and_return(@generator1)
+    @manifold.stub!(:generator).with(:rails).and_return(@generator2)
+    @manifold.stub!(:generator).with(:both).and_return(@generator3)
+    
+    @generator_class.stub!(:manifold).and_return(@manifold)
+  end
+
+  it "should return all invocations" do
+    @generator_class.invoke(:merb)
+    @generator_class.invoke(:rails)
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.invocations[0].should == @instance1
+    instance.invocations[1].should == @instance2
+  end
+  
+  it "should not return templates with an option that does not match." do
+    @generator_class.option :framework, :default => :rails
+    
+    @generator_class.invoke(:merb, :framework => :merb)
+    @generator_class.invoke(:rails, :framework => :rails)
+    @generator_class.invoke(:both)
+    
+    instance = @generator_class.new('/tmp')
+
+    instance.invocations[0].should == @instance2
+    instance.invocations[1].should == @instance3
+                                      
+    instance.framework = :merb        
+    instance.invocations[0].should == @instance1
+    instance.invocations[1].should == @instance3
+
+    instance.framework = :rails       
+    instance.invocations[0].should == @instance2
+    instance.invocations[1].should == @instance3
+
+    instance.framework = nil          
+    instance.invocations[0].should == @instance3
+  end
+end

data/spec/generator/invoke_spec.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.invoke' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.first_argument :test1
+    @generator_class.second_argument :test2
+    
+    @invoked_generator = mock('an invoked generator')
+    @invoked_instance = mock('an instance of the invoked generator')
+    @invoked_generator.stub!(:new).and_return(@invoked_instance)
+    
+    @manifold = mock('a manifold')
+    @manifold.stub!(:generator).with(:test).and_return(@invoked_generator)
+  end
+
+  it "should add nothing if there is no manifold" do
+    @generator_class.invoke(:test)
+    @instance = @generator_class.new('/tmp', {}, 'test', 'argument')
+
+    @instance.invocations.should be_empty
+  end
+
+  describe "with no block" do
+    
+    before(:each) do
+      @generator_class.stub!(:manifold).and_return(@manifold)
+    end
+    
+    it "should return the instantiaded template" do
+      @generator_class.invoke(:test)
+      @instance = @generator_class.new('/tmp', {}, 'test', 'argument')
+
+      @instance.invocations.first.should == @invoked_instance
+    end
+    
+    it "should ask the manifold for the generator" do
+      @generator_class.should_receive(:manifold).at_least(:once).and_return(@manifold)
+      @manifold.should_receive(:generator).with(:test).and_return(@invoked_generator)
+      @generator_class.invoke(:test)
+      @instance = @generator_class.new('/tmp', {}, 'test', 'argument')
+      
+      @instance.invocations.first.should == @invoked_instance
+    end
+    
+    it "should instantiate the generator with the correct arguments" do
+      @invoked_generator.should_receive(:new).with('/tmp', {}, 'test', 'argument').and_return(@invoked_instance)
+      @generator_class.invoke(:test)
+      @instance = @generator_class.new('/tmp', {}, 'test', 'argument')
+      
+      @instance.invocations.first.should == @invoked_instance
+    end
+    
+  end
+  
+  describe "with a block" do
+    
+    before(:each) do
+      @generator_class.stub!(:manifold).and_return(@manifold)
+    end
+    
+    it "should pass the generator class to the block and return the result of it" do    
+      @generator_class.invoke(:test) do |generator|
+        generator.new(destination_root, options, 'blah', 'monkey', some_method)
+      end
+      @instance = @generator_class.new('/tmp', {}, 'test', 'argument')
+      
+      @instance.should_receive(:some_method).and_return('da')
+      @invoked_generator.should_receive(:new).with('/tmp', {}, 'blah', 'monkey', 'da').and_return(@invoked_instance)
+      
+      @instance.invocations.first.should == @invoked_instance
+    end
+    
+    it "should ask the manifold for the generator" do
+      @generator_class.should_receive(:manifold).at_least(:once).and_return(@manifold)
+      @manifold.should_receive(:generator).with(:test).and_return(@invoked_generator)
+      
+      @generator_class.invoke(:test) do |generator|
+        generator.new(destination_root, options, 'blah', 'monkey')
+      end
+
+      @instance = @generator_class.new('/tmp', {}, 'test', 'argument')      
+      @instance.invocations.first.should == @invoked_instance
+    end
+  end
+end
+
+
+
+describe Templater::Generator, '#invoke!' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "should invoke all templates" do
+    template1 = mock('a template')
+    template2 = mock('another template')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.should_receive(:templates).and_return([template1, template2])
+    template1.should_receive(:invoke!)
+    template2.should_receive(:invoke!)
+
+    instance.invoke!
+  end
+end

data/spec/generator/option_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.option' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "should add accessors" do
+    @generator_class.option(:test)
+
+    instance = @generator_class.new('/tmp')
+    
+    instance.test = "monkey"
+    instance.test.should == "monkey"
+    
+  end
+  
+  it "should preset a default value" do
+    @generator_class.option(:test, :default => 'elephant')
+
+    instance = @generator_class.new('/tmp')
+  
+    instance.test.should == "elephant"  
+  end
+  
+  it "should allow overwriting of default values" do
+    @generator_class.option(:test, :default => 'elephant')
+
+    instance = @generator_class.new('/tmp')
+  
+    instance.test.should == "elephant"  
+    instance.test = "monkey"  
+    instance.test.should == "monkey"  
+  end
+  
+  it "should allow passing in of options on generator creation" do
+    @generator_class.option(:test, :default => 'elephant')
+
+    instance = @generator_class.new('/tmp', { :test => 'freebird' })
+  
+    instance.test.should == "freebird"  
+    instance.test = "monkey"  
+    instance.test.should == "monkey"  
+  end
+end

data/spec/generator/source_root_getter_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#source_root' do
+  it "try to retrieve the source root from the class" do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.should_receive(:source_root).and_return('/tmp/source')
+
+    instance = @generator_class.new('/tmp')
+    instance.source_root.should == '/tmp/source'
+  end
+end

data/spec/generator/source_root_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.source_root' do
+  it "should raise an error, complaining that source_root must be overridden" do
+    @generator_class = Class.new(Templater::Generator)    
+    lambda { @generator_class.source_root }.should raise_error(Templater::SourceNotSpecifiedError)
+  end
+end

data/spec/generator/template_getter_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#template' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+    @generator_class.class_eval do
+      def source_root
+        '/tmp/source'
+      end
+    end
+  end
+
+  it "should find a template by name" do
+    @generator_class.template(:blah1, 'blah.rb')
+    @generator_class.template(:blah2, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.template(:blah1).name.should == :blah1
+    instance.template(:blah1).source.should == '/tmp/source/blah.rbt'
+    instance.template(:blah1).destination.should == '/tmp/blah.rb'
+  end
+  
+  it "should not return a template with an option that does not match." do
+    @generator_class.option :framework, :default => :rails
+    
+    @generator_class.template(:merb, 'blah.rb', :framework => :merb)
+    @generator_class.template(:rails, 'blah2.rb', :framework => :rails)
+    @generator_class.template(:none, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+
+    instance.template(:rails).name.should == :rails
+    instance.template(:merb).should be_nil
+    instance.template(:none).name.should == :none
+
+    instance.framework = :merb
+    instance.template(:rails).should be_nil
+    instance.template(:merb).name.should == :merb
+    instance.template(:none).name.should == :none
+
+    instance.framework = nil
+    instance.template(:rails).should be_nil
+    instance.template(:merb).should be_nil
+    instance.template(:none).name.should == :none
+  end
+end