templater 0.1.1 → 0.1.2

data/spec/generator/actions_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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
+    
+    @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)
+    
+    @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)
+    
+    @generator_class.stub!(:manifold).and_return(@manifold)
+  end
+
+  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')
+  end
+  
+  it "should return all templates and files recursively for all invocations" 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.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')    
+  end
+  
+end

data/spec/generator/argument_as_array_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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

data/spec/generator/argument_as_hash_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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/argument_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.argument' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+  
+  it "should create accessors" do
+    @generator_class.argument(0, :monkey)
+    
+    instance = @generator_class.new('/tmp')
+    instance.monkey = 'a test'
+    instance.monkey.should == 'a test'
+  end
+  
+  it "should pass an initial value to the argument" do
+    @generator_class.argument(0, :monkey)
+    
+    instance = @generator_class.new('/tmp', {}, 'i am a monkey')
+    instance.monkey.should == 'i am a monkey'
+  end
+  
+  it "should create multiple accessors" do
+    @generator_class.argument(0, :monkey)
+    @generator_class.argument(1, :llama)
+    @generator_class.argument(2, :herd)
+    
+    instance = @generator_class.new('/tmp')
+    instance.monkey = 'a monkey'
+    instance.monkey.should == 'a monkey'
+    instance.llama = 'a llama'
+    instance.llama.should == 'a llama'
+    instance.herd = 'a herd'
+    instance.herd.should == 'a herd'
+  end
+  
+  it "should pass an initial value to multiple accessors" do
+    @generator_class.argument(0, :monkey)
+    @generator_class.argument(1, :llama)
+    @generator_class.argument(2, :herd)
+    
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'a llama', 'a herd')
+    instance.monkey.should == 'a monkey'
+    instance.llama.should == 'a llama'
+    instance.herd.should == 'a herd'
+  end
+  
+  it "should set a default value for an argument" do
+    @generator_class.argument(0, :monkey, :default => 'a revision')
+    
+    instance = @generator_class.new('/tmp')
+    instance.monkey.should == 'a revision'
+  end
+  
+  it "should allow some syntactic sugar declaration" do
+    @generator_class.first_argument(:monkey)
+    @generator_class.second_argument(:llama)
+    @generator_class.third_argument(:herd)
+    @generator_class.fourth_argument(:elephant)
+    
+    instance = @generator_class.new('/tmp', {}, 'a monkey', 'a llama', 'a herd', 'an elephant')
+    instance.monkey.should == 'a monkey'
+    instance.llama.should == 'a llama'
+    instance.herd.should == 'a herd'
+    instance.elephant.should == 'an elephant'
+  end
+  
+  it "should whine when there are too many arguments" do
+    @generator_class.argument(0, :monkey)
+    @generator_class.argument(1, :llama)
+    
+    lambda { @generator_class.new('/tmp', {}, 'a monkey', 'a llama', 'a herd') }.should raise_error(Templater::TooManyArgumentsError)
+  end
+  
+  it "should assign arguments if an argument is required and that requirement is fullfilled" do
+    @generator_class.argument(0, :monkey, :required => true)
+    @generator_class.argument(1, :elephant, :required => true)
+    @generator_class.argument(2, :llama)
+    
+    instance = @generator_class.new('/tmp', {}, 'enough', 'arguments')
+    instance.monkey.should == "enough"
+    instance.elephant.should == "arguments"
+    instance.llama.should be_nil
+  end
+  
+  it "should raise an error when a required argument is not passed" do
+    @generator_class.argument(0, :monkey, :required => true)
+    @generator_class.argument(1, :elephant, :required => true)
+    @generator_class.argument(2, :llama)
+    
+    lambda { @generator_class.new('/tmp', {}, 'too few arguments') }.should raise_error(Templater::TooFewArgumentsError)    
+  end
+  
+  it "should raise an error if nil is assigned to a require argument" do
+    @generator_class.argument(0, :monkey, :required => true)
+    
+    instance = @generator_class.new('/tmp', {}, 'test')
+    
+    lambda { instance.monkey = nil }.should raise_error(Templater::TooFewArgumentsError)    
+  end
+  
+  it "should assign an argument when a block appended to an argument does not throw :invalid" do
+    @generator_class.argument(0, :monkey) do
+      1 + 1
+    end
+    @generator_class.argument(1, :elephant) do
+      false
+    end
+    @generator_class.argument(2, :llama)
+    
+    instance = @generator_class.new('/tmp', {}, 'blah', 'urgh')
+    instance.monkey.should == 'blah'
+    instance.elephant.should == 'urgh'
+    
+    instance.monkey = :harr
+    instance.monkey.should == :harr
+  end
+  
+  it "should raise an error with the throw message, when a block is appended to an argument and throws :invalid" do
+    @generator_class.argument(0, :monkey) do
+      throw :invalid, 'this is not a valid monkey, bad monkey!'
+    end
+    
+    lambda { @generator_class.new('/tmp', {}, 'blah') }.should raise_error(Templater::ArgumentError, 'this is not a valid monkey, bad monkey!')
+    
+    instance = @generator_class.new('/tmp')
+    
+    lambda { instance.monkey = :anything }.should raise_error(Templater::ArgumentError, 'this is not a valid monkey, bad monkey!')
+  end
+
+end

data/spec/generator/desc_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.desc' do
+  it "should append text when called with an argument, and return it when called with no argument" do
+    @generator_class = Class.new(Templater::Generator)
+    
+    @generator_class.desc "some text"
+    @generator_class.desc.should == "some text"
+  end
+end

data/spec/generator/destination_root_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#destination_root' do
+  it "should be remembered" do
+    @generator_class = Class.new(Templater::Generator)
+    instance = @generator_class.new('/path/to/destination')
+    instance.destination_root.should == '/path/to/destination'
+  end
+end

data/spec/generator/empty_directory_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, ".empty_directory" do
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "adds directory path to list of directories that should be created" do
+    lambda do
+      @generator_class.empty_directory :bin, "bin"
+    end.should change(@generator_class.empty_directories, :size)    
+  end
+  
+  it "calculates directory path relatively to destination root" do
+    @generator_class.empty_directory :bin, "bin/swf"
+    
+    @instance = @generator_class.new("/tmp/destination")
+    @instance.empty_directory(:bin).destination.should == "/tmp/destination/bin/swf"
+  end  
+end

data/spec/generator/file_getter_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '#file' 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 file by name" do
+    @generator_class.file(:blah1, 'blah.rb')
+    @generator_class.file(:blah2, 'blah2.rb')
+    
+    instance = @generator_class.new('/tmp')
+    
+    instance.file(:blah1).name.should == :blah1
+    instance.file(:blah1).source.should == '/tmp/source/blah.rb'
+    instance.file(:blah1).destination.should == '/tmp/blah.rb'
+  end
+  
+  it "should not return a file 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.file(:rails).name.should == :rails
+    instance.file(:merb).should be_nil
+    instance.file(:none).name.should == :none
+
+    instance.framework = :merb
+    instance.file(:rails).should be_nil
+    instance.file(:merb).name.should == :merb
+    instance.file(:none).name.should == :none
+
+    instance.framework = nil
+    instance.file(:rails).should be_nil
+    instance.file(:merb).should be_nil
+    instance.file(:none).name.should == :none
+  end
+end

data/spec/generator/file_list_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.file_list' do
+  
+  it "should add a series of files given a list as heredoc" do
+    @generator_class = Class.new(Templater::Generator)
+    
+    @generator_class.should_receive(:file).with(:app_model_rb, 'app/model.rb')
+    @generator_class.should_receive(:file).with(:spec_model_rb, 'spec/model.rb')
+    @generator_class.should_receive(:file).with(:donkey_poo_css, 'donkey/poo.css')
+    @generator_class.should_receive(:file).with(:john_smith_file_rb, 'john/smith/file.rb')
+    
+    @generator_class.file_list <<-LIST
+      app/model.rb
+      spec/model.rb
+      donkey/poo.css
+      john/smith/file.rb
+    LIST
+  end
+  
+  it "should add a series of files given a list as array" do
+    @generator_class = Class.new(Templater::Generator)
+    
+    @generator_class.should_receive(:file).with(:app_model_rb, 'app/model.rb')
+    @generator_class.should_receive(:file).with(:spec_model_rb, 'spec/model.rb')
+    @generator_class.should_receive(:file).with(:donkey_poo_css, 'donkey/poo.css')
+    @generator_class.should_receive(:file).with(:john_smith_file_rb, 'john/smith/file.rb')
+    
+    @generator_class.file_list(%w(app/model.rb spec/model.rb donkey/poo.css john/smith/file.rb))
+  end
+  
+end

data/spec/generator/file_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templater::Generator, '.file' do
+
+  before do
+    @generator_class = Class.new(Templater::Generator)
+  end
+
+  it "should add a file with source and destination" do
+    @generator_class.file(:my_template, 'path/to/source.rbt', 'path/to/destination.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:source_root).and_return('/tmp/source')
+    
+    @instance.file(:my_template).source.should == '/tmp/source/path/to/source.rbt'
+    @instance.file(:my_template).destination.should == '/tmp/destination/path/to/destination.rb'
+    @instance.file(:my_template).should be_an_instance_of(Templater::File)
+  end
+  
+  it "should add a file with source and infer destination " do
+    @generator_class.file(:my_template, 'path/to/file.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:source_root).and_return('/tmp/source')
+    
+    @instance.file(:my_template).source.should == '/tmp/source/path/to/file.rb'
+    @instance.file(:my_template).destination.should == '/tmp/destination/path/to/file.rb'
+    @instance.file(:my_template).should be_an_instance_of(Templater::File)
+  end
+  
+  it "should add a file and convert an instruction encoded in the destination, but not one encoded in the source" do
+    @generator_class.file(:my_template, 'template/%some_method%.rbt', 'template/%another_method%.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:source_root).and_return('/tmp/source')
+    @instance.should_not_receive(:some_method)
+    @instance.should_receive(:another_method).at_least(:once).and_return('beast')
+    
+    @instance.file(:my_template).source.should == '/tmp/source/template/%some_method%.rbt'
+    @instance.file(:my_template).destination.should == "/tmp/destination/template/beast.rb"
+    @instance.file(:my_template).should be_an_instance_of(Templater::File)
+  end
+  
+  it "should add a file and leave an encoded instruction be if it doesn't exist as a method" do
+    @generator_class.file(:my_template, 'template/blah.rbt', 'template/%some_method%.rb')
+    @instance = @generator_class.new('/tmp/destination')
+    
+    @instance.stub!(:source_root).and_return('/tmp/source')
+    
+    @instance.file(:my_template).destination.should == "/tmp/destination/template/%some_method%.rb"
+    @instance.file(:my_template).should be_an_instance_of(Templater::File)
+  end
+end