rubytest 0.5.4 → 0.6.0

data/.index

@@ -9,14 +9,26 @@ authors:
 organizations: []
 requirements:
 - name: ansi
+- groups:
+  - build
+  development: true
+  name: fire
 - groups:
   - build
   development: true
   name: detroit
+- groups:
+  - build
+  development: true
+  name: dotopts
 - groups:
   - test
   development: true
   name: qed
+- groups:
+  - test
+  development: true
+  name: ae
 conflicts: []
 alternatives: []
 resources:
@@ -32,7 +44,7 @@ resources:
 repositories:
 - name: upstream
   scm: git
-  uri: git@github.com:rubyworks/ruby-test.git
+  uri: git@github.com:rubyworks/rubytest.git
 categories: []
 copyrights:
 - holder: RubyWorks
@@ -45,9 +57,9 @@ paths:
 created: '2011-07-23'
 summary: Ruby Universal Test Harness
 title: Ruby Test
-version: 0.5.4
+version: 0.6.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-01-22'
+date: '2013-02-09'

data/HISTORY.md

@@ -1,5 +1,35 @@
 # RELEASE HISTORY
 
+## 0.6.0 / 2013-02-10
+
+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
+will probably have to make some adjustments. Our apologies for the extra
+work. But the whole thing simply got more complicated than it needed to
+be and it was decided that conventional simplicity, with the option 
+unconventional complexity, was the best approach.
+
+To make a long story short... There is no default config file anymore.
+The `-p/--profile` command line option has been removed; replaced by
+a `-c/--config` option which requires a file relative to the working
+directory. In addition the configuration API had been changed from `Test.run`
+or `Test.configure`, to adopt the common convention, and it no longer takes
+a profile name for an argument. `Test.run` still has the same interface as
+`Test.configure` but it will now run tests immediately! So be sure to change
+that if you used it the past. Lastly, Ruby Test now supports DotOpts out of
+the box, so its easier then ever to setup default command line options.
+
+Changes:
+
+* Rename `Test.run` to `Test.configure` and remove profile argument.
+* Add new `Test.run` to immediately run tests.
+* Add `-c/--config` option for requiring project file.
+* Add `-C` and `-R` options for changing directory.
+* Add built-in support for DotOpts.
+* Deprecate profiles, removing `-p/--profile` cli option.
+* Deprecate Test::Runner configuration class methods.
+
+
 ## 0.5.4 / 2013-01-22
 
 This release simply updates configuraiton code to work with RC v0.4.0.

data/README.md

@@ -5,15 +5,19 @@
 [Development](http://github.com/rubyworks/rubytest) /
 [Issues](http://github.com/rubyworks/rubytest/issues)
 
+[![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)
+
+
 ## Description
 
-Ruby Test is a universal test harness for Ruby that can be used by any Ruby
-test framework. Ruby Test defines a simple specification for compliance, which
-allows tests from various frameworks to all run 
+Ruby Test is a universal test harness for Ruby developers. It can be used
+by any Ruby test framework. You can think of Ruby Test as a *meta test framework*. 
+Ruby Test defines a straight-forward specification that any test framework
+can utilize as it back-end. This makes it almost trivial to implement new
+test frameworks. Ruby Test further allows tests from various frameworks
+to all run through a single uniform user interface in a single pass.
 
-Ruby Test defines a straight-forward specification that any test framework can 
-easily support which allows Ruby Test to run the frameworks tests through a
-single uniform user interface in a single pass.
 
 ## Specification
 
@@ -25,10 +29,9 @@ over as a test case with each entry handled in the same manner. All test
 objects must respond to `#to_s` so their description can be used in test
 reports.
 
-Any raised exception that responds to `#assertion?` in the affirmative is taken
-to be a failed assertion rather than simply an error. Ruby Test extends the
-Exception class to support this method for all exceptions.
-
+Ruby Test handles assertions with [BRASS](http://rubyworks.github.com/brass)
+compliance. Any raised exception that responds to `#assertion?` in the
+affirmative is taken to be a failed assertion rather than simply an error. 
 A test framework may raise a `NotImplementedError` to have a test recorded
 as *todo* --a _pending_ exception to remind the developer of tests that still
 need to be written. The `NotImplementedError` is a standard Ruby exception
@@ -42,42 +45,62 @@ additional features that can makes its usage even more convenient.
 See the [Wiki](http://github.com/rubyworks/test/wiki) for further details.
 
 
-## Usage
+## Installation
 
-There are a few ways to run tests. First, there is a command line tool:
+Ruby Test is available as a Gem package.
 
-    $ rubytest
+    $ gem install rubytest
 
-The command line tool takes various options, use `--help` to see them.
-Be sure to load in your test framework or framework's Ruby Test adapter.
+Ruby Test is compliant with Setup.rb layout standard, so it can
+also be installed in an FHS compliant fashion if necessary.
 
-Preconfigurations can be defined in a `.test` file, e.g.
 
-    Test.run 'default' do |r|
-      r.format = 'progress'
-      r.requires << 'lemon'
-      r.files << 'test/*_case.rb'
-    end
+## Running Tests
 
-There is also a 'rubytest/autorun.rb' library script that can be loaded which
-creates an `at_exit` runner, for which `test.rb` provides a nice shortcut:
+There are a few ways to run tests. First, there is the command line tool
+e.g.
 
-    $ ruby -r test
+    $ rubytest test/test_*.rb
 
-There is also a Rake task.
+The command line tool takes various options, use `-h/--help` to see them.
 
-    require 'rubytest/rake'
+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.
 
-    Test::Rake::TestTask.new
+    $ rubytest -r lemon -r ae test/test_*.rb
 
-A Detroit plugin is in the works and should be available soon.
+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:
 
+    rubytest
+      -f progress
+      -r spectroscope
+      -r rspecial
+      spec/spec_*.rb
 
-## Installation
+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.
 
-Ruby Test is available as Gem package.
+    desc "run tests"
+    task :test
+      sh "rubytest"
+    end
 
-    $ gem install rubytest
+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.
+
+    require 'rubytest/rake'
+
+    Test::Rake::TestTask.new :test do |run|
+      run.requires << 'lemon'
+      run.files = 'test/test_*.rb'
+    end
+
+See the Wiki for more information on the different ways to run tests.
 
 
 ## Requirements
@@ -85,28 +108,29 @@ Ruby Test is available as Gem package.
 Ruby Test uses the [ANSI](http://rubyworks.github.com/ansi) gem for color output.
 
 Because of the "foundational" nature of this library we will look at removing
-this dependencies for future versions, but for early development the 
+this dependency for future versions, but for early development the 
 requirements does the job and does it well.
 
 
 ## Development
 
-Ruby Test is still a "nuby" gem. Please feel OBLIGATED to help improve it ;-)
+Ruby Test is still a bit of a "nuby" gem. Please feel OBLIGATED to help improve it ;-)
 
-Ruby Test is a [RubyWorks](http://rubyworks.github.com) project. If you can't
-contribue code, you can still help out by contributing to our development fund.
+Ruby Test is a [Rubyworks](http://rubyworks.github.com) project. If you can't
+contribute code, you can still help out by contributing to our development fund.
 
 
 ## Reference Material
 
-[1] [Standard Definition Of Unit Test](http://c2.com/cgi/wiki?StandardDefinitionOfUnitTest)
+* [Standard Definition Of Unit Test](http://c2.com/cgi/wiki?StandardDefinitionOfUnitTest)
+* [BRASS Assertions Standard](http:rubyworks.github.com/brass)
 
 
 ## Copyrights
 
 Copyright (c) 2011 Rubyworks
 
-Made available according to the terms of the <b>FreeBSD license</b>.
+Made available according to the terms of the <b>BSD-2-Clause</b> license.
 
-See NOTICE.md for details.
+See LICENSE.txt for details.
 

data/bin/ruby-test

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

data/bin/rubytest

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

data/lib/rubytest.rb

@@ -1,4 +1,4 @@
-# Ruby Test - a Universal Ruby Test Harness
+# Ruby Test - Universal Ruby Test Harness
 
 $TEST_SUITE          = [] unless defined?($TEST_SUITE)
 $RUBY_IGNORE_CALLERS = [] unless defined?($RUBY_IGNORE_CALLERS)
@@ -6,11 +6,27 @@ $RUBY_IGNORE_CALLERS = [] unless defined?($RUBY_IGNORE_CALLERS)
 #require 'brass'  # TODO: Should we require BRASS ?
 require 'ansi/core'
 
+module Test
+  # Load project index on demand.
+  def self.index
+    @index ||= (
+      require 'yaml'
+      __dir__  = File.dirname(__FILE__)
+      file = File.expand_path('rubytest.yml', __dir__)
+      YAML.load_file(file)
+    )
+  end
+
+  # Lookup missing constant in project index.
+  def self.const_missing(name)
+    index[name.to_s.downcase] || super(name)
+  end
+end
+
 if RUBY_VERSION < '1.9'
   require 'rubytest/core_ext'
   require 'rubytest/code_snippet'
   require 'rubytest/config'
-  require 'rubytest/rc'
   require 'rubytest/recorder'
   require 'rubytest/advice'
   require 'rubytest/runner'
@@ -21,7 +37,6 @@ else
   require_relative 'rubytest/core_ext'
   require_relative 'rubytest/code_snippet'
   require_relative 'rubytest/config'
-  require_relative 'rubytest/rc'
   require_relative 'rubytest/recorder'
   require_relative 'rubytest/advice'
   require_relative 'rubytest/runner'

data/lib/rubytest.yml

@@ -0,0 +1,65 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- name: ansi
+- groups:
+  - build
+  development: true
+  name: fire
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: dotopts
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/rubytest
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/rubytest
+  label: Source Code
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git@github.com:rubyworks/rubytest.git
+categories: []
+copyrights:
+- holder: RubyWorks
+  year: '2011'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2011-07-23'
+summary: Ruby Universal Test Harness
+title: Ruby Test
+version: 0.6.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'

data/lib/rubytest/autorun.rb

@@ -1,19 +1,7 @@
-#$TEST_SUITE = [] unless defined?($TEST_SUITE)
-
-if RUBY_VERSION < '1.9'
-  require 'rubytest'
-else
-  require_relative '../rubytest'
-end
+require 'rubytest'
 
 at_exit {
-  suite   = $TEST_SUITE
-  options = {
-    :format => ENV['rubytest-format']  # TODO: better name?
-  }
-
-  runner  = Ruth::Test::Runner.new(suite, options)
-  success = runner.run
+  success = Test.run
   exit -1 unless success
 }
 

data/lib/rubytest/cli.rb

@@ -2,65 +2,52 @@ module Test
 
   # Command line interface to test runner.
   #
+  # TODO: Use `cli` based library instead of option parser?
+  #
   class CLI
 
-    #
     # Convenience method for invoking the CLI.
     #
+    # @return nothing
     def self.run(*argv)
       new.run(*argv)
     end
 
-    #
     # Initialize CLI instance.
     #
+    # @return nothing
     def initialize
       require 'optparse'
 
-      Test::Config.load
-
-      #@profile = ENV['profile'] || ENV['p'] || 'default'
-      @config  = Test.config
-      @runner  = Runner.new
+      @config = Test.configuration(true)
     end
 
+    # Test run configuration.
     #
-    # @return [Runner]
-    #
-    attr :runner
-
-    #
-    # @return [Hash]
-    #
-    attr :config
-
-    #
-    def profile
-      ENV['profile'] || ENV['p'] || 'default'
+    # @return [Config]
+    def config
+      @config
     end
 
-    #
-    def profile=(name)
-      ENV['profile'] = name.to_s
-    end
-
-    #
     # Run tests.
     #
-    def run(*argv)
-      options.parse!(argv)
-
-      if Object.const_get(:RC)
-        RC.configure('rubytest')
+    # @return nothing
+    def run(argv=nil)
+      begin
+        require 'dotopts'
+      rescue LoadError
       end
 
-      run_profile
+      argv = (argv || ARGV.dup)
 
-      runner.files.replace(argv) unless argv.empty?
+      options.parse!(argv)
 
-      # TODO: this should probably be invoked via runner.run instead
-      Test::Config.load_path_setup if runner.autopath?
+      config.files.replace(argv) unless argv.empty?
 
+      config.apply_environment_overrides
+
+      #Test.run(config)
+      runner = Runner.new(config)
       begin
         success = runner.run
         exit -1 unless success
@@ -71,90 +58,87 @@ module Test
       end
     end
 
-    #
-    # Run the common profile if defined and then the specific
-    # profile.
-    #
-    def run_profile
-      raise "no such profile -- #{profile}" unless config[profile] or profile == 'default'
-
-      common = config['common']
-      common.call(runner) if common
-
-      profig = config[profile]
-      profig.call(runner) if profig
-    end
-
-    #
     # Setup OptionsParser instance.
     #
+    # @return [OptionParser]
     def options
       this = self
 
       OptionParser.new do |opt|
-        opt.banner = "Usage: #{$0} [options] [files ...]"
-
-        opt.separator "PRESET OPTIONS:"
-
-        opt.on '-p', '--profile NAME', "use configuration profile" do |name|
-          this.profile = name.to_s
-        end
+        opt.banner = "Usage: #{File.basename($0)} [options] [files ...]"
 
-        config_names = config.keys - ['common', 'default']
+        #opt.separator "PRESET OPTIONS:"
+        #pnames = profile_names
+        #unless pnames.empty?
+        #  pnames.each do |pname|
+        #    opt.separator((" " * 40) + "* #{pname}")
+        #  end
+        #end
+        #opt.separator "CONFIG OPTIONS:"
 
-        unless config_names.empty?
-          config_names.each do |name|
-            opt.separator((" " * 40) + "* #{name}")
-          end
-        end
-
-        opt.separator "CONFIG OPTIONS:"
         opt.on '-f', '--format NAME', 'report format' do |name|
-          runner.format = name
+          config.format = name
         end
         opt.on '-y', '--tapy', 'shortcut for -f tapy' do
-          runner.format = 'tapy'
+          config.format = 'tapy'
         end
         opt.on '-j', '--tapj', 'shortcut for -f tapj' do
-          runner.format = 'tapj'
+          config.format = 'tapj'
         end
 
         opt.on '-t', '--tag TAG', 'select tests by tag' do |tag|
-          runner.tags << tag
+          config.tags.concat makelist(tag)
         end
         opt.on '-u', '--unit TAG', 'select tests by software unit' do |unit|
-          runner.units << unit
+          config.units.concat makelist(unit)
         end
         opt.on '-m', '--match TEXT', 'select tests by description' do |text|
-          runner.match << text 
+          config.match.concat makelist(text)
         end
 
-        opt.on '-a', '--autopath', 'automatically add to $LOAD_PATH' do |paths|
-          runner.autopath = true
+        opt.on '-A', '--autopath', 'automatically add paths to $LOAD_PATH' do |paths|
+          config.autopath = true
         end
-        opt.on '-I', '--loadpath PATH', 'add to $LOAD_PATH' do |paths|
-          paths.split(/[:;]/).reverse_each do |path|
-            $LOAD_PATH.unshift path
-          end
+        opt.on '-I', '--loadpath PATH', 'add given path to $LOAD_PATH' do |paths|
+          #makelist(paths).reverse_each do |path|
+          #  $LOAD_PATH.unshift path
+          #end
+          config.loadpath.concat makelist(paths)
+        end
+        opt.on '-C', '--chdir DIR', 'change directory before running tests' do |dir|
+          config.chdir = dir
+        end
+        opt.on '-R', '--chroot', 'change to project root directory before running tests' do
+          config.chdir = Config.root
         end
         opt.on '-r', '--require FILE', 'require file' do |file|
-          require file
+          #require file
+          config.requires.concat makelist(file)
+        end
+        opt.on '-c', '--config FILE', "require local config file (immediately)" do |file|
+          config.load_config(file)
         end
-        opt.on '-v' , '--verbose', 'provide extra detailed report' do
-          runner.verbose = true
+        opt.on '-V' , '--verbose', 'provide extra detail in reports' do
+          config.verbose = true
         end
-        #opt.on('--log DIRECTORY', 'log directory'){ |dir|
-        #  options[:log] = dir
+        #opt.on('--log PATH', 'log test output to path'){ |path|
+        #  config.log = path
         #}
         opt.on("--[no-]ansi" , 'turn on/off ANSI colors'){ |v| $ansi = v }
         opt.on("--debug" , 'turn on debugging mode'){ $DEBUG = true }
 
-        opt.separator "COMMAND OPTIONS:"
-        #opt.on("--about" , 'display information about rubytest'){
-        #  puts "Ruby Test v#{VERSION}"
-        #  puts "#{COPYRIGHT}"
-        #  exit
-        #}
+        #opt.separator "COMMAND OPTIONS:"
+        opt.on('--about' , 'display information about rubytest') do
+          puts "Ruby Test v%s" % [Test.index['version']]
+          Test.index['copyrights'].each do |c|
+            puts "(c) %s %s (%s)" % c.values_at('year', 'holder', 'license')
+          end
+          exit
+        end
+        opt.on('--version' , 'display rubytest version') do
+          puts Test::VERSION
+          exit
+        end
         opt.on('-h', '--help', 'display this help message'){
           puts opt
           exit
@@ -162,6 +146,21 @@ module Test
       end
     end
 
+    # If given a String then split up at `:` and `;` markers.
+    # Otherwise ensure the list is an Array and the entries are
+    # all strings and not empty.
+    #
+    # @return [Array<String>]
+    def makelist(list)
+      case list
+      when String
+        list = list.split(/[:;]/)
+      else
+        list = Array(list).map{ |path| path.to_s }
+      end
+      list.reject{ |path| path.strip.empty? }
+    end
+
   end
 
 end