jferris-rr 0.7.1.0.1239654108

data/Rakefile

@@ -0,0 +1,77 @@
+require "rake"
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc "Runs the Rspec suite"
+task(:default) do
+  run_suite
+end
+
+desc "Runs the Rspec suite"
+task(:spec) do
+  run_suite
+end
+
+desc "Copies the trunk to a tag with the name of the current release"
+task(:tag_release) do
+  tag_release
+end
+
+def run_suite
+  dir = File.dirname(__FILE__)
+  system("ruby #{dir}/spec/spec_suite.rb") || raise("Spec Suite failed")
+end
+
+PKG_NAME = "rr"
+PKG_VERSION = "0.7.1"
+PKG_FILES = FileList[
+  '[A-Z]*',
+  '*.rb',
+  'lib/**/*.rb',
+  'spec/**/*.rb'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = "#{PKG_VERSION}.0.#{Time.now.to_i}"
+  s.summary = "RR (Double Ruby) is a double framework that features a rich " <<
+              "selection of double techniques and a terse syntax. " <<
+              "http://xunitpatterns.com/Test%20Double.html"
+  s.test_files = "spec/spec_suite.rb"
+  s.description = s.summary
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ "README.rdoc", "CHANGES" ]
+  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+
+  s.test_files = Dir.glob('spec/*_spec.rb')
+  s.require_path = 'lib'
+  s.author = "Brian Takita"
+  s.email = "brian@pivotallabs.com"
+  s.homepage = "http://pivotallabs.com"
+  s.rubyforge_project = "pivotalrb"
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_yaml
+  end
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+def tag_release
+  dashed_version = PKG_VERSION.gsub('.', '-')
+  svn_user = "#{ENV["SVN_USER"]}@" || ""
+  `svn cp svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/rr/trunk svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/rr/tags/REL-#{dashed_version} -m 'Version #{PKG_VERSION}'`
+end

data/lib/rr.rb

@@ -0,0 +1,84 @@
+dir = File.dirname(__FILE__)
+require 'rubygems'
+
+require "#{dir}/rr/errors/rr_error"
+require "#{dir}/rr/errors/subject_does_not_implement_method_error"
+require "#{dir}/rr/errors/subject_has_different_arity_error"
+require "#{dir}/rr/errors/double_definition_error"
+require "#{dir}/rr/errors/double_not_found_error"
+require "#{dir}/rr/errors/double_order_error"
+require "#{dir}/rr/errors/argument_equality_error"
+require "#{dir}/rr/errors/times_called_error"
+require "#{dir}/rr/errors/spy_verification_errors/spy_verification_error"
+require "#{dir}/rr/errors/spy_verification_errors/double_injection_not_found_error"
+require "#{dir}/rr/errors/spy_verification_errors/invocation_count_error"
+
+require "#{dir}/rr/space"
+require "#{dir}/rr/double_injection"
+require "#{dir}/rr/hash_with_object_id_key"
+require "#{dir}/rr/recorded_calls"
+
+require "#{dir}/rr/double_definitions/double_definition_creator_proxy"
+require "#{dir}/rr/double_definitions/double_definition_creator"
+require "#{dir}/rr/double_definitions/child_double_definition_creator"
+require "#{dir}/rr/adapters/rr_methods"
+
+require "#{dir}/rr/double"
+require "#{dir}/rr/double_definitions/double_definition"
+require "#{dir}/rr/double_definitions/strategies/strategy"
+require "#{dir}/rr/double_definitions/strategies/verification/verification_strategy"
+require "#{dir}/rr/double_definitions/strategies/verification/mock"
+require "#{dir}/rr/double_definitions/strategies/verification/stub"
+require "#{dir}/rr/double_definitions/strategies/verification/dont_allow"
+require "#{dir}/rr/double_definitions/strategies/implementation/implementation_strategy"
+require "#{dir}/rr/double_definitions/strategies/implementation/reimplementation"
+require "#{dir}/rr/double_definitions/strategies/implementation/strongly_typed_reimplementation"
+require "#{dir}/rr/double_definitions/strategies/implementation/proxy"
+require "#{dir}/rr/double_definitions/strategies/scope/scope_strategy"
+require "#{dir}/rr/double_definitions/strategies/scope/instance"
+require "#{dir}/rr/double_definitions/strategies/scope/instance_of_class"
+require "#{dir}/rr/double_matches"
+
+require "#{dir}/rr/expectations/argument_equality_expectation"
+require "#{dir}/rr/expectations/any_argument_expectation"
+require "#{dir}/rr/expectations/times_called_expectation"
+
+require "#{dir}/rr/wildcard_matchers/anything"
+require "#{dir}/rr/wildcard_matchers/is_a"
+require "#{dir}/rr/wildcard_matchers/numeric"
+require "#{dir}/rr/wildcard_matchers/boolean"
+require "#{dir}/rr/wildcard_matchers/duck_type"
+require "#{dir}/rr/wildcard_matchers/regexp"
+require "#{dir}/rr/wildcard_matchers/range"
+require "#{dir}/rr/wildcard_matchers/satisfy"
+require "#{dir}/rr/wildcard_matchers/hash_including"
+
+require "#{dir}/rr/times_called_matchers/terminal"
+require "#{dir}/rr/times_called_matchers/non_terminal"
+require "#{dir}/rr/times_called_matchers/times_called_matcher"
+require "#{dir}/rr/times_called_matchers/any_times_matcher"
+require "#{dir}/rr/times_called_matchers/integer_matcher"
+require "#{dir}/rr/times_called_matchers/range_matcher"
+require "#{dir}/rr/times_called_matchers/proc_matcher"
+require "#{dir}/rr/times_called_matchers/at_least_matcher"
+require "#{dir}/rr/times_called_matchers/at_most_matcher"
+
+require "#{dir}/rr/spy_verification_proxy"
+require "#{dir}/rr/spy_verification"
+
+require "#{dir}/rr/adapters/rspec"
+require "#{dir}/rr/adapters/test_unit"
+
+module RR
+  class << self
+    include Adapters::RRMethods
+    (RR::Space.instance_methods - Object.instance_methods).each do |method_name|
+      returns_method = <<-METHOD
+        def #{method_name}(*args, &block)
+          RR::Space.instance.__send__(:#{method_name}, *args, &block)
+        end
+      METHOD
+      class_eval(returns_method, __FILE__, __LINE__ - 4)
+    end
+  end
+end

data/lib/rr/adapters/rr_methods.rb

@@ -0,0 +1,122 @@
+module RR
+  module Adapters
+    module RRMethods
+      class << self
+        def register_strategy_class(strategy_class, method_name)
+          class_eval((<<-CLASS), __FILE__, __LINE__ + 1)
+          def #{method_name}(subject=DoubleDefinitions::DoubleDefinitionCreator::NO_SUBJECT, method_name=nil, &definition_eval_block)
+            creator = DoubleDefinitions::DoubleDefinitionCreator.new
+            creator.#{method_name}(subject, method_name, &definition_eval_block)
+          end
+          CLASS
+
+          class_eval((<<-CLASS), __FILE__, __LINE__ + 1)
+          def #{method_name}!(method_name=nil, &definition_eval_block)
+            creator = DoubleDefinitions::DoubleDefinitionCreator.new
+            creator.#{method_name}!(method_name, &definition_eval_block)
+          end
+          CLASS
+        end
+      end
+
+      # Verifies all the DoubleInjection objects have met their
+      # TimesCalledExpectations.
+      def verify
+        RR::Space.instance.verify_doubles
+      end
+
+      # Resets the registered Doubles and ordered Doubles
+      def reset
+        RR::Space.instance.reset
+      end
+
+      # Returns a AnyTimesMatcher. This is meant to be passed in as an argument
+      # to Double#times.
+      #
+      #   mock(object).method_name(anything).times(any_times) {return_value}
+      def any_times
+        TimesCalledMatchers::AnyTimesMatcher.new
+      end
+
+      # Sets up an Anything wildcard ArgumentEqualityExpectation
+      # that succeeds when passed any argument.
+      #   mock(object).method_name(anything) {return_value}
+      #   object.method_name("an arbitrary value") # passes
+      def anything
+        RR::WildcardMatchers::Anything.new
+      end
+
+      # Sets up an IsA wildcard ArgumentEqualityExpectation
+      # that succeeds when passed an argument of a certain type.
+      #   mock(object).method_name(is_a(String)) {return_value}
+      #   object.method_name("A String") # passes
+      def is_a(klass)
+        RR::WildcardMatchers::IsA.new(klass)
+      end
+
+      # Sets up an Numeric wildcard ArgumentEqualityExpectation
+      # that succeeds when passed an argument that is ::Numeric.
+      #   mock(object).method_name(numeric) {return_value}
+      #   object.method_name(99) # passes
+      def numeric
+        RR::WildcardMatchers::Numeric.new
+      end
+
+      # Sets up an Boolean wildcard ArgumentEqualityExpectation
+      # that succeeds when passed an argument that is a ::Boolean.
+      #   mock(object).method_name(boolean) {return_value}
+      #   object.method_name(false) # passes
+      def boolean
+        RR::WildcardMatchers::Boolean.new
+      end
+
+      # Sets up a DuckType wildcard ArgumentEqualityExpectation
+      # that succeeds when the passed argument implements the methods.
+      #   arg = Object.new
+      #   def arg.foo; end
+      #   def arg.bar; end
+      #   mock(object).method_name(duck_type(:foo, :bar)) {return_value}
+      #   object.method_name(arg) # passes
+      def duck_type(*args)
+        RR::WildcardMatchers::DuckType.new(*args)
+      end
+      
+      # Sets up a HashIncluding wildcard ArgumentEqualityExpectation
+      # that succeeds when the passed argument contains at least those keys
+      # and values of the expectation.
+      #   mock(object).method_name(hash_including(:foo => 1)) {return_value}
+      #   object.method_name({:foo => 1, :bar => 2) # passes
+      def hash_including(expected_hash)
+        RR::WildcardMatchers::HashIncluding.new(expected_hash)
+      end
+
+      # Sets up a Satisfy wildcard ArgumentEqualityExpectation
+      # that succeeds when the passed argument causes the expectation's
+      # proc to return true.
+      #   mock(object).method_name(satisfy {|arg| arg == :foo}) {return_value}
+      #   object.method_name(:foo) # passes
+      def satisfy(expectation_proc=nil, &block)
+        expectation_proc ||= block
+        RR::WildcardMatchers::Satisfy.new(expectation_proc)
+      end
+      
+      def spy(subject)
+        methods_to_stub = subject.public_methods - ["methods", "==", "__send__", "__id__"]
+        methods_to_stub.each do |method|
+          stub.proxy(subject, method)
+        end
+      end
+
+      def received(subject)
+        RR::SpyVerificationProxy.new(subject)
+      end
+      
+      instance_methods.each do |name|
+        alias_method "rr_#{name}", name
+      end
+    end
+  end
+  module Extensions
+    InstanceMethods = Adapters::RRMethods
+  end
+end

data/lib/rr/adapters/rspec.rb

@@ -0,0 +1,58 @@
+module RR
+  module Adapters
+    module Rspec
+      def self.included(mod)
+        patterns = ::Spec::Runner::QuietBacktraceTweaker::IGNORE_PATTERNS
+        unless patterns.include?(RR::Errors::BACKTRACE_IDENTIFIER)
+          patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+        end
+      end
+
+      include RRMethods
+      def setup_mocks_for_rspec
+        RR.reset
+      end
+      def verify_mocks_for_rspec
+        RR.verify
+      end
+      def teardown_mocks_for_rspec
+        RR.reset
+      end
+
+      def have_received(method = nil)
+        InvocationMatcher.new(method)
+      end
+
+      class InvocationMatcher < SpyVerificationProxy
+        attr_reader :failure_message
+ 
+        def initialize(method = nil)
+          method_missing(method) if method
+        end
+
+        def matches?(subject)
+          @verification.subject = subject
+          if error = RR::Space.instance.recorded_calls.match_error(@verification)
+            @failure_message = error.message
+            false
+          else
+            true
+          end
+        end
+
+        def nil?
+          false
+        end
+
+        def method_missing(method_name, *args, &block)
+          if @verification
+            @verification.send(method_name, *args)
+          else
+            @verification = super
+          end
+          self
+        end
+      end
+    end
+  end
+end

data/lib/rr/adapters/test_unit.rb

@@ -0,0 +1,29 @@
+module RR
+  module Adapters
+    module TestUnit
+      include RRMethods
+      def self.included(mod)
+        RR.trim_backtrace = true
+        mod.class_eval do
+          alias_method :setup_without_rr, :setup
+          def setup_with_rr
+            setup_without_rr
+            RR.reset
+          end
+          alias_method :setup, :setup_with_rr
+
+          alias_method :teardown_without_rr, :teardown
+          def teardown_with_rr
+            RR.verify
+            teardown_without_rr
+          end
+          alias_method :teardown, :teardown_with_rr
+        end
+      end
+
+      def assert_received(subject, &block)
+        block.call(received(subject)).call
+      end
+    end
+  end
+end

data/lib/rr/double.rb

@@ -0,0 +1,212 @@
+module RR
+  # RR::Double is the use case for a method call.
+  # It has the ArgumentEqualityExpectation, TimesCalledExpectation,
+  # and the implementation.
+  class Double
+    class << self
+      def formatted_name(method_name, args)
+        formatted_errors = args.collect {|arg| arg.inspect}.join(', ')
+        "#{method_name}(#{formatted_errors})"
+      end
+
+      def list_message_part(doubles)
+        doubles.collect do |double|
+          "- #{formatted_name(double.method_name, double.expected_arguments)}"
+        end.join("\n")
+      end
+    end
+
+    attr_reader :times_called, :double_injection, :definition, :times_called_expectation
+    include Space::Reader
+
+    def initialize(double_injection, definition)
+      @double_injection = double_injection
+      @definition = definition
+      @times_called = 0
+      @times_called_expectation = Expectations::TimesCalledExpectation.new(self)
+      definition.double = self
+      verify_method_signature if definition.verify_method_signature?
+      double_injection.register_double self
+    end
+    
+    # Double#call calls the Double's implementation. The return
+    # value of the implementation is returned.
+    #
+    # A TimesCalledError is raised when the times called
+    # exceeds the expected TimesCalledExpectation.
+    def call(double_injection, *args, &block)
+      if verbose?
+        puts Double.formatted_name(double_injection.method_name, args)
+      end
+      times_called_expectation.attempt if definition.times_matcher
+      space.verify_ordered_double(self) if ordered?
+      yields!(block)
+      return_value = call_implementation(double_injection, *args, &block)
+      definition.after_call_proc ? extract_subject_from_return_value(definition.after_call_proc.call(return_value)) : return_value
+    end
+
+    # Double#exact_match? returns true when the passed in arguments
+    # exactly match the ArgumentEqualityExpectation arguments.
+    def exact_match?(*arguments)
+      definition.exact_match?(*arguments)
+    end
+
+    # Double#wildcard_match? returns true when the passed in arguments
+    # wildcard match the ArgumentEqualityExpectation arguments.
+    def wildcard_match?(*arguments)
+      definition.wildcard_match?(*arguments)
+    end
+
+    # Double#attempt? returns true when the
+    # TimesCalledExpectation is satisfied.
+    def attempt?
+      verify_times_matcher_is_set
+      times_called_expectation.attempt?
+    end
+
+    # Double#verify verifies the the TimesCalledExpectation
+    # is satisfied for this double. A TimesCalledError
+    # is raised if the TimesCalledExpectation is not met.
+    def verify
+      verify_times_matcher_is_set
+      times_called_expectation.verify!
+      true
+    end
+
+    def terminal?
+      verify_times_matcher_is_set
+      times_called_expectation.terminal?
+    end
+
+    # The method name that this Double is attatched to
+    def method_name
+      double_injection.method_name
+    end
+
+    # The Arguments that this Double expects
+    def expected_arguments
+      verify_argument_expectation_is_set
+      argument_expectation.expected_arguments
+    end
+
+    # The TimesCalledMatcher for the TimesCalledExpectation
+    def times_matcher
+      definition.times_matcher
+    end
+
+    def formatted_name
+      self.class.formatted_name(method_name, expected_arguments)
+    end
+
+    protected
+    def ordered?
+      definition.ordered?
+    end
+
+    def verbose?
+      definition.verbose?
+    end
+    
+    def yields!(block)
+      if definition.yields_value
+        if block
+          block.call(*definition.yields_value)
+        else
+          raise ArgumentError, "A Block must be passed into the method call when using yields"
+        end
+      end
+    end
+
+    def call_implementation(double_injection, *args, &block)
+      return_value = do_call_implementation_and_get_return_value(double_injection, *args, &block)
+      extract_subject_from_return_value(return_value)
+    end
+
+    def verify_times_matcher_is_set
+      unless definition.times_matcher
+        raise RR::Errors::DoubleDefinitionError, "#definition.times_matcher is not set"
+      end
+    end
+
+    def verify_argument_expectation_is_set
+      unless definition.argument_expectation
+        raise RR::Errors::DoubleDefinitionError, "#definition.argument_expectation is not set"
+      end
+    end
+
+    def verify_method_signature
+      raise RR::Errors::SubjectDoesNotImplementMethodError unless definition.subject.respond_to?(double_injection.send(:original_method_name))
+      raise RR::Errors::SubjectHasDifferentArityError unless arity_matches?
+    end
+    
+    def subject_arity
+      definition.subject.method(double_injection.send(:original_method_name)).arity
+    end
+    
+    def subject_accepts_only_varargs?
+      subject_arity == -1
+    end
+    
+    def subject_accepts_varargs?
+      subject_arity < 0
+    end
+    
+    def arity_matches?
+      return true if subject_accepts_only_varargs?
+      if subject_accepts_varargs?
+        return ((subject_arity * -1) - 1) <= args.size
+      else
+        return subject_arity == args.size
+      end
+    end
+    
+    def args
+      definition.argument_expectation.expected_arguments
+    end
+    
+    def do_call_implementation_and_get_return_value(double_injection, *args, &block)
+      if definition.implementation_is_original_method?
+        if double_injection.object_has_original_method?
+          double_injection.call_original_method(*args, &block)
+        else
+          double_injection.subject.__send__(
+            :method_missing,
+            method_name,
+            *args,
+            &block
+          )
+        end
+      else
+        if implementation
+          if implementation.is_a?(Method)
+            implementation.call(*args, &block)
+          else
+            args << block if block
+            implementation.call(*args)
+          end
+        else
+          nil
+        end
+      end
+    end
+
+    def extract_subject_from_return_value(return_value)
+      case return_value
+      when DoubleDefinitions::DoubleDefinition
+        return_value.root_subject
+      when DoubleDefinitions::DoubleDefinitionCreatorProxy
+        return_value.__creator__.root_subject
+      else
+        return_value
+      end
+    end
+
+    def implementation
+      definition.implementation
+    end
+
+    def argument_expectation
+      definition.argument_expectation
+    end    
+  end
+end