puppet 0.23.2 → 0.24.0

data/test/lib/spec/mocks.rb

@@ -1,232 +0,0 @@
-require 'spec/mocks/methods'
-require 'spec/mocks/mock_handler'
-require 'spec/mocks/mock'
-require 'spec/mocks/argument_expectation'
-require 'spec/mocks/message_expectation'
-require 'spec/mocks/order_group'
-require 'spec/mocks/errors'
-require 'spec/mocks/error_generator'
-require 'spec/mocks/extensions/object'
-
-module Spec
-  # == Mocks and Stubs
-  #
-  # RSpec will create Mock Objects and Stubs for you at runtime, or attach stub/mock behaviour
-  # to any of your real objects (Partial Mock/Stub). Because the underlying implementation
-  # for mocks and stubs is the same, you can intermingle mock and stub
-  # behaviour in either dynamically generated mocks or your pre-existing classes.
-  # There is a semantic difference in how they are created, however,
-  # which can help clarify the role it is playing within a given spec.
-  #
-  # == Mock Objects
-  # 
-  # Mocks are objects that allow you to set and verify expectations that they will
-  # receive specific messages during run time. They are very useful for specifying how the subject of
-  # the spec interacts with its collaborators. This approach is widely known as "interaction
-  # testing".
-  # 
-  # Mocks are also very powerful as a design tool. As you are
-  # driving the implementation of a given class, Mocks provide an anonymous
-  # collaborator that can change in behaviour as quickly as you can write an expectation in your
-  # spec. This flexibility allows you to design the interface of a collaborator that often
-  # does not yet exist. As the shape of the class being specified becomes more clear, so do the
-  # requirements for its collaborators - often leading to the discovery of new types that are
-  # needed in your system.
-  # 
-  # Read Endo-Testing[http://www.mockobjects.com/files/endotesting.pdf] for a much
-  # more in depth description of this process.
-  # 
-  # == Stubs
-  # 
-  # Stubs are objects that allow you to set "stub" responses to
-  # messages. As Martin Fowler points out on his site,
-  # mocks_arent_stubs[http://www.martinfowler.com/articles/mocksArentStubs.html].
-  # Paraphrasing Fowler's paraphrasing
-  # of Gerard Meszaros: Stubs provide canned responses to messages they might receive in a test, while
-  # mocks allow you to specify and, subsquently, verify that certain messages should be received during
-  # the execution of a test.
-  # 
-  # == Partial Mocks/Stubs
-  # 
-  # RSpec also supports partial mocking/stubbing, allowing you to add stub/mock behaviour
-  # to instances of your existing classes. This is generally
-  # something to be avoided, because changes to the class can have ripple effects on
-  # seemingly unrelated specs. When specs fail due to these ripple effects, the fact
-  # that some methods are being mocked can make it difficult to understand why a
-  # failure is occurring.
-  # 
-  # That said, partials do allow you to expect and
-  # verify interactions with class methods such as +#find+ and +#create+
-  # on Ruby on Rails model classes.
-  # 
-  # == Further Reading
-  # 
-  # There are many different viewpoints about the meaning of mocks and stubs. If you are interested
-  # in learning more, here is some recommended reading:
-  # 
-  # * Mock Objects: http://www.mockobjects.com/
-  # * Endo-Testing: http://www.mockobjects.com/files/endotesting.pdf
-  # * Mock Roles, Not Objects: http://www.mockobjects.com/files/mockrolesnotobjects.pdf
-  # * Test Double Patterns: http://xunitpatterns.com/Test%20Double%20Patterns.html
-  # * Mocks aren't stubs: http://www.martinfowler.com/articles/mocksArentStubs.html
-  #
-  # == Creating a Mock
-  #
-  # You can create a mock in any specification (or setup) using:
-  #
-  #   mock(name, options={})
-  #
-  # The optional +options+ argument is a +Hash+. Currently the only supported
-  # option is +:null_object+. Setting this to true instructs the mock to ignore
-  # any messages it hasn’t been told to expect – and quietly return itself. For example:
-  #
-  #   mock("person", :null_object => true)
-  #
-  # == Creating a Stub
-  #
-  # You can create a stub in any specification (or setup) using:
-  #
-  #   stub(name, stub_methods_and_values_hash)
-  #
-  # For example, if you wanted to create an object that always returns
-  # "More?!?!?!" to "please_sir_may_i_have_some_more" you would do this:
-  #
-  #   stub("Mr Sykes", :please_sir_may_i_have_some_more => "More?!?!?!")
-  #
-  # == Creating a Partial Mock
-  #
-  # You don't really "create" a partial mock, you simply add method stubs and/or
-  # mock expectations to existing classes and objects:
-  #
-  #   Factory.should_receive(:find).with(id).and_return(value)
-  #   obj.stub!(:to_i).and_return(3)
-  #   etc ...
-  #
-  # == Expecting Messages
-  #
-  #   my_mock.should_receive(:sym)
-  #   my_mock.should_not_receive(:sym)
-  #   
-  # == Expecting Arguments
-  #
-  #   my_mock.should_receive(:sym).with(*args)
-  #   my_mock.should_not_receive(:sym).with(*args)
-  #
-  # == Argument Constraints using Expression Matchers
-  #
-  # Arguments that are passed to #with are compared with actual arguments received
-  # using == by default. In cases in which you want to specify things about the arguments
-  # rather than the arguments themselves, you can use any of the Expression Matchers.
-  # They don't all make syntactic sense (they were primarily designed for use with
-  # Spec::Expectations), but you are free to create your own custom Spec::Matchers.
-  #
-  # Spec::Mocks does provide one additional Matcher method named #ducktype.
-  #
-  # In addition, Spec::Mocks adds some keyword Symbols that you can use to
-  # specify certain kinds of arguments:
-  #
-  #   my_mock.should_receive(:sym).with(:no_args)
-  #   my_mock.should_receive(:sym).with(:any_args)
-  #   my_mock.should_receive(:sym).with(1, :numeric, "b") #2nd argument can any type of Numeric
-  #   my_mock.should_receive(:sym).with(1, :boolean, "b") #2nd argument can true or false
-  #   my_mock.should_receive(:sym).with(1, :string, "b") #2nd argument can be any String
-  #   my_mock.should_receive(:sym).with(1, /abc/, "b") #2nd argument can be any String matching the submitted Regexp
-  #   my_mock.should_receive(:sym).with(1, :anything, "b") #2nd argument can be anything at all
-  #   my_mock.should_receive(:sym).with(1, ducktype(:abs, :div), "b")
-  #                            #2nd argument can be object that responds to #abs and #div
-  #                                                                       
-  # == Receive Counts
-  #
-  #   my_mock.should_receive(:sym).once
-  #   my_mock.should_receive(:sym).twice
-  #   my_mock.should_receive(:sym).exactly(n).times
-  #   my_mock.should_receive(:sym).at_least(:once)
-  #   my_mock.should_receive(:sym).at_least(:twice)
-  #   my_mock.should_receive(:sym).at_least(n).times
-  #   my_mock.should_receive(:sym).at_most(:once)
-  #   my_mock.should_receive(:sym).at_most(:twice)
-  #   my_mock.should_receive(:sym).at_most(n).times
-  #   my_mock.should_receive(:sym).any_number_of_times
-  #
-  # == Ordering
-  #
-  #   my_mock.should_receive(:sym).ordered
-  #   my_mock.should_receive(:other_sym).ordered
-  #     #This will fail if the messages are received out of order
-  #
-  # == Setting Reponses
-  #
-  # Whether you are setting a mock expectation or a simple stub, you can tell the
-  # object precisely how to respond:
-  #
-  #   my_mock.should_receive(:sym).and_return(value)
-  #   my_mock.should_receive(:sym).exactly(3).times.and_return(value1, value2, value3)
-  #     # returns value1 the first time, value2 the second, etc
-  #   my_mock.should_receive(:sym).and_return { ... } #returns value returned by the block
-  #   my_mock.should_receive(:sym).and_raise(error)
-  #     #error can be an instantiated object or a class
-  #     #if it is a class, it must be instantiable with no args
-  #   my_mock.should_receive(:sym).and_throw(:sym)
-  #   my_mock.should_receive(:sym).and_yield([array,of,values,to,yield])
-  #
-  # Any of these responses can be applied to a stub as well, but stubs do
-  # not support any qualifiers about the message received (i.e. you can't specify arguments
-  # or receive counts):
-  #
-  #   my_mock.stub!(:sym).and_return(value)
-  #   my_mock.stub!(:sym).and_return(value1, value2, value3)
-  #   my_mock.stub!(:sym).and_raise(error)
-  #   my_mock.stub!(:sym).and_throw(:sym)
-  #   my_mock.stub!(:sym).and_yield([array,of,values,to,yield])
-  #
-  # == Arbitrary Handling
-  #
-  # Once in a while you'll find that the available expectations don't solve the
-  # particular problem you are trying to solve. Imagine that you expect the message
-  # to come with an Array argument that has a specific length, but you don't care
-  # what is in it. You could do this:
-  #
-  #   my_mock.should_receive(:sym) do |arg|
-  #     arg.should be_an_istance_of(Array)
-  #     arg.length.should == 7
-  #   end
-  #
-  # Note that this would fail if the number of arguments received was different from
-  # the number of block arguments (in this case 1).
-  #
-  # == Combining Expectation Details
-  #
-  # Combining the message name with specific arguments, receive counts and responses
-  # you can get quite a bit of detail in your expectations:
-  #
-  #   my_mock.should_receive(:<<).with("illegal value").once.and_raise(ArgumentError)
-  module Mocks
-    # Shortcut for creating an instance of Spec::Mocks::Mock.
-    def mock(name, options={})
-      Spec::Mocks::Mock.new(name, options)
-    end
-
-    # Shortcut for creating an instance of Spec::Mocks::Mock with
-    # predefined method stubs.
-    #
-    # == Examples
-    #
-    #   stub_thing = stub("thing", :a => "A")
-    #   stub_thing.a == "A" => true
-    #
-    #   stub_person = stub("thing", :name => "Joe", :email => "joe@domain.com")
-    #   stub_person.name => "Joe"
-    #   stub_person.email => "joe@domain.com"
-    def stub(name, stubs={})
-      object_stub = mock(name)
-      stubs.each { |key, value| object_stub.stub!(key).and_return(value) }
-      object_stub
-    end
-
-    # Shortcut for creating an instance of Spec::Mocks::DuckTypeArgConstraint
-    def duck_type(*args)
-      return Spec::Mocks::DuckTypeArgConstraint.new(*args)
-    end
-
-  end
-end

data/test/lib/spec/mocks/argument_expectation.rb

@@ -1,132 +0,0 @@
-module Spec
-  module Mocks
-  
-    class MatcherConstraint
-      def initialize(matcher)
-        @matcher = matcher
-      end
-      
-      def matches?(value)
-        @matcher.matches?(value)
-      end
-    end
-      
-    class LiteralArgConstraint
-      def initialize(literal)
-        @literal_value = literal
-      end
-      
-      def matches?(value)
-        @literal_value == value
-      end
-    end
-    
-    class RegexpArgConstraint
-      def initialize(regexp)
-        @regexp = regexp
-      end
-      
-      def matches?(value)
-        return value =~ @regexp unless value.is_a?(Regexp)
-        value == @regexp
-      end
-    end
-    
-    class AnyArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        true
-      end
-    end
-    
-    class NumericArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        value.is_a?(Numeric)
-      end
-    end
-    
-    class BooleanArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        return true if value.is_a?(TrueClass)
-        return true if value.is_a?(FalseClass)
-        false
-      end
-    end
-    
-    class StringArgConstraint
-      def initialize(ignore)
-      end
-      
-      def matches?(value)
-        value.is_a?(String)
-      end
-    end
-    
-    class DuckTypeArgConstraint
-      def initialize(*methods_to_respond_do)
-        @methods_to_respond_do = methods_to_respond_do
-      end
-  
-      def matches?(value)
-        @methods_to_respond_do.all? { |sym| value.respond_to?(sym) }
-      end
-    end
-
-    class ArgumentExpectation
-      attr_reader :args
-      @@constraint_classes = Hash.new { |hash, key| LiteralArgConstraint}
-      @@constraint_classes[:anything] = AnyArgConstraint
-      @@constraint_classes[:numeric] = NumericArgConstraint
-      @@constraint_classes[:boolean] = BooleanArgConstraint
-      @@constraint_classes[:string] = StringArgConstraint
-      
-      def initialize(args)
-        @args = args
-        if [:any_args] == args then @expected_params = nil
-        elsif [:no_args] == args then @expected_params = []
-        else @expected_params = process_arg_constraints(args)
-        end
-      end
-      
-      def process_arg_constraints(constraints)
-        constraints.collect do |constraint| 
-          convert_constraint(constraint)
-        end
-      end
-      
-      def convert_constraint(constraint)
-        return @@constraint_classes[constraint].new(constraint) if constraint.is_a?(Symbol)
-        return constraint if constraint.is_a?(DuckTypeArgConstraint)
-        return MatcherConstraint.new(constraint) if is_matcher?(constraint)
-        return RegexpArgConstraint.new(constraint) if constraint.is_a?(Regexp)
-        return LiteralArgConstraint.new(constraint)
-      end
-      
-      def is_matcher?(obj)
-        return obj.respond_to?(:matches?) && obj.respond_to?(:description)
-      end
-      
-      def check_args(args)
-        return true if @expected_params.nil?
-        return true if @expected_params == args
-        return constraints_match?(args)
-      end
-      
-      def constraints_match?(args)
-        return false if args.length != @expected_params.length
-        @expected_params.each_index { |i| return false unless @expected_params[i].matches?(args[i]) }
-        return true
-      end
-  
-    end
-    
-  end
-end

data/test/lib/spec/mocks/error_generator.rb

@@ -1,85 +0,0 @@
-module Spec
-  module Mocks
-    class ErrorGenerator
-      attr_writer :opts
-      
-      def initialize(target, name)
-        @target = target
-        @name = name
-      end
-      
-      def opts
-        @opts ||= {}
-      end
-
-      def raise_unexpected_message_error(sym, *args)
-        __raise "#{intro} received unexpected message :#{sym}#{arg_message(*args)}"
-      end
-      
-      def raise_unexpected_message_args_error(expectation, *args)
-        #this is either :no_args or an Array
-        expected_args = (expectation.expected_args == :no_args ? "(no args)" : format_args(*expectation.expected_args))
-        actual_args = args.empty? ? "(no args)" : format_args(*args)
-        __raise "#{intro} expected #{expectation.sym.inspect} with #{expected_args} but received it with #{actual_args}"
-      end
-      
-      def raise_expectation_error(sym, expected_received_count, actual_received_count, *args)
-        __raise "#{intro} expected :#{sym}#{arg_message(*args)} #{count_message(expected_received_count)}, but received it #{count_message(actual_received_count)}"
-      end
-      
-      def raise_out_of_order_error(sym)
-        __raise "#{intro} received :#{sym} out of order"
-      end
-      
-      def raise_block_failed_error(sym, detail)
-        __raise "#{intro} received :#{sym} but passed block failed with: #{detail}"
-      end
-      
-      def raise_missing_block_error(args_to_yield)
-        __raise "#{intro} asked to yield |#{arg_list(*args_to_yield)}| but no block was passed"
-      end
-      
-      def raise_wrong_arity_error(args_to_yield, arity)
-        __raise "#{intro} yielded |#{arg_list(*args_to_yield)}| to block with arity of #{arity}"
-      end
-      
-      private
-      def intro
-        @name ? "Mock '#{@name}'" : @target.to_s
-      end
-      
-      def __raise(message)
-        message = opts[:message] unless opts[:message].nil?
-        Kernel::raise(Spec::Mocks::MockExpectationError, message)
-      end
-      
-      def arg_message(*args)
-        " with " + format_args(*args)
-      end
-      
-      def format_args(*args)
-        return "(no args)" if args.empty? || args == [:no_args]
-        return "(any args)" if args == [:any_args]
-        "(" + arg_list(*args) + ")"
-      end
-
-      def arg_list(*args)
-        args.collect do |arg|
-          arg.respond_to?(:description) ? arg.description : arg.inspect
-        end.join(", ")
-      end
-      
-      def count_message(count)
-        return "at least #{pretty_print(count.abs)}" if count < 0
-        return pretty_print(count)
-      end
-
-      def pretty_print(count)
-        return "once" if count == 1
-        return "twice" if count == 2
-        return "#{count} times"
-      end
-
-    end
-  end
-end