joshng-zebra 0.1.1

data/README.rdoc

@@ -0,0 +1,61 @@
+= Zebra
+
+One line tests without the smells.
+
+= The problem
+
+  context "A blog post" do
+    setup do
+      @author = create_person
+      @post   = create_post :author => @author
+    end
+
+    should "be editable by its author" do
+      assert @post.editable_by?(@author)
+    end
+  end
+
+== Don't see the problem?
+
+Why bother writing self-documenting test code if you always have to explain it to the reader? {Test names are essentially glorified comments}[http://blog.jayfields.com/2008/05/testing-value-of-test-names.html] and {comments are frequently code smells}[http://memeagora.blogspot.com/2008/11/comments-code-smell.html]. Furthermore, all the extra code required to create a test (should "" do ... end) almost certainly discourages one assertion per test. If the assertion is one line and the code can explain itself, why bother with all the other crap?
+
+== The Solution
+
+  context "With a blog post" do
+    setup do
+      @author        = create_person
+      @somebody_else = create_person
+      @post          = create_post :author => @author
+    end
+
+    expect { @post.to be_editable_by(@author) }
+    expect { @post.not_to be_editable_by(@somebody_else) }
+  end
+
+== But, what about the test name?
+
+I'm glad you asked. This is where zebra gets really cool. The above test will create tests with the following names:
+
+  test: With a blog post expect @post.to(be_editable_by(@author))
+  test: With a blog post expect @post.not_to(be_editable_by(@author))
+
+Now, *that* is self documenting code.
+
+== The right tool for the job
+
+The cool thing about zebra is that it's an extension to test/unit. If you have a test that belongs in a should block, with a big, old-fashioned test name, you can have it. Just use should or it. When you have a short, self-documenting test, use expect. Best of both worlds.
+
+== Dependencies
+
+  - jeremymcanally-context or shoulda
+  - jeremymcanally-matchy
+  - parse_tree
+  - ruby2ruby
+
+== Inspiration
+
+{Jay Fields' Expectations}[http://blog.jayfields.com/2007/12/ruby-expectation-gem.html]
+
+== COPYRIGHT
+
+Copyright (c) 2008 {James Golick}[http://jamesgolick.com]. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 1

data/lib/zebra/shoulda.rb

@@ -0,0 +1,42 @@
+module Zebra
+  module ShouldaSupport
+    def self.included(klass)
+      klass.class_eval do
+        attr_accessor :expects
+
+        alias_method :build_without_expects, :build 
+        alias_method :build, :build_with_expects
+      end
+    end
+
+    def expect(&block)
+      self.expects ||= []
+      self.expects << block
+    end
+
+    def create_test_from_expect(&block)
+      test_name = expect_test_name(full_name, &block)
+
+      if test_unit_class.instance_methods.include?(test_name.to_s)
+        warn "  * WARNING: '#{test_name}' is already defined"
+      end
+
+      context = self
+      test_unit_class.send(:define_method, test_name) do
+        begin
+          context.run_parent_setup_blocks(self)
+          context.run_current_setup_blocks(self)
+          block.bind(self).call
+        ensure
+          context.run_all_teardown_blocks(self)
+        end
+      end
+    end
+
+    def build_with_expects
+      (expects || []).each { |e| create_test_from_expect(&e) }
+      build_without_expects
+    end
+  end
+end
+

data/lib/zebra.rb

@@ -0,0 +1,49 @@
+require 'test/unit'
+require 'matchy'
+require 'parse_tree'
+require 'parse_tree_extensions'
+require 'ruby2ruby'
+require File.dirname(__FILE__) + '/zebra/shoulda'
+
+module Zebra
+  class << self
+    def shoulda?
+      defined?(Shoulda)
+    end
+  end
+
+  def expect(&block)
+    Zebra.shoulda? ? expect_shoulda(&block) : expect_context(&block)
+  end
+
+  protected
+    def expect_shoulda(&block)
+      Shoulda::Context.send(:include, Zebra::ShouldaSupport) unless Shoulda::Context.include?(Zebra::ShouldaSupport)
+
+      if Shoulda.current_context
+        Shoulda.current_context.expect(&block)
+      else
+        context_name = self.name.gsub(/Test/, "")
+        context      = Shoulda::Context.new(context_name, self) do
+          expect(&block)
+        end
+        context.build
+      end
+    end
+
+    def expect_context(&block)
+      define_method(expect_test_name(context_name, &block), &block)
+    end
+
+    def expect_test_name(context_name, &block)
+      block_translation = block.to_ruby.gsub /proc \{ (.+?) \}/, '\1'
+      test_name         = ["test:", context_name, "expect", block_translation]
+      test_name.reject! { |s| s == "" }
+
+      test_name.join(' ')
+    end
+end
+
+Test::Unit::TestCase.send(:extend, Zebra)
+Object.send(:alias_method, :to, :should)
+Object.send(:alias_method, :not_to, :should_not)

data/test/context/context_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'context'
+
+class ContextTest < Test::Unit::TestCase
+  def setup
+    Zebra.stubs(:shoulda?).returns(false)
+  end
+
+  it "should create a test" do
+    self.class.expect { 2.to == 1 }
+    assert self.respond_to?("test: expect (2.to == 1)")
+  end
+
+  context "in a context" do
+    it "should grab the name of the context" do
+      self.class.expect { 2.to == 1 }
+      assert self.respond_to?("test: in a context expect (2.to == 1)"), self.class.instance_methods.grep(/test/).inspect
+    end
+  end
+end
+

data/test/else/matchy_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'context'
+
+class MatchyTest < Test::Unit::TestCase
+  it "should alias should to .to" do
+    assert_equal Object.method(:should), Object.method(:to)
+  end
+
+  it "should alias should_not to .not_to" do
+    assert_equal Object.method(:should_not), Object.method(:not_to)
+  end
+end
+

data/test/shoulda/shoulda_test.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require 'shoulda'
+
+class ShouldaTest < Test::Unit::TestCase
+  def setup
+    Zebra.stubs(:shoulda?).returns(true)
+  end
+
+  should "create a test" do
+    self.class.expect { 2.to == 1 }
+    assert self.respond_to?("test: Shoulda expect (2.to == 1)"), self.class.instance_methods.grep(/test/).inspect
+  end
+
+  context "in a context" do
+    expect { true }
+    should "grab the name of the context" do
+      assert self.respond_to?("test: in a context expect true"), self.class.instance_methods.grep(/test/).inspect
+    end
+  end
+
+  context "A context with no expects" do
+    should "not raise any exceptions" do
+      true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/zebra'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: joshng-zebra
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- James Golick
+- Josh Gruenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-matchy
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
+description: TODO
+email: joshngru@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/zebra
+- lib/zebra/shoulda.rb
+- lib/zebra.rb
+- test/context
+- test/context/context_test.rb
+- test/else
+- test/else/matchy_test.rb
+- test/shoulda
+- test/shoulda/shoulda_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/joshng/zebra
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+