assert 0.7.3 → 0.8.0

data/lib/assert/rake_tasks.rb

@@ -9,18 +9,24 @@ require 'assert/rake_tasks/test_task'
 
 module Assert::RakeTasks
 
-  FILE_SUFFIX = "_test.rb"
-
   # Setup the rake tasks for testing
   # * add 'include Assert::RakeTasks' to your Rakefile
   def self.included(receiver)
-    # auto-build rake tasks for the ./test files (if defined in ./test)
-    self.for('test') if File.exists?(File.expand_path('./test', Dir.pwd))
+    # auto-install rake tasks
+    self.install
+  end
+
+  def self.install
+    assert_test_root = ENV['ASSERT_TEST_ROOT'] || './test'
+
+    if File.exists?(assert_test_root)
+      self.irb_task(Assert::RakeTasks::Irb.new(assert_test_root))
+      self.to_tasks(Assert::RakeTasks::Scope.new(assert_test_root))
+    end
   end
 
-  def self.for(test_root='test')
-    self.irb_task(Assert::RakeTasks::Irb.new(test_root.to_s))
-    self.to_tasks(Assert::RakeTasks::Scope.new(test_root.to_s))
+  def self.for(test_root_name)
+    warn "[DEPRECATED] `Assert::RakeTasts.for` has been deprecated.  Use `Assert::RakeTasks.install` instead."
   end
 
   class << self

data/lib/assert/rake_tasks/irb.rb

@@ -26,7 +26,7 @@ module Assert::RakeTasks
     end
 
     def cmd
-      "irb -rubygems -r ./#{self.file_path}"
+      "irb -rubygems -r #{self.file_path}"
     end
 
   end

data/lib/assert/rake_tasks/scope.rb

@@ -4,29 +4,25 @@ require 'assert/rake_tasks/test_task'
 module Assert::RakeTasks
   class Scope
 
-    def self.test_file_suffix
-      "_test.rb"
+    def self.test_file_suffixes
+      ['_test.rb', '_tests.rb']
     end
 
+    attr_reader :path, :nested_files, :path_file_list, :test_tasks, :scopes
+
     def initialize(path)
       @path = path
+
+      @nested_files = get_nested_files
+      @path_file_list = build_path_file_list
+      @test_tasks = build_test_tasks
+      @scopes = build_scopes
     end
 
     def namespace
       File.basename(@path).to_sym
     end
 
-    # nested test files under the path
-    def nested_files
-      nested_files = Rake::FileList["#{@path}/**/*#{self.class.test_file_suffix}"]
-    end
-
-    # a list with the path test file "#{path}_test.rb" (if it exists)
-    def path_file_list
-      path_file_name = @path+self.class.test_file_suffix
-      (File.exists?(path_file_name) ? Rake::FileList[path_file_name] : [])
-    end
-
     # return a test task covering the scopes nested files plus path file
     # but only if there are nested files
     def to_test_task
@@ -37,32 +33,63 @@ module Assert::RakeTasks
       end
     end
 
+    protected
+
+    # nested test files under the path
+
+    def get_nested_files
+      self.class.test_file_suffixes.map do |suffix|
+        Rake::FileList["#{@path}/**/*#{suffix}"]
+      end.flatten
+    end
+
+    # a list with the path test file "#{path}_test.rb" (if it exists)
+
+    def build_path_file_list
+      self.class.test_file_suffixes.map do |suffix|
+        path_file_name = "#{@path}#{suffix}"
+        File.exists?(path_file_name) ? Rake::FileList[path_file_name] : []
+      end.flatten
+    end
+
     # a collection of test tasks for every standalone child test file
-    def test_tasks
-      # get immediate child test files
-      Dir.glob("#{@path}/*#{self.class.test_file_suffix}").collect do |f|
-        # get just the path name for each file
-        File.join(File.dirname(f), File.basename(f, self.class.test_file_suffix))
-      end.reject do |p|
+
+    def build_test_tasks
+      self.class.test_file_suffixes.map do |suffix|
+        # get immediate child test files
+        Dir.glob("#{@path}/*#{suffix}").collect do |f|
+          # get just the path name for each file
+          File.join(File.dirname(f), File.basename(f, suffix))
+        end
+      end.flatten.reject do |p|
         # reject any that have deeply nested test files
-        !Dir.glob("#{p}/**/*#{self.class.test_file_suffix}").empty?
+        self.class.test_file_suffixes.inject(false) do |result, suffix|
+          result || !Dir.glob("#{p}/**/*#{suffix}").empty?
+        end
       end.collect do |p|
         # build a test task for the standalone test file of the path
         TestTask.new(p) do |tt|
-          tt.files = Rake::FileList[p+self.class.test_file_suffix]
+          tt.files = self.class.test_file_suffixes.map do |suffix|
+            (File.exists?("#{p}#{suffix}") ? Rake::FileList["#{p}#{suffix}"] : [])
+          end.flatten
         end
       end
     end
 
     # a collection of scopes for every child test dir or test dir/file combo
-    def scopes
-      # get immediate child paths
-      Dir.glob("#{@path}/*").collect do |p|
-        # get just the path name for each dir/file and uniq it
-        File.join(File.dirname(p), File.basename(p, self.class.test_file_suffix))
-      end.uniq.select do |p|
+
+    def build_scopes
+      self.class.test_file_suffixes.map do |suffix|
+        # get immediate child paths
+        Dir.glob("#{@path}/*").collect do |p|
+          # get just the path name for each dir/file and uniq it
+          File.join(File.dirname(p), File.basename(p, suffix))
+        end
+      end.flatten.uniq.select do |p|
         # select any that have deeply nested test files
-        !Dir.glob("#{p}/**/*#{self.class.test_file_suffix}").empty?
+        self.class.test_file_suffixes.inject(false) do |result, suffix|
+          result || !Dir.glob("#{p}/**/*#{suffix}").empty?
+        end
       end.collect do |p|
         # build a scope for each path
         self.class.new(p)

data/lib/assert/rake_tasks/test_task.rb

@@ -26,7 +26,10 @@ module Assert::RakeTasks
     end
 
     def name
-      File.basename(@path, Scope.test_file_suffix).to_sym
+      # File.basename(@path, Scope.test_file_suffix).to_sym
+      @name ||= File.basename(@path).tap do |bname|
+        Scope.test_file_suffixes.each { |suffix| bname.gsub(suffix, '') }
+      end.to_sym
     end
 
     def file_list # :nodoc:

data/lib/assert/result.rb

@@ -8,15 +8,13 @@ module Assert::Result
   class Error < Base; end
   class Skip < Base; end
 
-  class << self
-    def types
-      { :pass => Pass,
-        :fail => Fail,
-        :ignore => Ignore,
-        :skip => Skip,
-        :error => Error
-      }
-    end
+  def self.types
+    { :pass => Pass,
+      :fail => Fail,
+      :ignore => Ignore,
+      :skip => Skip,
+      :error => Error
+    }
   end
 
   class Backtrace < ::Array

data/lib/assert/result_set.rb

@@ -1,13 +1,16 @@
 module Assert
   class ResultSet < ::Array
 
-    attr_accessor :view
+    attr_accessor :callback
+
+    def initialize(callback=nil)
+      @callback = callback
+      super()
+    end
 
     def <<(result)
       super
-      if @view && @view.respond_to?(:handle_runtime_result)
-        @view.handle_runtime_result(result)
-      end
+      @callback.call(result) if @callback
     end
 
   end

data/lib/assert/runner.rb

@@ -9,19 +9,15 @@ module Assert
       @view = view
     end
 
-    def run(render=true)
+    def run
+      @view.fire(:on_start)
       @suite.setup
 
-      if render
-        # render the view, passing it a callback block to run the test suite
-        @view.render do
-          benchmark { run_suite }
-        end
-      else
-        benchmark { run_suite }
-      end
+      benchmark { run_suite }
 
       @suite.teardown
+      @view.fire(:on_finish)
+
       count(:failed) + count(:errored)
     end
 
@@ -48,7 +44,11 @@ module Assert
 
     def run_suite
       # TODO: parallel running
-      tests_to_run.each {|test| test.run(@view)}
+      tests_to_run.each do |test|
+        @view.fire(:before_test, test)
+        test.run {|result| @view.fire(:on_result, result)}
+        @view.fire(:after_test, test)
+      end
     end
 
   end

data/lib/assert/setup/helpers.rb

@@ -8,9 +8,10 @@ module Assert
     # the user-specific helper file will always be required in after the
     # package-specific one
 
-    class << self
+    USER_TEST_DIR    = './.assert'
+    USER_TEST_HELPER = 'options'
 
-      USER_TEST_HELPER = "./.assert/options"
+    class << self
 
       # assume the test dir path is ./test and look for helpers in ./test/helper.rb
       def package_test_dir
@@ -34,7 +35,8 @@ module Assert
 
       def require_user_test_helper
         if ENV['HOME']
-          safe_require File.expand_path(USER_TEST_HELPER, ENV['HOME'])
+          helper_path = File.join(USER_TEST_DIR, USER_TEST_HELPER)
+          safe_require File.expand_path(helper_path, ENV['HOME'])
         end
       end
 

data/lib/assert/setup/runner.rb

@@ -2,13 +2,12 @@ require 'assert/options'
 require 'assert/runner'
 
 module Assert
+
   # Setup the default global runner for running tests
   options do
     default_runner Runner
   end
 
-  class << self
-    def runner; self.options.runner; end
-  end
+  def self.runner; self.options.runner; end
 
 end

data/lib/assert/setup/suite.rb

@@ -2,15 +2,12 @@ require 'assert/context'
 require 'assert/suite'
 
 module Assert
+
   # Setup the default global suite for collecting tests as contexts are defined
   options do
     default_suite Suite.new
   end
 
-  class << self
-    def suite
-      self.options.suite
-    end
-  end
+  def self.suite; self.options.suite; end
 
 end

data/lib/assert/setup/view.rb

@@ -1,3 +1,4 @@
+require 'assert/setup/helpers'
 require 'assert/view/default_view'
 
 module Assert
@@ -8,9 +9,31 @@ module Assert
     default_view View::DefaultView.new($stdout)
   end
 
-  # setup the global Assert.view method
-  class << self
-    def view; self.options.view; end
+  def self.view; self.options.view; end
+
+  module View
+
+    # this method is used to bring in custom user-specific views
+    # require views by passing either a full path to the view ruby file
+    # or passing the name of a view installed in ~/.assert/views
+
+    def self.require_user_view(view)
+      user_test_root = File.expand_path(Assert::Helpers::USER_TEST_DIR, ENV['HOME'])
+      views_file = File.join(user_test_root, 'views', view, 'lib', view)
+
+      if File.exists?(view) || File.exists?(view+'.rb')
+        require view
+      elsif ENV['HOME'] && File.exists?(views_file+'.rb')
+        require views_file
+      else
+        msg = "[WARN] Can't find or require #{view.inspect} view."
+        if !view.match(/\A\//)
+          msg << " Did you install it in `~/.assert/views`?"
+        end
+        warn msg
+      end
+    end
+
   end
 
 end

data/lib/assert/test.rb

@@ -34,44 +34,29 @@ module Assert
       self.context_info.klass
     end
 
-    def run(view=nil)
-      @results.view = view
+    def run(&result_callback)
+      # setup the a new test run
+      @results = ResultSet.new(result_callback)
       run_scope = self.context_class.new(self)
-      capture_output(StringIO.new(@output, "w+")) do
+
+      # run the test, capturing its output
+      begin
+        run_test_setup(run_scope)
+        run_test_code(run_scope)
+      rescue Result::TestFailure => err
+        @results << Result::Fail.new(self, err)
+      rescue Result::TestSkipped => err
+        @results << Result::Skip.new(self, err)
+      rescue Exception => err
+        @results << Result::Error.new(self, err)
+      ensure
         begin
-          # run any assert style 'setup do' setups
-          self.context_class.setup(run_scope)
-          # run any classic test/unit style 'def setup' setups
-          if run_scope.respond_to?(:setup)
-            run_scope.setup
-          end
-
-          # run the actual test code
-          if @code.kind_of?(::Proc)
-            run_scope.instance_eval(&@code)
-          elsif run_scope.respond_to?(@code.to_s)
-            run_scope.send(@code.to_s)
-          end
-        rescue Result::TestFailure => err
-          @results << Result::Fail.new(self, err)
-        rescue Result::TestSkipped => err
-          @results << Result::Skip.new(self, err)
-        rescue Exception => err
-          @results << Result::Error.new(self, err)
-        ensure
-          begin
-            # run any classic test/unit style 'def teardown' teardowns
-            if run_scope.respond_to?(:teardown)
-              run_scope.teardown
-            end
-            # run any assert style 'teardown do' teardowns
-            self.context_class.teardown(run_scope)
-          rescue Exception => teardown_err
-            @results << Result::Error.new(self, teardown_err)
-          end
+          run_test_teardown(run_scope)
+        rescue Exception => teardown_err
+          @results << Result::Error.new(self, teardown_err)
         end
       end
-      @results.view = nil
+      # return the results of the test run
       @results
     end
 
@@ -102,10 +87,40 @@ module Assert
 
     protected
 
-    def capture_output(io, &block)
-      if self.class.options.capture_output && io
+    def run_test_setup(scope)
+      capture_output do
+        # run any assert style 'setup do' setups
+        self.context_class.setup(scope)
+
+        # run any classic test/unit style 'def setup' setups
+        scope.setup if scope.respond_to?(:setup)
+      end
+    end
+
+    def run_test_code(scope)
+      capture_output do
+        if @code.kind_of?(::Proc)
+          scope.instance_eval(&@code)
+        elsif scope.respond_to?(@code.to_s)
+          scope.send(@code.to_s)
+        end
+      end
+    end
+
+    def run_test_teardown(scope)
+      capture_output do
+        # run any classic test/unit style 'def teardown' teardowns
+        scope.teardown if scope.respond_to?(:teardown)
+
+        # run any assert style 'teardown do' teardowns
+        self.context_class.teardown(scope)
+      end
+    end
+
+    def capture_output(&block)
+      if self.class.options.capture_output
         orig_stdout = $stdout.clone
-        $stdout = io
+        $stdout = capture_io
         block.call
         $stdout = orig_stdout
       else
@@ -113,6 +128,10 @@ module Assert
       end
     end
 
+    def capture_io
+      StringIO.new(@output, "a+")
+    end
+
     def name_from_context(name)
       [ self.context_class.description,
         name