rspec-rails 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 531ee4388e3473684c081da49e38e0254cc1503a
-  data.tar.gz: a24b272abedc01e713c31c991473bf8b290dec87
+  metadata.gz: e7082373e70e8e1b7a77e4a29acde414d3a0f88d
+  data.tar.gz: 0a6fd867ecf7f7d201e2b6f8d3ebaaef7357b6bd
 SHA512:
-  metadata.gz: 626e65139ca363cff2f5c770cd2eee8d2b4c45923a9f06ca56bf25010b55fba93f6d650a5c4092549dbef17943230e65e2aeb60b8c250ce9b2da77febb9c0fc2
-  data.tar.gz: 50b67c8d265abe9a766d50df2d0780febd6910f9ff3aef9a74aed19de6ae37c6a0ceee306851c2ca5129c1ae355e44e72283db60959bd2e4481e6a31d6786ba6
+  metadata.gz: edae3eef56dee24c9ef3b6aa78e971ac353c83058a38a9bbc05efb7da6cd8ed00b89f4add64f54c5d606cf88b4df8ba0846d9315f966b4dc0709583bf51b1b50
+  data.tar.gz: ac61c06796d8788ba676bb95d1ee3551b727e4757e1b78c2bbecfdba86551fb4bfbc9d141c594f42a03ed6c8008009dea09237ea1ba2b75d3440a809ad2256c6

data/Changelog.md

@@ -1,3 +1,20 @@
+### 3.1.0 / 2014-09-04
+[Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.0.2...v3.1.0)
+
+Enhancements:
+
+* Switch to using the `have_http_status` matcher in spec generators. (Aaron Kromer, #1086)
+* Update `rails_helper` generator to allow users to opt-in to auto-loading
+  `spec/support` files instead of forcing it upon them. (Aaron Kromer, #1137)
+* Include generator for `ActiveJob`. (Abdelkader Boudih, #1155)
+* Improve support for non-ActiveRecord apps by not loading ActiveRecord related
+  settings in the generated `rails_helper`. (Aaron Kromer, #1150)
+* Remove Ruby warnings as a suggested configuration. (Aaron Kromer, #1163)
+
+Bug Fixes:
+
+* Fix controller route lookup for Rails 4.2. (Tomohiro Hashidate, #1142)
+
 ### 3.0.2 / 2014-07-21
 [Full Changelog](http://github.com/rspec/rspec-rails/compare/v3.0.1...v3.0.2)
 

data/README.md

@@ -102,7 +102,7 @@ Use model specs to describe behavior of models (usually ActiveRecord-based) in
 the application.
 
 Model specs default to residing in the `spec/models` folder. Tagging any
-context with the metadata `:type => :model` treats it's examples as model
+context with the metadata `:type => :model` treats its examples as model
 specs.
 
 For example:
@@ -128,7 +128,7 @@ specs](https://www.relishapp.com/rspec/rspec-rails/docs/model-specs).
 Use controller specs to describe behavior of Rails controllers.
 
 Controller specs default to residing in the `spec/controllers` folder. Tagging
-any context with the metadata `:type => :controller` treats it's examples as
+any context with the metadata `:type => :controller` treats its examples as
 controller specs.
 
 For example:
@@ -177,7 +177,7 @@ end using a black box approach.
 
 Request specs default to residing in the `spec/requests`, `spec/api`, and
 `spec/integration` directories. Tagging any context with the metadata `:type =>
-:request` treats it's examples as request specs.
+:request` treats its examples as request specs.
 
 Request specs mix in behavior from
 [ActionDispatch::Integration::Runner](http://api.rubyonrails.org/classes/ActionDispatch/Integration/Runner.html),
@@ -247,7 +247,7 @@ Feature specs test your application from the outside by simulating a browser.
 simulated browser.
 
 Feature specs default to residing in the `spec/features` folder. Tagging any
-context with the metadata `:type => :feature` treats it's examples as feature
+context with the metadata `:type => :feature` treats its examples as feature
 specs.
 
 Feature specs mix in functionality from the capybara gem, thus they require
@@ -263,7 +263,7 @@ specs](https://www.relishapp.com/rspec/rspec-rails/v/3-0/docs/feature-specs/feat
 ## View specs
 
 View specs default to residing in the `spec/views` folder. Tagging any context
-with the metadata `:type => :view` treats it's examples as view specs.
+with the metadata `:type => :view` treats its examples as view specs.
 
 View specs mix in `ActionView::TestCase::Behavior`.
 
@@ -370,7 +370,7 @@ expect(rendered).to xxx
 ## Routing specs
 
 Routing specs default to residing in the `spec/routing` folder. Tagging any
-context with the metadata `:type => :routing` treats it's examples as routing
+context with the metadata `:type => :routing` treats its examples as routing
 specs.
 
 ```ruby
@@ -399,7 +399,7 @@ instead.
 ## Helper specs
 
 Helper specs default to residing in the `spec/helpers` folder. Tagging any
-context with the metadata `:type => :helper` treats it's examples as helper
+context with the metadata `:type => :helper` treats its examples as helper
 specs.
 
 Helper specs mix in ActionView::TestCase::Behavior. A `helper` object is

data/lib/generators/rspec.rb

@@ -7,8 +7,12 @@ module Rspec
   module Generators
     # @private
     class Base < ::Rails::Generators::NamedBase
-      def self.source_root
-        @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
+      def self.source_root(path = nil)
+        if path
+          @_rspec_source_root = path
+        else
+          @_rspec_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'rspec', generator_name, 'templates'))
+        end
       end
 
       if ::Rails::VERSION::STRING < '3.1'
@@ -27,10 +31,10 @@ module Rails
     class GeneratedAttribute
       def input_type
         @input_type ||= if type == :text
-          "textarea"
-        else
-          "input"
-        end
+                          "textarea"
+                        else
+                          "input"
+                        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ RSpec.describe <%= class_name %>Controller, :type => :controller do
   describe "GET <%= action %>" do
     it "returns http success" do
       get :<%= action %>
-      expect(response).to be_success
+      expect(response).to have_http_status(:success)
     end
   end
 

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

@@ -1,12 +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.
@@ -36,11 +36,28 @@ DESC
           :report_stream => StringIO.new
         )
         initializer.run
-        gsub_file File.join(tmpdir, 'spec', 'spec_helper.rb'),
+
+        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/rails_helper.rb

@@ -3,6 +3,7 @@ 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
@@ -11,20 +12,27 @@ require 'rspec/rails'
 # 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 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 }
+#
+# 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 ::Rails::VERSION::STRING >= '4.1' -%>
+<% 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|
+<% 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"
 
@@ -33,6 +41,7 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
+<% 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`.

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

@@ -4,7 +4,7 @@ RSpec.describe "<%= class_name.pluralize %>", :type => :request do
   describe "GET /<%= table_name %>" do
     it "works! (now write some real specs)" do
       get <%= index_helper %>_path
-      expect(response.status).to 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/model/model_generator.rb

@@ -4,19 +4,32 @@ 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/scaffold/scaffold_generator.rb

@@ -21,8 +21,12 @@ module Rspec
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        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
@@ -37,123 +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
+    protected
 
-        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 copy_view(view)
+        template "#{view}_spec.rb",
+                 File.join("spec/views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
+      end
 
-        # support for namespaced-resources
-        def ns_file_name
-          ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
-        end
+      def formatted_hash(hash)
+        formatted = hash.inspect
+        formatted.gsub!("{", "{ ")
+        formatted.gsub!("}", " }")
+        formatted.gsub!("=>", " => ")
+        formatted
+      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_file_name
+        ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
+      end
 
-        def ns_parts
-          @ns_parts ||= begin
-                          matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
-                          matches ? [matches[1], matches[2]] : []
-                        end
-        end
+      # support for namespaced-resources
+      def ns_table_name
+        ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
+      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
+      def ns_parts
+        @ns_parts ||= begin
+                        matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
+                        matches ? [matches[1], matches[2]] : []
+                      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)
+      # 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 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 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
 
-        def stub_or_should_chain(mode, chain)
-          receiver, method = chain.split(".")
-          method.gsub!(/\((.*?)\)/, '')
+      # 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
 
-          response = "#{receiver}.#{mode}(:#{method})"
-          response << ".with(#{$1})" unless $1.blank?
-          response
-        end
+      def stub_or_should_chain(mode, chain)
+        receiver, method = chain.split(".")
+        method.gsub!(/\((.*?)\)/, '')
 
-        def value_for(attribute)
-          raw_value_for(attribute).inspect
-        end
+        response = "#{receiver}.#{mode}(:#{method})"
+        response << ".with(#{$1})" unless $1.blank?
+        response
+      end
 
-        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 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