micronaut 0.2.9

data/examples/lib/micronaut/matchers/description_generation_example.rb

@@ -0,0 +1,175 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe Micronaut::Matchers do
+
+  describe "should be able to generate their own descriptions" do
+    
+    after do
+      Micronaut::Matchers.clear_generated_description
+    end
+
+    it "should == expected" do
+      "this".should == "this"
+      Micronaut::Matchers.generated_description.should == "should == \"this\""
+    end
+
+    it "should not == expected" do
+      "this".should_not == "that"
+      Micronaut::Matchers.generated_description.should == "should not == \"that\""
+    end
+
+    it "should be empty (arbitrary predicate)" do
+      [].should be_empty
+      Micronaut::Matchers.generated_description.should == "should be empty"
+    end
+
+    it "should not be empty (arbitrary predicate)" do
+      [1].should_not be_empty
+      Micronaut::Matchers.generated_description.should == "should not be empty"
+    end
+
+    it "should be true" do
+      true.should be_true
+      Micronaut::Matchers.generated_description.should == "should be true"
+    end
+
+    it "should be false" do
+      false.should be_false
+      Micronaut::Matchers.generated_description.should == "should be false"
+    end
+
+    it "should be nil" do
+      nil.should be_nil
+      Micronaut::Matchers.generated_description.should == "should be nil"
+    end
+
+    it "should be > n" do
+      5.should be > 3
+      Micronaut::Matchers.generated_description.should == "should be > 3"
+    end
+
+    it "should be predicate arg1, arg2 and arg3" do
+      5.0.should be_between(0,10)
+      Micronaut::Matchers.generated_description.should == "should be between 0 and 10"
+    end
+
+    it "should be_few_words predicate should be transformed to 'be few words'" do
+      5.should be_kind_of(Fixnum)
+      Micronaut::Matchers.generated_description.should == "should be kind of Fixnum"
+    end
+
+    it "should preserve a proper prefix for be predicate" do
+      5.should be_a_kind_of(Fixnum)
+      Micronaut::Matchers.generated_description.should == "should be a kind of Fixnum"
+      5.should be_an_instance_of(Fixnum)
+      Micronaut::Matchers.generated_description.should == "should be an instance of Fixnum"
+    end
+
+    it "should equal" do
+      expected = "expected"
+      expected.should equal(expected)
+      Micronaut::Matchers.generated_description.should == "should equal \"expected\""
+    end
+
+    it "should_not equal" do
+      5.should_not equal(37)
+      Micronaut::Matchers.generated_description.should == "should not equal 37"
+    end
+
+    it "should eql" do
+      "string".should eql("string")
+      Micronaut::Matchers.generated_description.should == "should eql \"string\""
+    end
+
+    it "should not eql" do
+      "a".should_not eql(:a)
+      Micronaut::Matchers.generated_description.should == "should not eql :a"
+    end
+
+    it "should have_key" do
+      {:a => "a"}.should have_key(:a)
+      Micronaut::Matchers.generated_description.should == "should have key :a"
+    end
+
+    it "should have n items" do
+      team.should have(3).players
+      Micronaut::Matchers.generated_description.should == "should have 3 players"
+    end
+
+    it "should have at least n items" do
+      team.should have_at_least(2).players
+      Micronaut::Matchers.generated_description.should == "should have at least 2 players"
+    end
+
+    it "should have at most n items" do
+      team.should have_at_most(4).players
+      Micronaut::Matchers.generated_description.should == "should have at most 4 players"
+    end
+
+    it "should include" do
+      [1,2,3].should include(3)
+      Micronaut::Matchers.generated_description.should == "should include 3"
+    end
+
+    it "should match" do
+      "this string".should match(/this string/)
+      Micronaut::Matchers.generated_description.should == "should match /this string/"
+    end
+
+    it "should raise_error" do
+      lambda { raise }.should raise_error
+      Micronaut::Matchers.generated_description.should == "should raise Exception"
+    end
+
+    it "should raise_error with type" do
+      lambda { raise }.should raise_error(RuntimeError)
+      Micronaut::Matchers.generated_description.should == "should raise RuntimeError"
+    end
+
+    it "should raise_error with type and message" do
+      lambda { raise "there was an error" }.should raise_error(RuntimeError, "there was an error")
+      Micronaut::Matchers.generated_description.should == "should raise RuntimeError with \"there was an error\""
+    end
+
+    it "should respond_to" do
+      [].should respond_to(:insert)
+      Micronaut::Matchers.generated_description.should == "should respond to [:insert]"
+    end
+
+    it "should throw symbol" do
+      lambda { throw :what_a_mess }.should throw_symbol
+      Micronaut::Matchers.generated_description.should == "should throw a Symbol"
+    end
+
+    it "should throw symbol (with named symbol)" do
+      lambda { throw :what_a_mess }.should throw_symbol(:what_a_mess)
+      Micronaut::Matchers.generated_description.should == "should throw :what_a_mess"
+    end
+
+    def team
+      Class.new do
+        def players
+          [1,2,3]
+        end
+      end.new
+    end
+    
+  end
+
+  describe "a matcher with no description" do
+    
+    def matcher
+      Class.new do
+        def matches?(ignore); true; end
+        def failure_message; ""; end
+      end.new
+    end
+
+    it "should provide a helpful message when used in a string-less example block" do
+      5.should matcher
+      Micronaut::Matchers.generated_description.should =~ /When you call.*description method/m
+    end
+    
+  end
+
+end

data/examples/lib/micronaut/matchers/eql_example.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe Micronaut::Matchers do
+
+  describe "eql" do
+
+    it "should match when actual.eql?(expected)" do
+      eql(1).matches?(1).should be_true
+    end
+
+    it "should not match when !actual.eql?(expected)" do
+      eql(1).matches?(2).should be_false
+    end
+
+    it "should describe itself" do
+      matcher = eql(1)
+      matcher.matches?(1)
+      matcher.description.should == "eql 1"
+    end
+
+    it "should provide message, expected and actual on #failure_message" do
+      matcher = eql("1")
+      matcher.matches?(1)
+      matcher.failure_message.should == ["expected \"1\", got 1 (using .eql?)", "1", 1]
+    end
+
+    it "should provide message, expected and actual on #negative_failure_message" do
+      matcher = eql(1)
+      matcher.matches?(1)
+      matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .eql?)", 1, 1]
+    end
+
+  end
+
+end

data/examples/lib/micronaut/matchers/equal_example.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe Micronaut::Matchers do
+
+  describe "equal" do
+    
+    it "should match when actual.equal?(expected)" do
+      equal(1).matches?(1).should be_true
+    end
+    
+    it "should not match when !actual.equal?(expected)" do
+      equal("1").matches?("1").should be_false
+    end
+    
+    it "should describe itself" do
+      matcher = equal(1)
+      matcher.matches?(1)
+      matcher.description.should == "equal 1"
+    end
+    
+    it "should provide message, expected and actual on #failure_message" do
+      matcher = equal("1")
+      matcher.matches?(1)
+      matcher.failure_message.should == ["expected \"1\", got 1 (using .equal?)", "1", 1]
+    end
+    
+    it "should provide message, expected and actual on #negative_failure_message" do
+      matcher = equal(1)
+      matcher.matches?(1)
+      matcher.negative_failure_message.should == ["expected 1 not to equal 1 (using .equal?)", 1, 1]
+    end
+    
+  end
+
+end

data/examples/lib/micronaut/matchers/has_example.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe Micronaut::Matchers do
+
+  describe "should have_sym(*args)" do
+    
+    it "should pass if #has_sym?(*args) returns true" do
+      {:a => "A"}.should have_key(:a)
+    end
+
+    it "should fail if #has_sym?(*args) returns false" do
+      lambda {
+        {:b => "B"}.should have_key(:a)
+      }.should fail_with("expected #has_key?(:a) to return true, got false")
+    end
+
+    it "should fail if target does not respond to #has_sym?" do
+      lambda { Object.new.should have_key(:a) }.should raise_error(NoMethodError)
+    end
+  
+    it "should re-raise an exception thrown in #has_sym?(*args)" do
+      o = Object.new
+      def o.has_sym?(*args)
+        raise "Funky exception"
+      end
+      lambda { o.should have_sym(:foo) }.should raise_error("Funky exception")
+    end
+    
+  end
+
+  describe "should_not have_sym(*args)" do
+    
+    it "should pass if #has_sym?(*args) returns false" do
+      {:a => "A"}.should_not have_key(:b)
+    end
+
+    it "should fail if #has_sym?(*args) returns true" do
+      lambda {
+        {:a => "A"}.should_not have_key(:a)
+      }.should fail_with("expected #has_key?(:a) to return false, got true")
+    end
+
+    it "should fail if target does not respond to #has_sym?" do
+      lambda {
+        Object.new.should have_key(:a)
+      }.should raise_error(NoMethodError)
+    end
+  
+    it "should reraise an exception thrown in #has_sym?(*args)" do
+      o = Object.new
+      def o.has_sym?(*args)
+        raise "Funky exception"
+      end
+      lambda { o.should_not have_sym(:foo) }.should raise_error("Funky exception")
+    end
+    
+  end
+
+  describe "has" do
+    
+    it "should work when the target implements #send" do
+      o = {:a => "A"}
+      def o.send(*args); raise "DOH! Library developers shouldn't use #send!" end
+      lambda { o.should have_key(:a) }.should_not raise_error
+    end
+    
+  end
+
+end

data/examples/lib/micronaut/matchers/have_example.rb

@@ -0,0 +1,392 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../example_helper")
+
+describe Micronaut::Matchers, "have" do
+
+  before do
+    unless defined?(::ActiveSupport::Inflector)
+      @active_support_was_not_defined
+      module ::ActiveSupport
+        class Inflector
+          def self.pluralize(string)
+            string.to_s + 's'
+          end
+        end
+      end
+    end
+  end
+
+  def create_collection_owner_with(n)
+    owner = Micronaut::Expectations::Helper::CollectionOwner.new
+    (1..n).each do |n|
+      owner.add_to_collection_with_length_method(n)
+      owner.add_to_collection_with_size_method(n)
+    end
+    owner
+  end
+
+  describe "should have(n).items" do
+
+    it "should pass if target has a collection of items with n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have(3).items_in_collection_with_length_method
+      owner.should have(3).items_in_collection_with_size_method
+    end
+
+    it "should convert :no to 0" do
+      owner = create_collection_owner_with(0)
+      owner.should have(:no).items_in_collection_with_length_method
+      owner.should have(:no).items_in_collection_with_size_method
+    end
+    
+    it "should fail if target has a collection of items with < n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have(4).items_in_collection_with_length_method
+      }.should fail_with("expected 4 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have(4).items_in_collection_with_size_method
+      }.should fail_with("expected 4 items_in_collection_with_size_method, got 3")
+    end
+  
+    it "should fail if target has a collection of items with > n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have(2).items_in_collection_with_length_method
+      }.should fail_with("expected 2 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have(2).items_in_collection_with_size_method
+      }.should fail_with("expected 2 items_in_collection_with_size_method, got 3")
+    end
+  end
+
+  describe 'should have(1).item when ActiveSupport::Inflector is defined' do
+    
+    it 'should pluralize the collection name' do
+      owner = create_collection_owner_with(1)
+      owner.should have(1).item
+    end
+  
+    after do
+      if @active_support_was_not_defined
+        Object.__send__ :remove_const, :ActiveSupport
+      end
+    end
+  end
+
+  describe 'should have(1).item when Inflector is defined' do
+    
+    before do
+      unless defined?(::Inflector)
+        @inflector_was_not_defined
+        class ::Inflector
+          def self.pluralize(string)
+            string.to_s + 's'
+          end
+        end
+      end
+    end
+  
+    it 'should pluralize the collection name' do
+      owner = create_collection_owner_with(1)
+      owner.should have(1).item
+    end
+
+    after do
+      if @inflector_was_not_defined
+        Object.__send__ :remove_const, :Inflector
+      end
+    end
+  end
+
+  describe "should have(n).items where result responds to items but returns something other than a collection" do
+    it "should provide a meaningful error" do
+      owner = Class.new do
+        def items
+          Object.new
+        end
+      end.new
+      lambda do
+        owner.should have(3).items
+      end.should raise_error("expected items to be a collection but it does not respond to #length or #size")
+    end
+  end
+
+  describe "should_not have(n).items" do
+  
+    it "should pass if target has a collection of items with < n members" do
+      owner = create_collection_owner_with(3)
+      owner.should_not have(4).items_in_collection_with_length_method
+      owner.should_not have(4).items_in_collection_with_size_method
+    end
+  
+    it "should pass if target has a collection of items with > n members" do
+      owner = create_collection_owner_with(3)
+      owner.should_not have(2).items_in_collection_with_length_method
+      owner.should_not have(2).items_in_collection_with_size_method
+    end
+
+    it "should fail if target has a collection of items with n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should_not have(3).items_in_collection_with_length_method
+      }.should fail_with("expected target not to have 3 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should_not have(3).items_in_collection_with_size_method
+        }.should fail_with("expected target not to have 3 items_in_collection_with_size_method, got 3")
+    end
+  end
+
+  describe "should have_exactly(n).items" do
+  
+    it "should pass if target has a collection of items with n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have_exactly(3).items_in_collection_with_length_method
+      owner.should have_exactly(3).items_in_collection_with_size_method
+    end
+
+    it "should convert :no to 0" do
+      owner = create_collection_owner_with(0)
+      owner.should have_exactly(:no).items_in_collection_with_length_method
+      owner.should have_exactly(:no).items_in_collection_with_size_method
+    end
+
+    it "should fail if target has a collection of items with < n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have_exactly(4).items_in_collection_with_length_method
+      }.should fail_with("expected 4 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have_exactly(4).items_in_collection_with_size_method
+      }.should fail_with("expected 4 items_in_collection_with_size_method, got 3")
+    end
+  
+    it "should fail if target has a collection of items with > n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have_exactly(2).items_in_collection_with_length_method
+      }.should fail_with("expected 2 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have_exactly(2).items_in_collection_with_size_method
+      }.should fail_with("expected 2 items_in_collection_with_size_method, got 3")
+    end
+  end
+
+  describe "should have_at_least(n).items" do
+  
+    it "should pass if target has a collection of items with n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have_at_least(3).items_in_collection_with_length_method
+      owner.should have_at_least(3).items_in_collection_with_size_method
+    end
+  
+    it "should pass if target has a collection of items with > n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have_at_least(2).items_in_collection_with_length_method
+      owner.should have_at_least(2).items_in_collection_with_size_method
+    end
+
+    it "should fail if target has a collection of items with < n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have_at_least(4).items_in_collection_with_length_method
+      }.should fail_with("expected at least 4 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have_at_least(4).items_in_collection_with_size_method
+      }.should fail_with("expected at least 4 items_in_collection_with_size_method, got 3")
+    end
+  
+    it "should provide educational negative failure messages" do
+      #given
+      owner = create_collection_owner_with(3)
+      length_matcher = have_at_least(3).items_in_collection_with_length_method
+      size_matcher = have_at_least(3).items_in_collection_with_size_method
+    
+      #when
+      length_matcher.matches?(owner)
+      size_matcher.matches?(owner)
+    
+      #then
+      length_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_least(3).items_in_collection_with_length_method
+We recommend that you use this instead:
+  should have_at_most(2).items_in_collection_with_length_method
+EOF
+
+      size_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_least(3).items_in_collection_with_size_method
+We recommend that you use this instead:
+  should have_at_most(2).items_in_collection_with_size_method
+EOF
+    end
+  end
+
+  describe "should have_at_most(n).items" do
+  
+    it "should pass if target has a collection of items with n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have_at_most(3).items_in_collection_with_length_method
+      owner.should have_at_most(3).items_in_collection_with_size_method
+    end
+
+    it "should fail if target has a collection of items with > n members" do
+      owner = create_collection_owner_with(3)
+      lambda {
+        owner.should have_at_most(2).items_in_collection_with_length_method
+      }.should fail_with("expected at most 2 items_in_collection_with_length_method, got 3")
+      lambda {
+        owner.should have_at_most(2).items_in_collection_with_size_method
+      }.should fail_with("expected at most 2 items_in_collection_with_size_method, got 3")
+    end
+  
+    it "should pass if target has a collection of items with < n members" do
+      owner = create_collection_owner_with(3)
+      owner.should have_at_most(4).items_in_collection_with_length_method
+      owner.should have_at_most(4).items_in_collection_with_size_method
+    end
+
+    it "should provide educational negative failure messages" do
+      #given
+      owner = create_collection_owner_with(3)
+      length_matcher = have_at_most(3).items_in_collection_with_length_method
+      size_matcher = have_at_most(3).items_in_collection_with_size_method
+    
+      #when
+      length_matcher.matches?(owner)
+      size_matcher.matches?(owner)
+    
+      #then
+      length_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_most(3).items_in_collection_with_length_method
+We recommend that you use this instead:
+  should have_at_least(4).items_in_collection_with_length_method
+EOF
+    
+      size_matcher.negative_failure_message.should == <<-EOF
+Isn't life confusing enough?
+Instead of having to figure out the meaning of this:
+  should_not have_at_most(3).items_in_collection_with_size_method
+We recommend that you use this instead:
+  should have_at_least(4).items_in_collection_with_size_method
+EOF
+    end
+  end
+
+  describe "have(n).items(args, block)" do
+    it "should pass args to target" do
+      target = mock("target")
+      target.expects(:items).with("arg1","arg2").returns([1,2,3])
+      target.should have(3).items("arg1","arg2")
+    end
+
+    it "should pass block to target" do
+      target = mock("target")
+      block = lambda { 5 }
+      target.expects(:items).with("arg1","arg2", block).returns([1,2,3])
+      target.should have(3).items("arg1","arg2", block)
+    end
+  end
+
+  describe "have(n).items where target IS a collection" do
+    it "should reference the number of items IN the collection" do
+      [1,2,3].should have(3).items
+    end
+
+    it "should fail when the number of items IN the collection is not as expected" do
+      lambda { [1,2,3].should have(7).items }.should fail_with("expected 7 items, got 3")
+    end
+  end
+
+  describe "have(n).characters where target IS a String" do
+    it "should pass if the length is correct" do
+      "this string".should have(11).characters
+    end
+
+    it "should fail if the length is incorrect" do
+      lambda { "this string".should have(12).characters }.should fail_with("expected 12 characters, got 11")
+    end
+  end
+
+  describe "have(n).things on an object which is not a collection nor contains one" do
+    it "should fail" do
+      lambda { Object.new.should have(2).things }.should raise_error(NoMethodError, /undefined method `things' for #<Object:/)
+    end
+  end
+
+  describe Micronaut::Matchers::Have, "for a collection owner that implements #send" do
+  
+    before do
+      @collection = Object.new
+      def @collection.floozles; [1,2] end
+      def @collection.send(*args); raise "DOH! Library developers shouldn't use #send!" end
+    end
+  
+    it "should work in the straightforward case" do
+      lambda {
+        @collection.should have(2).floozles
+      }.should_not raise_error
+    end
+
+    it "should work when doing automatic pluralization" do
+      lambda {
+        @collection.should have_at_least(1).floozle
+      }.should_not raise_error
+    end
+
+    it "should blow up when the owner doesn't respond to that method" do
+      lambda {
+        @collection.should have(99).problems
+      }.should raise_error(NoMethodError, /problems/)
+    end
+  end
+
+  describe Micronaut::Matchers::Have do
+    it "should have method_missing as private" do
+      with_ruby '1.8' do
+        Micronaut::Matchers::Have.private_instance_methods.should include("method_missing")
+      end
+      with_ruby '1.9' do
+        Have.private_instance_methods.should include(:method_missing)
+      end
+    end
+  
+    describe "respond_to?" do
+
+      before do
+        @have = Micronaut::Matchers::Have.new(:foo)
+        @a_method_which_have_defines = Micronaut::Matchers::Have.instance_methods.first
+        @a_method_which_object_defines = Object.instance_methods.first
+      end
+    
+      it "should be true for a method which Have defines" do
+        @have.should respond_to(@a_method_which_have_defines)
+      end
+    
+      it "should be true for a method that it's superclass (Object) defines" do
+        @have.should respond_to(@a_method_which_object_defines)
+      end
+    
+      it "should be false for a method which neither Object nor nor Have defines" do
+        @have.should_not respond_to(:foo_bar_baz)
+      end
+    
+      it "should be false if the owner doesn't respond to the method" do
+        have = Micronaut::Matchers::Have.new(99)
+        have.should_not respond_to(:problems)
+      end
+    
+      it "should be true if the owner responds to the method" do
+        have = Micronaut::Matchers::Have.new(:a_symbol)
+        have.should respond_to(:to_sym)
+      end
+
+    end
+
+  end
+  
+end