test-belt 1.1.2 → 2.0.0

data/.gitignore

@@ -3,3 +3,4 @@
 /coverage/
 *.log
 .bundle
+.rvmrc

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in i-env.gemspec
 gemspec
+
+gem 'rake', '~>0.9.2'

data/Gemfile.lock

@@ -1,17 +1,19 @@
 PATH
   remote: .
   specs:
-    test-belt (1.1.2)
+    test-belt (2.0.0)
       leftright (~> 0.9.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     leftright (0.9.1)
+    rake (0.9.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
+  rake (~> 0.9.2)
   test-belt!

data/README.rdoc

@@ -22,16 +22,20 @@ TestBelt only impacts your testing environment or setup and is designed only for
     # other gem dependencies ...
 
     group :test do
-      gem 'test-belt', :require => 'test_belt'
+      gem 'test-belt'
 
       # other testing gem dependencies ...
     end
 
 == Test Helpers
-Requiring test belt loads in the testing libraries I like and use.  In your test files or a common test helper file, require in test belt:
+Requiring test belt loads in the testing libraries I like and use.  First make sure all your tests are in a 'test' directory.  Then in your test files require in test belt:
     require 'test_belt'
 
-This will give you the following tools.  I use most of these helpers in testing this gem.  To see examples of these in action, peruse this gem's test files (https://github.com/kelredd/test-belt/tree/master/test) and run the test suite with:
+This does a few things for you:
+* adds your 'lib' and 'test' dirs to the $LOAD_PATH
+* requires in a 'test/helper' file if one exists
+
+In addition, it gives you the following tools.  I use most of these helpers in testing this gem.  To see examples of these in action, peruse this gem's test files (https://github.com/kelredd/test-belt/tree/master/test) and run the test suite with:
     $ rake test
 
 === Test::Unit
@@ -83,7 +87,7 @@ To see what this gives you:
     $ rake -T
 
 === IRB with your environment loaded
-Many times in developing code, I need to quickly load up IRB with my environment.  TestBelt will give you a rake task for doing that.  Simply create an env.rb file that loads your environment in your test file directory (/test for example).  See https://github.com/kelredd/test-belt/tree/master/test/env.rb and demo for this gem with:
+Many times in developing code, I need to quickly load up IRB with my environment.  TestBelt will give you a rake task for doing that.  Simply create an irb.rb file in your test file directory and have it require 'test_belt'.  See https://github.com/kelredd/test-belt/tree/master/test/irb.rb and demo for this gem with:
 
     $ rake irb
     > TestBelt

data/Rakefile

@@ -1,7 +1,9 @@
+include Rake::DSL
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'lib/test_belt/rake_tasks'
+require 'test_belt/rake_tasks'
 TestBelt::RakeTasks.for :test
 
 task :default => :build

data/lib/test-belt.rb

@@ -0,0 +1,2 @@
+# so you don't have to specify a :require opt in your Gemfile
+require 'test_belt'

data/lib/test_belt.rb

@@ -1,2 +1,4 @@
 module TestBelt; end
-require 'test_belt/helper'
+
+require 'test_belt/setup'
+TestBelt.setup(caller)

data/lib/test_belt/helper.rb

@@ -1,30 +1,2 @@
-require 'rubygems'
-require 'test/unit'
-require 'leftright'
-
-require 'test_belt/utils'
-require 'test_belt/default_test'
-require 'test_belt/testcase'
-require 'test_belt/should'
-require 'test_belt/context'
-require 'test_belt/subject'
-require 'test_belt/skip'
-require 'test_belt/callbacks'
-require 'test_belt/matchers'
-
-module TestBelt
-
-  def self.included(receiving_test_class)
-    if receiving_test_class.ancestors.include?(::Test::Unit::TestCase)
-      receiving_test_class.send(:include, DefaultTest)
-      receiving_test_class.send(:include, TestCase)
-      receiving_test_class.send(:extend,  Should)
-      receiving_test_class.send(:include, Context)
-      receiving_test_class.send(:include, Subject)
-      receiving_test_class.send(:include, Skip)
-      receiving_test_class.send(:include, Callbacks)
-      receiving_test_class.send(:include, Matchers)
-    end
-  end
-
-end
+# for backwards compatibility
+require 'test_belt/setup'

data/lib/test_belt/rake_tasks.rb

@@ -52,11 +52,11 @@ module TestBelt::RakeTasks
     end
 
     def irb_task(path)
-      env_file = File.join(path, "env.rb")
-      if File.exist?(env_file)
-        desc "Open irb preloaded with #{env_file}"
+      irb_file = File.join(path, "irb.rb")
+      if File.exist?(irb_file)
+        desc "Open irb preloaded with #{irb_file}"
         task :irb do
-          sh "irb -rubygems -r ./#{env_file}"
+          sh "irb -rubygems -r ./#{irb_file}"
         end
       end
     end

data/lib/test_belt/setup.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'test/unit'
+require 'leftright'
+
+require 'test_belt/utils'
+require 'test_belt/default_test'
+require 'test_belt/testcase'
+require 'test_belt/should'
+require 'test_belt/context'
+require 'test_belt/subject'
+require 'test_belt/skip'
+require 'test_belt/callbacks'
+require 'test_belt/matchers'
+
+module TestBelt
+
+  def self.included(receiving_test_class)
+    if receiving_test_class.ancestors.include?(::Test::Unit::TestCase)
+      receiving_test_class.send(:include, DefaultTest)
+      receiving_test_class.send(:include, TestCase)
+      receiving_test_class.send(:extend,  Should)
+      receiving_test_class.send(:include, Context)
+      receiving_test_class.send(:include, Subject)
+      receiving_test_class.send(:include, Skip)
+      receiving_test_class.send(:include, Callbacks)
+      receiving_test_class.send(:include, Matchers)
+    end
+  end
+
+
+  # assume the test dir path is ./test and the lib dir path ./test/../lib
+  TEST_DIR = "test"
+  LIB_DIR = "lib"
+  TEST_REGEX = /^#{TEST_DIR}$|^#{TEST_DIR}\/|\/#{TEST_DIR}\/|\/#{TEST_DIR}$/
+  TEST_HELPER_FILE = "helper"
+  class << self
+
+    # run some setup stuff based on the caller's info
+    def setup(caller_info)
+      if (crp = caller_root_path(caller_info))
+        add_caller_paths_to_load_path(crp)
+        require_caller_test_helper(crp)
+      end
+    end
+
+    private
+
+    # add the caller's lib/test dirs to the load path
+    def add_caller_paths_to_load_path(root_path)
+      add_to_load_path(File.join(root_path, LIB_DIR))
+      add_to_load_path(File.join(root_path, TEST_DIR))
+    end
+
+    def add_to_load_path(dir)
+      $LOAD_PATH.unshift(dir) unless $LOAD_PATH.include?(dir)
+    end
+
+    # require the caller's test/helper file if exists
+    def require_caller_test_helper(root_path)
+      if File.exists?(File.join(root_path, TEST_DIR, TEST_HELPER_FILE+'.rb')) &&
+         $LOAD_PATH.include?(File.join(root_path, TEST_DIR))
+        require TEST_HELPER_FILE
+      end
+    end
+
+    # this method inspects the caller info and finds the caller's root path
+    # this expects the caller's root path to be the parent dir of the first
+    # parent dir of caller named TEST_DIR
+    def caller_root_path(caller_info)
+      caller_dirname = File.expand_path(File.dirname(caller_info[0]))
+      if (test_dir_pos = caller_dirname.index(TEST_REGEX)) > 0
+        root_dir = caller_dirname[0..(test_dir_pos-1)]
+      end
+    end
+
+  end
+
+end

data/lib/test_belt/version.rb

@@ -1,3 +1,3 @@
 module TestBelt
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

data/test/callbacks_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 
 module TestBelt
 

data/test/helper.rb

@@ -1 +1,2 @@
-require 'test/env'
+# this file is automatically required in when you require 'test_belt'
+# put test helpers here

data/test/helpers_test.rb

@@ -1,4 +1,4 @@
-require "test/helper"
+require "test_belt"
 
 module TestBelt
 

data/test/irb.rb

@@ -0,0 +1,8 @@
+require 'test_belt'
+
+# this file is required in when the 'irb' rake test is run
+# b/c 'test_belt' is required above, lib and test dirs will
+# be added to the LOAD_PATH and the test helper will be
+# required in.
+
+# put any IRB setup code here

data/test/matchers_test.rb

@@ -1,5 +1,5 @@
-require "test/helper"
-require 'test/fixtures/thing'
+require "test_belt"
+require 'fixtures/thing'
 
 module TestBelt::Matchers
 
@@ -25,7 +25,7 @@ module TestBelt::Matchers
     should have_directory 'test'
     should have_directories './test/fixtures'
     should have_file 'test/fixtures/thing.rb'
-    should have_files './test/env.rb', './test/helper.rb'
+    should have_files './test/irb.rb', './test/helper.rb'
   end
 
 

data/test/rake_tasks_test.rb

@@ -1,5 +1,5 @@
-require "test/helper"
-require 'lib/test_belt/rake_tasks'
+require "test_belt"
+require 'test_belt/rake_tasks'
 
 module TestBelt
   class RakeTasksTest < Test::Unit::TestCase

data/test/utils_test.rb

@@ -1,5 +1,5 @@
-require "test/helper"
-require 'test/fixtures/inherited_stuff'
+require "test_belt"
+require 'fixtures/inherited_stuff'
 
 module TestBelt::Utils
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: test-belt
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: 
   segments: 
-  - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Kelly D. Redding
@@ -15,11 +15,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-05 00:00:00 Z
+date: 2011-07-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +28,11 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: leftright
   prerelease: false
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,8 +44,10 @@ dependencies:
         - 9
         - 0
         version: 0.9.0
-  type: :runtime
   version_requirements: *id002
+  prerelease: false
+  name: leftright
+  type: :runtime
 description: This is my Ruby testing "tool belt".  It packages up the most common testing tools and paradigms I use.  It is opinionated and custom to how I like to test.
 email: 
 - kelly@kelredd.com
@@ -63,6 +63,7 @@ files:
 - Gemfile.lock
 - README.rdoc
 - Rakefile
+- lib/test-belt.rb
 - lib/test_belt.rb
 - lib/test_belt/callbacks.rb
 - lib/test_belt/callbacks/case.rb
@@ -80,6 +81,7 @@ files:
 - lib/test_belt/matchers/have_readers.rb
 - lib/test_belt/matchers/have_writers.rb
 - lib/test_belt/rake_tasks.rb
+- lib/test_belt/setup.rb
 - lib/test_belt/should.rb
 - lib/test_belt/skip.rb
 - lib/test_belt/subject.rb
@@ -88,11 +90,11 @@ files:
 - lib/test_belt/version.rb
 - test-belt.gemspec
 - test/callbacks_test.rb
-- test/env.rb
 - test/fixtures/inherited_stuff.rb
 - test/fixtures/thing.rb
 - test/helper.rb
 - test/helpers_test.rb
+- test/irb.rb
 - test/matchers_test.rb
 - test/rake_tasks_test.rb
 - test/utils_test.rb
@@ -131,11 +133,11 @@ specification_version: 3
 summary: A gem for using testing tools I like - my Ruby testing toolbelt.
 test_files: 
 - test/callbacks_test.rb
-- test/env.rb
 - test/fixtures/inherited_stuff.rb
 - test/fixtures/thing.rb
 - test/helper.rb
 - test/helpers_test.rb
+- test/irb.rb
 - test/matchers_test.rb
 - test/rake_tasks_test.rb
 - test/utils_test.rb

data/test/env.rb

@@ -1,9 +0,0 @@
-# Add test and lib paths to the $LOAD_PATH
-[ File.dirname(__FILE__),
-  File.join(File.dirname(__FILE__), '..', 'lib')
-].each do |path|
-  full_path = File.expand_path(path)
-  $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
-end
-
-require 'test_belt'