spectator-emacs 0.1.0

data/.document

@@ -0,0 +1,2 @@
+lib/**/*.rb
+bin/spectator-emacs

data/.gitignore

@@ -0,0 +1,7 @@
+/html/
+/pkg/
+/doc/
+/.yardoc/
+*~
+\#*#
+\.#*

data/.rspec

@@ -0,0 +1 @@
+-f RspecOrgFormatter

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2013-01-25
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+gemspec
+
+group :test do
+  gem 'rspec_org_formatter'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    spectator-emacs (0.1.0)
+      docopt
+      open4
+      rb-inotify (~> 0.8.8)
+      rspec
+      spectator (~> 1.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    docopt (0.5.0)
+    ffi (1.3.1)
+    json (1.7.6)
+    listen (0.7.2)
+    notify (0.4.0)
+    open4 (1.3.0)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    rspec_org_formatter (0.2.2)
+      rspec (>= 2.6.0)
+    rubygems-tasks (0.2.3)
+    spectator (1.2.6)
+      listen
+      notify
+      term-ansicolor
+    term-ansicolor (1.0.7)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rdoc (~> 3.0)
+  redcarpet
+  rspec (~> 2.4)
+  rspec_org_formatter
+  rubygems-tasks (~> 0.2)
+  spectator-emacs!
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alessandro Piras
+
+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,155 @@
+# spectator-emacs
+
+* [Homepage](https://github.com/laynor/spectator-emacs#readme)
+* [Issues](https://github.com/laynor/spectator-emacs/issues)
+* [Documentation](http://rubydoc.info/gems/spectator-emacs/frames)
+* Email [mailto:laynor at gmail.com]
+
+## Description
+
+`spectator-emacs` is a [Spectator][spectator]
+extension that provides discreet notificatoins in the Emacs modeline,
+via the [Enotify][enotify] Emacs notification
+system.
+
+The RSpec output is displayed in an emacs buffer, and using the
+[RSpec Org Formatter][RSpecOrgFormatter],
+they are nicely formatted as an org-mode file. Minimize your switching
+from Emacs to the shell or the browser to just display the test
+results!
+
+If you hate growl-style popups and prefer a simple green/red
+(customizable!) indicator on the modeline, spectator-emacs is for you.
+
+## Features
+
+* Notifications on the emacs modeline
+* Short summary report on mouse-over in the modeline indicator
+* Easily switch to the results buffer with just a click on the
+  modeline indicator
+* Org formatted RSpec results with the aid of RSpec Org Formatter
+* Summary extraction can be customized to work with different RSpec
+  output formats
+* all the features offered by Spectator
+
+## Install
+```
+$ gem install spectator-emacs
+```
+## Examples
+
+To run `spectator-emacs`, just run it!
+```
+$ spectator-emacs
+```
+To customize it, create a .spectator-emacs file in your project root.
+You can customize various aspects of how spectator-emacs works:
+
+* Enotify host (default: localhost)
+* Enotify port (default: 5000)
+* The notification message that will appear on the emacs modeline
+  (default: 'F' for failures, 'P' for pending, 'S' for success)
+* The notification faces used to display the icons in the modeline
+  (default: `enotify-success-face` for success,
+  `enotify-failure-face`for failures, `enotify-warning-face` for
+  success with pending examples)
+* The Enotify slot id to register for notifications
+
+An example `.spectator-emacs' file:
+
+
+```ruby
+require 'spectator/emacs'
+
+@runner = Spectator::ERunner.new(:enotify_port => 5001,
+                                 :notification_messages => {
+                                   :failure => "failure",
+                                   :success => "success",
+                                   :pending => "pending"
+                                 },
+                                 :slot_id => "project foobar"
+                                 :notification_face => {
+                                   :pending => :font_lock_warning_face,
+                                   # see the docs for detail on Symbol#keyword
+                                   :success => :success.keyword,
+                                   :failure => :failure
+                                 }) do |runner|
+  # This code will be executed before entering the main loop.
+
+  def format_summary(examples, failures, pending)
+    summary = "#{examples} examples"
+    summary << ", #{failures} failures"  if failures > 0
+    summary << ", #{pending} pending"  if pending > 0
+    summary << "."
+    summary
+  end
+
+  # The default summary extraction method works with
+  # the standard documentation formatter, or any formatter
+  # that puts the summary on the last line and with the
+  # same format of the documentation formatter.
+  # It uses the helper function
+  # Spectator::Spec#extract_rspec_stats, which can be
+  # useful if the summary is expressed with the same
+  # pattern but on a line other than the last.
+  # For example, the RSpecOrgFormatter puts the summary on
+  # the 6th-last line.
+  #
+  def extract_rspec_org_summary(output)
+    runner.extract_rspec_stats(output, -6)
+  end
+
+  # Suppose rspec is using a custom formatter that
+  # puts the summary in a format in the last lines
+  # with a format like the following:
+  #
+  #   Examples: 123
+  #   Errors: 12
+  #   Pending: 2
+  #
+  def runner.extract_rspec_summary(output)
+    summary_lines = summary[-3..-1]
+    examples = summary[-3].split(':')[1].to_i
+    errors = summary[-2].split(':')[1].to_i
+    pending = summary[-1].split(':')[1].to_i
+    stats = {
+      :examples => examples,
+      :failures => failures,
+      :pending => pending,
+      :summary => format_summary(examples, failures, pending)
+    }
+    stats.merge(:status => rspec_status(stats))
+    stats
+  end
+end
+```
+
+
+
+## Requirements
+
+`spectator-emacs` requires a working Emacs installation. You need to
+install [Enotify][enotify], which can be found in the [MELPA][melpa]
+repository.
+
+You also need to load the `enotify-spectator-emacs` Enotify plugin.
+
+Put this in your .emacs:
+
+```lisp
+(require 'enotify)
+(enotify-minor-mode t)
+(add-to-list 'load-path "path/to/enotify-spectator-emacs")
+(require 'enotify-spectator-emacs)
+```
+
+## Copyright
+
+Copyright (c) 2013 Alessandro Piras
+
+See LICENSE.txt for details.
+
+[enotify]:http://github.com/laynor/enotify
+[spectator]:http://github.com/elia/spectator
+[RSpecOrgFormatter]:http://github.org/laynor/rspec_org_formatter
+[melpa]:http://melpa.milkbox.net/

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'yard'
+$:.unshift 'lib'
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rdoc', '~> 3.0'
+  require 'rdoc/task'
+
+  RDoc::Task.new do |rdoc|
+    rdoc.title = "spectator-emacs"
+  end
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rdoc` to install 'rdoc/task'."
+end
+task :doc => :rdoc
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+desc "Run spectator-emacs"
+task :'spectator-emacs' do
+  load "bin/spectator-emacs"
+end
+
+## YARD stuff
+YARD::Rake::YardocTask.new
+CLOBBER.include('doc', '.yardoc')

data/bin/spectator-emacs

@@ -0,0 +1,40 @@
+#!/usr/env/bin ruby
+
+require 'spectator/emacs'
+require 'docopt'
+CONFIGFILE = '.spectator-emacs'
+THISFILE = File.basename __FILE__
+doc = <<DOCOPT
+Listen to file changes and run RSpec, sending notifications to Emacs via Enotify.
+
+Usage:
+  #{THISFILE} [--config <filename>]
+  #{THISFILE} -h | --help
+  #{THISFILE} --version
+
+Options:
+  -h --help             Show this screen.
+  --config <filename>   Configuration file to read [default: .spectator-emacs]
+  --version             Show version.
+
+DOCOPT
+
+begin
+  require 'pp'
+  args = Docopt::docopt(doc, :version => Spectator::Emacs::VERSION)
+  config_file = args['--config']
+  pp args
+  if File.exists? config_file
+    content = File.read(config_file)
+    eval(content)  if not content.nil?
+  end
+
+  @runner ||= Spectator::ERunner.new
+rescue Docopt::Exit => e
+  puts e.message
+end
+
+
+# Local Variables:
+# mode: ruby
+# End:

data/lib/spectator/emacs/version.rb

@@ -0,0 +1,6 @@
+module Spectator
+  module Emacs
+    # spectator-emacs version
+    VERSION = "0.1.0"
+  end
+end

data/lib/spectator/emacs.rb

@@ -0,0 +1,460 @@
+require 'spectator/emacs/version'
+require 'spectator'
+require 'socket'
+require 'open4'
+
+class Object
+  # Returns a string representing the object as a lisp sexp.
+  def to_lisp
+    to_s
+  end
+end
+
+class Symbol
+  # Returns a string that represents the symbol as a lisp
+  # symbol. Underscores are converted to dashes.
+  #
+  # Example:
+  #
+  # ```
+  # :foo_bar.to_lisp => 'foo-bar'
+  # ```
+  def to_lisp
+    to_s.gsub "_", "-"
+  end
+
+  # Returns a symbol with the same name prefixed by a colon. This is
+  # convenient when converting a symbol with the {#to_lisp} method.
+  #
+  # Example:
+  #
+  # ```
+  # :foo_bar.keyword.to_lisp => ':foo-bar'
+  # ```
+  def keyword
+    if self[0] == ':'
+      self
+    else
+      ":#{to_s}".to_sym
+    end
+  end
+end
+
+class String
+  # Returns a string that represents a lisp string.
+  # This is basically just an alias for {String#inspect}
+  def to_lisp
+    inspect
+  end
+end
+
+class Array
+  # Returns a string that represents the array as a lisp list.
+  #
+  # Example:
+  #
+  # ```
+  # [:foo, 123, "bar"].to_lisp => '(foo 123 "bar")'
+  def to_lisp
+    sexp_array = map { |el| el.to_lisp }
+    "(#{sexp_array.join ' '})"
+  end
+end
+
+class Hash
+  # Creates and returns a new hash tabke with the same keys and values
+  # and tags it to be rendered as an association list by the to_lisp
+  # method.
+  #
+  # For example, ```{:a => :b, :x => 1}``` would be rendered as
+  #
+  # ```
+  #   ((a . b) (x . 1))
+  # ```
+  def as_alist
+    merge(:__render_as => :alist)
+  end
+
+  # Creates and returns a new hash tabke with the same keys and values
+  # but tagged to be rendered as a flat list by the to_lisp method.
+  #
+  # For example, ```{:a => :b, :x => 1}``` would be rendered as
+  #
+  # ```
+  #   (a b x 1)
+  # ```
+  def as_flat_list
+    merge(:__render_as => :flat )
+  end
+
+  # Creates and returns a new hash table with the same keys and values
+  # but tagged to be rendered as a property list by the to_lisp method.
+  # The keys must be symbols, and they will be rendered as keywords.
+  #
+  # For example, ```{:a => :b, :x => 1}``` would be rendered as
+  #
+  # ```
+  #   (:a b :x 1)
+  # ```
+  def as_plist
+    merge(:__render_as => :plist)
+  end
+
+  # Returns a symbol indicating how the hash will be rendered by the
+  # to_lisp method. The possible values are :flat, :alist, :plist.
+  def rendering_type
+    self[:__render_as] or :plist
+  end
+
+  # Renders the hash as a list, depending on how it has been tagged.
+  # If the hash has not been tagged, it will be rendered as a property
+  # list, see as_plist.
+  def to_lisp
+    def pjoin(string_list)
+      "(#{string_list.join ' '})"
+    end
+    h = self.clone
+    h.delete(:__render_as)
+    case rendering_type
+    when :alist
+      pjoin(h.map { |k, v| "(#{k.to_lisp} . #{v.to_lisp})" })
+    when :flat
+      pjoin(h.map { |k, v| "#{k.to_lisp} #{v.to_lisp}" })
+    when :plist
+      pjoin(h.map { |k, v| "#{k.keyword.to_lisp} #{v.to_lisp}" })
+    end
+  end
+end
+
+
+module Spectator
+  # This exception is thrown when an error occurs when trying to
+  # extract the rspec result summary (number of examples ran, number
+  # of failures, number of pending examples) from its output.
+  class SummaryExtractionError < RuntimeError
+  end
+
+  module Specs
+    # Summarizes the rspec results as one of `:failure, :pending, :success`.
+    #
+    # @param [Hash] rspec_stats A Hash table with keys ```:examples, :failures, :pending, :summary, :status```.
+    #    See {#extract_rspec_summary} for details about the meaning of the key/value pairs in this table.
+    def rspec_status(rspec_stats)
+      if rspec_stats[:failures] > 0
+        :failure
+      elsif rspec_stats[:pending] > 0
+        :pending
+      else
+        :success
+      end
+    end
+
+    # Returns a hash that summarizes the rspec results.
+    #
+    # @param [String] output the rspec output
+    # @param [Integer] line_number the line number of the summary in the rspec
+    #   output. It can be negative: -1 indicates the last line, -2
+    #   indicates the second last line and so on.
+    # @return [Hash] a hash table with keys ```:examples, :failures, :pending, :summary, :status```.
+    #
+    #   * **:examples** => number of examples ran
+    #   * **:failures** => number of failed examples
+    #   * **:pending** => number of pending examples ran
+    #   * **:summary** => the summary string from which the above have been extracted
+    #   * **:status**  => one of ```:failure, :pending, :success```
+    def extract_rspec_stats(output, line_number)
+      summary_line = output.split("\n")[line_number]
+      summary_regex = /^(\d*)\sexamples?,\s(\d*)\s(errors?|failures?)[^\d]*((\d*)\spending)?/
+      matchdata = summary_line.match(summary_regex)
+      raise SummaryExtractionError.new  if matchdata.nil?
+      _, examples, failures, _, pending = matchdata.to_a
+      stats = {:examples => examples.to_i, :failures => failures.to_i, :pending => pending.to_i, :summary => summary_line}
+      stats.merge(:status =>  rspec_status(stats))
+    end
+
+    # Returns a hash that summarizes the rspec results.
+    #
+    # Redefine this method if you are using a non standard rspec formatter,
+    # see the {file:README.md} for details.
+    # @param [String] output the rspec output
+    # @return [Hash] a hash table with keys ```:examples, :failures, :pending, :summary, :status```.
+    #
+    #   * **`:examples`**: number of examples ran
+    #   * **`:failures`**: number of failed examples
+    #   * **`:pending`**: number of pending examples ran
+    #   * **`:summary`**: the summary string from which the above have been extracted
+    #   * **`:status`**: one of
+    #
+    #        ```
+    #        :success, :pending, :failure
+    #        ```
+    def extract_rspec_summary(output)
+      begin
+        extract_rspec_stats output, @summary_line_number
+      rescue SummaryExtractionError
+        puts  "--- Error while extracting summary with the default method.".red
+        print "--- Summary line number: ".yellow
+        @summary_line_number = STDIN.gets.to_i
+        extract_rspec_summary output
+      end
+    end
+
+    # Runs a command and returns a hash containing exit status,
+    # standard output and standard error contents.
+    #
+    # @return [Hash] a hash table with keys `:status, :stdout, :stderr`.
+    def run(cmd)
+      puts "=== running: #{cmd} ".ljust(terminal_columns, '=').cyan
+      pid, _, stdout, stderr = Open4::popen4 cmd
+      _, status = Process::waitpid2 pid
+      puts "===".ljust(terminal_columns, '=').cyan
+      {:status => status, :stdout => stdout.read.strip, :stderr => stderr.read.strip}
+    end
+
+    # Sends a notification to emacs via Enotify
+    #
+    # @param [String] rspec_output The rspec command output
+    # @param [Hash] stats A Hash table with keys ```:examples, :failures, :pending, :summary, :status```.
+    #    See {#extract_rspec_summary} for details about the meaning of the key/value pairs in this table.
+    def rspec_send_results(rspec_output, stats)
+      begin
+        print "--- Sending notification to #{@enotify_host}:#{@enotify_port}" \
+        " through #{@enotify_slot_id}... ".cyan
+        enotify_notify rspec_output, stats
+        puts "Success!".green
+      rescue SocketError
+        puts "Failed!".red
+        enotify_connect
+        rspec_send_results rspec_output, stats
+      end
+    end
+
+    # Checks if the commands `bundle exec rspec` and `rspec` actually
+    # run the same program, and sets the `@bundle` instance variable
+    # accordingly.
+    #
+    # This is meant to speed up the execution of `rspec`.
+    def check_if_bundle_needed
+      if `bundle exec #{rspec_command} -v` == `#{rspec_command} -v`
+        @bundle = ""
+      else
+        @bundle = "bundle exec "
+      end
+    end
+
+    # Runs the `rspec` command with the given options, and notifies Emacs of the results.
+    #
+    # @param [String] options The command line arguments to pass to rspec.
+    def rspec(options)
+      unless options.empty?
+        results = run("#{@bundle}#{rspec_command} --failure-exit-code 99 #{options}")
+        status = results[:status].exitstatus
+        if status == 1
+          puts "An error occurred when running the tests".red
+          puts "RSpec output:"
+          puts "STDERR:"
+          puts results[:stderr]
+          puts "-" * 80
+          puts "STDOUT:"
+          puts results[:stdout]
+        else
+          begin
+            stats = extract_rspec_summary results[:stdout]
+            puts(stats[:summary].send(results[:status] == 0 ? :green : :red))
+            # enotify_notify results[:stdout], stats
+            rspec_send_results results[:stdout], stats
+          rescue StandardError => e
+            puts "ERROR extracting summary from rspec output: #{e}".red
+            puts e.backtrace
+            puts "RSpec output:"
+            puts "STDERR:"
+            puts results[:stderr]
+            puts "-" * 80
+            puts "STDOUT:"
+            puts results[:stdout]
+            print "Exit? (y/N)"
+            answer = STDIN.gets
+            abort "Execution aborted by the user"  if answer.strip.downcase == 'y'
+          end
+        end
+      end
+    end
+  end
+
+  # This module contains all the functions used to interact with the Enotify emacs mode-line notification system.
+  module Emacs
+    # Sends a message to the Enotify host.
+    #
+    # @param [Object] object the object to be serialized as a lisp
+    #   object (with the {Object#to_lisp} method) and sent as a message.
+    def enotify_send(object)
+      sexp = object.to_lisp
+      @sock.puts "|#{sexp.length}|#{sexp}"
+    end
+
+    # Registers the slot named `@enotify_slot_id` with Enotify.
+    def enotify_register
+      enotify_send :register => @enotify_slot_id, :handler_fn => :enotify_rspec_result_message_handler
+    end
+
+    # Sends a notification to the enotify host with the RSpec results.
+    #
+    # @param [String] stdout the rspec command output.
+    # @param [Hash] stats the extracted summary of the results. For
+    #   details, see the return value of
+    #   {Spectator::Specs#extract_rspec_summary} for details.
+    def enotify_notify(stdout, stats)
+      #stats = extract_rspec_stats stdout
+      status = stats[:status]
+      message = {
+        :id => @enotify_slot_id,
+        :notification => {
+          :text => @notification_messages[status],
+          :face => @notification_face[status],
+          :help => format_tooltip(stats),
+          :mouse_1 => :enotify_rspec_mouse_1_handler
+        },
+        :data => stdout
+      }
+
+      enotify_send message
+    end
+
+    # Checks whether the string is made by whitespace characters.
+    #
+    # @param [String] string the string to be checked
+    # @return [Boolean] non nil if the string is blank, nil otherwise.
+    def blank_string?(string)
+      string =~ /\A\s*\n?\z/
+    end
+
+    # Interactively retries to connect to the Enotify host, asking a
+    # new *host:port* value.
+    def rescue_sock_error
+      print "--- Enter Enotify host [localhost:5000]: ".yellow
+      host_and_port = STDIN.gets.strip
+      if blank_string?(host_and_port)
+        @enotify_host, @enotify_port = ['localhost', @default_options[:enotify_port]]
+      else
+        @enotify_host, @enotify_port = host_and_port.split(/\s:\s/)
+        @enotify_port = @enotify_port.to_i
+      end
+      enotify_connect
+    end
+
+    # Creates a connection to the Enotify host.
+    def enotify_connect
+      begin
+        print "=== Connecting to emacs... ".cyan
+        @sock = TCPSocket.new(@enotify_host, @enotify_port)
+        enotify_register
+        puts "Success!".green
+      rescue SocketError, Errno::ECONNREFUSED => e
+        puts "Failed!".red
+        rescue_sock_error
+      end
+    end
+
+    # Formats the text that will be used as a tooltip for the modeline
+    # *"icon"*.
+    #
+    # @param [Hash] stats the extracted summary of the results. For
+    #   details, see the return value of
+    #   {Spectator::Specs#extract_rspec_summary} for details.
+    def format_tooltip(stats)
+      t = Time.now
+      "#{t.year}-#{t.month}-#{t.day} -- #{t.hour}:#{t.min}:#{t.sec}\n" +
+        "#{stats[:examples]} examples, #{stats[:failures]} failures" +
+        ((stats[:pending] > 0) ? ", #{stats[:pending]} pending.\n" : ".\n") +
+        "\nmouse-1: switch to rspec output buffer"
+    end
+
+  end
+
+
+  # This is the class that implements the main loop of spectator-emacs.
+  # To run spectator-emacs, just create a new ERunner object.
+  class ERunner < Runner
+    include Specs
+    include Emacs
+    # Creates a new instance of ERunner. This implements the main loop of `spectator-emacs`.
+    # See the {file:README.md} for examples on how to customize the default behavior.
+    # @param [Hash] options possible options are:
+    #
+    #   ##### :enotify_port (Fixnum)
+    #   the port the Enotify host is listening to.
+    #   ##### :enotify_host`({String})
+    #   the host name or IP address where Enotify is running.
+    #   ##### :notification_messages ({Hash})
+    #   a hash with keys `:success, :failure, :pending` containing the
+    #   relative modeline *icons* strings.
+    #   Defaults to `{:success => "S", :failure => "F", :pending => "P"}`.
+    #   ##### :notification_face ({Hash})
+    #   A hash table with keys `:success, :failure, :pending` containing
+    #   the faces to apply to the notification *icon* in the Emacs modeline.
+    #   Values must be {Symbol}s, like for example `:font_lock_constant_face`
+    #   in order to use Emacs' `font-lock-warning-face`.
+    #   Defaults to
+    #
+    #      ```
+    #      {:success => :\':success\', :failure => :\':failure\', :pending => :\':warning\'}
+    #      ```
+    # @yield [ERunner] Gives a reference of the ERunner object just created to the block
+    #   Use this block when you need to customize the behavior of spectator-emacs.
+    #   For example, if you need a custom summary extraction method, you can create
+    #   the runner object as follows in your `.spectator-emacs` script:
+    #
+    #   ```ruby
+    #   @runner = ERunner.new do |runner|
+    #     def runner.extract_rspec_summary(output)
+    #       ## your summary extraction code here
+    #       ## ...
+    #     end
+    #   end
+    #   ```
+    def initialize(options={}, &block)
+      @default_options = {
+        :enotify_port => 5000,
+        :enotify_host => 'localhost',
+        :notification_messages => {:failure => "F", :success => "S", :pending => "P"},
+        :notification_face => {
+          :failure => :failure.keyword,
+          :success => :success.keyword,
+          :pending => :warning.keyword
+        }
+      }
+      options = @default_options.merge options
+      @cli_args = ARGV.to_a
+      puts "======= OPTIONS ======="
+      options.each {|k, v| puts "#{k} => #{v}"}
+      @enotify_host = options[:enotify_host]
+      @enotify_port = options[:enotify_port]
+      @notification_messages = options[:notification_messages]
+      @notification_face = options[:notification_face]
+      @summary_line_number = options[:summary_line] || -1
+      @enotify_slot_id = options[:slot_id] ||
+        ((File.basename Dir.pwd).split('_').map {|s| s.capitalize}).join.gsub('-','/')
+      check_if_bundle_needed
+      enotify_connect
+      yield self  if block_given?
+      # TODO: load .spectator-emacs
+      # contents = File::read('.spectator-emacs')
+      # eval(contents)
+      super()
+    end
+  end
+end
+#####################################
+# require 'spectator/emacs'
+
+# Spectator::ERunner.new(:enotify_port => 5001, :enotify_host => 'localhost') do |runner|
+#   def runner.extract_rspec_stats(results, line)
+#     ## define new spec extraction routine
+#     ## it must return a hash like this one:
+#     ## {:examples => 10,   # number of examples executed
+#     ##  :failures => 4,    # number of failures
+#     ##  :pending => 1,     # number of pending examples
+#     ##  :status => :failure # one of :pending, :succes, :failure
+#     ## }
+#   end
+# end

data/spec/emacs_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'spectator/emacs'
+
+describe Spectator::Emacs do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/lib/spectator/emacs_spec.rb

@@ -0,0 +1,68 @@
+require 'spectator/emacs'
+
+describe 'Spectator' do
+  describe 'EmacsInteraction' do
+    describe "Lisp sexp helpers" do
+      describe "Symbol#keyword" do
+        it "should be present" do
+          :foobar.should respond_to(:keyword)
+        end
+        it "should add a ':' if the symbol name does not begin with ':'" do
+          :foobar.keyword.should == :':foobar'
+        end
+        it "should not add a ':' if the symbol name already begins with ':'" do
+          sym = :':foobar'
+          sym.keyword.should == sym
+        end
+      end
+      describe "Object#to_lisp" do
+        it "should correctly represent a number" do
+          20.times do
+            num = rand(1..1000)
+            num.to_lisp.should == "#{num}"
+          end
+        end
+
+        it "should correctly represent a symbol" do
+          symbol = :foobar
+          symbol.to_lisp.should == "foobar"
+        end
+
+        it "should convert underscores to dashes when converting a symbol" do
+          symbol = :foo_bar
+          symbol.to_lisp.should == "foo-bar"
+        end
+
+        it "should correctly represent a string" do
+          "asdf\nfoobar".to_lisp.should == '"asdf\nfoobar"'
+        end
+
+        it "should correctly represent an array as a list" do
+          [1,2,3,4].to_lisp.should == '(1 2 3 4)'
+          [1,2, [3, 4], 5, 6].to_lisp.should == '(1 2 (3 4) 5 6)'
+          [:a, 1, :b, 2].to_lisp.should == '(a 1 b 2)'
+        end
+
+        describe "Hash#to_lisp" do
+          before(:each) do
+            @hash = {:a => [1,2,3], :b => 1, :c => "asdf"}
+          end
+          it "should correctly represent a hash as a plist" do
+            @hash.as_plist.to_lisp.should == '(:a (1 2 3) :b 1 :c "asdf")'
+          end
+          it "should correctly represent a hash as an alist" do
+            @hash.as_alist.to_lisp.should == '((a . (1 2 3)) (b . 1) (c . "asdf"))'
+          end
+          it "should correctly represent a hash as a flat list" do
+            @hash.as_flat_list.to_lisp.should == '(a (1 2 3) b 1 c "asdf")'
+          end
+        end
+      end
+    end
+  end
+  describe "ERunner" do
+    it "should inherit from Runner" do
+      Spectator::ERunner.superclass.should be(Spectator::Runner)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'spectator/emacs/version'
+
+include Spectator::Emacs

data/spectator-emacs.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/spectator/emacs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "spectator-emacs"
+  gem.version       = Spectator::Emacs::VERSION
+  gem.summary       = %q{A Spectator monkey-patch that displays notifications on the emacs modeline.}
+  gem.description   = <<-DESCRIPTION
+  spectator-emacs is a Spectator extension that provides discreet
+  notificatoins in the Emacs modeline, via the Enotify Emacs
+  notification system.
+
+  == Features ==
+  * Notifications on the emacs modeline
+  * Short summary report on mouse-over in the modeline indicator
+  * Easily switch to the results buffer with just a click on the
+    modeline indicator
+  * Org formatted RSpec results with the aid of RSpec Org Formatter
+  * Summary extraction can be customized to work with different RSpec
+    output formats
+  * all the features offered by Spectator
+  DESCRIPTION
+  gem.license       = "MIT"
+  gem.authors       = ["Alessandro Piras"]
+  gem.email         = "laynor@gmail.com"
+  gem.homepage      = "https://github.com/laynor/spectator-emacs#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rdoc', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
+  gem.add_dependency 'rspec'
+  gem.add_dependency 'spectator', '~> 1.2'
+  gem.add_dependency 'open4'
+  gem.add_dependency 'rb-inotify', '~> 0.8.8'
+  gem.add_dependency 'docopt'
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: spectator-emacs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alessandro Piras
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spectator
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "  spectator-emacs is a Spectator extension that provides discreet\n
+  \ notificatoins in the Emacs modeline, via the Enotify Emacs\n  notification system.\n\n
+  \ == Features ==\n  * Notifications on the emacs modeline\n  * Short summary report
+  on mouse-over in the modeline indicator\n  * Easily switch to the results buffer
+  with just a click on the\n    modeline indicator\n  * Org formatted RSpec results
+  with the aid of RSpec Org Formatter\n  * Summary extraction can be customized to
+  work with different RSpec\n    output formats\n  * all the features offered by Spectator\n"
+email: laynor@gmail.com
+executables:
+- spectator-emacs
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/spectator-emacs
+- lib/spectator/emacs.rb
+- lib/spectator/emacs/version.rb
+- spec/emacs_spec.rb
+- spec/lib/spectator/emacs_spec.rb
+- spec/spec_helper.rb
+- spectator-emacs.gemspec
+homepage: https://github.com/laynor/spectator-emacs#readme
+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'
+      segments:
+      - 0
+      hash: -2575753694497142155
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2575753694497142155
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Spectator monkey-patch that displays notifications on the emacs modeline.
+test_files:
+- spec/emacs_spec.rb
+- spec/lib/spectator/emacs_spec.rb
+- spec/spec_helper.rb