merb-core 0.9.2 → 0.9.3

data/lib/merb-core/core_ext/kernel.rb

@@ -9,7 +9,7 @@ module Kernel
   def dependency(name, *ver)
     Merb::BootLoader::Dependencies.dependencies << [name, ver]
   end
-  
+
   # Loads the given string as a gem.
   #
   # ==== Parameters
@@ -28,21 +28,21 @@ module Kernel
     try_framework = Merb.frozen?
     begin
       # If this is a piece of merb, and we're frozen, try to require
-      # first, so we can pick it up from framework/, 
+      # first, so we can pick it up from framework/,
       # otherwise try activating the gem
       if name =~ /^merb/ && try_framework
         require name
       else
         gem(name, *ver) if ver
         require name
-        Merb.logger.info!("loading gem '#{name}' from #{__app_file_trace__.first} ...")
+        Merb.logger.info!("loading gem '#{name}' ...")
       end
     rescue LoadError
       if try_framework
         try_framework = false
         retry
       else
-        Merb.logger.info!("loading gem '#{name}' from #{__app_file_trace__.first} ...")
+        Merb.logger.info!("loading gem '#{name}' ...")
         # Failed requiring as a gem, let's try loading with a normal require.
         require name
       end
@@ -63,7 +63,7 @@ module Kernel
       end
     end
   end
-  
+
   # Loads both gem and library dependencies that are passed in as arguments.
   #
   # ==== Parameters
@@ -89,7 +89,7 @@ module Kernel
       end
     end
   end
-  
+
   # Does a basic require, and prints a message if an error occurs.
   #
   # ==== Parameters
@@ -100,7 +100,7 @@ module Kernel
   rescue LoadError, RuntimeError
     Merb.logger.error!(message) if message
   end
-  
+
   # Used in Merb.root/config/init.rb to tell Merb which ORM (Object Relational
   # Mapper) you wish to use. Currently Merb has plugins to support
   # ActiveRecord, DataMapper, and Sequel.
@@ -115,20 +115,46 @@ module Kernel
   #   # This will use the DataMapper generator for your ORM
   #   $ ruby script/generate model MyModel
   def use_orm(orm)
-    if !Merb.generator_scope.include?(:merb_default) && !Merb.generator_scope.include?(orm.to_sym)
-      raise "Don't call use_orm more than once"
-    end
+    raise "Don't call use_orm more than once" if registred_orm?(orm)
+
     begin
       Merb.generator_scope.delete(:merb_default)
-      orm_plugin = orm.to_s.match(/^merb_/) ? orm.to_s : "merb_#{orm}"
-      Merb.generator_scope.unshift(orm.to_sym) unless Merb.generator_scope.include?(orm.to_sym)
+      register_orm(orm)
+      orm_plugin = "merb_#{orm}"
       Kernel.dependency(orm_plugin)
     rescue LoadError => e
       Merb.logger.warn!("The #{orm_plugin} gem was not found.  You may need to install it.")
       raise e
     end
   end
-  
+
+  # Use to check whether given ORM already registred at generator scope
+  #
+  # ==== Parameters
+  # orm<~to_sym>::
+  #   ORM alias, like :activerecord, :datamapper or :sequel.
+  #
+  # ==== Returns
+  # Boolean::
+  #   true if ORM is already registred, false otherwise
+  #
+  #--
+  # @semi-public
+  def registred_orm?(orm)
+    !Merb.generator_scope.include?(:merb_default) && !Merb.generator_scope.include?(orm.to_sym)
+  end
+
+  # Registers ORM at generator scope.
+  #
+  # ==== Parameters
+  # orm<~to_sym>::
+  #   ORM alias, like :activerecord, :datamapper or :sequel.
+  #--
+  # @private
+  def register_orm(orm)
+    Merb.generator_scope.unshift(orm.to_sym) unless Merb.generator_scope.include?(orm.to_sym)
+  end
+
   # Used in Merb.root/config/init.rb to tell Merb which testing framework to
   # use. Currently Merb has plugins to support RSpec and Test::Unit.
   #
@@ -143,24 +169,35 @@ module Kernel
   #   # This will now use the RSpec generator for tests
   #   $ ruby script/generate controller MyController
   def use_test(test_framework, *test_dependencies)
-    raise "use_test only supports :rspec and :test_unit currently" unless 
-      [:rspec, :test_unit].include?(test_framework.to_sym)
+    raise "use_test only supports :rspec and :test_unit currently" unless supported_test_framework?(test_framework)
+    register_test_framework(test_framework)
+
+    dependencies test_dependencies if Merb.env == "test" || Merb.env.nil?
+  end
+
+  # Check whether Merb supports test framework. Currently Merb has plugins to support RSpec and Test::Unit.
+  #
+  # ==== Parameters
+  # test_framework<Symbol>::
+  #   The test framework to check. Currently only supports :rspec and :test_unit.
+  #--
+  # @semi-public
+  def supported_test_framework?(test_framework)
+    [:rspec, :test_unit].include?(test_framework.to_sym)
+  end
+
+  # Register test framework at generator scope. Currently Merb has plugins to support RSpec and Test::Unit.
+  #
+  # ==== Parameters
+  # test_framework<Symbol>::
+  #   The test framework to check. Currently only supports :rspec and :test_unit but the check is performed before registration if you use API.
+  #--
+  # @private
+  def register_test_framework(test_framework)
     Merb.generator_scope.delete(:rspec)
     Merb.generator_scope.delete(:test_unit)
+
     Merb.generator_scope.push(test_framework.to_sym)
-    
-    dependencies test_dependencies if Merb.env == "test" || Merb.env.nil?
-  end
-  
-  # ==== Returns
-  # Array[String]:: A stack trace of the applications files.
-  def __app_file_trace__
-    caller.select do |call| 
-      call.include?(Merb.root) && !call.include?(Merb.root + "/framework")
-    end.map do |call|
-      file, line = call.scan(Regexp.new("#{Merb.root}/(.*):(.*)")).first
-      "#{file}:#{line}"
-    end
   end
 
   # ==== Parameters
@@ -219,9 +256,9 @@ module Kernel
 
     area
   end
-  
-  # Takes a block, profiles the results of running the block 100 times and
-  # writes out the results in a file.
+
+  # Takes a block, profiles the results of running the block
+  # specified number of times and generates HTML report.
   #
   # ==== Parameters
   # name<~to_s>::
@@ -244,8 +281,8 @@ module Kernel
   #   end
   #
   # Assuming that the total time taken for #puts calls was less than 5% of the
-  # total time to run, #puts won't appear in the profile report. 
-  # The code block will be run 30 times.
+  # total time to run, #puts won't appear in the profile report.
+  # The code block will be run 30 times in the example above.
   def __profile__(name, min=1, iter=100)
     require 'ruby-prof' unless defined?(RubyProf)
     return_result = ''
@@ -259,8 +296,8 @@ module Kernel
                           :print_file => true})
     end
     return_result
-  end  
-  
+  end
+
   # Extracts an options hash if it is the last item in the args array. Used
   # internally in methods that take *args.
   #
@@ -275,7 +312,7 @@ module Kernel
   def extract_options_from_args!(args)
     args.pop if Hash === args.last
   end
-  
+
   # Checks that the given objects quack like the given conditions.
   #
   # ==== Parameters
@@ -290,13 +327,13 @@ module Kernel
       raise ArgumentError, "#{k.inspect} doesn't quack like #{v.inspect}" unless k.quacks_like?(v)
     end
   end
-  
+
   unless Kernel.respond_to?(:debugger)
 
     # Define debugger method so that code even works if debugger was not
     # requested. Drops a note to the logs that Debugger was not available.
     def debugger
-       Merb.logger.info! "\n***** Debugger requested, but was not " + 
+       Merb.logger.info! "\n***** Debugger requested, but was not " +
                         "available: Start server with --debugger " +
                         "to enable *****\n"
     end

data/lib/merb-core/core_ext/mash.rb

@@ -9,7 +9,7 @@ class Mash < Hash
   # ==== Alternatives
   # If constructor is a Hash, a new mash will be created based on the keys of
   # the hash and no default value will be set.
-  def initialize(constructor = {}) 
+  def initialize(constructor = {})
     if constructor.is_a?(Hash) 
       super() 
       update(constructor) 
@@ -72,7 +72,7 @@ class Mash < Hash
   alias_method :member?, :key?
 
   # ==== Parameters
-  # key<Object>:: The key to fetch. This willbe run through convert_key.
+  # key<Object>:: The key to fetch. This will be run through convert_key.
   # extras:: Default value.
   #
   # ==== Returns
@@ -83,7 +83,7 @@ class Mash < Hash
 
   # ==== Parameters
   # indices<Array>::
-  #   The keys to retrieve values for. These will be run through convert_key.
+  #   The keys to retrieve values for. These will be run through +convert_key+.
   def values_at(*indices) 
     indices.collect {|key| self[convert_key(key)]} 
   end
@@ -146,7 +146,7 @@ class Mash < Hash
     when Hash 
       value.to_mash 
     when Array 
-      value.collect { |e| e.is_a?(Hash) ? e.to_mash : e } 
+      value.collect { |e| convert_value(e) } 
     else 
       value 
     end 

data/lib/merb-core/core_ext/object.rb

@@ -18,7 +18,7 @@ class Object
   #       puts self
   #     end
   #   end
-  # 
+  #
   #   def String.add_meta_var(var)
   #     self.meta_class.instance_eval do
   #       define_method var do
@@ -67,7 +67,7 @@ class Object
   #    false.blank?      #=>  true
   #    "".blank?         #=>  true
   #    "     ".blank?    #=>  true
-  #    " hey ho ".blank? #=>  false  
+  #    " hey ho ".blank? #=>  false
   def blank?
     if respond_to?(:empty?) && respond_to?(:strip)
       empty? or strip.empty?
@@ -89,8 +89,9 @@ class Object
     list.each {|x| obj = obj.const_get(x) }
     obj
   end
-  
-  # Makes a module from a string (e.g. Foo::Bar::Baz)
+
+  # Defines module from a string name (e.g. Foo::Bar::Baz)
+  # If method already exists, no exception raised.
   #
   # ==== Parameters
   # name<String>:: The name of the full module name to make
@@ -106,7 +107,7 @@ class Object
       #{ender}
     HERE
   end
-  
+
   # ==== Parameters
   # duck<Symbol, Class, Array>:: The thing to compare the object to.
   #
@@ -132,5 +133,15 @@ class Object
       false
     end
   end
-
-end
+  
+  # ==== Parameters
+  # arrayish<Array>:: Container to check, to see if it includes the object.
+  # more<Objects>:: additional args, will be flattened into arrayish
+  #
+  # ==== Returns
+  # Boolean: True if the object is included in arrayish (+ more)
+  def in?(arrayish,*more)
+    arrayish = more.unshift(arrayish) unless more.empty?
+    arrayish.include?(self)
+  end
+end

data/lib/merb-core/core_ext/set.rb

@@ -1,4 +1,9 @@
 module Merb
+  # Simple set implementation
+  # on top of Hash with mergins support.
+  #
+  # In particular this is used to store
+  # a set of callable actions of controller.
   class SimpleSet < Hash
 
     # ==== Parameters
@@ -33,9 +38,9 @@ module Merb
     def inspect
       "#<SimpleSet: {#{keys.map {|x| x.inspect}.join(", ")}}>"
     end
-  
+
     # def to_a
     alias_method :to_a, :keys
-    
-  end
-end
+
+  end # SimpleSet
+end # Merb

data/lib/merb-core/core_ext/string.rb

@@ -1,25 +1,36 @@
 require "pathname"
 
 class String
-  
-  class InvalidPathConversion < Exception; end
 
   # ==== Returns
   # String:: The string with all regexp special characters escaped.
   #
   # ==== Examples
-  #   "\*?{}.".escape_regexp #=> "\\*\\?\\{\\}\\."
+  #   "*?{}.".escape_regexp #=> "\\*\\?\\{\\}\\."
   def escape_regexp
     Regexp.escape self
   end
-  
+
+  # ==== Returns
+  # String:: The string with all regexp special characters unescaped.
+  #
+  # ==== Examples
+  #   "\\*\\?\\{\\}\\.".unescape_regexp #=> "*?{}."
+  def unescape_regexp
+    self.gsub(/\\([\.\?\|\(\)\[\]\{\}\^\$\*\+\-])/, '\1')
+  end
+
   # ==== Returns
   # String:: The string converted to snake case.
   #
   # ==== Examples
   #   "FooBar".snake_case #=> "foo_bar"
+  #   "HeadlineCNNNews".snake_case #=> "headline_cnn_news"
+  #   "CNN".snake_case #=> "cnn"
   def snake_case
-    gsub(/\B[A-Z]/, '_\&').downcase
+    return self.downcase if self =~ /^[A-Z]+$/
+    self.gsub(/([A-Z]+)(?=[A-Z][a-z]?)|\B[A-Z]/, '_\&') =~ /_*(.*)/
+      return $+.downcase
   end
 
   # ==== Returns
@@ -28,9 +39,10 @@ class String
   # ==== Examples
   #   "foo_bar".camel_case #=> "FooBar"
   def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
     split('_').map{|e| e.capitalize}.join
   end
-  
+
   # ==== Returns
   # String:: The path string converted to a constant name.
   #
@@ -39,7 +51,7 @@ class String
   def to_const_string
     gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
   end
-  
+
   # ==== Returns
   # String::
   #   The path that is associated with the constantized string, assuming a
@@ -62,8 +74,16 @@ class String
   def /(o)
     File.join(self, o.to_s)
   end
-  
+
+  # ==== Parameters ====
+  # other<String>:: Base path to calculate against
+  #
+  # ==== Returns ====
+  # String:: Relative path from between the two
+  #
+  # ==== Example ====
+  # "/opt/local/lib".relative_path_from("/opt/local/lib/ruby/site_ruby") # => "../.."
   def relative_path_from(other)
     Pathname.new(self).relative_path_from(Pathname.new(other)).to_s
   end
-end
+end

data/lib/merb-core/core_ext/time.rb

@@ -0,0 +1,13 @@
+class Time
+  
+  # ==== Returns
+  # String::
+  #   ISO 8601 compatible rendering of the Time object's properties.
+  # 
+  # ==== Examples
+  #   Time.now.to_json # => "\"2008-03-28T17:54:20-05:00\""
+  def to_json
+    self.xmlschema.to_json
+  end
+  
+end

data/lib/merb-core/dispatch/cookies.rb

@@ -69,8 +69,7 @@ module Merb
       Merb.logger.info("Cookie deleted: #{name} => #{cookie.inspect}")
       cookie
     end
-
-    private
+    
     # ==== Parameters
     # name<~to_s>:: Name of the cookie.
     # value<~to_s>:: Value of the cookie.

data/lib/merb-core/dispatch/dispatcher.rb

@@ -35,9 +35,7 @@ class Merb::Dispatcher
       end
       request.route_params = route_params
       request.params.merge! route_params
-      
-      Merb.logger.info("Params: #{request.params.inspect}")
-      
+            
       controller_name = (route_params[:namespace] ? route_params[:namespace] + '/' : '') + route_params[:controller]
       
       unless controller_name
@@ -61,11 +59,19 @@ class Merb::Dispatcher
         raise Merb::ControllerExceptions::NotFound
       end
 
+      Merb.logger.info("Params: #{klass._filter_params(request.params).inspect}")
+
       action = route_params[:action]
 
+      if route_index && route = Merb::Router.routes[route_index]
+        #Fixate the session ID if it is enabled on the route
+        if route.allow_fixation? && request.params.key?(Merb::Controller._session_id_key)
+          request.cookies[Merb::Controller._session_id_key] = request.params[Merb::Controller._session_id_key]
+        end
+      end      
+
       controller = dispatch_action(klass, action, request)
-      controller._benchmarks[:dispatch_time] = Time.now - start
-      controller.route = Merb::Router.routes[route_index] if route_index
+      controller._benchmarks[:dispatch_time] = Time.now - start  
       Merb.logger.info controller._benchmarks.inspect
       Merb.logger.flush
 
@@ -156,9 +162,9 @@ Stacktrace:
         request.params[:original_cookies] = request.cookies.dup rescue {}
         request.params[:exception] = exception
         request.params[:action] = exception_klass.name
-      
-        dispatch_action(klass, exception_klass.name, request, exception.class::STATUS)
-      rescue => dispatch_issue
+        
+        dispatch_action(klass, exception_klass.name, request, exception.class.status)
+      rescue => dispatch_issue       
         dispatch_issue = controller_exception(dispatch_issue)  
         # when no action/template exist for an exception, or an
         # exception occurs on an InternalServerError the message is
@@ -174,7 +180,9 @@ Stacktrace:
             retry
           else
             dispatch_default_exception(klass, request, exception)
-          end
+          end       
+        elsif request.params[:exception].is_a?(dispatch_issue.class)
+          dispatch_default_exception(klass, request, dispatch_issue)
         elsif dispatch_issue.is_a?(Merb::ControllerExceptions::InternalServerError)
           dispatch_default_exception(klass, request, dispatch_issue)
         else
@@ -202,7 +210,7 @@ Stacktrace:
     #   An array containing the Merb::Controller that was dispatched to and the
     #   error's name. For instance, a NotFound error's name is "not_found".
     def dispatch_default_exception(klass, request, e)
-      controller = klass.new(request, e.class::STATUS)
+      controller = klass.new(request, e.class.status)
       if e.is_a? Merb::ControllerExceptions::Redirection
         controller.headers.merge!('Location' => e.message)
         controller.body = %{ } #fix