generator-spec 0.4.5 → 0.4.7

data/README.markdown

@@ -1,17 +1,22 @@
-# RSpec 2 library for specifying and testing generators
+# RSpec 2 add-on for specifying and testing generators
 
-This project contains RSpec 2 matchers, helpers and various utilities to assist in writing Rails 3 generator specs.
+This project contains RSpec 2 matchers, helpers and various utilities to assist in writing Generator specs. 
+There is additional support geared towards spec'ing Generators for Rails 3.
 
-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 :)
+## Why?
 
-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!
+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. 
+
+This RSpec DSL should make it very easy and enjoyable to spec and test your Generators with RSpec 2 :)
+
+## Feedback
+
+Please let me know if you find any issues or have suggestions for improvements. 
 
 ## Install
 
 <code>gem install generator-spec</code>
 
-### 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:
 
@@ -19,7 +24,7 @@ To install the gem from the code, simply use the jeweler rake task:
 
 ## Usage
 
-The following demonstrates usage of this gem. There are many more options and DSL convenience methods.
+The following demonstrates usage of this library. There are many more options and DSL convenience methods (see wiki, code or specs).
 
 ### Configuration
 
@@ -35,12 +40,12 @@ RSpec::Generator.configure do |config|
   config.debug = false
   config.remove_temp_dir = true
   config.default_rails_root(__FILE__)
+  config.logger = :stdout # :file to output to a log file, logger only active when debug is true
 end
 
 # or customize the location of the temporary Rails 3 app dir used
 RSpec::Generator.configure do |config|
-  config.debug = false
-  config.remove_temp_dir = true
+  # ...
   config.rails_root = '~/my/rails/folder'
 end
 
@@ -48,20 +53,21 @@ end
 
 ### Specs for generators
 
-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.
+I recommend having a separate spec file for each generator (generator specs).
+You can use the special *require_generator* statement to ensure that one or more generators are loaded and made available for a given spec.
 
 <pre>require_generator :canable</pre>
 
 This will load the generator : `generators/canabale_generator.rb`
 
-If the generator is in a namespace, use a nested approach like this:
+If the generator is in a namespace (subfolder of generators), 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`
 
-You can also load generators from multiple namespaces and mix and match like this
+You can also load generators from multiple namespaces and mix and match like this. 
+I recommend against this however as it is difficult to read.
 
 <pre>require_generators [:canable => ['model', 'user'], :other => :side, :simple]</pre>
 
@@ -72,39 +78,6 @@ 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>
-
-<pre># spec/generators/canable/model_generator_spec.rb
-...
-# load generators to spec
-require 'generators/canable'
-
-describe 'model_generator' do
-  ...   
-end
-</pre>
-
-<pre># spec/generators/canable/user_generator_spec.rb
-...
-# load generators to spec
-require 'generators/canable'
-
-describe 'user_generator' do
-  ...   
-end
-</pre>
-
 ### Example: full generator spec
 
 <pre># spec/generators/model_generator_spec.rb  
@@ -154,6 +127,45 @@ describe 'model_generator' do
   end
 end</pre>
 
+## Code specs 
+
+There are a bunch of specialized ruby code matchers in the matchers/content folder which can be used to spec code files in general.
+Check out the specs in spec/generator_spec/matchers/content for examples on how to use these. 
+
+## Rails specs
+
+The rails_helpers folder contains a bunch of files which makes it easy to spec rails files and to perform various "Rails mutations". 
+These mutations make it easy to setup the temporary Rails app in a specific pre-condition, which is required for a given spec.
+
+### Examples: Rails helpers
+
+describe 'controller' do
+  include RSpec::Rails::Controller 
+
+  before :each do              
+    create_controller :account do
+      %q{
+        def index
+        end
+      }
+    end    
+  end
+
+  after :each do              
+    remove_controller :account
+  end
+    
+  it "should have an account_controller file that contains an AccountController class with an index method inside" do      
+      Rails.application.should have_controller :account_controller do |controller_file|
+        controller_file.should have_controller_class :account_controller do |klass|
+          klass.should have_method :index
+        end
+      end
+    end
+  end
+end
+
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.4.7

data/generator-spec.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{generator-spec}
-  s.version = "0.4.5"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
      "lib/generator_spec/matchers/content/have_block.rb",
      "lib/generator_spec/matchers/content/have_call.rb",
      "lib/generator_spec/matchers/content/have_calls.rb",
-     "lib/generator_spec/matchers/content/have_class.rb",
+     "lib/generator_spec/matchers/content/have_class_self.rb",
      "lib/generator_spec/matchers/content/have_method.rb",
      "lib/generator_spec/matchers/content/have_module.rb",
      "lib/generator_spec/matchers/content/have_region.rb",
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
      "lib/generator_spec/matchers/file/generate_directory.rb",
      "lib/generator_spec/matchers/file/generate_file.rb",
      "lib/generator_spec/matchers/file/generate_migration.rb",
+     "lib/generator_spec/matchers/file/have_file.rb",
      "lib/generator_spec/matchers/helpers/content.rb",
      "lib/generator_spec/matchers/helpers/file.rb",
      "lib/generator_spec/matchers/helpers/migration.rb",
@@ -75,12 +76,46 @@ Gem::Specification.new do |s|
      "lib/generators/observer/observer_generator.rb",
      "lib/generators/view/view_generator.rb",
      "rspec_for_generators.gemspec",
-     "spec/generator_spec/controller_generator_spec.rb",
-     "spec/generator_spec/helper_generator_spec.rb",
-     "spec/generator_spec/migration_generator_spec.rb",
-     "spec/generator_spec/model_generator_spec.rb",
-     "spec/generator_spec/observer_generator_spec.rb",
-     "spec/generator_spec/view_generator_spec.rb",
+     "spec/generator_spec/generators/controller_generator_spec.rb",
+     "spec/generator_spec/generators/helper_generator_spec.rb",
+     "spec/generator_spec/generators/migration_generator_spec.rb",
+     "spec/generator_spec/generators/model_generator_spec.rb",
+     "spec/generator_spec/generators/observer_generator_spec.rb",
+     "spec/generator_spec/generators/view_generator_spec.rb",
+     "spec/generator_spec/matchers/content/class_self_spec.rb",
+     "spec/generator_spec/matchers/content/have_block_spec.rb",
+     "spec/generator_spec/matchers/content/have_call_spec.rb",
+     "spec/generator_spec/matchers/content/have_calls_spec.rb",
+     "spec/generator_spec/matchers/content/have_class_spec.rb",
+     "spec/generator_spec/matchers/content/have_method_spec.rb",
+     "spec/generator_spec/matchers/content/have_module_spec.rb",
+     "spec/generator_spec/matchers/content/have_region_spec.rb",
+     "spec/generator_spec/matchers/content/have_subclass_spec.rb",
+     "spec/generator_spec/matchers/content/include_module_spec.rb",
+     "spec/generator_spec/matchers/content/inherit_from_spec.rb",
+     "spec/generator_spec/matchers/file/directory_spec.rb",
+     "spec/generator_spec/matchers/file/file_spec.rb",
+     "spec/generator_spec/matchers/file/migration_spec.rb",
+     "spec/generator_spec/matchers/migration/have_column_spec.rb",
+     "spec/generator_spec/matchers/migration/have_index_spec.rb",
+     "spec/generator_spec/matchers/migration/have_table_spec.rb",
+     "spec/generator_spec/matchers/migration/have_tbl_column_spec.rb",
+     "spec/generator_spec/matchers/migration/have_up_down_spec.rb",
+     "spec/generator_spec/matchers/rails/controller_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/helper_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/mailer_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/model_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/observer_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/view_matcher_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_app_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_controller_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_helper_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_mailer_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_migration_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_model_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_observer_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_orm_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_view_spec.rb",
      "spec/spec_helper.rb",
      "wiki/Custom Rails 3 Generators.textile",
      "wiki/content_matchers.textile",
@@ -94,12 +129,46 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{RSpec 2 library for writing generator specs}
   s.test_files = [
-    "spec/generator_spec/controller_generator_spec.rb",
-     "spec/generator_spec/helper_generator_spec.rb",
-     "spec/generator_spec/migration_generator_spec.rb",
-     "spec/generator_spec/model_generator_spec.rb",
-     "spec/generator_spec/observer_generator_spec.rb",
-     "spec/generator_spec/view_generator_spec.rb",
+    "spec/generator_spec/generators/controller_generator_spec.rb",
+     "spec/generator_spec/generators/helper_generator_spec.rb",
+     "spec/generator_spec/generators/migration_generator_spec.rb",
+     "spec/generator_spec/generators/model_generator_spec.rb",
+     "spec/generator_spec/generators/observer_generator_spec.rb",
+     "spec/generator_spec/generators/view_generator_spec.rb",
+     "spec/generator_spec/matchers/content/class_self_spec.rb",
+     "spec/generator_spec/matchers/content/have_block_spec.rb",
+     "spec/generator_spec/matchers/content/have_call_spec.rb",
+     "spec/generator_spec/matchers/content/have_calls_spec.rb",
+     "spec/generator_spec/matchers/content/have_class_spec.rb",
+     "spec/generator_spec/matchers/content/have_method_spec.rb",
+     "spec/generator_spec/matchers/content/have_module_spec.rb",
+     "spec/generator_spec/matchers/content/have_region_spec.rb",
+     "spec/generator_spec/matchers/content/have_subclass_spec.rb",
+     "spec/generator_spec/matchers/content/include_module_spec.rb",
+     "spec/generator_spec/matchers/content/inherit_from_spec.rb",
+     "spec/generator_spec/matchers/file/directory_spec.rb",
+     "spec/generator_spec/matchers/file/file_spec.rb",
+     "spec/generator_spec/matchers/file/migration_spec.rb",
+     "spec/generator_spec/matchers/migration/have_column_spec.rb",
+     "spec/generator_spec/matchers/migration/have_index_spec.rb",
+     "spec/generator_spec/matchers/migration/have_table_spec.rb",
+     "spec/generator_spec/matchers/migration/have_tbl_column_spec.rb",
+     "spec/generator_spec/matchers/migration/have_up_down_spec.rb",
+     "spec/generator_spec/matchers/rails/controller_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/helper_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/mailer_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/model_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/observer_matcher_spec.rb",
+     "spec/generator_spec/matchers/rails/view_matcher_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_app_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_controller_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_helper_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_mailer_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_migration_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_model_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_observer_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_orm_spec.rb",
+     "spec/generator_spec/rails_helpers/rails_view_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/generator_spec/helpers/migration_helper.rb

@@ -53,8 +53,8 @@ module Rails::Generators
       gsub_file reverse_migration_path, /dwn/, 'down'        
     end
 
-    def latest_migration_file
-      self.class.latest_migration_file
+    def latest_migration_file dir, name
+      self.class.latest_migration_file dir, name
     end
     
     def migration(options)

data/lib/generator_spec/main.rb

@@ -3,6 +3,11 @@ module RSpec
   end
 end
 
+module RSpec
+  module Rails
+  end
+end
+
 module Rails
   module Generators
   end

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

@@ -1,10 +1,90 @@
 module RSpec
   class RubyContentMatcher
-    attr_reader :content    
-    
-    def matches?(content)
+    attr_reader :content, :end_option, :alt_end, :content_matches
+
+    def initialize name
+      @end_option = name
+    end
+
+    def index
+      0
+    end
+
+    def indexes
+      nil
+    end
+
+         
+    def matches? content, &block            
       @content = content
-    end    
+      match = is_match? content                                                        
+      content_to_yield = if indexes
+        content_matches[indexes.first] || content_matches[indexes.last]
+      else
+        content_matches[index]
+      end          
+      handle_result(content_to_yield, match, &block)
+    end
+
+    def is_match? content
+      expr = get_expr(content) 
+      match = (content =~ expr)
+      @content_matches = [$1, $2, $3]
+    end
+
+    def handle_result content, match, &block 
+      if block && match && content
+        ruby_content = content.strip.extend(RSpec::RubyContent::Helpers)
+        yield ruby_content        
+      end
+      match
+    end      
+
+    def get_expr content
+      expr = /#{main_expr}#{comment_end}/m            
+      if (content =~ expr).nil?                             
+        /#{main_expr}#{end_expr}/m  
+      else
+        expr  
+      end        
+    end
+
+    Q_ANY_GROUP = '(.*?)'
+    ANY_GROUP = '(.*)'
+        
+    SPACES = '\s+'
+    OPT_SPACES = '\s*'
+    LPAR = '(\()'
+    RPAR = '(\))'  
+    OPT_ARGS = '(\(.+\))?'
+
+    def opt expr
+      "#{expr}?"
+    end
+
+    def args_msg
+      args ? " with arguments #{args}" : ''
+    end      
+
+    def any_args_expr
+      OPT_SPACES + OPT_ARGS
+    end
+
+    def args_expr
+      args ? SPACES + opt(LPAR) + OPT_SPACES + "#{args}" + OPT_SPACES + opt(RPAR) : ''
+    end
+
+    def main_expr
+      raise "Must override main_expr"
+    end
+
+    def end_expr
+      "$"
+    end
+
+    def comment_end 
+      alt_end != nil ? '#' + SPACES + "(#{end_option}|#{alt_end})" : '#' + SPACES + "#{end_option}"
+    end
     
     def failure_message
       debug_content

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

@@ -1,38 +1,41 @@
 module RSpec::RubyContentMatchers
   class HaveBlock < RSpec::RubyContentMatcher
-    attr_reader :name, :args, :block_args
+    attr_reader :name, :args, :block_args, :do_option, :end_option
 
     def initialize(name, options={})
+      super options[:end] || name      
       @name = name.to_s
-      @args = options[:args]
+      @args = options[:args] 
+      @do_option = options[:do].nil? ? true : options[:do]      
       @block_args = options[:block_args]
     end
-
-    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)
-        yield ruby_content 
-      end
-      match_res
-    end          
   
     def failure_message   
       super
-      return "Expected there to be a block #{name} with arguments #{args}, but there wasn't"
+      return "Expected there to be a block #{name}#{args_msg}#{block_args_msg}, but there wasn't"
     end 
     
     def negative_failure_message  
       super
-      return "Did not expect there to be a block #{name} with arguments #{args}, but there was"
+      return "Did not expect there to be a block #{name}#{args_msg}, but there was"
     end               
     
     protected
 
-    def end_expr
-      "(end|# #{name})"
+    def block_args_msg
+      " and block arguments #{block_args}" if block_args
+    end
+    
+    def indexes
+      [0, 2]
+    end
+
+    def main_expr
+      "#{name}" + SPACES + "#{args_expr}#{do_expr}" + ANY_GROUP
+    end
+
+    def do_expr
+      do_option == false ? '' : 'do' + SPACES + "#{block_args_expr}"
     end
 
     def args_expr
@@ -42,14 +45,13 @@ module RSpec::RubyContentMatchers
     def block_args_expr
       block_args ? '\|\s*' + block_args + '\s*\|' : ''
     end    
+
+    def alt_end
+      'do'
+    end
   end
   
   def have_block(name, options={})
     HaveBlock.new(name, options)
   end
-
-  def have_class_self(name, options={})
-    HaveBlock.new('class', :args => '<< self')
-  end
-
 end

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

@@ -7,39 +7,47 @@
 #
 module RSpec::RubyContentMatchers
   class HaveCall < RSpec::RubyContentMatcher
-    attr_reader :method, :args
+    attr_reader :method, :args, :dot
 
-    def initialize(method, args = nil)
+    def initialize(method, args = nil, options = {})
       @method = method.to_s
       @args = args
+      @dot = options[:dot]
     end
 
     def matches?(content)
-      super
-      (content =~ /#{method}#{args_expr}/m) != nil
+      @content = content
+      (content =~ /#{dot_expr}#{method}#{args_expr}/m)
     end          
   
     def failure_message
       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"      
+      "Expected there to be a call to #{method}#{args_msg}, but there wasn't"
     end 
     
     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"
+      "Did not expect there to be a call to #{method}#{args_msg}, but there was"
     end
              
     protected
-    
-    def args_expr
-      args ? "\s+(\()?\s*#{args}\s*(\))?" : ''
-    end      
-               
+
+    def not_def
+      '[^def\s]?\s*'
+    end
+
+    def dot_expr
+      return Regexp.escape(dot) if dot.kind_of?(String)
+      dot == true ? "#{not_def}\." : not_def
+    end
+                   
   end
   
   def have_call(method, args = nil)
     HaveCall.new(method, args)
   end  
+
+  def have_dot_call(method, options = {})
+    HaveCall.new(method, options[:args], :dot => options[:dot] || true)
+  end  
 end

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

@@ -1,42 +1,48 @@
 module RSpec::RubyContentMatchers
-  class HaveCalls < RSpec::RubyContentMatcher
+  class HaveCalls < HaveCall
     attr_reader :calls, :method, :args
 
-    def initialize(calls)
-      @calls = calls
+    def initialize(*calls)
+      case calls.first
+      when Array, Hash
+        @calls = calls.first
+      else    
+        @calls = calls
+      end
     end
 
     def matches?(content)
       super
+      case calls
+      when Array
+        do_list
+      when Hash
+        do_hash
+      end
+    end                              
+    
+    protected
+
+    def do_list
+      calls.each do |method|
+        @method = method.to_s   
+        expr = /#{not_def}#{method}/m
+        return false if (content =~ expr) == nil
+      end
+      true
+    end    
+
+    def do_hash
       calls.each_pair do |method, args|
         @method = method.to_s
         @args = args
-        return false if (content =~ /#{method}\s+#{args_expr}/m) == nil
+        return false if (content =~ /#{not_def}#{method}\s+#{args_expr}/m) == nil
       end
       true
-    end          
-  
-    def failure_message
-      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 
-      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
-             
-    protected
-    
-    def args_expr
-      args ? "(\()?\s*#{args}\s*(\))?" : ''
-    end      
-               
+    end    
   end
   
-  def have_calls(calls)
-    HaveCalls.new(calls)
+  def have_calls(*calls)
+    HaveCalls.new(*calls)
   end  
 end

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

@@ -0,0 +1,40 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveClassSelf < RSpec::RubyContentMatcher
+
+    def initialize
+      @end_option = 'class'
+    end
+  
+    def failure_message
+      super
+      return "Expected there to be a: class << self"
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect there to be a: class << self"
+    end
+
+    protected
+    
+    def main_expr
+      'class\s*<<\s*self' + ANY_GROUP
+    end
+
+    def alt_end
+      'class self'
+    end             
+  end
+
+  def have_class_self
+    HaveClassSelf.new
+  end
+  
+end