behaviors 1.0.3 → 1.99.99

data/test/behaviors_tasks_test.rb

@@ -49,10 +49,14 @@ class BehaviorsTasksTest < Test::Unit::TestCase
   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"
+      "User:",
+      " - should:",
+      "   - allow age to be changed",
+      "   - allow name to be changed",
+      " - given a constructed instance should:",
+      "   - be an adult if age is 18",
+      " - when constructing should:",
+      "   - set name and age accessors"
     ]
     assert_match(/#{user_behaviors.join("\n")}/, @report)
   end
@@ -62,10 +66,14 @@ class BehaviorsTasksTest < Test::Unit::TestCase
     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"
+      "User",
+      "should",
+      "allow age to be changed",
+      "allow name to be changed",
+      "given a constructed instance should",
+      "be an adult if age is 18",
+      "when constructing should",
+      "set name and age accessors"
     ]
     html_report_file_should_contain user_behaviors
   end

data/test/behaviors_test.rb

@@ -2,49 +2,227 @@ require 'test/unit'
 require File.expand_path(File.dirname(__FILE__)) + '/../lib/behaviors'
 require 'stringio'
 
+class Dog < Test::Unit::TestCase
+  extend Behaviors
+  attr_accessor :fed
+
+  alias_method :orig_run, :run #tuck run out of the way so DeveloperTest does not have test methods run at_exit
+  def run(result)
+  end
+
+  should 'be fed' do
+    @fed = true
+  end
+end
+
 loading_developer_test_class_stdout = StringIO.new
 saved_stdout = $stdout.dup
 $stdout = loading_developer_test_class_stdout
 
-class DeveloperTest
+class DeveloperTest < Test::Unit::TestCase
   extend Behaviors
-  attr_accessor :flunk_msg, :tested_code
 
-  should "test their code" do
-    @tested_code = true
+  attr_accessor :tests_code, :studies, :work_snack, :home_snack, 
+                :study_atmosphere, :rest_atmosphere, :unlimited_power, 
+                :work_atmosphere, :has_been_setup
+
+
+  alias_method :orig_run, :run #tuck run out of the way so DeveloperTest does not have test methods run at_exit
+  def run(result)
+  end
+
+  def setup
+    @snack = 'yogurt'
+  end
+
+  def have_unlimited_power
+    @unlimited_power = true
+  end
+
+  context 'developer at home' do
+    setup do
+      @noise_level = 'quiet'
+    end
+
+    should 'study' do
+      @studies = true
+      @home_snack = @snack
+      @study_atmosphere = @noise_level
+    end
+
+    should 'rest' do
+      @rest_atmosphere = @noise_level 
+    end
+  end
+
+  context 'developer at work' do
+    should 'test their code' do
+      @has_been_setup = @setup
+      @tests_code = true 
+      @work_snack = @snack
+      @noise_level ||= nil
+      @work_atmosphere = @noise_level
+      have_unlimited_power
+    end
+
+    setup do
+      @setup = true
+    end
+
+    should 'go to meetings'
   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
 
+class BehaviorsTest < Test::Unit::TestCase
 
   def setup
-    @target = DeveloperTest.new
-    assert_nil @target.tested_code, "block called too early"
+    @developer_test_suite = DeveloperTest.suite
   end
 
   #
   # TESTS
   #
   def test_should_called_with_a_block_defines_a_test
-    assert @target.methods.include?("test_should_test their code"), "Missing test method"
+    at_work_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at work should test their code'}
+    at_home_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at home should study'}
 
-    @target.send("test_should_test their code")
+    assert_nil at_work_test.tests_code, 'should be nil until test method called'
+    assert_nil at_home_test.studies, 'should be nil until test method called'
 
-    assert @target.tested_code, "block not called"
+    at_work_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    at_home_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+
+    assert at_work_test.tests_code, 'should be true after test method called'
+    assert at_home_test.studies, 'should be true after test method 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"
+    assert !@developer_test_suite.tests.any? {|test| test.method_name == 'test should_go to meetings' }, 'should not have defined test method'
+  end
+
+  def test_contexts_will_share_test_case_setup
+    at_work_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at work should test their code'}
+    at_home_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at home should study'}
+
+    assert_nil at_work_test.work_snack, 'work snack should not be defined'
+    assert_nil at_home_test.home_snack, 'home snack should not be defined'
+
+    at_work_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    at_home_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+
+    assert_equal 'yogurt', at_work_test.work_snack, 'wrong home snack'     
+    assert_equal 'yogurt', at_home_test.home_snack, 'wrong home snack'     
+  end
+
+  def test_contexts_can_make_calls_to_helpers_defined_outside_of_the_context
+    at_work_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at work should test their code'}
+
+    assert_nil at_work_test.unlimited_power, 'should not have unlimited power yet'
+
+    at_work_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    assert at_work_test.unlimited_power, 'should have unlimited power'
+  end
+
+  def test_contexts_can_have_their_own_setup_that_will_be_invoked_before_each_should
+    at_home_study_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at home should study'}
+    at_home_rest_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at home should rest'}
+
+    assert_nil at_home_study_test.study_atmosphere, 'study atmosphere should not be defined'
+    assert_nil at_home_rest_test.rest_atmosphere, 'rest atmosphere should not be defined'
+
+    at_home_study_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    at_home_rest_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+
+    assert_equal 'quiet', at_home_study_test.study_atmosphere, 'wrong study atmosphere'
+    assert_equal 'quiet', at_home_rest_test.rest_atmosphere, 'wrong rest atmosphere'
+  end
+
+  def test_setup_can_be_placed_anywhere_in_a_context
+    at_work_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at work should test their code'}
+
+    assert_nil at_work_test.unlimited_power, 'should not have unlimited power yet'
+
+    at_work_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    assert at_work_test.has_been_setup, 'should have called setup'
+  end
+
+  def test_a_context_does_get_polluted_with_instance_variables_from_another_context
+    at_home_study_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at home should study'}
+    assert_nil at_home_study_test.study_atmosphere, 'study atmosphere should not be defined'
+    
+    at_home_study_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    assert_equal 'quiet', at_home_study_test.study_atmosphere, 'wrong study atmosphere'
+
+
+    at_work_test = @developer_test_suite.tests.find {|test| test.method_name == 'test developer at work should test their code'}
+    assert_nil at_work_test.work_atmosphere, 'work atmosphere should not be defined'
+
+    at_work_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    assert_nil at_work_test.work_atmosphere, 'work atmosphere should not be defined'
   end
 
   def test_should_called_without_a_block_will_give_unimplemented_output_when_class_loads
-    unimplemented_output = "UNIMPLEMENTED CASE: Developer should go to meetings"
+    unimplemented_output = 'UNIMPLEMENTED CASE: Developer should go to meetings'
     assert_match(/#{unimplemented_output}/, $loading_developer_test_class_output)
   end
+
+  def test_can_use_shoulds_without_a_context
+    dog_suite = Dog.suite
+    fed_test = dog_suite.tests.find {|test| test.method_name == 'test should be fed'} 
+    assert_nil fed_test.fed, 'fed should not be defined yet'
+    fed_test.orig_run(Test::Unit::TestResult.new) {|result,progress_block|}
+    assert fed_test.fed, 'fed should be true'
+  end
+
+  def test_contexts_without_a_block_will_raise
+    assert_not_nil @@context_without_block_error, 'should have thrown an error'
+    assert_equal RuntimeError, @@context_without_block_error.class, 'wrong error type'
+    assert_match(/context: 'this will not work' called without a block/, @@context_without_block_error.message, 'wrong error message')
+  end
+
+  def test_defining_two_setups_in_context_will_raise
+    assert_not_nil @@context_without_block_error, 'should have thrown an error'
+    assert_equal RuntimeError, @@two_setups_error.class, 'wrong error type'
+    assert_equal "Can't define two setups within one context", @@two_setups_error.message
+  end
+
+  begin
+    class BoomBoom < Test::Unit::TestCase
+      extend Behaviors
+
+      alias_method :orig_run, :run #tuck run out of the way so Test does not have test methods run at_exit
+      def run(result)
+      end
+
+      context 'this will not work'
+    end
+  rescue => err
+    @@context_without_block_error = err
+  end
+
+  begin
+    class TwoSetups < Test::Unit::TestCase
+      extend Behaviors
+
+      alias_method :orig_run, :run #tuck run out of the way so Test does not have test methods run at_exit
+      def run(result)
+      end
+
+      context 'two setups will raise' do
+        setup do
+        end
+        setup do
+        end
+      end
+    end
+  rescue => err
+    @@two_setups_error = err
+  end
+
 end

metadata

@@ -1,63 +1,56 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: behaviors
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
-date: 2007-01-14 00:00:00 -05:00
-summary: behavior-driven unit test helper
-require_paths: 
-- lib
-email: dev@atomicobject.com
-homepage: http://behaviors.rubyforge.org
-rubyforge_project: behaviors
-description: Behaviors allows for Test::Unit test case methods to be defined as  human-readable descriptions of program behavior. It also provides  Rake tasks to list the behaviors of your project.
-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: 
+  version: 1.99.99
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Atomic Object LLC
-files: 
-- Manifest.txt
-- Rakefile
-- lib/behaviors.rb
-- lib/behaviors/reporttask.rb
-- test/behaviors_tasks_test.rb
-- test/behaviors_test.rb
-- test/tasks_test/lib/user.rb
-- test/tasks_test/Rakefile
-- test/tasks_test/test/user_test.rb
-test_files: 
-- test/behaviors_tasks_test.rb
-- test/behaviors_test.rb
-rdoc_options: []
+- Atomic Object
+autorequire: 
+bindir: bin
+cert_chain: []
 
-extra_rdoc_files: []
+date: 2009-12-01 00:00:00 -05:00
+default_executable: 
+dependencies: []
 
+description: DEPRECATED! behaviors will no longer be maintained.  We recommend switching to shoulda or rspec
+email: github@atomicobject.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: []
+
+has_rdoc: true
+homepage: http://atomicobject.github.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.7
-    version: 
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: behavior-driven unit test helper. DEPRECATED! Use rspec or shoulda instead
+test_files: 
+- test/behaviors_tasks_test.rb
+- test/behaviors_test.rb

data/Manifest.txt

@@ -1,9 +0,0 @@
-Manifest.txt
-Rakefile
-lib/behaviors.rb
-lib/behaviors/reporttask.rb
-test/behaviors_tasks_test.rb
-test/behaviors_test.rb
-test/tasks_test/lib/user.rb
-test/tasks_test/Rakefile
-test/tasks_test/test/user_test.rb

data/Rakefile

@@ -1,19 +0,0 @@
-require 'rake'
-require 'rubygems'
-require 'hoe'
-
-Hoe.new('behaviors','1.0.3') do |p|
-  p.author = "Atomic Object LLC" 
-  p.email = "dev@atomicobject.com" 
-  p.url = "http://behaviors.rubyforge.org" 
-  p.summary = "behavior-driven unit test helper" 
-  p.description = <<-EOS
-Behaviors allows for Test::Unit test case methods to be defined as 
-human-readable descriptions of program behavior. It also provides 
-Rake tasks to list the behaviors of your project.
-  EOS
-  p.test_globs = ['test/*_test.rb']
-
-  p.changes = <<-EOS
-  EOS
-end

data/lib/behaviors.rb

@@ -1,76 +0,0 @@
-=begin rdoc
-= Usage
-Behaviors provides a single method: should.
-  
-Instead of naming test methods like:
-
- def test_something
- end
-
-You declare test methods like:
-
- should "perform action" do
- end
-
-You may omit the body of a <tt>should</tt> method to describe unimplemented behavior.
-
- should "perform other action"
-
-When you run your unit tests, empty <tt>should</tt> methods will appear as an 'UNIMPLEMENTED CASE' along with the described behavior.
-This is useful for sketching out planned behavior quickly.
-
-Simply <tt>extend Behaviors</tt> in your <tt>TestCase</tt> to start using behaviors. 
-
-  require 'test/unit'
-  require 'behaviors'
-  require 'user'
-
-  class UserTest < Test::Unit::TestCase
-    extend Behaviors
-    ...
-  end
-
-= 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 behavior of an object.
-This helps you to think about the role of the object under test.
-
-Using a behavior-driven approach prevents the danger in assuming a one-to-one mapping of method names to 
-test method names.
-As always, you get the most value by writing the tests first.
-
-For a more complete BDD framework, try RSpec http://rspec.rubyforge.org/
-  
-= Rake tasks
-
-You can define a <tt>Behaviors::ReportTask</tt> in your <tt>Rakefile</tt> to generate rake tasks that
-summarize the behavior of your project.
-
-These tasks are named <tt>behaviors</tt> and <tt>behaviors_html</tt>. They 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.
-  Behaviors::ReportTask.new do |t|
-    t.pattern = 'test/**/*_test.rb'
-  end
-
-You may also initialize the <tt>ReportTask</tt> with a custom name to associate with a particular suite of tests.
-  Behaviors::ReportTask.new(:widget_subsystem) do |t|
-    t.pattern = 'test/widgets/*_test.rb'
-  end
-
-The html report will be placed in the <tt>doc</tt> directory by default.
-You can override this default by setting the <tt>html_dir</tt> in the <tt>ReportTask</tt>.
-  Behaviors::ReportTask.new do |t|
-    t.pattern = 'test/**/*_test.rb'
-    t.html_dir = 'behaviors_html_reports'
-  end
-=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/lib/behaviors/reporttask.rb

@@ -1,158 +0,0 @@
-require 'rake'
-require 'rake/tasklib'
-
-module Behaviors
-include Rake
-
-  class ReportTask < TaskLib
-    attr_accessor :pattern
-    attr_accessor :html_dir
-
-    def initialize(name=:behaviors)
-      @name = name
-      @html_dir = 'doc'
-      yield self if block_given?
-      define
-    end
-
-    def define
-      desc "List behavioral definitions for the classes specified (use for=<regexp> to further limit files included in report)"
-      task @name do
-        specifications.each do |spec|
-          puts "#{spec.name} should:\n"
-          spec.requirements.each do |req|
-            puts " - #{req}"
-          end
-        end
-      end
-
-      desc "Generate html report of behavioral definitions for the classes specified (use for=<regexp> to further limit files included in report)"
-      task "#{@name}_html" do
-        require 'erb'
-        txt =<<-EOS 
-<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</div>
-<% specifications.each do |spec| %>
-<div class="specification">
-<%= spec.name %> should: 
-<ul class="requirements">
-<% spec.requirements.each do |req| %>
-<li><%= req %></li>
-<% end %>
-</ul>
-</div>
-<% end %>
-</body>
-</html>
-        EOS
-        output_dir = File.expand_path(@html_dir)
-        mkdir_p output_dir
-        output_filename = output_dir + "/behaviors.html"
-        File.open(output_filename,"w") do |f|
-          f.write ERB.new(txt).result(binding)
-        end
-        puts "(Wrote #{output_filename})"
-      end
-    end
-
-    private
-    def test_files
-      test_list = FileList[@pattern]
-      if ENV['for'] 
-        test_list = test_list.grep(/#{ENV['for']}/i)
-      end
-      test_list
-    end  
-
-    def specifications
-      test_files.map do |file|
-        spec = OpenStruct.new
-        m = %r".*/([^/].*)_test.rb".match(file)
-        class_name = titleize(m[1]) if m[1]
-        spec.name = class_name
-        spec.requirements = []
-        File::readlines(file).each do |line| 
-          if line =~ /^\s*should\s+\(?\s*["'](.*)["']/
-            spec.requirements << $1
-          end
-        end
-        spec
-      end
-    end
-
-    ############################################################
-    # STOLEN FROM inflector.rb
-    ############################################################
-    #--
-    # Copyright (c) 2005 David Heinemeier Hansson
-    #
-    # Permission is hereby granted, free of charge, to any person obtaining
-    # a copy of this software and associated documentation files (the
-    # "Software"), to deal in the Software without restriction, including
-    # without limitation the rights to use, copy, modify, merge, publish,
-    # distribute, sublicense, and/or sell copies of the Software, and to
-    # permit persons to whom the Software is furnished to do so, subject to
-    # the following conditions:
-    #
-    # The above copyright notice and this permission notice shall be
-    # included in all copies or substantial portions of the Software.
-    #
-    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-    # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-    # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-    # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-    # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-    # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-    # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-    #++
-    def titleize(word)
-      humanize(underscore(word)).gsub(/\b([a-z])/) { $1.capitalize }
-    end    
-
-    def underscore(camel_cased_word)    camel_cased_word.to_s.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
-    end
-
-    def humanize(lower_case_and_underscored_word)
-      lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
-    end
-
-  end
-end

data/test/tasks_test/Rakefile

@@ -1,19 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-
-here = File.expand_path(File.dirname(__FILE__))
-require "#{here}/../../lib/behaviors/reporttask"
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "#{here}/../../lib"
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-Behaviors::ReportTask.new(:behaviors) do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.html_dir = 'behaviors_doc'
-end

data/test/tasks_test/lib/user.rb

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

data/test/tasks_test/test/user_test.rb

@@ -1,17 +0,0 @@
-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