rails 0.13.1 → 0.14.1

data/lib/fcgi_handler.rb

@@ -1,16 +1,17 @@
 require 'fcgi'
 require 'logger'
 require 'dispatcher'
+require 'rbconfig'
 
 class RailsFCGIHandler
   SIGNALS = {
     'HUP'  => :reload,
-    'TERM' => :graceful_exit,
-    'USR1' => :graceful_exit
+    'TERM' => :exit,
+    'USR1' => :exit,
+    'USR2' => :restart
   }
 
   attr_reader :when_ready
-  attr_reader :processing
 
   attr_accessor :log_file_path
   attr_accessor :gc_request_period
@@ -27,9 +28,6 @@ class RailsFCGIHandler
   # (default nil for normal GC behavior.)  Optionally, pass a block which
   # takes this instance as an argument for further configuration.
   def initialize(log_file_path = nil, gc_request_period = nil)
-    @when_ready = nil
-    @processing = false
-
     self.log_file_path = log_file_path || "#{RAILS_ROOT}/log/fastcgi.crash.log"
     self.gc_request_period = gc_request_period
 
@@ -42,42 +40,37 @@ class RailsFCGIHandler
     # Start error timestamp at 11 seconds ago.
     @last_error_on = Time.now - 11
 
-    dispatcher_log(:info, "starting")
+    dispatcher_log :info, "starting"
   end
 
   def process!(provider = FCGI)
     # Make a note of $" so we can safely reload this instance.
     mark!
 
-    # Begin countdown to garbage collection.
     run_gc! if gc_request_period
 
     provider.each_cgi do |cgi| 
-      # Safely reload this instance if requested.
-      if when_ready == :reload
-        run_gc! if gc_request_period
-        restore!
-        @when_ready = nil
-        dispatcher_log(:info, "reloaded")
-      end
-
       process_request(cgi)
 
-      # Break if graceful exit requested.
-      break if when_ready == :exit
-
-      # Garbage collection countdown.
-      if gc_request_period
-        @gc_request_countdown -= 1
-        run_gc! if @gc_request_countdown <= 0
+      case when_ready
+        when :reload
+          reload!
+        when :restart
+          close_connection(cgi)
+          restart!
+        when :exit
+          close_connection(cgi)
+          break
       end
+
+      gc_countdown
     end
 
     GC.enable
-    dispatcher_log(:info, "terminated gracefully")
+    dispatcher_log :info, "terminated gracefully"
 
   rescue SystemExit => exit_error
-    dispatcher_log(:info, "terminated by explicit exit")
+    dispatcher_log :info, "terminated by explicit exit"
 
   rescue Object => fcgi_error
     # retry on errors that would otherwise have terminated the FCGI process,
@@ -105,7 +98,7 @@ class RailsFCGIHandler
       STDERR << "  #{log_error.class}: #{log_error.message}\n"
     end
 
-    def dispatcher_error(e,msg="")
+    def dispatcher_error(e, msg = "")
       error_message =
         "Dispatcher failed to catch: #{e} (#{e.class})\n" +
         "  #{e.backtrace.join("\n  ")}\n#{msg}"
@@ -114,39 +107,53 @@ class RailsFCGIHandler
 
     def install_signal_handlers
       SIGNALS.each do |signal, handler_name|
-        install_signal_handler signal, method("#{handler_name}_handler").to_proc
+        install_signal_handler(signal, method("#{handler_name}_handler").to_proc)
       end
     end
 
     def install_signal_handler(signal, handler)
-      trap signal, handler
+      trap(signal, handler)
     rescue ArgumentError
       dispatcher_log :warn, "Ignoring unsupported signal #{signal}."
     end
 
-    def graceful_exit_handler(signal)
-      if processing
-        dispatcher_log :info, "asked to terminate ASAP"
-        @when_ready = :exit
-      else
-        dispatcher_log :info, "told to terminate NOW"
-        exit
-      end
+    def exit_handler(signal)
+      dispatcher_log :info, "asked to terminate ASAP"
+      @when_ready = :exit
     end
 
     def reload_handler(signal)
-      @when_ready = :reload
       dispatcher_log :info, "asked to reload ASAP"
+      @when_ready = :reload
+    end
+
+    def restart_handler(signal)
+      dispatcher_log :info, "asked to restart ASAP"
+      @when_ready = :restart
     end
 
     def process_request(cgi)
-      @processing = true
       Dispatcher.dispatch(cgi)
     rescue Object => e
       raise if SignalException === e
       dispatcher_error(e)
-    ensure
-      @processing = false
+    end
+
+    def restart!
+      config       = ::Config::CONFIG
+      ruby         = File::join(config['bindir'], config['ruby_install_name']) + config['EXEEXT']
+      command_line = [ruby, $0, ARGV].flatten.join(' ')
+      
+      dispatcher_log :info, "restarted"
+
+      exec(command_line)
+    end
+
+    def reload!
+      run_gc! if gc_request_period
+      restore!
+      @when_ready = nil
+      dispatcher_log :info, "reloaded"
     end
 
     def mark!
@@ -163,4 +170,15 @@ class RailsFCGIHandler
       @gc_request_countdown = gc_request_period
       GC.enable; GC.start; GC.disable
     end
-end
+    
+    def gc_countdown
+      if gc_request_period
+        @gc_request_countdown -= 1
+        run_gc! if @gc_request_countdown <= 0
+      end
+    end
+    
+    def close_connection(cgi)
+      cgi.instance_variable_get("@request").finish
+    end
+end

data/lib/initializer.rb

@@ -0,0 +1,479 @@
+require 'logger'
+
+RAILS_ENV = (ENV['RAILS_ENV'] || 'development').dup unless defined?(RAILS_ENV)
+
+module Rails
+  # The Initializer is responsible for processing the Rails configuration, such
+  # as setting the $LOAD_PATH, requiring the right frameworks, initializing
+  # logging, and more. It can be run either as a single command that'll just
+  # use the default configuration, like this:
+  #
+  #   Rails::Initializer.run
+  #
+  # But normally it's more interesting to pass in a custom configuration
+  # through the block running:
+  #
+  #   Rails::Initializer.run do |config|
+  #     config.frameworks -= [ :action_web_service ]
+  #   end
+  #
+  # This will use the default configuration options from Rails::Configuration,
+  # but allow for overwriting on select areas.
+  class Initializer
+    # The Configuration instance used by this Initializer instance.
+    attr_reader :configuration
+    
+    # Runs the initializer. By default, this will invoke the #process method,
+    # which simply executes all of the initialization routines. Alternately,
+    # you can specify explicitly which initialization routine you want:
+    #
+    #   Rails::Initializer.run(:set_load_path)
+    #
+    # This is useful if you only want the load path initialized, without
+    # incuring the overhead of completely loading the entire environment. 
+    def self.run(command = :process, configuration = Configuration.new)
+      yield configuration if block_given?
+      new(configuration).send(command)
+    end
+    
+    # Create a new Initializer instance that references the given Configuration
+    # instance.
+    def initialize(configuration)
+      @configuration = configuration
+    end
+    
+    # Sequentially step through all of the available initialization routines,
+    # in order:
+    #
+    # * #set_load_path
+    # * #set_connection_adapters
+    # * #require_frameworks
+    # * #load_environment
+    # * #initialize_database
+    # * #initialize_logger
+    # * #initialize_framework_logging
+    # * #initialize_framework_views
+    # * #initialize_routing
+    # * #initialize_dependency_mechanism
+    # * #initialize_breakpoints
+    # * #initialize_whiny_nils
+    # * #intitialize_framework_settings
+    # * #load_environment
+    # * #load_plugins
+    #
+    # (Note that #load_environment is invoked twice, once at the start and
+    # once at the end, to support the legacy configuration style where the
+    # environment could overwrite the defaults directly, instead of via the
+    # Configuration instance. 
+    def process
+      set_load_path
+      set_connection_adapters
+
+      require_frameworks
+      load_environment
+
+      initialize_database
+      initialize_logger
+      initialize_framework_logging
+      initialize_framework_views
+      initialize_routing
+      initialize_dependency_mechanism
+      initialize_breakpoints
+      initialize_whiny_nils
+      
+      intitialize_framework_settings
+      
+      # Support for legacy configuration style where the environment
+      # could overwrite anything set from the defaults/global through
+      # the individual base class configurations.
+      load_environment
+
+      load_plugins
+    end
+    
+    # Set the <tt>$LOAD_PATH</tt> based on the value of
+    # Configuration#load_paths. Duplicates are removed.
+    def set_load_path
+      configuration.load_paths.reverse.each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
+      $LOAD_PATH.uniq!
+    end
+    
+    # Sets the +RAILS_CONNECTION_ADAPTERS+ constant based on the value of
+    # Configuration#connection_adapters. This constant is used to determine
+    # which database adapters should be loaded (by default, all adapters are
+    # loaded).
+    def set_connection_adapters
+      Object.const_set("RAILS_CONNECTION_ADAPTERS", configuration.connection_adapters) if configuration.connection_adapters
+    end
+    
+    # Requires all frameworks specified by the Configuration#frameworks
+    # list. By default, all frameworks (ActiveRecord, ActiveSupport,
+    # ActionPack, ActionMailer, and ActionWebService) are loaded.
+    def require_frameworks
+      configuration.frameworks.each { |framework| require(framework.to_s) }
+    end
+    
+    # Loads all plugins in the <tt>vendor/plugins</tt> directory. Each
+    # subdirectory of <tt>vendor/plugins</tt> is inspected as follows:
+    #
+    # * if the directory has a +lib+ subdirectory, add it to the load path
+    # * if the directory contains an <tt>init.rb</tt> file, read it in and
+    #   eval it.
+    #
+    # After all plugins are loaded, duplicates are removed from the load path.
+    def load_plugins
+      config = configuration
+
+      Dir.glob("#{configuration.plugins_path}/*") do |directory|
+        next if File.basename(directory)[0] == ?. || !File.directory?(directory)
+
+        if File.directory?("#{directory}/lib")
+          $LOAD_PATH.unshift "#{directory}/lib"
+        end
+
+        if File.exist?("#{directory}/init.rb")
+          silence_warnings do
+            eval(IO.read("#{directory}/init.rb"), binding)
+          end
+        end
+      end
+
+      $LOAD_PATH.uniq!
+    end
+
+    # Loads the environment specified by Configuration#environment_path, which
+    # is typically one of development, testing, or production.
+    def load_environment
+      silence_warnings do
+        config = configuration
+        eval(IO.read(configuration.environment_path), binding)
+      end
+    end
+    
+    # This initialization routine does nothing unless <tt>:active_record</tt>
+    # is one of the frameworks to load (Configuration#frameworks). If it is,
+    # this sets the database configuration from Configuration#database_configuration
+    # and then establishes the connection.
+    def initialize_database
+      return unless configuration.frameworks.include?(:active_record)
+      ActiveRecord::Base.configurations = configuration.database_configuration
+      ActiveRecord::Base.establish_connection
+    end
+    
+    # If the +RAILS_DEFAULT_LOGGER+ constant is already set, this initialization
+    # routine does nothing. If the constant is not set, and Configuration#logger
+    # is not +nil+, this also does nothing. Otherwise, a new logger instance
+    # is created at Configuration#log_path, with a default log level of
+    # Configuration#log_level.
+    #
+    # If the log could not be created, the log will be set to output to
+    # +STDERR+, with a log level of +WARN+.
+    def initialize_logger
+      # if the environment has explicitly defined a logger, use it
+      return if defined?(RAILS_DEFAULT_LOGGER)
+
+      unless logger = configuration.logger
+        begin
+          logger = Logger.new(configuration.log_path)
+          logger.level = Logger.const_get(configuration.log_level.to_s.upcase)
+        rescue StandardError
+          logger = Logger.new(STDERR)
+          logger.level = Logger::WARN
+          logger.warn(
+            "Rails Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " +
+            "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
+          )
+        end
+      end
+      
+      silence_warnings { Object.const_set "RAILS_DEFAULT_LOGGER", logger }
+    end
+    
+    # Sets the logger for ActiveRecord, ActionController, and ActionMailer
+    # (but only for those frameworks that are to be loaded). If the framework's
+    # logger is already set, it is not changed, otherwise it is set to use
+    # +RAILS_DEFAULT_LOGGER+.
+    def initialize_framework_logging
+      for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
+        framework.to_s.camelize.constantize.const_get("Base").logger ||= RAILS_DEFAULT_LOGGER
+      end
+    end
+    
+    # Sets the +template_root+ for ActionController::Base and ActionMailer::Base
+    # (but only for those frameworks that are to be loaded). If the framework's
+    # +template_root+ has already been set, it is not changed, otherwise it is
+    # set to use Configuration#view_path.
+    def initialize_framework_views
+      for framework in ([ :action_controller, :action_mailer ] & configuration.frameworks)
+        framework.to_s.camelize.constantize.const_get("Base").template_root ||= configuration.view_path
+      end
+    end
+
+    # If ActionController is not one of the loaded frameworks (Configuration#frameworks)
+    # this does nothing. Otherwise, it loads the routing definitions and sets up
+    # loading module used to lazily load controllers (Configuration#controller_paths).
+    def initialize_routing
+      return unless configuration.frameworks.include?(:action_controller)
+      ActionController::Routing::Routes.reload
+      Object.const_set "Controllers", Dependencies::LoadingModule.root(*configuration.controller_paths)
+    end
+    
+    # Sets the dependency loading mechanism based on the value of
+    # Configuration#cache_classes.
+    def initialize_dependency_mechanism
+      Dependencies.mechanism = configuration.cache_classes ? :require : :load
+    end
+    
+    # Sets the +BREAKPOINT_SERVER_PORT+ if Configuration#breakpoint_server
+    # is true.
+    def initialize_breakpoints
+      silence_warnings { Object.const_set("BREAKPOINT_SERVER_PORT", 42531) if configuration.breakpoint_server }
+    end
+
+    # Loads support for "whiny nil" (noisy warnings when methods are invoked
+    # on +nil+ values) if Configuration#whiny_nils is true.
+    def initialize_whiny_nils
+      require('active_support/whiny_nil') if configuration.whiny_nils
+    end
+
+    # Initialize framework-specific settings for each of the loaded frameworks
+    # (Configuration#frameworks). The available settings map to the accessors
+    # on each of the corresponding Base classes.
+    def intitialize_framework_settings
+      configuration.frameworks.each do |framework|
+        base_class = framework.to_s.camelize.constantize.const_get("Base")
+
+        configuration.send(framework).each do |setting, value|
+          base_class.send("#{setting}=", value)
+        end
+      end
+    end
+  end
+  
+  # The Configuration class holds all the parameters for the Initializer and
+  # ships with defaults that suites most Rails applications. But it's possible
+  # to overwrite everything. Usually, you'll create an Configuration file
+  # implicitly through the block running on the Initializer, but it's also
+  # possible to create the Configuration instance in advance and pass it in
+  # like this:
+  #
+  #   config = Rails::Configuration.new
+  #   Rails::Initializer.run(:process, config)
+  class Configuration
+    # A stub for setting options on ActionController::Base
+    attr_accessor :action_controller
+    
+    # A stub for setting options on ActionMailer::Base
+    attr_accessor :action_mailer
+    
+    # A stub for setting options on ActionView::Base
+    attr_accessor :action_view
+    
+    # A stub for setting options on ActionWebService::Base
+    attr_accessor :action_web_service
+    
+    # A stub for setting options on ActiveRecord::Base
+    attr_accessor :active_record
+    
+    # Whether or not to use the breakpoint server (boolean)
+    attr_accessor :breakpoint_server
+    
+    # Whether or not classes should be cached (set to false if you want
+    # application classes to be reloaded on each request)
+    attr_accessor :cache_classes
+    
+    # The list of connection adapters to load. (By default, all connection
+    # adapters are loaded. You can set this to be just the adapter(s) you
+    # will use to reduce your application's load time.)
+    attr_accessor :connection_adapters
+    
+    # The list of paths that should be searched for controllers. (Defaults
+    # to <tt>app/controllers</tt> and <tt>components</tt>.)
+    attr_accessor :controller_paths
+
+    # The path to the database configuration file to use. (Defaults to
+    # <tt>config/database.yml</tt>.)
+    attr_accessor :database_configuration_file
+    
+    # The list of rails framework components that should be loaded. (Defaults
+    # to <tt>:active_record</tt>, <tt>:action_controller</tt>,
+    # <tt>:action_view</tt>, <tt>:action_mailer</tt>, and
+    # <tt>:action_web_service</tt>).
+    attr_accessor :frameworks
+    
+    # An array of additional paths to prepend to the load path. By default,
+    # all +app+, +lib+, +vendor+ and mock paths are included in this list.
+    attr_accessor :load_paths
+    
+    # The log level to use for the default Rails logger. In production mode,
+    # this defaults to <tt>:info</tt>. In development mode, it defaults to
+    # <tt>:debug</tt>.
+    attr_accessor :log_level
+    
+    # The path to the log file to use. Defaults to log/#{environment}.log
+    # (e.g. log/development.log or log/production.log).
+    attr_accessor :log_path
+    
+    # The specific logger to use. By default, a logger will be created and
+    # initialized using #log_path and #log_level, but a programmer may
+    # specifically set the logger to use via this accessor and it will be
+    # used directly.
+    attr_accessor :logger
+    
+    # The root of the application's views. (Defaults to <tt>app/views</tt>.)
+    attr_accessor :view_path
+    
+    # Set to +true+ if you want to be warned (noisily) when you try to invoke
+    # any method of +nil+. Set to +false+ for the standard Ruby behavior.
+    attr_accessor :whiny_nils
+    
+    # Create a new Configuration instance, initialized with the default
+    # values.
+    def initialize
+      self.frameworks                   = default_frameworks
+      self.load_paths                   = default_load_paths
+      self.log_path                     = default_log_path
+      self.log_level                    = default_log_level
+      self.view_path                    = default_view_path
+      self.controller_paths             = default_controller_paths
+      self.cache_classes                = default_cache_classes
+      self.breakpoint_server            = default_breakpoint_server
+      self.whiny_nils                   = default_whiny_nils
+      self.database_configuration_file  = default_database_configuration_file
+      
+      for framework in default_frameworks
+        self.send("#{framework}=", OrderedOptions.new)
+      end
+    end
+    
+    # Loads and returns the contents of the #database_configuration_file. The
+    # contents of the file are processed via ERB before being sent through
+    # YAML::load.
+    def database_configuration
+      YAML::load(ERB.new(IO.read(database_configuration_file)).result)
+    end
+    
+    # The path to the current environment's file (development.rb, etc.). By
+    # default the file is at <tt>config/environments/#{environment}.rb</tt>.
+    def environment_path
+      "#{RAILS_ROOT}/config/environments/#{environment}.rb"
+    end
+
+    # The path to the root of the plugins directory. By default, it is in
+    # <tt>vendor/plugins</tt>.
+    def plugins_path
+      "#{RAILS_ROOT}/vendor/plugins"
+    end
+    
+    # Return the currently selected environment. By default, it returns the
+    # value of the +RAILS_ENV+ constant.
+    def environment
+      ::RAILS_ENV
+    end
+
+    private
+      def default_frameworks
+        [ :active_record, :action_controller, :action_view, :action_mailer, :action_web_service ]
+      end
+    
+      def default_load_paths
+        paths = ["#{RAILS_ROOT}/test/mocks/#{environment}"]
+
+        # Then model subdirectories.
+        # TODO: Don't include .rb models as load paths
+        paths.concat(Dir["#{RAILS_ROOT}/app/models/[_a-z]*"])
+        paths.concat(Dir["#{RAILS_ROOT}/components/[_a-z]*"])
+
+        # Followed by the standard includes.
+        # TODO: Don't include dirs for frameworks that are not used
+        paths.concat %w(
+          app 
+          app/models 
+          app/controllers 
+          app/helpers 
+          app/apis 
+          components 
+          config 
+          lib 
+          vendor 
+          vendor/rails/railties
+          vendor/rails/railties/lib
+          vendor/rails/actionpack/lib
+          vendor/rails/activesupport/lib
+          vendor/rails/activerecord/lib
+          vendor/rails/actionmailer/lib
+          vendor/rails/actionwebservice/lib
+        ).map { |dir| "#{RAILS_ROOT}/#{dir}" }.select { |dir| File.directory?(dir) }
+      end
+
+      def default_log_path
+        File.join(RAILS_ROOT, 'log', "#{environment}.log")
+      end
+      
+      def default_log_level
+        environment == 'production' ? :info : :debug
+      end
+      
+      def default_database_configuration_file
+        File.join(RAILS_ROOT, 'config', 'database.yml')
+      end
+      
+      def default_view_path
+        File.join(RAILS_ROOT, 'app', 'views')
+      end
+      
+      def default_controller_paths
+        [ File.join(RAILS_ROOT, 'app', 'controllers'), File.join(RAILS_ROOT, 'components') ]
+      end
+      
+      def default_dependency_mechanism
+        :load
+      end
+      
+      def default_cache_classes
+        false
+      end
+      
+      def default_breakpoint_server
+        false
+      end
+      
+      def default_whiny_nils
+        false
+      end
+  end
+end
+
+# Needs to be duplicated from Active Support since its needed before Active
+# Support is available.
+class OrderedOptions < Array # :nodoc:
+  def []=(key, value)
+    key = key.to_sym
+
+    if pair = find_pair(key)
+      pair.pop
+      pair << value
+    else
+      self << [key, value]
+    end
+  end
+
+  def [](key)
+    pair = find_pair(key.to_sym)
+    pair ? pair.last : nil
+  end
+
+  def method_missing(name, *args)
+    if name.to_s =~ /(.*)=$/
+      self[$1.to_sym] = args.first
+    else
+      self[name]
+    end
+  end
+
+  private
+    def find_pair(key)
+      self.each { |i| return i if i.first == key }
+      return false
+    end
+end