merb-core 0.9.3 → 0.9.4

data/lib/merb-core/core_ext.rb

@@ -1,13 +1,8 @@
-corelib = File.join(File.dirname(__FILE__), "core_ext")
-
-require "#{corelib}/string"
-require corelib/:time
-require corelib/:class
-require corelib/:hash
-require corelib/:kernel
-require corelib/:mash
-require corelib/:object
-require corelib/:object_space
-require corelib/:rubygems
-require corelib/:set
+begin
+  require "extlib"
+rescue LoadError => e
+  puts "Merb-core 0.9.4 and later uses extlib for Ruby core class extensions. Install it from github.com/sam/extlib."
+  exit
+end
 
+require File.dirname(__FILE__) / "core_ext" / "kernel"

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

@@ -1,29 +1,41 @@
 module Kernel
-  # Loads the given string as a gem. Execution is deferred to
-  # the Merb::BootLoader::Dependencies.run during bootup.
+  # Loads the given string as a gem. Execution is deferred until
+  # after the logger has been instantiated and the framework directory
+  # structure is defined.
   #
+  # If that has already happened, the gem will be activated
+  # immediately.
+  # 
   # ==== Parameters
-  # name<String>:: The name of the gem to load.
-  # *ver<Gem::Requirement, Gem::Version, Array, ~to_str>::
+  # @param name<String> The name of the gem to load.
+  # @param *ver<Gem::Requirement, Gem::Version, Array, #to_str>
   #   Version requirements to be passed to Gem.activate.
+  #
+  # ==== Returns
+  # Array[String, Array[Gem::Requirement, Gem::Version, Array, #to_str]]::
+  #   The name and version information that was passed in.
   def dependency(name, *ver)
-    Merb::BootLoader::Dependencies.dependencies << [name, ver]
+    if Merb::BootLoader.finished?(Merb::BootLoader::Dependencies)
+      load_dependency(name, *ver)
+    else
+      Merb::BootLoader::Dependencies.dependencies << [name, ver]
+    end
+    [name, ver]
   end
 
   # Loads the given string as a gem.
   #
-  # ==== Parameters
-  # name<String>:: The name of the gem to load.
-  # *ver<Gem::Requirement, Gem::Version, Array, ~to_str>::
-  #   Version requirements to be passed to Gem.activate.
-  #
-  # ==== Notes
-  # If the gem cannot be found, the method will attempt to require the string
-  # as a library.
-  #
   # This new version tries to load the file via ROOT/gems first before moving
   # off to the system gems (so if you have a lower version of a gem in
   # ROOT/gems, it'll still get loaded).
+  #
+  # @param name<String> The name of the gem to load.
+  # @param *ver<Gem::Requirement, Gem::Version, Array, #to_str>
+  #   Version requirements to be passed to Gem.activate.
+  #
+  # @note
+  #   If the gem cannot be found, the method will attempt to require the string
+  #   as a library.
   def load_dependency(name, *ver)
     try_framework = Merb.frozen?
     begin
@@ -52,8 +64,7 @@ module Kernel
   # Loads both gem and library dependencies that are passed in as arguments.
   # Execution is deferred to the Merb::BootLoader::Dependencies.run during bootup.
   #
-  # ==== Parameters
-  # *args<String, Hash, Array>:: The dependencies to load.
+  # @param *args<String, Hash, Array> The dependencies to load.
   def dependencies(*args)
     args.each do |arg|
       case arg
@@ -66,20 +77,18 @@ module Kernel
 
   # Loads both gem and library dependencies that are passed in as arguments.
   #
-  # ==== Parameters
-  # *args<String, Hash, Array>:: The dependencies to load.
-  #
-  # ==== Notes
-  # Each argument can be:
-  # String:: Single dependency.
-  # Hash::
-  #   Multiple dependencies where the keys are names and the values versions.
-  # Array:: Multiple string dependencies.
-  #
-  # ==== Examples
-  # dependencies "RedCloth"                 # Loads the the RedCloth gem
-  # dependencies "RedCloth", "merb_helpers" # Loads RedCloth and merb_helpers
-  # dependencies "RedCloth" => "3.0"        # Loads RedCloth 3.0
+  # @param *args<String, Hash, Array> The dependencies to load.
+  #
+  # @note
+  #   Each argument can be:
+  #   String:: Single dependency.
+  #   Hash::
+  #     Multiple dependencies where the keys are names and the values versions.
+  #   Array:: Multiple string dependencies.
+  #
+  # @example dependencies "RedCloth"                 # Loads the the RedCloth gem
+  # @example dependencies "RedCloth", "merb_helpers" # Loads RedCloth and merb_helpers
+  # @example dependencies "RedCloth" => "3.0"        # Loads RedCloth 3.0
   def load_dependencies(*args)
     args.each do |arg|
       case arg
@@ -92,9 +101,8 @@ module Kernel
 
   # Does a basic require, and prints a message if an error occurs.
   #
-  # ==== Parameters
-  # library<~to_s>:: The library to attempt to include.
-  # message<String>:: The error to add to the log upon failure. Defaults to nil.
+  # @param library<to_s> The library to attempt to include.
+  # @param message<String> The error to add to the log upon failure. Defaults to nil.
   def rescue_require(library, message = nil)
     require library
   rescue LoadError, RuntimeError
@@ -105,20 +113,19 @@ module Kernel
   # Mapper) you wish to use. Currently Merb has plugins to support
   # ActiveRecord, DataMapper, and Sequel.
   #
-  # ==== Parameters
-  # orm<~to_s>:: The ORM to use.
+  # @param orm<#to_s> The ORM to use.
   #
-  # ==== Examples
-  #   # This line goes in dependencies.yml
+  # @example
   #   use_orm :datamapper
   #
   #   # This will use the DataMapper generator for your ORM
-  #   $ ruby script/generate model MyModel
+  #   $ merb-gen model ActivityEvent
+  #
+  # @note
+  #   If for some reason this is called more than once, latter
+  #   call takes over other.
   def use_orm(orm)
-    raise "Don't call use_orm more than once" if registred_orm?(orm)
-
     begin
-      Merb.generator_scope.delete(:merb_default)
       register_orm(orm)
       orm_plugin = "merb_#{orm}"
       Kernel.dependency(orm_plugin)
@@ -128,46 +135,28 @@ module Kernel
     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>::
+  # @param orm<#to_sym>
   #   ORM alias, like :activerecord, :datamapper or :sequel.
-  #--
-  # @private
+  #
+  # @api private
   def register_orm(orm)
-    Merb.generator_scope.unshift(orm.to_sym) unless Merb.generator_scope.include?(orm.to_sym)
+    Merb.orm_generator_scope = orm
   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.
   #
-  # ==== Parameters
-  # test_framework<Symbol>::
+  # @param test_framework<Symbol>
   #   The test framework to use. Currently only supports :rspec and :test_unit.
   #
-  # ==== Examples
-  #   # This line goes in dependencies.yml
+  # @example
   #   use_test :rspec
   #
   #   # This will now use the RSpec generator for tests
-  #   $ ruby script/generate controller MyController
+  #   $ merb-gen model ActivityEvent
   def use_test(test_framework, *test_dependencies)
     raise "use_test only supports :rspec and :test_unit currently" unless supported_test_framework?(test_framework)
     register_test_framework(test_framework)
@@ -177,112 +166,117 @@ module Kernel
 
   # Check whether Merb supports test framework. Currently Merb has plugins to support RSpec and Test::Unit.
   #
-  # ==== Parameters
-  # test_framework<Symbol>::
+  # @param test_framework<Symbol>
   #   The test framework to check. Currently only supports :rspec and :test_unit.
-  #--
-  # @semi-public
+  #
+  # @api plugin
   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
+  # @param 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.
+  #
+  # @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)
+    Merb.test_framework_generator_scope = test_framework
   end
 
-  # ==== Parameters
-  # i<Fixnum>:: The caller number. Defaults to 1.
+  # @param i<Fixnum> The caller number. Defaults to 1.
   #
-  # ==== Returns
-  # Array[Array]:: The file, line and method of the caller.
+  # @return <Array[Array]> The file, line and method of the caller.
   #
-  # ==== Examples
+  # @example
   #   __caller_info__(1)
   #     # => ['/usr/lib/ruby/1.8/irb/workspace.rb', '52', 'irb_binding']
   def __caller_info__(i = 1)
     file, line, meth = caller[i].scan(/(.*?):(\d+):in `(.*?)'/).first
   end
 
-  # ==== Parameters
-  # file<String>:: The file to read.
-  # line<Fixnum>:: The line number to look for.
-  # size<Fixnum>::
+  # @param file<String> The file to read.
+  # @param line<Fixnum> The line number to look for.
+  # @param size<Fixnum>
   #   Number of lines to include above and below the the line to look for.
   #   Defaults to 4.
   #
-  # ==== Returns
-  # Array[Array]::
+  # @return <Array[Array]>
   #   Triplets containing the line number, the line and whether this was the
   #   searched line.
   #
-  # ==== Examples
-  #  __caller_lines__('/usr/lib/ruby/1.8/debug.rb', 122, 2) # =>
-  #   [
-  #     [ 120, "  def check_suspend",                               false ],
-  #     [ 121, "    return if Thread.critical",                     false ],
-  #     [ 122, "    while (Thread.critical = true; @suspend_next)", true  ],
-  #     [ 123, "      DEBUGGER__.waiting.push Thread.current",      false ],
-  #     [ 124, "      @suspend_next = false",                       false ]
-  #   ]
+  # @example
+  #   __caller_lines__('/usr/lib/ruby/1.8/debug.rb', 122, 2) # =>
+  #     [
+  #       [ 120, "  def check_suspend",                               false ],
+  #       [ 121, "    return if Thread.critical",                     false ],
+  #       [ 122, "    while (Thread.critical = true; @suspend_next)", true  ],
+  #       [ 123, "      DEBUGGER__.waiting.push Thread.current",      false ],
+  #       [ 124, "      @suspend_next = false",                       false ]
+  #     ]
   def __caller_lines__(file, line, size = 4)
-    return [['Template Error!', "problem while rendering", false]] if file =~ /\(erubis\)/
-    lines = File.readlines(file)
-    current = line.to_i - 1
-
-    first = current - size
-    first = first < 0 ? 0 : first
-
-    last = current + size
-    last = last > lines.size ? lines.size : last
-
-    log = lines[first..last]
-
-    area = []
-
-    log.each_with_index do |line, index|
-      index = index + first + 1
-      area << [index, line.chomp, index == current + 1]
+    line = line.to_i
+    if file =~ /\(erubis\)/
+      yield :error, "Template Error! Problem while rendering", false
+    elsif !File.file?(file) || !File.readable?(file)
+      yield :error, "File `#{file}' not available", false
+    else
+      lines = File.read(file).split("\n")
+      first_line = (f = line - size - 1) < 0 ? 0 : f
+      lines = lines[first_line, size * 2 + 1]
+      
+      lines.each_with_index do |str, index|
+        yield index + line - size, str.chomp
+      end
     end
-
-    area
+    # 
+    # lines = File.readlines(file)
+    # current = line.to_i - 1
+    # 
+    # first = current - size
+    # first = first < 0 ? 0 : first
+    # 
+    # last = current + size
+    # last = last > lines.size ? lines.size : last
+    # 
+    # log = lines[first..last]
+    # 
+    # area = []
+    # 
+    # log.each_with_index do |line, index|
+    #   index = index + first + 1
+    #   area << [index, line.chomp, index == current + 1]
+    # end
+    # 
+    # area
   end
 
   # Takes a block, profiles the results of running the block
   # specified number of times and generates HTML report.
   #
-  # ==== Parameters
-  # name<~to_s>::
+  # @param name<#to_s>
   #   The file name. The result will be written out to
   #   Merb.root/"log/#{name}.html".
-  # min<Fixnum>::
+  # @param min<Fixnum>
   #   Minimum percentage of the total time a method must take for it to be
   #   included in the result. Defaults to 1.
   #
-  # ==== Returns
-  # String:: The result of the profiling.
+  # @return <String>
+  #   The result of the profiling.
   #
-  # ==== Notes
-  # Requires ruby-prof (<tt>sudo gem install ruby-prof</tt>)
+  # @note
+  #   Requires ruby-prof (<tt>sudo gem install ruby-prof</tt>)
   #
-  # ==== Examples
+  # @example
   #   __profile__("MyProfile", 5, 30) do
   #     rand(10)**rand(10)
   #     puts "Profile run"
   #   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 in the example above.
+  #   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 in the example above.
   def __profile__(name, min=1, iter=100)
     require 'ruby-prof' unless defined?(RubyProf)
     return_result = ''
@@ -301,10 +295,9 @@ module Kernel
   # Extracts an options hash if it is the last item in the args array. Used
   # internally in methods that take *args.
   #
-  # ==== Parameters
-  # args<Array>:: The arguments to extract the hash from.
+  # @param args<Array> The arguments to extract the hash from.
   #
-  # ==== Examples
+  # @example
   #   def render(*args,&blk)
   #     opts = extract_options_from_args!(args) || {}
   #     # [...]
@@ -315,13 +308,12 @@ module Kernel
 
   # Checks that the given objects quack like the given conditions.
   #
-  # ==== Parameters
-  # opts<Hash>::
+  # @param opts<Hash>
   #   Conditions to enforce. Each key will receive a quacks_like? call with the
   #   value (see Object#quacks_like? for details).
   #
-  # ==== Raises
-  # ArgumentError:: An object failed to quack like a condition.
+  # @raise <ArgumentError>
+  #   An object failed to quack like a condition.
   def enforce!(opts = {})
     opts.each do |k,v|
       raise ArgumentError, "#{k.inspect} doesn't quack like #{v.inspect}" unless k.quacks_like?(v)

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

@@ -32,6 +32,8 @@ module Merb
     # :value<~to_s>:: Value of the cookie
     # :path<String>:: The path for which this cookie applies. Defaults to "/".
     # :expires<Time>:: Cookie expiry date.
+    # :domain<String>:: The domain for which this cookie applies.
+    # :secure<Boolean>:: Security flag.
     #
     # ==== Alternatives
     # If options is not a hash, it will be used as the cookie value directly.
@@ -65,6 +67,11 @@ module Merb
       cookie = @_cookies.delete(name)
       options = Mash.new(options)
       options[:expires] = Time.at(0)
+
+      if domain = options[:domain] || Merb::Controller._session_cookie_domain
+        options[:domain] = domain
+      end
+
       set_cookie(name, "", options)
       Merb.logger.info("Cookie deleted: #{name} => #{cookie.inspect}")
       cookie
@@ -78,14 +85,29 @@ module Merb
     # ==== Options (options)
     # :path<String>:: The path for which this cookie applies. Defaults to "/".
     # :expires<Time>:: Cookie expiry date.
+    # :domain<String>:: The domain for which this cookie applies.
+    # :secure<Boolean>:: Security flag.
     def set_cookie(name, value, options)
       options[:path] = '/' unless options[:path]
       if expiry = options[:expires]
         options[:expires] = expiry.gmtime.strftime(Merb::Const::COOKIE_EXPIRATION_FORMAT)
       end
-      # options are sorted for testing purposes
-      (@_headers['Set-Cookie'] ||=[]) << "#{name}=#{value}; " +
-        options.map{|k, v| "#{k}=#{v};"}.sort.join(' ')
+      
+      if domain = options[:domain] || Merb::Controller._session_cookie_domain
+        options[:domain] = domain
+      end
+
+      secure = options.delete(:secure)
+      
+      @_headers['Set-Cookie'] ||=[]
+      
+      kookie = "#{name}=#{value}; "
+      # options are sorted for testing purposes:
+      # Hash is unsorted so string is spec is random every run
+      kookie <<  options.map{|k, v| "#{k}=#{v};"}.join(' ')
+      kookie << ' secure' if secure
+      
+      @_headers['Set-Cookie'] << kookie
     end
   end
-end
+end