stendhal 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stendhal (0.0.1)
+    stendhal (0.1.0)
 
 GEM
   remote: http://rubygems.org/

data/Readme.md

@@ -6,24 +6,50 @@ Currently under development, there is only basic functionality for now.
 Below I will be posting whatever features are available throughout the
 development.
 
+##Current features
+
+* Nested example groups
+* Pending examples
+* Lame reporter (but will get better eventually)
+* Matchers (use with object.must or object.must_not)
+    eq() / eql()
+    be_a() / be_kind_of() / be_a_kind_of()
+    be_whatever # asks object.whatever?
+
+
 ##Installation
 
     gem install stendhal
 
 ##Usage
 
-    # your spec file for some class - my_class_spec.rb
+    # your spec file for some class - foo_spec.rb
 
-    describe "My fancy class" do
+    describe "Foo" do
 
       it "does something" do
         my_object = MyClass.new
-        my_object.fancy = true
+        my_object.must be_a(MyClass) 
+      end
 
-        assert my_object.fancy
+      
+      it "fails when 7 is not 9" do
+        (3 + 4).must eq(9)
       end
 
-      describe "Additional functionality" do
+      it "asks for a kind of object" do
+        "string".must be_a(String)
+      end
+
+      it "asks things to objects" do
+        "string".must be_frozen
+      end
+
+      it "has common sense" do
+        "string".must_not eq(3)
+      end
+
+      describe "Pending examples" do
 
         it "should do something but I don't know what yet"
 
@@ -38,18 +64,24 @@ development.
 
 ###Running the specs!
 
-    stendhal my_class_spec.rb
+    stendhal foo_spec.rb
 
 ###And the output...
 
-    My fancy class
+    Foo
     * does something
-
-    Additional functionality
+    * fails when 7 is not 9 [FAILED]
+            expected 7 to equal 9
+    * asks for a kind of object
+    * asks things to objects [FAILED]
+            expected "string" to be frozen
+    * has common sense
+
+    Pending examples
     * should do something but I don't know what yet
     * will do something else
 
-    3 examples, 0 failures, 2 pending
+    7 examples, 2 failures, 2 pending
 
 ##Note on Patches/Pull Requests
  

data/features/examples.feature

@@ -1,15 +1,15 @@
 Feature: Examples and example groups
 
-  Spec-ish Domain Specific Language
+  RSpec-ish Domain Specific Language
 
   Scenario: declare an example
-    Given a directory named "rspec_project"
-    When I cd to "rspec_project"
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
     Given a file named "sample_spec.rb" with:
     """
       describe "something" do
         it "does something" do
-          assert true
+          # put your code here 
         end
       end
     """
@@ -18,29 +18,30 @@ Feature: Examples and example groups
     And the output should contain "1 example, 0 failures"
 
   Scenario: declare a failing example
-    Given a directory named "rspec_project"
-    When I cd to "rspec_project"
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
     Given a file named "sample_spec.rb" with:
     """
       describe "something" do
         it "does something" do
-          assert false
+          fail "this is not what I expected"
         end
       end
     """
     When I run "stendhal sample_spec.rb"
     Then the exit status should be 0
-    And the output should contain "* does something"
+    And the output should contain "* does something [FAILED]"
+    And the output should contain "this is not what I expected"
     And the output should contain "1 example, 1 failure"
 
   Scenario: declare a pending example
-    Given a directory named "rspec_project"
-    When I cd to "rspec_project"
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
     Given a file named "sample_spec.rb" with:
     """
       describe "something" do
         pending "does something" do
-          assert false
+          fail "this is not what I expected"
         end
       end
     """
@@ -50,14 +51,14 @@ Feature: Examples and example groups
     And the output should contain "1 example, 0 failures, 1 pending"
 
   Scenario: declare an example in nested groups
-    Given a directory named "rspec_project"
-    When I cd to "rspec_project"
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
     Given a file named "sample_spec.rb" with:
     """
       describe "something" do
         describe "inside another thing" do
           it "does this" do
-            assert true
+            # put your code here
           end
         end
       end
@@ -70,22 +71,22 @@ Feature: Examples and example groups
     And the output should contain "1 example, 0 failures"
 
   Scenario: many examples in different example groups
-    Given a directory named "rspec_project"
-    When I cd to "rspec_project"
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
     Given a file named "sample_spec.rb" with:
     """
       describe "something" do
         describe "inside another thing" do
           it "does this" do
-            assert true
+            # put your code here
           end
         end
         describe "pending" do
           pending "todo" do
-            assert false
+            # put your code here
           end
           it "fails" do
-            assert false
+            fail "indeed"
           end
         end
       end
@@ -97,5 +98,6 @@ Feature: Examples and example groups
     And the output should contain "* does this"
     And the output should contain "pending"
     And the output should contain "* todo"
-    And the output should contain "* fails"
+    And the output should contain "* fails [FAILED]"
+    And the output should contain "indeed"
     And the output should contain "3 examples, 1 failure, 1 pending"

data/features/expectations.feature

@@ -0,0 +1,119 @@
+Feature: Expectations
+
+  Stendhal comes with some built-in expectations.
+
+  Scenario: equality expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          (3 + 4).must eq(7)
+          6.must_not eql(7)
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures"
+
+  Scenario: failed equality expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          (3 + 4).must eql(4)
+
+        end
+        it "does something else" do
+
+          4.must_not eq(4)
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "expected 7 to equal 4"
+    And the output should contain "expected 4 to be different than 4"
+    And the output should contain "2 examples, 2 failures"
+
+  Scenario: kind_of expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          6.must be_a(Fixnum)
+          6.must be_kind_of(Fixnum)
+          6.must be_kind_of(Fixnum)
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures"
+
+  Scenario: failed kind_of expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          6.must_not be_a(Fixnum)
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "expected 6 not to be a Fixnum"
+    And the output should contain "1 example, 1 failure"
+
+  Scenario: predicate expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          str = "String".freeze
+          str.must be_frozen
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures"
+
+  Scenario: failed predicate expectations
+    Given a directory named "stendhal_project"
+    When I cd to "stendhal_project"
+    Given a file named "sample_spec.rb" with:
+    """
+      describe "something" do
+        it "does something" do
+
+          hash = {:number => 3}.freeze
+          hash.must_not be_frozen
+
+        end
+      end
+    """
+    When I run "stendhal sample_spec.rb"
+    Then the exit status should be 0
+    And the output should contain "expected {:number=>3} not to be frozen"
+    And the output should contain "1 example, 1 failure"

data/lib/stendhal/core_ext/kernel.rb

@@ -2,4 +2,10 @@ module Kernel
   def describe(*args,&blk)
     Stendhal::ExampleGroup.new(*args,&blk)
   end
+  def must(matcher)
+    matcher.match self
+  end
+  def must_not(matcher)
+    matcher.match self, :negative => true
+  end
 end

data/lib/stendhal/dsl.rb

@@ -1,5 +1,6 @@
 module Stendhal
   module DSL
+
     module Example
       def it(*args,&blk)
         self.add_example Stendhal::Example.new(*args,&blk)
@@ -14,6 +15,7 @@ module Stendhal
         self.add_example Stendhal::Example.new(*args,options,&blk)
       end
     end
+
   end
 end
 

data/lib/stendhal/example.rb

@@ -1,11 +1,12 @@
 module Stendhal
   class Example
-    include Assertions
+    include Matchers
 
     @@examples = []
 
     attr_reader :description
     attr_reader :block
+    attr_reader :failed_message
 
     def initialize(docstring, options = {}, &block)
       @description = docstring
@@ -18,8 +19,9 @@ module Stendhal
       begin
         self.instance_eval(&@block)
         return 0
-      rescue AssertionFailed=>e
+      rescue Exceptions::ExpectationNotMet=>e
         @failed = true
+        @failed_message = e.message
         return 1
       rescue StandardError=>e
         @aborted = true
@@ -43,6 +45,10 @@ module Stendhal
       @@examples.delete self
     end
 
+    def fail(message = 'failed')
+      raise Stendhal::Exceptions::ExpectationNotMet.new(message)
+    end
+
     class << self
 
       def destroy_all

data/lib/stendhal/example_group.rb

@@ -26,7 +26,8 @@ module Stendhal
         end
       end.each do |example|
         failures += example.run
-        $stdout.print "* #{example.description}\n"
+        $stdout.print "* #{example.description}#{' [FAILED]' if example.failed?}\n"
+        $stdout.print "\t#{example.failed_message}\n"
       end
       [examples.count, failures, pending]
     end

data/lib/stendhal/exceptions.rb

@@ -0,0 +1,5 @@
+module Stendhal
+  module Exceptions
+    class ExpectationNotMet < StandardError; end
+  end
+end

data/lib/stendhal/matchers/abstract_matcher.rb

@@ -0,0 +1,16 @@
+module Stendhal
+  module Matchers
+    class AbstractMatcher
+      attr_reader :target
+
+      def initialize(target)
+        @target = target
+      end
+
+      def match(original, options = {})
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/stendhal/matchers/equality.rb

@@ -0,0 +1,17 @@
+module Stendhal
+  module Matchers
+    class Equality < AbstractMatcher
+
+      def match(original, options = {})
+        message = "expected #{original.inspect} #{options[:negative] ? 'to be different than' : 'to equal'} #{@target.inspect}"
+        if options[:negative]
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) if @target == original
+        else
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) unless @target == original
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/stendhal/matchers/kind.rb

@@ -0,0 +1,17 @@
+module Stendhal
+  module Matchers
+    class Kind < AbstractMatcher
+
+      def match(original, options = {})
+        message = "expected #{original.inspect} #{options[:negative] ? 'not ' : ''}to be a #{@target.inspect}"
+        if options[:negative]
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) if original.is_a?(@target)
+        else
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) unless original.is_a?(@target)
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/stendhal/matchers/predicate.rb

@@ -0,0 +1,17 @@
+module Stendhal
+  module Matchers
+    class Predicate < AbstractMatcher
+
+      def match(original, options = {})
+        message = "expected #{original.inspect} #{options[:negative] ? 'not ' : ''}to be #{@target.to_s.gsub('?','')}"
+        if options[:negative]
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) if original.send(@target)
+        else
+          raise Stendhal::Exceptions::ExpectationNotMet.new(message) unless original.send(@target)
+        end
+        true
+      end
+
+    end
+  end
+end

data/lib/stendhal/matchers.rb

@@ -0,0 +1,25 @@
+require 'stendhal/matchers/abstract_matcher'
+require 'stendhal/matchers/equality'
+require 'stendhal/matchers/kind'
+require 'stendhal/matchers/predicate'
+
+module Stendhal
+  module Matchers
+    def eq(other)
+      Equality.new(other)
+    end
+    alias_method :eql, :eq
+
+    def be_a(kind)
+      Kind.new(kind)
+    end
+    alias_method :be_kind_of, :be_a
+    alias_method :be_a_kind_of, :be_a
+
+    def method_missing(m,*args)
+      if m.to_s =~ /be_(\w+)/
+        Predicate.new(($1 + '?').to_sym)
+      end
+    end
+  end
+end

data/lib/stendhal/version.rb

@@ -1,3 +1,3 @@
 module Stendhal
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/stendhal.rb

@@ -1,4 +1,5 @@
-require 'stendhal/assertions'
+require 'stendhal/exceptions'
+require 'stendhal/matchers'
 require 'stendhal/example'
 require 'stendhal/example_group'
 

data/spec/stendhal/example_group_spec.rb

@@ -38,13 +38,13 @@ module Stendhal
         @group = ExampleGroup.new("group")
         4.times do
           example = Example.new("some example") do
-            assert true
+            true
           end
           @runnable_examples << example
           @group.add_example example
         end
         @failing_example = Example.new("failing") do
-          assert false
+          fail "this example fails just because"
         end
         @group.add_example @failing_example
         @pending_example = Example.new("pending")

data/spec/stendhal/example_spec.rb

@@ -32,13 +32,14 @@ module Stendhal
         example.run
       end
 
-      it "captures failed assertions" do
+      it "captures unmet expectations" do
         example = Example.new("docstring") do
-          assert false
+          raise Stendhal::Exceptions::ExpectationNotMet.new("expected this example to be awesome")
         end
         expect {example.run}.to_not raise_error
         example.run
         example.should be_failed
+        example.failed_message.should == "expected this example to be awesome"
       end
 
       it "captures exceptions" do
@@ -52,6 +53,17 @@ module Stendhal
 
     end
 
+    describe "#fail" do
+      it 'fails with a given message' do
+        example = Example.new("docstring") do
+          fail "expectation not awesome enough"
+        end
+        example.run
+        example.should be_failed
+        example.failed_message.should == "expectation not awesome enough"
+      end
+    end
+
     describe "class methods" do
       describe "#count" do
         it "returns the number of examples in memory" do

data/spec/stendhal/matchers/abstract_matcher_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Stendhal
+  module Matchers
+    describe AbstractMatcher do
+      
+      it 'initializes with a target' do
+        matcher = AbstractMatcher.new("target")    
+        matcher.target.should == "target"
+      end
+
+      it 'does not implement #match' do
+        matcher = AbstractMatcher.new("target")    
+        expect { matcher.match("whatever") }.to raise_error(NotImplementedError)
+      end
+
+    end
+  end
+end

data/spec/stendhal/matchers/equality_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module Stendhal
+  module Matchers
+    describe Equality do
+     
+      describe "#match" do
+        it 'passes when original and target objects are equivalent' do
+          matcher = Equality.new("string")
+          matcher.match("string").should be_true
+        end
+
+        it 'fails when original and target objects are unequivalent' do
+          matcher = Equality.new("string")
+          expected_message = %q{expected "other string" to equal "string"}
+          expect {
+            matcher.match("other string")
+          }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+        end
+
+        context "with :negative => true" do
+
+          it 'passes when found unequivalence' do
+            matcher = Equality.new("string")
+            matcher.match("other string", :negative => true).should be_true
+          end
+
+          it 'fails otherwise' do
+            matcher = Equality.new("string")
+            expected_message = %q{expected "string" to be different than "string"}
+            expect {
+              matcher.match("string", :negative => true)
+            }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+          end
+
+        end
+      end
+
+    end
+  end
+end

data/spec/stendhal/matchers/kind_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Stendhal
+  module Matchers
+    describe Kind do
+     
+      describe "#match" do
+        it 'passes when original is a subclass of target' do
+          matcher = Kind.new(Numeric)
+          matcher.match(3).should be_true
+        end
+
+        it 'fails otherwise' do
+          matcher = Kind.new(Fixnum)
+          expected_message = %q{expected 3.2 to be a Fixnum}
+          expect {
+            matcher.match(3.2)
+          }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+        end 
+
+        context "with :negative => true" do
+
+          it 'passes when original is not a subclass of target' do
+            matcher = Kind.new(Numeric)
+            matcher.match("string", :negative => true).should be_true
+          end
+
+          it 'fails otherwise' do
+            matcher = Kind.new(Numeric)
+            expected_message = %q{expected 3 not to be a Numeric}
+            expect {
+              matcher.match(3, :negative => true)
+            }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+          end
+
+        end
+        
+      end
+
+    end
+  end
+end

data/spec/stendhal/matchers/predicate_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Stendhal
+  module Matchers
+    describe Predicate do
+     
+      describe "#match" do
+        it 'passes when original responds to target returning true' do
+          matcher = Predicate.new(:frozen?)
+          matcher.match("string".freeze).should be_true
+        end
+
+        it 'fails when it returns false' do
+          matcher = Predicate.new(:frozen?)
+          expected_message = %q{expected "string" to be frozen}
+          expect {
+            matcher.match("string")
+          }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+        end
+
+        context "with :negative => true" do
+
+          it 'passes when original returns false when sent target' do
+            matcher = Predicate.new(:frozen?)
+            matcher.match("string", :negative => true).should be_true
+          end
+
+          it 'fails otherwise' do
+            matcher = Predicate.new(:frozen?)
+            expected_message = %q{expected "string" not to be frozen}
+            expect {
+              matcher.match("string".freeze, :negative => true)
+            }.to raise_error(Stendhal::Exceptions::ExpectationNotMet, expected_message)
+          end
+
+        end
+        
+      end
+
+    end
+  end
+end

data/spec/stendhal/matchers_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class MyClass
+  include Stendhal::Matchers
+end
+
+module Stendhal
+  describe "a class with included Matchers" do
+  
+    let(:object) { MyClass.new }
+     
+    describe "#==" do
+      it 'creates a new equality expectation' do
+        Matchers::Equality.should_receive(:new).with(7)
+        object == 7
+      end
+    end
+
+    describe "#be_a" do
+      it 'creates a new kind expectation' do
+        Matchers::Kind.should_receive(:new).with(Fixnum)
+        object.be_a(Fixnum)
+      end
+    end
+
+    describe "#be_whatever" do
+      it 'creates a new predicate expectation' do
+        Matchers::Predicate.should_receive(:new).with(:frozen?)
+        object.be_frozen
+      end
+    end
+
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Josep M. Bach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2010-10-31 01:00:00 +02:00
 default_executable: stendhal
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,21 +90,31 @@ files:
 - Readme.md
 - bin/stendhal
 - features/examples.feature
+- features/expectations.feature
 - features/support/env.rb
 - lib/stendhal.rb
-- lib/stendhal/assertions.rb
 - lib/stendhal/autorun.rb
 - lib/stendhal/core_ext/kernel.rb
 - lib/stendhal/dsl.rb
 - lib/stendhal/example.rb
 - lib/stendhal/example_group.rb
+- lib/stendhal/exceptions.rb
+- lib/stendhal/matchers.rb
+- lib/stendhal/matchers/abstract_matcher.rb
+- lib/stendhal/matchers/equality.rb
+- lib/stendhal/matchers/kind.rb
+- lib/stendhal/matchers/predicate.rb
 - lib/stendhal/version.rb
 - script/console
 - spec/spec_helper.rb
-- spec/stendhal/assertions_spec.rb
 - spec/stendhal/core_ext/kernel_spec.rb
 - spec/stendhal/example_group_spec.rb
 - spec/stendhal/example_spec.rb
+- spec/stendhal/matchers/abstract_matcher_spec.rb
+- spec/stendhal/matchers/equality_spec.rb
+- spec/stendhal/matchers/kind_spec.rb
+- spec/stendhal/matchers/predicate_spec.rb
+- spec/stendhal/matchers_spec.rb
 - stendhal.gemspec
 has_rdoc: true
 homepage: http://rubygems.org/gems/stendhal
@@ -140,9 +150,14 @@ specification_version: 3
 summary: Stendhal is a really simple test framework.
 test_files: 
 - features/examples.feature
+- features/expectations.feature
 - features/support/env.rb
 - spec/spec_helper.rb
-- spec/stendhal/assertions_spec.rb
 - spec/stendhal/core_ext/kernel_spec.rb
 - spec/stendhal/example_group_spec.rb
 - spec/stendhal/example_spec.rb
+- spec/stendhal/matchers/abstract_matcher_spec.rb
+- spec/stendhal/matchers/equality_spec.rb
+- spec/stendhal/matchers/kind_spec.rb
+- spec/stendhal/matchers/predicate_spec.rb
+- spec/stendhal/matchers_spec.rb

data/lib/stendhal/assertions.rb

@@ -1,12 +0,0 @@
-module Stendhal
-  module Assertions
-    def assert test, msg = nil
-      msg ||= "Failed assertion, no message given."
-      unless test then
-        raise AssertionFailed, msg
-      end
-      true
-    end
-  end
-  class AssertionFailed < Exception; end
-end

data/spec/stendhal/assertions_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-class MyClass
-  include Stendhal::Assertions
-end
-
-module Stendhal
-  describe Assertions do
-    
-    subject { MyClass.new }
-
-    describe "#assert" do
-
-      it "does nothing if asserted expression returns true" do
-        subject.assert true
-      end
-
-      it "raises an AssertionFailed exception otherwise" do
-        expect { subject.assert false }.to raise_error(AssertionFailed)
-      end
-
-      it "yields a given message for the error" do
-        expect { subject.assert false, "softwared!" }.to raise_error(AssertionFailed, "softwared!")
-      end
-
-    end
-
-  end
-end