assert-view 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+.bundle
+*.gem
+*.log
+.rvmrc
+.rbenv-version

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify dependencies in assert-views.gemspec
+gemspec
+
+gem 'rake', '~>0.9.2'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    assert-view (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.3.0)
+    assert (0.3.0)
+      ansi (~> 1.3)
+    rake (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  assert
+  assert-view!
+  bundler
+  rake (~> 0.9.2)

data/README.rdoc

@@ -0,0 +1,112 @@
+= Assert::View
+
+
+
+== Description
+
+Assert::View is a collection of view classes for displaying test results using the Assert testing framework (https://github.com/teaminsight/assert).  It allows any number of views to be created and used when running tests with Assert.
+
+
+
+== Installation and Usage
+Assert::View is a dependency of Assert and will be automatically installed when you install Assert:
+
+    $ gem install assert   # will install assert-view as a dependency
+
+=== Usage: override the default view with a different one
+Assert uses the Assert::View::Terminal view outputting to $stdout by default (https://github.com/teaminsight/assert/blob/master/lib/assert/setup/view.rb).  To override and use a different view, add the following to your ~/.assert/options.rb file:
+
+    require 'assert/view/different_view'
+
+    # Override the Assert view option and assign it an instance of the different view
+    # Setup the view passing it the suite accessor and the IO to output on
+    Assert.options.view Assert::View::DifferentView.new(Assert.suite, $stdout)
+
+=== Usage: define your own and override
+So, ~/.assert/option.rb is just a ruby script that is required when Assert is setting itself up.  You can use this file to define your own custom view class and then override the Assert view option like above:
+
+    # Say you wanted to tweak and make a better Terminal view
+    require 'assert/view/terminal'
+    module Assert::View
+      class MyBetterTerminal < Terminal
+        # override stuff and tweak it to your heart's content
+      end
+    end
+
+    # Now override the view option to use your better terminal
+    Assert.options.view Assert::View::MyBetterTerminal.new(Assert.suite, $stdout)
+
+
+
+== Assert::View::Base class
+All views need to subclass the Assert::View::Base class.  This class implements a few core things that assert expects of its view classes:
+
+=== Initializer
+All view initializers take two things at minimum:
+* *output_io*: an IO stream to output to ($stdout, etc...)
+* *suite*: (optional) an instance of the core suite class; the suite of tests to run/render (defaults to Assert.suite - you probably shouldn't change this default unless you know what you are doing)
+
+=== 'suite' reader
+The suite reader provides access to the suite of tests that will be or has been run.  Use this reader to do things like count tests or test results, iterate through the tests and display detailed results, etc.  This reader provides all the model data needed to render your view.
+
+=== 'render' method
+The render method, as its name suggests, handles the overall rendering of the view.  All render methods should take the following arguments:
+* *args*: not used right now - more for view backwards compatibility in the event that args are needed
+* *runner*: runner is a block that is given to the render method by the Assert::Runner class in use.  The view class should call this block (@runner.call@) when the view is ready to run the suite of tests.  Output any view headers before calling; output any view summary/footer after calling.
+
+Here is an excerpt from the Terminal class to illustrate how a render method could be implemented:
+
+    def render(*args, &runner)
+      self.io_puts(:load_stmt)            # header info
+
+      if count(:tests) > 0
+        runner.call if runner             # run the test suite
+        self.io_puts(:detailed_results)   # show any result details
+      end
+
+      self.io_puts(:results_stmt)         # summary/footer info
+    end
+
+=== 'handle_runtime_result' method
+This method is called as the suite of tests is being run.  It is a callback for when a new test result is added to a tests results and the result is passed as the only argument.  Use of the method is totally optional.  The Terminal view uses it to output result abbreviations while the test suite is running.
+
+=== Utilities
+The base class provides a few utilities for rendering views:
+* *io_puts*: puts output to the output IO.  Pass it the string to output or a symbol of a method that returns the string to output.
+* *io_print*: same as io_puts, printing the string instead of putting it
+* *run_time*: get a string with the suite's run time in seconds
+* *run_seed*: get the seed value used to run the test suite in random order
+* *count*: helper method for counting stuff on the suite, ie: 'count(:tests)'
+
+
+
+== Roll Your Own!
+
+Assert::View is designed to be extended and customized.  Using the Base class, create your own view classes and use them as you see fit.  If you feel like sharing, fork the repo, and add a pull requests.  Bonus points to anyone who rips off other testing frameworks views (LeftRight, Turn, etc.)
+
+
+
+== License
+
+Copyright (c) 2011 Kelly D. Redding and Team Insight
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'assert/rake_tasks'
+Assert::RakeTasks.for(:test)
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :build

data/assert-view.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "assert/view/version"
+
+Gem::Specification.new do |s|
+  s.name        = "assert-view"
+  s.version     = Assert::View::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kelly Redding"]
+  s.email       = ["kelly@kelredd.com"]
+  s.homepage    = "http://github.com/teaminsight/assert-view"
+  s.summary     = %q{A collection of views for use in the Assert testing framework}
+  s.description = %q{A collection of views for use in the Assert testing framework}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("assert")
+end

data/lib/assert/view.rb

@@ -0,0 +1,2 @@
+module Assert; end
+module Assert::Views; end

data/lib/assert/view/base.rb

@@ -0,0 +1,63 @@
+require 'assert/options'
+
+module Assert::View
+
+  class Base
+    include Assert::Options
+    options do
+      default_passed_abbrev   '.'
+      default_failed_abbrev   'F'
+      default_ignored_abbrev  'I'
+      default_skipped_abbrev  'S'
+      default_errored_abbrev  'E'
+    end
+
+    attr_reader :suite
+
+    def initialize(output_io, suite=Assert.suite)
+      @suite = suite
+      @out = output_io
+    end
+
+    # override this to define how a view calls the runner and renders its results
+    def render(*args, &runner)
+    end
+
+    def handle_runtime_result(result)
+    end
+
+    protected
+
+    def io_puts(msg, opts={})
+      @out.puts(io_msg(msg, opts={}))
+    end
+
+    def io_print(msg, opts={})
+      @out.print(io_msg(msg, opts={}))
+    end
+
+    def run_time(format='%.6f')
+      format % @suite.run_time
+    end
+
+    def runner_seed
+      @suite.runner_seed
+    end
+
+    def count(type)
+      @suite.count(type)
+    end
+
+    private
+
+    def io_msg(msg, opts={})
+      if msg.kind_of?(::Symbol) && self.respond_to?(msg)
+        self.send(msg).to_s
+      else
+        msg.to_s
+      end
+    end
+
+  end
+
+end

data/lib/assert/view/terminal.rb

@@ -0,0 +1,131 @@
+require 'assert/view/base'
+require 'assert/result'
+
+require 'ansi/code'
+
+module Assert::View
+
+  class Terminal < Base
+
+    options do
+      default_styled          false
+      default_passed_styles   :green
+      default_failed_styles   :red, :bold
+      default_errored_styles  :yellow, :bold
+      default_skipped_styles  :cyan
+      default_ignored_styles  :magenta
+    end
+
+    def render(*args, &runner)
+      self.io_puts(:load_stmt)
+
+      if count(:tests) > 0
+        self.io_puts(:run_stmt)
+        runner.call if runner
+        self.io_puts(:detailed_results)
+      end
+
+      self.io_puts(:results_stmt)
+    end
+
+    def handle_runtime_result(result)
+      sym = result.to_sym
+      self.io_print(result_io_msg(self.options.send("#{sym}_abbrev"), sym))
+    end
+
+    protected
+
+    def load_stmt
+      tplur = (tcount = count(:tests)) == 1 ? "test": "tests"
+      "\nLoaded suite (#{tcount} #{tplur})"
+    end
+
+    def run_stmt
+      "Running tests in random order, seed: '#{self.runner_seed}'"
+    end
+
+    def detailed_results
+      details = self.suite.ordered_tests.reverse.collect do |test|
+        test.results.collect do |result|
+          if show_result_details?(result)
+            [ result_io_msg(result.to_s, result.to_sym),
+              output_io_msg(test.output.to_s)
+            ].join("\n")
+          end
+        end
+      end.flatten.compact
+      "\n\n" + details.join("\n\n") if !details.empty?
+    end
+
+    def results_stmt
+      rplur = (rcount = count(:results)) == 1 ? "result" : "results"
+      [ "\n",
+        "#{rcount} test #{rplur}: ", results_breakdown, "\n\n",
+        "(#{self.run_time} seconds)"
+      ].join('')
+    end
+
+    def results_breakdown
+      if count(:passed) == count(:results)
+        stmnt = if count(:results) < 1
+          "uhh..."
+        elsif count(:results) == 1
+          "it passed"
+        else
+          "all passed"
+        end
+        result_io_msg(stmnt, :passed)
+      else
+        breakdowns = [:passed, :failed, :ignored, :skipped, :errored]
+        breakdowns = breakdowns.inject([]) do |results, result_sym|
+          results << (if count(result_sym) > 0
+            result_io_msg("#{count(result_sym)} #{result_sym}", result_sym)
+          end)
+        end.compact
+        if breakdowns.size < 2
+          breakdowns.join('')
+        elsif breakdowns.size == 2
+          breakdowns.join(" and ")
+        else
+          [breakdowns[0..-2].join(", "), breakdowns.last].join(", and ")
+        end
+      end
+    end
+
+    def result_io_msg(msg, result_sym)
+      term_styles = if self.options.styled
+        self.options.send("#{result_sym}_styles")
+      end
+      io_msg(msg, :term_styles => term_styles)
+    end
+
+    def output_io_msg(output)
+      if output && !output.empty?
+        [ "--- stdout ---",
+          io_msg(output),
+          "--------------"
+        ].collect{|i| i.strip}.join("\n")
+      end
+    end
+
+    def io_msg(msg, opts={})
+      val = super
+      if !(style = term_style(*opts[:term_styles])).empty?
+        val = style + val + ANSI.send(:reset)
+      else
+        val
+      end
+    end
+
+    def term_style(*ansi_codes)
+      ansi_codes.collect{|code| ANSI.send(code) rescue nil}.compact.join('')
+    end
+
+    def show_result_details?(result)
+      ([:failed, :errored].include?(result.to_sym)) ||
+      ([:skipped, :ignored].include?(result.to_sym) && result.message)
+    end
+
+  end
+
+end

data/lib/assert/view/version.rb

@@ -0,0 +1,5 @@
+module Assert; end
+
+module Assert::View
+  VERSION = "0.1.0"
+end

data/test/base_test.rb

@@ -0,0 +1,44 @@
+require 'assert'
+require 'assert/suite'
+
+require 'assert/view/base'
+require 'stringio'
+
+module Assert::View
+
+  class BaseTest < Assert::Context
+    desc "the view base"
+    setup do
+      @view = Assert::View::Base.new(Assert::Suite.new, StringIO.new("", "w+"))
+    end
+    subject{ @view }
+
+    should have_reader :suite
+    should have_instance_methods :render, :handle_runtime_result, :options
+    should have_class_method :options
+
+  end
+
+  class BaseOptionsTest < Assert::Context
+    desc "options for the base view"
+    subject do
+      Assert::View::Base.options
+    end
+
+    should "be an Options::Base object" do
+      assert_kind_of Assert::Options::Base, subject
+    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
+    end
+
+  end
+
+
+
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+# this file is automatically required in when you require 'assert' in your tests
+# put test helpers here
+
+# add root dir to the load path
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))

data/test/irb.rb

@@ -0,0 +1,9 @@
+require 'assert/setup'
+
+# this file is required in when the 'irb' rake test is run.
+# b/c 'assert/setup' is required above, the test helper will be
+# required in as well.
+
+# put any IRB setup code here
+
+require 'assert/view'

data/test/terminal_test.rb

@@ -0,0 +1,32 @@
+require 'assert'
+require 'assert/options'
+
+require 'assert/view/terminal'
+
+module Assert::View
+
+  class TerminalOptionsTest < Assert::Context
+    desc "options for the terminal view"
+    subject do
+      Assert::View::Terminal.options
+    end
+
+    should "be an Options::Base object" do
+      assert_kind_of Assert::Options::Base, subject
+    end
+
+    should "default the styled option" do
+      assert_equal false, subject.default_styled
+    end
+
+    should "default its result styles" do
+      assert_equal :green, subject.default_passed_styles
+      assert_equal [:red, :bold], subject.default_failed_styles
+      assert_equal :magenta, subject.default_ignored_styles
+      assert_equal :cyan, subject.default_skipped_styles
+      assert_equal [:yellow, :bold], subject.default_errored_styles
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: assert-view
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: assert
+description: A collection of views for use in the Assert testing framework
+email: 
+- kelly@kelredd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- assert-view.gemspec
+- lib/assert/view.rb
+- lib/assert/view/base.rb
+- lib/assert/view/terminal.rb
+- lib/assert/view/version.rb
+- test/base_test.rb
+- test/helper.rb
+- test/irb.rb
+- test/terminal_test.rb
+homepage: http://github.com/teaminsight/assert-view
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A collection of views for use in the Assert testing framework
+test_files: 
+- test/base_test.rb
+- test/helper.rb
+- test/irb.rb
+- test/terminal_test.rb