rubytest 0.4.2 → 0.5.0

data/.ruby

@@ -1,7 +1,6 @@
 ---
 source:
 - var
-- var/
 authors:
 - name: trans
   email: transfire@gmail.com
@@ -37,7 +36,7 @@ revision: 0
 created: '2011-07-23'
 summary: Ruby Universal Test Harness
 title: Ruby Test
-version: 0.4.2
+version: 0.5.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

data/HISTORY.md

@@ -1,5 +1,19 @@
 # RELEASE HISTORY
 
+## 0.5.0 / 2012-03-22
+
+This release improves the command line interface, the handling of
+configuration and provides a mechinism for adding custom test 
+observers. The later can be used for things like mock library
+verifcation steps.
+
+Changes:
+
+* Make CLI an actual class.
+* Refactor configuration file lookup and support Confection.
+* Add customizable test observer via new Advice class.
+
+
 ## 0.4.2 / 2012-03-04
 
 Minor release to fix detection of pre-existance of Exception core

data/bin/ruby-test

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'rubytest'
-Test::Runner.cli(*ARGV)
+Test::CLI.run(*ARGV)
 

data/bin/rubytest

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'rubytest'
-Test::Runner.cli(*ARGV)
+Test::CLI.run(*ARGV)
 

data/lib/rubytest/advice.rb

@@ -0,0 +1,134 @@
+module Test
+
+  # The Advice class is an observer that can be customized to 
+  # initiate before, after and upon procedures for all of RubyTests
+  # observable points.
+  #
+  # Only one procedure is allowed per-point.
+  #
+  class Advice
+
+    #
+    def self.joinpoints
+      @joinpoints ||= []
+    end
+
+    # TODO: Should before and affter hooks be evaluated in the context of test
+    #       object scope? The #scope field has been added to the RubyTest spec
+    #       just in case.
+
+    #
+    def self.joinpoint(name)
+      joinpoints << name.to_sym
+
+      class_eval %{
+        def #{name}(*args)
+          procedure = @table[:#{name}]
+          procedure.call(*args) if procedure
+        end
+      }
+    end
+
+    #
+    def initialize
+      @table = {}
+    end
+
+    # @method begin_suite(suite)
+    joinpoint :begin_suite
+
+    # @method begin_case(case)
+    joinpoint :begin_case
+
+    # @method skip_test(test, reason)
+    joinpoint :skip_test
+
+    # @method begin_test(test)
+    joinpoint :begin_test
+
+    # @method pass(test)
+    joinpoint :pass
+
+    # @method fail(test, exception)
+    joinpoint :fail
+
+    # @method error(test, exception)
+    joinpoint :error
+
+    # @method todo(test, exception)
+    joinpoint :todo
+
+    # @method end_test(test)
+    joinpoint :end_test
+
+    # @method end_case(case)
+    joinpoint :end_case
+
+    # @method end_suite(suite)
+    joinpoint :end_suite
+
+    #
+    #def [](key)
+    #  @table[key.to_sym]
+    #end
+
+    # Add a procedure to one of the join-points.
+    def join(type, &block)
+      type = valid_type(type) 
+      @table[type] = block
+    end
+
+    # Add a procedure to one of the before join-points.
+    def join_before(type, &block)
+      join("begin_#{type}", &block) 
+    end
+
+    # Add a procedure to one of the after join-points.
+    def join_after(type, &block)
+      join("end_#{type}", &block)
+    end
+
+    # Ignore any other signals (precautionary).
+    def method_missing(*)
+    end
+
+  private
+
+    #def invoke(symbol, *args)
+    #  if @table.key?(symbol)
+    #    self[symbol].call(*args)
+    #  end
+    #end
+
+    #
+    def valid_type(type)
+      type = message_type(type)
+      unless self.class.joinpoints.include?(type)
+        raise ArgumentError, "not a valid advice type -- #{type}"
+      end
+      type
+    end
+
+    #
+    def message_type(type)
+      type = type.to_sym
+      case type
+      when :each
+        type = :test
+      when :all
+        type = :case
+      when :begin_each
+        type = :begin_test
+      when :begin_all
+        type = :begin_case
+      when :end_each
+        type = :end_test
+      when :end_all
+        type = :end_case
+      end
+      return type
+    end
+
+  end
+
+end

data/lib/rubytest/cli.rb

@@ -1,16 +1,51 @@
 module Test
 
-  # Command line interface.
-  class Runner
+  # Command line interface to test runner.
+  #
+  class CLI
 
-    # Test runner command line interface.
     #
-    def self.cli(*argv)
-      runner = Runner.new
+    # Convenience method for invoking the CLI.
+    #
+    def self.run(*argv)
+      new.run(*argv)
+    end
+
+    #
+    # Initialize CLI instance.
+    #
+    def initialize
+      require 'optparse'
 
       Test::Config.load
 
-      cli_options(runner, argv)
+      @profile = 'default'
+      @config  = Test.config
+      @runner  = Runner.new
+    end
+
+    #
+    # @return [Runner]
+    #
+    attr :runner
+
+    #
+    # @return [Hash]
+    #
+    attr :config
+
+    #
+    attr_accessor :profile
+
+    #
+    # Run tests.
+    #
+    def run(*argv)
+      options.parse!(argv)
+
+      run_profile
+
+      runner.files.replace(argv) unless argv.empty?
 
       Test::Config.load_path_setup  #unless runner.autopath == false
 
@@ -24,31 +59,43 @@ module Test
     end
 
     #
-    def self.cli_options(runner, argv)
-      require 'optparse'
+    # 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'
 
-      config = Test.config.dup
-      config_loaded = false
+      common  = config['common']
+      common.call(runner) if common
 
-      common  = config.delete('common')
-      default = config.delete('default')
+      profig = config[profile]
+      profig.call(runner) if profig
+    end
 
-      common.call(runner) if common
+    #
+    # Setup OptionsParser instance.
+    #
+    def options
+      this = self
 
       OptionParser.new do |opt|
         opt.banner = "Usage: #{$0} [options] [files ...]"
 
-        unless config.empty?
-          opt.separator "PRESET OPTIONS:"
-          config.each do |name, block|
-            opt.on("--#{name}") do
-              block.call(runner)
-            end
+        opt.separator "PRESET OPTIONS:"
+
+        opt.on '-p', '--profile NAME', "use configuration profile" do |name|
+          this.profile = name.to_s
+        end
+
+        config_names = config.keys - ['common', 'default']
+
+        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
         end
@@ -83,22 +130,20 @@ module Test
         #opt.on('--log DIRECTORY', 'log directory'){ |dir|
         #  options[:log] = dir
         #}
-        opt.on_tail("--[no-]ansi" , 'turn on/off ANSI colors'){ |v| $ansi = v }
-        opt.on_tail("--debug" , 'turn on debugging mode'){ $DEBUG = true }
-        #opt.on_tail("--about" , 'display information about lemon'){
+        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.on_tail('-h', '--help', 'display this help message'){
+        opt.on('-h', '--help', 'display this help message'){
           puts opt
           exit
         }
-      end.parse!(argv)
-
-      default.call(runner) if default && !config_loaded
-
-      runner.files.replace(argv) unless argv.empty?
+      end
     end
 
   end

data/lib/rubytest/config.rb

@@ -1,57 +1,104 @@
 module Test
 
   #
-  def self.run(name=:default, &block)
+  def self.run(name=nil, &block)
+    name = name ? name : 'default'
+
     @config ||= {}
     @config[name.to_s] = block
   end
 
+  #
   def self.config
     @config ||= {}
   end
 
+  # Handle test run configruation.
+  #
+  # @todo Why not use the instace level for `Test.config` ?
   #
   class Config
 
-    # Test configuration file.
+    # Tradional test configuration file glob. This glob
+    # looks for a `Testfile` or a `.test` file.
+    # Either can have an optional `.rb` extension.
+    GLOB_RC = '{testfile.rb,testfile,.test.rb,.test}'
+
+    # If a root level test file can't be found, then use this
+    # glob to search the task directory for `*.rubytest` files.
+    GLOB_TASK = 'task/*.rubytest'
+
+    # Glob used to find project root directory.
+    GLOB_ROOT = '{.ruby,.git,.hg,_darcs,lib/}'
+
     #
-    # The name of the file is an ode to the original Ruby cli test tool.
+    # Load configuration. This will first look for a root level `Testfile.rb`
+    # or `.test.rb` file. Failing that it will look for `task/*.rubytest` files.
+    # An example entry into any of these look like:
     #
-    # @example
-    #   .test
-    #   .testrb
-    #   .test.rb
-    #   .config/test.rb
+    #   Test.run :name do |run|
+    #     run.files << 'test/case_*.rb'
+    #   end
     #
-    # @todo Too many options for ruby-test configuration file.
-    GLOB_RC = '{.testrb,.test.rb,.test,.config/test.rb,config/test.rb}'
-
+    # Use `:default` for name for non-specific profile and `:common` for code that
+    # should apply to all configurations.
     #
-    GLOB_ROOT = '{.ruby,.git,.hg}'
-
+    # Failing any traditional configuration files, the Confection system will
+    # be used. An example entry in a projects `Confile` is:
+    #
+    #   config :test, :name do |run|
+    #     run.files << 'test/case_*.rb'
+    #   end
+    #
+    # You can leave the `:name` parameter out for `:default`.
     #
     def self.load
-      super(rc_file) if rc_file
-      #Ruth.module_eval(File.read(rc_file)) if rc_file
+      if rc_files.empty?
+        if confection_file
+          require 'confection'
+          confection('test', '*').each do |c|
+            name = c.profile ? c.profile : :default
+            Test.run(name, &c)
+          end
+        end
+      else
+        rc_files.each do |file|
+          super(file)
+        end
+      end
+    end
+
+    #
+    def self.confection_file
+      @confection_file ||= (
+        Dir.glob(File.join(root, '{,.}confile{,.rb}'), File::FNM_CASEFOLD).first
+      )
     end
 
     # Find rc file.
-    def self.rc_file
-      @rc_file ||= (
-        glob    = GLOB_RC
-        stop    = root
-        default = nil
-        dir     = Dir.pwd
-        file    = nil
-        loop do
-          file = Dir[File.join(dir, glob)].first
-          break file if file
-          break if dir == stop
-          dir = File.dirname(dir)
-          break if dir == '/'
+    def self.rc_files
+      @rc_files ||= (
+        if file = Dir.glob(File.join(root, GLOB_RC), File::FNM_CASEFOLD).first
+          [file]
+        else
+          Dir.glob(File.join(root, GLOB_TASK))
         end
-        file ? file : default
       )
+
+      #  glob    = GLOB_RC
+      #  stop    = root
+      #  default = nil
+      #  dir     = Dir.pwd
+      #  file    = nil
+      #  loop do
+      #    files = Dir.glob(File.join(dir, glob), File::FNM_CASEFOLD)
+      #    file = files.find{ |f| File.file?(f) }
+      #    break file if file
+      #    break if dir == stop
+      #    dir = File.dirname(dir)
+      #    break if dir == '/'
+      #  end
+      #  file ? file : default
     end
 
     # Find and cache project root directory.

data/lib/rubytest/recorder.rb

@@ -14,8 +14,8 @@ module Test
     end
 
     #
-    def skip(test)
-      self[:skip] << test
+    def skip_test(test, reason)
+      self[:skip] << [test, reason]
     end
 
     # Add `test` to pass set.
@@ -35,9 +35,9 @@ module Test
       self[:todo] << [test, exception]
     end
 
-    def omit(test, exception)
-      self[:omit] << [test, exception]
-    end
+    #def omit(test, exception)
+    #  self[:omit] << [test, exception]
+    #end
 
     # Returns true if their are no test errors or failures.
     def success?

data/lib/rubytest/reporters/abstract.rb

@@ -63,7 +63,7 @@ module Test
       def fail(test, exception)
       end
 
-      #
+      # Report a test error.
       def error(test, exception)
       end
 
@@ -71,10 +71,6 @@ module Test
       def todo(test, exception)
       end
 
-      # Report an omitted test.
-      def omit(test, exception)
-      end
-
       #
       def end_test(test)
       end

data/lib/rubytest/reporters/dotprogress.rb

@@ -5,6 +5,10 @@ module Test::Reporters
   # Simple Dot-Progress Reporter
   class Dotprogress < Abstract
 
+    def skip_test(unit, reason)
+      print "S".ansi(:cyan) if runner.verbose?
+    end
+
     def pass(unit)
       print "."
       $stdout.flush
@@ -25,11 +29,6 @@ module Test::Reporters
       $stdout.flush
     end
 
-    def omit(unit, exception)
-      print "O".ansi(:cyan)
-      $stdout.flush
-    end
-
     def end_suite(suite)
       puts; puts
       puts timestamp
@@ -37,12 +36,10 @@ module Test::Reporters
 
       if runner.verbose?
         unless record[:omit].empty?
-          puts "OMISSIONS\n\n"
-          record[:omit].each do |test, exception|
+          puts "SKIPPED\n\n"
+          record[:skip].each do |test, reason|
             puts "    #{test}".ansi(:bold)
-            puts "    #{exception}"
-            puts "    #{file_and_line(exception)}"
-            #puts code(exception)
+            puts "    #{reason}" if String===reason
             puts
           end
         end

data/lib/rubytest/runner.rb

@@ -113,6 +113,29 @@ module Test
       @hard = !!boolean
     end
 
+    # Instance of Advice is a special customizable observer.
+    def advice
+      @advice
+    end
+
+    # Define universal before advice.
+    def before(type, &block)
+      advice.join_before(type, &block)
+    end
+
+    # Define universal after advice. Can be used by mock libraries,
+    # for example to run mock verification.
+    def after(type, &block)
+      advice.join_after(type, &block)
+    end
+
+    # Define universal upon advice.
+    #
+    # See {Advice} for valid join-points.
+    def upon(type, &block)
+      advice.join(type, &block)
+    end
+
     # New Runner.
     #
     # @param [Array] suite
@@ -128,13 +151,15 @@ module Test
       @verbose   = options[:verbose] || self.class.verbose
       @hard      = options[:hard]    || self.class.hard
 
+      @advice    = Advice.new
+
       block.call(self) if block
     end
 
     # The reporter to use for ouput.
     attr :reporter
 
-    # Record pass, fail, error, pending and omitted tests.
+    # Record pass, fail, error and pending tests.
     attr :recorder
 
     # Array of observers, typically this just contains the recorder and
@@ -155,7 +180,8 @@ module Test
 
       @reporter  = reporter_load(format)
       @recorder  = Recorder.new
-      @observers = [@reporter, @recorder]
+
+      @observers = [advice, @recorder, @reporter]
 
       #cd_tmp do
         observers.each{ |o| o.begin_suite(suite) }
@@ -196,8 +222,8 @@ module Test
     # Run a test case.
     #
     def run_case(tcase)
-      if tcase.respond_to?(:skip?) && tcase.skip?
-        return observers.each{ |o| o.skip_case(tcase) }
+      if tcase.respond_to?(:skip?) && (reason = tcase.skip?)
+        return observers.each{ |o| o.skip_case(tcase, reason) }
       end
 
       observers.each{ |o| o.begin_case(tcase) }
@@ -219,8 +245,8 @@ module Test
     #   The test to run, must repsond to #call.
     #
     def run_test(test)
-      if test.respond_to?(:skip?) && test.skip?
-        return observers.each{ |o| o.skip_test(test) }
+      if test.respond_to?(:skip?) && (reason = test.skip?)
+        return observers.each{ |o| o.skip_test(test, reason) }
       end
 
       observers.each{ |o| o.begin_test(test) }

data/lib/rubytest.rb

@@ -11,6 +11,7 @@ if RUBY_VERSION < '1.9'
   require 'rubytest/code_snippet'
   require 'rubytest/config'
   require 'rubytest/recorder'
+  require 'rubytest/advice'
   require 'rubytest/runner'
   require 'rubytest/cli'
   require 'rubytest/reporters/abstract'
@@ -18,8 +19,9 @@ if RUBY_VERSION < '1.9'
 else
   require_relative 'rubytest/core_ext'
   require_relative 'rubytest/code_snippet'
-  require_relative 'rubytest/recorder'
   require_relative 'rubytest/config'
+  require_relative 'rubytest/recorder'
+  require_relative 'rubytest/advice'
   require_relative 'rubytest/runner'
   require_relative 'rubytest/cli'
   require_relative 'rubytest/reporters/abstract'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubytest
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000 Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &20859580 !ruby/object:Gem::Requirement
+  requirement: &14620080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20859580
+  version_requirements: *14620080
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &20856920 !ruby/object:Gem::Requirement
+  requirement: &14639980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20856920
+  version_requirements: *14639980
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &20879280 !ruby/object:Gem::Requirement
+  requirement: &14638520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20879280
+  version_requirements: *14638520
 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."
@@ -54,18 +54,18 @@ executables:
 - rubytest
 extensions: []
 extra_rdoc_files:
+- LICENSE.txt
 - HISTORY.md
 - README.md
-- NOTICE.md
 files:
 - .ruby
-- .test
 - bin/ruby-test
 - bin/rubytest
 - demo/01_test.md
 - demo/02_case.md
 - demo/applique/ae.rb
 - demo/applique/rubytest.rb
+- lib/rubytest/advice.rb
 - lib/rubytest/autorun.rb
 - lib/rubytest/cli.rb
 - lib/rubytest/code_snippet.rb
@@ -93,9 +93,9 @@ files:
 - lib/test.rb
 - test/basic_case.rb
 - Gemfile.lock
+- LICENSE.txt
 - HISTORY.md
 - README.md
-- NOTICE.md
 homepage: http://rubyworks.github.com/rubytest
 licenses:
 - BSD-2-Clause

data/.test

@@ -1,11 +0,0 @@
-Test.run(:default) do |run|
-  run.files << 'test/*_case.rb'
-end
-
-Test.run(:cov) do |run|
-  run.files << 'test/*_case.rb'
-  SimpleCov.start do |cov|
-    cov.coverage_dir = 'log/coverage'
-  end
-end
-