mynyml-phocus 0.9.4 → 0.9.8

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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. 

data/README

@@ -0,0 +1,95 @@
+==== Intro
+
+Phocus let's you temporarily focus some tests, ignoring all others, even across test classes.
+
+==== Examples
+
+  require 'test/unit'
+  require 'phocus/test_unit'
+
+  class TestUser < Test::Unit::TestCase
+
+    focus
+    def test_foo
+      assert User.authenticate('...')
+    end
+
+    def test_bar
+      assert User.do_something_else
+    end
+  end
+
+  class TestAcmeWidget < Test::Unit::TestCase
+
+    def test_abc
+      assert true
+    end
+
+    focus
+    def test_xyz
+      assert true
+    end
+  end
+
+Executing these tests (say with <tt>rake test</tt> or <tt>autotest</tt>), will
+only run <tt>test_foo</tt> and <tt>test_xyz</tt>.
+
+Also works fine with <tt>test "description"</tt> style tests.
+
+    focus
+    test "abc" do
+      assert true
+    end
+
+==== Phocus Vs. Editor
+
+"Dude, MY editor already does that! Just get a real editor!!1!"
+
+Actually, so does my editor. But I've found that in many situations, it was far
+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.
+
+Debugging:
+Some editors will even allow you to step into the code when using
+<tt>debugger</tt> within that single test, but it's usually not as convenient
+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:
+
+  require 'phocus/test_unit'
+  require 'phocus/minitest'
+  require 'phocus/shoulda'
+  require 'phocus/context'
+  require 'phocus/contest'
+
+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.
+
+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)
+
+==== Links
+source:: http://github.com/mynyml/phocus
+rdocs::  http://docs.github.com/mynyml/phocus
+
+==== License
+MIT. See LICENSE file.

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'phocus'
-  s.version         = '0.9.4'
+  s.version         = '0.9.8'
   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"
@@ -33,6 +33,16 @@ spec = Gem::Specification.new do |s|
   s.files           = all_except([/doc/, /pkg/])
 end
 
+desc "Generate rdoc documentation."
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Phocus"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
 Rake::GemPackageTask.new(spec) do |p|
   p.gem_spec = spec
 end
@@ -54,13 +64,3 @@ desc "Uninstall gem"
 task :uninstall => :clean do
   sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
 end
-
-desc "Generate rdoc documentation."
-Rake::RDocTask.new("rdoc") { |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.title    = "Simple Router - Document"
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.options << '--charset' << 'utf-8'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-}

data/lib/phocus/contest.rb

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

data/lib/phocus/context.rb

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

data/lib/phocus/minitest.rb

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

data/lib/phocus/shoulda.rb

@@ -5,14 +5,18 @@ require 'shoulda'
 root  = Pathname(__FILE__).dirname.parent.parent.expand_path
 require root + 'lib/phocus'
 
-class Test::Unit::TestCase
-  include ::Phocus
+module Test #:nodoc: all
+  class Unit::TestCase
+    include ::Phocus
+  end
 end
 
-class Test::Unit::TestSuite
-  # TODO only override when @@__focused
-  def empty?
-    false
+module Test #:nodoc: all
+  class Unit::TestSuite
+    # TODO only override when @@__focused
+    def empty?
+      false
+    end
   end
 end
 

data/lib/phocus/test_unit.rb

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

data/lib/phocus.rb

@@ -1,13 +1,74 @@
+# 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,
+# although it is generic enough that it could conceivably be used in other
+# circumstances as well.
+#
+# Use the <tt>focus</tt> statement right before defining your test method.
+#
+# ===== Examples
+#   require 'test/unit'
+#   require 'phocus'
+#
+#   Phocus.method_pattern = /^test_/
+#
+#   class TestUser < Test::Unit::TestCase
+#     include Phocus
+#
+#     focus
+#     def test_foo
+#       assert true
+#     end
+#
+#     def test_bar
+#       flunk "not focused"
+#     end
+#   end
+#
+# When executed, only test_foo will be run. Can also be used on more than one
+# methods.
+#
+# Phocus also let's you focus methods across classes, which is almost always
+# the desired behaviour. Simply include the mixin in the parent class. In the
+# case of test/unit and test/unit based testing frameworks, this means:
+#
+#   class Test::Unit::TestCase
+#     include Phocus
+#   end
+#
+# Now focusing will work across *all* your tests. Not much benifit if you run
+# your test files individually, but indispensable when using <tt>rake test</tt>
+# or autotest.
+#
 module Phocus
   class << self
     attr_accessor :method_pattern
 
+    # Specify a pattern that identifies the names of the group of methods
+    # focusing will apply to.
+    #
+    # For example, when using test/unit, you want the relevant group of methods
+    # to be your test methods, which are the ones starting with <tt>test_</tt>.
+    #
+    #   Phocus.method_pattern = /^test_/
+    #
+    # (which happens to be the default pattern)
+    #
+    # On the other hand, context (http://github.com/jeremymcanally/context),
+    # has test methods starting with <tt>test:</tt>, so you can specify:
+    #
+    #   Phocus.method_pattern = /^test:/
+    #
+    # In reality, it's not so much that Phocus focuses on certain methods, but
+    # rather it ignores others. Since we don't want to ignore helper methods
+    # (setup, teardown, custom helpers, etc.), we must restrict the scope of
+    # ignored methods, which is what <tt>method_pattern</tt> allows us to do.
     def method_pattern
       @method_pattern || /^test_/
     end
   end
 
-  def self.included(base)
+  def self.included(base) #:nodoc:
     base.extend ClassMethods
   end
 
@@ -16,19 +77,28 @@ module Phocus
     @@__focused      = false
     @@__focus_next   = false
 
-    def focused
+    # Use right before defining a method to focus it.
+    def focus
       unless @@__focused
         clear_test_methods!
         @@__focused = true
       end
       @@__focus_next = true
     end
-    alias :focus  :focused
-    alias :phocus :focused
+    # :stopdoc:
+    alias :focused :focus
+    alias :phocus  :focus
+    # :startdoc:
 
-    def method_added(name)
+    # 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,
+    # keep a reference to methods being defined so that we can come back and
+    # remove them later.
+    #
+    def method_added(name) #:nodoc:
       super
-      #if name.to_s.match(/^test/)
       if name.to_s.match(Phocus.method_pattern)
         if @@__focused
           @@__focus_next ? @@__focus_next = false : remove_method(name)

data/phocus.gemspec

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: phocus
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.8
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-28 00:00:00 -04:00
+date: 2009-05-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,7 @@ files:
 - lib/phocus/test_unit.rb
 - lib/phocus.rb
 - phocus.gemspec
+- LICENSE
 - README
 has_rdoc: true
 homepage: ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-phocus
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.8
 platform: ruby
 authors: 
 - Martin Aumont
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-27 21:00:00 -07:00
+date: 2009-05-28 21:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,7 @@ files:
 - lib/phocus/test_unit.rb
 - lib/phocus.rb
 - phocus.gemspec
+- LICENSE
 - README
 has_rdoc: true
 homepage: ""