rspec_for_generators 0.2.1 → 0.3.0

data/README.markdown

@@ -1,65 +1,102 @@
 # RSpec 2 library for specifying and testing generators
 
-RSpec 2 matchers, helpers and various utilities to assist in writing generator specs especially Rails 3 generators.
+This project contains RSpec 2 matchers, helpers and various utilities to assist in writing Rails 3 generator specs.
 
-This project was extracted from my experiments with creating generators for jnunemaker's *Canable*, see [My fork of Canable](http://github.com/kristianmandrup/canable).
+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 :)
 
-I attempted to test the generators I built but I noticed, that the only option I could find, was to use a special Rails TestCase class created for Test-Unit. 
-So I thought I could wrap it to be used with RSpec 2; my BDD testing framework of choice!
+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!
 
 ## Install
 
 <code>gem install rspec_for_generators</code>
 
-To install using edge
+The gem is a jewel (using jeweler), so 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 cool DSL convenience methods. Check out the code!
+The following demonstrates an example usage. There are many more options and DSL convenience methods.
 
-### spec/spec_helper.rb
+### Configuration
 
-<pre>require 'rspec'
+First setup the *spec_helper.rb*. Here is an example configuration.
 
-# The following somewhat ugly 'hack' is currently required for rails_spec_helper.rb to work.
-# It's the relative root for which the Rails mock app is created. 
-# So if it's set to point to the spec folder, then the temporary rails application 
-# will be generated in ../tmp, relative to the folder of this file : File.dirname(__FILE__)
-# Thus in this example the /tmp folder will be in the current project root. 
+<pre># spec/spec_helper.rb
+  
+require 'rspec'
+require 'rspec_for_generators'
 
-# Note: In the near future I will provide a better way to achieve this, by hooking into the Rails 3 loading 
-# behavior as described in a *Rails Dispatch* article by *wycatz* 
+Rails.application.configure do
+  # use default rails tmp dir
+  config.root_dir = TmpRails.root_dir(__FILE__)
+  
+  # or specify custom rails tmp dir  
+  # config.root_dir = TmpRails.root_dir(File.dirname(__FILE__) + '/../tmp', :custom)
+end
 
-module Rails
-  def config_root_dir
-    File.dirname(__FILE__)
-  end
-end    
+# configure it!
+RSpec::Generator.configure!
+</pre>
 
-# load this rspec toolbox to help spec generators
-require 'rspec_for_generators'</pre>
+### Specs for generators
 
-### spec/generators/canable.rb
+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.
+
+<pre>require_generator :canable</pre>
+
+This will load the generator : `generators/canabale_generator.rb`
+
+If the generator is namespaced, use a nested approach like so:
 
-Convenience way to define which generators to require 
-  
 <pre>require_generators :canable => ['model', 'user']</pre>
 
-### spec/generators/model_generator_spec.rb
+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:
+  
+<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 of full generator spec
+
+<pre># spec/generators/model_generator_spec.rb  
 
-<pre>require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 # list of generators to spec are loaded
 require 'generators/canable'
 
 describe 'model_generator' do
-  # include Rails model helpers for AciveRecord
-  # also available are: MongoMapper, Mongoid and DataMapper    
-  # mongo_mapper, :data_mapper, :mongoid
+  # include Rails model helpers for ActiveRecord
+  # available: MongoMapper, Mongoid and DataMapper
   
-  model_helper_for :active_record
+  include RSpec::Rails::Orm::ActiveRecord
   
   before :each do              
     # define generator to test
@@ -89,7 +126,7 @@ describe 'model_generator' do
       create_model name     
       g.run_generator %w{account}
       g.should generate_file name, :model do |content|
-        content.should have_class name.camelize do |klass|
+        content.should have_class name do |klass|
           klass.should include_module 'Canable::Ables'
         end
       end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/generators/demo/demo_generator.rb

@@ -37,7 +37,7 @@ class DemoGenerator < Rails::Generators::Base
   end
 
   def model_class_name
-    name.camelize
+    name.to_s.camelize
   end
                      
   def model_file_name

data/lib/rspec_for_generators/fixtures/routes.rb

@@ -1,2 +1,2 @@
-TestApp.routes.draw do |map|
+Rails.application.routes.draw do |map|
 end

data/lib/rspec_for_generators/generator_spec_helper.rb

@@ -8,8 +8,6 @@ require 'rspec_for_generators/rails_spec_helper'
 # Call configure to load the settings from
 # Rails.application.config.generators to Rails::Generators
 
-Rails::Generators.configure!
-
 # require the generators
 def require_generators *generator_list
   generator_list.each do |name, generators|    
@@ -21,13 +19,29 @@ def require_generators *generator_list
       end    
     end
   end
-end
+end  
+alias :require_generator :require_generators
 
 module RSpec    
   module Generator
     class << self  
       attr_accessor :generator, :test_method_name
 
+      def remove_rails_dir!
+        FileUtils.rm_rf ::TmpRails.root
+      end
+
+      def configure!
+        ::RSpec::Generators::TestCase.destination ::Rails.root      
+        ::Rails::Generators.configure! 
+        
+        ::RSpec.configure do |config|
+          config.after(:suite) do
+            ::RSpec::Generator.remove_rails_dir!
+          end
+        end        
+      end
+
       def run_generator *args, &block
         generator.run_generator *args
         if block

data/lib/rspec_for_generators/matchers/content/have_class.rb

@@ -5,7 +5,7 @@ module RSpec
       attr_reader :klass
 
       def initialize(klass)
-        @klass = klass      
+        @klass = klass.to_s.camelize      
       end
 
       def matches?(content)      

data/lib/rspec_for_generators/matchers/content/have_method.rb

@@ -13,7 +13,7 @@ module RSpec
 
       def initialize(method, type)
         @type = type
-        @method = method
+        @method = method.to_s
       end
 
       def matches?(content)      

data/lib/rspec_for_generators/matchers/content/have_module.rb

@@ -9,7 +9,7 @@ module RSpec
       end
 
       def matches?(module_name)      
-        @module_name = module_name
+        @module_name = module_name.to_s.camelize
         @content =~ /module\s+#{@module_name}\s+(.*)end/m
         if block_given?
           ruby_content = $2.strip.extend(RSpec::RubyContent::Helpers)

data/lib/rspec_for_generators/matchers/content/include_module.rb

@@ -5,7 +5,7 @@ module RSpec
       attr_reader :module_name
 
       def initialize module_name
-        @module_name = module_name
+        @module_name = module_name.to_s.camelize
       end
 
       def matches?(content)      

data/lib/rspec_for_generators/matchers/content/inherit_from.rb

@@ -5,7 +5,7 @@ module RSpec
       attr_reader :klass
 
       def initialize(content)
-        @klass = klass
+        @klass = klass.to_s.camelize
       end
 
       def matches?(content)      

data/lib/rspec_for_generators/matchers/helpers/file.rb

@@ -15,7 +15,7 @@ module RSpec
 
       def check_model(name, clazz, options = {})
         self.should generate_file("#{name.underscore}.rb", :model) do |file_content|
-          file_content.should have_class clazz.camelize do |content|
+          file_content.should have_class clazz do |content|
             check_matchings options[:matchings]    
             check_methods(options[:methods])
             check_class_methods(options[:class_methods])

data/lib/rspec_for_generators/rails_helpers/all.rb

@@ -1,5 +1,5 @@
 require 'rspec_for_generators/rails_helpers/rails_app'
-require 'rspec_for_generators/rails_helpers/rails_model'
+require 'rspec_for_generators/rails_helpers/rails_orm'
 require 'rspec_for_generators/rails_helpers/rails_controller'
 require 'rspec_for_generators/rails_helpers/rails_helper'
 require 'rspec_for_generators/rails_helpers/rails_view'

data/lib/rspec_for_generators/rails_helpers/rails_controller.rb

@@ -12,7 +12,7 @@ module RSpec
       end  
 
       def controller_content name
-        %Q{class #{name.camelize}Controller < ActionController::Base
+        %Q{class #{name.to_s.camelize}Controller < ActionController::Base
         end}        
       end
 

data/lib/rspec_for_generators/rails_helpers/rails_helper.rb

@@ -12,7 +12,7 @@ module RSpec
       end  
 
       def helper_content name
-        %Q{class #{name.camelize}Helper
+        %Q{class #{name.to_s.camelize}Helper
         end}        
       end
 

data/lib/rspec_for_generators/rails_helpers/rails_model.rb

@@ -1,94 +1,29 @@
-module RSpec  
-  module Rails
-    module Model
-      module ActiveRecord
-        def file_content name
-          %Q{class #{name.camelize} < ActiveRecord::Base
-          end}
-        end
-      end
-
-      module MongoMapper
-        def file_content name
-          %Q{class #{name.camelize}
-            include MongoMapper::Document
-          end}
-        end
-        
-        def field name, type = nil
-          return "key :#{name}, #{type}" if type
-          "key :#{name}"
-        end
-      end
-
-      module Mongoid
-        def file_content name
-          %Q{class #{name.camelize}
-            include Mongoid::Document
-          end}
-        end
-        
-        def field name, type = nil
-          return "field :#{name}, :type => #{type}" if type
-          "field :#{name}"
-        end        
-      end
-
-      module DataMapper
-        def file_content name
-          %Q{class #{name.camelize}
-            include DataMapper::Resource
-          end}
-        end
-        
-        def field name, type = nil
-          return "property :#{name}, #{type}" if type
-          "property :#{name}"
-        end        
-      end
-
-      def set_orm orm
-        orm_module = case orm
-        when :active_record
-          ActiveRecord
-        when :data_mapper
-          DataMapper
-        when :mongo_mapper
-          MongoMapper
-        when :mongoid
-          Mongoid
-        end
-        include orm_module
-      end
+module RSpec::Rails
+  module Model    
+    def create_model name, &block
+      puts "create_model: #{name}"
       
-      def create_model name, &block
-        file =  model_file_name(name)
-        unless File.exist?(file)    
-          FileUtils.mkdir_p File.dirname(file)
-          File.open(file, 'w') do |f|  
-            f.puts file_content(name)
-            yield f if block_given?
-          end
+      file = model_file_name(name)
+      unless File.exist?(file)    
+        FileUtils.mkdir_p File.dirname(file)
+        File.open(file, 'w') do |f|  
+          f.puts file_content(name)
+          yield f if block_given?
         end
-      end  
-
-      def remove_model name
-        file = model_file_name(name)
-        FileUtils.rm_f(file) if File.exist?(file)
       end
+    end  
 
-      def remove_models *names
-        names.each{|name| remove_model name }
-      end      
-      
-      def model_file_name name
-        File.join(::Rails.root, "app/models/#{name}.rb")
-      end        
+    def remove_model name
+      file = model_file_name(name)
+      FileUtils.rm_f(file) if File.exist?(file)
     end
-  end
-end
 
-def model_helper_for orm
-  include RSpec::Rails::Model
-  set_orm orm
+    def remove_models *names
+      names.each{|name| remove_model name }
+    end      
+    
+    def model_file_name name
+      File.join(::Rails.root, "app/models/#{name}.rb")
+    end        
+  end
 end

data/lib/rspec_for_generators/rails_helpers/rails_orm.rb

@@ -0,0 +1,77 @@
+require 'rspec_for_generators/rails_helpers/rails_model'
+
+module RSpec::Rails
+  module Orm
+    module Base
+      include RSpec::Rails::Model
+
+      protected
+
+      def clazz name             
+        "class #{name.to_s.camelize}"
+      end
+    
+      def file name
+        %Q{#{clazz name}
+          #{yield if block_given?}
+        end}
+      end
+
+      def file_w_include name
+        file name { "include #{yield}" if block_given?}
+      end
+
+      def file_w_inherit name
+        %Q{#{clazz name} < #{yield if block_given?}
+        end}
+      end
+    end
+  
+    module ActiveRecord  
+      include RSpec::Rails::Orm::Base  
+
+      def file_content(name)
+        file_w_inherit(name) {'ActiveRecord::Base'}
+      end
+    end
+
+    module MongoMapper
+       include RSpec::Rails::Orm::Base  
+    
+      def file_content name
+        file_w_include(name) { 'MongoMapper::Document' }
+      end
+  
+      def field name, type = nil
+        return "key :#{name}, #{type}" if type
+        "key :#{name}"
+      end
+    end
+
+    module Mongoid
+      include RSpec::Rails::Orm::Base
+        
+      def file_content name
+        file_w_include(name) { 'Mongoid::Document' }
+      end
+  
+      def field name, type = nil
+        return "field :#{name}, :type => #{type}" if type
+        "field :#{name}"
+      end        
+    end
+
+    module DataMapper
+      include RSpec::Rails::Orm::Base
+        
+      def file_content name
+        file_w_include(name) { 'DataMapper::Resource' }
+      end
+  
+      def field name, type = nil
+        return "property :#{name}, #{type}" if type
+        "property :#{name}"
+      end        
+    end
+  end
+end

data/lib/rspec_for_generators/rails_spec_helper.rb

@@ -1,17 +1,35 @@
 require 'rspec_for_generators/rails_helpers/all'
 
-class TestApp < Rails::Application
-  raise StandardError, "You must define a location for Rails.config_root_dir" if !Rails.config_root_dir
-  config.root = Rails.config_root_dir
-end
+module TmpRails
+  class << self    
+    attr_accessor :root
+    
+    def root_dir path, options = {}
+      @root = options == :custom ? custom_root_dir(path) : default_root_dir(path)      
+    end
+
+    protected
+
+    def default_root_dir path
+      File.expand_path(File.join(File.dirname(path), '..', 'tmp'))      
+    end
 
+    def custom_root_dir path
+      File.expand_path(path)
+    end
+  end
+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'))
+    # 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
 
+class TestApp < Rails::Application
+end
+
 Rails.application = TestApp
-Rails.application.config.root = Rails.root
 

data/lib/rspec_for_generators/rspec_test_case.rb

@@ -3,7 +3,7 @@ module RSpec
     class TestCase < ::Rails::Generators::TestCase   
       setup :prepare_destination
       # setup :copy_routes
-      destination File.join(::Rails.root)      
+      
             
       def initialize(test_method_name)
         @method_name = test_method_name

data/rspec_for_generators.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rspec_for_generators}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-08-03}
+  s.date = %q{2010-08-04}
   s.description = %q{RSpec 2 matchers, helpers and utils to assist in writing generator specs}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
      "lib/rspec_for_generators/rails_helpers/rails_helper.rb",
      "lib/rspec_for_generators/rails_helpers/rails_mailer.rb",
      "lib/rspec_for_generators/rails_helpers/rails_model.rb",
+     "lib/rspec_for_generators/rails_helpers/rails_orm.rb",
      "lib/rspec_for_generators/rails_helpers/rails_view.rb",
      "lib/rspec_for_generators/rails_spec_helper.rb",
      "lib/rspec_for_generators/rspec_test_case.rb",
@@ -52,7 +53,6 @@ Gem::Specification.new do |s|
      "spec/rspec_for_generators/rspec_for_generators_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "tmp/rails/config/routes.rb",
      "wiki/Custom Rails 3 Generators.textile"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/rspec_for_generators}

data/spec/rspec_for_generators/rspec_for_generators_spec.rb

@@ -1,9 +1,8 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require_generators :demo
+require_generator :demo
 
 describe 'model_generator' do
-  include RSpec::Rails::Model
-  include RSpec::Rails::Model::ActiveRecord
+  include RSpec::Rails::Orm::ActiveRecord
   
   before :each do              
     RSpec::Generator.setup_generator 'model_generator' do
@@ -30,7 +29,7 @@ describe 'model_generator' do
       create_model name     
       g.run_generator %w{account}
       g.should generate_file name, :model do |content|
-        content.should have_class name.camelize do |klass|
+        content.should have_class name do |klass|
           klass.should include_module 'Canable::Ables'
         end
       end

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'rspec'
 require 'rspec/autorun'     
+require 'rspec_for_generators'
 
-module Rails
-  def self.config_root_dir
-    File.dirname(__FILE__)
-  end
+Rails.application.configure do
+  # config.root_dir = TmpRails.root_dir(__FILE__)
+  config.root_dir = TmpRails.root_dir(File.dirname(__FILE__) + '/../tmp', :custom)
 end
 
-require 'rspec_for_generators'
+RSpec::Generator.configure!
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 +02:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -149,6 +149,7 @@ files:
 - lib/rspec_for_generators/rails_helpers/rails_helper.rb
 - lib/rspec_for_generators/rails_helpers/rails_mailer.rb
 - lib/rspec_for_generators/rails_helpers/rails_model.rb
+- lib/rspec_for_generators/rails_helpers/rails_orm.rb
 - lib/rspec_for_generators/rails_helpers/rails_view.rb
 - lib/rspec_for_generators/rails_spec_helper.rb
 - lib/rspec_for_generators/rspec_test_case.rb
@@ -156,7 +157,6 @@ files:
 - spec/rspec_for_generators/rspec_for_generators_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tmp/rails/config/routes.rb
 - wiki/Custom Rails 3 Generators.textile
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/rspec_for_generators

data/tmp/rails/config/routes.rb

@@ -1,2 +0,0 @@
-TestApp.routes.draw do |map|
-end