assert-view 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    assert-view (0.3.0)
+    assert-view (0.4.0)
       ansi (~> 1.3)
       undies (~> 1.1)
 
@@ -12,7 +12,7 @@ GEM
     assert (0.6.0)
       assert-view (~> 0.3)
     rake (0.9.2)
-    undies (1.1.0)
+    undies (1.2.0)
 
 PLATFORMS
   ruby

data/lib/assert/view/base.rb

@@ -1,3 +1,4 @@
+require 'assert/result'
 require 'assert/options'
 
 module Assert::View
@@ -50,11 +51,11 @@ module Assert::View
 
     include Assert::Options
     options do
-      default_passed_abbrev   '.'
-      default_failed_abbrev   'F'
-      default_ignored_abbrev  'I'
-      default_skipped_abbrev  'S'
-      default_errored_abbrev  'E'
+      default_pass_abbrev   '.'
+      default_fail_abbrev   'F'
+      default_ignore_abbrev 'I'
+      default_skip_abbrev   'S'
+      default_error_abbrev  'E'
     end
 
     # the Renderer defines the hooks and callbacks needed for the runner to
@@ -114,34 +115,108 @@ module Assert::View
       self.count(:tests) > 0
     end
 
-    def all_passed?
-      self.count(:passed) == self.count(:results)
+    def all_pass?
+      self.count(:pass) == self.count(:results)
+    end
+
+    # get a uniq list of contexts for the test suite
+    def suite_contexts
+      @suite_contexts ||= self.suite.tests.inject([]) do |contexts, test|
+        contexts << test.context_info.klass
+      end.uniq
+    end
+
+    def ordered_suite_contexts
+      self.suite_contexts.sort{|a,b| a.to_s <=> b.to_s}
+    end
+
+    # get a uniq list of files containing contexts for the test suite
+    def suite_files
+      @suite_files ||= self.suite.tests.inject([]) do |files, test|
+        files << test.context_info.file
+      end.uniq
+    end
+
+    def ordered_suite_files
+      self.suite_files.sort{|a,b| a.to_s <=> b.to_s}
+    end
+
+    # get all the results that have details to show
+    # in addition, if a block is given...
+    # yield each result with its index, test, and any captured output
+    def detailed_results(test=nil)
+      tests = test.nil? ? self.suite.ordered_tests.reverse : [test]
+      result_index = 0
+      tests.collect do |test|
+        result_index += 1
+        test.results.
+        select { |result| self.show_result_details?(result) }.
+        each {|r| yield r, result_index, test, test.output if block_given?}
+      end.compact.flatten
+    end
+
+    # get all the results for a klass or other
+    def all_results_for(what=nil)
+      tests = if what.kind_of?(Class) && what.ancestors.include?(Assert::Context)
+        # test results for the given context
+        self.suite.ordered_tests.select do |test|
+          test.context_info.klass == what
+        end
+      elsif what.kind_of?(String)
+        # test results for the given test file
+        self.suite.ordered_tests.select do |test|
+          test.context_info.file == what
+        end
+      else
+        selt.suite.ordered_tests
+      end
+
+      result_index = 0
+      tests.collect do |test|
+        result_index += 1
+        test.results.
+        each {|r| yield r, result_index, test, test.output if block_given?}
+      end.compact.flatten
+    end
+
+    # only show result details for failed or errored results
+    # show result details if a skip or passed result was issues w/ a message
+    def show_result_details?(result)
+      ([:fail, :error].include?(result.to_sym)) ||
+      ([:skip, :ignore].include?(result.to_sym) && result.message)
+    end
+
+    def capture_output_start_msg
+      "--- stdout ---"
+    end
+    def capture_output_end_msg
+      "--------------"
     end
 
     # return a list of result symbols that have actually occurred
     def ocurring_result_types
       @result_types ||= [
-        :passed, :failed, :ignored, :skipped, :errored
+        :pass, :fail, :ignore, :skip, :error
       ].select { |result_sym| self.count(result_sym) > 0 }
     end
 
     # print a result summary message for a given result type
     def result_summary_msg(result_type)
-      if result_type == :passed && self.all_passed?
-        self.all_passed_result_summary_msg
+      if result_type == :pass && self.all_pass?
+        self.all_pass_result_summary_msg
       else
         "#{self.count(result_type)} #{result_type.to_s}"
       end
     end
 
     # generate an appropriate result summary msg for all tests passing
-    def all_passed_result_summary_msg
+    def all_pass_result_summary_msg
       if self.count(:results) < 1
         "uhh..."
       elsif self.count(:results) == 1
-        "it passed"
+        "pass"
       else
-        "all passed"
+        "all pass"
       end
     end
 

data/lib/assert/view/default_view.rb

@@ -1,8 +1,6 @@
-require 'assert/result'
-require 'assert/options'
-
 require 'assert/view/base'
 require 'assert/view/helpers/ansi'
+require 'assert/view/helpers/capture_output'
 
 module Assert::View
 
@@ -10,104 +8,70 @@ module Assert::View
   # designed for terminal viewing.
 
   class DefaultView < Base
+    helper Helpers::CaptureOutput
     helper Helpers::AnsiStyles
+
     options do
-      styled          true
-      passed_styles   :green
-      failed_styles   :red, :bold
-      errored_styles  :yellow, :bold
-      skipped_styles  :cyan
-      ignored_styles  :magenta
+      styled         true
+      pass_styles    :green
+      fail_styles    :red, :bold
+      error_styles   :yellow, :bold
+      skip_styles    :cyan
+      ignore_styles  :magenta
     end
 
     template do
-      __
       __ view.loaded_tests_statement
 
       if view.tests?
 
         __ view.running_tests_statement
 
-        view.run_tests(runner) do |each_result|
-          result_sym = each_result.to_sym
-          result_abbrev = view.options.send("#{result_sym}_abbrev")
-          __ ansi_styled_msg(result_abbrev, result_ansi_styles(result_sym)), false
+        view.run_tests(runner) do |result|
+          result_abbrev = view.options.send("#{result.to_sym}_abbrev")
+          __ ansi_styled_msg(result_abbrev, result_ansi_styles(result)), false
         end
         __ "\n"  # add a newline after streamed runner output
 
-        view.detailed_results do |result, output|
+        view.detailed_results do |result, index, test, output|
           __ ansi_styled_msg(result.to_s, result_ansi_styles(result))
-
-          if !output.empty?
-            __ view.result_output_start_msg
-            __ output, false
-            __ view.result_output_end_msg
-          end
-
+          __ captured_output(output) if output && !output.empty?
           __
         end
 
       end
 
-      # build a summary sentence w/ styled results breakdown
-      styled_results_breakdown_statement = view.results_breakdown_statement do |msg, result_type|
-        ansi_styled_msg(msg, result_ansi_styles(result_type))
-      end
-
-      __ [ view.result_count_statement, ": ", styled_results_breakdown_statement ].join('')
+      __ [  view.result_count_statement, ": ",
+            (view.results_breakdown_statement do |msg, result_sym|
+              ansi_styled_msg(msg, result_ansi_styles(result_sym))
+            end)
+         ].join('')
       __
       __ view.run_time_statement
     end
 
     def loaded_tests_statement
-      "Loaded suite (#{view.count(:tests)} test#{'s' if view.count(:tests) != 1})"
-    end
-
-    def running_tests_statement
-      "Running tests in random order, seeded with: \"#{self.runner_seed}\""
-    end
-
-    # show test details in reverse order from how they were collected (FILO)
-    def detailed_tests
-      self.suite.ordered_tests.reverse
+      "Loaded suite (#{self.test_count_statement})"
     end
 
-    # get all the results that have details to show
-    # in addition, if a block is given...
-    # yield each result with its test output
-    def detailed_results(test=nil)
-      tests = test.nil? ? self.detailed_tests : [test]
-      tests.collect do |test|
-        test.results.
-        select { |result| self.show_result_details?(result) }.
-        each {|r| yield r, test.output if block_given?}
-      end.compact.flatten
+    def test_count_statement
+      "#{self.count(:tests)} test#{'s' if self.count(:tests) != 1}"
     end
 
-    # only show result details for failed or errored results
-    # show result details if a skip or passed result was issues w/ a message
-    def show_result_details?(result)
-      ([:failed, :errored].include?(result.to_sym)) ||
-      ([:skipped, :ignored].include?(result.to_sym) && result.message)
-    end
-
-    def result_output_start_msg
-      "--- stdout ---"
-    end
-    def result_output_end_msg
-      "--------------"
+    def running_tests_statement
+      "Running tests in random order, seeded with \"#{self.runner_seed}\""
     end
 
     # generate a sentence fragment describing the breakdown of test results
     # if a block is given, yield each msg in the breakdown for custom template formatting
     def results_breakdown_statement
-      self.to_sentence(self.ocurring_result_types.collect do |result_type|
-        yield(self.result_summary_msg(result_type), result_type) if block_given?
+      self.to_sentence(self.ocurring_result_types.collect do |result_sym|
+        yield(self.result_summary_msg(result_sym), result_sym) if block_given?
       end)
     end
 
     def result_count_statement
-      "#{self.count(:results)} test result#{'s' if self.count(:results) != 1}"
+      "#{self.count(:results)} result#{'s' if self.count(:results) != 1}"
     end
 
     def run_time_statement

data/lib/assert/view/helpers/capture_output.rb

@@ -0,0 +1,16 @@
+module Assert::View::Helpers
+
+  module CaptureOutput
+
+    def captured_output(output)
+      if !output.empty?
+        # TODO: move to the base view
+        [ view.capture_output_start_msg,
+          output + view.capture_output_end_msg
+        ].join("\n")
+      end
+    end
+
+  end
+
+end

data/lib/assert/view/helpers/leftright_columns.rb

@@ -0,0 +1,48 @@
+module Assert::View::Helpers
+
+  module LeftrightColumns
+
+    def left_column(text, opts={})
+      col_width = opts[:width] || self.view.left_column_width
+      __ case view.options.left_column_justify
+      when :left
+        text.to_s+" "*(col_width-(text.to_s.size))
+      else
+        " "*(col_width-(text.to_s.size))+text.to_s+" "
+      end, false
+    end
+
+    def right_column(text, opts={})
+      lines = text.split("\n")
+      right_columnize(lines.first, opts)
+      lines[1..-1].each do |line|
+        self.left_column("")
+        right_columnize(line, opts)
+      end
+      __ if opts[:endline]
+    end
+
+    def right_columnize(text, opts={})
+      col_width = opts[:width] || self.view.right_column_width
+      # split text into array of limit sizes
+
+      n,r = text.size.divmod(col_width)
+      grps = (0..(n-1)).collect do |i|
+        i == 0 ? text[i*col_width,col_width] : " "+text[i*col_width,col_width]
+      end
+      if r > 0
+        grps << (n > 0 ? " "+text[-r,r] : text[-r,r])
+      end
+
+      __ grps.first
+      if grps.size > 1
+        grps[1..-1].each do |g|
+          self.left_column("")
+          __ g
+        end
+      end
+    end
+
+  end
+
+end

data/lib/assert/view/leftright_view.rb

@@ -0,0 +1,115 @@
+require 'assert/view/default_view'
+require 'assert/view/helpers/leftright_columns'
+
+module Assert::View
+
+  # This is the default view used by assert.  It renders ansi test output
+  # designed for terminal viewing.
+
+  class LeftrightView < DefaultView
+    helper Helpers::LeftrightColumns
+
+    options do
+      default_right_column_width    80
+      default_left_column_groupby   :context
+      default_left_column_justify   :right
+    end
+
+    template do
+      __ view.loaded_suite_statement
+      __ view.started_statement
+
+      if view.tests?
+        __
+
+        view.run_tests(runner)
+
+        view.leftright_groups.each do |grouping|
+          result_abbrevs = ""
+          view.all_results_for(grouping) do |result, index, test, output|
+            result_abbrev = view.options.send("#{result.to_sym}_abbrev")
+            result_abbrevs << ansi_styled_msg(result_abbrev, result_ansi_styles(result))
+          end
+          left_column(view.left_column_display(grouping))
+          right_column(result_abbrevs, {
+            :width => (view.options.styled ? 10 : 1)*view.right_column_width
+          })
+
+          result_details = []
+          view.all_results_for(grouping) do |result, index, test, output|
+            if view.show_result_details?(result)
+              result_details << [
+                ansi_styled_msg(result.to_s, result_ansi_styles(result)),
+                captured_output(output),
+                "\n"
+              ].compact.join("\n")
+            end
+          end
+          if result_details.size > 0
+            left_column("")
+            right_column(result_details.join, {:endline => true})
+          end
+        end
+
+      end
+
+      __
+      __ [  view.result_count_statement, ": ",
+            (view.results_breakdown_statement do |msg, result_sym|
+              ansi_styled_msg(msg, result_ansi_styles(result_sym))
+            end)
+         ].join('')
+      __
+      __ view.run_time_statement
+    end
+
+    def loaded_suite_statement
+      "Loaded suite #{$0.to_s}"
+    end
+
+    def started_statement
+      "Started"
+    end
+
+    def leftright_groups
+      case self.options.left_column_groupby
+      when :context
+        self.ordered_suite_contexts
+      when :file
+        self.ordered_suite_files
+      else
+        []
+      end
+    end
+
+    def left_column_display(leftcol_value)
+      case self.options.left_column_groupby
+      when :context
+        leftcol_value.to_s.gsub(/Test$/, '')
+      when :file
+        leftcol_value.to_s.gsub(File.expand_path(".", Dir.pwd), '').gsub(/^\/+test\//, '')
+      else
+        leftcol_value.to_s
+      end
+    end
+
+    def left_column_width
+      @left_col_width ||= case self.options.left_column_groupby
+      when :context
+        self.suite_contexts.collect{|f| f.to_s.gsub(/Test$/, '')}
+      when :file
+        self.suite_files.collect{|f| f.to_s.gsub(File.expand_path(".", Dir.pwd), '').gsub(/^\/+test\//, '')}
+      else
+        []
+      end.inject(0) do |max_size, klass|
+        klass.to_s.size > max_size ? klass.to_s.size : max_size
+      end + 1
+    end
+
+    def right_column_width
+      self.options.right_column_width
+    end
+
+  end
+
+end

data/lib/assert/view/redgreen_view.rb

@@ -0,0 +1,63 @@
+require 'assert/view/test_unit_view'
+require 'assert/view/helpers/ansi'
+
+module Assert::View
+
+  # this view add simple color ansi output to the TestUnitView
+
+  class RedgreenView < TestUnitView
+    helper Helpers::CaptureOutput
+    helper Helpers::AnsiStyles
+
+    options do
+      styled          true
+      passed_styles   :green
+      failed_styles   :red
+      errored_styles  :yellow
+      skipped_styles  :yellow
+      ignored_styles  :yellow
+    end
+
+    # this template is identical to the TestUnitView template, except:
+    # - the run_tests result handler block shows ansi styled output
+    # - each detailed result renders its name styled
+    # - the results_breakdown_statement renders ansi styled
+    template do
+      __ view.loaded_suite_statement
+      __ view.started_statement
+
+      if view.tests?
+
+        view.run_tests(runner) do |each_result|
+          # the run_tests result handler from DefaultView
+          result_sym = each_result.to_sym
+          result_abbrev = view.options.send("#{result_sym}_abbrev")
+          __ ansi_styled_msg(result_abbrev, result_ansi_styles(result_sym)), false
+        end
+        __
+        __ view.finished_statement
+        __
+
+        # same as the test/unit template except styling result name
+        view.detailed_results do |result, index, test, output|
+          # TODO: remove and call directly once result name is in assert
+          result_name = result.respond_to?(:name) ? result.name : ""
+          __ "  #{index}) #{ansi_styled_msg(result_name, result_ansi_styles(result.to_sym))}:"
+          __ "#{result.test_name}(#{test.context_class.name}):"
+          __ result.message
+          __ "    #{result.backtrace.filtered.first.to_s}"
+
+          __ captured_output(output) if output && !output.empty?
+          __
+        end
+
+      end
+
+      # smae as test/unit, except styled
+      __ ansi_styled_msg(view.results_breakdown_statement, view.all_pass? ? :green : :red)
+    end
+
+  end
+
+end
+

data/lib/assert/view/test_unit_view.rb

@@ -0,0 +1,66 @@
+require 'assert/view/base'
+require 'assert/view/helpers/capture_output'
+
+module Assert::View
+
+  # this view renders in test/unit style
+
+  class TestUnitView < Base
+    helper Helpers::CaptureOutput
+
+    template do
+      __ view.loaded_suite_statement
+      __ view.started_statement
+
+      if view.tests?
+
+        view.run_tests(runner) do |each_result|
+          __ view.options.send("#{each_result.to_sym}_abbrev"), false
+        end
+        __
+        __ view.finished_statement
+        __
+
+        view.detailed_results do |result, index, test, output|
+          # TODO: remove and call directly once result name is in assert
+          result_name = result.respond_to?(:name) ? result.name : ""
+          __ "  #{index}) #{result_name}:"
+          __ "#{result.test_name}(#{test.context_class.name}):"
+          __ result.message
+          __ "    #{result.backtrace.filtered.first.to_s}"
+
+          __ captured_output(output) if output && !output.empty?
+          __
+        end
+
+      end
+
+      __ view.results_breakdown_statement
+    end
+
+    def loaded_suite_statement
+      "Loaded suite #{$0.to_s}"
+    end
+
+    def started_statement
+      "Started"
+    end
+
+    def finished_statement
+      "Finished in #{self.run_time} seconds."
+    end
+
+    # generate a sentence fragment describing the breakdown of test results
+    # if a block is given, yield each msg in the breakdown for custom template formatting
+    def results_breakdown_statement
+      [ "#{self.count(:tests)} tests, #{self.count(:results)} assertions",
+        self.to_sentence(self.ocurring_result_types.collect do |result_type|
+          self.result_summary_msg(result_type)
+        end)
+      ].join(", ")
+    end
+
+  end
+
+end
+

data/lib/assert/view/version.rb

@@ -1,5 +1,5 @@
 module Assert; end
 
 module Assert::View
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/base_test.rb

@@ -16,9 +16,14 @@ module Assert::View
     should have_accessors :suite, :output_io, :runtime_result_callback
     should have_class_method :template
     should have_instance_methods :run_tests, :handle_runtime_result
-    should have_instance_methods :run_time, :runner_seed, :count, :tests?, :all_passed?
+    should have_instance_methods :run_time, :runner_seed, :count, :tests?
+    should have_instance_methods :suite_contexts, :ordered_suite_contexts
+    should have_instance_methods :suite_files, :ordered_suite_files
+    should have_instance_methods :show_result_details?, :detailed_results, :all_results_for
     should have_instance_methods :ocurring_result_types, :result_summary_msg
-    should have_instance_methods :all_passed_result_summary_msg, :to_sentence
+    should have_instance_methods :all_pass?, :all_pass_result_summary_msg, :to_sentence
+    should have_instance_methods :capture_output_start_msg, :capture_output_end_msg
+
 
     # options stuff
     should have_instance_method :options
@@ -41,11 +46,11 @@ module Assert::View
     end
 
     should "default its result abbreviations" do
-      assert_equal '.', subject.default_passed_abbrev
-      assert_equal 'F', subject.default_failed_abbrev
-      assert_equal 'I', subject.default_ignored_abbrev
-      assert_equal 'S', subject.default_skipped_abbrev
-      assert_equal 'E', subject.default_errored_abbrev
+      assert_equal '.', subject.default_pass_abbrev
+      assert_equal 'F', subject.default_fail_abbrev
+      assert_equal 'I', subject.default_ignore_abbrev
+      assert_equal 'S', subject.default_skip_abbrev
+      assert_equal 'E', subject.default_error_abbrev
     end
 
   end

data/test/default_view_test.rb

@@ -5,16 +5,14 @@ require 'stringio'
 
 module Assert::View
 
-  class TerminalTest < Assert::Context
-    desc "the terminal view"
+  class DefaultViewTest < Assert::Context
+    desc "the default view"
     setup do
       @view = Assert::View::DefaultView.new(Assert::Suite.new, StringIO.new("", "w+"))
     end
     subject{ @view }
 
     should have_instance_methods :loaded_tests_statement, :running_tests_statement
-    should have_instance_methods :detailed_tests, :detailed_results, :show_result_details?
-    should have_instance_methods :result_output_start_msg, :result_output_end_msg
     should have_instance_methods :results_breakdown_statement, :result_count_statement
     should have_instance_methods :run_time_statement
 

data/test/leftright_view_test.rb

@@ -0,0 +1,19 @@
+require 'assert'
+
+require 'assert/view/leftright_view'
+require 'stringio'
+
+module Assert::View
+
+  class LeftrightViewTest < Assert::Context
+    desc "the leftright view"
+    setup do
+      @view = Assert::View::LeftrightView.new(Assert::Suite.new, StringIO.new("", "w+"))
+    end
+    subject{ @view }
+
+    should have_instance_methods :loaded_suite_statement, :started_statement
+    should have_instance_methods :leftright_groups, :left_column_display, :left_column_width
+
+  end
+end

data/test/test_unit_test.rb

@@ -0,0 +1,19 @@
+require 'assert'
+
+require 'assert/view/test_unit_view'
+require 'stringio'
+
+module Assert::View
+
+  class TestUnitViewTest < Assert::Context
+    desc "the test/unit view"
+    setup do
+      @view = Assert::View::TestUnitView.new(Assert::Suite.new, StringIO.new("", "w+"))
+    end
+    subject{ @view }
+
+    should have_instance_methods :loaded_suite_statement, :started_statement
+    should have_instance_methods :finished_statement, :results_breakdown_statement
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: assert-view
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-09 00:00:00 Z
+date: 2011-10-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -96,11 +96,18 @@ files:
 - lib/assert/view/base.rb
 - lib/assert/view/default_view.rb
 - lib/assert/view/helpers/ansi.rb
+- lib/assert/view/helpers/capture_output.rb
+- lib/assert/view/helpers/leftright_columns.rb
+- lib/assert/view/leftright_view.rb
+- lib/assert/view/redgreen_view.rb
+- lib/assert/view/test_unit_view.rb
 - lib/assert/view/version.rb
 - test/base_test.rb
 - test/default_view_test.rb
 - test/helper.rb
 - test/irb.rb
+- test/leftright_view_test.rb
+- test/test_unit_test.rb
 homepage: http://github.com/teaminsight/assert-view
 licenses: []
 
@@ -139,3 +146,5 @@ test_files:
 - test/default_view_test.rb
 - test/helper.rb
 - test/irb.rb
+- test/leftright_view_test.rb
+- test/test_unit_test.rb