rspec-live 0.0.1

data/History.md

@@ -0,0 +1,7 @@
+### Version 0.0.1
+2014-8-12
+
+* Watch for file changes and rerun all specs
+* Concise backtraces with configurable verbosity level
+* Rotate list of failures to show different specs at the top
+* Fullscreen Curses output with color and resizing detection

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brian Auton
+
+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/README.md

@@ -0,0 +1,25 @@
+# rspec-live
+
+rspec-live is a test runner and formatter for RSpec 3+ that shows the state of your test suite
+clearly and concisely in a console window.  As files in your project are updated, created, or
+removed, rspec-live reruns your tests in the background and continually updates the displayed
+status.
+
+### Requirements
+
+* Ruby 1.8.7 or newer
+* RSpec 3.0.0 or newer
+
+### Getting Started
+
+Add the gem to your Gemfile,
+
+    gem 'rspec-live'
+
+Update your bundle,
+
+    bundle
+
+And start it up.
+
+    rspec-live

data/bin/rspec-live

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require "rspec-live/suite"
+require "rspec-live/runner"
+require "rspec-live/watcher"
+require "rspec-live/display"
+
+display = RSpecLive::Display.new
+suite = RSpecLive::Suite.new(RSpecLive::Runner.new, display.suite_display)
+RSpecLive::Watcher.new(suite, display.watcher_display).start

data/lib/formatters/inventory_formatter.rb

@@ -0,0 +1,13 @@
+require "json"
+
+class InventoryFormatter
+  RSpec::Core::Formatters.register self, :example_started
+
+  def initialize(output)
+    @output = output
+  end
+
+  def example_started(notification)
+    @output << "#{JSON.unparse(name: notification.example.location)}\n"
+  end
+end

data/lib/formatters/update_formatter.rb

@@ -0,0 +1,30 @@
+require "json"
+
+class UpdateFormatter
+  RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending
+
+  def initialize(output)
+    @output = output
+  end
+
+  def example_passed(notification)
+    report :name => notification.example.location, :status => "passed"
+  end
+
+  def example_failed(notification)
+    report({
+      :name => notification.example.location,
+      :status => "failed",
+      :backtrace => notification.exception.backtrace,
+      :message => notification.exception.message,
+    })
+  end
+
+  def example_pending(notification)
+    report :name => notification.example.location, :status => "pending"
+  end
+
+  def report(data)
+    @output << "#{JSON.unparse data}\n"
+  end
+end

data/lib/rspec-live/backtrace.rb

@@ -0,0 +1,66 @@
+module RSpecLive
+  class Backtrace
+    def initialize(data, verbosity)
+      @components = data.map { |text| BacktraceComponent.new text, verbosity }
+    end
+
+    def components
+      strip_setup collapsed_components.map(&:to_s)
+    end
+
+    private
+
+    def strip_setup(text_components)
+      list = text_components.dup
+      while ["gem:ruby", "gem:rspec-core"].include? list.last do
+        list = list[0, list.length-1]
+      end
+      list
+    end
+
+    def collapsed_components
+      @components.inject([]) do |group, component|
+        group.dup.tap do |new_group|
+          new_group << component unless group.last && (group.last.to_s == component.to_s)
+        end
+      end
+    end
+  end
+
+  class BacktraceComponent
+    def initialize(text, verbosity)
+      @file, @line, @method = text.split(":")
+      @verbosity = verbosity
+    end
+
+    def to_s
+      local_file_reference || gem_reference || "other"
+    end
+
+    private
+
+    def local_file_reference
+      if @file.start_with? Dir.pwd
+        ref = "#{@file.gsub(/^#{Dir.pwd}\//, "")}:#{@line}"
+        ref += ":#{cleaned_method}" if @verbosity > 1
+        ref
+      end
+    end
+
+    def cleaned_method
+      @method.gsub(/^in `/, "").gsub(/'$/, "")
+    end
+
+    def gem_reference
+      if @file.include? "/gems/"
+        local_reference = @file.split("/gems/").last
+        path = local_reference.gsub(/^\/*/, "")
+        gem_name_parts = local_reference.split("/").first.split("-")
+        gem_name = gem_name_parts[0, gem_name_parts.length - 1].join("-")
+        ref = "gem:#{gem_name}"
+        ref += "/#{path}:#{@line}:#{cleaned_method}" if @verbosity > 2
+        ref
+      end
+    end
+  end
+end

data/lib/rspec-live/display.rb

@@ -0,0 +1,68 @@
+require "rspec-live/terminal"
+
+module RSpecLive
+  class Display
+    attr_reader :watcher_display, :suite_display
+
+    def initialize
+      @terminal = Terminal.new
+      @watcher_display = WatcherDisplay.new(@terminal.add_section :xalign => :center)
+      @terminal.add_section :display => :block, :content => key_command_info, :color => :blue
+      @suite_display = SuiteDisplay.new(@terminal.add_section :display => :block)
+    end
+
+    private
+
+    def key_command_info
+      "Keys: A:show/hide-all N:next V:verbosity R:rerun Q:quit"
+    end
+  end
+
+  class WatcherDisplay
+    def initialize(section)
+      @section = section
+    end
+
+    def status=(status)
+      @section.content = "RSpec summary for #{File.basename Dir.pwd} (#{status})"
+      @section.refresh
+    end
+  end
+
+  class SuiteDisplay
+    def initialize(section)
+      @section = section
+    end
+
+    def show_examples(examples, suite_status, detailed_examples, verbosity)
+      @section.clear
+      @section.add_section :display => :block
+      examples.map(&:status).each do |status|
+        @section.add_section :content => character[status], :color => color[status]
+      end
+      @section.add_section :display => :block
+      @section.add_section :content => "#{suite_status}", :display => :block
+      @section.add_section :display => :block
+      last_failed = true
+      bullet_width = (detailed_examples.length-1).to_s.length
+      detailed_examples.each_with_index do |example, index|
+        bullet = "#{index+1}.".rjust(bullet_width+1, " ")
+        @section.add_section :display => :block if (!last_failed && example.failed?)
+        @section.add_section :content => example.details(verbosity), :display => :block, :color => color[example.status], :wrap => true, :bullet => bullet
+        @section.add_section :display => :block if example.failed?
+        last_failed = example.failed?
+      end
+      @section.refresh
+    end
+
+    private
+
+    def character
+      {:unknown => ".", :passed => ".", :failed => "F", :pending => "S"}
+    end
+
+    def color
+      {:unknown => :blue, :passed => :green, :failed => :red, :pending => :yellow}
+    end
+  end
+end

data/lib/rspec-live/example.rb

@@ -0,0 +1,53 @@
+require "rspec-live/backtrace"
+
+module RSpecLive
+  class Example
+    attr_reader :name, :status
+
+    def initialize
+      @name = ""
+      @status = :unknown
+      @backtrace = []
+    end
+
+    def update(data)
+      @name = data["name"] if data["name"]
+      @status = data["status"].to_sym if data["status"]
+      @backtrace = data["backtrace"] if data["backtrace"]
+      @message = data["message"] if data["message"]
+    end
+
+    def status=(value)
+      @status = value.to_sym
+    end
+
+    def passed?
+      @status == :passed
+    end
+
+    def failed?
+      @status == :failed
+    end
+
+    def details(verbosity)
+      failed? ? failure_message(verbosity) : name_component
+    end
+
+    def name_component
+      "(" + @name.gsub(/^.\//, "") + ")"
+    end
+
+    def failure_message(verbosity)
+      ([name_component] + backtrace_components(verbosity) + exception_components).compact.join " -> "
+    end
+
+    def backtrace_components(verbosity)
+      return [] if verbosity < 1
+      Backtrace.new(@backtrace, verbosity).components.reverse.map { |c| "(#{c})" }
+    end
+
+    def exception_components
+      [@message.gsub("\n", " ").strip.inspect]
+    end
+  end
+end

data/lib/rspec-live/runner.rb

@@ -0,0 +1,42 @@
+require "pty"
+require "json"
+
+module RSpecLive
+  class Runner
+    def inventory(&block)
+      run "inventory", "--dry-run", &block
+    end
+
+    def update(&block)
+      run "update", &block
+    end
+
+    private
+
+    def run(formatter, options="", &block)
+      PTY.spawn formatter_command(formatter, options) do |stdin, stdout, pid|
+        begin
+          stdin.each do |line|
+            block.call JSON.parse line
+          end
+        rescue Errno::EIO
+        end
+      end
+    rescue PTY::ChildExited
+    end
+
+    def formatter_command(formatter, options)
+      options << " --format #{formatter_class formatter}"
+      options << " --require #{formatter_source formatter}"
+      "rspec #{options}"
+    end
+
+    def formatter_source(formatter)
+      File.join File.dirname(__FILE__), "../formatters/#{formatter}_formatter.rb"
+    end
+
+    def formatter_class(formatter)
+      "#{formatter.capitalize}Formatter"
+    end
+  end
+end

data/lib/rspec-live/suite.rb

@@ -0,0 +1,94 @@
+require "rspec-live/example"
+
+module RSpecLive
+  class Suite
+    def initialize(runner, display)
+      @runner = runner
+      @display = display
+      @example_names = []
+      @examples = {}
+      @show_all = false
+      @verbosity = 1
+    end
+
+    def toggle_all
+      @show_all = !@show_all
+      update_display
+    end
+
+    def inventory
+      @example_names = []
+      @runner.inventory do |example_data|
+        update_or_create_example example_data
+        update_display
+      end
+    end
+
+    def update
+      @runner.update do |example_data|
+        update_or_create_example example_data
+        update_display
+      end
+    end
+
+    def focus_next
+      @focused = detailed_examples[1].name if detailed_examples[1]
+      update_display
+    end
+
+    def clear_status
+      @examples.each_value { |example| example.status = :unknown }
+    end
+
+    def cycle_verbosity
+      @verbosity = (@verbosity + 1) % 4
+      update_display
+    end
+
+    private
+
+    def next_visible(name)
+    end
+
+    def update_or_create_example(data)
+      name = data["name"]
+      @example_names << name unless @example_names.include? name
+      sort_example_names
+      @examples[name] ||= Example.new
+      @examples[name].update data
+      @examples[name]
+    end
+
+    def update_display
+      @display.show_examples ordered_examples, summary, detailed_examples, @verbosity
+    end
+
+    def detailed_examples
+      all = ordered_examples
+      if @focused
+        index = @example_names.index(@focused) || 0
+        all = all[index, all.length-index] + all[0, index]
+      end
+      @show_all ? all : all.select(&:failed?)
+    end
+
+    def ordered_examples
+      @example_names.map { |name| @examples[name] }
+    end
+
+    def sort_example_names
+      @example_names.sort_by! do |name|
+        file, line = name.split(":")
+        line = line.rjust(8, "0")
+        [file, line].join(":")
+      end
+    end
+
+    def summary
+      passed = ordered_examples.select(&:passed?).length
+      total = ordered_examples.length
+      percent = (100*passed/total.to_f).round
+      "#{passed} of #{total} examples passed (#{percent}%)"
+    end
+  end
+end

data/lib/rspec-live/terminal.rb

@@ -0,0 +1,121 @@
+require "curses"
+
+module RSpecLive
+  class Terminal
+    def initialize
+      Terminal.reset_curses
+      @root_section = TerminalSection.new
+      Signal.trap("SIGWINCH", proc { Terminal.reset_curses; @root_section.refresh })
+    end
+
+    def self.reset_curses
+      Curses.init_screen
+      Curses.curs_set 0
+      Curses.clear
+      Curses.refresh
+      Curses.start_color
+      Curses.use_default_colors
+      available_colors.each do |name|
+        Curses.init_pair color_constant(name), color_constant(name), -1
+      end
+      @width = `tput cols`.to_i
+      @height = `tput lines`.to_i
+      Curses.resizeterm @height, @width
+    end
+
+    def self.width
+      @width
+    end
+
+    def add_section(*args)
+      @root_section.add_section(*args)
+    end
+
+    def self.color_constant(name)
+      Curses.const_get "COLOR_#{name.to_s.upcase}"
+    end
+
+    def self.available_colors
+      [:blue, :green, :red, :yellow, :white]
+    end
+  end
+
+  class TerminalSection
+    def initialize(parent = nil, options = {})
+      @content = ""
+      @parent = parent
+      options.each_pair { |key, value| instance_variable_set "@#{key}", value }
+      @children = []
+    end
+
+    def add_section(options = {})
+      new_section = TerminalSection.new(self, options)
+      @children << new_section
+      new_section
+    end
+
+    def content=(value)
+      @content = value.to_s
+    end
+
+    def clear
+      @content = ""
+      @children = []
+      refresh
+    end
+
+    def refresh
+      if @parent
+        @parent.refresh
+      else
+        Curses.clear
+        Curses.setpos 0, 0
+        draw
+        Curses.refresh
+      end
+    end
+
+    def draw
+      Curses.addstr "\n" if @display == :block
+      draw_left_margin
+      if @color
+        Curses.attron(color_attribute @color) { draw_content }
+      else
+        draw_content
+      end
+      draw_right_margin
+      @children.each(&:draw)
+    end
+
+    def draw_content
+      text = @content
+      bullet = @bullet ? "#{@bullet} " : ""
+      if @display == :block && @wrap
+        text = bullet + wrap_with_margin(text, Terminal.width-1, bullet.length)
+      end
+      Curses.addstr text
+    end
+
+    def wrap_with_margin(text, width, margin_width)
+      wrap(text, width - margin_width).split("\n").join("\n" + (" " * margin_width))
+    end
+
+    def wrap(text, width)
+      text.scan(/\S.{0,#{width-2}}\S(?=\s|$)|\S+/).join("\n")
+    end
+
+    def draw_left_margin
+      Curses.addstr(("=" * [0, (((Terminal.width - @content.length) / 2) - 1)].max) + " ") if @align == :center
+    end
+
+    def draw_right_margin
+      Curses.addstr(" " + ("=" * [0, (((Terminal.width - @content.length) / 2) - 2)].max)) if @align == :center
+    end
+
+    private
+
+    def color_attribute(name)
+      Curses.color_pair(Terminal.color_constant name) | Curses::A_NORMAL
+    end
+  end
+end

data/lib/rspec-live/version.rb

@@ -0,0 +1,3 @@
+module RSpecLive
+  VERSION = "0.0.1"
+end

data/lib/rspec-live/watcher.rb

@@ -0,0 +1,42 @@
+require "listen"
+
+module RSpecLive
+  class Watcher
+    def initialize(suite, display)
+      @suite = suite
+      @display = display
+    end
+
+    def start
+      process_tests
+      Listen.to(Dir.pwd) { process_tests }.start
+      while perform_key_command; end
+    rescue Interrupt
+    end
+
+    private
+
+    def perform_key_command
+      key = STDIN.getc.chr.downcase
+      @suite.toggle_all if key == "a"
+      @suite.focus_next if key == "n"
+      return false if key == "q"
+      reset if key == "r"
+      @suite.cycle_verbosity if key == "v"
+      true
+    end
+
+    def reset
+      @suite.clear_status
+      process_tests
+    end
+
+    def process_tests
+      @display.status = "analyzing specs"
+      @suite.inventory
+      @display.status = "running specs"
+      @suite.update
+      @display.status = "watching for updates..."
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rspec-live
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Auton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.9
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: 
+email:
+- brianauton@gmail.com
+executables:
+- rspec-live
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec-live/terminal.rb
+- lib/rspec-live/example.rb
+- lib/rspec-live/runner.rb
+- lib/rspec-live/version.rb
+- lib/rspec-live/suite.rb
+- lib/rspec-live/watcher.rb
+- lib/rspec-live/backtrace.rb
+- lib/rspec-live/display.rb
+- lib/formatters/inventory_formatter.rb
+- lib/formatters/update_formatter.rb
+- README.md
+- History.md
+- License.txt
+- bin/rspec-live
+homepage: http://github.com/brianauton/rspec-live
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: Continually updating console output for RSpec 3+
+test_files: []