wycats-merb-core 0.9.8 → 0.9.9

data/lib/merb-core/bootloader.rb

@@ -6,7 +6,8 @@ module Merb
     #---
     # @semipublic
     cattr_accessor :subclasses, :after_load_callbacks, :before_load_callbacks, :finished
-    self.subclasses, self.after_load_callbacks, self.before_load_callbacks, self.finished = [], [], [], []
+    self.subclasses, self.after_load_callbacks,
+      self.before_load_callbacks, self.finished = [], [], [], []
 
     class << self
 
@@ -74,7 +75,7 @@ module Merb
         end
         self.subclasses = subklasses
       end
-      
+
       # Determines whether or not a specific bootloader has finished yet.
       #
       # ==== Parameters
@@ -144,13 +145,23 @@ class Merb::BootLoader::Logger < Merb::BootLoader
 
   # Sets Merb.logger to a new logger created based on the config settings.
   def self.run
-    Merb.logger = Merb::Logger.new(Merb.log_file, Merb::Config[:log_level], Merb::Config[:log_delimiter], Merb::Config[:log_auto_flush])
+    Merb::Config[:log_level] ||= begin
+      if Merb.environment == "production"
+        Merb::Logger::Levels[:warn]
+      else
+        Merb::Logger::Levels[:debug]
+      end
+    end
+
+    Merb::Config[:log_stream] = Merb.log_stream
+
     print_warnings
   end
-  
+
   def self.print_warnings
     if Gem::Version.new(Gem::RubyGemsVersion) < Gem::Version.new("1.1")
-      Merb.logger.warn! "Merb requires Rubygems 1.1 and later. Please upgrade RubyGems with gem update --system."
+      Merb.fatal! "Merb requires Rubygems 1.1 and later. " \
+        "Please upgrade RubyGems with gem update --system."
     end
   end
 end
@@ -159,12 +170,12 @@ end
 #
 # Only run if daemonization or clustering options specified on start.
 # Port is taken from Merb::Config and must be already set at this point.
-class Merb::BootLoader::DropPidFile <  Merb::BootLoader
+class Merb::BootLoader::DropPidFile < Merb::BootLoader
   class << self
 
     # Stores a PID file if Merb is running daemonized or clustered.
     def run
-      Merb::Server.store_pid(Merb::Config[:port]) if Merb::Config[:daemonize] || Merb::Config[:cluster]
+      Merb::Server.store_pid("main") #if Merb::Config[:daemonize] || Merb::Config[:cluster]
     end
   end
 end
@@ -257,6 +268,10 @@ class Merb::BootLoader::Dependencies < Merb::BootLoader
   # haven't been loaded up until this point.
 
   def self.run
+    set_encoding
+    # this is crucial: load init file with all the preferences
+    # then environment init file, then start enabling specific
+    # components, load dependencies and update logger.
     load_initfile
     load_env_config
     enable_json_gem unless Merb::disabled?(:json)
@@ -269,14 +284,29 @@ class Merb::BootLoader::Dependencies < Merb::BootLoader
   end
 
   def self.enable_json_gem
+    gem "json"
     require "json/ext"
   rescue LoadError
+    gem "json_pure"
     require "json/pure"
   end
 
   def self.update_logger
-    updated_logger_options = [ Merb.log_file, Merb::Config[:log_level], Merb::Config[:log_delimiter], Merb::Config[:log_auto_flush] ]
-    Merb::BootLoader::Logger.run if updated_logger_options != Merb.logger.init_args
+    Merb.logger = nil
+
+    # If log file is given, use it and not log stream we have.
+    if Merb::Config[:log_file]
+      raise "log file should be a string, got: #{Merb::Config[:log_file].inspect}" unless Merb::Config[:log_file].is_a?(String)
+      STDOUT.puts "Logging to file at #{Merb::Config[:log_file]}" unless Merb.testing?
+      Merb::Config[:log_stream] = File.open(Merb::Config[:log_file], "w+")
+    # but if it's not given, fallback to log stream or stdout
+    else
+      Merb::Config[:log_stream] ||= STDOUT
+    end
+  end
+
+  def self.set_encoding
+    $KCODE = 'UTF8' if $KCODE == 'NONE' || $KCODE.blank?
   end
 
   private
@@ -293,7 +323,10 @@ class Merb::BootLoader::Dependencies < Merb::BootLoader
 
     # Loads the environment configuration file, if any
     def self.load_env_config
-      load(env_config) if env_config?
+      if env_config?
+        STDOUT.puts "Loading #{env_config}" unless Merb.testing?
+        load(env_config)
+      end
     end
 
     # Determines the init file to use, if any.
@@ -308,9 +341,11 @@ class Merb::BootLoader::Dependencies < Merb::BootLoader
 
     # Loads the init file, should one exist
     def self.load_initfile
-      load(initfile) if File.exists?(initfile)
+      if File.exists?(initfile)
+        STDOUT.puts "Loading init file from #{initfile}" unless Merb.testing?
+        load(initfile)
+      end
     end
-
 end
 
 class Merb::BootLoader::MixinSession < Merb::BootLoader
@@ -320,7 +355,7 @@ class Merb::BootLoader::MixinSession < Merb::BootLoader
   # plugin session stores for example - these need to be loaded in a
   # before_app_loads block or a BootLoader that runs after MixinSession.
   #
-  # Note: access to Merb::Config is needed, so it needs to run after 
+  # Note: access to Merb::Config is needed, so it needs to run after
   # Merb::BootLoader::Dependencies is done.
   def self.run
     require 'merb-core/dispatch/session'
@@ -356,32 +391,174 @@ class Merb::BootLoader::LoadClasses < Merb::BootLoader
     # Load all classes from Merb's native load paths.
     def run
       # Add models, controllers, helpers and lib to the load path
-      $LOAD_PATH.unshift Merb.dir_for(:model)
-      $LOAD_PATH.unshift Merb.dir_for(:controller)
-      $LOAD_PATH.unshift Merb.dir_for(:lib)
-      $LOAD_PATH.unshift Merb.dir_for(:helper)
+      unless @ran
+        $LOAD_PATH.unshift Merb.dir_for(:model)
+        $LOAD_PATH.unshift Merb.dir_for(:controller)
+        $LOAD_PATH.unshift Merb.dir_for(:lib)
+        $LOAD_PATH.unshift Merb.dir_for(:helper)
+      end
+
+      @ran = true
+      $0 = "merb#{" : " + Merb::Config[:name] if Merb::Config[:name]} : master"
+
+      if Merb::Config[:fork_for_class_load] && !Merb.testing?
+        start_transaction
+      else
+        Merb.trap('INT') do
+          Merb.logger.warn! "Killing children"
+          kill_children
+        end
+      end
 
       # Load application file if it exists - for flat applications
       load_file Merb.dir_for(:application) if File.file?(Merb.dir_for(:application))
-      
+
       # Load classes and their requirements
       Merb.load_paths.each do |component, path|
-        next unless path.last && component != :application
+        next if path.last.blank? || component == :application || component == :router
         load_classes(path.first / path.last)
       end
 
       Merb::Controller.send :include, Merb::GlobalHelpers
     end
-    
+
+    # Wait for any children to exit, remove the "main" PID, and
+    # exit.
+    def exit_gracefully
+      Process.waitall
+      Merb::Server.remove_pid("main")
+      exit
+    end
+
+    # If using fork-based code reloading, set up the BEGIN
+    # point and set up any signals in the parent and child.
+    def start_transaction
+      Merb.logger.warn! "Parent pid: #{Process.pid}"
+      reader, writer = nil, nil
+
+      if GC.respond_to?(:copy_on_write_friendly=)
+        GC.copy_on_write_friendly = true
+      end
+
+      loop do
+        reader, @writer = IO.pipe
+        pid = Kernel.fork
+
+        # pid means we're in the parent; only stay in the loop in that case
+        break unless pid
+        @writer.close
+
+        Merb::Server.store_pid("main")
+
+        if Merb::Config[:console_trap]
+          Merb.trap("INT") {}
+        else
+          Merb.trap("INT") do
+            Merb.logger.warn! "Killing children"
+            begin
+              Process.kill("ABRT", pid)
+            rescue SystemCallError
+            end
+            exit_gracefully
+          end
+        end
+
+        Merb.trap("HUP") do
+          Merb.logger.warn! "Doing a fast deploy\n"
+          Process.kill("HUP", pid)
+        end
+
+        reader_ary = [reader]
+        loop do
+          if exit_status = Process.wait2(pid, Process::WNOHANG)
+            exit_status[1] == 128 ? break : exit
+          end
+          if select(reader_ary, nil, nil, 0.25)
+            begin
+              next if reader.eof?
+              msg = reader.readline
+              if msg =~ /128/
+                break
+              else
+                exit_gracefully
+              end
+            rescue SystemCallError
+              exit_gracefully
+            end
+          end
+        end
+      end
+
+      reader.close
+
+      # add traps to the child
+      if Merb::Config[:console_trap]
+        Merb::Server.add_irb_trap
+        at_exit { kill_children }
+      else
+        Merb.trap('INT') {}
+        Merb.trap('ABRT') { kill_children }
+        Merb.trap('HUP') { kill_children(128) }
+      end
+    end
+
+    # Kill any children of the spawner process and exit with
+    # an appropriate status code.
+    #
+    # Note that exiting the spawner process with a status code
+    # of 128 when a master process exists will cause the
+    # spawner process to be recreated, and the app code reloaded.
+    #
+    # @param status<Integer> The status code to exit with
+    def kill_children(status = 0)
+      Merb.exiting = true unless status == 128
+
+      begin
+        @writer.puts(status.to_s) if @writer
+      rescue SystemCallError
+      end
+
+      threads = []
+
+      ($CHILDREN || []).each do |p|
+        threads << Thread.new do
+          begin
+            Process.kill("ABRT", p)
+            Process.wait2(p)
+          rescue SystemCallError
+          end
+        end
+      end
+      threads.each {|t| t.join }
+      exit(status)
+    end
+
     # ==== Parameters
     # file<String>:: The file to load.
     def load_file(file)
-      klasses = ObjectSpace.classes.dup
-      load file
-      LOADED_CLASSES[file] = ObjectSpace.classes - klasses
-      MTIMES[file] = File.mtime(file)
+      # Don't do this expensive operation unless we need to
+      unless Merb::Config[:fork_for_class_load]
+        klasses = ObjectSpace.classes.dup
+      end
+
+      # Ignore the file for syntax errors. The next time
+      # the file is changed, it'll be reloaded again
+      begin
+        load file
+      rescue SyntaxError
+        return
+      ensure
+        if Merb::Config[:reload_classes]
+          MTIMES[file] = File.mtime(file)
+        end
+      end
+
+      # Don't do this expensive operation unless we need to
+      unless Merb::Config[:fork_for_class_load]
+        LOADED_CLASSES[file] = ObjectSpace.classes - klasses
+      end
     end
-    
+
     # Load classes from given paths - using path/glob pattern.
     #
     # *paths<Array>::
@@ -403,22 +580,18 @@ class Merb::BootLoader::LoadClasses < Merb::BootLoader
     # ==== Parameters
     # file<String>:: The file to reload.
     def reload(file)
-      remove_classes_in_file(file) { |f| load_file(f) }
-    end
-    
-    # Reload the router to regenerate all routes.
-    def reload_router!
-      if File.file?(router_file = Merb.dir_for(:router) / Merb.glob_for(:router))
-        Merb::Router.reset!
-        reload router_file
+      if Merb::Config[:fork_for_class_load]
+        kill_children(128)
+      else
+        remove_classes_in_file(file) { |f| load_file(f) }
       end
     end
-    
+
     # ==== Parameters
     # file<String>:: The file to remove classes for.
     # &block:: A block to call with the file that has been removed.
     def remove_classes_in_file(file, &block)
-      Merb.klass_hashes.each {|x| x.protect_keys!}
+      Merb.klass_hashes.each { |x| x.protect_keys! }
       if klasses = LOADED_CLASSES.delete(file)
         klasses.each { |klass| remove_constant(klass) unless klass.to_s =~ /Router/ }
       end
@@ -451,7 +624,7 @@ class Merb::BootLoader::LoadClasses < Merb::BootLoader
         Merb.logger.debug("Failed to remove constant #{object} from #{base}")
       end
     end
-    
+
     private
 
     # "Better loading" of classes.  If a class fails to load due to a NameError
@@ -489,10 +662,11 @@ class Merb::BootLoader::LoadClasses < Merb::BootLoader
         if klasses.size == size_at_start && klasses.size != 0
           # Write all remaining failed classes and their exceptions to the log
           messages = error_map.only(*failed_classes).map do |klass, e|
-            ["Could not load #{klass}:\n\n#{e.message} - (#{e.class})", "#{(e.backtrace || []).join("\n")}"]
+            ["Could not load #{klass}:\n\n#{e.message} - (#{e.class})",
+              "#{(e.backtrace || []).join("\n")}"]
           end
           messages.each { |msg, trace| Merb.logger.fatal!("#{msg}\n\n#{trace}") }
-          raise LoadError, "#{messages[0][0]} (see log for details)"
+          Merb.fatal! "#{failed_classes.join(", ")} failed to load."
         end
         break if(klasses.size == size_at_start || klasses.size == 0)
       end
@@ -502,6 +676,31 @@ class Merb::BootLoader::LoadClasses < Merb::BootLoader
 
 end
 
+class Merb::BootLoader::Router < Merb::BootLoader
+  class << self
+
+    def run
+      Merb::BootLoader::LoadClasses.load_file(router_file) if router_file
+    end
+
+    def reload!
+      if router_file
+        Merb::Router.reset!
+        Merb::BootLoader::LoadClasses.reload(router_file)
+      end
+    end
+
+    def router_file
+      @router_file ||= begin
+        if File.file?(router = Merb.dir_for(:router) / Merb.glob_for(:router))
+          router
+        end
+      end
+    end
+
+  end
+end
+
 class Merb::BootLoader::Templates < Merb::BootLoader
   class << self
 
@@ -532,7 +731,9 @@ class Merb::BootLoader::Templates < Merb::BootLoader
       # template roots.  eg app/views/shared/*
       template_paths << Dir["#{Merb.dir_for(:view)}/**/*.#{extension_glob}"] if Merb.dir_for(:view)
 
-      template_paths.flatten.compact.uniq
+      # This ignores templates for partials, which need to be compiled at use time to generate
+      # a preamble that assigns local variables
+      template_paths.flatten.compact.uniq.grep(%r{^.*/[^_][^/]*$})
     end
   end
 end
@@ -562,13 +763,13 @@ class Merb::BootLoader::MimeTypes < Merb::BootLoader
 end
 
 class Merb::BootLoader::Cookies < Merb::BootLoader
-  
+
   def self.run
     require 'merb-core/dispatch/cookies'
     Merb::Controller.send(:include, Merb::CookiesMixin)
     Merb::Request.send(:include, Merb::CookiesMixin::RequestMixin)
   end
-  
+
 end
 
 class Merb::BootLoader::SetupSession < Merb::BootLoader
@@ -581,22 +782,22 @@ class Merb::BootLoader::SetupSession < Merb::BootLoader
       base_name = File.basename(file, ".rb")
       require file unless base_name == "container" || base_name == "store_container"
     end
-    
+
     # Set some defaults.
     Merb::Config[:session_id_key] ||= "_session_id"
-    
+
     # List of all session_stores from :session_stores and :session_store config options.
     config_stores = Merb::Config.session_stores
-    
+
     # Register all configured session stores - any loaded session container class
     # (subclassed from Merb::SessionContainer) will be available for registration.
     Merb::SessionContainer.subclasses.each do |class_name|
-      if(store = Object.full_const_get(class_name)) && 
+      if(store = Object.full_const_get(class_name)) &&
         config_stores.include?(store.session_store_type)
           Merb::Request.register_session_type(store.session_store_type, class_name)
       end
     end
-    
+
     # Mixin the Merb::Session module to add app-level functionality to sessions
     Merb::SessionContainer.send(:include, Merb::Session)
   end
@@ -669,7 +870,7 @@ class Merb::BootLoader::RackUpApplication < Merb::BootLoader
          run Merb::Rack::Application.new
        }.to_app
     end
-    
+
   end
 end
 
@@ -681,7 +882,7 @@ class Merb::BootLoader::ReloadClasses < Merb::BootLoader
       Thread.new do
         loop do
           sleep( seconds )
-          block.call
+          yield
         end
         Thread.exit
       end
@@ -692,14 +893,6 @@ class Merb::BootLoader::ReloadClasses < Merb::BootLoader
   def self.run
     return unless Merb::Config[:reload_classes]
 
-    TimedExecutor.every(Merb::Config[:reload_time] || 0.5) do
-      reload
-    end
-    
-  end
-
-  # Reloads all files.
-  def self.reload
     paths = []
     Merb.load_paths.each do |path_name, file_info|
       path, glob = file_info
@@ -707,11 +900,26 @@ class Merb::BootLoader::ReloadClasses < Merb::BootLoader
       paths << Dir[path / glob]
     end
 
-    paths << Merb.dir_for(:application) if Merb.dir_for(:application) && File.file?(Merb.dir_for(:application))
+    if Merb.dir_for(:application) && File.file?(Merb.dir_for(:application))
+      paths << Merb.dir_for(:application)
+    end
+
+    paths.flatten!
+
+    TimedExecutor.every(Merb::Config[:reload_time] || 0.5) do
+      GC.start
+      reload(paths)
+    end
+
+  end
+
+  # Reloads all files.
+  def self.reload(paths)
+    paths.each do |file|
+      next if LoadClasses::MTIMES[file] &&
+        LoadClasses::MTIMES[file] == File.mtime(file)
 
-    paths.flatten.each do |file|
-      next if Merb::BootLoader::LoadClasses::MTIMES[file] && Merb::BootLoader::LoadClasses::MTIMES[file] == File.mtime(file)
-      Merb::BootLoader::LoadClasses.reload(file)
+      LoadClasses.reload(file)
     end
   end
 end