behaviors 1.0.0

data/lib/behaviors.rb

@@ -0,0 +1,50 @@
+=begin rdoc
+= Usage
+Behaviors provides a single method: should.
+
+Your test classes should <tt>extend Behaviors</tt>. 
+  
+Instead of naming test methods like:
+
+ def test_something
+ end
+
+You declare test methods like:
+
+ should "perform action" do
+ end
+
+You also have the ability to declare flunking test methods as a way
+to describe future tests:
+
+ should "perform other action"
+
+= Motivation
+Test methods typically focus on the name of the method under test instead of its behavior.
+
+Creating test methods with <tt>should</tt> statements focuses on the behaviors of an object.
+This enhances the TDD experience by provoking the developer to think about the role of the object under test.
+
+Writing the tests first to declare an object's behaviors and then implementing those
+behaviors through object methods produces the most value.
+Using this behavior-driven approach prevents the dangers associated with assuming a one-to-one mapping of method names to 
+test method names.
+
+For a more complete BDD framework, try RSpec http://rspec.rubyforge.org/
+  
+= Rake tasks
+
+Behaviors includes a pair of Rake tasks, <tt>behaviors</tt> and <tt>behaviors_html</tt>.  These tasks will output to the
+console or an html file in the <tt>doc</tt> directory with a list all of your <tt>should</tt> tests.
+Use these tasks to summarize the behavior of your project.
+=end
+module Behaviors
+  def should(behave,&block)
+    mname = "test_should_#{behave}"
+    if block
+      define_method mname, &block
+    else
+      puts ">>> UNIMPLEMENTED CASE: #{name.sub(/Test$/,'')} should #{behave}"
+    end
+  end
+end

data/test/behaviors_tasks_test.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+
+APP_ROOT = File.expand_path(File.dirname(__FILE__) + '/../')
+
+class BehaviorsTasksTest < Test::Unit::TestCase
+
+  def setup
+    here = File.expand_path(File.dirname(__FILE__))
+    cmd = RUBY_PLATFORM[/mswin/] ? 'rake.cmd' : 'rake'
+    @base_cmd = "#{cmd} -f \"#{here}/tasks_test/Rakefile\" "    
+  end 
+
+  #
+  # HELPERS
+  #
+  def run_behaviors_task
+    run_cmd "behaviors"
+  end
+
+  def run_behaviors_html_task
+    run_cmd "behaviors_html"
+  end
+
+  def run_cmd(cmd)
+    @report = %x[ #{@base_cmd} #{cmd} ]
+  end
+
+  def see_html_task_output_message
+    @html_output_filename = "#{APP_ROOT}/test/tasks_test/doc/behaviors.html"
+    assert_match /Wrote #{@html_output_filename}/, @report
+  end
+
+  def see_that_html_report_file_exits
+    assert File.exists?(@html_output_filename), "html output file should exist"
+  end
+
+  def html_report_file_should_contain(user_behaviors)
+    file_contents = File.read(@html_output_filename)
+    user_behaviors.each do |line|
+      assert_match /#{line}/, file_contents
+    end
+  end
+
+  #
+  # TESTS
+  #
+  def test_that_behaviors_tasks_should_list_behavioral_definitions_for_the_classes_under_test
+    run_behaviors_task
+    user_behaviors = [
+    "User should:",
+    " - be able set user name and age during construction",
+    " - be able to get user name and age",
+    " - be able to ask if a user is an adult"
+    ]
+    assert_match /#{user_behaviors.join("\n")}/, @report
+  end
+
+  def test_that_behaviors_tasks_should_list_behavioral_definitions_for_the_classes_under_test_in_html_output
+    run_behaviors_html_task
+    see_html_task_output_message
+    see_that_html_report_file_exits
+    user_behaviors = [
+      "User should:",
+      "be able set user name and age during construction",
+      "be able to get user name and age",
+      "be able to ask if a user is an adult"
+    ]
+    html_report_file_should_contain user_behaviors
+  end
+
+end

data/test/behaviors_test.rb

@@ -0,0 +1,50 @@
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/behaviors'
+require 'stringio'
+
+loading_developer_test_class_stdout = StringIO.new
+saved_stdout = $stdout.dup
+$stdout = loading_developer_test_class_stdout
+
+class DeveloperTest
+  extend Behaviors
+  attr_accessor :flunk_msg, :tested_code
+
+  should "test their code" do
+    @tested_code = true
+  end
+  should "go to meetings"
+end
+
+$stdout = saved_stdout
+loading_developer_test_class_stdout.rewind
+$loading_developer_test_class_output = loading_developer_test_class_stdout.read
+
+class BehaviorsTest < Test::Unit::TestCase
+
+
+  def setup
+    @target = DeveloperTest.new
+    assert_nil @target.tested_code, "block called too early"
+  end
+
+  #
+  # TESTS
+  #
+  def test_should_called_with_a_block_defines_a_test
+    assert @target.methods.include?("test_should_test their code"), "Missing test method"
+
+    @target.send("test_should_test their code")
+
+    assert @target.tested_code, "block not called"
+  end
+
+  def test_should_called_without_a_block_does_not_create_a_test_method
+    assert !@target.methods.include?("test_should_go to meetings"), "Should not have method"
+  end
+
+  def test_should_called_without_a_block_will_give_unimplemented_output_when_class_loads
+    unimplemented_output = "UNIMPLEMENTED CASE: Developer should go to meetings"
+    assert_match /#{unimplemented_output}/, $loading_developer_test_class_output
+  end
+end

data/test/tasks_test/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+require 'rake/testtask'
+
+APP_ROOT = File.expand_path(File.dirname(__FILE__))
+load "#{APP_ROOT}/../../tasks/behaviors_tasks.rake"
+
+cd APP_ROOT
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "#{APP_ROOT}/../../lib"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/test/tasks_test/doc/behaviors.html

@@ -0,0 +1,55 @@
+  <html>
+  <head>
+  <style>
+
+  div.title
+  {
+    width: 600px;
+    font: bold 14pt trebuchet ms;
+  }
+
+  div.specification 
+  {
+    font: bold 12pt trebuchet ms;
+    border: solid 1px black;
+    width: 600px;
+    padding: 5px;
+    margin: 5px;
+  }
+
+  ul.requirements
+  {
+    font: normal 11pt verdana;
+    padding-left: 0;
+    margin-left: 0;
+    border-bottom: 1px solid gray;
+    width: 600px;
+  }
+
+  ul.requirements li
+  {
+    list-style: none;
+    margin: 0;
+    padding: 0.25em;
+    border-top: 1px solid gray;
+  }
+  </style>
+  </head>
+  <body>
+  <div class="title">Specifications for tasks_test</div>
+  
+  <div class="specification">
+  User should: 
+  <ul class="requirements">
+  
+  <li>be able set user name and age during construction</li>
+  
+  <li>be able to get user name and age</li>
+  
+  <li>be able to ask if a user is an adult</li>
+  
+  </ul>
+  </div>
+  
+  </body>
+  </html>

data/test/tasks_test/lib/user.rb

@@ -0,0 +1,2 @@
+class User
+end

data/test/tasks_test/test/user_test.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'behaviors'
+
+require 'user'
+
+class UserTest < Test::Unit::TestCase
+  extend Behaviors
+
+  def setup
+  end
+
+  should "be able set user name and age during construction"
+  should "be able to get user name and age"
+  should "be able to ask if a user is an adult"
+  def test_DELETEME
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: behaviors
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-10-19 00:00:00 -04:00
+summary: behavior-driven unit test helper
+require_paths: 
+- lib
+email: dev@atomicobject.com
+homepage: http://atomicobject.com
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Atomic Object LLC
+files: 
+- test/behaviors_tasks_test.rb
+- test/behaviors_test.rb
+- test/tasks_test
+- test/tasks_test/doc
+- test/tasks_test/lib
+- test/tasks_test/Rakefile
+- test/tasks_test/test
+- test/tasks_test/doc/behaviors.html
+- test/tasks_test/lib/user.rb
+- test/tasks_test/test/user_test.rb
+- lib/behaviors.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+