rspec-rails-watchr-emacs 0.9.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# See gem's dependencies in: rspec-rails-watchr.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Elia Schito
+
+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,122 @@
+# ESpectator (a fork of [Spectator][spectator] that integrates with emacs)
+
+ESpectator provides discreet notifications in the emacs modeline, via
+the [Enotify][enotify] emacs notification system.
+
+Test results are displayed in an emacs buffer, so no more switching
+between emacs and the window were the test results are displayed are
+necessary :-)
+
+If you hate growl-style popups and prefer a simple indicator on the
+modeline, ESpectator is for you. It's best used together with
+[RSpec Org Formatter][RSpecOrgFormatter], which provides org formatted
+test results that do look nice on emacs.
+
+## Usage
+
+### Emacs side
+
+You need to install [Enotify][enotify] first. Please refer to its
+README for this step.
+
+Copy the emacs/enotify-espectator.el file in a directory in your
+load-path and add this line after the enotify configuration in your
+.emacs:
+
+```lisp
+	(require 'enotify-espectator)
+```
+
+Note that enotify uses the TCP port 5000 to listen to notification
+messages. If you specified a different port, refer to the ``Advanced''
+section of this document to see how to specify various ESpectator
+options
+
+### Watchr
+
+In your specs.watchr file just add:
+
+```ruby
+	require 'rspec-rails-watchr-emacs'
+	@specs_watchr ||= Rspec::Rails::Watchr.new(self)
+```
+
+Then launch `watchr` as usual (probably `bundle exec watchr`).  If you
+are using RspecOrgFormatter, see the *Advanced* section of this
+document.
+
+### Instructions
+
+The normal behavior is similar to `autotest --fast-start
+--no-full-after-failed` but gives the user a bit more control over
+execution. By hitting CTRL+C (or CMD+. on OSX) you get the following
+prompt:
+
+    ^C (Interrupted with CTRL+C)
+    --- What to do now? (q=quit, a=all-specs, r=reload): 
+
+### Advanced
+
+ESpectator supports the following options (here reported with their
+default values):
+```ruby
+	{ :enotify_port => 5000, # TCP port for the enotify connection
+      :enotify_host => 'localhost', # host name for the enotify connection
+      :notification_message => { # Text displayed on the modeline when
+	    :failure => "F",         # there is at least 1 failing spec
+		:success => "S",         # there are no failing or pending spec
+		:pending => "P"          # there are no failing spec and at least 1 pending
+	  },
+      :notification_face => { # Face used to display the text in the modeline
+        :failure => keyword(:failure),
+        :success => keyword(:success),
+        :pending => keyword(:warning)},
+	  #
+      # custom_extract_summary_proc: takes the result text as argument
+      # and returns an hash of the form
+      # {:errors => #errors
+      #  :pending => #pending
+      #  :examples => #examples
+      #  :status => (:success|:failure|:pending) }
+      :custom_extract_summary_proc => nil, 
+	  #
+	  # index of the Rspec summary line.
+	  # It should look like this:
+	  # 25 examples, 2 failures, 1 pending
+      :error_count_line => -1,
+	  #
+	  # A proc that takes two arguments |path, specs|
+	  # where path is the file that has been modified
+	  # and specs is a vector containing all the spec
+	  # files.
+	  # It should return a vector containing the matching
+	  # specs for `path'.
+      :custom_matcher => nil
+	}
+```
+An example of a custom matcher:
+
+```ruby
+    @specs_watchr ||= Rspec::Rails::Watchr.new(self,
+	   :custom_matcher => lambda { |path, specs|
+			   case path
+			   when %r{lib/calibration_with_coefficients}
+				 specs.grep(%r{models/(logarithmic|polynomial)_calibration})
+			   when %r{app/models/telemetry_parameter}
+				 specs.grep(%r{models/telemetry_parameter})
+			   end
+			   })
+```
+
+To use it with the [RSpec Org Formatter][RSpecOrgFormatter], the 
+:error_count_line option should be set to -6:
+```ruby
+	@specs_watchr ||= Rspec::Rails::Watchr.new(self, :error_count_line => -6)
+```
+
+
+Copyright (c) 2012 Alessandro Piras, 2011 Elia Schito, released under the MIT license
+
+[enotify]:https://github.com/laynor/enotify
+[RSpecOrgFormatter]:https://github.com/laynor/rspec_org_formatter
+[spectator]:https://github.com/elia/spectator

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/emacs/enotify-espectator.el

@@ -0,0 +1,29 @@
+;;;; Espectator plugin for enotify
+(require 'enotify)
+
+(defun enotify-rspec-result-buffer-name (id)
+  (format "*RSpec Results: %s*" id))
+
+(defun enotify-rspec-result-message-handler (id data)
+  (let ((buf (get-buffer-create (enotify-rspec-result-buffer-name id))))
+    (save-current-buffer
+      (set-buffer buf)
+      (erase-buffer)
+      (insert data)
+      (flet ((message (&rest args) (apply 'format args)))
+	(org-mode)))))
+      
+
+
+(defvar enotify-rspec-result-message-handler 'enotify-rspec-result-message-handler)
+
+(defun enotify-rspec-mouse-1-handler (event)
+  (interactive "e")
+  (switch-to-buffer-other-window
+   (enotify-rspec-result-buffer-name
+    (enotify-event->slot-id event))))
+
+(defvar enotify-rspec-mouse-1-handler 'enotify-rspec-mouse-1-handler)
+
+(provide 'enotify-espectator)
+

data/lib/rspec-rails-watchr-emacs.rb

@@ -0,0 +1,364 @@
+# coding: utf-8)
+
+require 'rspec-rails-watchr-emacs/version'
+require 'term/ansicolor'
+
+class SpecWatchr
+  String.send :include, Term::ANSIColor
+
+  
+  module CommandLine
+    def terminal_columns
+      cols = `stty -a`.scan(/ (\d+) columns/).flatten.first
+      $?.success? ? cols.to_i : nil
+    end
+
+    def run cmd
+      puts "=== running: #{cmd} ".ljust(terminal_columns, '=').cyan
+      results = `#{cmd}`
+      success = $?.success?
+      unless @custom_extract_summary_proc
+        puts "    " + results.split("\n")[@error_count_line].strip.send(success ? :green : :red)
+      end
+      puts "===".ljust(terminal_columns, '=').cyan
+      # {:success => success, :results => message}
+      results
+    end
+
+    def clear!
+      system 'clear'
+    end
+  end
+
+  module EmacsConnection
+    def alist (hash)
+      hash.merge(:magic_convert_to => :alist)
+    end
+    def flatten (hash)
+      hash.merge(:magic_convert_to => :flat)
+    end
+    def keyword (symbol)
+      :"#{symbol.inspect}"
+    end
+    def elispify_symbol(symbol)
+      symbol.to_s.gsub(/_/,'-') 
+    end
+    def hash_to_esexp (hash)
+      h = hash.clone
+      h.delete(:magic_convert_to)
+      case hash[:magic_convert_to]
+      when :alist
+        res = h.map { |k, v| "(#{object_to_esexp k} . #{object_to_esexp v})" }
+        "(#{res.join(' ')})"
+      when :flat
+        res = h.map { |k, v| "#{object_to_esexp k} #{object_to_esexp v}" }
+        "(#{res.join(' ')})"
+      else
+        if hash.keys.reduce(true) { |base, el| base && Symbol === el }
+          res = h.map { |k, v| "#{object_to_esexp keyword(k)} #{object_to_esexp v}" }
+          "(#{res.join(' ')})"
+        else
+          h[:magic_convert_to] = :alist
+          hash_to_esexp h
+        end
+      end
+    end
+    def object_to_esexp (object)
+      case object
+      when String
+        object.inspect
+      when Array
+        res = object.map { |el| object_to_esexp(el) }
+        "(#{res.join(' ')})"
+      when Symbol
+        elispify_symbol(object)
+      when Hash
+        hash_to_esexp object
+      else
+        object.to_s
+      end
+    end
+    def esend (object)
+      msg = object_to_esexp object
+      @sock.puts("|#{msg.length}|#{msg}")
+      # @sock.print("|#{msg.length}|")
+      # sleep 2
+      # @sock.puts msg
+    end
+
+    def rspec_status(err_cnt)
+      if err_cnt[:errors] > 0
+        :failure
+      elsif err_cnt[:pending] > 0
+        :pending
+      else
+        :success
+      end
+    end
+
+    def extract_rspec_counts(results, line)
+      err_line = results.split("\n")[line]
+      err_regex = /^(\d*)\sexamples?,\s(\d*)\s(errors?|failures?)[^\d]*((\d*)\spending)?/
+      _, examples, errors, _, pending = (err_line.match err_regex).to_a
+      summ = { :examples => examples.to_i, :errors => errors.to_i, :pending => pending.to_i }
+      summ.merge(:status => rspec_status(summ))
+    end
+
+    def extract_rspec_summary(results)
+      case @custom_extract_summary_proc
+      when Proc
+        @custom_extract_summary_proc.call(results)
+      else
+        begin
+          extract_rspec_counts(results, @error_count_line)
+        rescue
+          puts "--- Error while matching error counts.".red
+          print "--- Summary line number: ".yellow
+          @error_count_line = STDIN.gets.to_i
+          extract_rspec_summary results
+        end
+      end
+    end
+
+    def format_help(summary)
+      h = "#{summary[:errors]} errors\n"
+      h << ("#{summary[:pending]} pending\n" if summary[:pending]>0).to_s
+      h << "\nmouse-1: switch to result buffer"
+    end
+
+    
+    def eregister
+      esend :register => @enotify_slot_id, :handler_fn => :enotify_rspec_result_message_handler
+    end
+
+      
+    
+    def esend_results(results)
+      summ = extract_rspec_summary(results)
+      status = summ[:status]
+      message = { :id => @enotify_slot_id,
+        :notification => {
+          :text => @notification_message[status],
+          :face => @notification_face[status],
+          :help => format_help(summ),
+          :mouse_1 => :enotify_rspec_mouse_1_handler},
+        :data => results,
+      }
+      esend message
+    end
+  end 
+        
+
+  module Specs
+
+    def rspec_command
+      @rspec_command ||= File.exist?('./.rspec') ? 'rspec' : 'spec'
+    end
+
+    def rspec_send_results(results)
+      begin
+        print "--- Sending notification to #{@enotify_host}:#{@enotify_port}" \
+        " through #{@enotify_slot_id}... ".cyan
+        esend_results results 
+        puts "Success!".green
+      rescue
+        puts "Failed!".red
+        init_network
+        rspec_send_results results 
+      end
+    end
+
+    def check_if_bundle_needed
+      if `bundle exec #{rspec_command} -v` == `#{rspec_command} -v` 
+        @bundle = ""
+      else
+        @bundle = "bundle exec "
+      end
+    end
+
+    def rspec options
+      unless options.empty?
+        results = run("#{@bundle}#{rspec_command} #{options}")
+        # notify( success ? '♥♥ SUCCESS :) ♥♥' : '♠♠ FAILED >:( ♠♠' )
+        rspec_send_results(results)
+      end
+    end
+
+    def rspec_all
+      rspec 'spec'
+    end
+
+    def rspec_files *files
+      rspec files.join(' ')
+    end
+
+    def specs_for(path)
+      print "--- Searching specs for #{path.inspect}...".yellow
+      specs = match_specs path, Dir['spec/**/*_spec.rb']
+      puts specs.empty? ? ' nothing found.'.red : " #{specs.size} matched.".green
+      specs
+    end
+
+    def default_rails_matcher path, specs
+      specs.grep(/\b#{path}((_spec)?\.rb)?$/)
+    end
+
+    def match_specs path, specs
+      matched_specs = @custom_matcher.call(path, specs) if @custom_matcher
+      matched_specs = default_rails_matcher(path, specs) if matched_specs.nil?
+    end
+  end
+
+  module Control
+    def exit_watchr
+      @exiting = true
+      puts '--- Exiting...'.white
+      exit
+    end
+
+    def abort_watchr!
+      puts '--- Forcing abort...'.white
+      abort("\n")
+    end
+
+    def reload!
+      # puts ARGV.join(' ')
+      exec('bundle exec watchr')
+    end
+
+    def reload_file_list
+      require 'shellwords'
+      system "touch #{__FILE__.shellescape}"
+      # puts '--- Watch\'d file list reloaded.'.green
+    end
+
+    def trap_int!
+      # Ctrl-C
+
+      @interrupted ||= false
+
+      Signal.trap('INT') { 
+        puts  ' (Interrupted with CTRL+C)'.red
+        if @interrupted
+          @exiting ? abort_watchr : exit_watchr
+        else
+          @interrupted = true
+          # reload_file_list
+          print '--- What to do now? (q=quit, a=all-specs, r=reload): '.yellow
+          case STDIN.gets.chomp.strip.downcase
+          when 'q'; @interrupted = false; exit_watchr
+          when 'a'; @interrupted = false; rspec_all
+          when 'r'; @interrupted = false; reload!
+          else
+            @interrupted = false
+            puts '--- Bad input, ignored.'.yellow
+          end
+          puts '--- Waiting for changes...'.cyan
+        end
+      }
+    end
+  end
+
+
+
+  include CommandLine
+  include Specs
+  include Control
+  include EmacsConnection
+
+  def blank_string?(string)
+    string =~ /\A\s*\n?\z/
+  end
+
+  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
+    init_network
+  end
+    
+  def init_network
+    begin
+      print "=== Connecting to emacs... ".cyan
+      @sock = TCPSocket.new(@enotify_host, @enotify_port)
+      eregister
+      puts "Success!".green
+    rescue
+      puts "Failed!".red
+      rescue_sock_error
+    end
+  end
+
+  def initialize watchr, options = {}
+    @default_options = {
+      :enotify_port => 5000,
+      :enotify_host => 'localhost',
+      :notification_message => {:failure => "F", :success => "S", :pending => "P"},
+      :notification_face => {
+        :failure => keyword(:failure),
+        :success => keyword(:success),
+        :pending => keyword(:warning)},
+      # custom_extract_summary_proc: takes the result text as argument
+      # and returns an hash of the form
+      # {:errors => #errors
+      #  :pending => #pending
+      #  :examples => #examples
+      #  :status => (:success|:failure|:pending) }
+      :custom_extract_summary_proc => nil, 
+      :error_count_line => -1,
+
+      # custom_matcher : takes two arguments: the path of the modified
+      # file (CHECK) and an array of spec files. Returns an array of
+      # matching spec files for the path given.
+      :custom_matcher => nil     }
+
+    options = @default_options.merge(options)
+    puts "========OPTIONS=========="
+    puts options
+    puts "========================="
+    @enotify_host = options[:enotify_host]
+    @enotify_port = options[:enotify_port]
+    @notification_message = options[:notification_message]
+    @notification_face = options[:notification_face]
+    @custom_extract_summary_proc = options[:custom_extract_summary_proc]
+    @error_count_line = options[:error_count_line]
+          
+    @custom_matcher = options[:custom_matcher]
+    
+    yield if block_given?
+    @enotify_slot_id = ((File.basename Dir.pwd).split('_').map { |s| s.capitalize }).join
+    check_if_bundle_needed
+    init_network
+    @watchr = watchr
+
+
+    
+    
+    
+
+    watchr.watch('^spec/(.*)_spec\.rb$')                     {|m| rspec_files specs_for(m[1])}
+    watchr.watch('^(?:app|lib|script)/(.*)(?:\.rb|\.\w+|)$') {|m| rspec_files specs_for(m[1].gsub(/\.rb$/,''))}
+
+    trap_int!
+
+    puts '--- Waiting for changes...'.cyan
+  end
+end
+
+
+class Object
+  module Rspec
+    module Rails
+      module Watchr
+        def self.new *args, &block
+          SpecWatchr.new *args, &block
+        end
+      end
+    end
+  end
+end

data/lib/rspec-rails-watchr-emacs/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Rails
+    module Watchr
+      VERSION = '0.9.0'
+    end
+  end
+end

data/rspec-rails-watchr-emacs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rspec-rails-watchr-emacs/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'rspec-rails-watchr-emacs'
+  s.version     = Rspec::Rails::Watchr::VERSION
+  s.authors     = %w[Alessandro Piras]
+  s.email       = %w[laynor@gmail.com]
+  s.homepage    = 'https://github.com/laynor/spectator'
+  s.summary     = %q{Watches specs for a Rails (2 or 3) project - notifications via Emacs enotify}
+  s.description = %q{Watches specs for a Rails (2 or 3) project - notifications via Emacs enotify. Fork of rspec-rails-watchr (spectator)}
+  s.license     = 'MIT'
+
+  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 = %w[lib]
+  
+  s.add_dependency 'watchr'
+  s.add_dependency 'term-ansicolor'
+  s.add_dependency 'notify'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rails-watchr-emacs
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Alessandro
+- Piras
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: &76086330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76086330
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: &76083960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76083960
+- !ruby/object:Gem::Dependency
+  name: notify
+  requirement: &76083660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *76083660
+description: Watches specs for a Rails (2 or 3) project - notifications via Emacs
+  enotify. Fork of rspec-rails-watchr (spectator)
+email:
+- laynor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- emacs/enotify-espectator.el
+- lib/rspec-rails-watchr-emacs.rb
+- lib/rspec-rails-watchr-emacs/version.rb
+- rspec-rails-watchr-emacs.gemspec
+homepage: https://github.com/laynor/spectator
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Watches specs for a Rails (2 or 3) project - notifications via Emacs enotify
+test_files: []