test-belt 0.1.0

data/README.rdoc

@@ -0,0 +1,96 @@
+= TestBelt
+
+== 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.
+
+== Installation
+
+    gem install test-belt
+
+TestBelt only impacts your testing environment or setup and is designed only for testing scenarios.  Here are a few ways of bringing it in to your tool:
+* As a development dependency for a gem:
+    Gem::Specification.new do |s|
+      # your spec stuff ...
+
+      s.add_development_dependency("test-belt")
+    end
+
+* As a Gemfile test dependency:
+    source 'http://rubygems.org'
+
+    # other gem dependencies ...
+
+    group :test do
+      gem 'test-belt'
+
+      # other testing gem dependencies ...
+    end
+
+== Test Helper
+Using the TestBelt test helper loads in the testing libraries I like and use.  In your test files or a common test helper file, require in the helper:
+    require 'test_belt/helper'
+
+This will give you the following:
+
+=== Test::Unit
+just write Test::Unit tests with assertions
+
+=== Leftright
+https://github.com/jordi/leftright
+
+=== Shoulda
+https://github.com/thoughtbot/shoulda
+
+=== Shoulda enhancements
+I've added some handy macros and extensions to some things Shoulda does.  None of these are required so just use them as you see fit.  Here's a sampling of what is added:
+* Class interface macros:
+** should_have_class_methods
+** should_have_readers
+** etc
+* Files macros:
+** should_have_files
+** should_have_directories
+** etc
+* Context macros:
+** before/after aliases for setup/teardown
+** etc
+
+I use most of these helpers in testing this gem.  To see examples of these in action, peruse this gem's test files and run the test suite with:
+    $ rake test
+
+== Rake tasks for running tests
+TestBelt can provide an automatic set of rake tasks for testing subsets of your code base.  These tasks are defined based on the structure of your test files.  To use this first add this to your Rakefile:
+
+    require 'rubygems'
+    require 'test_belt/rake_tasks'
+    TestBelt::RakeTasks.for :test      # this assumes your test files are located in /test
+
+To see what this gives you:
+
+    $ rake -T
+
+== License
+
+Copyright (c) 2010 Kelly D. Redding
+
+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/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'lib/test_belt/version'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'test-belt'
+  s.version          = TestBelt::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A library for using testing tools I like - my Ruby testing toolbelt."
+  s.author           = 'Kelly Redding'
+  s.email            = 'kelly@kelredd.com'
+  s.homepage         = 'http://github.com/kelredd/test-belt'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
+  # s.executables      = ['test-belt']
+
+  s.add_development_dependency("shoulda", [">= 2.10.0"])
+  s.add_development_dependency("leftright", [">= 0.0.6"])
+  s.add_development_dependency("kelredd-useful", [">= 0.4.0"])
+  s.add_development_dependency("kelredd-simple-gem", [">= 0.7.0"])
+
+  # s.add_dependency("gem-name", [">= 0"])
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc 'Generate the gemspec for this gem'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+task :default => :gem
+
+require 'lib/test_belt/rake_tasks'
+TestBelt::RakeTasks.for :test
+

data/lib/test_belt.rb

@@ -0,0 +1,2 @@
+module TestBelt
+end

data/lib/test_belt/helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'leftright'
+require 'shoulda'
+require 'test_belt/shoulda_macros'

data/lib/test_belt/rake_tasks.rb

@@ -0,0 +1,84 @@
+require 'rake'
+require 'rake/tasklib'
+
+module TestBelt; end
+module TestBelt::RakeTasks
+
+  FILE_SUFFIX = "_test.rb"
+
+  class TestTask < Rake::TaskLib
+    attr_accessor :name, :description, :test_files
+
+    # Create a testing task.
+    def initialize(name=:test)
+      @name = name
+      @description = "Run tests" + (@name==:test ? "" : " for #{@name}")
+      @test_files = []
+      yield self if block_given?
+    end
+
+    # Define the rake task to run this test suite
+    def to_task
+      desc @description
+      task @name do
+        RakeFileUtils.verbose(true) { ruby "\"#{rake_loader}\" " + file_list }
+      end
+    end
+
+    def file_list # :nodoc:
+      @test_files.collect{|f| "\"#{f}\""}.join(' ')
+    end
+
+    protected
+
+    def rake_loader # :nodoc:
+      find_file('rake/rake_test_loader') or
+        fail "unable to find rake test loader"
+    end
+
+    def find_file(fn) # :nodoc:
+      $LOAD_PATH.each do |path|
+        file_path = File.join(path, "#{fn}.rb")
+        return file_path if File.exist? file_path
+      end
+      nil
+    end
+  end
+
+  class << self
+    def for(test_namespace = :test)
+      self.to_tasks(test_namespace.to_s)
+    end
+
+    def to_tasks(path)
+      suite_name = File.basename(path)
+
+      # define a rake test task for all top-level test files at this path
+      if !Dir.glob(File.join(path, "**/*#{FILE_SUFFIX}")).empty?
+        TestTask.new(suite_name.to_sym) do |t|
+          file_location = suite_name == path ? '' : " for #{File.join(path.split(File::SEPARATOR)[1..-1])}"
+          t.description = "Run all tests#{file_location}"
+          t.test_files = FileList["#{path}/**/*#{FILE_SUFFIX}"]
+        end.to_task
+      end
+
+      namespace suite_name.to_s do
+        # define rake test tasks for each top-level test file individually
+        Dir.glob(File.join(path, "*#{FILE_SUFFIX}")).each do |test_file|
+          test_name = File.basename(test_file, FILE_SUFFIX)
+          TestTask.new(test_name.to_sym) do |t|
+            t.description = "Run tests for #{[path.split(File::SEPARATOR), test_name].flatten[1..-1].join(':')}"
+            t.test_files = FileList[test_file]
+          end.to_task
+        end
+
+        # recursively define rake test tasks for each file
+        # in each top-level directory
+        Dir.glob(File.join(path, "*/")).each do |test_dir|
+          self.to_tasks(test_dir)
+        end
+      end
+    end
+  end
+
+end

data/lib/test_belt/shoulda_macros.rb

@@ -0,0 +1,9 @@
+require 'shoulda'
+
+module TestBelt; end
+module TestBelt::ShouldaMacros; end
+
+require 'test_belt/shoulda_macros/classes'
+require 'test_belt/shoulda_macros/context'
+require 'test_belt/shoulda_macros/files'
+

data/lib/test_belt/shoulda_macros/classes.rb

@@ -0,0 +1,61 @@
+require 'useful/ruby_extensions/string' unless String.new.respond_to?(:constantize)
+
+module TestBelt; end
+module TestBelt::ShouldaMacros; end
+module TestBelt::ShouldaMacros::Classes
+
+  # Ripped from Shoulda::ActiveRecord::Macros
+  def should_have_class_methods(*methods)
+    get_options!(methods)
+    methods.each do |method|
+      should "respond to class method ##{method}" do
+        klass = construct_subject.class
+        assert_respond_to klass, method, "#{klass.name} does not have class method #{method}"
+      end
+    end
+  end
+  alias_method :should_have_class_method, :should_have_class_methods
+  protected :should_have_class_methods, :should_have_class_method
+
+
+  # Ripped from Shoulda::ActiveRecord::Macros
+  def should_have_instance_methods(*methods)
+    get_options!(methods)
+    methods.each do |method|
+      should "respond to instance method ##{method}" do
+        the_subject = construct_subject
+        assert_respond_to(the_subject, method, "#{the_subject.class.name} does not have instance method #{method}")
+      end
+    end
+  end
+  alias_method :should_have_instance_method, :should_have_instance_methods
+  protected :should_have_instance_methods, :should_have_instance_method
+
+
+  def should_have_readers(*readers)
+    get_options!(readers)
+    should_have_instance_methods *readers
+  end
+  alias_method :should_have_reader, :should_have_readers
+  protected :should_have_readers, :should_have_reader
+
+
+  def should_have_writers(*writers)
+    get_options!(writers)
+    should_have_instance_methods *(writers.collect{|w| "#{w}="})
+  end
+  alias_method :should_have_writer, :should_have_writers
+  protected :should_have_writers, :should_have_writer
+
+
+  def should_have_accessors(*accessors)
+    get_options!(accessors)
+    should_have_instance_methods *accessors
+    should_have_instance_methods *(accessors.collect{|a| "#{a}="})
+  end
+  alias_method :should_have_accessor, :should_have_accessors
+  protected :should_have_accessors, :should_have_accessor
+
+end
+
+Test::Unit::TestCase.extend(TestBelt::ShouldaMacros::Classes) if defined? Test::Unit::TestCase

data/lib/test_belt/shoulda_macros/context.rb

@@ -0,0 +1,25 @@
+module TestBelt; end
+module TestBelt::ShouldaMacros; end
+module TestBelt::ShouldaMacros::Context
+end
+
+
+if defined? Shoulda::Context
+  module Shoulda
+    class Context
+
+      alias_method :before, :setup
+      alias_method :after, :teardown
+
+      # TODO: override described_type to use string blessed with constantize method
+      # alias_method(:orig_described_type, :described_type) rescue NameError
+      # def described_type
+      #   self.name.gsub(/Test$/, '').constantize
+      # end
+      # protected :described_type
+
+    end
+  end
+
+  Shoulda::Context.extend(TestBelt::ShouldaMacros::Context)
+end

data/lib/test_belt/shoulda_macros/files.rb

@@ -0,0 +1,31 @@
+require 'useful/ruby_extensions/string' unless String.new.respond_to?(:constantize)
+
+module TestBelt; end
+module TestBelt::ShouldaMacros; end
+module TestBelt::ShouldaMacros::Files
+
+  def should_have_files(*files)
+    the_files = files.flatten
+    if the_files.empty?
+      should "have @root_path" do
+        assert @root_path, "the variable @root_path is not defined"
+        assert File.exists?(@root_path), "'#{@root_path}' does not exist"
+      end
+    else
+      the_files.each do |file|
+        should "have the file '#{file}' in @root_path" do
+          assert @root_path, "the variable @root_path is not defined"
+          assert File.exists?(File.join(@root_path, file)), "'#{file}' does not exist in '#{@root_path}'"
+        end
+      end
+    end
+  end
+  protected :should_have_files
+
+  alias_method :should_have_file, :should_have_files
+  alias_method :should_have_directories, :should_have_files
+  alias_method :should_have_directory, :should_have_files
+
+end
+
+Test::Unit::TestCase.extend(TestBelt::ShouldaMacros::Files) if defined? Test::Unit::TestCase

data/lib/test_belt/test_unit/context.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+require 'test_belt/test_unit/runner'
+
+module Test::Unit
+
+  class TestCase
+
+    class << self
+
+      def _testbelt_suite_callbacks
+        @_testbelt_suite_callbacks ||= {
+          :started => [],
+          :finished => []
+        }
+      end
+
+      def _testbelt_testcase_callbacks
+        @_testbelt_testcase_callbacks ||= {
+          :setup => [],
+          :teardown => []
+        }
+      end
+
+      protected
+
+      # Suite level callbacks
+      def suite_started(&block)
+        ::Test::Unit::TestCase._testbelt_suite_callbacks[:started] << block
+      end
+      alias :on_suite_started :suite_started
+
+      def suite_finished(&block)
+        ::Test::Unit::TestCase._testbelt_suite_callbacks[:finished] << block
+      end
+      alias :on_suite_finished :suite_finished
+
+      # TestCase level callbacks
+      def setup_once(&block)
+        _testbelt_testcase_callbacks[:setup] << block
+      end
+      alias :before_once :setup_once
+
+      def teardown_once(&block)
+        _testbelt_testcase_callbacks[:teardown] << block
+      end
+      alias :after_once :teardown_once
+
+    end
+  end
+
+
+  # override the TestSuite with TestCase callbacks
+  class TestSuite
+    alias_method :run_without_testbelt_callbacks, :run
+
+    def run(*args, &block) # :nodoc:
+      if !tests.empty? && (testclass = tests.first).kind_of?(::Test::Unit::TestCase)
+        tests.first.class._testbelt_testcase_callbacks[:setup].each do |callback|
+          callback.call
+        end
+      end
+      run_without_testbelt_callbacks *args, &block
+      if !tests.empty? && (testclass = tests.first).kind_of?(::Test::Unit::TestCase)
+        tests.first.class._testbelt_testcase_callbacks[:teardown].reverse.each do |callback|
+          callback.call
+        end
+      end
+    end
+  end
+
+end

data/lib/test_belt/test_unit/runner.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+module TestBelt; end
+module TestBelt::TestUnit
+
+  if defined? ::LeftRight::Runner
+    class Runner < ::LeftRight::Runner; end
+  else
+    class Runner < ::Test::Unit::UI::Console::TestRunner; end
+  end
+
+  class Runner
+    def started(*args)
+      super
+      if ::Test::Unit::TestCase.respond_to?("_testbelt_suite_callbacks")
+        ::Test::Unit::TestCase._testbelt_suite_callbacks[:started].each do |callback|
+          callback.call
+        end
+      end
+    end
+
+    def finished(*args)
+      if ::Test::Unit::TestCase.respond_to?("_testbelt_suite_callbacks")
+        ::Test::Unit::TestCase._testbelt_suite_callbacks[:finished].reverse.each do |callback|
+          callback.call
+        end
+      end
+      super
+    end
+  end
+
+end
+
+module Test::Unit
+
+  # override the AutoRunner's runner to use TestBelt's
+  # with callback for suite started/finished
+  class AutoRunner
+    alias_method :initialize_without_testbelt_runner, :initialize
+
+    def initialize(*args)
+      initialize_without_testbelt_runner *args
+      @runner = lambda { |r| ::TestBelt::TestUnit::Runner }
+    end
+  end
+
+end

data/lib/test_belt/version.rb

@@ -0,0 +1,13 @@
+module TestBelt
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: test-belt
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: leftright
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
+        version: 0.0.6
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: kelredd-useful
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: kelredd-simple-gem
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :development
+  version_requirements: *id004
+description: 
+email: kelly@kelredd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/test_belt/helper.rb
+- lib/test_belt/rake_tasks.rb
+- lib/test_belt/shoulda_macros/classes.rb
+- lib/test_belt/shoulda_macros/context.rb
+- lib/test_belt/shoulda_macros/files.rb
+- lib/test_belt/shoulda_macros.rb
+- lib/test_belt/test_unit/context.rb
+- lib/test_belt/test_unit/runner.rb
+- lib/test_belt/version.rb
+- lib/test_belt.rb
+has_rdoc: true
+homepage: http://github.com/kelredd/test-belt
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for using testing tools I like - my Ruby testing toolbelt.
+test_files: []
+