mynyml-phocus 0.9.8 → 0.9.9

data/README

@@ -2,10 +2,19 @@
 
 Phocus let's you temporarily focus some tests, ignoring all others, even across test classes.
 
+===== Features
+
+* Ultra simple to use
+* Works accross testcase classes
+* Works within contexts
+* Can focus multiple tests
+* Simple code (< 50 LOCs)
+* Compatible with at least 5 different testing frameworks
+
 ==== Examples
 
   require 'test/unit'
-  require 'phocus/test_unit'
+  require 'phocus'
 
   class TestUser < Test::Unit::TestCase
 
@@ -43,7 +52,7 @@ Also works fine with <tt>test "description"</tt> style tests.
 
 ==== Phocus Vs. Editor
 
-"Dude, MY editor already does that! Just get a real editor!!1!"
+"Dude, MY editor already does that! Just get a real editor!!"
 
 Actually, so does my editor. But I've found that in many situations, it was far
 from enough.
@@ -51,7 +60,7 @@ from enough.
 Contexts:
 Some frameworks like shoulda, context and contest allow you to embed tests
 within context blocks, which throws off the editor's "run a single test"
-funtionality, since they expand the test method names.
+functionality, since they expand the test method names.
 
 Debugging:
 Some editors will even allow you to step into the code when using
@@ -61,33 +70,22 @@ as the console.
 Multiple Tests:
 Phocus allows focusing more than one tests.
 
-==== Other Testing Frameworks
-
-Phocus is compatible with various testing frameworks. To use with your
-framework of choice, simply require the right compatibility file:
+==== Testing Framework Compatibility
 
-  require 'phocus/test_unit'
-  require 'phocus/minitest'
-  require 'phocus/shoulda'
-  require 'phocus/context'
-  require 'phocus/contest'
+Phocus is known to be compatible with the following testing frameworks (see test/compat/*):
 
-It is likely to be compatible with other frameworks as well, but these are the
-ones that have been verified to work and that are automatically set up.
+  * test/unit
+  * minitest/unit
+  * shoulda
+  * context
+  * contest
 
-In case you're wondering,
-
-  require 'phocus'
-
-is the standalone phocus functionality. You can require it directly, but you'll
-have to set it up (which pretty much just means setting the right
-Phocus.method_pattern for your test framework and including the mixin). You
-really don't need to bother though, that work has been taken care of for you if
-you <tt>require 'phocus/...'</tt> directly. Though it will be useful if you're
-trying to get Phocus working with another framework. Refer to the rdocs in this
-case (or better yet, you can read the source; it's < 50 LOCs)
+It is possibly compatible out of the box with other test/unit-based testing
+frameworks as well, but it should be fairly easy to set up if it isn't (include
+Phocus in parent testcase class and set proper method_pattern. See rdocs)
 
 ==== Links
+
 source:: http://github.com/mynyml/phocus
 rdocs::  http://docs.github.com/mynyml/phocus
 

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'phocus'
-  s.version         = '0.9.8'
+  s.version         = '0.9.9'
   s.summary         = "Run focused tests on test/unit."
   s.description     = "Tell test/unit exactly which tests you want run. It will ignore all the other ones and let you concentrate on a few."
   s.author          = "Martin Aumont"
@@ -64,3 +64,16 @@ desc "Uninstall gem"
 task :uninstall => :clean do
   sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
 end
+
+desc "run framework compatibility tests"
+task :test_all do
+  paths = %w(
+    test/compat/test_contest.rb
+    test/compat/test_context.rb
+    test/compat/test_minitest.rb
+    test/compat/test_shoulda.rb
+    test/compat/test_test_unit.rb
+    test/test_phocus.rb
+  )
+  paths.each {|path| system("ruby #{path}") }
+end

data/TODO

@@ -7,7 +7,7 @@ o test (implement?) compatibility with test/unit plugins
   o test/spec
     ...
 
-o add docs
+x add docs
   - rdocs, README
 
 o focus do
@@ -16,3 +16,5 @@ o focus do
   end
 
   to focus a group of tests at once
+
+x autodetect test framework; simply use `require 'phocus'`

data/lib/phocus/autodetect.rb

@@ -0,0 +1,46 @@
+# :stopdoc:
+# Script to auto detect the test framework in use, and set it up with Phocus.
+
+# Somewhat hackish, but simple/straightforward. If there ever is a need for
+# extendability I'll gladly refactor.
+
+
+# --------------------------------------------------
+# test/unit, contest
+# --------------------------------------------------
+if defined?(Test::Unit::TestCase)
+
+  Test::Unit::TestCase.class_eval { include ::Phocus }
+  Test::Unit::TestSuite.class_eval { def empty?() false end }
+  Phocus.method_pattern = /^test_/
+end
+
+# --------------------------------------------------
+# minitest
+# --------------------------------------------------
+if defined?(MiniTest::Unit::TestCase)
+
+  MiniTest::Unit::TestCase.class_eval { include ::Phocus }
+  Phocus.method_pattern = /^test_/
+end
+
+# --------------------------------------------------
+# context
+# --------------------------------------------------
+if defined?(Test::Unit::TestCase) &&
+            Test::Unit::TestCase.class_eval { class << self; self; end }.included_modules.map {|m| m.to_s }.include?('Context::Context')
+
+  Test::Unit::TestCase.class_eval { include ::Phocus }
+  Phocus.method_pattern = /test:/
+end
+
+# --------------------------------------------------
+# shoulda (test/unit)
+# --------------------------------------------------
+if defined?(Test::Unit::TestCase) &&
+   defined?(Shoulda)
+
+  Test::Unit::TestCase.class_eval { include ::Phocus }
+  Test::Unit::TestSuite.class_eval { def empty?() false end }
+  Phocus.method_pattern = /^test:/
+end

data/lib/phocus.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 # Phocus let's you single out selected methods out of a defined group of methods.
 #
 # It is intended to be used to focus one or more tests in a test suite,
@@ -93,7 +95,7 @@ module Phocus
     # If the method belongs to target group (method_pattern), then remove it
     # unless it is focused.
     #
-    # we don't want any methods removed if focus is never used, so until it is,
+    # We don't want any methods removed if focus is never used, so until it is,
     # keep a reference to methods being defined so that we can come back and
     # remove them later.
     #
@@ -117,3 +119,5 @@ module Phocus
       end
   end
 end
+
+require Pathname(__FILE__).dirname.expand_path + 'phocus/autodetect'

data/phocus.gemspec

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: phocus
 version: !ruby/object:Gem::Version 
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-29 00:00:00 -04:00
+date: 2009-06-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -36,11 +36,7 @@ files:
 - TODO
 - lib
 - lib/phocus
-- lib/phocus/context.rb
-- lib/phocus/shoulda.rb
-- lib/phocus/contest.rb
-- lib/phocus/minitest.rb
-- lib/phocus/test_unit.rb
+- lib/phocus/autodetect.rb
 - lib/phocus.rb
 - phocus.gemspec
 - LICENSE

data/test/README

@@ -4,3 +4,5 @@ Each test file uses it's own framework, so they must be run individually.
   ruby test/compat/test_test_unit.rb
   ruby test/compat/test_context.rb
   ...
+
+<tt>rake test_all</tt> will do just that.

data/test/compat/test_contest.rb

@@ -1,5 +1,6 @@
 require 'test/test_helper'
-require 'lib/phocus/contest'
+require 'contest'
+require 'lib/phocus'
 
 class Test::Unit::TestCase
   def setup

data/test/compat/test_context.rb

@@ -1,5 +1,6 @@
 require 'test/test_helper'
-require 'lib/phocus/context'
+require 'context'
+require 'lib/phocus'
 
 # should focus a method
 class TestContextA < Test::Unit::TestCase

data/test/compat/test_minitest.rb

@@ -1,5 +1,6 @@
 require 'test/test_helper'
-require 'lib/phocus/minitest'
+require 'minitest/autorun'
+require 'lib/phocus'
 
 class MiniTest::Unit::TestCase
   def setup

data/test/compat/test_shoulda.rb

@@ -1,5 +1,9 @@
 require 'test/test_helper'
-require 'lib/phocus/shoulda' # testing shoulda/test_unit
+require 'test/unit'
+require 'shoulda'
+require 'lib/phocus'
+
+# testing shoulda/test_unit
 
 class Test::Unit::TestCase
   def setup

data/test/compat/test_test_unit.rb

@@ -1,5 +1,6 @@
 require 'test/test_helper'
-require 'lib/phocus/test_unit'
+require 'test/unit'
+require 'lib/phocus'
 
 class Test::Unit::TestCase
   def setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-phocus
 version: !ruby/object:Gem::Version 
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 21:00:00 -07:00
+date: 2009-06-09 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -36,11 +36,7 @@ files:
 - TODO
 - lib
 - lib/phocus
-- lib/phocus/context.rb
-- lib/phocus/shoulda.rb
-- lib/phocus/contest.rb
-- lib/phocus/minitest.rb
-- lib/phocus/test_unit.rb
+- lib/phocus/autodetect.rb
 - lib/phocus.rb
 - phocus.gemspec
 - LICENSE

data/lib/phocus/contest.rb

@@ -1,13 +0,0 @@
-require 'pathname'
-require 'contest'
-
-root  = Pathname(__FILE__).dirname.parent.parent.expand_path
-require root + 'lib/phocus'
-
-module Test #:nodoc: all
-  class Unit::TestCase
-    include ::Phocus
-  end
-end
-
-Phocus.method_pattern = /^test_/

data/lib/phocus/context.rb

@@ -1,13 +0,0 @@
-require 'pathname'
-require 'context'
-
-root  = Pathname(__FILE__).dirname.parent.parent.expand_path
-require root + 'lib/phocus'
-
-module Test #:nodoc: all
-  class Unit::TestCase
-    include ::Phocus
-  end
-end
-
-Phocus.method_pattern = /test:/

data/lib/phocus/minitest.rb

@@ -1,15 +0,0 @@
-require 'pathname'
-require 'minitest/unit'
-
-root  = Pathname(__FILE__).dirname.parent.parent.expand_path
-require root + 'lib/phocus'
-
-module MiniTest #:nodoc: all
-  class Unit::TestCase
-    include ::Phocus
-  end
-end
-
-Phocus.method_pattern = /^test_/
-
-MiniTest::Unit.autorun

data/lib/phocus/shoulda.rb

@@ -1,23 +0,0 @@
-require 'pathname'
-require 'test/unit'
-require 'shoulda'
-
-root  = Pathname(__FILE__).dirname.parent.parent.expand_path
-require root + 'lib/phocus'
-
-module Test #:nodoc: all
-  class Unit::TestCase
-    include ::Phocus
-  end
-end
-
-module Test #:nodoc: all
-  class Unit::TestSuite
-    # TODO only override when @@__focused
-    def empty?
-      false
-    end
-  end
-end
-
-Phocus.method_pattern = /^test:/

data/lib/phocus/test_unit.rb

@@ -1,22 +0,0 @@
-require 'pathname'
-require 'test/unit'
-
-root  = Pathname(__FILE__).dirname.parent.parent.expand_path
-require root + 'lib/phocus'
-
-module Test #:nodoc: all
-  class Unit::TestCase
-    include ::Phocus
-  end
-end
-
-module Test #:nodoc: all
-  class Unit::TestSuite
-    # TODO only override when @@__focused
-    def empty?
-      false
-    end
-  end
-end
-
-Phocus.method_pattern = /^test_/