Extract matchers to base class and subclasses

Author: avit

lib/rspec-rails-caching.rb

@@ -9,7 +9,6 @@ module RSpecRailsCaching
   end
 
   RSpec.configure do |config|
-    config.alias_it_should_behave_like_to :with_configuration, "with"
     config.before(:all, :type => :controller, :caching => true) do |example|
       silence_warnings do
         @_orig_cache_store = RAILS_CACHE
@@ -22,10 +21,13 @@ module RSpecRailsCaching
       # The controller needs to be reloaded to metaprogram the caches_page
       # callback with the perform_caching option turned on. There is no
       # reloading if the example controller isn't in the load paths, likely
-      # because it was defined inline in the spec.
+      # because it was defined inline in the spec or an AnonymousController.
       if ctrl_class_file =
         ActiveSupport::Dependencies.search_for_file(example.class.controller_class.to_s.underscore)
         then
+        # FIXME: the controller's cache_page callbacks don't get triggered
+        # when the test suite runs an outer example group (without caching:
+        # true), but individual examples will pass.
         ActiveSupport::Dependencies.load(ctrl_class_file)
       end
 
@@ -35,18 +37,13 @@ module RSpecRailsCaching
       end
     end
 
-    config.after(:all) do |example|
+    config.after(:all, :type => :controller, :caching => true) do |example|
       silence_warnings do
         Object.const_set "RAILS_CACHE", @_orig_cache_store
       end
       ActionController::Base.cache_store = RAILS_CACHE
       ActionController::Base.perform_caching = false
     end
-
-    config.around(:each, :type => :controller, :caching => true) do |example|
-      # This block does some voodoo to ensure the controller class gets
-      # reloaded in the right context. I don't understand why it's necessary.
-    end
   end
 
 end

lib/rspec-rails-caching/matchers.rb

@@ -1,7 +1,4 @@
-module RSpecRailsCaching
-  module Matchers
-  end
-end
-
+require 'rspec-rails-caching/matchers/cache'
+require 'rspec-rails-caching/matchers/expire'
 require 'rspec-rails-caching/matchers/cache_page'
 require 'rspec-rails-caching/matchers/expire_page'

lib/rspec-rails-caching/matchers/base.rb

@@ -0,0 +1,45 @@
+module RSpecRailsCaching
+  module Matchers
+    extend RSpec::Matchers::DSL
+
+    def self.caching_matcher name, &block
+      matcher name do
+        match do |actual|
+          actual = actual.call if actual.respond_to?(:call)
+          Array(expected).all? { |e| cache_results.include?(e) }
+        end
+
+        description do
+          "#{cache_or_expire} #{expected.inspect}"
+        end
+
+        failure_message_for_should_not do |actual|
+          "Expected #{controller.class} not to #{cache_or_expire} #{expected.inspect} but got #{cache_results.inspect}"
+        end
+
+        failure_message_for_should do |actual|
+          "Expected #{controller.class} to #{cache_or_expire} #{expected.inspect} but got #{cache_results.inspect}"
+        end
+
+        def controller
+          matcher_execution_context.controller
+        end
+
+        def cache_store
+          controller.cache_store
+        end
+
+        def cache_results
+          fail NoMethodError, "Abstract method 'cache_results' to be defined in matcher"
+        end
+
+        def cache_or_expire
+          fail NoMethodError, "Abstract method 'cache_or_expire' to be defined in matcher"
+        end
+
+        instance_eval &block
+
+      end
+    end
+  end
+end

lib/rspec-rails-caching/matchers/cache.rb

@@ -0,0 +1,13 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :cache do
+    def cache_results
+      cache_store.cached
+    end
+  end
+  alias_method :cache_fragment, :cache
+  alias_method :cache_action,   :cache
+
+end

lib/rspec-rails-caching/matchers/cache_page.rb

@@ -1,38 +1,15 @@
-module RSpecRailsCaching::Matchers
-  extend RSpec::Matchers::DSL
-
-  matcher :cache_page do |*expected|
-    match do |actual|
-      actual = actual.call if actual.respond_to?(:call)
-      unless actual.is_a? ActionController::TestResponse
-        raise ArgumentError("cache_page matcher expects a callable Proc or a TestResponse")
-      end
-
-      Array(expected).all? { |e| cache_store.page_cached?(e) }
-    end
+require 'rspec-rails-caching/matchers/base'
 
-    failure_message_for_should do |actual|
-      "expected #{controller.class} to cache: #{expected.inspect} but got #{cache_results.inspect}"
-    end
-
-    failure_message_for_should_not do |actual|
-      "expected #{controller.class} not to cache: #{expected.inspect} but got #{cache_results.inspect}"
-    end
-
-    description do
-      "cache page #{expected.inspect}"
-    end
-
-    def controller
-      matcher_execution_context.controller
-    end
+module RSpecRailsCaching::Matchers
 
-    def cache_store
-      controller.cache_store
+  caching_matcher :cache_page do
+    def cache_or_expire
+      "cache page"
     end
 
     def cache_results
       cache_store.cached_pages
     end
   end
+
 end

lib/rspec-rails-caching/matchers/expire.rb

@@ -0,0 +1,11 @@
+require 'rspec-rails-caching/matchers/base'
+
+module RSpecRailsCaching::Matchers
+
+  caching_matcher :expire do
+    def cache_results
+      cache_store.expired
+    end
+  end
+
+end

lib/rspec-rails-caching/matchers/expire_page.rb

@@ -1,38 +1,15 @@
-module RSpecRailsCaching::Matchers
-  extend RSpec::Matchers::DSL
-
-  matcher :expire_page do |*expected|
-    match do |actual|
-      actual = actual.call if actual.respond_to?(:call)
-      unless actual.is_a? ActionController::TestResponse
-        raise ArgumentError("cache_page matcher expects a callable Proc or a TestResponse")
-      end
-
-      Array(expected).all? { |e| cache_store.page_expired?(e) }
-    end
+require 'rspec-rails-caching/matchers/base'
 
-    failure_message_for_should do |actual|
-      "expected #{controller.class} to expire: #{expected.inspect} but got #{cache_results.inspect}"
-    end
-
-    failure_message_for_should_not do |actual|
-      "expected #{controller.class} not to expire: #{expected.inspect} but got #{cache_results.inspect}"
-    end
-
-    description do
-      "expire page #{expected.inspect}"
-    end
-
-    def controller
-      matcher_execution_context.controller
-    end
+module RSpecRailsCaching::Matchers
 
-    def cache_store
-      controller.cache_store
+  caching_matcher :expire_page do
+    def cache_or_expire
+      "expire page"
     end
 
     def cache_results
       cache_store.expired_pages
     end
   end
+
 end