shoulda-matchers 2.8.0 → 3.0.0.rc1

data/lib/shoulda/matchers/doublespeak/double_collection.rb

@@ -3,7 +3,8 @@ module Shoulda
     module Doublespeak
       # @private
       class DoubleCollection
-        def initialize(klass)
+        def initialize(world, klass)
+          @world = world
           @klass = klass
           @doubles_by_method_name = {}
         end
@@ -40,12 +41,12 @@ module Shoulda
 
         protected
 
-        attr_reader :klass, :doubles_by_method_name
+        attr_reader :world, :klass, :doubles_by_method_name
 
         def register_double(method_name, implementation_type)
           implementation =
             DoubleImplementationRegistry.find(implementation_type)
-          double = Double.new(klass, method_name, implementation)
+          double = Double.new(world, klass, method_name, implementation)
           doubles_by_method_name[method_name] = double
           double
         end

data/lib/shoulda/matchers/doublespeak/method_call.rb

@@ -0,0 +1,35 @@
+module Shoulda
+  module Matchers
+    module Doublespeak
+      # @private
+      class MethodCall
+        attr_accessor :return_value
+        attr_reader :method_name, :args, :block, :object, :double
+
+        def initialize(args)
+          @method_name = args.fetch(:method_name)
+          @args = args.fetch(:args)
+          @block = args[:block]
+          @double = args[:double]
+          @object = args[:object]
+          @return_value = nil
+        end
+
+        def with_return_value(return_value)
+          dup.tap do |call|
+            call.return_value = return_value
+          end
+        end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            method_name == other.method_name &&
+            args == other.args &&
+            block == other.block &&
+            double == other.double &&
+            object == other.object
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/doublespeak/object_double.rb

@@ -19,8 +19,13 @@ module Shoulda
         end
 
         def method_missing(method_name, *args, &block)
-          calls << MethodCallWithName.new(method_name, args, block)
-          (calls_by_method_name[method_name] ||= []) << MethodCall.new(args, block)
+          call = MethodCall.new(
+            method_name: method_name,
+            args: args,
+            block: block
+          )
+          calls << call
+          (calls_by_method_name[method_name] ||= []) << call
           nil
         end
 

data/lib/shoulda/matchers/doublespeak/proxy_implementation.rb

@@ -17,9 +17,10 @@ module Shoulda
           @stub_implementation = stub_implementation
         end
 
-        def call(double, object, args, block)
-          stub_implementation.call(double, object, args, block)
-          double.call_original_method(object, args, block)
+        def call(call)
+          return_value = call.double.call_original_method(call)
+          stub_implementation.call(call.with_return_value(return_value))
+          return_value
         end
 
         protected

data/lib/shoulda/matchers/doublespeak/stub_implementation.rb

@@ -21,9 +21,9 @@ module Shoulda
           end
         end
 
-        def call(double, object, args, block)
-          double.record_call(args, block)
-          implementation.call(object, args, block)
+        def call(call)
+          call.double.record_call(call)
+          implementation.call(call)
         end
 
         protected

data/lib/shoulda/matchers/doublespeak/world.rb

@@ -4,7 +4,19 @@ module Shoulda
       # @private
       class World
         def double_collection_for(klass)
-          double_collections_by_class[klass] ||= DoubleCollection.new(klass)
+          double_collections_by_class[klass] ||=
+            DoubleCollection.new(self, klass)
+        end
+
+        def store_original_method_for(klass, method_name)
+          original_methods_for_class(klass)[method_name] ||=
+            klass.instance_method(method_name)
+        end
+
+        def original_method_for(klass, method_name)
+          if original_methods_by_class.key?(klass)
+            original_methods_by_class[klass][method_name]
+          end
         end
 
         def with_doubles_activated
@@ -31,6 +43,14 @@ module Shoulda
         def double_collections_by_class
           @_double_collections_by_class ||= {}
         end
+
+        def original_methods_by_class
+          @_original_methods_by_class ||= {}
+        end
+
+        def original_methods_for_class(klass)
+          original_methods_by_class[klass] ||= {}
+        end
       end
     end
   end

data/lib/shoulda/matchers/integrations.rb

@@ -0,0 +1,43 @@
+module Shoulda
+  module Matchers
+    # @private
+    module Integrations
+      class << self
+        def register_library(klass, name)
+          library_registry.register(klass, name)
+        end
+
+        def find_library!(name)
+          library_registry.find!(name)
+        end
+
+        def register_test_framework(klass, name)
+          test_framework_registry.register(klass, name)
+        end
+
+        def find_test_framework!(name)
+          test_framework_registry.find!(name)
+        end
+
+        private
+
+        def library_registry
+          @_library_registry ||= Registry.new
+        end
+
+        def test_framework_registry
+          @_test_framework_registry ||= Registry.new
+        end
+      end
+    end
+  end
+end
+
+require 'shoulda/matchers/integrations/configuration'
+require 'shoulda/matchers/integrations/configuration_error'
+require 'shoulda/matchers/integrations/inclusion'
+require 'shoulda/matchers/integrations/rails'
+require 'shoulda/matchers/integrations/registry'
+
+require 'shoulda/matchers/integrations/libraries'
+require 'shoulda/matchers/integrations/test_frameworks'

data/lib/shoulda/matchers/integrations/configuration.rb

@@ -0,0 +1,68 @@
+require 'set'
+
+module Shoulda
+  module Matchers
+    module Integrations
+      # @private
+      class Configuration
+        def self.apply(configuration, &block)
+          new(configuration, &block).apply
+        end
+
+        def initialize(configuration, &block)
+          @test_frameworks = Set.new
+          @libraries = Set.new
+
+          test_framework :missing_test_framework
+          library :missing_library
+
+          block.call(self)
+        end
+
+        def test_framework(name)
+          clear_default_test_framework
+          @test_frameworks << Integrations.find_test_framework!(name)
+        end
+
+        def library(name)
+          @libraries << Integrations.find_library!(name)
+        end
+
+        def apply
+          if no_test_frameworks_added? && no_libraries_added?
+            raise ConfigurationError, <<EOT
+shoulda-matchers is not configured correctly. You need to specify at least one
+test framework and/or library. For example:
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
+EOT
+          end
+
+          @test_frameworks.each do |test_framework|
+            test_framework.include(Shoulda::Matchers::Independent)
+            @libraries.each { |library| library.integrate_with(test_framework) }
+          end
+        end
+
+        private
+
+        def clear_default_test_framework
+          @test_frameworks.select!(&:present?)
+        end
+
+        def no_test_frameworks_added?
+          @test_frameworks.empty? || !@test_frameworks.any?(&:present?)
+        end
+
+        def no_libraries_added?
+          @libraries.empty?
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/configuration_error.rb

@@ -0,0 +1,9 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      # @private
+      class ConfigurationError < StandardError
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/inclusion.rb

@@ -0,0 +1,20 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      # @private
+      module Inclusion
+        def include_into(mod, *other_mods, &block)
+          mods_to_include = other_mods.dup
+          mods_to_extend = other_mods.dup
+
+          if block
+            mods_to_include << Module.new(&block)
+          end
+
+          mod.__send__(:include, *mods_to_include)
+          mod.extend(*mods_to_extend)
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries.rb

@@ -0,0 +1,15 @@
+require 'shoulda/matchers/integrations/libraries/action_controller'
+require 'shoulda/matchers/integrations/libraries/active_model'
+require 'shoulda/matchers/integrations/libraries/active_record'
+require 'shoulda/matchers/integrations/libraries/missing_library'
+require 'shoulda/matchers/integrations/libraries/rails'
+
+module Shoulda
+  module Matchers
+    module Integrations
+      # @private
+      module Libraries
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries/action_controller.rb

@@ -0,0 +1,31 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        # @private
+        class ActionController
+          Integrations.register_library(self, :action_controller)
+
+          include Integrations::Inclusion
+          include Integrations::Rails
+
+          def integrate_with(test_framework)
+            test_framework.include(matchers_module)
+
+            include_into(::ActionController::TestCase, matchers_module) do
+              def subject
+                @controller
+              end
+            end
+          end
+
+          private
+
+          def matchers_module
+            Shoulda::Matchers::ActionController
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries/active_model.rb

@@ -0,0 +1,26 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        # @private
+        class ActiveModel
+          Integrations.register_library(self, :active_model)
+
+          include Integrations::Inclusion
+          include Integrations::Rails
+
+          def integrate_with(test_framework)
+            test_framework.include(matchers_module)
+            include_into(ActiveSupport::TestCase, matchers_module)
+          end
+
+          private
+
+          def matchers_module
+            Shoulda::Matchers::ActiveModel
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries/active_record.rb

@@ -0,0 +1,26 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        # @private
+        class ActiveRecord
+          Integrations.register_library(self, :active_record)
+
+          include Integrations::Inclusion
+          include Integrations::Rails
+
+          def integrate_with(test_framework)
+            test_framework.include(matchers_module)
+            include_into(ActiveSupport::TestCase, matchers_module)
+          end
+
+          private
+
+          def matchers_module
+            Shoulda::Matchers::ActiveRecord
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries/missing_library.rb

@@ -0,0 +1,19 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        # @private
+        class MissingLibrary
+          Integrations.register_library(self, :missing_library)
+
+          def integrate_with(test_framework)
+          end
+
+          def rails?
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/libraries/rails.rb

@@ -0,0 +1,30 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        # @private
+        class Rails
+          Integrations.register_library(self, :rails)
+
+          include Integrations::Rails
+
+          SUB_LIBRARIES = [
+            :active_model,
+            :active_record,
+            :action_controller
+          ]
+
+          def integrate_with(test_framework)
+            Shoulda::Matchers.assertion_exception_class =
+              ActiveSupport::TestCase::Assertion
+
+            SUB_LIBRARIES.each do |name|
+              library = Integrations.find_library!(name)
+              library.integrate_with(test_framework)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/integrations/rails.rb

@@ -0,0 +1,12 @@
+module Shoulda
+  module Matchers
+    module Integrations
+      # @private
+      module Rails
+        def rails?
+          true
+        end
+      end
+    end
+  end
+end