rtomayko-sinatra 0.8.9 → 0.8.10

data/CHANGES

@@ -8,6 +8,10 @@
    Documentation on using these features is forth-coming; the following
    provides the basic gist: http://gist.github.com/38605
 
+ * Parameters with subscripts are now parsed into a nested/recursive
+   Hash structure. e.g., "post[title]=Hello&post[body]=World" yields
+   params: {'post' => {'title' => 'Hello', 'body' => 'World'}}.
+
  * Regular expressions may now be used in route pattens; captures are
    available at "params[:captures]".
 
@@ -41,6 +45,16 @@
    has the status code specified. It's also possible to register an error
    page for a range of status codes: "error(500..599)".
 
+ * Sinatra's testing support is no longer dependent on Test::Unit. Requiring
+   'sinatra/test' adds the Sinatra::Test module and Sinatra::TestHarness
+   class, which can be used with any test framework. The 'sinatra/test/unit',
+   'sinatra/test/spec', 'sinatra/test/rspec', or 'sinatra/test/bacon' files
+   can be required to setup a framework-specific testing environment. See the
+   README for more information.
+
+ * Added support for Bacon (test framework). The 'sinatra/test/bacon' file
+   can be required to setup Sinatra test helpers on Bacon::Context.
+
  * Deprecated "set_option" and "set_options"; use "set" instead.
 
  * Deprecated the "env" option ("options.env"); use "environment" instead.
@@ -65,6 +79,10 @@
    treated as internal server errors and result in a 500 response
    status.
 
+ * Deprecated the "get_it", "post_it", "put_it", "delete_it", and "head_it"
+   test helper methods. Use "get", "post", "put", "delete", and "head",
+   respectively, instead.
+
  * Removed Event and EventContext classes. Applications are defined in a
    subclass of Sinatra::Base; each request is processed within an
    instance.

data/README.rdoc

@@ -165,12 +165,13 @@ other templates.
 
 Templates may be defined at the end of the source file:
 
+  require 'rubygems'
+  require 'sinatra'
+
   get '/' do
     haml :index
   end
 
-  use_in_file_templates!
-
   __END__
 
   @@ layout
@@ -180,6 +181,11 @@ Templates may be defined at the end of the source file:
   @@ index
   %div.title Hello world!!!!!
 
+NOTE:  Sinatra will automaticly load any in-file-templates in the
+source file that first required sinatra.  If you have in-file-templates
+in another source file you will need to explicitly call
++use_in_file_templates! on main in that file.
+
 It's also possible to define named templates using the top-level template
 method:
 
@@ -380,59 +386,61 @@ typically don't have to +use+ them explicitly.
 
 == Testing
 
-=== Test/Unit
+The Sinatra::Test module includes a variety of helper methods for testing
+your Sinatra app. Sinatra includes support for Test::Unit, test-spec, RSpec,
+and Bacon through separate source files.
+
+=== Test::Unit
 
-  require 'rubygems'
   require 'sinatra'
   require 'sinatra/test/unit'
   require 'my_sinatra_app'
 
   class MyAppTest < Test::Unit::TestCase
-
     def test_my_default
-      get_it '/'
+      get '/'
       assert_equal 'My Default Page!', @response.body
     end
 
     def test_with_agent
-      get_it '/', :agent => 'Songbird'
+      get '/', :agent => 'Songbird'
       assert_equal 'You're in Songbird!', @response.body
     end
 
     ...
-
   end
 
-=== Test/Spec
+=== Test::Spec
+
+Install the test-spec gem and require <tt>'sinatra/test/spec'</tt> before
+your app:
 
-  require 'rubygems'
   require 'sinatra'
   require 'sinatra/test/spec'
   require 'my_sinatra_app'
 
   describe 'My app' do
-
     it "should show a default page" do
-      get_it '/'
+      get '/'
       should.be.ok
       body.should.equal 'My Default Page!'
     end
 
     ...
-
   end
 
 === RSpec
 
-  require 'rubygems'
-  require 'spec'
+Install the rspec gem and require <tt>'sinatra/test/rspec'</tt> before
+your app:
+
   require 'sinatra'
   require 'sinatra/test/rspec'
   require 'my_sinatra_app'
 
   describe 'My app' do
     it 'should show a default page' do
-      get_it '/'
+      get '/'
       @response.should be_ok
       @response.body.should == 'My Default Page!'
     end
@@ -441,20 +449,35 @@ typically don't have to +use+ them explicitly.
 
   end
 
-See Sinatra::Test::Methods for more information on +get_it+, +post_it+,
-+put_it+, and friends.
+=== Bacon
+
+  require 'sinatra'
+  require 'sinatra/test/bacon'
+  require 'my_sinatra_app'
+
+  describe 'My app' do
+    it 'should be ok' do
+      get '/'
+      should.be.ok
+      body.should == 'Im OK'
+    end
+  end
+
+See Sinatra::Test for more information on +get+, +post+, +put+, and
+friends.
 
 == Command line
 
 Sinatra applications can be run directly:
 
-  ruby myapp.rb [-h] [-x] [-p PORT] [-e ENVIRONMENT]
+  ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-s HANDLER]
 
 Options are:
 
   -h # help
   -p # set the port (default is 4567)
   -e # set the environment (default is development)
+  -s # specify rack server/handler (default is thin)
   -x # turn on the mutex lock (default is off)
 
 == Contributing

data/compat/events_test.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/helper'
 
 context "Simple Events" do
-
   def simple_request_hash(method, path)
     Rack::Request.new({
       'REQUEST_METHOD' => method.to_s.upcase,
@@ -14,16 +13,16 @@ context "Simple Events" do
 
   def invoke_simple(path, request_path, &b)
     params = nil
-    mock_app {
-      get path do
-        params = self.params
-        b.call if b
-      end
-    }
+    get path do
+      params = self.params
+      b.call if b
+    end
     get_it request_path
     MockResult.new(b, params)
   end
 
+  setup { Sinatra.application = nil }
+
   specify "return last value" do
     block = Proc.new { 'Simple' }
     result = invoke_simple('/', '/', &block)
@@ -38,6 +37,7 @@ context "Simple Events" do
     result.params.should.equal "foo" => 'a', "bar" => 'b'
 
     # unscapes
+    Sinatra.application = nil
     result = invoke_simple('/:foo/:bar', '/a/blake%20mizerany')
     result.should.not.be.nil
     result.params.should.equal "foo" => 'a', "bar" => 'blake mizerany'
@@ -48,14 +48,17 @@ context "Simple Events" do
     result.should.not.be.nil
     result.params.should.equal "foo" => 'a', "bar" => 'b'
 
+    Sinatra.application = nil
     result = invoke_simple('/?:foo?/?:bar?', '/a/')
     result.should.not.be.nil
     result.params.should.equal "foo" => 'a', "bar" => nil
 
+    Sinatra.application = nil
     result = invoke_simple('/?:foo?/?:bar?', '/a')
     result.should.not.be.nil
     result.params.should.equal "foo" => 'a', "bar" => nil
 
+    Sinatra.application = nil
     result = invoke_simple('/:foo?/?:bar?', '/')
     result.should.not.be.nil
     result.params.should.equal "foo" => nil, "bar" => nil

data/compat/helper.rb

@@ -13,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.8.9'
+  VERSION = '0.8.10'
 
   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
@@ -324,8 +331,7 @@ module Sinatra
       self.class.filters.each {|block| instance_eval(&block)}
       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, method_name|
           if pattern =~ path
@@ -345,8 +351,7 @@ module Sinatra
               else
                 {}
               end
-            @params = original_params.dup
-            @params.merge!(params)
+            @params = original_params.merge(params)
 
             catch(:pass) {
               conditions.each { |cond|
@@ -359,14 +364,24 @@ module Sinatra
       raise NotFound
     end
 
-    def invoke(handler)
-      res = catch(:halt) {
-        if handler.respond_to?(:call)
-          instance_eval(&handler)
-        else
-          send(handler)
+    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) }
       case
       when res.respond_to?(:to_str)
         @response.body = [res]
@@ -478,8 +493,13 @@ 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")
@@ -541,10 +561,10 @@ module Sinatra
 
       def get(path, opts={}, &block)
         conditions = @conditions.dup
-        _, _, _, method_name = route('GET', path, opts, &block)
+        route('GET', path, opts, &block)
 
         @conditions = conditions
-        head(path, opts) { invoke(method_name) ; [] }
+        head(path, opts) { invoke(block) ; [] }
       end
 
       def put(path, opts={}, &bk); route 'PUT', path, opts, &bk; end
@@ -553,21 +573,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, []
-        method_name = "route { #{method} #{path} }"
-        nmethods = instance_methods.grep(rx = /#{Regexp.escape(method_name)}/).size
-        method_name += " [#{nmethods}]"
 
-        define_method(method_name, &block)
+        define_method "#{verb} #{path}", &block
+        unbound_method = instance_method("#{verb} #{path}")
+        block = lambda { unbound_method.bind(self).call }
 
-        (routes[method] ||= []).
-          push([pattern, keys, conditions, method_name]).last
+        (routes[verb] ||= []).
+          push([pattern, keys, conditions, block]).last
       end
 
       def compile(path)
@@ -784,6 +803,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/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
 

data/lib/sinatra/test.rb

@@ -1,112 +1,114 @@
 require 'sinatra/base'
-require 'test/unit'
 
-module Sinatra::Test
-  include Rack::Utils
-
-  attr_reader :app, :request, :response
-
-  def mock_app(base=Sinatra::Base, &block)
-    @app = Sinatra.new(base, &block)
-  end
-
-  undef request if method_defined?(:request)
-
-  def request(verb, path, *args)
-    fail "@app not set - cannot make request" if @app.nil?
-    @request = Rack::MockRequest.new(@app)
-    opts, input =
-      case args.size
-      when 2 # input, env
-        input, env = args
-        if input.kind_of?(Hash) # params, env
-          [env, param_string(input)]
-        else
-          [env, input]
-        end
-      when 1 # params
-        if (data = args.first).kind_of?(Hash)
-          env = (data.delete(:env) || {})
-          [env, param_string(data)]
+module Sinatra
+
+  module Test
+    include Rack::Utils
+
+    attr_reader :app, :request, :response
+
+    def test_request(verb, path, *args)
+      @app = Sinatra::Application if @app.nil? && defined?(Sinatra::Application)
+      fail "@app not set - cannot make request" if @app.nil?
+      @request = Rack::MockRequest.new(@app)
+      opts, input =
+        case args.size
+        when 2 # input, env
+          input, env = args
+          if input.kind_of?(Hash) # params, env
+            [env, param_string(input)]
+          else
+            [env, input]
+          end
+        when 1 # params
+          if (data = args.first).kind_of?(Hash)
+            env = (data.delete(:env) || {})
+            [env, param_string(data)]
+          else
+            [{}, data]
+          end
+        when 0
+          [{}, '']
         else
-          [{}, data]
+          raise ArgumentError, "zero, one, or two arguments expected"
         end
-      when 0
-        [{}, '']
-      else
-        raise ArgumentError, "zero, one, or two arguments expected"
-      end
-    opts = rack_opts(opts)
-    opts[:input] ||= input
-    yield @request if block_given?
-    @response = @request.request(verb, path, opts)
-  end
+      opts = rack_opts(opts)
+      opts[:input] ||= input
+      yield @request if block_given?
+      @response = @request.request(verb, path, opts)
+    end
 
-  def get(path, *args, &b)  ; request('GET', path, *args, &b) ; end
-  def head(path, *args, &b) ; request('HEAD', path, *args, &b) ; end
-  def post(path, *args, &b) ; request('POST', path, *args, &b) ; end
-  def put(path, *args, &b)  ; request('PUT', path, *args, &b) ; end
-  def delete(path, *args, &b) ; request('DELETE', path, *args, &b) ; end
+    def get(path, *args, &b)  ; test_request('GET', path, *args, &b) ; end
+    def head(path, *args, &b) ; test_request('HEAD', path, *args, &b) ; end
+    def post(path, *args, &b) ; test_request('POST', path, *args, &b) ; end
+    def put(path, *args, &b)  ; test_request('PUT', path, *args, &b) ; end
+    def delete(path, *args, &b) ; test_request('DELETE', path, *args, &b) ; end
 
-  def follow!
-    request 'GET', @response.location
-  end
+    def follow!
+      test_request 'GET', @response.location
+    end
 
-  def should
-    @response.should
-  end
+    def body ; @response.body ; end
+    def status ; @response.status ; end
 
-  def body
-    @response.body
-  end
+    # Delegate other missing methods to @response.
+    def method_missing(name, *args, &block)
+      if @response && @response.respond_to?(name)
+        @response.send(name, *args, &block)
+      else
+        super
+      end
+    end
 
-  def status
-    @response.status
-  end
+    # Also check @response since we delegate there.
+    def respond_to?(symbol, include_private=false)
+      super || (@response && @response.respond_to?(symbol, include_private))
+    end
 
-  RACK_OPT_NAMES = {
-    :accept => "HTTP_ACCEPT",
-    :agent => "HTTP_USER_AGENT",
-    :host => "HTTP_HOST",
-    :session => "HTTP_COOKIE",
-    :cookies => "HTTP_COOKIE",
-    :content_type => "CONTENT_TYPE"
-  }
-
-  def rack_opts(opts)
-    opts.inject({}) do |hash,(key,val)|
-      key = RACK_OPT_NAMES[key] || key
-      hash[key] = val
-      hash
+    RACK_OPT_NAMES = {
+      :accept => "HTTP_ACCEPT",
+      :agent => "HTTP_USER_AGENT",
+      :host => "HTTP_HOST",
+      :session => "HTTP_COOKIE",
+      :cookies => "HTTP_COOKIE",
+      :content_type => "CONTENT_TYPE"
+    }
+
+    def rack_opts(opts)
+      opts.inject({}) do |hash,(key,val)|
+        key = RACK_OPT_NAMES[key] || key
+        hash[key] = val
+        hash
+      end
     end
-  end
 
-  def env_for(opts={})
-    opts = rack_opts(opts)
-    Rack::MockRequest.env_for(opts)
-  end
+    def env_for(opts={})
+      opts = rack_opts(opts)
+      Rack::MockRequest.env_for(opts)
+    end
 
-  def param_string(hash)
-    hash.map { |pair| pair.map{|v|escape(v)}.join('=') }.join('&')
-  end
+    def param_string(hash)
+      hash.map { |pair| pair.map{|v|escape(v)}.join('=') }.join('&')
+    end
 
-  if defined? Sinatra::Compat
-    # Deprecated. Use: "get" instead of "get_it".
-    %w(get head post put delete).each do |verb|
-      alias_method "#{verb}_it", verb
-      remove_method verb
+    if defined? Sinatra::Compat
+      # Deprecated. Use: "get" instead of "get_it".
+      %w(get head post put delete).each do |verb|
+        eval <<-RUBY, binding, __FILE__, __LINE__
+        def #{verb}_it(*args, &block)
+          sinatra_warn "The #{verb}_it method is deprecated; use #{verb} instead."
+          test_request('#{verb.upcase}', *args, &block)
+        end
+        RUBY
+      end
     end
+  end
 
-    include Sinatra::Delegator
+  class TestHarness
+    include Test
 
-    # Deprecated. Tests no longer delegate missing methods to the
-    # mock response. Use: @response
-    def method_missing(name, *args, &block)
-      if @response && @response.respond_to?(name)
-        @response.send(name, *args, &block)
-      else
-        super
-      end
+    def initialize(app=nil)
+      @app = app || Sinatra::Application
     end
   end
 end

data/lib/sinatra.rb

@@ -1,3 +1,8 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
 require 'sinatra/base'
 require 'sinatra/main'
 require 'sinatra/compat'
+
+use_in_file_templates!