rspec-rails 2.99.0 → 3.1.0

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

@@ -1,7 +1,12 @@
+require "rspec/support"
+require "rspec/core"
+RSpec::Support.require_rspec_core "project_initializer"
+require "rspec/rails/feature_check"
+
 module Rspec
   module Generators
+    # @private
     class InstallGenerator < ::Rails::Generators::Base
-
       desc <<DESC
 Description:
     Copy rspec files to your application.
@@ -11,14 +16,48 @@ DESC
         @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
       end
 
-      def copy_dot_rspec
-        template '.rspec'
+      def copy_spec_files
+        Dir.mktmpdir do |dir|
+          generate_rspec_init dir
+          template File.join(dir, '.rspec'), '.rspec'
+          directory File.join(dir, 'spec'), 'spec'
+        end
+      end
+
+      def copy_rails_files
+        template 'spec/rails_helper.rb'
       end
 
-      def copy_spec_files
-        directory 'spec'
+    private
+
+      def generate_rspec_init(tmpdir)
+        initializer = ::RSpec::Core::ProjectInitializer.new(
+          :destination => tmpdir,
+          :report_stream => StringIO.new
+        )
+        initializer.run
+
+        spec_helper_path = File.join(tmpdir, 'spec', 'spec_helper.rb')
+
+        replace_generator_command(spec_helper_path)
+        remove_warnings_configuration(spec_helper_path)
       end
 
+      def replace_generator_command(spec_helper_path)
+        gsub_file spec_helper_path,
+                  'rspec --init',
+                  'rails generate rspec:install',
+                  :verbose => false
+      end
+
+      def remove_warnings_configuration(spec_helper_path)
+        empty_line = '^\n'
+        comment_line = '^\s*#.+\n'
+        gsub_file spec_helper_path,
+                  /#{empty_line}(#{comment_line})+\s+config\.warnings = true\n/,
+                  '',
+                  :verbose => false
+      end
     end
   end
 end

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

@@ -1,37 +1,38 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
 require File.expand_path("../../config/environment", __FILE__)
 require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end
 # in _spec.rb will both be required and run as specs, causing the specs to be
 # run twice. It is recommended that you do not name files matching this glob to
-# end with _spec.rb. You can configure this pattern with with the --pattern
+# end with _spec.rb. You can configure this pattern with the --pattern
 # option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
-Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-<% if ::Rails::VERSION::STRING >= '4.1' -%>
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+<% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
 # Checks for pending migrations before tests are run.
 # If you are not using ActiveRecord, you can remove this line.
 ActiveRecord::Migration.maintain_test_schema!
 
-<% elsif ::Rails::VERSION::STRING >= '4' -%>
+<% elsif RSpec::Rails::FeatureCheck.can_check_pending_migrations? -%>
 # Checks for pending migrations before tests are run.
 # If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+ActiveRecord::Migration.check_pending!
 
 <% end -%>
 RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
+<% if RSpec::Rails::FeatureCheck.has_active_record? -%>
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
   config.fixture_path = "#{::Rails.root}/spec/fixtures"
 
@@ -40,29 +41,19 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = "random"
-
+<% end -%>
   # RSpec Rails can automatically mix in different behaviours to your tests
   # based on their file location, for example enabling you to call `get` and
   # `post` in specs under `spec/controllers`.
   #
   # You can disable this behaviour by removing the line below, and instead
-  # explictly tag your specs with their type, e.g.:
+  # explicitly tag your specs with their type, e.g.:
   #
-  #     describe UsersController, :type => :controller do
+  #     RSpec.describe UsersController, :type => :controller do
   #       # ...
   #     end
   #
   # The different available types are documented in the features, such as in
-  # https://relishapp.com/rspec/rspec-rails/v/3-0/docs
+  # https://relishapp.com/rspec/rspec-rails/docs
   config.infer_spec_type_from_file_location!
 end

data/lib/generators/rspec/integration/integration_generator.rb

@@ -2,27 +2,16 @@ require 'generators/rspec'
 
 module Rspec
   module Generators
+    # @private
     class IntegrationGenerator < Base
       class_option :request_specs,   :type => :boolean, :default => true,  :desc => "Generate request specs"
-      class_option :webrat,          :type => :boolean, :default => false, :desc => "Use webrat methods/matchers"
-      class_option :webrat_matchers, :type => :boolean, :default => false, :desc => "Use webrat methods/matchers (deprecated - use --webrat)"
 
       def generate_request_spec
         return unless options[:request_specs]
 
-        RSpec.deprecate("the --webrat-matchers option", :replacement => nil) if options[:webrat_matchers]
-        RSpec.deprecate("the --webrat option", :replacement => nil) if options[:webrat]
-
         template 'request_spec.rb',
                  File.join('spec/requests', class_path, "#{table_name}_spec.rb")
       end
-
-    protected
-
-      def webrat?
-        options[:webrat] || options[:webrat_matchers]
-      end
-
     end
   end
 end

data/lib/generators/rspec/integration/templates/request_spec.rb

@@ -1,15 +1,10 @@
-require 'spec_helper'
+require 'rails_helper'
 
-describe "<%= class_name.pluralize %>" do
+RSpec.describe "<%= class_name.pluralize %>", :type => :request do
   describe "GET /<%= table_name %>" do
     it "works! (now write some real specs)" do
-<% if webrat? -%>
-      visit <%= index_helper %>_path
-<% else -%>
-      # Run the generator again with the --webrat flag if you want to use webrat methods/matchers
       get <%= index_helper %>_path
-<% end -%>
-      response.status.should be(200)
+      expect(response).to have_http_status(200)
     end
   end
 end

data/lib/generators/rspec/job/job_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class JobGenerator < Base
+      def create_job_spec
+        template 'job_spec.rb.erb', File.join('spec/jobs', class_path, "#{file_name}_job_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/job/templates/job_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Job, :type => :job do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/mailer/mailer_generator.rb

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

data/lib/generators/rspec/mailer/templates/mailer_spec.rb

@@ -1,19 +1,19 @@
-require "spec_helper"
+require "rails_helper"
 
 <% module_namespacing do -%>
-describe <%= class_name %> do
+RSpec.describe <%= class_name %>, :type => :mailer do
 <% for action in actions -%>
   describe "<%= action %>" do
     let(:mail) { <%= class_name %>.<%= action %> }
 
     it "renders the headers" do
-      mail.subject.should eq(<%= action.to_s.humanize.inspect %>)
-      mail.to.should eq(["to@example.org"])
-      mail.from.should eq(["from@example.com"])
+      expect(mail.subject).to eq(<%= action.to_s.humanize.inspect %>)
+      expect(mail.to).to eq(["to@example.org"])
+      expect(mail.from).to eq(["from@example.com"])
     end
 
     it "renders the body" do
-      mail.body.encoded.should match("Hi")
+      expect(mail.body.encoded).to match("Hi")
     end
   end
 

data/lib/generators/rspec/model/model_generator.rb

@@ -2,20 +2,34 @@ require 'generators/rspec'
 
 module Rspec
   module Generators
+    # @private
     class ModelGenerator < Base
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      argument :attributes,
+               :type => :array,
+               :default => [],
+               :banner => "field:type field:type"
       class_option :fixture, :type => :boolean
 
       def create_model_spec
-        template 'model_spec.rb', File.join('spec/models', class_path, "#{file_name}_spec.rb")
+        template_file = File.join(
+          'spec/models',
+          class_path,
+          "#{file_name}_spec.rb"
+        )
+        template 'model_spec.rb', template_file
       end
 
       hook_for :fixture_replacement
 
       def create_fixture_file
-        if options[:fixture] && options[:fixture_replacement].nil?
-          template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
-        end
+        return unless missing_fixture_replacement?
+        template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
+      end
+
+    private
+
+      def missing_fixture_replacement?
+        options[:fixture] && options[:fixture_replacement].nil?
       end
     end
   end

data/lib/generators/rspec/model/templates/fixtures.yml

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
 <% unless attributes.empty? -%>
 one:

data/lib/generators/rspec/model/templates/model_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% module_namespacing do -%>
-describe <%= class_name %> do
+RSpec.describe <%= class_name %>, :type => :model do
   pending "add some examples to (or delete) #{__FILE__}"
 end
 <% end -%>

data/lib/generators/rspec/observer/observer_generator.rb

@@ -2,6 +2,7 @@ require 'generators/rspec'
 
 module Rspec
   module Generators
+    # @private
     class ObserverGenerator < Base
       def generate_observer_spec
         template 'observer_spec.rb',

data/lib/generators/rspec/observer/templates/observer_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require 'rails_helper'
 
 <% module_namespacing do -%>
-describe <%= class_name %>Observer do
+RSpec.describe <%= class_name %>Observer, :type => :observer do
   pending "add some examples to (or delete) #{__FILE__}"
 end
 <% end -%>

data/lib/generators/rspec/scaffold/scaffold_generator.rb

@@ -3,6 +3,7 @@ require 'rails/generators/resource_helpers'
 
 module Rspec
   module Generators
+    # @private
     class ScaffoldGenerator < Base
       include ::Rails::Generators::ResourceHelpers
       source_paths << File.expand_path("../../helper/templates", __FILE__)
@@ -14,19 +15,18 @@ module Rspec
 
       class_option :controller_specs, :type => :boolean, :default => true,  :desc => "Generate controller specs"
       class_option :view_specs,       :type => :boolean, :default => true,  :desc => "Generate view specs"
-      class_option :webrat,           :type => :boolean, :default => false, :desc => "Use webrat methods/matchers"
-      class_option :webrat_matchers,  :type => :boolean, :default => false, :desc => "Use webrat methods/matchers (deprecated - use --webrat)"
       class_option :helper_specs,     :type => :boolean, :default => true,  :desc => "Generate helper specs"
       class_option :routing_specs,    :type => :boolean, :default => true,  :desc => "Generate routing specs"
 
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        RSpec.deprecate("the --webrat-matchers option", :replacement => nil) if options[:webrat_matchers]
-        RSpec.deprecate("the --webrat option", :replacement => nil) if options[:webrat]
-
-        template 'controller_spec.rb',
-                 File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb")
+        template_file = File.join(
+          'spec/controllers',
+          controller_class_path,
+          "#{controller_file_name}_controller_spec.rb"
+        )
+        template 'controller_spec.rb', template_file
       end
 
       def generate_view_specs
@@ -41,153 +41,126 @@ module Rspec
       def generate_routing_spec
         return unless options[:routing_specs]
 
-        template 'routing_spec.rb',
-          File.join('spec/routing', controller_class_path, "#{controller_file_name}_routing_spec.rb")
+        template_file = File.join(
+          'spec/routing',
+          controller_class_path,
+          "#{controller_file_name}_routing_spec.rb"
+        )
+        template 'routing_spec.rb', template_file
       end
 
       hook_for :integration_tool, :as => :integration
 
-      protected
-
-        def webrat?
-          options[:webrat] || options[:webrat_matchers]
-        end
-
-        def copy_view(view)
-          template "#{view}_spec.rb",
-                   File.join("spec/views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
-        end
-
-        def example_valid_attributes
-          # Only take the first attribute so this hash does not become unweildy and large in the
-          # generated controller spec. It is the responsibility of the user to keep the the valid
-          # attributes method up-to-date as they add validations.
-          @example_valid_attributes ||=
-            if attributes.any?
-              { attributes.first.name => attributes.first.default.to_s }
-            else
-              { }
-            end
-        end
+    protected
 
-        def example_invalid_attributes
-          @example_invalid_attributes ||=
-            if attributes.any?
-              { attributes.first.name => "invalid value" }
-            else
-              { }
-            end
-        end
-
-        def example_params_for_update
-          @example_params_for_update ||=
-            if example_valid_attributes.any?
-              example_valid_attributes
-            else
-              { "these" => "params" }
-            end
-        end
+      def copy_view(view)
+        template "#{view}_spec.rb",
+                 File.join("spec/views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
+      end
 
-        def formatted_hash(hash)
-          formatted = hash.inspect
-          formatted.gsub!("{", "{ ")
-          formatted.gsub!("}", " }")
-          formatted.gsub!("=>", " => ")
-          formatted
-        end
+      def formatted_hash(hash)
+        formatted = hash.inspect
+        formatted.gsub!("{", "{ ")
+        formatted.gsub!("}", " }")
+        formatted.gsub!("=>", " => ")
+        formatted
+      end
 
-        # support for namespaced-resources
-        def ns_file_name
-          ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
-        end
+      # support for namespaced-resources
+      def ns_file_name
+        ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
+      end
 
-        # support for namespaced-resources
-        def ns_table_name
-          ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
-        end
+      # support for namespaced-resources
+      def ns_table_name
+        ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
+      end
 
-        def ns_parts
-          @ns_parts ||= begin
-                          matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
-                          matches ? [matches[1], matches[2]] : []
-                        end
-        end
+      def ns_parts
+        @ns_parts ||= begin
+                        matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
+                        matches ? [matches[1], matches[2]] : []
+                      end
+      end
 
-        # Returns the name of the mock. For example, if the file name is user,
-        # it returns mock_user.
-        #
-        # If a hash is given, it uses the hash key as the ORM method and the
-        # value as response. So, for ActiveRecord and file name "User":
-        #
-        #   mock_file_name(:save => true)
-        #   #=> mock_user(:save => true)
-        #
-        # If another ORM is being used and another method instead of save is
-        # called, it will be the one used.
-        #
-        def mock_file_name(hash=nil)
-          if hash
-            method, and_return = hash.to_a.first
-            method = orm_instance.send(method).split('.').last.gsub(/\(.*?\)/, '')
-            "mock_#{ns_file_name}(:#{method} => #{and_return})"
-          else
-            "mock_#{ns_file_name}"
-          end
+      # Returns the name of the mock. For example, if the file name is user,
+      # it returns mock_user.
+      #
+      # If a hash is given, it uses the hash key as the ORM method and the
+      # value as response. So, for ActiveRecord and file name "User":
+      #
+      #   mock_file_name(:save => true)
+      #   #=> mock_user(:save => true)
+      #
+      # If another ORM is being used and another method instead of save is
+      # called, it will be the one used.
+      #
+      def mock_file_name(hash = nil)
+        if hash
+          method, and_return = hash.to_a.first
+          method = orm_instance.send(method).split('.').last.gsub(/\(.*?\)/, '')
+          "mock_#{ns_file_name}(:#{method} => #{and_return})"
+        else
+          "mock_#{ns_file_name}"
         end
+      end
 
-        # Receives the ORM chain and convert to expects. For ActiveRecord:
-        #
-        #   should! orm_class.find(User, "37")
-        #   #=> User.should_receive(:find).with(37)
-        #
-        # For Datamapper:
-        #
-        #   should! orm_class.find(User, "37")
-        #   #=> User.should_receive(:get).with(37)
-        #
-        def should_receive(chain)
-          stub_or_should_chain(:should_receive, chain)
-        end
+      # Receives the ORM chain and convert to expects. For ActiveRecord:
+      #
+      #   should! orm_class.find(User, "37")
+      #   #=> User.should_receive(:find).with(37)
+      #
+      # For Datamapper:
+      #
+      #   should! orm_class.find(User, "37")
+      #   #=> User.should_receive(:get).with(37)
+      #
+      def should_receive(chain)
+        stub_or_should_chain(:should_receive, chain)
+      end
 
-        # Receives the ORM chain and convert to stub. For ActiveRecord:
-        #
-        #   stub orm_class.find(User, "37")
-        #   #=> User.stub(:find).with(37)
-        #
-        # For Datamapper:
-        #
-        #   stub orm_class.find(User, "37")
-        #   #=> User.stub(:get).with(37)
-        #
-        def stub(chain)
-          stub_or_should_chain(:stub, chain)
-        end
+      # Receives the ORM chain and convert to stub. For ActiveRecord:
+      #
+      #   stub orm_class.find(User, "37")
+      #   #=> User.stub(:find).with(37)
+      #
+      # For Datamapper:
+      #
+      #   stub orm_class.find(User, "37")
+      #   #=> User.stub(:get).with(37)
+      #
+      def stub(chain)
+        stub_or_should_chain(:stub, chain)
+      end
 
-        def stub_or_should_chain(mode, chain)
-          receiver, method = chain.split(".")
-          method.gsub!(/\((.*?)\)/, '')
+      def stub_or_should_chain(mode, chain)
+        receiver, method = chain.split(".")
+        method.gsub!(/\((.*?)\)/, '')
 
-          response = "#{receiver}.#{mode}(:#{method})"
-          response << ".with(#{$1})" unless $1.blank?
-          response
-        end
+        response = "#{receiver}.#{mode}(:#{method})"
+        response << ".with(#{$1})" unless $1.blank?
+        response
+      end
 
-        def value_for(attribute)
-          case attribute.type
-          when :string
-            "#{attribute.name.titleize}".inspect
-          when :integer
-            @attribute_id_map ||= {}
-            @attribute_id_map[attribute] ||= @attribute_id_map.keys.size.next.to_s
-          else
-            attribute.default.inspect
-          end
-        end
+      def value_for(attribute)
+        raw_value_for(attribute).inspect
+      end
 
-        def banner
-          self.class.banner
+      def raw_value_for(attribute)
+        case attribute.type
+        when :string
+          attribute.name.titleize
+        when :integer
+          @attribute_id_map ||= {}
+          @attribute_id_map[attribute] ||= @attribute_id_map.keys.size.next
+        else
+          attribute.default
         end
+      end
 
+      def banner
+        self.class.banner
+      end
     end
   end
 end