mspec 1.0.0

data/lib/mspec/runner/actions/tally.rb

@@ -0,0 +1,80 @@
+class Tally
+  attr_reader :files, :examples, :expectations, :failures, :errors
+
+  def initialize
+    @files = @examples = @expectations = @failures = @errors = 0
+  end
+
+  def files!(add=1)
+    @files += add
+  end
+
+  def examples!(add=1)
+    @examples += add
+  end
+
+  def expectations!(add=1)
+    @expectations += add
+  end
+
+  def failures!(add=1)
+    @failures += add
+  end
+
+  def errors!(add=1)
+    @errors += add
+  end
+
+  def format
+    [ [@files, 'file'],
+      [@examples, 'example'],
+      [@expectations, 'expectation'],
+      [@failures, 'failure'],
+      [@errors, 'error']
+    ].map { |count, word| pluralize count, word }.join(", ")
+  end
+
+  def pluralize(count, singular)
+    "#{count} #{singular}#{'s' unless count == 1}"
+  end
+  private :pluralize
+end
+
+class TallyAction
+  attr_reader :counter
+
+  def initialize
+    @counter = Tally.new
+  end
+
+  def register
+    MSpec.register :load, self
+    MSpec.register :after, self
+    MSpec.register :expectation, self
+  end
+
+  def unregister
+    MSpec.unregister :load, self
+    MSpec.unregister :after, self
+    MSpec.unregister :expectation, self
+  end
+
+  def load
+    @counter.files!
+  end
+
+  def expectation(state)
+    @counter.expectations!
+  end
+
+  def after(state)
+    @counter.examples!
+    state.exceptions.each do |msg, exc|
+      state.failure?(exc) ? @counter.failures! : @counter.errors!
+    end
+  end
+
+  def format
+    @counter.format
+  end
+end

data/lib/mspec/runner/actions/timer.rb

@@ -0,0 +1,22 @@
+class TimerAction
+  def register
+    MSpec.register :start, self
+    MSpec.register :finish, self
+  end
+
+  def start
+    @start = Time.now
+  end
+
+  def finish
+    @stop = Time.now
+  end
+
+  def elapsed
+    @stop - @start
+  end
+
+  def format
+    "Finished in %f seconds" % elapsed
+  end
+end

data/lib/mspec/runner/filters.rb

@@ -0,0 +1,4 @@
+require 'mspec/runner/filters/match'
+require 'mspec/runner/filters/regexp'
+require 'mspec/runner/filters/tag'
+require 'mspec/runner/filters/profile'

data/lib/mspec/runner/filters/match.rb

@@ -0,0 +1,22 @@
+class MatchFilter
+  def initialize(what, *strings)
+    @what = what
+    @descriptions = to_regexp(*strings)
+  end
+
+  def to_regexp(*strings)
+    strings.map { |str| Regexp.new Regexp.escape(str) }
+  end
+
+  def ===(string)
+    @descriptions.any? { |d| d === string }
+  end
+
+  def register
+    MSpec.register @what, self
+  end
+
+  def unregister
+    MSpec.unregister @what, self
+  end
+end

data/lib/mspec/runner/filters/profile.rb

@@ -0,0 +1,54 @@
+class ProfileFilter
+  def initialize(what, *files)
+    @what = what
+    @methods = load(*files)
+    @pattern = /([^ .#]+[.#])([^ ]+)/
+  end
+
+  def find(name)
+    return name if File.exist?(File.expand_path(name))
+
+    ["spec/profiles", "spec", "profiles", "."].each do |dir|
+      file = File.join dir, name
+      return file if File.exist? file
+    end
+  end
+
+  def parse(file)
+    pattern = /(\S+):\s*/
+    key = ""
+    file.inject(Hash.new { |h,k| h[k] = [] }) do |hash, line|
+      line.chomp!
+      if line[0,2] == "- "
+        hash[key] << line[2..-1].gsub(/[ '"]/, "")
+      elsif m = pattern.match(line)
+        key = m[1]
+      end
+      hash
+    end
+  end
+
+  def load(*files)
+    files.inject({}) do |hash, file|
+      next hash unless name = find(file)
+
+      File.open name, "r" do |f|
+        hash.merge parse(f)
+      end
+    end
+  end
+
+  def ===(string)
+    return false unless m = @pattern.match(string)
+    return false unless l = @methods[m[1]]
+    l.include? m[2]
+  end
+
+  def register
+    MSpec.register @what, self
+  end
+
+  def unregister
+    MSpec.unregister @what, self
+  end
+end

data/lib/mspec/runner/filters/regexp.rb

@@ -0,0 +1,7 @@
+require 'mspec/runner/filters/match'
+
+class RegexpFilter < MatchFilter
+  def to_regexp(*strings)
+    strings.map { |str| Regexp.new str }
+  end
+end

data/lib/mspec/runner/filters/tag.rb

@@ -0,0 +1,29 @@
+require 'mspec/runner/filters/match'
+
+class TagFilter
+  def initialize(what, *tags)
+    @what = what
+    @tags = tags
+  end
+
+  def load
+    desc = MSpec.read_tags(*@tags).map { |t| t.description }
+
+    @filter = MatchFilter.new(@what, *desc)
+    @filter.register
+  end
+
+  def unload
+    @filter.unregister if @filter
+  end
+
+  def register
+    MSpec.register :load, self
+    MSpec.register :unload, self
+  end
+
+  def unregister
+    MSpec.unregister :load, self
+    MSpec.unregister :unload, self
+  end
+end

data/lib/mspec/runner/formatters.rb

@@ -0,0 +1,7 @@
+require 'mspec/runner/formatters/dotted'
+require 'mspec/runner/formatters/specdoc'
+require 'mspec/runner/formatters/html'
+require 'mspec/runner/formatters/summary'
+require 'mspec/runner/formatters/unit'
+require 'mspec/runner/formatters/spinner'
+require 'mspec/runner/formatters/yaml'

data/lib/mspec/runner/formatters/dotted.rb

@@ -0,0 +1,81 @@
+require 'mspec/expectations/expectations'
+require 'mspec/runner/actions/timer'
+require 'mspec/runner/actions/tally'
+
+class DottedFormatter
+  attr_reader :timer, :tally
+
+  def initialize(out=nil)
+    @states = []
+    if out.nil?
+      @out = $stdout
+    else
+      @out = File.open out, "w"
+    end
+  end
+
+  def register
+    @timer = TimerAction.new
+    @timer.register
+    @tally = TallyAction.new
+    @tally.register
+    @counter = @tally.counter
+
+    MSpec.register :after, self
+    MSpec.register :finish, self
+  end
+
+  def after(state)
+    unless state.exception?
+      print "."
+    else
+      @states << state
+      print failure?(state) ? "F" : "E"
+    end
+  end
+
+  def finish
+    print "\n"
+    count = 0
+    @states.each do |state|
+      state.exceptions.each do |msg, exc|
+        outcome = failure?(state) ? "FAILED" : "ERROR"
+        print "\n#{count += 1})\n#{state.description} #{outcome}\n"
+        print "#{exc.class.name} occurred during: #{msg}\n" if msg
+        print message(exc)
+        print "\n"
+        print backtrace(exc)
+        print "\n"
+      end
+    end
+    print "\n#{@timer.format}\n\n#{@tally.format}\n"
+  end
+
+  def print(*args)
+    @out.print(*args)
+  end
+
+  def message(exc)
+    if exc.message.empty?
+      "<No message>"
+    elsif exc.class == ExpectationNotMetError
+      exc.message
+    else
+      "#{exc.class}: #{exc.message}"
+    end
+  end
+
+  def failure?(state)
+    state.exceptions.all? { |msg, exc| state.failure?(exc) }
+  end
+  private :failure?
+
+  def backtrace(exc)
+    begin
+      return exc.awesome_backtrace.show
+    rescue Exception
+      return exc.backtrace && exc.backtrace.join("\n")
+    end
+  end
+  private :backtrace
+end

data/lib/mspec/runner/formatters/html.rb

@@ -0,0 +1,87 @@
+require 'mspec/expectations/expectations'
+require 'mspec/runner/formatters/dotted'
+
+class HtmlFormatter < DottedFormatter
+  def register
+    super
+    MSpec.register :start, self
+    MSpec.register :enter, self
+    MSpec.register :leave, self
+  end
+
+  def start
+    print <<-EOH
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+    "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<title>Spec Output For #{RUBY_NAME} (#{RUBY_VERSION})</title>
+<style type="text/css">
+ul {
+  list-style: none;
+}
+.fail {
+  color: red;
+}
+.pass {
+  color: green;
+}
+#details :target {
+  background-color: #ffffe0;
+}
+</style>
+</head>
+<body>
+EOH
+  end
+
+  def enter(describe)
+    print "<div><p>#{describe}</p>\n<ul>\n"
+  end
+
+  def leave
+    print "</ul>\n</div>\n"
+  end
+
+  def after(state)
+    desc = "- #{state.it}"
+    if state.exception?
+      @states << state
+      count = @counter.failures + @counter.errors - state.exceptions.size
+      state.exceptions.each do |msg, exc|
+        outcome = state.failure?(exc) ? "FAILED" : "ERROR"
+        count += 1
+        print %[<li class="fail">#{desc} (<a href="#details-#{count}">#{outcome} - #{count}</a>)</li>\n]
+      end
+    else
+      print %[<li class="pass">#{desc}</li>\n]
+    end
+  end
+
+  def finish
+    success = @states.empty?
+    unless success
+      print "<hr>\n"
+      print %[<ol id="details">]
+      count = 0
+      @states.each do |state|
+        state.exceptions.each do |msg, exc|
+          outcome = failure?(state) ? "FAILED" : "ERROR"
+          print %[\n<li id="details-#{count += 1}"><p>#{escape(state.description)} #{outcome}</p>\n<p>]
+          print escape(message(exc))
+          print "</p>\n<pre>\n"
+          print escape(backtrace(exc))
+          print "</pre>\n</li>\n"
+        end
+      end
+      print "</ol>\n"
+    end
+    print %[<p>#{@timer.format}</p>\n]
+    print %[<p class="#{success ? "pass" : "fail"}">#{@tally.format}</p>\n]
+    print "</body>\n</html>\n"
+  end
+
+  def escape(string)
+    string.gsub("&", "&nbsp;").gsub("<", "&lt;").gsub(">", "&gt;")
+  end
+end

data/lib/mspec/runner/formatters/specdoc.rb

@@ -0,0 +1,27 @@
+require 'mspec/expectations/expectations'
+require 'mspec/runner/formatters/dotted'
+
+class SpecdocFormatter < DottedFormatter
+  def register
+    super
+    MSpec.register :enter, self
+  end
+
+  def enter(describe)
+    print "\n#{describe}\n"
+  end
+
+  def after(state)
+    desc = "- #{state.it}"
+    if state.exception?
+      @states << state
+      count = @counter.failures + @counter.errors - state.exceptions.size
+      state.exceptions.each do |msg, exc|
+        outcome = state.failure?(exc) ? "FAILED" : "ERROR"
+        print "#{desc} (#{outcome} - #{count += 1})\n"
+      end
+    else
+      print "#{desc}\n"
+    end
+  end
+end

data/lib/mspec/runner/formatters/spinner.rb

@@ -0,0 +1,89 @@
+require 'mspec/expectations/expectations'
+require 'mspec/runner/formatters/dotted'
+
+class SpinnerFormatter < DottedFormatter
+  attr_reader :length
+
+  Spins = %w!| / - \\!
+  HOUR = 3600
+  MIN = 60
+
+  def initialize(out=nil)
+    @out = $stdout
+
+    @states = []
+    @which = 0
+    @count = 0
+    self.length = 40
+    @percent = 0
+    @start = Time.now
+
+    term = ENV['TERM']
+    @color = (term != "dumb")
+    @fail_color  = "32"
+    @error_color = "32"
+  end
+
+  def register
+    super
+
+    MSpec.register :start, self
+    MSpec.register :load, self
+  end
+
+  def length=(length)
+    @length = length
+    @ratio = 100.0 / length
+    @position = length / 2 - 2
+  end
+
+  def etr
+    return "00:00:00" if @percent == 0
+    elapsed = Time.now - @start
+    remain = (100 * elapsed / @percent) - elapsed
+
+    hour = remain >= HOUR ? (remain / HOUR).to_i : 0
+    remain -= hour * HOUR
+    min = remain >= MIN ? (remain / MIN).to_i : 0
+    sec = remain - min * MIN
+
+    "%02d:%02d:%02d" % [hour, min, sec]
+  end
+
+  def percentage
+    @percent = @count * 100 / @total
+    bar = ("=" * (@percent / @ratio)).ljust @length
+    label = "%d%%" % @percent
+    bar[@position, label.size] = label
+    bar
+  end
+
+  def spin
+    @which = (@which + 1) % Spins.size
+    if @color
+      print "\r[%s | %s | %s] \033[0;#{@fail_color}m%6dF \033[0;#{@error_color}m%6dE\033[0m" %
+          [Spins[@which], percentage, etr, @counter.failures, @counter.errors]
+    else
+      print "\r[%s | %s | %s] %6dF %6dE" %
+          [Spins[@which], percentage, etr, @counter.failures, @counter.errors]
+    end
+  end
+
+  def start
+    @total = MSpec.retrieve(:files).size
+  end
+
+  def load
+    @count += 1
+  end
+
+  def after(state)
+    if state.exception?
+      @fail_color =  "31" if @counter.failures > 0
+      @error_color = "33" if @counter.errors > 0
+      @states << state
+    end
+
+    spin
+  end
+end