rspec-rails 3.0.0.rc1 → 3.0.0

data/lib/generators/rspec/scaffold/templates/edit_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
-describe "<%= ns_table_name %>/edit", :type => :view do
+RSpec.describe "<%= ns_table_name %>/edit", :type => :view do
   before(:each) do
     @<%= ns_file_name %> = assign(:<%= ns_file_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
 <% output_attributes.each_with_index do |attribute, attribute_index| -%>

data/lib/generators/rspec/scaffold/templates/index_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
-describe "<%= ns_table_name %>/index", :type => :view do
+RSpec.describe "<%= ns_table_name %>/index", :type => :view do
   before(:each) do
     assign(:<%= table_name %>, [
 <% [1,2].each_with_index do |id, model_index| -%>

data/lib/generators/rspec/scaffold/templates/new_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
-describe "<%= ns_table_name %>/new", :type => :view do
+RSpec.describe "<%= ns_table_name %>/new", :type => :view do
   before(:each) do
     assign(:<%= ns_file_name %>, <%= class_name %>.new(<%= '))' if output_attributes.empty? %>
 <% output_attributes.each_with_index do |attribute, attribute_index| -%>

data/lib/generators/rspec/scaffold/templates/routing_spec.rb

@@ -1,7 +1,7 @@
-require "spec_helper"
+require "rails_helper"
 
 <% module_namespacing do -%>
-describe <%= controller_class_name %>Controller, :type => :routing do
+RSpec.describe <%= controller_class_name %>Controller, :type => :routing do
   describe "routing" do
 
 <% unless options[:singleton] -%>

data/lib/generators/rspec/scaffold/templates/show_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% output_attributes = attributes.reject{|attribute| [:datetime, :timestamp, :time, :date].index(attribute.type) } -%>
-describe "<%= ns_table_name %>/show", :type => :view do
+RSpec.describe "<%= ns_table_name %>/show", :type => :view do
   before(:each) do
     @<%= ns_file_name %> = assign(:<%= ns_file_name %>, <%= class_name %>.create!(<%= '))' if output_attributes.empty? %>
 <% output_attributes.each_with_index do |attribute, attribute_index| -%>
@@ -15,7 +15,7 @@ describe "<%= ns_table_name %>/show", :type => :view do
   it "renders attributes in <p>" do
     render
 <% for attribute in output_attributes -%>
-    expect(rendered).to match(/<%= eval(value_for(attribute)) %>/)
+    expect(rendered).to match(/<%= raw_value_for(attribute) %>/)
 <% end -%>
   end
 end

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

@@ -1,5 +1,5 @@
-require 'spec_helper'
+require 'rails_helper'
 
-describe "<%= file_path %>/<%= @action %>", :type => :view do
+RSpec.describe "<%= file_path %>/<%= @action %>", :type => :view do
   pending "add some examples to (or delete) #{__FILE__}"
 end

data/lib/generators/rspec/view/view_generator.rb

@@ -2,6 +2,7 @@ require 'generators/rspec'
 
 module Rspec
   module Generators
+    # @private
     class ViewGenerator < Base
       argument :actions, :type => :array, :default => [], :banner => "action action"
 

data/lib/rspec-rails.rb

@@ -1,5 +1,8 @@
+# Namespace for all core RSpec projects.
 module RSpec
+  # Namespace for rspec-rails code.
   module Rails
+    # Railtie to hook into Rails.
     class Railtie < ::Rails::Railtie
       # Rails-3.0.1 requires config.app_generators instead of 3.0.0's config.generators
       generators = config.respond_to?(:app_generators) ? config.app_generators : config.generators

data/lib/rspec/rails/adapters.rb

@@ -7,6 +7,8 @@ module RSpec
     if ::Rails::VERSION::STRING >= '4.1.0'
       gem 'minitest'
       require 'minitest/assertions'
+      # Constant aliased to either Minitest or TestUnit, depending on what is
+      # loaded.
       Assertions = Minitest::Assertions
     else
       begin
@@ -16,12 +18,13 @@ module RSpec
         require 'rubysl-test-unit' if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
         require 'test/unit/assertions'
       end
+      # Constant aliased to either Minitest or TestUnit, depending on what is
+      # loaded.
       Assertions = Test::Unit::Assertions
     end
 
-    # @api private
+    # @private
     class AssertionDelegator < Module
-      # @api private
       def initialize(*assertion_modules)
         assertion_class = Class.new(SimpleDelegator) do
           include ::RSpec::Rails::Assertions
@@ -30,12 +33,10 @@ module RSpec
         end
 
         super() do
-          # @api private
           define_method :build_assertion_instance do
             assertion_class.new(self)
           end
 
-          # @api private
           def assertion_instance
             @assertion_instance ||= build_assertion_instance
           end
@@ -54,7 +55,7 @@ module RSpec
 
     # Adapts example groups for `Minitest::Test::LifecycleHooks`
     #
-    # @api private
+    # @private
     module MinitestLifecycleAdapter
       extend ActiveSupport::Concern
 
@@ -82,26 +83,22 @@ module RSpec
       end
     end
 
-    # @api private
+    # @private
     module MinitestCounters
-      # @api private
       def assertions
         @assertions ||= 0
       end
 
-      # @api private
       def assertions=(assertions)
         @assertions = assertions
       end
     end
 
-    # @api private
+    # @private
     module SetupAndTeardownAdapter
       extend ActiveSupport::Concern
 
       module ClassMethods
-        # @api private
-        #
         # Wraps `setup` calls from within Rails' testing framework in `before`
         # hooks.
         def setup(*methods)
@@ -123,7 +120,6 @@ module RSpec
         end
       end
 
-      # @api private
       def method_name
         @example
       end
@@ -133,9 +129,8 @@ module RSpec
     module MinitestAssertionAdapter
       extend ActiveSupport::Concern
 
+      # @private
       module ClassMethods
-        # @api private
-        #
         # Returns the names of assertion methods that we want to expose to
         # examples without exposing non-assertion methods in Test::Unit or
         # Minitest.
@@ -144,7 +139,6 @@ module RSpec
             [:build_message]
         end
 
-        # @api private
         def define_assertion_delegators
           assertion_method_names.each do |m|
             define_method(m.to_sym) do |*args, &block|
@@ -154,13 +148,11 @@ module RSpec
         end
       end
 
-      # @api private
       class AssertionDelegator
         include ::RSpec::Rails::Assertions
         include ::RSpec::Rails::MinitestCounters
       end
 
-      # @api private
       def assertion_delegator
         @assertion_delegator ||= AssertionDelegator.new
       end
@@ -173,7 +165,7 @@ module RSpec
     # Backwards compatibility. It's unlikely that anyone is using this
     # constant, but we had forgotten to mark it as `@private` earlier
     #
-    # @api private
+    # @private
     TestUnitAssertionAdapter = MinitestAssertionAdapter
   end
 end

data/lib/rspec/rails/configuration.rb

@@ -1,5 +1,41 @@
 module RSpec
+
   module Rails
+    # Fake class to document RSpec Rails configuration options. In practice,
+    # these are dynamically added to the normal RSpec configuration object.
+    class Configuration
+      # @!method infer_spec_type_from_file_location!
+      # Automatically tag specs in conventional directories with matching `type`
+      # metadata so that they have relevant helpers available to them. See
+      # `RSpec::Rails::DIRECTORY_MAPPINGS` for details on which metadata is
+      # applied to each directory.
+
+      # @!method render_views=(val)
+      #
+      # When set to `true`, controller specs will render the relevant view as
+      # well. Defaults to `false`.
+
+      # @!method render_views(val)
+      # Enables view rendering for controllers specs.
+
+      # @!method render_views?
+      # Reader for currently value of `render_views` setting.
+    end
+
+    # Mappings used by `infer_spec_type_from_file_location!`.
+    #
+    # @api private
+    DIRECTORY_MAPPINGS = {
+      :controller => %w[spec controllers],
+      :helper     => %w[spec helpers],
+      :mailer     => %w[spec mailers],
+      :model      => %w[spec models],
+      :request    => %w[spec (requests|integration|api)],
+      :routing    => %w[spec routing],
+      :view       => %w[spec views],
+      :feature    => %w[spec features]
+    }
+
     # @private
     def self.initialize_configuration(config)
       config.backtrace_exclusion_patterns << /vendor\//
@@ -13,7 +49,7 @@ module RSpec
       config.include RSpec::Rails::ViewExampleGroup,       :type => :view
       config.include RSpec::Rails::FeatureExampleGroup,    :type => :feature
 
-      if defined?(RSpec::Rails::MailerExampleGroup)
+      if defined?(ActionMailer)
         config.include RSpec::Rails::MailerExampleGroup, :type => :mailer
       end
 
@@ -27,11 +63,10 @@ module RSpec
       config.add_setting :global_fixtures
       config.add_setting :fixture_path
 
-      # view rendering settings
       # This allows us to expose `render_views` as a config option even though it
       # breaks the convention of other options by using `render_views` as a
-      # command (i.e. render_views = true), where it would normally be used as a
-      # getter. This makes it easier for rspec-rails users because we use
+      # command (i.e. `render_views = true`), where it would normally be used
+      # as a getter. This makes it easier for rspec-rails users because we use
       # `render_views` directly in example groups, so this aligns the two APIs,
       # but requires this workaround:
       config.add_setting :rendering_views, :default => false
@@ -49,16 +84,7 @@ module RSpec
       end
 
       def config.infer_spec_type_from_file_location!
-        {
-          :controller => %w[spec controllers],
-          :helper     => %w[spec helpers],
-          :mailer     => %w[spec mailers],
-          :model      => %w[spec models],
-          :request    => %w[spec (requests|integration|api)],
-          :routing    => %w[spec routing],
-          :view       => %w[spec views],
-          :feature    => %w[spec features]
-        }.each do |type, dir_parts|
+        DIRECTORY_MAPPINGS.each do |type, dir_parts|
           escaped_path = Regexp.compile(dir_parts.join('[\\\/]') + '[\\\/]')
           define_derived_metadata(:file_path => escaped_path) do |metadata|
             metadata[:type] ||= type

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

@@ -1,4 +1,5 @@
 module RSpec::Rails
+  # Container module for controller spec functionality.
   module ControllerExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
@@ -9,6 +10,7 @@ module RSpec::Rails
     include RSpec::Rails::Matchers::RoutingMatchers
     include RSpec::Rails::AssertionDelegator.new(ActionDispatch::Assertions::RoutingAssertions)
 
+    # Class-level DSL for controller specs.
     module ClassMethods
       # @private
       def controller_class
@@ -20,7 +22,7 @@ module RSpec::Rails
       # `body` in that context. Also sets up implicit routes for this
       # controller, that are separate from those defined in "config/routes.rb".
       #
-      # @note Due to Ruby 1.8 scoping rules in anoymous subclasses, constants
+      # @note Due to Ruby 1.8 scoping rules in anonymous subclasses, constants
       #   defined in `ApplicationController` must be fully qualified (e.g.
       #   `ApplicationController::AccessDenied`) in the block passed to the
       #   `controller` method. Any instance methods, filters, etc, that are
@@ -28,7 +30,6 @@ module RSpec::Rails
       #   within the block.
       #
       # @example
-      #
       #     describe ApplicationController do
       #       controller do
       #         def index
@@ -66,7 +67,7 @@ module RSpec::Rails
             end
           end
         end
-        new_controller_class.class_eval(&body)
+        new_controller_class.class_exec(&body)
         (class << self; self; end).__send__(:define_method, :controller_class) { new_controller_class }
 
         before do
@@ -97,7 +98,6 @@ module RSpec::Rails
       # is most useful when testing Rails engines.
       #
       # @example
-      #
       #     describe MyEngine::PostsController do
       #       routes { MyEngine::Engine.routes }
       #
@@ -112,12 +112,15 @@ module RSpec::Rails
 
     attr_reader :controller, :routes
 
-    # @api private
+    # @private
+    #
+    # RSpec Rails uses this to make Rails routes easily available to specs.
     def routes=(routes)
       @routes = routes
       assertion_instance.instance_variable_set(:@routes, routes)
     end
 
+    # @private
     module BypassRescue
       def rescue_with_handler(exception)
         raise exception
@@ -130,7 +133,6 @@ module RSpec::Rails
     # conditions.
     #
     # @example
-    #
     #     describe ProfilesController do
     #       it "raises a 403 when a non-admin user tries to view another user's profile" do
     #         profile = create_profile

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

@@ -1,8 +1,10 @@
 module RSpec::Rails
+  # Container module for routing spec functionality.
   module FeatureExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
 
+    # Default host to be used in Rails route helpers if none is specified.
     DEFAULT_HOST = "www.example.com"
 
     included do
@@ -17,6 +19,9 @@ module RSpec::Rails
       end
     end
 
+    # Shim to check for presence of Capybara. Will delegate if present, raise
+    # if not. We assume here that in most cases `visit` will be the first
+    # Capybara method called in a spec.
     def visit(*)
       if defined?(super)
         super

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

@@ -1,14 +1,15 @@
 require 'rspec/rails/view_assigns'
 
 module RSpec::Rails
+  # Container module for helper specs.
   module HelperExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
     include ActionView::TestCase::Behavior
     include RSpec::Rails::ViewAssigns
 
+    # @private
     module ClassMethods
-      # @api private
       def determine_default_helper_class(ignore)
         described_class
       end

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

@@ -1,5 +1,15 @@
+module RSpec::Rails
+  # Container module for mailer spec functionality. It is only available if
+  # ActionMailer has been loaded before it.
+  module MailerExampleGroup
+    # This blank module is only necessary for YARD processing. It doesn't
+    # handle the conditional `defined?` check below very well.
+  end
+end
+
 if defined?(ActionMailer)
   module RSpec::Rails
+    # Container module for mailer spec functionality.
     module MailerExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::RailsExampleGroup
@@ -11,7 +21,9 @@ if defined?(ActionMailer)
         options.each { |key, value| default_url_options[key] = value } if options
       end
 
+      # Class-level DSL for mailer specs.
       module ClassMethods
+        # Alias for `described_class`.
         def mailer_class
           described_class
         end

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

@@ -1,4 +1,6 @@
 module RSpec::Rails
+  # Container class for model spec functionality. Does not provide anything
+  # special over the common RailsExampleGroup currently.
   module ModelExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup

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

@@ -4,6 +4,7 @@ require 'rspec/rails/matchers'
 
 module RSpec
   module Rails
+    # Common rails example functionality.
     module RailsExampleGroup
       extend ActiveSupport::Concern
       include RSpec::Rails::SetupAndTeardownAdapter

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

@@ -1,4 +1,5 @@
 module RSpec::Rails
+  # Container class for request spec functionality.
   module RequestExampleGroup
     extend ActiveSupport::Concern
     include RSpec::Rails::RailsExampleGroup
@@ -8,6 +9,7 @@ module RSpec::Rails
     include RSpec::Rails::Matchers::RenderTemplate
     include ActionController::TemplateAssertions
 
+    # Delegates to `Rails.application`.
     def app
       ::Rails.application
     end