generator-spec 0.4.3 → 0.4.4

data/README.markdown

@@ -2,22 +2,24 @@
 
 This project contains RSpec 2 matchers, helpers and various utilities to assist in writing Rails 3 generator specs.
 
-Rails 3 has a Rails::Generators::TestCase class for use with Test-Unit, to help test generators, containing specific assertion methods that can be used to assert generator behavior. Theres was no RSpec 2 equivalent, so I wrapped Rails::Generators::TestCase for use with RSpec 2 and created some RSpec 2 matchers that mimic the assertion methods
-of TestCase and also added some extra goodies to the mix. It should now be pretty easy to test your Rails 3 generators with RSpec 2 :)
+Rails 3 has a Rails::Generators::TestCase class for use with Test-Unit, to help test generators. This TestCase contains specific custom assertion methods that can be used to assert generator behavior. To create an RSpec 2 equivalent, I wrapped Rails::Generators::TestCase for use with RSpec 2 and created some RSpec 2 matchers that mimic the assertion methods of the Test-Unit TestCase. I have also a bunch of "extra goodies" to the mix. The new intuitive DSL RSpec DSL for specifying/testing generators should make it very easy and intuitive to test your Rails 3 generators with RSpec 2 :)
 
-Please advice if you find any issues or have suggestions for improvements. The code is not as pretty as it could be, so feel free to refactor and improve it to your hearts desire!
+Please advice if you find any issues or have suggestions for improvements. The code is not as pretty as it could be, so feel free to refactor and improve this gem to your hearts desire!
 
 ## Install
 
-<code>gem install rspec_for_generators</code>
+<code>gem install generator-spec</code>
 
-The gem is a jewel (using jeweler), so to install the gem from the code - simply use the jeweler rake task:
+### Install from code
+
+The gem is a jewel based on [jeweler](http://github.com/technicalpickles/jeweler). 
+To install the gem from the code, simply use the jeweler rake task:
 
 <code>rake install</code>
 
 ## Usage
 
-The following demonstrates an example usage. There are many more options and DSL convenience methods.
+The following demonstrates usage of this gem. There are many more options and DSL convenience methods.
 
 ### Configuration
 
@@ -26,32 +28,59 @@ First setup the *spec_helper.rb*. Here is an example configuration.
 <pre># spec/spec_helper.rb
   
 require 'rspec'
-require 'rspec_for_generators'
+require 'generators_spec'
 
 # configure it like this to use default settings
-RSpec::Generator.configure_root_dir __FILE__
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = true
+  config.default_rails_root(__FILE__)
+end
 
 # or customize the location of the temporary Rails 3 app dir used
-RSpec::Generator.configure_root_dir '~/my/rails/folder', :custom
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = true
+  config.rails_root = '~/my/rails/folder'
+end
+
 </pre>
 
 ### Specs for generators
 
-I recommend having a separate spec for each generator. A generator spec can include *this* file to ensure all generators are loaded.
-Put a *require_generator* statement in each spec file, to ensure that particular generator is loaded and thus available for the spec.
+I recommend having a separate spec for each generator called a 'generator spec'. 
+You can use the special *require_generator* statement to ensure that one or more generators are loaded and made available for the spec.
 
 <pre>require_generator :canable</pre>
 
 This will load the generator : `generators/canabale_generator.rb`
 
-If the generator is namespaced, use a nested approach like this:
+If the generator is in a namespace, use a nested approach like this:
 
 <pre>require_generators :canable => ['model', 'user']</pre>
 
 This will load the generators: `generators/canable/model_generator.rb` and `generators/canable/user_generator.rb`
 
-If you have multiple generators in a shared namespace, the following approach can be used. 
-Create a file that loads all the generators in the namespace. Include this file for each spec that tests a particular generator in that namespace:
+You can also load generators from multiple namespaces and mix and match like this
+
+<pre>require_generators [:canable => ['model', 'user'], :other => :side, :simple]</pre>
+
+### Auto-require all generators
+
+You can also require all generators or all within a specific namespace like this:
+
+require_generators :all
+require_generators :canable => :all
+
+## Using a shared generator loader file
+
+If you have multiple generators in a shared namespace, the following alternative approach can be used. 
+Create a file that loads all the generators you are specifying in this folder, fx all generators in a specific namespace. 
+Then include this 'generator load file' in each spec. 
+
+This uses the 'require_all' gem functionality
+
+## Example usage: require generators
   
 <pre># spec/generators/canable.rb
 require_generators :canable => ['model', 'user']</pre>
@@ -76,9 +105,7 @@ describe 'user_generator' do
 end
 </pre>
 
-
-
-### Example of full generator spec
+### Example: full generator spec
 
 <pre># spec/generators/model_generator_spec.rb  
 
@@ -99,29 +126,27 @@ describe 'model_generator' do
       tests Canable::Generators::ModelGenerator
     end    
     # ensure clean state before run
-    remove_model 'account'    
+    remove_model :account
   end
 
   after :each do              
-    # ensure clean state after run  
-    remove_model 'account'    
+    # ensure clean state after each run  
+    remove_model :account
   end
     
   it "should not work without an existing Account model file" do            
     with_generator do |g|   
-      name = 'account'
-      g.run_generator %w{account}
-      g.should_not generate_file name, :model
+      g.run_generator :account.args
+      g.should_not generate_file :account, :model
     end
   end
 
   it "should decorate an existing Account model file with 'include Canable:Ables'" do            
     with_generator do |g|  
-      name = 'account'
-      create_model name     
-      g.run_generator %w{account}
-      g.should generate_model name do |content|
-        content.should have_class name do |klass|
+      create_model :account     
+      g.run_generator 'account'.args
+      g.should generate_model :account do |content|
+        content.should have_class :account do |klass|
           klass.should include_module 'Canable::Ables'
         end
       end
@@ -129,15 +154,6 @@ describe 'model_generator' do
   end
 end</pre>
 
-## TODO
-
-Need to create specs to test matchers/helpers for generated:
-* migration
-* controller
-* helper
-* view
-* ...
-
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/lib/{rspec_for_generators.rb → generator_spec.rb}

@@ -4,7 +4,7 @@ require 'rails'
 require 'require_all'
 require 'rails/generators'
 require 'active_support/core_ext/module/aliasing'
-require 'rspec_for_generators/main'
+require 'generator_spec/main'
 
 RSpec.configure do |config|
   config.include(RSpec::FileMatchers)

data/lib/generator_spec/extensions/core_ext.rb

@@ -0,0 +1,17 @@
+class Array
+  def args
+    flatten.map{|a| a.args}.flatten
+  end
+end
+
+class Symbol
+  def args
+    [to_s]
+  end
+end
+
+class String
+  def args
+    (self =~ /\w+\s+\w+/) ? self.split : self
+  end
+end

data/lib/{rspec_for_generators/rails_spec_helper.rb → generator_spec/helpers/configure_rails.rb}

@@ -1,5 +1,3 @@
-require_all File.dirname(__FILE__) + '/rails_helpers'
-
 module TmpRails
   class << self    
     attr_accessor :root
@@ -22,8 +20,6 @@ end
   
 module Rails
   def self.root
-    # raise StandardError, "You must define a location for Rails.config_root_dir" if !Rails.config_root_dir    
-    # @root ||= File.expand_path(File.join(Rails.config_root_dir, '..', 'tmp', 'rails'))
     @root ||= File.join(Rails.application.config.root_dir, 'rails')
   end
 end

data/lib/generator_spec/main.rb

@@ -0,0 +1,42 @@
+module RSpec
+  module Generator
+  end
+end
+
+module RSpec
+  module RubyContentMatchers
+  end
+end
+
+module RSpec
+  module FileMatchers
+  end
+end
+
+require_all File.dirname(__FILE__) + '/extensions'
+require_all File.dirname(__FILE__) + '/rails_helpers'
+require_all File.dirname(__FILE__) + '/helpers'
+require_all File.dirname(__FILE__) + '/rspec_generator'
+
+
+module RSpec::Core
+  class ExampleGroup
+    def with_generator &block
+      RSpec::Generator.with_generator &block
+    end
+    
+    def setup_generator test_method_name=nil, &block
+      RSpec::Generator.setup_generator test_method_name, &block
+    end
+  end
+end
+
+require 'generator_spec/require_generator'
+
+require 'generator_spec/matchers/content/content_matcher'
+require_all File.dirname(__FILE__) + '/matchers/content'
+
+require_all File.dirname(__FILE__) + '/matchers/file'
+require_all File.dirname(__FILE__) + '/matchers/migration'
+
+require_all File.dirname(__FILE__) + '/matchers/helpers'

data/lib/generator_spec/matchers/content/content_matcher.rb

@@ -0,0 +1,21 @@
+module RSpec
+  class RubyContentMatcher
+    attr_reader :content    
+    
+    def matches?(content)
+      @content = content
+    end    
+    
+    def failure_message
+      debug_content
+    end
+
+    def negative_failure_message
+      debug_content
+    end
+      
+    def debug_content
+      puts "Content: #{content}" if RSpec::Generator.debug?      
+    end
+  end
+end

data/lib/{rspec_for_generators → generator_spec}/matchers/content/have_block.rb

@@ -1,6 +1,6 @@
 module RSpec::RubyContentMatchers
-  class HaveBlock
-    attr_reader :name, :args, :block_args, :content
+  class HaveBlock < RSpec::RubyContentMatcher
+    attr_reader :name, :args, :block_args
 
     def initialize(name, options={})
       @name = name.to_s
@@ -8,9 +8,9 @@ module RSpec::RubyContentMatchers
       @block_args = options[:block_args]
     end
 
-    def matches?(content)            
-      @content = content 
-      match_res = (content =~ /#{name}\s+#{args_expr}do\s+#{block_args_expr}(.*?)end/m) != nil
+    def matches?(content)
+      super
+      match_res = (content =~ /#{name}\s+#{args_expr}do\s+#{block_args_expr}(.*?)#{end_expr}/m) != nil
       block_content = $1 || $3
       if block_given? && block_content
         ruby_content = block_content.strip.extend(RSpec::RubyContent::Helpers)
@@ -20,17 +20,21 @@ module RSpec::RubyContentMatchers
     end          
   
     def failure_message   
-      puts "Content: #{content}" if RSpec::Generator.debug?      
+      super
       return "Expected there to be a block #{name} with arguments #{args}, but there wasn't"
     end 
     
     def negative_failure_message  
-      puts "Content: #{content}" if RSpec::Generator.debug?                                          
+      super
       return "Did not expect there to be a block #{name} with arguments #{args}, but there was"
     end               
     
     protected
 
+    def end_expr
+      "(end|# #{name})"
+    end
+
     def args_expr
       args ? '(\()?\s*' + args + '\s*(\))?\s+' : ''
     end      
@@ -42,5 +46,10 @@ module RSpec::RubyContentMatchers
   
   def have_block(name, options={})
     HaveBlock.new(name, options)
-  end    
+  end
+
+  def have_class_self(name, options={})
+    HaveBlock.new('class', :args => '<< self')
+  end
+
 end

data/lib/{rspec_for_generators → generator_spec}/matchers/content/have_call.rb

@@ -6,8 +6,8 @@
 #   say_hello_file_content.should have_method "hello"
 #
 module RSpec::RubyContentMatchers
-  class HaveCall
-    attr_reader :method, :args, :content
+  class HaveCall < RSpec::RubyContentMatcher
+    attr_reader :method, :args
 
     def initialize(method, args = nil)
       @method = method.to_s
@@ -15,18 +15,18 @@ module RSpec::RubyContentMatchers
     end
 
     def matches?(content)
-      @content = content
+      super
       (content =~ /#{method}#{args_expr}/m) != nil
     end          
   
     def failure_message
-      puts "Content: #{content}" if RSpec::Generator.debug?      
+      super
       return "Expected there to be a call to #{method} with args #{args}, but there wasn't" if args
       "Expected there to be a call to #{method}, but there wasn't"      
     end 
     
-    def negative_failure_message               
-      puts "Content: #{content}" if RSpec::Generator.debug?                             
+    def negative_failure_message
+      super
       return "Did not expect there to be a call to #{method} with args #{args}, but there was" if args
       "Did not expect there to be a call to #{method}, but there was"
     end

data/lib/{rspec_for_generators → generator_spec}/matchers/content/have_calls.rb

@@ -1,13 +1,13 @@
 module RSpec::RubyContentMatchers
-  class HaveCalls
-    attr_reader :calls, :method, :args, :content
+  class HaveCalls < RSpec::RubyContentMatcher
+    attr_reader :calls, :method, :args
 
     def initialize(calls)
       @calls = calls
     end
 
     def matches?(content)
-      @content = content
+      super
       calls.each_pair do |method, args|
         @method = method.to_s
         @args = args
@@ -17,13 +17,13 @@ module RSpec::RubyContentMatchers
     end          
   
     def failure_message
-      puts "Content: #{content}" if RSpec::Generator.debug?            
+      super
       return "Expected there to be a call to #{method} with args #{args}, but there wasn't" if args
       "Expected there to be a call to #{method}, but there wasn't"
     end 
     
     def negative_failure_message 
-      puts "Content: #{content}" if RSpec::Generator.debug?                                           
+      super
       return "Did not expect there to be a call to #{method} with args #{args}, but there was" if args
       "Did not expect there to be a call to #{method}, but there was"
     end

data/lib/{rspec_for_generators → generator_spec}/matchers/content/have_class.rb

@@ -1,6 +1,6 @@
 module RSpec::RubyContentMatchers
-  class HaveClass
-    attr_reader :klass, :type, :content
+  class HaveClass < RSpec::RubyContentMatcher
+    attr_reader :klass, :type
 
     def initialize(klass, type=nil)
       @klass = klass.to_s.camelize
@@ -8,8 +8,8 @@ module RSpec::RubyContentMatchers
     end
 
     def matches?(content) 
-      @content = content     
-      match_res = (content =~ /class\s+#{klass}#{type}\s+(.*)end/m)
+      super
+      match_res = (content =~ /class\s+#{klass}#{type}\s+(.*)#{end_expr}/m)
       if block_given? && $1
         ruby_content = $1.strip.extend(RSpec::RubyContent::Helpers)
         yield ruby_content        
@@ -18,28 +18,36 @@ module RSpec::RubyContentMatchers
     end          
   
     def failure_message 
-      puts "Content: #{content}" if RSpec::Generator.debug?
+      super
       "Expected there to be the class #{klass}"
     end 
     
     def negative_failure_message    
-      puts "Content: #{content}" if RSpec::Generator.debug?      
+      super
       "Did no expected there to be the class #{klass}"
     end
+
+    def end_expr
+      "(end|# #{klass})"
+    end
                
   end
   
   def have_class(klass, type = nil)
     HaveClass.new(klass, type)
   end    
+  alias_method :be_class, :have_class
 
   def have_helper_class(klass)
     HaveClass.new(klass, :helper)
   end    
+  alias_method :be_helper_class, :have_helper_class
+
 
   def have_controller_class(klass)
     HaveClass.new(klass, :controller)
   end
+  alias_method :be_controller_class, :have_controller_class  
 end