rubytest 0.6.0 → 0.7.0

data/.index

@@ -17,10 +17,6 @@ requirements:
   - build
   development: true
   name: detroit
-- groups:
-  - build
-  development: true
-  name: dotopts
 - groups:
   - test
   development: true
@@ -57,9 +53,9 @@ paths:
 created: '2011-07-23'
 summary: Ruby Universal Test Harness
 title: Ruby Test
-version: 0.6.0
+version: 0.7.0
 name: rubytest
 description: ! "Ruby Test is a universal test harness for Ruby. It can handle any
   compliant \ntest framework, even running tests from multiple frameworks in a single
   pass."
-date: '2013-02-09'
+date: '2013-02-17'

data/HISTORY.md

@@ -1,6 +1,39 @@
 # RELEASE HISTORY
 
-## 0.6.0 / 2013-02-10
+## 0.7.0 / 2013-02-18
+
+Version 0.7 is a significant release. The library has been simplified
+by spinning-off both the command-line tool and the Rake task as
+`rubytest-cli` and `rubytest-rake` respectively. This was done for a
+couple of good reasons: a) It focuses the the library on it's core
+functionality and b) and it makes the library suitable for becoming
+a Ruby standard library, should that ever become a possibility.
+
+Changes:
+
+* Spun off command-line tool as `rubytest-cli`.
+* Spun off Rake task as `rubytest-rake`.
+
+
+## 0.6.1 / 2013-02-16
+
+Configurations can now supply a before and after procedure to be
+run right before or right after tests are run. This can be useful
+for setting up coverage tools Simplecov, which has to be setup
+before the applicable code is required but after all supporting
+test infrustructure is required. This release also fixes
+the `-c/--config` option, to prevent name clashes between gems and
+local config files.
+
+Changes:
+
+* Add before and after config procs.
+* Fix -c/--config loading.
+* Remove use of DotOpts, it is not good enough yet.
+* Move Rake plugin to separate plugin project.
+
+
+## 0.6.0 / 2013-02-11
 
 This release of Ruby Test takes a hard step back and reconsiders how
 to handle configuration from the ground up. Current users of Ruby Test

data/README.md

@@ -2,8 +2,8 @@
 
 [Homepage](http://rubyworks.github.com/rubytest) /
 [User Guide](http://wiki.github.com/rubyworks/rubytest) /
-[Development](http://github.com/rubyworks/rubytest) /
-[Issues](http://github.com/rubyworks/rubytest/issues)
+[Support](http://github.com/rubyworks/rubytest/issues) /
+[Development](http://github.com/rubyworks/rubytest)
 
 [![Build Status](https://secure.travis-ci.org/rubyworks/rubytest.png)](http://travis-ci.org/rubyworks/rubytest)
 [![Gem Version](https://badge.fury.io/rb/rubytest.png)](http://badge.fury.io/rb/rubytest)
@@ -57,50 +57,64 @@ also be installed in an FHS compliant fashion if necessary.
 
 ## Running Tests
 
-There are a few ways to run tests. First, there is the command line tool
-e.g.
+There are a few ways to run tests. 
 
-    $ rubytest test/test_*.rb
+### Via Runner Scripts
 
-The command line tool takes various options, use `-h/--help` to see them.
+Out of the box Ruby Test doesn't provide any special means for doing so,
+you simply write you own runner script using the Ruby Test API.
+Here is the basic example:
 
-When running tests, you need to be sure to load in your test framework
-or your framework's Ruby Test adapter. This is usually done via a helper
-script in the test files, but might also be done via command line options,
-e.g.
+    require 'rubytest'
 
-    $ rubytest -r lemon -r ae test/test_*.rb
+    Test.run! do |r|
+      r.loadpath 'lib'
+      r.test_files 'test/test_*.rb'
+    end
+
+Put that in a `test/runner.rb` script and run it with `ruby` or
+add `#!/usr/bin/env ruby` at the top and put it in `bin/test`
+setting `chmod u+x bin/test`. Either way, you now have your test
+runner.
+
+### Via Command-line Tool
 
-Ruby Test supports [dotopts](http://rubyworks.github.com/dotopts) out of the
-box, so it easy to setup reusable options. For example, a `.option` file
-entry might be:
+Probably the easiest way to run tests is via the command line tool available
+via the `rubytest-cli` plug-in. You can read more about it on its
+[webpage](http://rubyworks.github.com/rubytest-cli), but we will quickly go
+over it here. 
 
-    rubytest
-      -f progress
-      -r spectroscope
-      -r rspecial
-      spec/spec_*.rb
+The basic usage example is:
 
-If you are using a build tool to run your tests, such as Rake or Fire, it is
-best to shell out to `rubytest`. This keeps your test environent as prestine
-as possible.
+    $ rubytest -Ilib test/test_*.rb
+
+The command line tool takes various options, most of which correspond directly
+to the configuration options of the `Test.run/Test.configure` API. Use
+`-h/--help` to see them all.
+
+If you are using a build tool to run your tests, such as Rake or Ergo, shelling
+out to `rubytest` is a good way to go as it keeps your test environment as 
+pristine as possible, e.g.
 
     desc "run tests"
     task :test
       sh "rubytest"
     end
 
-RubyTest comes with a Rake task plugin, but its use is all but deprecated
-because it's basically just a glorified rendition of the above.
+### Via Rake Task
+
+There is also a Rake plug-in that can be installed called `rubytest-rake`.
+Surf over to its [webpage](http://rubyworks.github.com/rubytest-rake) for details.
+A basic example in its case, add to ones Rakefile:
 
     require 'rubytest/rake'
 
     Test::Rake::TestTask.new :test do |run|
       run.requires << 'lemon'
-      run.files = 'test/test_*.rb'
+      run.test_files = 'test/test_*.rb'
     end
 
-See the Wiki for more information on the different ways to run tests.
+See the Wiki for more detailed information on the different ways to run tests.
 
 
 ## Requirements

data/demo/01_test.md

@@ -15,7 +15,8 @@ a test. For instance, given an abtriray object defined as follows.
 
 If we pass this to a test runner as part of a test suite,
 
-    runner = Test::Runner.new(:suite=>[test], :format=>'test')
+    config = Test::Config.new(:suite=>[test], :format=>'test')
+    runner = Test::Runner.new(config)
 
     success = runner.run
 

data/lib/rubytest.yml

@@ -17,10 +17,6 @@ requirements:
   - build
   development: true
   name: detroit
-- groups:
-  - build
-  development: true
-  name: dotopts
 - groups:
   - test
   development: true
@@ -57,9 +53,9 @@ paths:
 created: '2011-07-23'
 summary: Ruby Universal Test Harness
 title: Ruby Test
-version: 0.6.0
+version: 0.7.0
 name: rubytest
 description: ! "Ruby Test is a universal test harness for Ruby. It can handle any
   compliant \ntest framework, even running tests from multiple frameworks in a single
   pass."
-date: '2013-02-09'
+date: '2013-02-17'

data/lib/rubytest/cli.rb

@@ -33,11 +33,6 @@ module Test
     #
     # @return nothing
     def run(argv=nil)
-      begin
-        require 'dotopts'
-      rescue LoadError
-      end
-
       argv = (argv || ARGV.dup)
 
       options.parse!(argv)
@@ -86,6 +81,7 @@ module Test
           config.format = 'tapj'
         end
 
+        # tempted to change -T
         opt.on '-t', '--tag TAG', 'select tests by tag' do |tag|
           config.tags.concat makelist(tag)
         end
@@ -118,6 +114,9 @@ module Test
         opt.on '-c', '--config FILE', "require local config file (immediately)" do |file|
           config.load_config(file)
         end
+        #opt.on '-T', '--tests GLOB', "tests to run (if none given as arguments)" do |glob|
+        #  config.files << glob
+        #end
         opt.on '-V' , '--verbose', 'provide extra detail in reports' do
           config.verbose = true
         end

data/lib/rubytest/config.rb

@@ -1,13 +1,18 @@
 module Test
 
+  # Stores test configurations.
+  def self.config
+    @config ||= {}
+  end
+
   # Configure test run via a block then will be passed a `Config` instance.
   #
   # @return [Config]
-  def self.configure(&block)
+  def self.configure(profile=nil, &block)
     if reconfigure?
-      configuration.apply(&block)
+      configuration(profile).apply(profile, &block)
     else
-      @config = Config.new(&block)
+      config[profile.to_s] = Config.new(&block)
     end
   end
 
@@ -23,9 +28,9 @@ module Test
   # Get the current configuration.
   #
   # @return [Config]
-  def self.configuration(reconfigurable=false)
+  def self.configuration(profile=nil, reconfigurable=false)
     @reconfigure = true if reconfigurable
-    @config ||= Config.new
+    config[profile.to_s] ||= Config.new
   end
 
   ##
@@ -39,12 +44,6 @@ module Test
     # Glob used to find project root directory.
     GLOB_ROOT = '{.index,.gemspec,.git,.hg,_darcs,lib/}'
 
-    # RubyTest configuration file can be in '.test.rb`, `etc/test.rb`
-    # or `config/test.rb`, `.test`, in that order of precedence.
-    #
-    # @deprecated Use manual -c/--config option instead.
-    GLOB_CONFIG = '{.test.rb,etc/test.rb,config/test.rb,.test}'
-
     #
     def self.assertionless
       @assertionless
@@ -55,28 +54,6 @@ module Test
       @assertionaless = !!boolean
     end
 
-    # Load configuration file. An example file might look like:
-    #
-    #   Test.configure do |run|
-    #     run.files << 'test/case_*.rb'
-    #   end
-    #
-    # @deprecated Planned for deprecation in April 2013.
-    def self.load_config
-      if config_file
-        file = config_file.sub(Dir.pwd+'/','')
-        $stderr.puts "Automatic #{file} loading has been deprecated.\nUse -c option for future version."
-        load config_file
-      end
-    end
-
-    # Find traditional configuration file.
-    #
-    # @deprecated
-    def self.config_file
-      @config_file ||= Dir.glob(File.join(root, GLOB_CONFIG)).first
-    end
-
     # Find and cache project root directory.
     #
     # @return [String] Project's root path.
@@ -139,19 +116,16 @@ module Test
 
       #apply_environment
 
-      settings.each do |k,v|
-        send("#{k}=", v)
-      end
-
-      self.class.load_config # deprecated!!!
-
-      apply(&block)
+      apply(settings, &block)
     end
 
     # Evaluate configuration block.
     #
     # @return nothing
-    def apply(&block)
+    def apply(hash={}, &block)
+      hash.each do |k,v|
+        send("#{k}=", v)
+      end
       block.call(self) if block
     end
 
@@ -171,7 +145,8 @@ module Test
     # List of test files to run.
     #
     # @return [Array<String>]
-    def files
+    def files(*list)
+      @files.concat(makelist(list)) unless list.empty?
       @files
     end
     alias test_files files
@@ -201,7 +176,11 @@ module Test
     # Paths to add to $LOAD_PATH.
     #
     # @return [Array<String>]
-    attr :loadpath
+    def loadpath(*list)
+      @loadpath.concat(makelist(list)) unless list.empty?
+      @loadpath
+    end
+    alias :load_path :loadpath
 
     # Set paths to add to $LOAD_PATH.
     #
@@ -209,11 +188,15 @@ module Test
     def loadpath=(list)
       @loadpath = makelist(list)
     end
+    alias :load_path= :loadpath=
 
     # Scripts to require prior to tests.
     #
     # @return [Array<String>]
-    attr :requires
+    def requires(*list)
+      @requires.concat(makelist(list)) unless list.empty?
+      @requires
+    end
 
     # Set the features that need to be required before the
     # test files.
@@ -226,15 +209,19 @@ module Test
     # Name of test report format, by default it is `dotprogress`.
     #
     # @return [String] format
-    def format
+    def format(name=nil)
+      @format = name.to_s if name
       @format || DEFAULT_FORMAT
     end
 
     # Set test report format.
     #
+    # @param [String] name
+    #   Name of the report format.
+    #
     # @return [String] format
-    def format=(format)
-      @format = format.to_s
+    def format=(name)
+      @format = name.to_s
     end
 
     # Provide extra details in reports?
@@ -254,7 +241,8 @@ module Test
     # Selection of tags for filtering tests.
     #
     # @return [Array<String>]
-    def tags
+    def tags(*list)
+      @tags.concat(makelist(list)) unless list.empty?
       @tags
     end
 
@@ -268,7 +256,8 @@ module Test
     # Description match for filtering tests.
     #
     # @return [Array<String>]
-    def match
+    def match(*list)
+      @match.concat(makelist(list)) unless list.empty?
       @match
     end
 
@@ -283,7 +272,8 @@ module Test
     # which are matched against module, class and method names.
     #
     # @return [Array<String>]
-    def units
+    def units(*list)
+      @units.concat(makelist(list)) unless list.empty?
       @units
     end
 
@@ -312,7 +302,8 @@ module Test
     # Change to this directory before running tests.
     #
     # @return [String]
-    def chdir
+    def chdir(dir=nil)
+      @chdir = dir.to_s if dir
       @chdir
     end
 
@@ -323,6 +314,22 @@ module Test
       @chdir = dir.to_s
     end
 
+    # Procedure to call, just before running tests.
+    #
+    # @return [Proc,nil]
+    def before(&proc)
+      @before = proc if proc
+      @before
+    end
+
+    # Procedure to call, just after running tests.
+    #
+    # @return [Proc,nil]
+    def after(&proc)
+      @after = proc if proc
+      @after
+    end
+
     # The mode is only useful for specialied purposes, such as how
     # to run tests via the Rake task. It has no general purpose
     # and can be ignored in most cases.
@@ -390,27 +397,26 @@ module Test
       @loadpath = env(:loadpath, @loadpath) if @loadpath.empty?
     end
 
-    # Load configuration file.
+    # Load configuration file for project.
+    #
+    # File names are prefixed with `./` to ensure they are from a local
+    # source. An extension of `.rb` is assumed if the file lacks an one.
     #
     # @return [Boolean] true if file was required
     def load_config(file)
-      try_paths = ['etc', 'config']
-      try_paths.concat loadpath
-      try_paths << '.'
-      try_paths = try_paths.uniq
+      file = file + '.rb' if File.extname(file) == ''
 
       if chdir
-        try_paths = try_paths.map{ |path| File.join(chdir, path) }
+        file = File.join(chdir, file)
+      else
+        file = File.join('.', file)
       end
 
-      hold_path = $LOAD_PATH.dup
-      $LOAD_PATH.replace(try_paths)
-      begin
-        success = require file
-      ensure
-        $LOAD_PATH.replace(hold_path)
+      if File.exist?(file)
+        return require(file)
+      else
+        raise "config file not found -- `#{file}'"
       end
-      success
     end
 
   private

data/lib/rubytest/runner.rb

@@ -1,34 +1,65 @@
 module Test
 
-  # Currently this is an alias for configure, however it is likely
-  # to become an alias for `Runner.run` in the future.
+  # Alias for `Test.configure`.
+  # Use #run! to run tests immediately.
   #
-  # @deprecated Will probably change behavior in future.
-  def self.run(config=nil, &config_proc)
-    $stderr.puts "configuration profiles no longer supported." if config
-    configure(&config_proc)
+  def self.run(profile=nil, &config_proc)
+    configure(profile, &config_proc)
+  end
+
+  # Configure and run immediately.
+  #
+  # @todo Should this method return the success instead of exiting?
+  # @todo Wrap run in at_exit ?
+  #
+  # @return [void]
+  def self.run!(config=nil, &config_proc)
+    begin
+      success = Runner.run(config, &config_proc)
+      exit -1 unless success
+    rescue => error
+      raise error if $DEBUG
+      $stderr.puts('ERROR: ' + error.to_s)
+      exit -1
+    end
   end
 
   # The Test::Runner class handles the execution of tests.
   #
   class Runner
 
-    # TODO: Wrap run in at_exit ?
-    def self.run(config=nil, &config_proc)
+    # Run tests.
+    #
+    # @param [Config,Hash,String,Symbol] config
+    #   Either a Config instance, a hash to construct a Config
+    #   instance with, or a name of a configuration profile.
+    #
+    # @return [Boolean] Success of test run.
+    def self.run(config=nil, &config_proc) #:yield:
       runner = Runner.new(config, &config_proc)
-      begin
-        success = runner.run
-        exit -1 unless success
-      rescue => error
-        raise error if $DEBUG
-        $stderr.puts('ERROR: ' + error.to_s)
-        exit -1
-      end
+      runner.run
     end
 
     # Exceptions that are not caught by test runner.
     OPEN_ERRORS = [NoMemoryError, SignalException, Interrupt, SystemExit]
 
+    # New Runner.
+    #
+    # @param [Config] config
+    #   Config instance.
+    #
+    def initialize(config) #:yield:
+      @config = case config
+        when Config then config
+        when Hash   then Config.new(config)
+        else Test.configuration(config)
+      end
+
+      yeild(@config) if block_given?
+
+      @advice = Advice.new
+    end
+
     # Handle all configuration via the config instance.
     attr :config
 
@@ -78,23 +109,6 @@ module Test
       advice.join(type, &block)
     end
 
-    # New Runner.
-    #
-    # @param [Config] config
-    #   Config instance.
-    #
-    def initialize(config=nil, &block)
-      if config
-        @config = Hash === config ? Config.new(config) : config
-      else
-        @config = Test.configuration
-      end
-
-      block.call(@config) if block
-
-      @advice = Advice.new
-    end
-
     # The reporter to use for ouput.
     attr :reporter
 
@@ -116,8 +130,12 @@ module Test
 
         ignore_callers
 
-        config.loadpath.each{ |path| $LOAD_PATH.unshift(path) }
-        config.requires.each{ |file| require file }
+        config.loadpath.flatten.each{ |path| $LOAD_PATH.unshift(path) }
+        config.requires.flatten.each{ |file| require file }
+
+        # Config before advice occurs after loadpath and require are
+        # applied and before test files are required.
+        config.before.call if config.before
 
         test_files.each do |test_file|
           require test_file
@@ -131,6 +149,8 @@ module Test
         observers.each{ |o| o.begin_suite(suite) }
         run_thru(suite)
         observers.each{ |o| o.end_suite(suite) }
+
+        config.after.call if config.after
       end
 
       recorder.success?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubytest
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -59,22 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotopts
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: qed
   requirement: !ruby/object:Gem::Requirement
@@ -112,9 +96,7 @@ description: ! "Ruby Test is a universal test harness for Ruby. It can handle an
   pass."
 email:
 - transfire@gmail.com
-executables:
-- ruby-test
-- rubytest
+executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -122,8 +104,6 @@ extra_rdoc_files:
 - README.md
 files:
 - .index
-- bin/ruby-test
-- bin/rubytest
 - demo/01_test.md
 - demo/02_case.md
 - demo/applique/ae.rb
@@ -138,7 +118,6 @@ files:
 - lib/rubytest/core_ext/file.rb
 - lib/rubytest/core_ext/string.rb
 - lib/rubytest/core_ext.rb
-- lib/rubytest/rake.rb
 - lib/rubytest/recorder.rb
 - lib/rubytest/reporters/abstract.rb
 - lib/rubytest/reporters/abstract_hash.rb

data/bin/ruby-test

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-begin
-  require 'rubytest'
-  Test::CLI.run
-rescue RuntimeError => error
-  raise error if $DEBUG
-  $stderr.puts error
-end
-

data/bin/rubytest

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-begin
-  require 'rubytest'
-  Test::CLI.run
-rescue RuntimeError => error
-  raise error if $DEBUG
-  $stderr.puts error
-end
-

data/lib/rubytest/rake.rb

@@ -1,137 +0,0 @@
-require 'rubytest'
-require 'rake/tasklib'
-
-module Test
-
-  ##
-  # Rake subspace.
-  #
-  module Rake
-
-    ##
-    # Define a test rake task.
-    #
-    # The `TEST` environment variable can be used to select tests
-    # when using this task. Note, this is just a more convenient
-    # way than using `RUBYTEST_FILES`.
-    #
-    class TestTask < ::Rake::TaskLib
-
-      # Glob patterns are used by default to select test scripts.
-      DEFAULT_TESTS = [
-        'test/**/case_*.rb',
-        'test/**/*_case.rb',
-        'test/**/test_*.rb',
-        'test/**/*_test.rb'
-      ]
-
-      # Test run configuration.
-      #
-      # @return [Config]
-      attr :config
-
-      # Initialize new Rake::TestTask instance.
-      #
-      def initialize(name='test', desc='run tests', &block)
-        @name = name || 'test'
-        @desc = desc
-
-        @config = Test::Config.new
-
-        @config.files << default_tests if @config.files.empty?
-        @config.loadpath << 'lib' if @config.loadpath.empty?
-
-        block.call(@config)
-
-        define_task
-      end
-
-      # Define rake task for testing.
-      #
-      # @return nothing
-      def define_task
-        desc @desc
-        task @name do
-          config.mode == 'shell' ? run_shell : run
-        end
-      end
-
-      # Run tests, via fork is possible, otherwise straight out.
-      #
-      # @return nothing
-      def run
-        if Process.respond_to?(:fork)
-          fork {
-            runner  = Test::Runner.new(config)
-            success = runner.run
-            exit -1 unless success
-          }
-          Process.wait
-        else
-          runner  = Test::Runner.new(config)
-          success = runner.run
-          exit -1 unless success
-        end
-      end
-
-      # Run test via command line shell.
-      #
-      # @return nothing
-      def shell_run
-        success = ruby(*config.to_shellwords)
-        exit -1 unless success
-      end
-
-      # Resolve test globs.
-      #
-      # @todo Implementation probably cna be simplified.
-      # @return [Array<String>] List of test files.
-      def test_files
-        files = tests
-        files = files.map{ |f| Dir[f] }.flatten
-        files = files.map{ |f| File.directory?(f) ? Dir[File.join(f, '**/*.rb')] : f }
-        files = files.flatten.uniq
-        files = files.map{ |f| File.expand_path(f) }
-        files
-      end
-
-      # Default test globs. For extra convenience will look for list in
-      # `ENV['TEST']` first.
-      #
-      # @return [Array<String>]
-      def default_tests
-        if ENV['TEST']
-          ENV['TEST'].split(/[:;]/)
-        else
-          DEFAULT_TESTS
-        end
-      end
-
-=begin
-      # Shell out to current ruby command.
-      #
-      # @return [Boolean] Success of shell call.
-      def ruby(*argv)
-        system(ruby_command, *argv)
-      end
-
-      # Get current ruby shell command.
-      #
-      # @return [String] Ruby shell command.
-      def ruby_command
-        @ruby_command ||= (
-          require 'rbconfig'
-          ENV['RUBY'] ||
-            File.join(
-              RbConfig::CONFIG['bindir'],
-              RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT']
-            ).sub(/.*\s.*/m, '"\&"')
-        )
-      end
-=end
-
-    end
-
-  end
-
-end