merb-core 0.9.2 → 0.9.3

data/lib/merb-core/server.rb

@@ -1,6 +1,6 @@
 require 'etc'
 module Merb
-  
+
   # Server encapsulates the management of Merb daemons.
   class Server
     class << self
@@ -29,9 +29,9 @@ module Merb
             else
               raise "Merb is already running on port: #{port}"
             end
-          end   
+          end
         elsif Merb::Config[:daemonize]
-          unless alive?(@port)  
+          unless alive?(@port)
             remove_pid_file(@port)
             daemonize(@port)
           else
@@ -39,6 +39,7 @@ module Merb
           end
         else
           trap('TERM') { exit }
+          trap('INT') { puts "\nExiting"; exit }
           BootLoader.run
           Merb.adapter.start(Merb::Config.to_hash)
         end
@@ -51,8 +52,8 @@ module Merb
       # Boolean::
       #   True if Merb is running on the specified port.
       def alive?(port)
-        f = "#{Merb.log_path}" / "merb.#{port}.pid"
-        pid = IO.read(f).chomp.to_i
+        pidfile = pid_file(port)
+        pid = IO.read(pidfile).chomp.to_i
         Process.kill(0, pid)
         true
       rescue
@@ -69,7 +70,10 @@ module Merb
       def kill(port, sig=9)
         Merb::BootLoader::BuildFramework.run
         begin
-          Dir[Merb.log_path/ "merb.#{port == 'all' ? '*' : port }.pid"].each do |f|
+          pidfiles = port == "all" ?
+            pid_files : [ pid_file(port) ]
+            
+          pidfiles.each do |f|          
             pid = IO.read(f).chomp.to_i
             begin
               Process.kill(sig, pid)
@@ -86,7 +90,7 @@ module Merb
               puts "Failed to kill PID #{pid}: #{e.message}"
             end
           end
-        ensure  
+        ensure
           exit
         end
       end
@@ -105,19 +109,24 @@ module Merb
           Dir.chdir Merb::Config[:merb_root]
           at_exit { remove_pid_file(port) }
           Merb::Config[:port] = port
-          if Merb::Config[:user]
-            if Merb::Config[:group]
-              change_privilege(Merb::Config[:user], Merb::Config[:group])
-            else
-              change_privilege(Merb::Config[:user])
-            end    
-          end  
           BootLoader.run
           Merb.adapter.start(Merb::Config.to_hash)
         end
       end
 
-      # Removes a PID file from the filesystem.
+      def change_privilege
+        if Merb::Config[:user]
+          if Merb::Config[:group]
+            _change_privilege(Merb::Config[:user], Merb::Config[:group])
+          else
+            _change_privilege(Merb::Config[:user])
+          end
+        end
+      end
+      
+      # 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.
       #
       # ==== Parameters
       # port<~to_s>::
@@ -127,15 +136,13 @@ module Merb
       # If Merb::Config[:pid_file] has been specified, that will be used
       # instead of the port based PID file.
       def remove_pid_file(port)
-        if Merb::Config[:pid_file]
-          pidfile = Merb::Config[:pid_file]
-        else
-          pidfile = Merb.log_path / "merb.#{port}.pid"
-        end
+        pidfile = pid_file(port)
         FileUtils.rm(pidfile) if File.exist?(pidfile)
       end
 
       # Stores a PID file on the filesystem.
+      # This uses :pid_file options from configuration when provided
+      # or merb.<port>.pid in log directory by default.
       #
       # ==== Parameters
       # port<~to_s>::
@@ -145,15 +152,58 @@ module Merb
       # If Merb::Config[:pid_file] has been specified, that will be used
       # instead of the port based PID file.
       def store_pid(port)
-        FileUtils.mkdir_p(Merb.log_path) unless File.directory?(Merb.log_path)
+        pidfile = pid_file(port)
+        FileUtils.mkdir_p(File.dirname(pidfile)) unless File.directory?(File.dirname(pidfile))
+        File.open(pidfile, 'w'){ |f| f.write("#{Process.pid}") }
+      end
+          
+      # Gets the pid file for the specified port.
+      #
+      # ==== Parameters
+      # port<~to_s>::
+      #   The port 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.
+      def pid_file(port)
         if Merb::Config[:pid_file]
           pidfile = Merb::Config[:pid_file]
+          if Merb::Config[:cluster]
+            ext = File.extname(Merb::Config[:pid_file])
+            base = File.basename(Merb::Config[:pid_file], ext)
+            dir = File.dirname(Merb::Config[:pid_file])
+            File.join(dir, "#{base}.#{port}#{ext}")
+          else
+            Merb::Config[:pid_file]
+          end
         else
           pidfile = Merb.log_path / "merb.#{port}.pid"
+          Merb.log_path / "merb.#{port}.pid"
         end
-        File.open(pidfile, 'w'){ |f| f.write("#{Process.pid}") }
       end
-          
+
+      # Get a list of the pid files.
+      #
+      # ==== Returns
+      # Array::
+      #   List of pid file paths. If not clustered, array contains a single path.
+      def pid_files
+        if Merb::Config[:pid_file]
+          if Merb::Config[:cluster]
+            ext = File.extname(Merb::Config[:pid_file])
+            base = File.basename(Merb::Config[:pid_file], ext)
+            dir = File.dirname(Merb::Config[:pid_file])
+            Dir[dir / "#{base}.*#{ext}"]
+          else
+            [ Merb::Config[:pid_file] ]
+          end
+        else
+          Dir[Merb.log_path / "merb.*.pid"]
+        end
+       end      
+      
       # Change privileges of the process to the specified user and group.
       #
       # ==== Parameters
@@ -162,14 +212,14 @@ module Merb
       #
       # ==== Alternatives
       # If group is left out, the user will be used as the group.
-      def change_privilege(user, group=user)
-        
+      def _change_privilege(user, group=user)
+
         puts "Changing privileges to #{user}:#{group}"
-        
+
         uid, gid = Process.euid, Process.egid
         target_uid = Etc.getpwnam(user).uid
         target_gid = Etc.getgrnam(group).gid
-      
+
         if uid != target_uid || gid != target_gid
           # Change process ownership
           Process.initgroups(user, target_gid)
@@ -181,4 +231,4 @@ module Merb
       end
     end
   end
-end
+end

data/lib/merb-core/test/helpers/multipart_request_helper.rb

@@ -101,7 +101,7 @@ module Merb::Test::MultipartRequestHelper
   #     self.stub!(:current_user).and_return(@user)
   #   end
   #
-  # ==== Note
+  # ==== Notes
   # Set your option to contain a file object to simulate file uploads.
   #   
   # Does not use routes.
@@ -124,7 +124,7 @@ module Merb::Test::MultipartRequestHelper
   #   should go here (see +fake_request+).
   # block<Proc>:: The block is executed in the context of the controller.
   #
-  # ==== Note
+  # ==== Notes
   # To include an uploaded file, put a file object as a value in params.
   def multipart_post(path, params = {}, env = {}, &block)
     env[:request_method] = "POST"
@@ -144,7 +144,7 @@ module Merb::Test::MultipartRequestHelper
   #   should go here (see +fake_request+).
   # block<Proc>:: The block is executed in the context of the controller.
   #
-  # ==== Note
+  # ==== Notes
   # To include an uplaoded file, put a file object as a value in params.
   def multipart_put(path, params = {}, env = {}, &block)
     env[:request_method] = "PUT"

data/lib/merb-core/test/helpers/request_helper.rb

@@ -15,7 +15,7 @@ module Merb
           env['rack.input'] = req
           super(DEFAULT_ENV.merge(env))
         end
-    
+
         private
         DEFAULT_ENV = Mash.new({
           'SERVER_NAME' => 'localhost',
@@ -38,7 +38,7 @@ module Merb
           'GATEWAY_INTERFACE' => 'CGI/1.2',
           'HTTP_ACCEPT' => 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5',
           'HTTP_CONNECTION' => 'keep-alive',
-          'REQUEST_METHOD' => 'GET'      
+          'REQUEST_METHOD' => 'GET'
         }) unless defined?(DEFAULT_ENV)
       end
 
@@ -50,11 +50,11 @@ module Merb
       # :post_body<String>:: The post body for the request.
       # :req<String>::
       #   The request string. This will only be used if :post_body is left out.
-      # 
+      #
       # ==== Returns
       # FakeRequest:: A Request object that is built based on the parameters.
       #
-      # ==== Note
+      # ==== Notes
       # If you pass a post body, the content-type will be set to URL-encoded.
       #
       #---
@@ -66,7 +66,7 @@ module Merb
         else
           req = opt[:req]
         end
-        FakeRequest.new(env, StringIO.new(req || '')) 
+        FakeRequest.new(env, StringIO.new(req || ''))
       end
 
       # Dispatches an action to the given class. This bypasses the router and is
@@ -91,7 +91,7 @@ module Merb
       #     self.stub!(:current_user).and_return(@user)
       #   end
       #
-      # ==== Note
+      # ==== Notes
       # Does not use routes.
       #
       #---
@@ -104,7 +104,47 @@ module Merb
 
         dispatch_request(request, controller_klass, action, &blk)
       end
-  
+
+
+      # Dispatches an action to the given class and using HTTP Basic Authentication
+      # This bypasses the router and is suitable for unit testing of controllers.
+      #
+      # ==== Parameters
+      # controller_klass<Controller>::
+      #   The controller class object that the action should be dispatched to.
+      # action<Symbol>:: The action name, as a symbol.
+      # username<String>:: The username.
+      # password<String>:: The password.
+      # params<Hash>::
+      #   An optional hash that will end up as params in the controller instance.
+      # env<Hash>::
+      #   An optional hash that is passed to the fake request. Any request options
+      #   should go here (see +fake_request+), including :req or :post_body
+      #   for setting the request body itself.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
+      #
+      # ==== Example
+      #   dispatch_with_basic_authentication_to(MyController, :create, 'Fred', 'secret', :name => 'Homer' ) do
+      #     self.stub!(:current_user).and_return(@user)
+      #   end
+      #
+      # ==== Notes
+      # Does not use routes.
+      #
+      #---
+      # @public
+      def dispatch_with_basic_authentication_to(controller_klass, action, username, password, params = {}, env = {}, &blk)
+        action = action.to_s
+        request_body = { :post_body => env[:post_body], :req => env[:req] }
+        env["X_HTTP_AUTHORIZATION"] = "Basic #{Base64.encode64("#{username}:#{password}")}"
+        request = fake_request(env.merge(
+          :query_string => Merb::Request.params_to_query_string(params)), request_body)
+
+        dispatch_request(request, controller_klass, action, &blk)
+      end
+
       # An HTTP GET request that operates through the router.
       #
       # ==== Parameters
@@ -114,12 +154,14 @@ module Merb
       # env<Hash>::
       #   An optional hash that is passed to the fake request. Any request options
       #   should go here (see +fake_request+).
-      # &block:: The block is executed in the context of the controller.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       def get(path, params = {}, env = {}, &block)
         env[:request_method] = "GET"
         request(path, params, env, &block)
       end
-  
+
       # An HTTP POST request that operates through the router.
       #
       # ==== Parameters
@@ -129,12 +171,14 @@ module Merb
       # env<Hash>::
       #   An optional hash that is passed to the fake request. Any request options
       #   should go here (see fake_request).
-      # &block:: The block is executed in the context of the controller.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       def post(path, params = {}, env = {}, &block)
         env[:request_method] = "POST"
         request(path, params, env, &block)
       end
-  
+
       # An HTTP PUT request that operates through the router.
       #
       # ==== Parameters
@@ -144,12 +188,14 @@ module Merb
       # env<Hash>::
       #   An optional hash that is passed to the fake request. Any request options
       #   should go here (see fake_request).
-      # &block:: The block is executed in the context of the controller.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       def put(path, params = {}, env = {}, &block)
         env[:request_method] = "PUT"
         request(path, params, env, &block)
       end
-  
+
       # An HTTP DELETE request that operates through the router
       #
       # ==== Parameters
@@ -159,7 +205,9 @@ module Merb
       # env<Hash>::
       #   An optional hash that is passed to the fake request. Any request options
       #   should go here (see fake_request).
-      # &block:: The block is executed in the context of the controller.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       def delete(path, params = {}, env = {}, &block)
         env[:request_method] = "DELETE"
         request(path, params, env, &block)
@@ -175,48 +223,54 @@ module Merb
       # env<Hash>::
       #   An optional hash that is passed to the fake request. Any request options
       #   should go here (see +fake_request+).
-      # blk<Proc>:: The block is executed in the context of the controller.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       #
       # ==== Example
-      #   request(path, :create, :name => 'Homer' ) do
+      #   request(path, { :name => 'Homer' }, { :request_method => "PUT" }) do
       #     self.stub!(:current_user).and_return(@user)
       #   end
       #
-      # ==== Note
+      # ==== Notes
       # Uses Routes.
       #
       #---
-      # @semi-public  
+      # @semi-public
       def request(path, params = {}, env= {}, &block)
         env[:request_method] ||= "GET"
         env[:request_uri] = path
         multipart = env.delete(:test_with_multipart)
-    
+
         request = fake_request(env)
-    
+
         opts = check_request_for_route(request) # Check that the request will be routed correctly
-        klass = Object.full_const_get(opts.delete(:controller).to_const_string)
+        controller_name = (opts[:namespace] ? opts.delete(:namespace) + '/' : '') + opts.delete(:controller)
+        klass = Object.full_const_get(controller_name.snake_case.to_const_string)
+        
         action = opts.delete(:action).to_s
         params.merge!(opts)
-  
+
         multipart.nil? ? dispatch_to(klass, action, params, env, &block) : dispatch_multipart_to(klass, action, params, env, &block)
       end
 
 
       # The workhorse for the dispatch*to helpers.
-      # 
+      #
       # ==== Parameters
       # request<Merb::Test::FakeRequest, Merb::Request>::
       #   A request object that has been setup for testing.
       # controller_klass<Merb::Controller>::
       #   The class object off the controller to dispatch the action to.
       # action<Symbol>:: The action to dispatch the request to.
-      # blk<Proc>:: The block will execute in the context of the controller itself.
+      # &blk::
+      #   The controller is yielded to the block provided for actions *prior* to
+      #   the action being dispatched.
       #
       # ==== Returns
       # An instance of +controller_klass+ based on the parameters.
       #
-      # ==== Note
+      # ==== Notes
       # Does not use routes.
       #
       #---
@@ -233,7 +287,7 @@ module Merb
       end
 
       # Checks to see that a request is routable.
-      # 
+      #
       # ==== Parameters
       # request<Merb::Test::FakeRequest, Merb::Request>::
       #   The request object to inspect.
@@ -254,4 +308,4 @@ module Merb
       end
     end
   end
-end
+end