rspec-rails 2.8.0.rc1 → 2.8.0.rc2

data/lib/rspec/rails/example/helper_example_group.rb

@@ -1,30 +1,6 @@
 require 'rspec/rails/view_assigns'
 
 module RSpec::Rails
-  # Extends ActionView::TestCase::Behavior
-  #
-  # == Examples
-  #
-  #   describe RoleBasedDisplayHelper do
-  #     describe "display_for" do
-  #       context "given the role of the current user" do
-  #         it "yields to the block" do
-  #           helper.stub(:current_user) { double(:roles => ['admin'] }
-  #           text = helper.display_for('admin') { "this text" }
-  #           text.should eq("this text")
-  #         end
-  #       end
-  #
-  #       context "given a different role that that of the current user" do
-  #         it "renders an empty String" do
-  #           helper.stub(:current_user) { double(:roles => ['manager'] }
-  #           text = helper.display_for('admin') { "this text" }
-  #           text.should eq("")
-  #         end
-  #       end
-  #     end
-  #   end
-  #
   module HelperExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
@@ -32,26 +8,25 @@ module RSpec::Rails
     include RSpec::Rails::ViewAssigns
 
     module ClassMethods
+      # @api private
       def determine_default_helper_class(ignore)
-        describes
+        described_class
       end
     end
 
-    module InstanceMethods
-      # Returns an instance of ActionView::Base with the helper being specified
-      # mixed in, along with any of the built-in rails helpers.
-      def helper
-        _view.tap do |v|
-          v.extend(ApplicationHelper) if defined?(ApplicationHelper)
-          v.assign(view_assigns)
-        end
+    # Returns an instance of ActionView::Base with the helper being specified
+    # mixed in, along with any of the built-in rails helpers.
+    def helper
+      _view.tap do |v|
+        v.extend(ApplicationHelper) if defined?(ApplicationHelper)
+        v.assign(view_assigns)
       end
+    end
 
     private
 
-      def _controller_path
-        example.example_group.describes.to_s.sub(/Helper/,'').underscore
-      end
+    def _controller_path
+      example.example_group.described_class.to_s.sub(/Helper/,'').underscore
     end
 
     included do

data/lib/rspec/rails/example/mailer_example_group.rb

@@ -14,7 +14,7 @@ if defined?(ActionMailer)
 
       module ClassMethods
         def mailer_class
-          describes
+          described_class
         end
       end
     end

data/lib/rspec/rails/example/rails_example_group.rb

@@ -1,9 +1,14 @@
+# Temporary workaround to resolve circular dependency between rspec-rails' spec
+# suite and ammeter.
+require 'rspec/rails/matchers'
+
 module RSpec
   module Rails
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter
       include RSpec::Rails::TestUnitAssertionAdapter
+      include RSpec::Rails::Matchers
     end
   end
 end

data/lib/rspec/rails/example/request_example_group.rb

@@ -1,32 +1,17 @@
 module RSpec::Rails
-  # Extends ActionDispatch::Integration::Runner to work with RSpec.
-  #
-  # == Matchers
-  #
-  # In addition to the stock matchers from rspec-expectations, request
-  # specs add these matchers, which delegate to rails' assertions:
-  #
-  #   response.should render_template(*args)
-  #   => delegates to assert_template(*args)
-  #
-  #   response.should redirect_to(destination)
-  #   => delegates to assert_redirected_to(destination)
   module RequestExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
     include ActionDispatch::Integration::Runner
     include ActionDispatch::Assertions
-
-    module InstanceMethods
-      def app
-        ::Rails.application
-      end
-    end
-
     include RSpec::Rails::Matchers::RedirectTo
     include RSpec::Rails::Matchers::RenderTemplate
     include ActionController::TemplateAssertions
 
+    def app
+      ::Rails.application
+    end
+
     included do
       metadata[:type] = :request
 

data/lib/rspec/rails/example/routing_example_group.rb

@@ -8,16 +8,6 @@ module RSpec::Rails
     include RSpec::Rails::Matchers::RoutingMatchers
     include RSpec::Rails::Matchers::RoutingMatchers::RouteHelpers
 
-    module InstanceMethods
-      attr_reader :routes
-
-      private
-
-      def method_missing(m, *args, &block)
-        routes.url_helpers.respond_to?(m) ? routes.url_helpers.send(m, *args) : super
-      end
-    end
-
     included do
       metadata[:type] = :routing
 
@@ -25,5 +15,13 @@ module RSpec::Rails
         @routes = ::Rails.application.routes
       end
     end
+
+    attr_reader :routes
+
+    private
+
+    def method_missing(m, *args, &block)
+      routes.url_helpers.respond_to?(m) ? routes.url_helpers.send(m, *args) : super
+    end
   end
 end

data/lib/rspec/rails/example/view_example_group.rb

@@ -1,22 +1,6 @@
 require 'rspec/rails/view_assigns'
 
 module RSpec::Rails
-  # Extends ActionView::TestCase::Behavior
-  #
-  # == Examples
-  #
-  #   describe "widgets/index.html.erb" do
-  #     it "renders the @widgets" do
-  #       widgets = [
-  #         stub_model(Widget, :name => "Foo"),
-  #         stub_model(Widget, :name => "Bar")
-  #       ]
-  #       assign(:widgets, widgets)
-  #       render
-  #       rendered.should contain("Foo")
-  #       rendered.should contain("Bar")
-  #     end
-  #   end
   module ViewExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
@@ -39,7 +23,7 @@ module RSpec::Rails
       end
     end
 
-    module InstanceMethods
+    module ExampleMethods
       # @overload render
       # @overload render({:partial => path_to_file})
       # @overload render({:partial => path_to_file}, {... locals ...})
@@ -51,27 +35,27 @@ module RSpec::Rails
       # The only addition is that you can call render with no arguments, and RSpec
       # will pass the top level description to render:
       #
-      #   describe "widgets/new.html.erb" do
-      #     it "shows all the widgets" do
-      #       render # => view.render(:file => "widgets/new.html.erb")
-      #       ...
+      #     describe "widgets/new.html.erb" do
+      #       it "shows all the widgets" do
+      #         render # => view.render(:file => "widgets/new.html.erb")
+      #         # ...
+      #       end
       #     end
-      #   end
       def render(options={}, local_assigns={}, &block)
         options = {:template => _default_file_to_render} if Hash === options and options.empty?
         super(options, local_assigns, &block)
       end
 
-      # The instance of +ActionView::Base+ that is used to render the template.
-      # Use this to stub methods _before_ calling +render+.
+      # The instance of `ActionView::Base` that is used to render the template.
+      # Use this to stub methods _before_ calling `render`.
       #
-      #   describe "widgets/new.html.erb" do
-      #     it "shows all the widgets" do
-      #       view.stub(:foo) { "foo" }
-      #       render
-      #       ...
+      #     describe "widgets/new.html.erb" do
+      #       it "shows all the widgets" do
+      #         view.stub(:foo) { "foo" }
+      #         render
+      #         # ...
+      #       end
       #     end
-      #   end
       def view
         _view
       end
@@ -81,9 +65,9 @@ module RSpec::Rails
       # help isolate view examples from partials rendered by the view template
       # that is the subject of the example.
       #
-      # == Example
+      # @example
       #
-      #   stub_template("widgets/_widget.html.erb" => "This content.")
+      #     stub_template("widgets/_widget.html.erb" => "This content.")
       def stub_template(hash)
         view.view_paths.unshift(ActionView::FixtureResolver.new(hash))
       end
@@ -91,18 +75,18 @@ module RSpec::Rails
       # Provides access to the params hash that will be available within the
       # view:
       #
-      #       params[:foo] = 'bar'
+      #     params[:foo] = 'bar'
       def params
         controller.params
       end
 
-      # @deprecated # use +view+ instead.
+      # @deprecated Use `view` instead.
       def template
         RSpec.deprecate("template","view")
         view
       end
 
-      # @deprecated # use +rendered+ instead.
+      # @deprecated Use `rendered` instead.
       def response
         RSpec.deprecate("response", "rendered")
         rendered
@@ -135,6 +119,8 @@ module RSpec::Rails
     end
 
     included do
+      include ExampleMethods
+
       metadata[:type] = :view
       helper *_default_helpers
 

data/lib/rspec/rails/extensions/active_record/base.rb

@@ -3,12 +3,13 @@ module RSpec
     if defined?(ActiveRecord)
       module Extensions
         module ActiveRecord
-          # Extension to enhance +should have+ on AR Model classes
+          # Extension to enhance `should have` on AR Model classes
           #
-          # == Examples
-          #   ModelClass.should have(:no).records
-          #   ModelClass.should have(1).record
-          #   ModelClass.should have(n).records
+          # @example
+          #
+          #     ModelClass.should have(:no).records
+          #     ModelClass.should have(1).record
+          #     ModelClass.should have(n).records
           def records
             find(:all)
           end
@@ -24,16 +25,18 @@ module RSpec
 end
 
 module ::ActiveModel::Validations
-  # Extension to enhance <tt>should have</tt> on AR Model instances.
-  # Calls model.valid? in order to prepare the object's errors
-  # object.
+  # Extension to enhance `should have` on AR Model instances.  Calls
+  # model.valid? in order to prepare the object's errors object. 
+  #
+  # You can also use this to specify the content of the error messages.
   #
-  # == Examples
+  # @example
   #
-  #   model.should have(:no).errors_on(:attribute)
-  #   model.should have(1).error_on(:attribute)
-  #   model.should have(n).errors_on(:attribute)
+  #     model.should have(:no).errors_on(:attribute)
+  #     model.should have(1).error_on(:attribute)
+  #     model.should have(n).errors_on(:attribute)
   #
+  #     model.errors_on(:attribute).should include("can't be blank")
   def errors_on(attribute)
     self.valid?
     [self.errors[attribute]].flatten.compact

data/lib/rspec/rails/fixture_support.rb

@@ -1,6 +1,6 @@
 module RSpec
   module Rails
-    if defined?(ActiveRecord)
+    if defined?(ActiveRecord::TestFixtures)
       module FixtureSupport
         extend ActiveSupport::Concern
 

data/lib/rspec/rails/matchers/be_a_new.rb

@@ -1,40 +1,73 @@
-RSpec::Matchers.define :be_a_new do |model_klass|
-  match do |actual|
-    actual.is_a?(model_klass) && actual.new_record? && attributes_match?(actual)
-  end
+module RSpec::Rails::Matchers
+  class BeANew
+    include RSpec::Matchers::BaseMatcher
 
-  chain :with do |expected_attributes|
-    attributes.merge!(expected_attributes)
-  end
+    # @api private
+    def matches?(actual)
+      super
+      actual.is_a?(expected) && actual.new_record? && attributes_match?(actual)
+    end
 
-  failure_message_for_should do |actual|
-    [].tap do |message|
-      unless actual.is_a?(model_klass) && actual.new_record? 
-        message << "expected #{actual.inspect} to be a new #{model_klass.inspect}"
-      end
-      unless attributes_match?(actual)
-        if unmatched_attributes.size > 1
-          message << "attributes #{unmatched_attributes.inspect} were not set on #{actual.inspect}"
-        else
-          message << "attribute #{unmatched_attributes.inspect} was not set on #{actual.inspect}"
+    # Use this to specify the specific attributes to match on the new record.
+    #
+    # @example
+    #
+    #     it "assigns a new Thing with the submitted attributes" do
+    #       post :create, :thing => { :name => "Illegal Value" }
+    #       assigns(:thing).should be_a_new(Thing).with(:name => nil)
+    #     end
+    def with(expected_attributes)
+      attributes.merge!(expected_attributes)
+      self
+    end
+
+    # @api private
+    def failure_message_for_should
+      [].tap do |message|
+        unless actual.is_a?(expected) && actual.new_record?
+          message << "expected #{actual.inspect} to be a new #{expected.inspect}"
         end
-      end
-    end.join(' and ')
-  end
+        unless attributes_match?(actual)
+          if unmatched_attributes.size > 1
+            message << "attributes #{unmatched_attributes.inspect} were not set on #{actual.inspect}"
+          else
+            message << "attribute #{unmatched_attributes.inspect} was not set on #{actual.inspect}"
+          end
+        end
+      end.join(' and ')
+    end
 
-  def attributes
-    @attributes ||= {}
-  end
+    private
 
-  def attributes_match?(actual)
-    attributes.stringify_keys.all? do |key, value|
-      actual.attributes[key].eql?(value)
+    def attributes
+      @attributes ||= {}
     end
-  end
 
-  def unmatched_attributes
-    attributes.stringify_keys.reject do |key, value|
-      actual.attributes[key].eql?(value)
+    def attributes_match?(actual)
+      attributes.stringify_keys.all? do |key, value|
+        actual.attributes[key].eql?(value)
+      end
     end
+
+    def unmatched_attributes
+      attributes.stringify_keys.reject do |key, value|
+        actual.attributes[key].eql?(value)
+      end
+    end
+  end
+
+  # Passes if actual is an instance of `model_class` and returns `false` for
+  # `persisted?`. Typically used to specify instance variables assigned to
+  # views by controller actions
+  #
+  # @example
+  #
+  #     get :new
+  #     assigns(:thing).should be_a_new(Thing)
+  #
+  #     post :create, :thing => { :name => "Illegal Value" }
+  #     assigns(:thing).should be_a_new(Thing).with(:name => nil)
+  def be_a_new(model_class)
+    BeANew.new(model_class)
   end
 end

data/lib/rspec/rails/matchers/be_new_record.rb

@@ -1,5 +1,20 @@
-RSpec::Matchers.define :be_new_record do
-  match do |actual|
-    !actual.persisted?
+module RSpec::Rails::Matchers
+  class BeANewRecord
+    include RSpec::Matchers::BaseMatcher
+
+    # @api private
+    def matches?(actual)
+      !actual.persisted?
+    end
+  end
+
+  # Passes if actual returns `false` for `persisted?`.
+  #
+  # @example
+  #
+  #     get :new
+  #     assigns(:thing).should be_new_record
+  def be_new_record
+    BeANewRecord.new
   end
 end