bmizerany-sinatra 0.9.0 → 0.9.0.2

data/compat/helper.rb

@@ -1,6 +1,9 @@
 require 'rubygems'
 require 'mocha'
 
+# disable warnings in compat specs.
+$VERBOSE = nil
+
 $:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
 
 ENV['RACK_ENV'] ||= 'test'
@@ -10,9 +13,18 @@ require 'sinatra/test'
 require 'sinatra/test/unit'
 require 'sinatra/test/spec'
 
+module Sinatra::Test
+  # we need to remove the new test helper methods since they conflict with
+  # the top-level methods of the same name.
+  %w(get head post put delete).each do |verb|
+    remove_method verb
+  end
+  include Sinatra::Delegator
+end
+
 class Test::Unit::TestCase
+  include Sinatra::Test
   def setup
     @app = lambda { |env| Sinatra::Application.call(env) }
   end
-  include Sinatra::Test
 end

data/lib/sinatra/base.rb

@@ -4,7 +4,7 @@ require 'rack'
 require 'rack/builder'
 
 module Sinatra
-  VERSION = '0.9.0'
+  VERSION = '0.9.0.2'
 
   class Request < Rack::Request
     def user_agent
@@ -14,6 +14,13 @@ module Sinatra
     def accept
       @env['HTTP_ACCEPT'].split(',').map { |a| a.strip }
     end
+
+    # Override Rack 0.9.x's #params implementation (see #72 in lighthouse)
+    def params
+      self.GET.update(self.POST)
+    rescue EOFError => boom
+      self.GET
+    end
   end
 
   class Response < Rack::Response
@@ -70,7 +77,7 @@ module Sinatra
     def redirect(uri, *args)
       status 302
       response['Location'] = uri
-      halt *args
+      halt(*args)
     end
 
     # Halt processing and return the error status provided.
@@ -135,7 +142,7 @@ module Sinatra
     class StaticFile < ::File #:nodoc:
       alias_method :to_path, :path
       def each
-        while buf = read(8196)
+        while buf = read(8192)
           yield buf
         end
       end
@@ -210,6 +217,7 @@ module Sinatra
 
     def lookup_layout(engine, options)
       return if options[:layout] == false
+      options.delete(:layout) if options[:layout] == true
       template = options[:layout] || :layout
       data = lookup_template(engine, template, options)
       [template, data]
@@ -298,10 +306,10 @@ module Sinatra
     attr_accessor :env, :request, :response, :params
 
     def call!(env)
-      @env = env
-      @request = Request.new(env)
+      @env      = env
+      @request  = Request.new(env)
       @response = Response.new
-      @params = nil
+      @params   = nil
       error_detection { dispatch! }
       @response.finish
     end
@@ -320,13 +328,16 @@ module Sinatra
 
   private
     def dispatch!
-      self.class.filters.each {|block| instance_eval(&block)}
+      self.class.filters.each do |block|
+        res = catch(:halt) { instance_eval(&block) ; :continue }
+        return unless res == :continue
+      end
+
       if routes = self.class.routes[@request.request_method]
         path = @request.path_info
-        original_params = Hash.new{ |hash,k| hash[k.to_s] if Symbol === k }
-        original_params.merge! @request.params
+        original_params = nested_params(@request.params)
 
-        routes.each do |pattern, keys, conditions, block|
+        routes.each do |pattern, keys, conditions, method_name|
           if pattern =~ path
             values = $~.captures.map{|val| val && unescape(val) }
             params =
@@ -344,13 +355,12 @@ module Sinatra
               else
                 {}
               end
-            @params = original_params.dup
-            @params.merge!(params)
+            @params = original_params.merge(params)
 
             catch(:pass) {
               conditions.each { |cond|
                 throw :pass if instance_eval(&cond) == false }
-              return invoke(block)
+              return invoke(method_name)
             }
           end
         end
@@ -358,8 +368,26 @@ module Sinatra
       raise NotFound
     end
 
+    def nested_params(params)
+      return indifferent_hash.merge(params) if !params.keys.join.include?('[')
+      params.inject indifferent_hash do |res, (key,val)|
+        if key =~ /\[.*\]/
+          splat = key.scan(/(^[^\[]+)|\[([^\]]+)\]/).flatten.compact
+          head, last = splat[0..-2], splat[-1]
+          head.inject(res){ |s,v| s[v] ||= indifferent_hash }[last] = val
+        end
+        res
+      end
+    end
+
+    def indifferent_hash
+      Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+    end
+
     def invoke(block)
       res = catch(:halt) { instance_eval(&block) }
+      return if res.nil?
+
       case
       when res.respond_to?(:to_str)
         @response.body = [res]
@@ -379,17 +407,12 @@ module Sinatra
         else
           @response.body = res
         end
-      when res.kind_of?(Symbol)  # TODO: deprecate this.
-        @response.body = __send__(res)
       when res.respond_to?(:each)
         @response.body = res
       when (100...599) === res
         @response.status = res
-      when res.nil?
-        @response.body = []
-      else
-        raise TypeError, "#{res.inspect} not supported"
       end
+
       res
     end
 
@@ -404,6 +427,12 @@ module Sinatra
       invoke handler unless handler.nil?
     rescue ::Exception => boom
       @env['sinatra.error'] = boom
+
+      if options.dump_errors?
+        msg = ["#{boom.class} - #{boom.message}:", *boom.backtrace].join("\n ")
+        @env['rack.errors'] << msg
+      end
+
       raise boom if options.raise_errors?
       @response.status = 500
       invoke errmap[boom.class] || errmap[Exception]
@@ -456,6 +485,10 @@ module Sinatra
         end
       end
 
+      def not_found(&block)
+        error 404, &block
+      end
+
       def template(name, &block)
         templates[name] = block
       end
@@ -465,11 +498,16 @@ module Sinatra
       end
 
       def use_in_file_templates!
-        line = caller.detect { |s| s !~ /lib\/sinatra.*\.rb/ &&
-          s !~ /\(.*\)/ }
+        line = caller.detect do |s|
+          [
+           /lib\/sinatra.*\.rb/,
+           /\(.*\)/,
+           /rubygems\/custom_require\.rb/
+          ].all? { |x| s !~ x }
+        end
         file = line.sub(/:\d+.*$/, '')
         if data = ::IO.read(file).split('__END__')[1]
-          data.gsub! /\r\n/, "\n"
+          data.gsub!(/\r\n/, "\n")
           template = nil
           data.each_line do |line|
             if line =~ /^@@\s*(.*)/
@@ -528,7 +566,7 @@ module Sinatra
 
       def get(path, opts={}, &block)
         conditions = @conditions.dup
-        route 'GET', path, opts, &block
+        route('GET', path, opts, &block)
 
         @conditions = conditions
         head(path, opts) { invoke(block) ; [] }
@@ -540,15 +578,20 @@ module Sinatra
       def head(path, opts={}, &bk); route 'HEAD', path, opts, &bk; end
 
     private
-      def route(method, path, opts={}, &block)
+      def route(verb, path, opts={}, &block)
         host_name  opts[:host]  if opts.key?(:host)
         user_agent opts[:agent] if opts.key?(:agent)
         accept_mime_types opts[:provides] if opts.key?(:provides)
 
         pattern, keys = compile(path)
         conditions, @conditions = @conditions, []
-        (routes[method] ||= []).
-          push [pattern, keys, conditions, block]
+
+        define_method "#{verb} #{path}", &block
+        unbound_method = instance_method("#{verb} #{path}")
+        block = lambda { unbound_method.bind(self).call }
+
+        (routes[verb] ||= []).
+          push([pattern, keys, conditions, block]).last
       end
 
       def compile(path)
@@ -647,6 +690,7 @@ module Sinatra
     end
 
     set :raise_errors, true
+    set :dump_errors, false
     set :sessions, false
     set :logging, false
     set :methodoverride, false
@@ -740,6 +784,7 @@ module Sinatra
 
   class Default < Base
     set :raise_errors, false
+    set :dump_errors, true
     set :sessions, false
     set :logging, true
     set :methodoverride, true
@@ -763,6 +808,7 @@ module Sinatra
     def self.reload!
       @reloading = true
       superclass.send :inherited, self
+      $LOADED_FEATURES.delete("sinatra.rb")
       ::Kernel.load app_file
       @reloading = false
     end

data/lib/sinatra/compat.rb

@@ -1,58 +1,102 @@
+# Sinatra 0.3.x compatibility module.
+#
+# The following code makes Sinatra 0.9.x compatible with Sinatra 0.3.x to
+# ease the transition to the final 1.0 release. Everything defined in this
+# file will be removed for the 1.0 release.
+
 require 'ostruct'
 require 'sinatra/base'
 require 'sinatra/main'
 
-# Deprecated. Do we still need this?
+# Like Kernel#warn but outputs the location that triggered the warning.
+def sinatra_warn(*message)
+  line = caller.
+    detect { |line| line !~ /(?:lib\/sinatra\/|__DELEGATE__)/ }.
+    sub(/:in .*/, '')
+  warn "#{line}: warning: #{message.join(' ')}"
+end
+
+# Rack now supports evented and swiftiplied mongrels through separate
+# handler.
 if ENV['SWIFT']
+  sinatra_warn 'the SWIFT environment variable is deprecated;',
+    'use Rack::Handler::SwiftipliedMongrel instead.'
   require 'swiftcore/swiftiplied_mongrel'
   puts "Using Swiftiplied Mongrel"
 elsif ENV['EVENT']
+  sinatra_warn 'the EVENT environment variable is deprecated;',
+    'use Rack::Handler::EventedMongrel instead.'
   require 'swiftcore/evented_mongrel'
   puts "Using Evented Mongrel"
 end
 
-# Deprecated. Make Rack 0.9.0 backward compatibile with 0.4.0
-# mime types
+# Make Rack 0.9.0 backward compatibile with 0.4.0 mime types. This isn't
+# technically a Sinatra issue but many Sinatra apps access the old
+# MIME_TYPES constants due to Sinatra example code.
 require 'rack/file'
 class Rack::File
-  unless defined? MIME_TYPES
-    MIME_TYPES = Hash.new {|hash,key|
-      Rack::Mime::MIME_TYPES[".#{key}"] }
+  def self.const_missing(const_name)
+    if const_name == :MIME_TYPES
+      hash = Hash.new { |hash,key| Rack::Mime::MIME_TYPES[".#{key}"] }
+      const_set :MIME_TYPES, hash
+      sinatra_warn 'Rack::File::MIME_TYPES is deprecated; use Rack::Mime instead.'
+      hash
+    else
+      super
+    end
   end
 end
 
-# Deprecated. Rack::Utils will not extend itself in the future. Sinatra::Base
-# includes Rack::Utils, however.
-module Rack::Utils ; extend self ; end
-
 module Sinatra
   module Compat
   end
 
-  # Deprecated. Use: error
+  # The ServerError exception is deprecated. Any exception is considered an
+  # internal server error.
   class ServerError < RuntimeError
+    def initialize(*args, &block)
+      sinatra_warn 'Sinatra::ServerError is deprecated;',
+        'use another exception, error, or Kernel#fail instead.'
+    end
     def code ; 500 ; end
   end
 
   class Default < Base
-    # Deprecated.
-    FORWARD_METHODS = Sinatra::Delegator::METHODS
+    def self.const_missing(const_name)
+      if const_name == :FORWARD_METHODS
+        sinatra_warn 'Sinatra::Application::FORWARD_METHODS is deprecated;',
+          'use Sinatra::Delegator::METHODS instead.'
+        const_set :FORWARD_METHODS, Sinatra::Delegator::METHODS
+        Sinatra::Delegator::METHODS
+      else
+        super
+      end
+    end
 
     # Deprecated. Use: response['Header-Name']
     def headers(header=nil)
+      sinatra_warn "The 'headers' method is deprecated; use 'response' instead."
       response.headers.merge!(header) if header
       response.headers
     end
     alias :header :headers
 
     # Deprecated. Use: halt
-    alias :stop :halt
+    def stop(*args, &block)
+      sinatra_warn "The 'stop' method is deprecated; use 'halt' instead."
+      halt(*args, &block)
+    end
 
     # Deprecated. Use: etag
-    alias :entity_tag :etag
+    def entity_tag(*args, &block)
+      sinatra_warn "The 'entity_tag' method is deprecated; use 'etag' instead."
+      etag(*args, &block)
+    end
 
     # The :disposition option is deprecated; use: #attachment. This method
     # setting the Content-Transfer-Encoding header is deprecated.
+    #--
+    # TODO deprecation warning for :disposition argument.
     def send_file(path, opts={})
       opts[:disposition] = 'attachment' if !opts.key?(:disposition)
       attachment opts[:filename] || path if opts[:filename] || opts[:disposition]
@@ -60,48 +104,89 @@ module Sinatra
       super(path, opts)
     end
 
-    def options ; self.class.options ; end
+    # Throwing halt with a Symbol and the to_result convention are
+    # deprecated. Override the invoke method to detect those types of return
+    # values.
+    def invoke(handler)
+      res = super
+      case
+      when res.kind_of?(Symbol)
+        sinatra_warn "Invoking the :#{res} helper by returning a Symbol is deprecated;",
+          "call the helper directly instead."
+        @response.body = __send__(res)
+      when res.respond_to?(:to_result)
+        sinatra_warn "The to_result convention is deprecated."
+        @response.body = res.to_result(self)
+      end
+      res
+    end
+
+    def options
+      Options.new(self.class)
+    end
+
+    class Options < Struct.new(:target) #:nodoc:
+      def method_missing(name, *args, &block)
+        if target.respond_to?(name)
+          target.__send__(name, *args, &block)
+        elsif args.empty? && name.to_s !~ /=$/
+          sinatra_warn 'accessing undefined options will raise a NameError in Sinatra 1.0'
+          nil
+        else
+          super
+        end
+      end
+    end
 
     class << self
       # Deprecated. Options are stored directly on the class object.
-      def options ; Options.new(self) ; end
-
-      class Options < Struct.new(:target) #:nodoc:
-        def method_missing(name, *args, &block)
-          if target.respond_to?(name)
-            target.__send__(name, *args, &block)
-          elsif args.empty? && name.to_s !~ /=$/
-            nil
-          else
-            super
-          end
-        end
+      def options
+        sinatra_warn "The 'options' class method is deprecated; use 'self' instead."
+        Options.new(self)
       end
 
       # Deprecated. Use: configure
-      alias :configures :configure
+      def configures(*args, &block)
+        sinatra_warn "The 'configures' method is deprecated; use 'configure' instead."
+        configure(*args, &block)
+      end
 
       # Deprecated. Use: set
       def default_options
+        sinatra_warn "Sinatra::Application.default_options is deprecated; use 'set' instead."
         fake = lambda { |options| set(options) }
         def fake.merge!(options) ; call(options) ; end
         fake
       end
 
       # Deprecated. Use: set
-      alias :set_option :set
-      alias :set_options :set
+      def set_option(*args, &block)
+        sinatra_warn "The 'set_option' method is deprecated; use 'set' instead."
+        set(*args, &block)
+      end
+
+      def set_options(*args, &block)
+        sinatra_warn "The 'set_options' method is deprecated; use 'set' instead."
+        set(*args, &block)
+      end
 
       # Deprecated. Use: set :environment, ENV
       def env=(value)
+        sinatra_warn "The :env option is deprecated; use :environment instead."
         set :environment, value
       end
-      alias :env :environment
+
+      # Deprecated. Use: options.environment
+      def env
+        sinatra_warn "The :env option is deprecated; use :environment instead."
+        environment
+      end
     end
 
     # Deprecated. Missing messages are no longer delegated to @response.
     def method_missing(name, *args, &b)
       if @response.respond_to?(name)
+        sinatra_warn "The '#{name}' method is deprecated; use 'response.#{name}' instead."
         @response.send(name, *args, &b)
       else
         super
@@ -112,30 +197,43 @@ module Sinatra
   class << self
     # Deprecated. Use: Sinatra::Application
     def application
+      sinatra_warn "Sinatra.application is deprecated; use Sinatra::Application instead."
       Sinatra::Application
     end
 
-    # Deprecated. Use: error 404
-    def not_found(&block)
-      error 404, &block
-    end
-
     # Deprecated. Use: Sinatra::Application.reset!
     def application=(value)
       raise ArgumentError unless value.nil?
+      sinatra_warn "Setting Sinatra.application to nil is deprecated; create a new instance instead."
       Sinatra.class_eval do
         remove_const :Application
         const_set :Application, Class.new(Sinatra::Default)
       end
     end
 
-    # Deprecated. Use: Sinatra::Application
-    alias :build_application :application
+    def build_application
+      sinatra_warn "Sinatra.build_application is deprecated; use Sinatra::Application instead."
+      Sinatra::Application
+    end
 
-    # Deprecated.
-    def options ; Sinatra::Application.options ; end
-    def port ; options.port ; end
-    def host ; options.host ; end
-    def env ; options.environment  ; end
+    def options
+      sinatra_warn "Sinatra.options is deprecated; use Sinatra::Application.option_name instead."
+      Sinatra::Application.options
+    end
+
+    def port
+      sinatra_warn "Sinatra.port is deprecated; use Sinatra::Application.port instead."
+      options.port
+    end
+
+    def host
+      sinatra_warn "Sinatra.host is deprecated; use Sinatra::Application.host instead."
+      options.host
+    end
+
+    def env
+      sinatra_warn "Sinatra.env is deprecated; use Sinatra::Application.environment instead."
+      options.environment
+    end
   end
 end

data/lib/sinatra/test/bacon.rb

@@ -0,0 +1,17 @@
+require 'bacon'
+require 'sinatra/test'
+
+Sinatra::Default.set(
+  :env => :test,
+  :run => false,
+  :raise_errors => true,
+  :logging => false
+)
+
+module Sinatra::Test
+  def should
+    @response.should
+  end
+end
+
+Bacon::Context.send(:include, Sinatra::Test)

data/lib/sinatra/test/rspec.rb

@@ -1,2 +1,9 @@
 require 'sinatra/test'
 require 'spec/interop/test'
+
+Sinatra::Default.set(
+  :env => :test,
+  :run => false,
+  :raise_errors => true,
+  :logging => false
+)

data/lib/sinatra/test/spec.rb

@@ -1,2 +1,9 @@
 require 'test/spec'
 require 'sinatra/test'
+require 'sinatra/test/unit'
+
+module Sinatra::Test
+  def should
+    @response.should
+  end
+end

data/lib/sinatra/test/unit.rb

@@ -1,5 +1,5 @@
-require 'test/unit'
 require 'sinatra/test'
+require 'test/unit'
 
 Test::Unit::TestCase.send :include, Sinatra::Test