rspec-rails 1.3.4 → 2.0.0.a2

data/.gitignore

@@ -1,8 +1,2 @@
-tmtags
-.DS_Store
-.emacs-project
-*~
+tmp
 pkg
-doc
-email.txt
-*.swp

data/README.markdown

@@ -0,0 +1,58 @@
+RSpec-2 for Rails-3
+
+### Backwards compatibility
+
+None. This is a rewrite of the rspec-rails extension designed to work
+with rails-3.x and rspec-2.x. It will not work with older versions of
+either rspec or rails.
+
+### Current state
+
+Currently in super-pre-alpha state - explore at your own risk!
+
+Install:
+
+    git clone git://github.com/rspec/rspec-dev
+    cd rspec-dev
+    rake git:clone
+    rake gem:build
+    rake gem:install
+
+This installs the following gems:
+
+* rspec
+* rspec-core
+* rspec-expectations
+* rspec-mocks
+* rspec-rails
+
+### What works
+
+Currently supported:
+
+* controller specs in spec/controllers
+  * no view isolation yet
+* model specs in spec/models
+* request specs in spec/requests
+  * these wrap rails integration tests
+* rails assertions
+* webrat matchers
+* rails-specific matchers
+  * response.should redirect_to(...)
+    * wraps assert_redirected_to
+    * only works with should (not should_not)
+* generators
+  * borrowed from José Valim's third_rails repo on github
+  * the generators work, but not all the generated specs
+    work yet :(
+
+### Known issues
+
+None (or very little) of the following are supported yet (but will be soon):
+
+* rails-specific matchers
+  * only supports "response.should redirect_to(..)"
+* isolation from views in controller specs
+* view specs
+* helper specs
+* routing specs

data/Rakefile

@@ -1,14 +1,56 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rubygems'
+gem 'jeweler', '>= 1.4.0'
+require 'rake'
+require 'yaml'
 
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__),"..","rspec","lib")))
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__),"lib")))
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__),'lib'))
 
-require 'spec/rails/version'
-require 'spec/rake/spectask'
-require 'cucumber/rake/task'
+require 'rake/rdoctask'
+require 'rspec/rails/version'
 
-Cucumber::Rake::Task.new
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rspec-rails"
+    gem.version = Rspec::Rails::Version::STRING
+    gem.summary = "Rspec-2 for Rails-3"
+    gem.email = "dchelimsky@gmail.com;chad.humphries@gmail.com"
+    gem.homepage = "http://github.com/rspec/rspec-rails"
+    gem.authors = ["David Chelimsky", "Chad Humphries"]
+    gem.add_dependency "rspec", ">= #{Rspec::Rails::Version::STRING}"
+    gem.add_dependency "webrat", "0.7.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
 
-task :default => [:features]
+
+desc 'create app, generate a bunch of stuff, and run rake spec'
+task :create_app do |t|
+  if File.directory?('./tmp/rails')
+    rm_rf "tmp/example_app"
+    ruby "./tmp/rails/railties/bin/rails tmp/example_app --dev -m example_app_template.rb"
+  else
+    puts <<-MESSAGE
+
+You need to install rails in ./tmp/rails before you can run the 
+#{t.name} task:
+  
+  git clone git://github.com/rails/rails tmp/rails
+
+(We'll automate this eventually, but running 'git clone' from rake in this
+project is mysteriously full of fail)
+
+MESSAGE
+  end
+end
+
+desc 'clobber generated files'
+task :clobber do
+  rm_rf "pkg"
+end
+
+task :default => :create_app
 

data/example_app_template.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+require 'rspec/rails/version'
+# This needs to be installed on the system, as well as all of its rspec-2 deps
+# - would be nicer if we could source them from the <repo>/pkg dirs
+gem 'rspec-rails', :version => "'#{Rspec::Rails::Version::STRING}'"
+
+initializer 'generators.rb', <<-CODE
+module ExampleApp
+  class Application < Rails::Application
+    config.generators do |g|
+      g.test_framework   :rspec,
+                         :fixtures => false,
+                         :integration_tool => false,
+                         :routes => true,
+                         :views => false
+   
+      g.integration_tool :rspec
+    end
+  end
+end
+CODE
+
+run('gem bundle')
+
+generate('rspec:install')
+generate('model', 'thing', 'name:string')
+generate('controller', 'widgets', 'index')
+generate('integration_test', 'widgets')
+
+run('rake db:migrate')
+run('rake db:test:prepare')
+run('script/rspec spec')
+run('rake spec')

data/lib/generators/rspec.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/named_base'
+
+module Rspec
+  module Generators
+    class Base < Rails::Generators::NamedBase #:nodoc:
+      def self.source_root
+        @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
+      end
+    end
+  end
+end
+
+module Rails
+  module Generators
+    class GeneratedAttribute #:nodoc:
+      def input_type
+        @input_type ||= if type == :text
+          "textarea"
+        else
+          "input"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/controller/controller_generator.rb

@@ -0,0 +1,26 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    class ControllerGenerator < Base
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+
+      class_option :template_engine, :desc => "Template engine to generate view files"
+
+      def create_controller_files
+        template 'controller_spec.rb',
+                 File.join('spec/controllers', class_path, "#{file_name}_controller_spec.rb")
+      end
+
+      def create_view_files
+        empty_directory File.join("spec", "views", file_path)
+
+        actions.each do |action|
+          @action = action
+          template 'view_spec.rb',
+                   File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/controller/templates/controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe <%= class_name %>Controller do
+
+<% for action in actions -%>
+
+  describe "GET '<%= action %>'" do
+    it "should be successful" do
+      get '<%= action %>'
+      response.should be_success
+    end
+  end
+
+<% end -%>
+end

data/lib/generators/rspec/controller/templates/view_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../../spec_helper')
+
+describe "/<%= file_name %>/<%= @action %>.html.<%= options[:template_engine] %>" do
+  before(:each) do
+    render '<%= file_name %>/<%= @action %>'
+  end
+
+  #Delete this example and add some real ones or delete this file
+  it "should tell you where to find the file" do
+    response.should have_tag('p', %r[Find me in app/views/<%= file_path %>/<%= @action %>])
+  end
+end

data/lib/generators/rspec/helper/helper_generator.rb

@@ -0,0 +1,11 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    class HelperGenerator < Base
+      def create_helper_files
+        template 'helper_spec.rb', File.join('spec/helpers', class_path, "#{file_name}_helper_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/helper/templates/helper_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+# Specs in this file have access to a helper object that includes
+# the <%= class_name %>Helper. For example:
+# 
+# describe <%= class_name %>Helper 
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       helper.concat_strings("this","that").should == "this that"
+#     end
+#   end
+# end
+describe <%= class_name %>Helper do
+end

data/lib/generators/rspec/install/install_generator.rb

@@ -0,0 +1,29 @@
+module Rspec
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      add_shebang_option!
+
+      desc <<DESC
+Description:
+    Copy rspec files to your application.
+DESC
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def copy_lib_files
+        directory 'lib'
+      end
+
+      def copy_script_files
+        directory "script"
+        chmod "script/rspec", 0755, :verbose => false
+      end
+
+      def copy_spec_files
+        directory 'spec'
+      end
+    end
+  end
+end

data/lib/generators/rspec/install/templates/lib/tasks/rspec.rake

@@ -0,0 +1,119 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+rescue MissingSourceFile 
+  module Rspec
+    module Core
+      class RakeTask
+        def initialize(name)
+          task name do
+            # if rspec-rails is a configured gem, this will output helpful material and exit ...
+            require File.expand_path(File.dirname(__FILE__) + "/../../config/environment")
+
+            # ... otherwise, do this:
+            raise <<-MSG
+
+#{"*" * 80}
+*  You are trying to run an rspec rake task defined in
+*  #{__FILE__},
+*  but rspec can not be found in vendor/gems, vendor/plugins or system gems.
+#{"*" * 80}
+MSG
+          end
+        end
+      end
+    end
+  end
+end
+
+Rake.application.instance_variable_get('@tasks').delete('default')
+
+spec_prereq = File.exist?(File.join(Rails.root, 'config', 'database.yml')) ? "db:test:prepare" : :noop
+task :noop do
+end
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+Rspec::Core::RakeTask.new(:spec => spec_prereq)
+
+# namespace :spec do
+  # desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  # Rspec::Core::RakeTask.new(:rcov) do |t|
+    # t.spec_opts = ['--options', "\"#{Rails.root}/spec/spec.opts\""]
+    # t.spec_files = FileList['spec/**/*_spec.rb']
+    # t.rcov = true
+    # t.rcov_opts = lambda do
+      # IO.readlines("#{Rails.root}/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    # end
+  # end
+
+  # desc "Print Rspecdoc for all specs (excluding plugin specs)"
+  # Rspec::Core::RakeTask.new(:doc) do |t|
+    # t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    # t.spec_files = FileList['spec/**/*_spec.rb']
+  # end
+
+  # desc "Print Rspecdoc for all plugin examples"
+  # Rspec::Core::RakeTask.new(:plugin_doc) do |t|
+    # t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    # t.spec_files = FileList['vendor/plugins/**/spec/**/*_spec.rb'].exclude('vendor/plugins/rspec/*')
+  # end
+
+  # [:models, :controllers, :views, :helpers, :lib, :integration].each do |sub|
+    # desc "Run the code examples in spec/#{sub}"
+    # Rspec::Core::RakeTask.new(sub => spec_prereq) do |t|
+      # t.spec_opts = ['--options', "\"#{Rails.root}/spec/spec.opts\""]
+      # t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    # end
+  # end
+
+  # desc "Run the code examples in vendor/plugins (except RRspec's own)"
+  # Rspec::Core::RakeTask.new(:plugins => spec_prereq) do |t|
+    # t.spec_opts = ['--options', "\"#{Rails.root}/spec/spec.opts\""]
+    # t.spec_files = FileList['vendor/plugins/**/spec/**/*_spec.rb'].exclude('vendor/plugins/rspec/*').exclude("vendor/plugins/rspec-rails/*")
+  # end
+
+  # namespace :plugins do
+    # desc "Runs the examples for rspec_on_rails"
+    # Rspec::Core::RakeTask.new(:rspec_on_rails) do |t|
+      # t.spec_opts = ['--options', "\"#{Rails.root}/spec/spec.opts\""]
+      # t.spec_files = FileList['vendor/plugins/rspec-rails/spec/**/*_spec.rb']
+    # end
+  # end
+
+  # task :statsetup do
+    # require 'code_statistics'
+    # ::STATS_DIRECTORIES << %w(Model\ specs spec/models) if File.exist?('spec/models')
+    # ::STATS_DIRECTORIES << %w(View\ specs spec/views) if File.exist?('spec/views')
+    # ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers) if File.exist?('spec/controllers')
+    # ::STATS_DIRECTORIES << %w(Helper\ specs spec/helpers) if File.exist?('spec/helpers')
+    # ::STATS_DIRECTORIES << %w(Library\ specs spec/lib) if File.exist?('spec/lib')
+    # ::STATS_DIRECTORIES << %w(Routing\ specs spec/routing) if File.exist?('spec/routing')
+    # ::STATS_DIRECTORIES << %w(Integration\ specs spec/integration) if File.exist?('spec/integration')
+    # ::CodeStatistics::TEST_TYPES << "Model specs" if File.exist?('spec/models')
+    # ::CodeStatistics::TEST_TYPES << "View specs" if File.exist?('spec/views')
+    # ::CodeStatistics::TEST_TYPES << "Controller specs" if File.exist?('spec/controllers')
+    # ::CodeStatistics::TEST_TYPES << "Helper specs" if File.exist?('spec/helpers')
+    # ::CodeStatistics::TEST_TYPES << "Library specs" if File.exist?('spec/lib')
+    # ::CodeStatistics::TEST_TYPES << "Routing specs" if File.exist?('spec/routing')
+    # ::CodeStatistics::TEST_TYPES << "Integration specs" if File.exist?('spec/integration')
+  # end
+
+  # namespace :db do
+    # namespace :fixtures do
+      # desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y. Load from subdirectory in test/fixtures using FIXTURES_DIR=z."
+      # task :load => :environment do
+        # ActiveRecord::Base.establish_connection(Rails.env)
+        # base_dir = File.join(Rails.root, 'spec', 'fixtures')
+        # fixtures_dir = ENV['FIXTURES_DIR'] ? File.join(base_dir, ENV['FIXTURES_DIR']) : base_dir
+
+        # require 'active_record/fixtures'
+        # (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/).map {|f| File.join(fixtures_dir, f) } : Dir.glob(File.join(fixtures_dir, '*.{yml,csv}'))).each do |fixture_file|
+          # Fixtures.create_fixtures(File.dirname(fixture_file), File.basename(fixture_file, '.*'))
+        # end
+      # end
+    # end
+  # end
+# end

data/lib/generators/rspec/install/templates/script/rspec.tt

@@ -0,0 +1,4 @@
+<%= shebang %>
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rspec/autorun'

data/{generators/rspec/templates → lib/generators/rspec/install/templates/spec}/spec_helper.rb

@@ -1,24 +1,26 @@
 # This file is copied to ~/spec when you run 'ruby script/generate rspec'
 # from the project root directory.
 ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path(File.join(File.dirname(__FILE__),'..','config','environment'))
-require 'spec/autorun'
-require 'spec/rails'
+require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)
+require 'rspec/rails'
 
-# Uncomment the next line to use webrat's matchers
-#require 'webrat/integrations/rspec-rails'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Rspec::Core.configure do |config|
+  # Remove this line if you don't want Rspec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include Rspec::Matchers
 
-Spec::Runner.configure do |config|
   # If you're not using ActiveRecord you should remove these
   # lines, delete config/database.yml and disable :active_record
   # in your config/boot.rb
-  config.use_transactional_fixtures = true
-  config.use_instantiated_fixtures  = false
-  config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
 
   # == Fixtures
   #
@@ -41,7 +43,7 @@ Spec::Runner.configure do |config|
   #
   # == Mock Framework
   #
-  # RSpec uses its own mocking framework by default. If you prefer to
+  # RSpec uses it's own mocking framework by default. If you prefer to
   # use mocha, flexmock or RR, uncomment the appropriate line:
   #
   # config.mock_with :mocha
@@ -50,5 +52,5 @@ Spec::Runner.configure do |config|
   #
   # == Notes
   #
-  # For more information take a look at Spec::Runner::Configuration and Spec::Runner
+  # For more information take a look at Rspec::Core::Configuration
 end