ZenTest 3.1.0 → 3.2.0

data/History.txt

@@ -1,3 +1,15 @@
+*** 3.2.0 / 2006-04-10
+
++ 1 major enhancement:
+	+ Added Test::Rails.
++ 1 minor enhancement:
+	+ Extended autotest for Test::Rails.
++ 4 bug fixes:
+	+ Autotest now detects changes in rhtml.
+	+ Improved autotest's file mapping and choice of ruby.
+	+ We've got RDoc, yes we do!
+	+ Removed redundancies in rakefile. Using gem spec for most stuff now.
+
 *** 3.1.0 / 2006-03-29
 
 + 2 major enhancements
@@ -15,10 +27,10 @@
 	+ autotest can now run cvs/svn/p4 up periodically to be a mini-tinderbox.
 	+ autotest now has real help.
 + 4 bug fixes
-	- ZenTest is now zentest. Yay for consistency! (do a rake uninstall to clean)
-	- ZenTest excludes pretty_print methods.
-	- Fixed unary operator issues (they were backwards... oops!) for ZenTest.
-	- unit_diff now runs diff.exe on Windoze. dunno if that will work.
+	+ ZenTest is now zentest. Yay for consistency! (do a rake uninstall to clean)
+	+ ZenTest excludes pretty_print methods.
+	+ Fixed unary operator issues (they were backwards... oops!) for ZenTest.
+	+ unit_diff now runs diff.exe on Windoze. dunno if that will work.
 
 *** 3.0.0 / 2006-03-06
 

data/Manifest.txt

@@ -5,6 +5,7 @@ README.txt
 Rakefile
 bin/autotest
 bin/multiruby
+bin/rails_test_audit
 bin/unit_diff
 bin/zentest
 example.txt
@@ -12,11 +13,20 @@ example1.rb
 example2.rb
 lib/autotest.rb
 lib/rails_autotest.rb
+lib/test/rails.rb
+lib/test/rails/controller_test_case.rb
+lib/test/rails/functional_test_case.rb
+lib/test/rails/ivar_proxy.rb
+lib/test/rails/rake_tasks.rb
+lib/test/rails/test_case.rb
+lib/test/rails/view_test_case.rb
+lib/test/zentest_assertions.rb
 lib/unit_diff.rb
 lib/zentest.rb
 test/data/normal/lib/.#photo.rb
 test/data/normal/lib/blah.rb
 test/data/normal/lib/photo.rb
+test/data/normal/test/#test_photo.rb#
 test/data/normal/test/test_camelcase.rb
 test/data/normal/test/test_photo.rb
 test/data/normal/test/test_route.rb
@@ -25,8 +35,10 @@ test/data/rails/app/controllers/admin/theme_controller.rb
 test/data/rails/app/controllers/route_controller.rb
 test/data/rails/app/models/flickr_photo.rb
 test/data/rails/app/models/route.rb
+test/data/rails/app/views/route/index.rhtml
 test/data/rails/config/environment.rb
 test/data/rails/config/routes.rb
+test/data/rails/test/controllers/route_controller_test.rb
 test/data/rails/test/fixtures/routes.yml
 test/data/rails/test/functional/admin/themes_controller_test.rb
 test/data/rails/test/functional/dummy_controller_test.rb
@@ -34,6 +46,7 @@ test/data/rails/test/functional/route_controller_test.rb
 test/data/rails/test/unit/flickr_photo_test.rb
 test/data/rails/test/unit/photo_test.rb
 test/data/rails/test/unit/route_test.rb
+test/data/rails/test/views/route_view_test.rb
 test/test_autotest.rb
 test/test_rails_autotest.rb
 test/test_unit_diff.rb

data/README.txt

@@ -5,7 +5,8 @@
 
 == DESCRIPTION
 
-ZenTest provides 3 different tools: zentest, unit_diff, and autotest.
+ZenTest provides 4 different tools and 1 library: zentest, unit_diff,
+autotest, multiruby, and Test::Rails.
 
 ZenTest scans your target and unit-test code and writes your missing
 code based on simple naming rules, enabling XP at a much quicker
@@ -21,7 +22,11 @@ corresponding dependent tests.
 multiruby runs anything you want on multiple versions of ruby. Great
 for compatibility checking!
 
-There are two strategies intended for ZenTest: test conformance
+Test::Rails helps you build industrial-strength Rails code.
+
+== STRATEGERY
+
+There are two strategeries intended for ZenTest: test conformance
 auditing and rapid XP.
 
 For auditing, ZenTest provides an excellent means of finding methods
@@ -33,15 +38,16 @@ ZenTest can also be used to evaluate generated code and execute your
 tests, allowing for very rapid development of both tests and
 implementation.
 
-== FEATURES/PROBLEMS
+== FEATURES
 
 * Scans your ruby code and tests and generates missing methods for you.
 * Includes a very helpful filter for Test::Unit output called unit_diff.
 * Continually and intelligently test only those files you change with autotest.
 * Test against multiple versions with multiruby.
-- Not the best doco in the world (my fault)
+* Enhance and automatically audit your rails tests using Test::Rails.
 * Includes a LinuxJournal article on testing with ZenTest written by Pat Eyler.
 * See also: http://blog.zenspider.com/archives/zentest/
+* See also: http://blog.segment7.net/articles/category/zentest
 
 == SYNOPSYS
 
@@ -53,46 +59,7 @@ implementation.
 
   multiruby ./TestMyProject.rb
 
-== RULES
-
-ZenTest uses the following rules to figure out what code should be
-generated:
-
-* Definition:
-  * CUT = Class Under Test
-  * TC = Test Class (for CUT)
-* TC's name is the same as CUT w/ "Test" prepended at every scope level.
-  * Example: TestA::TestB vs A::B.
-* CUT method names are used in CT, with "test_" prependend and optional "_ext" extensions for differentiating test case edge boundaries.
-  * Example:
-    * A::B#blah
-    * TestA::TestB#test_blah_normal
-    * TestA::TestB#test_blah_missing_file
-* All naming conventions are bidirectional with the exception of test extensions.
-
-== METHOD MAPPING
-
-Method names are mapped bidirectionally in the following way:
-
-  method	test_method
-  method?	test_method_eh		(too much exposure to Canadians :)
-  method!	test_method_bang
-  method=	test_method_equals
-  []		test_index
-  *		test_times
-  ==		test_equals2
-  ===		test_equals3
-
-Further, any of the test methods should be able to have arbitrary
-extensions put on the name to distinguish edge cases:
-
-  method	test_method
-  method	test_method_simple
-  method	test_method_no_network
-
-To allow for unmapped test methods (ie, non-unit tests), name them:
-
-  test_integration_.*
+  (and other stuff for Test::Rails)
 
 == REQUIREMENTS
 
@@ -102,8 +69,14 @@ To allow for unmapped test methods (ie, non-unit tests), name them:
 
 == INSTALL
 
-* make test
-* sudo make install
+Using Rubygems:
+
+* sudo gem install ZenTest
+
+Using Rake:
+
+* rake test
+* sudo rake install
 
 == LICENSE
 

data/Rakefile

@@ -16,25 +16,35 @@ spec = Gem::Specification.new do |s|
   s.authors = ['Ryan Davis', 'Eric Hodel']
   s.email = 'ryand-ruby@zenspider.com'
 
-  s.files = File.read('Manifest.txt').split($/)
+  s.files = IO.readlines("Manifest.txt").map {|f| f.chomp }
   s.require_path = 'lib'
-  s.executables = %w[ZenTest unit_diff autotest multiruby]
+
+  s.executables = s.files.grep(/^bin\//).map { |f| File.basename f }
 
   paragraphs = File.read("README.txt").split(/\n\n+/)
-  s.instance_variable_set "@description", paragraphs[3..9].join("\n\n")
-  s.instance_variable_set "@summary", paragraphs[11]
+  s.instance_variable_set "@description", paragraphs[3..10].join("\n\n")
+  s.instance_variable_set "@summary", paragraphs[12]
 
   if $DEBUG then
     puts "ZenTest #{s.version}"
     puts
+    puts s.executables.sort.inspect
+    puts
+    puts "** summary:"
     puts s.summary
     puts
+    puts "** description:"
     puts s.description
   end
 
-  s.files = IO.readlines("Manifest.txt").map {|f| f.chomp }
   s.homepage = "http://www.zenspider.com/ZSS/Products/ZenTest/"
   s.rubyforge_project = "zentest"
+  s.has_rdoc = true
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
 end
 
 desc 'Run tests'
@@ -57,19 +67,19 @@ Rake::RDocTask.new :rdoc do |rd|
   rd.rdoc_files.add 'lib', 'README.txt', 'History.txt', 'LinuxJournalArticle.txt'
   rd.main = 'README.txt'
   rd.options << '-d' if `which dot` =~ /\/dot/ unless RUBY_PLATFORM =~ /win32/
-  rd.options << '-t "ZenTest RDoc"'
-end
-
-desc 'Build Gem'
-Rake::GemPackageTask.new spec do |pkg|
-  pkg.need_tar = true
+  rd.options << '-t ZenTest RDoc'
 end
 
 $prefix = ENV['PREFIX'] || Config::CONFIG['prefix']
 $bin  = File.join($prefix, 'bin')
 $lib  = Config::CONFIG['sitelibdir']
-$bins = %w(zentest autotest unit_diff multiruby)
-$libs = %w(zentest.rb autotest.rb rails_autotest.rb unit_diff.rb)
+$bins = spec.executables
+$libs = spec.files.grep(/^lib\//).map { |f| f.sub(/^lib\//, '') }.sort
+
+task :blah do
+    p $bins
+    p $libs
+end
 
 task :install do
   $bins.each do |f|
@@ -77,7 +87,9 @@ task :install do
   end
 
   $libs.each do |f|
-    install File.join("lib", f), $lib, :mode => 0444
+    dir = File.join($lib, File.dirname(f))
+    mkdir_p dir unless test ?d, dir
+    install File.join("lib", f), dir, :mode => 0444
   end
 end
 
@@ -93,9 +105,14 @@ task :uninstall do
   $libs.each do |f|
     rm_f File.join($lib, f)
   end
+
+  rm_rf File.join($lib, "test")
 end
 
 desc 'Clean up'
 task :clean => [ :clobber_rdoc, :clobber_package ] do
   rm_f Dir["**/*~"]
 end
+
+# vim:syntax=ruby
+

data/bin/rails_test_audit

@@ -0,0 +1,80 @@
+#!/usr/local/bin/ruby -w
+
+# TODO: Probably has dup code with ZenTest.
+# TODO: Map controller assert_assigns to view test ivar assignments.
+# TODO: Make this a rake task, rake test:audit.
+
+# test_cases[test_case][test][ivar] = value
+def build_test_cases(type)
+  test_cases = Hash.new { |h,k|
+    h[k] = Hash.new { |h,k|
+      h[k] = Hash.new { |h,k|
+        h[k] = {} } } }
+
+  test_case = nil
+  test = nil
+
+  fixtures = Hash.new { |h,k| h[k] = [] }
+
+  Dir["test/#{type}/*rb"].each do |test|
+    File.open test do |fp|
+      fp.each_line do |line|
+        case line
+        when /^class (.*)(View|Controller)Test </
+          test_case = $1
+        when /^\s+def (test_\S+)/
+          test = $1
+        when /^\s+controller\[(.+?)\] = (.*)$/,
+             /^\s+assert_assigned (.*?), (.*)/
+          ivar = $1
+          value = $2
+          test_cases[test_case][test][ivar] = value
+        when /fixtures (.*)/ then
+          fixtures[test_case].push(*$1.split(', '))
+        end
+      end
+    end
+  end
+
+  return test_cases, fixtures
+end
+
+view_test_cases, view_fixtures = build_test_cases 'views'
+controller_test_cases, controller_fixtures = build_test_cases 'controller'
+
+out = []
+
+view_test_cases.sort_by { |tc,_| tc }.each do |test_case, tests|
+  out << "require 'test/test_helper'"
+  out << nil
+  out << "class #{test_case}ControllerTest < Test::Rails::ControllerTestCase"
+  out << nil
+
+  fixtures = controller_fixtures[test_case] - view_fixtures[test_case]
+
+  unless fixtures.empty? then
+    fixtures.each do |fixture|
+      out << "  fixtures #{fixture}"
+    end
+    out << nil
+  end
+
+  tests.sort_by { |t,_| t }.each do |test, ivars|
+    ivars = view_test_cases[test_case][test].keys -
+            controller_test_cases[test_case][test].keys
+
+    next if ivars.empty?
+
+    out << "  def #{test}"
+    ivars.sort.each do |ivar|
+      value = view_test_cases[test_case][test][ivar]
+      out << "    assert_assigned #{ivar}, #{value}"
+    end
+    out << "  end"
+    out << nil
+  end
+  out << "end"
+  out << nil
+end
+
+puts out.join("\n")

data/bin/unit_diff

@@ -15,18 +15,17 @@
 #    -v display version
 
 require 'unit_diff'
+require 'zentest'
 
 ############################################################
 
-UNIT_DIFF_VERSION = '1.1.0'
-
 if defined? $v then
-  puts "#{File.basename $0} v. #{UNIT_DIFF_VERSION}"
-  exit
+  puts "#{File.basename $0} v. #{ZenTest::VERSION}"
+  exit 0
 end
 
 if defined? $h then
-  File.open(File.basename($0)) do |f|
+  File.open($0) do |f|
     begin; end until f.readline =~ /usage:/
     f.readline
     while line = f.readline and line.sub!(/^# ?/, '')
@@ -37,4 +36,3 @@ if defined? $h then
 end
 
 puts UnitDiff.unit_diff(ARGF)
-

data/lib/autotest.rb

@@ -1,6 +1,7 @@
 $TESTING = defined? $TESTING
 
 require 'find'
+require 'rbconfig'
 
 ##
 # Autotest continuously runs your tests as you work on your project.
@@ -21,7 +22,7 @@ require 'find'
 # * Implementation files must be stored in lib/
 # * Implementation files must match up with a test file named
 #   test_.*implementation.rb
-
+#--
 # New (proposed) strategy:
 #
 # 1) find all files and associate them from impl <-> test
@@ -62,7 +63,7 @@ class Autotest
     end
 
     return filters.map do |klass, methods|
-      ["'/^(#{methods.join('|')})/'", /#{klass}/]
+      ["'/^(#{methods.join('|')})$/'", /#{klass}/]
     end
   end
 
@@ -175,7 +176,7 @@ class Autotest
         puts "# Rerunning failures: #{failed_files.join ' '}"
 
         test_filter = " -n #{filter}" unless filter == "'/^(default_test)/'"
-        cmd = "ruby -Ilib:test #{failed_files.join ' '}#{test_filter} | unit_diff -u"
+        cmd = "#{ruby} -Ilib:test #{failed_files.join ' '}#{test_filter} | unit_diff -u"
 
         puts "+ #{cmd}"
         result = `#{cmd}`
@@ -190,6 +191,14 @@ class Autotest
     end
   end
 
+  ##
+  # The path to this ruby for running tests.
+
+  def ruby
+    return File.join(Config::CONFIG['bindir'],
+                     Config::CONFIG['ruby_install_name'])
+  end
+
   ##
   # Repeatedly scans for updated files and runs their tests.
 
@@ -248,7 +257,7 @@ class Autotest
     map_file_names(updated).each do |tests|
       next if tests.empty?
       puts '# Testing updated files'
-      cmd = "ruby -Ilib:test -e '#{tests.inspect}.each { |f| load f }' | unit_diff -u"
+      cmd = "#{ruby} -Ilib:test -e '#{tests.inspect}.each { |f| load f }' | unit_diff -u"
       puts "+ #{cmd}"
       results = `#{cmd}`
       puts results
@@ -274,12 +283,16 @@ class Autotest
 
       # REFACTOR: I don't think the two routines merit real differences
       retest_failed failed, tests
-    end
 
-    reset_times if ever_failed
+      break
+    end
 
-    puts '# All passed'
-    puts "# Waiting for changes"
+    if ever_failed
+      reset_times
+    else # We'll immediately test everything, so don't print this out.
+      puts '# All passed'
+      puts "# Waiting for changes"
+    end
 
     return ever_failed
   end
@@ -304,7 +317,6 @@ class Autotest
     updated = []
 
     Find.find '.' do |f|
-
       if @exceptions then
         if f =~ @exceptions then
           Find.prune if Kernel.test ?d, f
@@ -316,7 +328,7 @@ class Autotest
 
       next if File.directory? f
       next if f =~ /(?:swp|~|rej|orig)$/        # temporary/patch files
-      next if f =~ /\/\.#/                      # Emacs autosave/cvs merge files
+      next if f =~ /\/\.?#/                     # Emacs autosave/cvs merge files
 
       f = f.sub(/^\.\//, '')