rails 1.1.6 → 1.2.0

data/lib/breakpoint.rb

@@ -16,7 +16,13 @@
 # license please contact me.
 
 require 'irb'
-require 'binding_of_caller'
+if RUBY_VERSION == '1.8.5'
+  def Binding.of_caller(&block)
+    raise "Breakpoints are not currently working with Ruby 1.8.5"
+  end
+else
+  require 'binding_of_caller'
+end
 require 'drb'
 require 'drb/acl'
 
@@ -178,6 +184,30 @@ module Breakpoint
       end
     end
 
+    # Prints the source code surrounding the location where the
+    # breakpoint was issued.
+    def show_source_list(context = 5)
+      start_line, break_line, result = source_lines(context, true)
+      offset = [(break_line + context).to_s.length, 4].max
+      result.each_with_index do |line, i|
+        mark = (start_line + i == break_line ? '->' : '  ')
+        client.puts("%0#{offset}d%s#{line}" % [start_line + i, mark])
+      end
+      Pathname.new(@__bp_file).cleanpath.to_s
+    end
+
+    # Prints the call stack.
+    def show_call_stack(depth = 10)
+      base = Pathname.new(RAILS_ROOT).cleanpath.to_s
+      caller[1..depth].each do |line|
+        line.sub!(/^[^:]*/) do |path|
+          Pathname.new(path).cleanpath.to_s
+        end
+        client.puts(line.index(base) == 0 ? line[(base.length + 1)..-1] : line)
+      end
+      "#{Pathname.new(@__bp_file).cleanpath.to_s}:#{@__bp_line}"
+    end
+
     # Lets an object that will forward method calls to the breakpoint
     # client. This is useful for outputting longer things at the client
     # and so on. You can for example do these things:

data/lib/breakpoint_client.rb

@@ -30,13 +30,13 @@ ARGV.options do |opts|
     "connections from the server.",
     "Default: Find a good URI automatically.",
     "Example: -c druby://localhost:12345"
-  ) { |Options[:ClientURI]| }
+  ) { |v| Options[:ClientURI] = v }
 
   opts.on("-s", "--server-uri=uri",
     "Connect to the server specified at the",
     "specified uri.",
     "Default: druby://localhost:42531"
-  ) { |Options[:ServerURI]| }
+  ) { |v| Options[:ServerURI] = v }
 
   opts.on("-R", "--retry-delay=delay", Integer,
     "Automatically try to reconnect to the",
@@ -45,14 +45,14 @@ ARGV.options do |opts|
     "A value of 0 disables automatical",
     "reconnecting completely.",
     "Default: 10"
-  ) { |Options[:RetryDelay]| }
+  ) { |v| Options[:RetryDelay] = v }
 
   opts.on("-P", "--[no-]permanent",
     "Run the breakpoint client in permanent mode.",
     "This means that the client will keep continue",
     "running even after the server has closed the",
     "connection. Useful for example in Rails."
-  ) { |Options[:Permanent]| }
+  ) { |v| Options[:Permanent] = v }
 
   opts.on("-V", "--[no-]verbose",
     "Run the breakpoint client in verbose mode.",
@@ -60,7 +60,7 @@ ARGV.options do |opts|
     "individual breakpoints. This might help in seeing",
     "that the breakpoint client is still alive, but adds",
     "quite a bit of clutter."
-  ) { |Options[:Verbose]| }
+  ) { |v| Options[:Verbose] = v }
 
   opts.separator ""
 

data/lib/code_statistics.rb

@@ -83,7 +83,7 @@ class CodeStatistics #:nodoc:
       loc_over_m = (statistics["codelines"] / statistics["methods"]) - 2 rescue loc_over_m = 0
 
       start = if TEST_TYPES.include? name
-        "|   #{name.ljust(18)} "
+        "| #{name.ljust(20)} "
       else
         "| #{name.ljust(20)} " 
       end

data/lib/commands/performance/profiler.rb

@@ -1,5 +1,5 @@
 if ARGV.empty?
-  $stderr.puts "Usage: ./script/performance/profiler 'Person.expensive_method(10)' [times]"
+  $stderr.puts "Usage: ./script/performance/profiler 'Person.expensive_method(10)' [times] [flat|graph|graph_html]"
   exit(1)
 end
 
@@ -16,14 +16,30 @@ end
 
 # Use the ruby-prof extension if available.  Fall back to stdlib profiler.
 begin
-  require 'prof'
-  $stderr.puts 'Using the ruby-prof extension.'
-  Prof.clock_mode = Prof::GETTIMEOFDAY
-  Prof.start
-  profile_me
-  results = Prof.stop
-  require 'rubyprof_ext'
-  Prof.print_profile(results, $stderr)
+  begin
+    require "ruby-prof"
+    $stderr.puts 'Using the ruby-prof extension.'
+    RubyProf.clock_mode = RubyProf::WALL_TIME
+    RubyProf.start
+    profile_me
+    results = RubyProf.stop
+    if ARGV[2]
+      printer_class = RubyProf.const_get((ARGV[2] + "_printer").classify)
+    else
+      printer_class = RubyProf::FlatPrinter
+    end
+    printer = printer_class.new(results)
+    printer.print($stderr, 0)
+  rescue LoadError
+    require "prof"
+    $stderr.puts 'Using the old ruby-prof extension.'
+    Prof.clock_mode = Prof::GETTIMEOFDAY
+    Prof.start
+    profile_me
+    results = Prof.stop
+    require 'rubyprof_ext'
+    Prof.print_profile(results, $stderr)
+  end
 rescue LoadError
   require 'profiler'
   $stderr.puts 'Using the standard Ruby profiler.'

data/lib/commands/plugin.rb

@@ -136,7 +136,7 @@ class RailsEnvironment
     Tempfile.open("svn-set-prop") do |file|
       file.write(items)
       file.flush
-      system("svn propset -q svn:externals -F #{file.path} \"#{root}/vendor/plugins\"")
+      system("svn propset -q svn:externals -F \"#{file.path}\" \"#{root}/vendor/plugins\"")
     end
   end
   
@@ -150,10 +150,18 @@ class Plugin
     guess_name(uri)
   end
   
+  def self.find(name)
+    name =~ /\// ? new(name) : Repositories.instance.find_plugin(name)
+  end
+  
   def to_s
     "#{@name.ljust(30)}#{@uri}"
   end
   
+  def svn_url?
+    @uri =~ /svn(?:\+ssh)?:\/\/*/
+  end
+  
   def installed?
     File.directory?("#{rails_env.root}/vendor/plugins/#{name}") \
       or rails_env.externals.detect{ |name, repo| self.uri == repo }
@@ -161,7 +169,7 @@ class Plugin
   
   def install(method=nil, options = {})
     method ||= rails_env.best_install_method?
-    method = :export if method == :http and @uri =~ /svn:\/\/*/
+    method   = :export if method == :http and svn_url?
 
     uninstall if installed? and options[:force]
 
@@ -177,6 +185,7 @@ class Plugin
     path = "#{rails_env.root}/vendor/plugins/#{name}"
     if File.directory?(path)
       puts "Removing 'vendor/plugins/#{name}'" if $verbose
+      run_uninstall_hook
       rm_r path
     else
       puts "Plugin doesn't exist: #{path}"
@@ -187,6 +196,20 @@ class Plugin
     rails_env.externals = externals
   end
 
+  def info
+    tmp = "#{rails_env.root}/_tmp_about.yml"
+    if svn_url?
+      cmd = "svn export #{@uri} \"#{rails_env.root}/#{tmp}\""
+      puts cmd if $verbose
+      system(cmd)
+    end
+    open(svn_url? ? tmp : File.join(@uri, 'about.yml')) do |stream|
+      stream.read
+    end rescue "No about.yml found in #{uri}"
+  ensure
+    FileUtils.rm_rf tmp if svn_url?
+  end
+
   private 
 
     def run_install_hook
@@ -194,6 +217,11 @@ class Plugin
       load install_hook_file if File.exists? install_hook_file
     end
 
+    def run_uninstall_hook
+      uninstall_hook_file = "#{rails_env.root}/vendor/plugins/#{name}/uninstall.rb"
+      load uninstall_hook_file if File.exists? uninstall_hook_file
+    end
+
     def install_using_export(options = {})
       svn_command :export, options
     end
@@ -442,7 +470,7 @@ module Commands
       options.parse!(general)
       
       command = general.shift
-      if command =~ /^(list|discover|install|source|unsource|sources|remove|update)$/
+      if command =~ /^(list|discover|install|source|unsource|sources|remove|update|info)$/
         command = Commands.const_get(command.capitalize).new(self)
         command.parse!(sub)
       else
@@ -549,8 +577,8 @@ module Commands
     def options
       OptionParser.new do |o|
         o.set_summary_indent('  ')
-        o.banner =    "Usage: #{@base_command.script_name} source REPOSITORY"
-        o.define_head "Add a new repository."
+        o.banner =    "Usage: #{@base_command.script_name} source REPOSITORY [REPOSITORY [REPOSITORY]...]"
+        o.define_head "Add new repositories to the default search list."
       end
     end
     
@@ -656,13 +684,17 @@ module Commands
       puts "Scraping #{uri}" if $verbose
       dupes = []
       content = open(uri).each do |line|
-        if line =~ /<a[^>]*href=['"]([^'"]*)['"]/ or line =~ /(svn:\/\/[^<|\n]*)/
-          uri = $1
-          if uri =~ /\/plugins\// and uri !~ /\/browser\//
-            uri = extract_repository_uri(uri)
-            yield uri unless dupes.include?(uri) or Repositories.instance.exist?(uri)
-            dupes << uri
+        begin
+          if line =~ /<a[^>]*href=['"]([^'"]*)['"]/ || line =~ /(svn:\/\/[^<|\n]*)/
+            uri = $1
+            if uri =~ /^\w+:\/\// && uri =~ /\/plugins\// && uri !~ /\/browser\// && uri !~ /^http:\/\/wiki\.rubyonrails/ && uri !~ /http:\/\/instiki/
+              uri = extract_repository_uri(uri)
+              yield uri unless dupes.include?(uri) || Repositories.instance.exist?(uri)
+              dupes << uri
+            end
           end
+        rescue
+          puts "Problems scraping '#{uri}': #{$!.to_s}"
         end
       end
     end
@@ -729,19 +761,12 @@ module Commands
       environment = @base_command.environment
       install_method = determine_install_method
       puts "Plugins will be installed using #{install_method}" if $verbose
-      args.each do |name| 
-        if name =~ /\// then
-          ::Plugin.new(name).install(install_method, @options)
-        else
-          plugin = Repositories.instance.find_plugin(name)
-          unless plugin.nil?
-            plugin.install(install_method, @options)
-          else
-            puts "Plugin not found: #{name}"
-            exit 1
-          end
-        end
+      args.each do |name|
+        ::Plugin.find(name).install(install_method, @options)
       end
+    rescue
+      puts "Plugin not found: #{args.inspect}"
+      exit 1
     end
   end
 
@@ -802,6 +827,27 @@ module Commands
     end
   end
 
+  class Info
+    def initialize(base_command)
+      @base_command = base_command
+    end
+
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: #{@base_command.script_name} info name [name]..."
+        o.define_head "Shows plugin info at {url}/about.yml."
+      end
+    end
+
+    def parse!(args)
+      options.parse!(args)
+      args.each do |name|
+        puts ::Plugin.find(name).info
+        puts
+      end
+    end
+  end
 end
  
 class RecursiveHTTPFetcher

data/lib/commands/process/inspector.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+
+if RUBY_PLATFORM =~ /mswin32/ then abort("Inspector is only for Unix") end
+
+OPTIONS = {
+  :pid_path => File.expand_path(RAILS_ROOT + '/tmp/pids'),
+  :pattern  => "dispatch.*.pid",
+  :ps       => "ps -o pid,state,user,start,time,pcpu,vsz,majflt,command -p %s"
+}
+
+class Inspector
+  def self.inspect(pid_path, pattern)
+    new(pid_path, pattern).inspect
+  end
+
+  def initialize(pid_path, pattern)
+    @pid_path, @pattern = pid_path, pattern
+  end
+
+  def inspect
+    header = `#{OPTIONS[:ps] % 1}`.split("\n")[0] + "\n"
+    lines  = pids.collect { |pid| `#{OPTIONS[:ps] % pid}`.split("\n")[1] }
+    
+    puts(header + lines.join("\n"))
+  end
+
+  private
+    def pids
+      pid_files.collect do |pid_file|
+        File.read(pid_file).to_i
+      end
+    end
+
+    def pid_files
+      Dir.glob(@pid_path + "/" + @pattern)
+    end
+end
+
+
+ARGV.options do |opts|
+  opts.banner = "Usage: inspector [options]"
+
+  opts.separator ""
+
+  opts.on <<-EOF
+  Description:
+    Displays system information about Rails dispatchers (or other processes that use pid files) through
+    the ps command.
+
+  Examples:
+    inspector                                             # default ps on all tmp/pids/dispatch.*.pid files
+    inspector -s 'ps -o user,start,majflt,pcpu,vsz -p %s' # custom ps, %s is where the pid is interleaved
+  EOF
+
+  opts.on("  Options:")
+
+  opts.on("-s", "--ps=command", "default: #{OPTIONS[:ps]}", String)           { |v| OPTIONS[:ps] = v }
+  opts.on("-p", "--pidpath=path", "default: #{OPTIONS[:pid_path]}", String)   { |v| OPTIONS[:pid_path] = v }
+  opts.on("-r", "--pattern=pattern", "default: #{OPTIONS[:pattern]}", String) { |v| OPTIONS[:pattern] = v }
+
+  opts.separator ""
+
+  opts.on("-h", "--help", "Show this help message.") { puts opts; exit }
+
+  opts.parse!
+end
+
+Inspector.inspect(OPTIONS[:pid_path], OPTIONS[:pattern])

data/lib/commands/process/reaper.rb

@@ -4,89 +4,102 @@ require 'uri'
 
 if RUBY_PLATFORM =~ /mswin32/ then abort("Reaper is only for Unix") end
 
-# Instances of this class represent a single running process. Processes may
-# be queried by "keyword" to find those that meet a specific set of criteria.
-class ProgramProcess
+class Killer
   class << self
-    
     # Searches for all processes matching the given keywords, and then invokes
     # a specific action on each of them. This is useful for (e.g.) reloading a
     # set of processes:
     #
-    #   ProgramProcess.process_keywords(:reload, "basecamp")
-    def process_keywords(action, *keywords)
-      processes = keywords.collect { |keyword| find_by_keyword(keyword) }.flatten
-
-      if processes.empty?
-        puts "Couldn't find any process matching: #{keywords.join(" or ")}"
-      else
-        processes.each do |process|
-          puts "#{action.capitalize}ing #{process}"
-          process.send(action)
-        end
-      end      
+    #   Killer.process(:reload, "/tmp/pids", "dispatcher.*.pid")
+    def process(action, pid_path, pattern, keyword)
+      new(pid_path, pattern, keyword).process(action)
     end
 
-    # Searches for all processes matching the given keyword:
-    #
-    #   ProgramProcess.find_by_keyword("basecamp")
-    def find_by_keyword(keyword)
-      process_lines_with_keyword(keyword).split("\n").collect { |line|
-        next if line =~ /inq|ps axww|grep|spawn-fcgi|spawner|reaper/
-        pid, *command = line.split
-        new(pid, command.join(" "))
-      }.compact
+    # Forces the (rails) application to reload by sending a +HUP+ signal to the
+    # process.
+    def reload(pid)
+      `kill -s HUP #{pid}`
     end
 
-    private
-      def process_lines_with_keyword(keyword)
-        `ps axww -o 'pid command' | grep #{keyword}`
-      end
-  end
+    # Force the (rails) application to restart by sending a +USR2+ signal to the
+    # process.
+    def restart(pid)
+      `kill -s USR2 #{pid}`
+    end
 
-  # Create a new ProgramProcess instance that represents the process with the
-  # given pid, running the given command.
-  def initialize(pid, command)
-    @pid, @command = pid, command
-  end
+    # Forces the (rails) application to gracefully terminate by sending a
+    # +TERM+ signal to the process.
+    def graceful(pid)
+      `kill -s TERM #{pid}`
+    end
 
-  # Forces the (rails) application to reload by sending a +HUP+ signal to the
-  # process.
-  def reload
-    `kill -s HUP #{@pid}`
-  end
+    # Forces the (rails) application to terminate immediately by sending a -9
+    # signal to the process.
+    def kill(pid)
+      `kill -9 #{pid}`
+    end
 
-  # Forces the (rails) application to gracefully terminate by sending a
-  # +TERM+ signal to the process.
-  def graceful
-    `kill -s TERM #{@pid}`
+    # Send a +USR1+ signal to the process.
+    def usr1(pid)
+      `kill -s USR1 #{pid}`
+    end
   end
 
-  # Forces the (rails) application to terminate immediately by sending a -9
-  # signal to the process.
-  def kill
-    `kill -9 #{@pid}`
+  def initialize(pid_path, pattern, keyword=nil)
+    @pid_path, @pattern, @keyword = pid_path, pattern, keyword
   end
 
-  # Send a +USR1+ signal to the process.
-  def usr1
-    `kill -s USR1 #{@pid}`
-  end
+  def process(action)
+    pids = find_processes
 
-  # Force the (rails) application to restart by sending a +USR2+ signal to the
-  # process.
-  def restart
-    `kill -s USR2 #{@pid}`
+    if pids.empty?
+      warn "Couldn't find any pid file in '#{@pid_path}' matching '#{@pattern}'"
+      warn "(also looked for processes matching #{@keyword.inspect})" if @keyword
+    else
+      pids.each do |pid|
+        puts "#{action.capitalize}ing #{pid}"
+        self.class.send(action, pid)
+      end
+      
+      delete_pid_files if terminating?(action)
+    end      
   end
+  
+  private
+    def terminating?(action)
+      [ "kill", "graceful" ].include?(action)
+    end
+  
+    def find_processes
+      files = pid_files
+      if files.empty?
+        find_processes_via_grep
+      else
+        files.collect { |pid_file| File.read(pid_file).to_i }
+      end
+    end
 
-  def to_s #:nodoc:
-    "[#{@pid}] #{@command}"
-  end
+    def find_processes_via_grep
+      lines = `ps axww -o 'pid command' | grep #{@keyword}`.split(/\n/).
+        reject { |line| line =~ /inq|ps axww|grep|spawn-fcgi|spawner|reaper/ }
+      lines.map { |line| line[/^\s*(\d+)/, 1].to_i }
+    end
+    
+    def delete_pid_files
+      pid_files.each { |pid_file| File.delete(pid_file) }
+    end
+    
+    def pid_files
+      Dir.glob(@pid_path + "/" + @pattern)
+    end
 end
 
+
 OPTIONS = {
-  :action      => "restart",
-  :dispatcher  => File.expand_path(RAILS_ROOT + '/public/dispatch.fcgi')
+  :action     => "restart",
+  :pid_path   => File.expand_path(RAILS_ROOT + '/tmp/pids'),
+  :pattern    => "dispatch.[0-9]*.pid",
+  :dispatcher => File.expand_path("#{RAILS_ROOT}/public/dispatch.fcgi")
 }
 
 ARGV.options do |opts|
@@ -96,9 +109,13 @@ ARGV.options do |opts|
 
   opts.on <<-EOF
   Description:
-    The reaper is used to restart, reload, gracefully exit, and forcefully exit FCGI processes
-    running a Rails Dispatcher. This is commonly done when a new version of the application
-    is available, so the existing processes can be updated to use the latest code.
+    The reaper is used to restart, reload, gracefully exit, and forcefully exit processes
+    running a Rails Dispatcher (or any other process responding to the same signals). This
+    is commonly done when a new version of the application is available, so the existing
+    processes can be updated to use the latest code.
+
+    It uses pid files to work on the processes and by default assume them to be located
+    in RAILS_ROOT/tmp/pids. 
 
     The reaper actions are:
 
@@ -110,15 +127,17 @@ ARGV.options do |opts|
     Restart is the most common and default action.
 
   Examples:
-    reaper # restarts the default dispatcher
-    reaper -a reload
-    reaper -a exit -d /my/special/dispatcher.fcgi
+    reaper                  # restarts the default dispatchers
+    reaper -a reload        # reload the default dispatchers
+    reaper -a kill -r *.pid # kill all processes that keep pids in tmp/pids
   EOF
 
   opts.on("  Options:")
 
   opts.on("-a", "--action=name", "reload|graceful|kill (default: #{OPTIONS[:action]})", String)  { |v| OPTIONS[:action] = v }
-  opts.on("-d", "--dispatcher=path", "default: #{OPTIONS[:dispatcher]}", String)                 { |v| OPTIONS[:dispatcher] = v }
+  opts.on("-p", "--pidpath=path", "default: #{OPTIONS[:pid_path]}", String)                      { |v| OPTIONS[:pid_path] = v }
+  opts.on("-r", "--pattern=pattern", "default: #{OPTIONS[:pattern]}", String)                    { |v| OPTIONS[:pattern] = v }
+  opts.on("-d", "--dispatcher=path", "DEPRECATED. default: #{OPTIONS[:dispatcher]}", String)     { |v| OPTIONS[:dispatcher] = v }
 
   opts.separator ""
 
@@ -127,4 +146,4 @@ ARGV.options do |opts|
   opts.parse!
 end
 
-ProgramProcess.process_keywords(OPTIONS[:action], OPTIONS[:dispatcher])
+Killer.process(OPTIONS[:action], OPTIONS[:pid_path], OPTIONS[:pattern], OPTIONS[:dispatcher])