guillaumegentil-rspactor 0.2.8 → 0.3.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mislav Marohnić
+
+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

@@ -1,16 +1,57 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
+task :default => :spec
 
-Echoe.new('rspactor', '0.2.8') do |p|
-  p.description    = "RSpactor is a little command line tool to automatically run your changed specs (much like autotest)."
-  p.url            = "http://github.com/guillaumegentil/rspactor/"
-  p.author         = "Andreas Wolff"
-  p.email          = "treas@dynamicdudes.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
-  p.executable_pattern = "bin/rspactor"
-  p.runtime_dependencies = ["optiflag"]
-  p.development_dependencies = []
+desc "starts RSpactor"
+task :spec do
+  system "ruby -Ilib bin/rspactor"
 end
 
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each
+desc "generates .gemspec file"
+task :gemspec => "version:read" do
+  spec = Gem::Specification.new do |gem|
+    gem.name = "rspactor"
+    gem.summary = "RSpactor is a command line tool to automatically run your changed specs (much like autotest)."
+    gem.email = "mislav.marohnic@gmail.com"
+    gem.homepage = "http://github.com/mislav/rspactor"
+    gem.authors = ["Mislav Marohnić", "Andreas Wolff", "Pelle Braendgaard", "Thibaud Guillaume-Gentil"]
+    gem.has_rdoc = false
+    
+    gem.version = GEM_VERSION
+    gem.files = FileList['Rakefile', '{bin,lib,images,spec}/**/*', 'README*', 'LICENSE*']
+    gem.executables = Dir['bin/*'].map { |f| File.basename(f) }
+  end
+  
+  spec_string = spec.to_ruby
+  
+  begin
+    Thread.new { eval("$SAFE = 3\n#{spec_string}", binding) }.join 
+  rescue
+    abort "unsafe gemspec: #{$!}"
+  else
+    File.open("#{spec.name}.gemspec", 'w') { |file| file.write spec_string }
+  end
+end
+
+task :bump => ["version:bump", :gemspec]
+
+namespace :version do
+  task :read do
+    unless defined? GEM_VERSION
+      GEM_VERSION = File.read("VERSION")
+    end
+  end
+  
+  task :bump => :read do
+    if ENV['VERSION']
+      GEM_VERSION.replace ENV['VERSION']
+    else
+      GEM_VERSION.sub!(/\d+$/) { |num| num.to_i + 1 }
+    end
+    
+    File.open("VERSION", 'w') { |v| v.write GEM_VERSION }
+  end
+end
+
+task :release => :bump do
+  system %(git commit VERSION *.gemspec -m "release v#{GEM_VERSION}")
+  system %(git tag -am "release v#{GEM_VERSION}" v#{GEM_VERSION})
+end

data/bin/rspactor

@@ -1,21 +1,7 @@
 #!/usr/bin/env ruby
+require 'rspactor/runner'
 
-require 'optiflag'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'interactor')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'listener')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'inspector')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'runner')
-
-module RSpactor extend OptiFlagSet
-  optional_switch_flag "drb" do
-    description "use spec_server"
-  end
-  optional_switch_flag "clear" do
-    description "clear shell before each spec execution"
-  end
-
-  and_process!
-end
-
-
-Runner.load(:drb => ARGV.flags.drb?, :clear => ARGV.flags.clear?)
+RSpactor::Runner.start({
+  :coral => ARGV.delete('--coral'),
+  :run_in => ARGV.last
+})

data/bin/rspactor-system

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+require 'rspactor'
+Growl = RSpactor::Growl
+
+root = ENV['HOME']
+$mappings = []
+$libs = []
+
+def map(regex, &block)
+  $mappings << [regex, block]
+end
+
+def libs
+  $libs
+end
+
+def title
+  $title
+end
+
+listener = RSpactor::Listener.new do |changed_files|
+  changed_files.reject! do |file|
+    file.index(root + "/Library/") == 0
+  end
+  
+  if changed_files.size == 1
+    changed_file = changed_files.first
+    dir = changed_file
+    hook = nil
+    
+    until hook or (dir = File.dirname(dir)) == root
+      candidate = dir + "/.rspactor"
+      hook = candidate if File.exists?(candidate)
+    end 
+    
+    if hook
+      targets = []
+      $title = "Test results"
+      $mappings.clear
+      $libs.replace ['lib']
+      load hook
+      
+      unless $mappings.empty?
+        relative_path = changed_file.sub(dir + '/', '')
+        
+        for regex, block in $mappings
+          if match = relative_path.match(regex)
+            targets.concat Array(block.call(relative_path, match))
+            break
+          end
+        end
+        
+        existing_targets = targets.select { |file| File.exist?(File.join(dir, file)) }
+      else
+        inspector = RSpactor::Inspector.new(dir)
+        existing_targets = inspector.determine_spec_files(changed_file).map do |file|
+          file.sub(dir + '/', '')
+        end
+      end
+
+      if not existing_targets.empty?
+        case existing_targets.first
+        when %r{^test/}
+          $libs << 'test'
+        when %r{^spec/}
+          $libs << 'spec'
+        end
+        
+        Dir.chdir(dir) do
+          unless 'spec' == $libs.last
+            command = "ruby -I#{$libs.join(':')} -e 'ARGV.each{|f| load f}' "
+          else
+            command = "RUBYOPT='-I#{$libs.join(':')}' spec --color "
+          end
+          command << existing_targets.join(' ')
+          # puts command
+          puts changed_file
+          system command
+        end
+
+        if $?.success?
+          Growl::notify $title, "You rock!", Growl::image_path('success')
+        else
+          Growl::notify $title, "YOU LOSE", Growl::image_path('failed')
+        end
+      elsif $mappings.empty?
+        $stderr.puts "-- don't know how to run #{changed_file}"
+      end
+    end
+  end
+end
+
+listener.run(root)

data/lib/rspactor/growl.rb

@@ -0,0 +1,14 @@
+module RSpactor
+  module Growl
+    extend self
+    
+    def notify(title, msg, img, pri = 0)
+      system("growlnotify -w -n rspactor --image #{img} -p #{pri} -m #{msg.inspect} #{title} &") 
+    end
+    
+    # failed | pending | success
+    def image_path(icon)
+      File.expand_path File.dirname(__FILE__) + "/../../images/#{icon}.png"
+    end
+  end
+end

data/lib/rspactor/inspector.rb

@@ -0,0 +1,89 @@
+module RSpactor
+  # Maps the changed filenames to list of specs to run in the next go.
+  # Assumes Rails-like directory structure
+  class Inspector
+    EXTENSIONS = %w(rb erb builder haml rhtml rxml yml conf opts)
+    
+    def initialize(dir)
+      @root = dir
+    end
+    
+    def determine_spec_files(file)
+      candidates = translate(file)
+      candidates.reject { |candidate| candidate.index('.') }.each do |dir|
+        candidates.reject! { |candidate| candidate.index("#{dir}/") == 0 }
+      end
+      spec_files = candidates.select { |candidate| File.exists? candidate }
+      
+      if spec_files.empty?
+        $stderr.puts "doesn't exist: #{candidates.inspect}"
+      end
+      spec_files
+    end
+    
+    # mappings for Rails are inspired by autotest mappings in rspec-rails
+    def translate(file)
+      file = file.sub(%r:^#{Regexp.escape(@root)}/:, '')
+      candidates = []
+      
+      if spec_file?(file)
+        candidates << file
+      else
+        spec_file = append_spec_file_extension(file)
+        
+        case file
+        when %r:^app/:
+          if file =~ %r:^app/controllers/application(_controller)?.rb$:
+            candidates << 'controllers'
+          elsif file == 'app/helpers/application_helper.rb'
+            candidates << 'helpers' << 'views'
+          else
+            candidates << spec_file.sub('app/', '')
+            
+            if file =~ %r:^app/(views/.+\.[a-z]+)\.[a-z]+$:
+              candidates << append_spec_file_extension($1)
+            elsif file =~ %r:app/helpers/(\w+)_helper.rb:
+              candidates << "views/#{$1}"
+            elsif file =~ /_observer.rb$/
+              candidates << candidates.last.sub('_observer', '')
+            end
+          end
+        when %r:^lib/:
+          candidates << spec_file
+          # lib/foo/bar_spec.rb -> lib/bar_spec.rb
+          candidates << candidates.last.sub($&, '')
+          # lib/bar_spec.rb -> bar_spec.rb
+          candidates << candidates.last.sub(%r:\w+/:, '') if candidates.last.index('/')
+        when 'config/routes.rb'
+          candidates << 'controllers' << 'helpers' << 'views'
+        when 'config/database.yml', 'db/schema.rb'
+          candidates << 'models'
+        when %r:^(spec/(spec_helper|shared/.*)|config/(boot|environment(s/test)?))\.rb$:, 'spec/spec.opts'
+          candidates << 'spec'
+        else
+          candidates << spec_file
+        end
+      end
+      
+      candidates.map do |candidate|
+        if candidate.index('spec') == 0
+          File.join(@root, candidate)
+        else
+          File.join(@root, 'spec', candidate)
+        end
+      end
+    end
+    
+    def append_spec_file_extension(file)
+      if File.extname(file) == ".rb"
+        file.sub(/.rb$/, "_spec.rb")
+      else
+        file + "_spec.rb"
+      end
+    end
+    
+    def spec_file?(file)
+      file =~ /^spec\/.+_spec.rb$/
+    end
+  end
+end

data/lib/rspactor/interactor.rb

@@ -0,0 +1,64 @@
+require 'timeout'
+
+module RSpactor
+  class Interactor
+    def initialize(dir)
+      @root = dir
+      ticker
+    end
+    
+    def wait_for_enter_key(msg, seconds_to_wait)
+      begin
+        Timeout::timeout(seconds_to_wait) do
+          ticker(:start => true, :msg => msg)
+          $stdin.gets
+          return true
+        end
+      rescue Timeout::Error
+        false
+      ensure
+        ticker(:stop => true)
+      end
+    end
+    
+    def start_termination_handler
+      @main_thread = Thread.current
+      Thread.new do
+        loop do
+          sleep 0.5
+          if $stdin.gets
+            if wait_for_enter_key("** Running all specs.. Hit <enter> again to exit RSpactor", 3)
+              @main_thread.exit
+              exit
+            end
+            Runner.new(@root).run_all_specs
+          end
+        end
+      end
+    end
+    
+    private
+    
+    def ticker(opts = {})
+      if opts[:stop]
+        $stdout.puts "\n"
+        @pointer_running = false
+      elsif opts[:start]
+        @pointer_running = true
+        write(opts[:msg]) if opts[:msg]
+      else
+        Thread.new do
+          loop do
+            write('.') if @pointer_running == true
+            sleep 1.0
+          end
+        end
+      end
+    end
+
+    def write(msg)
+      $stdout.print(msg)
+      $stdout.flush
+    end
+  end
+end

data/lib/rspactor/listener.rb

@@ -0,0 +1,88 @@
+require 'osx/foundation'
+OSX.require_framework '/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework'
+
+module RSpactor
+  # based on http://rails.aizatto.com/2007/11/28/taming-the-autotest-beast-with-fsevents/
+  class Listener
+    attr_reader :last_check, :callback, :valid_extensions
+
+    def initialize(valid_extensions = nil)
+      @valid_extensions = valid_extensions
+      timestamp_checked
+
+      @callback = lambda do |stream, ctx, num_events, paths, marks, event_ids|
+        changed_files = extract_changed_files_from_paths(split_paths(paths, num_events))
+        timestamp_checked
+        yield changed_files unless changed_files.empty?
+      end
+    end
+
+    def run(directories)
+      dirs = Array(directories)
+      stream = OSX::FSEventStreamCreate(OSX::KCFAllocatorDefault, callback, nil, dirs, OSX::KFSEventStreamEventIdSinceNow, 0.5, 0)
+      unless stream
+        $stderr.puts "Failed to create stream"
+        exit(1)
+      end
+
+      OSX::FSEventStreamScheduleWithRunLoop(stream, OSX::CFRunLoopGetCurrent(), OSX::KCFRunLoopDefaultMode)
+      unless OSX::FSEventStreamStart(stream)
+        $stderr.puts "Failed to start stream"
+        exit(1)
+      end
+
+      begin
+        OSX::CFRunLoopRun()
+      rescue Interrupt
+        OSX::FSEventStreamStop(stream)
+        OSX::FSEventStreamInvalidate(stream)
+        OSX::FSEventStreamRelease(stream)
+      end
+    end
+
+    def timestamp_checked
+      @last_check = Time.now
+    end
+
+    def split_paths(paths, num_events)
+      paths.regard_as('*')
+      rpaths = []
+      num_events.times { |i| rpaths << paths[i] }
+      rpaths
+    end
+
+    def extract_changed_files_from_paths(paths)
+      changed_files = []
+      paths.each do |path|
+        next if ignore_path?(path)
+        Dir.glob(path + "*").each do |file|
+          next if ignore_file?(file)
+          changed_files << file if file_changed?(file)
+        end
+      end
+      changed_files
+    end
+
+    def file_changed?(file)
+      File.stat(file).mtime > last_check
+    rescue Errno::ENOENT
+      false
+    end
+
+    def ignore_path?(path)
+      path =~ /(?:^|\/)\.(git|svn)/
+    end
+
+    def ignore_file?(file)
+      File.basename(file).index('.') == 0 or not valid_extension?(file)
+    end
+
+    def file_extension(file)
+      file =~ /\.(\w+)$/ and $1
+    end
+
+    def valid_extension?(file)
+      valid_extensions.nil? or valid_extensions.include?(file_extension(file))
+    end
+  end
+end

data/lib/rspactor/runner.rb

@@ -0,0 +1,141 @@
+require 'rspactor'
+
+module RSpactor
+  class Runner
+    def self.start(options = {})
+      run_in = options.delete(:run_in) || Dir.pwd
+      new(run_in, options).start
+    end
+    
+    attr_reader :dir, :options, :inspector, :interactor
+    
+    def initialize(dir, options = {})
+      @dir = dir
+      @options = options
+      read_git_head
+    end
+    
+    def start
+      load_dotfile
+      puts "** RSpactor is now watching at '#{dir}'"
+      start_interactor
+      start_listener
+    end
+    
+    def start_interactor
+      @interactor = Interactor.new(dir)
+      aborted = @interactor.wait_for_enter_key("** Hit <enter> to skip initial spec run", 3)
+      @interactor.start_termination_handler
+      run_all_specs unless aborted
+    end
+    
+    def start_listener
+      @inspector = Inspector.new(dir)
+      
+      Listener.new(Inspector::EXTENSIONS) do |files|
+        spec_changed_files(files) unless git_head_changed?
+      end.run(dir)
+    end
+    
+    def load_dotfile
+      dotfile = File.join(ENV['HOME'], '.rspactor')
+      if File.exists?(dotfile)
+        begin
+          Kernel.load dotfile
+        rescue => e
+          $stderr.puts "Error while loading #{dotfile}: #{e}"
+        end
+      end
+    end
+    
+    def run_all_specs
+      run_spec_command(File.join(dir, 'spec'))
+    end
+    
+    def run_spec_command(paths)
+      paths = Array(paths)
+      if paths.empty?
+        @last_run_failed = nil
+      else
+        cmd = [ruby_opts, spec_runner, paths, spec_opts].flatten.join(' ')
+        @last_run_failed = run_command(cmd)
+      end
+    end
+    
+    def last_run_failed?
+      @last_run_failed == false
+    end
+    
+    protected
+    
+    def run_command(cmd)
+      $stderr.puts "#{cmd}"
+      system(cmd)
+      $?.success?
+    end
+    
+    def spec_changed_files(files)
+      files_to_spec = files.inject([]) do |all, file|
+        all.concat inspector.determine_spec_files(file)
+      end
+      unless files_to_spec.empty?
+        puts files_to_spec.join("\n")
+        
+        previous_run_failed = last_run_failed?
+        run_spec_command(files_to_spec)
+        
+        if options[:retry_failed] and previous_run_failed and not last_run_failed?
+          run_all_specs
+        end
+      end
+    end
+    
+    private
+    
+    def spec_opts
+      if File.exist?('spec/spec.opts')
+        opts = File.read('spec/spec.opts').gsub("\n", ' ')
+      else
+        opts = "--color"
+      end
+      
+      opts << ' ' << formatter_opts
+      # only add the "progress" formatter unless no other (besides growl) is specified
+      opts << ' -f progress' unless opts.scan(/\s(?:-f|--format)\b/).length > 1
+      
+      opts
+    end
+    
+    def formatter_opts
+      "-r #{File.dirname(__FILE__)}/../rspec_growler.rb -f RSpecGrowler:STDOUT"
+    end
+    
+    def spec_runner
+      if File.exist?("script/spec")
+        "script/spec"
+      else
+        "spec"
+      end
+    end
+    
+    def ruby_opts
+      other = ENV['RUBYOPT'] ? " #{ENV['RUBYOPT']}" : ''
+      other << ' -rcoral' if options[:coral]
+      %(RUBYOPT='-Ilib:spec#{other}')
+    end
+    
+    def git_head_changed?
+      old_git_head = @git_head
+      read_git_head
+      @git_head and old_git_head and @git_head != old_git_head
+    end
+    
+    def read_git_head
+      git_head_file = File.join(dir, '.git', 'HEAD')
+      @git_head = File.exists?(git_head_file) && File.read(git_head_file)
+    end
+  end
+end
+
+# backward compatibility
+Runner = RSpactor::Runner

data/lib/rspactor.rb

@@ -0,0 +1,7 @@
+module RSpactor
+  autoload :Interactor, 'rspactor/interactor'
+  autoload :Listener, 'rspactor/listener'
+  autoload :Inspector, 'rspactor/inspector'
+  autoload :Runner, 'rspactor/runner'
+  autoload :Growl, 'rspactor/growl'
+end

data/lib/rspec_growler.rb

@@ -0,0 +1,26 @@
+require 'spec/runner/formatter/base_formatter'
+require File.dirname(__FILE__) + '/rspactor/growl'
+
+class RSpecGrowler < Spec::Runner::Formatter::BaseFormatter
+  include RSpactor::Growl
+  
+  def dump_summary(duration, total, failures, pending)
+    icon = if failures > 0
+      'failed'
+    elsif pending > 0
+      'pending'
+    else
+      'success'
+    end
+    
+    image_path = File.dirname(__FILE__) + "/../images/#{icon}.png"
+    message = "#{total} examples, #{failures} failures"
+    
+    if pending > 0
+      message << " (#{pending} pending)"
+    end
+    
+    notify "Test Results", message, image_path(icon)
+  end
+end
+