Improve example group mixin testing.

myronmarston · myronmarston · commit 2fec9607c297 · 2014-04-21T18:34:48.000-07:00
- Use a shared example group instead of a
  matcher. There are many more aspects to test
  than just one matchers worth.
- Rather than stubbing the metadata, actually
  write out spec files in an appropriate directory.
- Add coverage for `spec/api` mapping to `:request` specs.
diff --git a/spec/rspec/rails/example/controller_example_group_spec.rb b/spec/rspec/rails/example/controller_example_group_spec.rb
@@ -6,8 +6,8 @@ def self.abstract?; false; end
 
 module RSpec::Rails
   describe ControllerExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/controllers/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\controllers\\') }
+    it_behaves_like "an rspec-rails example group mixin", :controller,
+      './spec/controllers/', '.\\spec\\controllers\\'
 
     let(:group) do
       RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/feature_example_group_spec.rb b/spec/rspec/rails/example/feature_example_group_spec.rb
@@ -2,8 +2,8 @@
 
 module RSpec::Rails
   describe FeatureExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/features/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\features\\') }
+    it_behaves_like "an rspec-rails example group mixin", :feature,
+      './spec/features/', '.\\spec\\features\\'
 
     it "adds :type => :feature to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/helper_example_group_spec.rb b/spec/rspec/rails/example/helper_example_group_spec.rb
@@ -5,8 +5,8 @@ module RSpec::Rails
     module ::FoosHelper; end
     subject { HelperExampleGroup }
 
-    it { is_expected.to be_included_in_files_in('./spec/helpers/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\helpers\\') }
+    it_behaves_like "an rspec-rails example group mixin", :helper,
+      './spec/helpers/', '.\\spec\\helpers\\'
 
     it "provides a controller_path based on the helper module's name" do
       example = double
diff --git a/spec/rspec/rails/example/mailer_example_group_spec.rb b/spec/rspec/rails/example/mailer_example_group_spec.rb
@@ -4,12 +4,12 @@ module RSpec::Rails
   describe MailerExampleGroup do
     module ::Rails; end
     before do
-      expect(Rails).to receive_message_chain(:application, :routes, :url_helpers).and_return(Rails)
-      expect(Rails).to receive_message_chain(:configuration, :action_mailer, :default_url_options).and_return({})
+      allow(Rails).to receive_message_chain(:application, :routes, :url_helpers).and_return(Rails)
+      allow(Rails).to receive_message_chain(:configuration, :action_mailer, :default_url_options).and_return({})
     end
 
-    it { is_expected.to be_included_in_files_in('./spec/mailers/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\mailers\\') }
+    it_behaves_like "an rspec-rails example group mixin", :mailer,
+      './spec/mailers/', '.\\spec\\mailers\\'
 
     it "adds :type => :mailer to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/model_example_group_spec.rb b/spec/rspec/rails/example/model_example_group_spec.rb
@@ -2,8 +2,8 @@
 
 module RSpec::Rails
   describe ModelExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/models/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\models\\') }
+    it_behaves_like "an rspec-rails example group mixin", :model,
+      './spec/models/', '.\\spec\\models\\'
 
     it "adds :type => :model to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/request_example_group_spec.rb b/spec/rspec/rails/example/request_example_group_spec.rb
@@ -2,10 +2,10 @@
 
 module RSpec::Rails
   describe RequestExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/requests/') }
-    it { is_expected.to be_included_in_files_in('./spec/integration/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\requests\\') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\integration\\') }
+    it_behaves_like "an rspec-rails example group mixin", :request,
+      './spec/requests/', '.\\spec\\requests\\',
+      './spec/integration/', '.\\spec\\integration\\',
+      './spec/api/', '.\\spec\\api\\'
 
     it "adds :type => :request to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/routing_example_group_spec.rb b/spec/rspec/rails/example/routing_example_group_spec.rb
@@ -2,8 +2,8 @@
 
 module RSpec::Rails
   describe RoutingExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/routing/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\routing\\') }
+    it_behaves_like "an rspec-rails example group mixin", :routing,
+      './spec/routing/', '.\\spec\\routing\\'
 
     it "adds :type => :routing to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/rspec/rails/example/view_example_group_spec.rb b/spec/rspec/rails/example/view_example_group_spec.rb
@@ -2,8 +2,8 @@
 
 module RSpec::Rails
   describe ViewExampleGroup do
-    it { is_expected.to be_included_in_files_in('./spec/views/') }
-    it { is_expected.to be_included_in_files_in('.\\spec\\views\\') }
+    it_behaves_like "an rspec-rails example group mixin", :view,
+      './spec/views/', '.\\spec\\views\\'
 
     it "adds :type => :view to the metadata" do
       group = RSpec::Core::ExampleGroup.describe do
diff --git a/spec/support/helpers.rb b/spec/support/helpers.rb
@@ -1,13 +1,4 @@
 module Helpers
-  def stub_metadata(additional_metadata)
-    stub_metadata = metadata_with(additional_metadata)
-    allow(RSpec::Core::ExampleGroup).to receive(:metadata) { stub_metadata }
-  end
-
-  def metadata_with(additional_metadata)
-    ::RSpec.describe("example group").metadata.merge(additional_metadata)
-  end
-
   def with_isolated_config
     original_config = RSpec.configuration
     RSpec.configuration = RSpec::Core::Configuration.new
diff --git a/spec/support/matchers.rb b/spec/support/matchers.rb
diff --git a/spec/support/shared_examples.rb b/spec/support/shared_examples.rb
@@ -0,0 +1,62 @@
+require 'pathname'
+
+shared_examples_for "an rspec-rails example group mixin" do |type, *paths|
+  let(:mixin) { described_class }
+
+  def define_group_in(path, group_definition)
+    path = Pathname(path)
+    $_new_group = nil
+    begin
+      file = path + "whatever_spec.rb"
+
+      Dir.mktmpdir("rspec-rails-app-root") do |dir|
+        Dir.chdir(dir) do
+          path.mkpath
+          spec_file = File.open(file, "w") do |f|
+            f.write("$_new_group = #{group_definition}")
+          end
+
+          load file
+        end
+      end
+
+      group = $_new_group
+      return group
+    ensure
+      $_new_group = nil
+    end
+  end
+
+  around(:example) do |ex|
+    with_isolated_config(&ex)
+  end
+
+  context 'when `infer_spec_type_from_file_location!` is configured' do
+    before { RSpec.configuration.infer_spec_type_from_file_location! }
+
+    paths.each do |path|
+      context "for an example group defined in a file in the #{path} directory" do
+        it "includes itself in the example group" do
+          group = define_group_in path, "RSpec.describe"
+          expect(group.included_modules).to include(mixin)
+        end
+
+        it "tags groups in that directory with `:type => #{type.inspect}`" do
+          group = define_group_in path, "RSpec.describe"
+          expect(group.metadata).to include(:type => type)
+        end
+
+        it "allows users to override the type" do
+          group = define_group_in path, "RSpec.describe 'group', :type => :other"
+          expect(group.metadata).to include(:type => :other)
+          expect(group.included_modules).not_to include(mixin)
+        end
+      end
+    end
+
+    it "includes itself in example groups tagged with `:type => #{type.inspect}`" do
+      group = define_group_in "spec/other", "RSpec.describe 'group', :type => #{type.inspect}"
+      expect(group.included_modules).to include(mixin)
+    end
+  end
+end
