wycats-merb-core 0.9.8 → 0.9.9

data/lib/merb-core/dispatch/router/route.rb

@@ -12,10 +12,9 @@ module Merb
 
       attr_reader :conditions, :params, :segments
       attr_reader :index, :variables, :name
-      attr_reader :redirect_status, :redirect_url
       attr_accessor :fixation
 
-      def initialize(conditions, params, options = {}, &conditional_block)
+      def initialize(conditions, params, deferred_procs, options = {})
         @conditions, @params = conditions, params
 
         if options[:redirects]
@@ -25,10 +24,12 @@ module Merb
           @defaults          = {}
         else
           @defaults          = options[:defaults] || {}
-          @conditional_block = conditional_block
         end
+        
+        # @conditional_block = conditional_block
 
         @identifiers       = options[:identifiers]
+        @deferred_procs    = deferred_procs
         @segments          = []
         @symbol_conditions = {}
         @placeholders      = {}
@@ -42,10 +43,6 @@ module Merb
       def allow_fixation?
         @fixation
       end
-
-      def redirects?
-        @redirects
-      end
       
       def to_s
         regexp? ?
@@ -55,30 +52,75 @@ module Merb
       
       alias_method :inspect, :to_s
 
+      # Appends self to Merb::Router.routes
       def register
         @index = Merb::Router.routes.size
         Merb::Router.routes << self
         self
       end
       
+      # Inserts self to Merb::Router.routes at the specified index.
+      def register_at(index)
+        @index = index
+        Merb::Router.routes.insert(index, self)
+        self
+      end
+      
+      # Sets the route as a resource route with the given key as the 
+      # lookup key.
+      def resource=(key)
+        Router.resource_routes[key] = self
+        key
+      end
+      
       def name=(name)
         @name = name.to_sym
         Router.named_routes[@name] = self
         @name
       end
       
-      # === Compiled method ===
+      # Generates the URL for the route given the passed arguments. The
+      # method will first match the anonymous parameters to route params
+      # and will convert all the parameters according to the specifed
+      # object identifiers.
+      #
+      # Then the named parameters are passed to a compiled generation proc.
+      #
+      # ==== Parameters
+      # args<Array>::
+      #   The arguments passed to the public #url method with the name
+      #   of the route removed. This is an array of the anonymous parameters
+      #   followed by a hash containing the named parameters.
+      #
+      # defaults<Hash>::
+      #   A hash of parameters to use to generate the route if there are
+      #   any missing required parameters. This is usually the parameters
+      #   for the current request
+      #
+      # ==== Returns
+      # String:: The generated URL.
       def generate(args = [], defaults = {})
         raise GenerationError, "Cannot generate regexp Routes" if regexp?
         
         params = extract_options_from_args!(args) || { }
         
+        params.each do |k, v|
+          params[k] = identify(v, k)
+        end
+        
         # Support for anonymous params
         unless args.empty?
-          raise GenerationError, "The route has #{@variables.length} variables: #{@variables.inspect}" if args.length > @variables.length
+          # First, let's determine which variables are missing
+          variables = @variables - params.keys
           
-          args.each_with_index do |param, i|
-            params[@variables[i]] ||= param
+          args.each do |param|
+            raise GenerationError, "The route has #{@variables.length} variables: #{@variables.inspect}" if variables.empty?
+            
+            if identifier = identifier_for(param) and identifier.is_a?(Array)
+              identifier.each { |ident| params[variables.shift] = param.send(ident) }
+            else
+              params[variables.shift] ||= identify(param)
+            end
           end
         end
         
@@ -86,13 +128,63 @@ module Merb
         uri = Merb::Config[:path_prefix] + uri if Merb::Config[:path_prefix]
         uri
       end
+      
+      # Identifies the object according to the identifiers set while building
+      # the routes. Identifying an object means picking an instance method to
+      # call on the object that will return a string representation of the
+      # object for the route being generated. If the identifier is an array,
+      # then a param_key must be present and match one of the elements of the
+      # identifier array.
+      #
+      # param_keys that end in _id are treated slightly differently in order
+      # to get nested resources to work correctly.
+      def identify(obj, param_key = nil)
+        identifier = identifier_for(obj)
+        if identifier.is_a?(Array)
+          # First check if the param_key exists as an identifier
+          return obj.send(param_key) if identifier.include?(param_key)
+          # If the param_key ends in _id, just return the object id
+          return obj.id if "#{param_key}" =~ /_id$/
+          # Otherwise, raise an error
+          raise GenerationError, "The object #{obj.inspect} cannot be identified with #{identifier.inspect} for #{param_key}"
+        else
+          identifier ? obj.send(identifier) : obj
+        end
+      end
+      
+      # Returns the identifier for the passed object. Built in core ruby classes are
+      # always identified with to_s. The method will return nil in that case (since
+      # to_s is the default for objects that do not have identifiers.)
+      def identifier_for(obj)
+        return if obj.is_a?(String)    || obj.is_a?(Symbol)     || obj.is_a?(Numeric)  ||
+                  obj.is_a?(TrueClass) || obj.is_a?(FalseClass) || obj.is_a?(NilClass) ||
+                  obj.is_a?(Array)     || obj.is_a?(Hash)
+        
+        @identifiers.each do |klass, identifier|
+          return identifier if obj.is_a?(klass)
+        end
+        
+        return nil
+      end
 
+      # Returns the if statement and return value for for the main
+      # Router.match compiled method.
       def compiled_statement(first)
         els_if = first ? '  if ' : '  elsif '
 
         code = ""
         code << els_if << condition_statements.join(" && ") << "\n"
-        if @conditional_block
+        
+        # First, we need to always return the value of the
+        # deferred block if it explicitly matched the route
+        if @redirects && @deferred_procs.any?
+          code << "    return [#{@index.inspect}, block_result] if request.matched?" << "\n" 
+          code << "    request.redirects!" << "\n"
+          code << "    [#{@index.inspect}, { :url => #{@redirect_url.inspect}, :status => #{@redirect_status.inspect} }]" << "\n"
+        elsif @redirects
+          code << "    request.redirects!" << "\n"
+          code << "    [#{@index.inspect}, { :url => #{@redirect_url.inspect}, :status => #{@redirect_status.inspect} }]" << "\n"
+        elsif @deferred_procs.any?
           code << "    [#{@index.inspect}, block_result]" << "\n"
         else
           code << "    [#{@index.inspect}, #{params_as_string}]" << "\n"
@@ -233,7 +325,7 @@ module Merb
           segments.each_with_index do |segment, i|
             bits << case
               when segment.is_a?(String) then segment
-              when segment.is_a?(Symbol) then '#{param_for_route(cached_' + segment.to_s + ')}'
+              when segment.is_a?(Symbol) then '#{cached_' + segment.to_s + '}'
               when segment.is_a?(Array) && segment.any? { |s| !s.is_a?(String) } then "\#{#{@opt_segment_stack.last.shift}}"
               else ""
             end
@@ -242,16 +334,6 @@ module Merb
           bits
         end
         
-        def param_for_route(param)
-          case param
-            when String, Symbol, Numeric, TrueClass, FalseClass, NilClass
-              param
-            else
-              _, identifier = @identifiers.find { |klass, _| param.is_a?(klass) }
-              identifier ? param.send(identifier) : param
-          end
-        end
-        
       end
 
     # === Conditions ===
@@ -300,7 +382,11 @@ module Merb
           end
         end
         
-        @variables = @segments.flatten.select { |s| s.is_a?(Symbol)  }
+        unless regexp?
+          @variables = @segments.flatten.select { |s| s.is_a?(Symbol)  }
+          compiled.gsub!(%r[/+], '/')
+          compiled.gsub!(%r[(.+)/$], '\1')
+        end
 
         compiled
       end
@@ -441,6 +527,7 @@ module Merb
       def condition_statements
         statements = []
 
+        # First, let's build the conditions for the regular 
         conditions.each_pair do |key, value|
           statements << case value
           when Regexp
@@ -460,13 +547,40 @@ module Merb
             %{(cached_#{key} == #{value.inspect})}
           end
         end
-
-        if @conditional_block
-          statements << "(block_result = #{CachedProc.new(@conditional_block)}.call(request, #{params_as_string}))"
+        
+        # The first one is special, so let's extract it
+        if first = @deferred_procs.first
+          deferred = ""
+          deferred << "(block_result = "
+          deferred <<   "request._process_block_return("
+          deferred <<     "#{first}.call(request, #{params_as_string})"
+          deferred <<   ")"
+          deferred << ")"
+          
+          # Let's build the rest of them now
+          if @deferred_procs.length > 1
+            deferred << deferred_condition_statement(@deferred_procs[1..-1])
+          end
+          
+          statements << deferred
         end
 
         statements
       end
+      
+      # (request.matched? || ((block_result = process(proc.call))))
+      def deferred_condition_statement(deferred)
+        if current = deferred.first
+          html  = " && (request.matched? || ("
+          html <<   "(block_result = "
+          html <<     "request._process_block_return("
+          html <<       "#{current}.call(request, block_result)"
+          html <<     ")"
+          html <<   ")"
+          html <<   "#{deferred_condition_statement(deferred[1..-1])}"
+          html << "))"
+        end
+      end
 
       def params_as_string
         elements = params.keys.map do |k|

data/lib/merb-core/logger.rb

@@ -1,203 +1,214 @@
-Merb::Logger = Extlib::Logger
+# Merb::Logger = Extlib::Logger
+
+class Merb::Logger < Extlib::Logger
+  def verbose!(message, level = :warn)
+    send("#{level}!", message) if Merb::Config[:verbose]
+  end
+
+  def verbose(message, level = :warn)
+    send(level, message) if Merb::Config[:verbose]
+  end
+end
+
 # require "time" # httpdate
-# # ==== Public Merb Logger API
-# #
-# # To replace an existing logger with a new one:
-# #  Merb::Logger.set_log(log{String, IO},level{Symbol, String})
-# #
-# # Available logging levels are
-# #   Merb::Logger::{ Fatal, Error, Warn, Info, Debug }
-# #
-# # Logging via:
-# #   Merb.logger.fatal(message<String>,&block)
-# #   Merb.logger.error(message<String>,&block)
-# #   Merb.logger.warn(message<String>,&block)
-# #   Merb.logger.info(message<String>,&block)
-# #   Merb.logger.debug(message<String>,&block)
-# #
-# # Logging with autoflush:
-# #   Merb.logger.fatal!(message<String>,&block)
-# #   Merb.logger.error!(message<String>,&block)
-# #   Merb.logger.warn!(message<String>,&block)
-# #   Merb.logger.info!(message<String>,&block)
-# #   Merb.logger.debug!(message<String>,&block)
-# #
-# # Flush the buffer to 
-# #   Merb.logger.flush
-# #
-# # Remove the current log object
-# #   Merb.logger.close
-# # 
-# # ==== Private Merb Logger API
-# # 
-# # To initialize the logger you create a new object, proxies to set_log.
-# #   Merb::Logger.new(log{String, IO},level{Symbol, String})
-# module Merb
-# 
-#   class << self
-#     attr_accessor :logger
-#   end
-# 
-#   class Logger
-# 
-#     attr_accessor :level
-#     attr_accessor :delimiter
-#     attr_accessor :auto_flush
-#     attr_reader   :buffer
-#     attr_reader   :log
-#     attr_reader   :init_args
-# 
-#     # ==== Notes
-#     # Ruby (standard) logger levels:
-#     # :fatal:: An unhandleable error that results in a program crash
-#     # :error:: A handleable error condition
-#     # :warn:: A warning
-#     # :info:: generic (useful) information about system operation
-#     # :debug:: low-level information for developers
-#     Levels = 
-#     {
-#       :fatal => 7, 
-#       :error => 6, 
-#       :warn  => 4,
-#       :info  => 3,
-#       :debug => 0
-#     } unless const_defined?(:Levels)
-# 
-#     private
-# 
-#     # Readies a log for writing.
-#     #
-#     # ==== Parameters
-#     # log<IO, String>:: Either an IO object or a name of a logfile.
-#     def initialize_log(log)
-#       close if @log # be sure that we don't leave open files laying around.
-# 
-#       if log.respond_to?(:write)
-#         @log = log
-#       elsif File.exist?(log)
-#         @log = open(log, (File::WRONLY | File::APPEND))
-#         @log.sync = true
-#       else
-#         FileUtils.mkdir_p(File.dirname(log)) unless File.directory?(File.dirname(log))
-#         @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
-#         @log.sync = true
-#         @log.write("#{Time.now.httpdate} #{delimiter} info #{delimiter} Logfile created\n")
-#       end
-#     end
-# 
-#     public
-# 
-#     # To initialize the logger you create a new object, proxies to set_log.
-#     #
-#     # ==== Parameters
-#     # *args:: Arguments to create the log from. See set_logs for specifics.
-#     def initialize(*args)
-#       @init_args = args
-#       set_log(*args)
-#     end
-# 
-#     # Replaces an existing logger with a new one.
-#     # 
-#     # ==== Parameters
-#     # log<IO, String>:: Either an IO object or a name of a logfile.
-#     # log_level<~to_sym>::
-#     #   The log level from, e.g. :fatal or :info. Defaults to :error in the
-#     #   production environment and :debug otherwise.
-#     # delimiter<String>::
-#     #   Delimiter to use between message sections. Defaults to " ~ ".
-#     # auto_flush<Boolean>::
-#     #   Whether the log should automatically flush after new messages are
-#     #   added. Defaults to false.
-#     def set_log(log, log_level = nil, delimiter = " ~ ", auto_flush = false)
-#       if log_level && Levels[log_level.to_sym]
-#         @level = Levels[log_level.to_sym]
-#       elsif Merb.environment == "production"
-#         @level = Levels[:warn]
-#       else
-#         @level = Levels[:debug]
-#       end
-#       @buffer     = []
-#       @delimiter  = delimiter
-#       @auto_flush = auto_flush
-# 
-#       initialize_log(log)
-# 
-#       Merb.logger = self
-#     end
-# 
-#     # Flush the entire buffer to the log object.
-#     def flush
-#       return unless @buffer.size > 0
-#       @log.write(@buffer.slice!(0..-1).to_s)
-#     end
-# 
-#     # Close and remove the current log object.
-#     def close
-#       flush
-#       @log.close if @log.respond_to?(:close) && !@log.tty?
-#       @log = nil
-#     end
-# 
-#     # Appends a message to the log. The methods yield to an optional block and
-#     # the output of this block will be appended to the message.
-#     #
-#     # ==== Parameters
-#     # string<String>:: The message to be logged. Defaults to nil.
-#     #
-#     # ==== Returns
-#     # String:: The resulting message added to the log file.
-#     def <<(string = nil)
-#       message = ""
-#       message << delimiter
-#       message << string if string
-#       message << "\n" unless message[-1] == ?\n
-#       @buffer << message
-#       flush if @auto_flush
-# 
-#       message
-#     end
-#     alias :push :<<
-# 
-#     # Generate the logging methods for Merb.logger for each log level.
-#     Levels.each_pair do |name, number|
-#       class_eval <<-LEVELMETHODS, __FILE__, __LINE__
-# 
-#       # Appends a message to the log if the log level is at least as high as
-#       # the log level of the logger.
-#       #
-#       # ==== Parameters
-#       # string<String>:: The message to be logged. Defaults to nil.
-#       #
-#       # ==== Returns
-#       # self:: The logger object for chaining.
-#       def #{name}(message = nil)
-#         self << message if #{number} >= level
-#         self
-#       end
-# 
-#       # Appends a message to the log if the log level is at least as high as
-#       # the log level of the logger. The bang! version of the method also auto
-#       # flushes the log buffer to disk.
-#       #
-#       # ==== Parameters
-#       # string<String>:: The message to be logged. Defaults to nil.
-#       #
-#       # ==== Returns
-#       # self:: The logger object for chaining.
-#       def #{name}!(message = nil)
-#         self << message if #{number} >= level
-#         flush if #{number} >= level
-#         self
-#       end
-# 
-#       # ==== Returns
-#       # Boolean:: True if this level will be logged by this logger.
-#       def #{name}?
-#         #{number} >= level
-#       end
-#       LEVELMETHODS
-#     end
-# 
-#   end
-#   
-# end
+# ==== Public Merb Logger API
+#
+# To replace an existing logger with a new one:
+#  Merb::Logger.set_log(log{String, IO},level{Symbol, String})
+#
+# Available logging levels are
+#   Merb::Logger::{ Fatal, Error, Warn, Info, Debug }
+#
+# Logging via:
+#   Merb.logger.fatal(message<String>,&block)
+#   Merb.logger.error(message<String>,&block)
+#   Merb.logger.warn(message<String>,&block)
+#   Merb.logger.info(message<String>,&block)
+#   Merb.logger.debug(message<String>,&block)
+#
+# Logging with autoflush:
+#   Merb.logger.fatal!(message<String>,&block)
+#   Merb.logger.error!(message<String>,&block)
+#   Merb.logger.warn!(message<String>,&block)
+#   Merb.logger.info!(message<String>,&block)
+#   Merb.logger.debug!(message<String>,&block)
+#
+# Flush the buffer to
+#   Merb.logger.flush
+#
+# Remove the current log object
+#   Merb.logger.close
+#
+# ==== Private Merb Logger API
+#
+# To initialize the logger you create a new object, proxies to set_log.
+#   Merb::Logger.new(log{String, IO},level{Symbol, String})
+module Merb
+
+  class Logger
+
+    attr_accessor :level
+    attr_accessor :delimiter
+    attr_accessor :auto_flush
+    attr_reader   :buffer
+    attr_reader   :log
+    attr_reader   :init_args
+
+    # ==== Notes
+    # Ruby (standard) logger levels:
+    # :fatal:: An unhandleable error that results in a program crash
+    # :error:: A handleable error condition
+    # :warn:: A warning
+    # :info:: generic (useful) information about system operation
+    # :debug:: low-level information for developers
+    Levels = Mash.new({
+      :fatal => 7,
+      :error => 6,
+      :warn  => 4,
+      :info  => 3,
+      :debug => 0
+    }) unless const_defined?(:Levels)
+
+    @@mutex = {}
+
+    private
+
+    # Readies a log for writing.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    def initialize_log(log)
+      close if @log # be sure that we don't leave open files laying around.
+
+      if log.respond_to?(:write)
+        @log = log
+      elsif File.exist?(log)
+        @log = open(log, (File::WRONLY | File::APPEND))
+        @log.sync = true
+      else
+        FileUtils.mkdir_p(File.dirname(log)) unless File.directory?(File.dirname(log))
+        @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
+        @log.sync = true
+        @log.write("#{Time.now.httpdate} #{delimiter} info #{delimiter} Logfile created\n")
+      end
+    end
+
+    public
+
+    # To initialize the logger you create a new object, proxies to set_log.
+    #
+    # ==== Parameters
+    # *args:: Arguments to create the log from. See set_logs for specifics.
+    def initialize(*args)
+      set_log(*args)
+    end
+
+    # Replaces an existing logger with a new one.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    # log_level<~to_sym>::
+    #   The log level from, e.g. :fatal or :info. Defaults to :error in the
+    #   production environment and :debug otherwise.
+    # delimiter<String>::
+    #   Delimiter to use between message sections. Defaults to " ~ ".
+    # auto_flush<Boolean>::
+    #   Whether the log should automatically flush after new messages are
+    #   added. Defaults to false.
+    def set_log(stream = Merb::Config[:log_stream],
+      log_level = Merb::Config[:log_level],
+      delimiter = Merb::Config[:log_delimiter],
+      auto_flush = Merb::Config[:log_auto_flush])
+
+      @buffer                   = []
+      @delimiter                = delimiter
+      @auto_flush               = auto_flush
+
+      if Levels[log_level]
+        @level                  = Levels[log_level]
+      else
+        @level                  = log_level
+      end
+
+      @log                      = stream
+      @mutex = (@@mutex[@log] ||= Mutex.new)
+    end
+
+    # Flush the entire buffer to the log object.
+    def flush
+      return unless @buffer.size > 0
+      @mutex.synchronize do
+        @log.write(@buffer.slice!(0..-1).to_s)
+      end
+    end
+
+    # Close and remove the current log object.
+    def close
+      flush
+      @log.close if @log.respond_to?(:close) && !@log.tty?
+      @log = nil
+    end
+
+    # Appends a message to the log. The methods yield to an optional block and
+    # the output of this block will be appended to the message.
+    #
+    # ==== Parameters
+    # string<String>:: The message to be logged. Defaults to nil.
+    #
+    # ==== Returns
+    # String:: The resulting message added to the log file.
+    def <<(string = nil)
+      message = ""
+      message << delimiter
+      message << string if string
+      message << "\n" unless message[-1] == ?\n
+      @buffer << message
+      flush if @auto_flush
+
+      message
+    end
+    alias :push :<<
+
+    # Generate the logging methods for Merb.logger for each log level.
+    Levels.each_pair do |name, number|
+      class_eval <<-LEVELMETHODS, __FILE__, __LINE__
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}(message = nil)
+        self << message if #{number} >= level
+        self
+      end
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger. The bang! version of the method also auto
+      # flushes the log buffer to disk.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}!(message = nil)
+        self << message if #{number} >= level
+        flush if #{number} >= level
+        self
+      end
+
+      # ==== Returns
+      # Boolean:: True if this level will be logged by this logger.
+      def #{name}?
+        #{number} >= level
+      end
+      LEVELMETHODS
+    end
+
+  end
+
+end