quicktest 0.5.6 → 0.5.7

data/README

@@ -93,11 +93,16 @@ http://gregweber.info/projects/quicktest.html
 included with the gem
 
 == Important Notes
+- def quicktest will instantiate an object for the class you are testing, which gives a convenient referenct to self in the quicktest method.  However, it calls new() without any parameters.  If you need parameters for new(), you will have to use def self.quicktest and call new() yourself
+
+== Configuration
 - when testing module instance methods, the module is included into an anonymous class.  By default, that class inherits from Object.  To change this you must define an object that the module will be included into by defining the following in the module:
 
   def self.quicktest_include_into; String end
 
-- def quicktest will instantiate an object for the class you are testing, which gives a convenient referenct to self in the quicktest method.  However, it calls new() without any parameters.  If you need parameters for new(), you will have to use def self.quicktest and call new() yourself
+- you can change the testing method name from quicktest to something else using the command line option
+
+  --quicktest better_testing_name
 
 == TroubleShooting
 - quicktest methods not working properly? if the class (or one of its ancestors) is overriding method tracing then including QuickTest::Tracer will fix it, but you should also fix the class or its ancestor.

data/{rakefile → Rakefile}

@@ -1,16 +1,19 @@
-project = 'quicktest'
+$project = 'quicktest'
+require 'tasks/helpers'
+
 def test_dir; Dir.chdir('spec') {|dir| yield dir } end
 
-def run command
-  res = `#{command}`
-  exit $?.exitstatus if $?.exitstatus != 0
-  res
+class String
+  def split_join( splitter=$/ )
+    yield( split( splitter ) ).join( splitter )
+  end
 end
 
 desc "test"
 task :test do
   t = 'spec -r ../lib/quicktest test.rb'
   test_dir {(puts (run "#{t} >| test_result.txt || #{t}"))}
+  test_dir { puts `../bin/quickspec __test.rb --quicktest __test` }
 end
 
 namespace :test do
@@ -30,20 +33,6 @@ namespace :test do
   end
 end
 
-class IO
-  def self.write( file, str )
-    self.open( file, 'w' ) { |fh| fh.print str }
-  end
-  def self.read_write( file, write_file=file )
-    self.write(write_file, (yield( self.read( file ))))
-  end
-end
-class String
-  def split_join( splitter=$/ )
-    yield( split( splitter ) ).join( splitter )
-  end
-end
-
 def decode_readme &block
   fail unless block_given?
   begin
@@ -82,55 +71,25 @@ namespace :readme do
       fail unless system 'rdoc --force-update --quiet README'
     end
     require 'hpricot'
+    require 'htmlentities'
     doc = open( 'doc/files/README.html' ) { |f| Hpricot(f) }
     # find example code
     doc.at('#description').search('pre').
       select {|elem| elem.inner_html =~ /class |module /}.each do |ex|
       # add coderay and undo what rdoc has done in the example code
-      ex.swap("<coderay lang='ruby'>#{ex.inner_html.gsub('&quot;', '"').gsub('&gt;','>')}</coderay>")
+      ex.swap("<coderay lang='ruby'>#{HTMLEntities.new.decode ex.inner_html}</coderay>")
     end
     puts doc.at('#description').to_html
   end
 end
 
-desc "release a new gem to rubyforge"
-task :release => [:test,:record,:rdoc,:website,:package] do
-  Dir.chdir('pkg') do
-    release = Dir['*.gem'].sort_by {|file| File.mtime(file)}.last
-    release =~ /^[^-]+-([.0-9]+).gem$/
-    (puts (run "rubyforge login && rubyforge add_release #{project} #{project} #$1 #{release}"))
-  end
-  Dir.chdir('doc') do
-    run "scp -r ./ gregwebs@rubyforge.org:/var/www/gforge-projects/#{project}"
-  end
-end
-
-desc "update website"
-file :website => ['README','rakefile'] do
-  Dir.chdir '/home/greg/sites/projects/' do
-    (puts (run 'rake projects:update'))
-    (puts (run 'rake deploy:rsync'))
-  end
-end
-
-desc 'git add and push'
-task :record do
-  unless `git diff`.chomp.empty?
-    ARGV.clear
-    puts "enter commit message"
-    (puts (run "git commit -a -m #{Kernel.gets}"))
-    puts "committed! now pushing.. "
-    (puts (run 'git push origin master'))
-  end
-end
-
 require 'rubygems'
 require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
-  s.name = project
-  s.rubyforge_project = project
-  s.version = "0.5.6"
+  s.name = $project
+  s.rubyforge_project = $project
+  s.version = "0.5.7"
   s.author = "Greg Weber"
   s.email = "greg@gregweber.info"
   s.homepage = "http://quicktest.rubyfore.org/"

data/TODO

@@ -0,0 +1 @@
+exiting will not run the last test

data/doc/created.rid

@@ -1 +1 @@
-Tue, 11 Mar 2008 15:27:43 -0500
+Mon, 28 Apr 2008 00:16:33 -0500

data/lib/quicktest.rb

@@ -8,6 +8,9 @@ module QuickTest
 
   # create module variables
   class << self
+    # then name of the testing method, default is :quicktest
+    attr_accessor :test_method
+
     # don't record the fact that we add Module.method_added
     attr_accessor :ignore_first_method_added
 
@@ -45,17 +48,17 @@ module QuickTest
 
     # keep a list of all traced methods
     self.methods = []
-    def self.add_method( meth )
+    def self.add_method meth
       self.methods.push meth
     end
-    def self.add_singleton_method( meth )
+    def self.add_singleton_method meth
       self.methods.push meth
     end
 
     def initialize tested
       self.class.tested_self = tested
 
-      q = tested.method(:quicktest)
+      q = tested.method(QuickTest.test_method)
       tested.extend(QuickTest.runner_module)
       QuickTest.runner_module::QuickTestIncludeModules.each do |mod|
         tested.extend mod
@@ -64,10 +67,16 @@ module QuickTest
       case q.arity
       when 0 then q.call
       when 1 then q.call tested.method(self.class.methods[-1])
-      else raise ArgumentError, "to many arguments for quicktest method"
+      else raise ArgumentError, "to many arguments for #{QuickTest.test_method} method"
       end
 
       tested.send :__quicktest_run_tests__
+
+      # removing the quicktest method will prevent Ruby from warning about the method being redefined
+      # I don't know how to remove a class method
+      unless tested.kind_of?(Class) or tested.kind_of?(Module)
+        tested.class.class_eval { remove_method QuickTest.test_method }
+      end
     end
   end
 
@@ -79,21 +88,22 @@ module QuickTest
     @@after_block = nil
     @@before_block = nil
 
-    def before( &block ); @@before_block = block end
-    def after( &block );  @@after_block = block end
-    def it(specification, &block )
+    def before( *args, &block ) @@before_block = [args, block] end
+    def after(  *args, &block ) @@after_block  = [args, block] end
+    def it specification, &block
       @@quicktests[(TestRunner.methods.pop.to_s << ' ' << specification)] = block
       TestRunner.methods.clear
     end
 
   private
     def __quicktest_run_tests__ # :nodoc:
-      before_block, after_block = @@before_block, @@after_block
+      before_args, before_block = @@before_block
+      after_args, after_block = @@after_block
       tests = @@quicktests
 
       describe( TestRunner.tested_self.to_s ) do
-        before { before_block.call } if before_block
-        after  { after_block.call } if after_block
+        before(*before_args) { before_block.call } if before_block
+        after(*after_args)   { after_block.call }  if after_block
 
         tests.each_pair do |spec, test_block|
           it( spec ) { test_block.call }
@@ -110,9 +120,9 @@ module QuickTest
   module Tracer
     def self.included(into)
       if into == Class or into == Module # default include in in Module
-        self.tracer_include(into)
+        self.tracer_include into
       else
-        self.tracer_include((class<<into;self;end))
+        self.tracer_include(class<<into;self;end)
       end
     end
 
@@ -125,7 +135,7 @@ module QuickTest
         alias_method :__quicktest_method_added__, :method_added
 
         # ruby tracing hook
-        def singleton_method_added(traced)
+        def singleton_method_added traced
           # avoid infinite recursion if module is included into a class by a user
           return if traced == QuickTest.runner.methods.last
 
@@ -134,7 +144,7 @@ module QuickTest
             QuickTest.include_module_into = nil
           end
 
-          if traced == :quicktest
+          if traced == QuickTest.test_method
             QuickTest.runner.new self
 
           elsif traced == :quicktest_include_into
@@ -149,20 +159,17 @@ module QuickTest
         QuickTest.ignore_first_method_added = true
 
         # ruby tracing hook
-        def method_added(traced)
+        def method_added traced
           qt = QuickTest
           # avoid infinite recursion if module is included into a class by a user
           return if traced == qt.runner.methods.last
 
-          if traced == :quicktest
+          if traced == QuickTest.test_method
             qt.runner.new(
               if self.class != Module
                 self.new
               else
-                imi = QuickTest.include_module_into
-                o = (imi ? Class.new(imi) : Class.new).new
-                o.extend(self)
-                o
+                Class.new(QuickTest.include_module_into || Object).extend(self)
               end
             )
 
@@ -182,16 +189,31 @@ module QuickTest
 end
 
 
-# add cases for different test handlers here
+# configurable
+QuickTest.test_method = :quicktest
 QuickTest.runner = QuickTest::TestRunner
-QuickTest.runner_module = 
-case ARGV[0]
-when '--rspec' then ARGV.shift; QuickTest::RSpecTestRunner
-else # assume rspec
-  QuickTest::RSpecTestRunner
+QuickTest.runner_module = QuickTest::RSpecTestRunner
+
+files = []
+while(arg = ARGV.shift)
+  case arg
+  when '--rspec'
+    QuickTest.runner_module = ARGV.shift ||
+      (puts "--rspec requires an argument";exit(1))
+  when '--quicktest'
+    QuickTest.test_method = ARGV.shift.to_sym ||
+      (puts "--quicktest requires an argument";exit(1))
+  else
+    (puts "unknown argument: #{arg}";exit(1)) unless File.exist? arg
+    files.push(arg)
+  end
 end
+ARGV.concat files
 
+# trace all methods
 class Module # :nodoc:
   include QuickTest::Tracer
 end
-#class Class;  include QuickTest::Tracer end
+
+# TODO: run pending tests at exit
+#at_exit do end

data/spec/__test.rb

@@ -0,0 +1,7 @@
+def testing
+end
+def __test
+  it "should be of class Object" do
+    self.should be_kind_of(Object)
+  end
+end

data/spec/test.rb

@@ -90,6 +90,15 @@ module TestModule
       7.times {$r.shift}
     end
   end
+
+  define_method(:the_method) {}
+  def quicktest
+    msg = "should include the module into class Object"
+    it msg do
+      $r.shift.should =~ /^'#<Class:0x[^>]+> the_method #{msg}' FAILED$/
+      7.times {$r.shift}
+    end
+  end
 end
 
 class TestClass

data/spec/test_result.txt

@@ -1,69 +1,77 @@
-.....FFFFFFFF
+.....FFFFFFFFF
 
 1)
-'#<Object:0xb781e3ec>  should show class name in output' FAILED
+'#<Object:0xb7b72b9c>  should show class name in output' FAILED
 expected: /^'#<Object:0x[^>]+>  should show class name in output' FAILED$/,
      got: nil (using =~)
 ./test.rb:58:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
 2)
-'#<Object:0xb781d244> new_method_added should show name of added method' FAILED
+'#<Object:0xb7b72098> new_method_added should show name of added method' FAILED
 expected: /^'#<Object:0x[^>]+> new_method_added should show name of added method' FAILED$/,
      got: nil (using =~)
 ./test.rb:68:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
 3)
 'TestModule  should show class name in output' FAILED
 expected: /^'TestModule  should show class name in output' FAILED$/,
      got: nil (using =~)
 ./test.rb:78:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
 4)
 'TestModule new_singleton_method_added should show class name in output' FAILED
 expected: /^'TestModule new_singleton_method_added should show class name in output' FAILED$/,
      got: nil (using =~)
 ./test.rb:89:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
 5)
+'#<Class:0xb7b6fa8c> the_method should include the module into class Object' FAILED
+expected: /^'#<Class:0x[^>]+> the_method should include the module into class Object' FAILED$/,
+     got: nil (using =~)
+./test.rb:98:in `quicktest'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
+
+6)
 'TestClass  should show class name in output' FAILED
 expected: /^'TestClass  should show class name in output' FAILED$/,
      got: nil (using =~)
-./test.rb:100:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+./test.rb:109:in `quicktest'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
-6)
-'#<TestClass:0xb78168f4>  should show class name in output' FAILED
+7)
+'#<TestClass:0xb7b6e8bc>  should show class name in output' FAILED
 expected: /^'#<TestClass:0x[^>]+>  should show class name in output' FAILED$/,
      got: nil (using =~)
-./test.rb:107:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+./test.rb:116:in `quicktest'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
-7)
-'#<TestClass:0xb78155f8> new_method_added should show name of added method' FAILED
+8)
+'#<TestClass:0xb7b6de58> new_method_added should show name of added method' FAILED
 expected: /^'#<TestClass:0x[^>]+> new_method_added should show name of added method' FAILED$/,
      got: nil (using =~)
-./test.rb:117:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+./test.rb:126:in `quicktest'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
-8)
+9)
 'TestClass new_singleton_method_added should show class name in output' FAILED
 expected: /^'TestClass new_singleton_method_added should show class name in output' FAILED$/,
      got: nil (using =~)
-./test.rb:128:in `quicktest'
-../lib/quicktest.rb:99:in `call'
-../lib/quicktest.rb:99:in `__quicktest_run_tests__'
+./test.rb:137:in `quicktest'
+../lib/quicktest.rb:109:in `call'
+../lib/quicktest.rb:109:in `__quicktest_run_tests__'
 
-Finished in 0.029012 seconds
+Finished in 0.051081 seconds
 
-13 examples, 8 failures
+14 examples, 9 failures

data/tasks/gregproject.rake

@@ -0,0 +1,65 @@
+desc "run specs"
+task :spec do
+  Dir[ 'spec/*' ].each do |file|
+    out "spec #{file}"
+  end
+end
+
+require 'rubygems'
+require 'spec/rake/spectask'
+desc "verify test coverage with RCov"
+task :rcov => 'rcov:verify'
+namespace :rcov do
+  Spec::Rake::SpecTask.new('rcov') do |t|
+    t.spec_files = ['spec/*.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+
+  require 'spec/rake/verify_rcov'
+  # rcov is wrong- I am actually at 100%
+  RCov::VerifyTask.new(:verify => :rcov) do |t|
+    t.threshold = 100 # Make sure you have rcov 0.7 or higher!
+    t.index_html = $rcov_index_html
+  end
+end
+
+desc "create a new gem release"
+task :release => [:test,:record,:rdoc,:website,:package] do
+  Dir.chdir('pkg') do
+    release = Dir['*.gem'].sort_by {|file| File.mtime(file)}.last
+    release =~ /^[^-]+-([.0-9]+).gem$/
+    out "rubyforge login && rubyforge add_release #{$project} #{$project} #$1 #{release}"
+  end
+end
+
+desc "update website"
+file :website => ['README','Rakefile'] do
+  Dir.chdir '/home/greg/sites/projects/' do
+    out 'rake --silent projects:update'
+    out 'rake --silent deploy:rsync'
+  end
+end
+  
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rd|  
+   rd.main = "README"  
+   rd.rdoc_dir = "doc"
+   rd.rdoc_files.include("README", "lib/**/*.rb")  
+   rd.title = "#$project rdoc"  
+   rd.options << '-S' # inline source  
+   rd.template = `allison --path`.chomp + '.rb'  
+ end
+
+desc 'git add and push'
+task :record do
+  unless `git status`.split($/).last =~ /nothing added/
+    puts `git diff`
+    ARGV.clear
+    puts "enter commit message"
+    out "git commit -a -m '#{Kernel.gets}'"
+    puts "committed! now pushing.. "
+    out 'git push origin master'
+  end
+end

data/tasks/helpers.rb

@@ -0,0 +1,36 @@
+def exit_msg(msg, code=1)
+  puts msg
+  exit(code)
+end
+def run command
+  res = `#{command}`
+  if $?.exitstatus != 0
+    exit_msg(
+      "\nfailure on command:\n  #{command.chomp}\nresult:\n  #{res}\n",
+      $?.exitstatus
+    )
+  end
+  res
+end
+def out command
+  (puts (run command))
+end
+
+def cd_tmp
+  Dir.mkdir 'tmp' unless File.directory? 'tmp'
+  Dir.chdir('tmp') do |dir|
+    yield dir
+  end
+  rm_rf 'tmp'
+end
+
+class IO
+  def self.write( file, str )
+    self.open( file, 'w' ) { |fh| fh.print str }
+  end
+  def self.read_write( file, write_file=file )
+    self.write(write_file, (yield( self.read( file ))))
+  end
+end
+
+Dir.glob('tasks/*.rake').sort.each {|fn| import fn}

metadata

@@ -1,46 +1,43 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: quicktest
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
-date: 2008-03-11 00:00:00 -05:00
-summary: utility for inlining tests with the code tested
-require_paths: 
-- lib
-email: greg@gregweber.info
-homepage: http://quicktest.rubyfore.org/
-rubyforge_project: quicktest
-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: 
+  version: 0.5.7
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: |+
-  
-    spec and quickspec are ruby executable scripts, whose directory location must be in your PATH environment variable (or you must invoke the with the full file path).
-  
-    run tests with
-       quickspec [file1 file2 ...]
-  
 authors: 
 - Greg Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: 
+email: greg@gregweber.info
+executables: 
+- quickspec
+extensions: []
+
+extra_rdoc_files: 
+- README
 files: 
 - ./bin
 - ./doc
 - ./lib
+- ./TODO
 - ./spec
+- ./Rakefile
+- ./tasks
 - ./README
-- ./rakefile
 - bin/quickspec
 - doc/files
 - doc/index.html
@@ -51,28 +48,43 @@ files:
 - doc/created.rid
 - doc/classes
 - lib/quicktest.rb
+- spec/__test.rb
 - spec/test.rb
 - spec/test_result.txt
+- tasks/helpers.rb
+- tasks/gregproject.rake
 - README
-test_files: []
-
+has_rdoc: true
+homepage: http://quicktest.rubyfore.org/
+post_install_message: |+
+  
+    spec and quickspec are ruby executable scripts, whose directory location must be in your PATH environment variable (or you must invoke the with the full file path).
+  
+    run tests with
+       quickspec [file1 file2 ...]
+  
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-executables: 
-- quickspec
-extensions: []
-
+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: rspec
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
-    version: 
+rubyforge_project: quicktest
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: utility for inlining tests with the code tested
+test_files: []
+