RubyGems - merb-core - Versions diffs - 0.9.8 → 0.9.9 - Mend

merb-core 0.9.8 → 0.9.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

data/CONTRIBUTORS +33 -0
data/README +7 -3
data/Rakefile +3 -3
data/lib/merb-core.rb +165 -94
data/lib/merb-core/bootloader.rb +469 -100
data/lib/merb-core/config.rb +79 -3
data/lib/merb-core/constants.rb +24 -2
data/lib/merb-core/controller/abstract_controller.rb +172 -67
data/lib/merb-core/controller/exceptions.rb +50 -6
data/lib/merb-core/controller/merb_controller.rb +215 -108
data/lib/merb-core/controller/mime.rb +36 -12
data/lib/merb-core/controller/mixins/authentication.rb +52 -7
data/lib/merb-core/controller/mixins/conditional_get.rb +14 -0
data/lib/merb-core/controller/mixins/controller.rb +90 -58
data/lib/merb-core/controller/mixins/render.rb +34 -10
data/lib/merb-core/controller/mixins/responder.rb +40 -16
data/lib/merb-core/controller/template.rb +37 -16
data/lib/merb-core/core_ext/hash.rb +9 -0
data/lib/merb-core/core_ext/kernel.rb +92 -41
data/lib/merb-core/dispatch/dispatcher.rb +29 -45
data/lib/merb-core/dispatch/request.rb +186 -82
data/lib/merb-core/dispatch/router.rb +141 -53
data/lib/merb-core/dispatch/router/behavior.rb +296 -139
data/lib/merb-core/dispatch/router/resources.rb +51 -19
data/lib/merb-core/dispatch/router/route.rb +76 -23
data/lib/merb-core/dispatch/session.rb +80 -36
data/lib/merb-core/dispatch/session/container.rb +31 -15
data/lib/merb-core/dispatch/session/cookie.rb +51 -22
data/lib/merb-core/dispatch/session/memcached.rb +10 -6
data/lib/merb-core/dispatch/session/memory.rb +17 -5
data/lib/merb-core/dispatch/session/store_container.rb +21 -9
data/lib/merb-core/dispatch/worker.rb +16 -2
data/lib/merb-core/gem_ext/erubis.rb +4 -0
data/lib/merb-core/plugins.rb +13 -0
data/lib/merb-core/rack.rb +1 -0
data/lib/merb-core/rack/adapter.rb +1 -0
data/lib/merb-core/rack/adapter/abstract.rb +95 -17
data/lib/merb-core/rack/adapter/irb.rb +50 -5
data/lib/merb-core/rack/application.rb +27 -5
data/lib/merb-core/rack/handler/mongrel.rb +6 -6
data/lib/merb-core/rack/helpers.rb +33 -0
data/lib/merb-core/rack/middleware/conditional_get.rb +1 -1
data/lib/merb-core/rack/middleware/path_prefix.rb +3 -3
data/lib/merb-core/rack/middleware/static.rb +11 -7
data/lib/merb-core/server.rb +134 -69
data/lib/merb-core/tasks/gem_management.rb +153 -80
data/lib/merb-core/tasks/merb_rake_helper.rb +12 -4
data/lib/merb-core/tasks/stats.rake +1 -1
data/lib/merb-core/test/helpers/mock_request_helper.rb +29 -22
data/lib/merb-core/test/helpers/request_helper.rb +1 -1
data/lib/merb-core/test/helpers/route_helper.rb +50 -4
data/lib/merb-core/test/matchers/request_matchers.rb +2 -36
data/lib/merb-core/test/matchers/view_matchers.rb +32 -22
data/lib/merb-core/test/run_specs.rb +6 -5
data/lib/merb-core/test/test_ext/rspec.rb +6 -19
data/lib/merb-core/version.rb +1 -1
metadata +5 -4

data/lib/merb-core/rack/helpers.rb ADDED Viewed

@@ -0,0 +1,33 @@
+module Merb
+  module Rack
+    module Helpers
+      # A helper to build a rack response which implements a redirect.  The status will be set to
+      # the passed in status if passed.  If you pass in permanent it will be a 301, permanent redirect,
+      # otherwise it defaults to a temporary 302 redirect.
+      #
+      # ==== Parameters
+      # url<~to_s>:: The url to redirect to.
+      # options<Hash>:: A hash of options for the redirect
+      #   status: The status code to use for the redirect
+      #   permanent:  True if this is a permanent redirect (301)
+      #
+      # ==== Returns
+      # <Array>:: A rack response to redirect to the specified url.
+      #
+      # @api plugin
+      def self.redirect(url, options = {})
+        # Build the rack array
+        status   = options.delete(:status)
+        status ||= options[:permanent] ? 301 : 302
+        Merb.logger.info("Dispatcher redirecting to: #{url} (#{status})")
+        Merb.logger.flush
+        [status, { Merb::Const::LOCATION => url },
+         Merb::Rack::StreamWrapper.new("<html><body>You are being <a href=\"#{url}\">redirected</a>.</body></html>")]
+      end
+    end
+  end
+end

data/lib/merb-core/rack/middleware/conditional_get.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module Merb
         if document_not_modified?(env, headers)
           status = 304
-          body = ""
+          body = Merb::Const::EMPTY_STRING
           # set Date header using RFC1123 date format as specified by HTTP
           # RFC2616 section 3.3.1.
         end

data/lib/merb-core/rack/middleware/path_prefix.rb CHANGED Viewed

@@ -20,12 +20,12 @@ module Merb
       def strip_path_prefix(env)
         ['PATH_INFO', 'REQUEST_URI'].each do |path_key|
           if env[path_key] =~ @path_prefix
-            env[path_key].sub!(@path_prefix, '')
-            env[path_key] = '/' if env[path_key].empty?
+            env[path_key].sub!(@path_prefix, Merb::Const::EMPTY_STRING)
+            env[path_key] = Merb::Const::SLASH if env[path_key].empty?
           end
         end
       end
     end
   end
-end
+end

data/lib/merb-core/rack/middleware/static.rb CHANGED Viewed

@@ -8,16 +8,20 @@ module Merb
       end
       def call(env)
-        path = env['PATH_INFO'] ? env['PATH_INFO'].chomp('/') : ""
+        path = if env[Merb::Const::PATH_INFO]
+                 env[Merb::Const::PATH_INFO].chomp(Merb::Const::SLASH)
+               else
+                 Merb::Const::EMPTY_STRING
+               end
         cached_path = (path.empty? ? 'index' : path) + '.html'
-        if file_exist?(path) && env['REQUEST_METHOD'] =~ /GET|HEAD/ # Serve the file if it's there and the request method is GET or HEAD
+        if file_exist?(path) && env[Merb::Const::REQUEST_METHOD] =~ /GET|HEAD/ # Serve the file if it's there and the request method is GET or HEAD
           serve_static(env)
-        elsif file_exist?(cached_path) && env['REQUEST_METHOD'] =~ /GET|HEAD/ # Serve the page cache if it's there and the request method is GET or HEAD
-          env['PATH_INFO'] = cached_path
+        elsif file_exist?(cached_path) && env[Merb::Const::REQUEST_METHOD] =~ /GET|HEAD/ # Serve the page cache if it's there and the request method is GET or HEAD
+          env[Merb::Const::PATH_INFO] = cached_path
           serve_static(env)
         elsif path =~ /favicon\.ico/
-          return [404, {"Content-Type"=>"text/html"}, "404 Not Found."]
+          return [404, { Merb::Const::CONTENT_TYPE => Merb::Const::TEXT_SLASH_HTML }, "404 Not Found."]
         else
           @app.call(env)
         end
@@ -36,10 +40,10 @@ module Merb
         # ==== Parameters
         # env<Hash>:: Environment variables to pass on to the server.
         def serve_static(env)
-          env["PATH_INFO"] = ::Merb::Request.unescape(env["PATH_INFO"])
+          env[Merb::Const::PATH_INFO] = ::Merb::Request.unescape(env[Merb::Const::PATH_INFO])
           @static_server.call(env)
         end
     end
   end
-end
+end

data/lib/merb-core/server.rb CHANGED Viewed

@@ -18,10 +18,12 @@ module Merb
       # ==== Alternatives
       # If cluster is left out, then one process will be started. This process
       # will be daemonized if Merb::Config[:daemonize] is true.
+      #
+      # @api private
       def start(port, cluster=nil)
         @port = port
-        @cluster = cluster
+        @cluster = cluster
         if Merb::Config[:daemonize]
           pidfile = pid_file(port)
@@ -29,7 +31,7 @@ module Merb
           unless alive?(@port)
             remove_pid_file(@port)
-            puts "Daemonizing..." if Merb::Config[:verbose]
+            Merb.logger.warn! "Daemonizing..." if Merb::Config[:verbose]
             daemonize(@port)
           else
             Merb.fatal! "Merb is already running on port #{port}.\n" \
@@ -47,79 +49,96 @@ module Merb
       # ==== Returns
       # Boolean::
       #   True if Merb is running on the specified port.
+      #
+      # @api private
       def alive?(port)
-        puts "About to check if port #{port} is alive..." if Merb::Config[:verbose]
         pidfile = pid_file(port)
-        puts "Pidfile is #{pidfile}..." if Merb::Config[:verbose]
-        pid = File.read(pidfile).chomp.to_i
-        puts "Process id is #{pid}" if Merb::Config[:verbose]
+        pid     = pid_in_file(pidfile)
         Process.kill(0, pid)
         true
       rescue Errno::ESRCH, Errno::ENOENT
         false
       rescue Errno::EACCES => e
-        Merb.fatal!("You don't have access to the PID file at #{pidfile}.", e)
+        Merb.fatal!("You don't have access to the PID file at #{pidfile}: #{e.message}")
+      end
+      def pid_in_file(pidfile)
+        File.read(pidfile).chomp.to_i
       end
       # ==== Parameters
       # port<~to_s>:: The port of the Merb process to kill.
-      # sig<~to_s>:: The signal to send to the process. Defaults to 9.
+      # sig<~to_s>:: The signal to send to the process, the default is 9 - SIGKILL.
+      #
+      # No    Name         Default Action       Description
+      # 1     SIGHUP       terminate process    terminal line hangup
+      # 2     SIGINT       terminate process    interrupt program
+      # 3     SIGQUIT      create core image    quit program
+      # 4     SIGILL       create core image    illegal instruction
+      # 9     SIGKILL      terminate process    kill program
+      # 15    SIGTERM      terminate process    software termination signal
+      # 30    SIGUSR1      terminate process    User defined signal 1
+      # 31    SIGUSR2      terminate process    User defined signal 2
       #
       # ==== Alternatives
-      # If you pass "all" as the port, the signal will be sent to all Merb
-      # processes.
-      def kill(port, sig="INT")
-        Merb::BootLoader::BuildFramework.run
-        if sig == 9 && port == "main"
-          kill_pid("INT", pid_file("main"))
-          Dir["#{Merb.log_path}" / "*.pid"].each do |file|
-            kill_pid(9, file)
-          end
-        else
-          kill_pid(sig, pid_file(port))
-        end
+      # If you pass "all" as the port, the signal will be sent to all Merb processes.
+      #
+      # @api private
+      def kill(port, sig = "INT")
         if sig.is_a?(Integer)
           sig = Signal.list.invert[sig]
         end
+        Merb::BootLoader::BuildFramework.run
-        if sig == "KILL" && port == "main"
-          Merb.fatal! "Killed all PIDs with signal KILL"
+        # If we kill the master, then the workers should be reaped also.
+        if %w(main master all).include?(port)
+          # If a graceful exit is requested then send INT to the master process.
+          #
+          # Otherwise read pids from pid files and try to kill each process in turn.
+          kill_pid(sig, pid_file("main")) if sig == "INT"
         else
-          Merb.fatal! "Killed #{port} with signal #{sig}"
+          kill_pid(sig, pid_file(port))
         end
       end
+      # Sends the provided signal to the process pointed at by the provided pid file.
+      # @api private
       def kill_pid(sig, file)
         begin
-          pid = File.read(file).chomp.to_i
-          Merb.logger.warn! "Killing pid #{pid}"
+          pid = pid_in_file(file)
+          Merb.logger.fatal! "Killing pid #{pid} with #{sig}"
           Process.kill(sig, pid)
           FileUtils.rm(file) if File.exist?(file)
         rescue Errno::EINVAL
-          Merb.fatal! "Failed to kill PID #{pid}: '#{sig}' is an invalid " \
+          Merb.logger.fatal! "Failed to kill PID #{pid} with #{sig}: '#{sig}' is an invalid " \
             "or unsupported signal number."
         rescue Errno::EPERM
-          Merb.fatal! "Failed to kill PID #{pid}: Insufficient permissions."
+          Merb.logger.fatal! "Failed to kill PID #{pid} with #{sig}: Insufficient permissions."
         rescue Errno::ESRCH
           FileUtils.rm file
-          Merb.fatal! "Failed to kill PID #{pid}: Process is " \
+          Merb.logger.fatal! "Failed to kill PID #{pid} with #{sig}: Process is " \
             "deceased or zombie."
         rescue Errno::EACCES => e
-          Merb.fatal! e.message, e
+          Merb.logger.fatal! e.message
         rescue Errno::ENOENT => e
-          Merb.fatal! "Could not find a PID file at #{file}", e
+          # This should not cause abnormal exit, which is why
+          # we do not use Merb.fatal but instead just log with max level.
+          Merb.logger.fatal! "Could not find a PID file at #{file}. " \
+            "Most likely the process is no longer running and the pid file was not cleaned up."
         rescue Exception => e
           if !e.is_a?(SystemExit)
-            Merb.fatal! "Failed to kill PID #{pid}", e
+            Merb.logger.fatal! "Failed to kill PID #{pid.inspect} with #{sig.inspect}: #{e.message}"
           end
         end
       end
       # ==== Parameters
       # port<~to_s>:: The port of the Merb process to daemonize.
+      #
+      # @api private
       def daemonize(port)
-        puts "About to fork..." if Merb::Config[:verbose]
+        Merb.logger.warn! "About to fork..." if Merb::Config[:verbose]
         fork do
           Process.setsid
           exit if fork
@@ -131,26 +150,42 @@ module Merb
           begin
             Dir.chdir Merb::Config[:merb_root]
           rescue Errno::EACCES => e
-            Merb.fatal! "You specified #{Merb::Config[:merb_root]} " \
-              "as the Merb root, but you did not have access to it.", e
+            Merb.fatal! "You specified Merb root as #{Merb::Config[:merb_root]}, " \
+              "yet the current user does not have access to it. ", e
           end
           at_exit { remove_pid_file(port) }
           Merb::Config[:port] = port
           bootup
         end
       rescue NotImplementedError => e
-        Merb.fatal! "Daemonized mode is not supported on your platform", e
+        Merb.fatal! "Daemonized mode is not supported on your platform. ", e
       end
+      # Starts up Merb by running the bootloader and starting the adapter.
+      #
+      # @api private
       def bootup
-        Merb.trap('TERM') { exit }
+        Merb.trap("TERM") { shutdown }
-        puts "Running bootloaders..." if Merb::Config[:verbose]
+        Merb.logger.warn! "Running bootloaders..." if Merb::Config[:verbose]
         BootLoader.run
-        puts "Starting Rack adapter..." if Merb::Config[:verbose]
+        Merb.logger.warn! "Starting Rack adapter..." if Merb::Config[:verbose]
         Merb.adapter.start(Merb::Config.to_hash)
       end
+      # Shut down Merb, reap any workers if necessary.
+      #
+      # @api private
+      def shutdown(status = 0)
+        # reap_workers does exit but may not be called...
+        Merb::BootLoader::LoadClasses.reap_workers(status) if Merb::Config[:fork_for_class_load]
+        # which is why we exit explicitly here
+        exit(status)
+      end
+      # Change process user/group to those specified in Merb::Config.
+      #
+      # @api private
       def change_privilege
         if Merb::Config[:user] && Merb::Config[:group]
           Merb.logger.verbose! "About to change privilege to group " \
@@ -167,7 +202,7 @@ module Merb
       # Removes a PID file used by the server from the filesystem.
       # This uses :pid_file options from configuration when provided
-      # or merb.<port>.pid in log directory by default.
+      # or merb.<port/socket>.pid in log directory by default.
       #
       # ==== Parameters
       # port<~to_s>::
@@ -175,11 +210,13 @@ module Merb
       #
       # ==== Alternatives
       # If Merb::Config[:pid_file] has been specified, that will be used
-      # instead of the port based PID file.
+      # instead of the port/socket based PID file.
+      #
+      # @api private
       def remove_pid_file(port)
         pidfile = pid_file(port)
         if File.exist?(pidfile)
-          puts "Removing pid file #{pidfile} (port is #{port})..."
+          Merb.logger.warn! "Removing pid file #{pidfile} (port/socket: #{port})..."
           FileUtils.rm(pidfile)
         end
       end
@@ -194,37 +231,61 @@ module Merb
       #
       # ==== Alternatives
       # If Merb::Config[:pid_file] has been specified, that will be used
-      # instead of the port based PID file.
+      # instead of the port/socket based PID file.
+      #
+      # @api private
       def store_pid(port)
         store_details(port)
       end
+      # Delete the pidfile for the specified port/socket.
+      #
+      # @api private
       def remove_pid(port)
         FileUtils.rm(pid_file(port)) if File.file?(pid_file(port))
       end
+      # Stores a PID file on the filesystem.
+      # This uses :pid_file options from configuration when provided
+      # or merb.<port/socket>.pid in log directory by default.
+      #
+      # ==== Parameters
+      # port<~to_s>::
+      #   The port of the Merb process to whom the the PID file belongs to.
+      #
+      # ==== Alternatives
+      # If Merb::Config[:pid_file] has been specified, that will be used
+      # instead of the port/socket based PID file.
+      #
+      # @api private
       def store_details(port = nil)
         file = pid_file(port)
         begin
           FileUtils.mkdir_p(File.dirname(file))
         rescue Errno::EACCES => e
-          Merb.fatal! "You tried to store Merb logs in #{File.dirname(file)}, " \
-            "but you did not have access.", e
+          Merb.fatal! "Failed to store Merb logs in #{File.dirname(file)}, " \
+            "permission denied. ", e
         end
         Merb.logger.warn! "Storing #{type} file to #{file}..." if Merb::Config[:verbose]
-        File.open(file, 'w'){ |f| f.write(Process.pid.to_s) }
+        begin
+          File.open(file, 'w'){ |f| f.write(Process.pid.to_s) }
+        rescue Errno::EACCES => e
+          Merb.fatal! "Failed to access #{file}, permission denied.", e
+        end
       end
-      # Gets the pid file for the specified port.
+      # Gets the pid file for the specified port/socket.
       #
       # ==== Parameters
       # port<~to_s>::
-      #   The port of the Merb process to whom the the PID file belongs to.
+      #   The port/socket of the Merb process to whom the the PID file belongs to.
       #
       # ==== Returns
       # String::
       #   Location of pid file for specified port. If clustered and pid_file option
-      #   is specified, it adds the port value to the path.
+      #   is specified, it adds the port/socket value to the path.
+      #
+      # @api private
       def pid_file(port)
         pidfile = Merb::Config[:pid_file] || (Merb.log_path / "merb.%s.pid")
         pidfile % port
@@ -234,7 +295,9 @@ module Merb
       #
       # ==== Returns
       # Array::
-      #   List of pid file paths. If not clustered, array contains a single path.
+      #   List of pid file paths. If not running clustered, the array contains a single path.
+      #
+      # @api private
       def pid_files
         if Merb::Config[:pid_file]
           if Merb::Config[:cluster]
@@ -250,34 +313,33 @@ module Merb
       # Change privileges of the process to the specified user and group.
       #
       # ==== Parameters
-      # user<String>:: The user who should own the server process.
-      # group<String>:: The group who should own the server process.
+      # user<String>:: The user to change the process to.
+      # group<String>:: The group to change the process to.
       #
       # ==== Alternatives
       # If group is left out, the user will be used as the group.
+      #
+      # @api private
       def _change_privilege(user, group=user)
         Merb.logger.warn! "Changing privileges to #{user}:#{group}"
         uid, gid = Process.euid, Process.egid
         begin
           target_uid = Etc.getpwnam(user).uid
         rescue ArgumentError => e
-          Merb.fatal!(
-            "You tried to use user #{user}, but no such user was found", e)
+          Merb.fatal!("Failed to change to user #{user}, does the user exist?", e)
           return false
         end
         begin
           target_gid = Etc.getgrnam(group).gid
         rescue ArgumentError => e
-          Merb.fatal!(
-            "You tried to use group #{group}, but no such group was found", e)
+          Merb.fatal!("Failed to change to group #{group}, does the group exist?", e)
           return false
         end
-        if uid != target_uid || gid != target_gid
+        if (uid != target_uid) || (gid != target_gid)
           # Change process ownership
           Process.initgroups(user, target_gid)
           Process::GID.change_privilege(target_gid)
@@ -285,24 +347,27 @@ module Merb
         end
         true
       rescue Errno::EPERM => e
-        Merb.fatal! "Couldn't change user and group to #{user}:#{group}", e
+        Merb.fatal! "Permission denied for changing user:group to #{user}:#{group}.", e
         false
       end
+      # Add trap to enter IRB on SIGINT. Process exit if second SIGINT is received.
+      #
+      # @api private
       def add_irb_trap
-        Merb.trap('INT') do
+        Merb.trap("INT") do
           if @interrupted
-            puts "Exiting\n"
+            Merb.logger.warn! "Interrupt received a second time, exiting!\n"
             exit
           end
           @interrupted = true
-          puts "Interrupt a second time to quit"
+          Merb.logger.warn! "Interrupt a second time to quit."
           Kernel.sleep 1.5
           ARGV.clear # Avoid passing args to IRB
           if @irb.nil?
-            require 'irb'
+            require "irb"
             IRB.setup(nil)
             @irb = IRB::Irb.new(nil)
             IRB.conf[:MAIN_CONTEXT] = @irb.context
@@ -311,7 +376,7 @@ module Merb
           Merb.trap(:INT) { @irb.signal_handle }
           catch(:IRB_EXIT) { @irb.eval_input }
-          puts "Exiting IRB mode, back in server mode"
+          Merb.logger.warn! "Exiting from IRB mode back into server mode."
           @interrupted = false
           add_irb_trap
         end