RubyGems - sinatra-base - Versions diffs - 1.0 → 1.4.0 - Mend

sinatra-base 1.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (101) hide show

data/.yardopts +4 -0
data/AUTHORS +15 -0
data/CHANGES +524 -1
data/Gemfile +82 -0
data/LICENSE +1 -1
data/README.de.rdoc +2093 -0
data/README.es.rdoc +2091 -0
data/README.fr.rdoc +2116 -0
data/README.hu.rdoc +607 -0
data/README.jp.rdoc +514 -23
data/README.pt-br.rdoc +647 -0
data/README.pt-pt.rdoc +646 -0
data/README.rdoc +1580 -205
data/README.ru.rdoc +2015 -0
data/README.zh.rdoc +1816 -0
data/Rakefile +110 -44
data/examples/chat.rb +61 -0
data/examples/simple.rb +3 -0
data/examples/stream.ru +26 -0
data/lib/sinatra.rb +0 -3
data/lib/sinatra/base.rb +923 -393
data/lib/sinatra/main.rb +9 -7
data/lib/sinatra/showexceptions.rb +37 -4
data/lib/sinatra/version.rb +3 -0
data/sinatra-base.gemspec +15 -91
data/test/base_test.rb +2 -2
data/test/builder_test.rb +32 -2
data/test/coffee_test.rb +92 -0
data/test/contest.rb +62 -28
data/test/creole_test.rb +65 -0
data/test/delegator_test.rb +162 -0
data/test/encoding_test.rb +20 -0
data/test/erb_test.rb +25 -2
data/test/extensions_test.rb +1 -1
data/test/filter_test.rb +226 -8
data/test/haml_test.rb +8 -2
data/test/helper.rb +47 -0
data/test/helpers_test.rb +1287 -80
data/test/integration/app.rb +62 -0
data/test/integration_helper.rb +208 -0
data/test/integration_test.rb +82 -0
data/test/less_test.rb +36 -6
data/test/liquid_test.rb +59 -0
data/test/mapped_error_test.rb +84 -7
data/test/markaby_test.rb +80 -0
data/test/markdown_test.rb +81 -0
data/test/middleware_test.rb +1 -1
data/test/nokogiri_test.rb +69 -0
data/test/rack_test.rb +45 -0
data/test/radius_test.rb +59 -0
data/test/rdoc_test.rb +66 -0
data/test/readme_test.rb +136 -0
data/test/request_test.rb +13 -1
data/test/response_test.rb +21 -2
data/test/result_test.rb +5 -5
data/test/route_added_hook_test.rb +1 -1
data/test/routing_test.rb +328 -13
data/test/sass_test.rb +48 -18
data/test/scss_test.rb +88 -0
data/test/server_test.rb +4 -3
data/test/settings_test.rb +191 -21
data/test/sinatra_test.rb +5 -1
data/test/slim_test.rb +88 -0
data/test/static_test.rb +89 -5
data/test/streaming_test.rb +140 -0
data/test/templates_test.rb +143 -4
data/test/textile_test.rb +65 -0
data/test/views/a/in_a.str +1 -0
data/test/views/ascii.erb +2 -0
data/test/views/b/in_b.str +1 -0
data/test/views/calc.html.erb +1 -0
data/test/views/explicitly_nested.str +1 -0
data/test/views/hello.coffee +1 -0
data/test/views/hello.creole +1 -0
data/test/views/hello.liquid +1 -0
data/test/views/hello.mab +1 -0
data/test/views/hello.md +1 -0
data/test/views/hello.nokogiri +1 -0
data/test/views/hello.radius +1 -0
data/test/views/hello.rdoc +1 -0
data/test/views/hello.sass +1 -1
data/test/views/hello.scss +3 -0
data/test/views/hello.slim +1 -0
data/test/views/hello.str +1 -0
data/test/views/hello.textile +1 -0
data/test/views/hello.yajl +1 -0
data/test/views/layout2.liquid +2 -0
data/test/views/layout2.mab +2 -0
data/test/views/layout2.nokogiri +3 -0
data/test/views/layout2.radius +2 -0
data/test/views/layout2.slim +3 -0
data/test/views/layout2.str +2 -0
data/test/views/nested.str +1 -0
data/test/views/utf8.erb +2 -0
data/test/yajl_test.rb +80 -0
metadata +126 -91
data/lib/sinatra/tilt.rb +0 -746
data/test/erubis_test.rb +0 -82
data/test/views/error.erubis +0 -3
data/test/views/hello.erubis +0 -1
data/test/views/layout2.erubis +0 -2

data/test/sinatra_test.rb CHANGED

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path('../helper', __FILE__)
 class SinatraTest < Test::Unit::TestCase
   it 'creates a new Sinatra::Base subclass on new' do
@@ -10,4 +10,8 @@ class SinatraTest < Test::Unit::TestCase
       end
     assert_same Sinatra::Base, app.superclass
   end
+  it "responds to #template_cache" do
+    assert_kind_of Tilt::Cache, Sinatra::Base.new!.template_cache
+  end
 end

data/test/slim_test.rb ADDED

@@ -0,0 +1,88 @@
+require File.expand_path('../helper', __FILE__)
+begin
+require 'slim'
+class SlimTest < Test::Unit::TestCase
+  def slim_app(&block)
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'
+      get '/', &block
+    }
+    get '/'
+  end
+  it 'renders inline slim strings' do
+    slim_app { slim "h1 Hiya\n" }
+    assert ok?
+    assert_equal "<h1>Hiya</h1>", body
+  end
+  it 'renders .slim files in views path' do
+    slim_app { slim :hello }
+    assert ok?
+    assert_equal "<h1>Hello From Slim</h1>", body
+  end
+  it "renders with inline layouts" do
+    mock_app {
+      layout { %(h1\n  | THIS. IS. \n  == yield.upcase ) }
+      get('/') { slim 'em Sparta' }
+    }
+    get '/'
+    assert ok?
+    assert_equal "<h1>THIS. IS. <EM>SPARTA</EM></h1>", body
+  end
+  it "renders with file layouts" do
+    slim_app {
+      slim '| Hello World', :layout => :layout2
+    }
+    assert ok?
+    assert_equal "<h1>Slim Layout!</h1><p>Hello World</p>", body
+  end
+  it "raises error if template not found" do
+    mock_app {
+      get('/') { slim :no_such_template }
+    }
+    assert_raise(Errno::ENOENT) { get('/') }
+  end
+  HTML4_DOCTYPE = "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" \"http://www.w3.org/TR/html4/loose.dtd\">"
+  it "passes slim options to the slim engine" do
+    mock_app { get('/') { slim "x foo='bar'", :attr_wrapper => "'" }}
+    get '/'
+    assert ok?
+    assert_body "<x foo='bar'></x>"
+  end
+  it "passes default slim options to the slim engine" do
+    mock_app do
+      set :slim, :attr_wrapper => "'"
+      get('/') { slim "x foo='bar'" }
+    end
+    get '/'
+    assert ok?
+    assert_body "<x foo='bar'></x>"
+  end
+  it "merges the default slim options with the overrides and passes them to the slim engine" do
+    mock_app do
+      set :slim, :attr_wrapper => "'"
+      get('/') { slim "x foo='bar'" }
+      get('/other') { slim "x foo='bar'", :attr_wrapper => '"' }
+    end
+    get '/'
+    assert ok?
+    assert_body "<x foo='bar'></x>"
+    get '/other'
+    assert ok?
+    assert_body '<x foo="bar"></x>'
+  end
+end
+rescue LoadError
+  warn "#{$!.to_s}: skipping slim tests"
+end

data/test/static_test.rb CHANGED

@@ -1,10 +1,10 @@
-require File.dirname(__FILE__) + '/helper'
+require File.expand_path('../helper', __FILE__)
 class StaticTest < Test::Unit::TestCase
   setup do
     mock_app {
       set :static, true
-      set :public, File.dirname(__FILE__)
+      set :public_folder, File.dirname(__FILE__)
     }
   end
@@ -36,7 +36,6 @@ class StaticTest < Test::Unit::TestCase
     head "/#{File.basename(__FILE__)}"
     assert ok?
     assert_equal '', body
-    assert_equal File.size(__FILE__).to_s, response['Content-Length']
     assert response.headers.include?('Last-Modified')
   end
@@ -66,7 +65,7 @@ class StaticTest < Test::Unit::TestCase
   end
   it 'passes to the next handler when the public option is nil' do
-    @app.set :public, nil
+    @app.set :public_folder, nil
     get "/#{File.basename(__FILE__)}"
     assert not_found?
   end
@@ -85,9 +84,94 @@ class StaticTest < Test::Unit::TestCase
   it '404s when .. path traverses outside of public directory' do
     mock_app {
       set :static, true
-      set :public, File.dirname(__FILE__) + '/data'
+      set :public_folder, File.dirname(__FILE__) + '/data'
     }
     get "/../#{File.basename(__FILE__)}"
     assert not_found?
   end
+  def assert_valid_range(http_range, range, path, file)
+    request = Rack::MockRequest.new(@app)
+    response = request.get("/#{File.basename(path)}", 'HTTP_RANGE' => http_range)
+    should_be = file[range]
+    expected_range = "bytes #{range.begin}-#{range.end}/#{file.length}"
+    assert_equal 206,response.status, "Should be HTTP/1.1 206 Partial content"
+    assert_equal should_be.length, response.body.length, "Unexpected response length for #{http_range}"
+    assert_equal should_be, response.body, "Unexpected response data for #{http_range}"
+    assert_equal should_be.length.to_s, response['Content-Length'], "Incorrect Content-Length for #{http_range}"
+    assert_equal expected_range, response['Content-Range'], "Incorrect Content-Range for #{http_range}"
+  end
+  it 'handles valid byte ranges correctly' do
+    # Use the biggest file in this dir so we can test ranges > 8k bytes. (StaticFile sends in 8k chunks.)
+    path = File.dirname(__FILE__) + '/helpers_test.rb'  # currently 16k bytes
+    file = File.read(path)
+    length = file.length
+    assert length > 9000, "The test file #{path} is too short (#{length} bytes) to run these tests"
+    [0..0, 42..88, 1234..1234, 100..9000, 0..(length-1), (length-1)..(length-1)].each do |range|
+      assert_valid_range("bytes=#{range.begin}-#{range.end}", range, path, file)
+    end
+    [0, 100, length-100, length-1].each do |start|
+      assert_valid_range("bytes=#{start}-", (start..length-1), path, file)
+    end
+    [1, 100, length-100, length-1, length].each do |range_length|
+      assert_valid_range("bytes=-#{range_length}", (length-range_length..length-1), path, file)
+    end
+    # Some valid ranges that exceed the length of the file:
+    assert_valid_range("bytes=100-999999", (100..length-1), path, file)
+    assert_valid_range("bytes=100-#{length}", (100..length-1), path, file)
+    assert_valid_range("bytes=-#{length}", (0..length-1), path, file)
+    assert_valid_range("bytes=-#{length+1}", (0..length-1), path, file)
+    assert_valid_range("bytes=-999999", (0..length-1), path, file)
+  end
+  it 'correctly ignores syntactically invalid range requests' do
+    # ...and also ignores multi-range requests, which aren't supported yet
+    ["bytes=45-40", "bytes=IV-LXVI", "octets=10-20", "bytes=-", "bytes=1-2,3-4"].each do |http_range|
+      request = Rack::MockRequest.new(@app)
+      response = request.get("/#{File.basename(__FILE__)}", 'HTTP_RANGE' => http_range)
+      assert_equal 200,response.status, "Invalid range '#{http_range}' should be ignored"
+      assert_equal nil,response['Content-Range'], "Invalid range '#{http_range}' should be ignored"
+    end
+  end
+  it 'returns error 416 for unsatisfiable range requests' do
+    # An unsatisfiable request is one that specifies a start that's at or past the end of the file.
+    length = File.read(__FILE__).length
+    ["bytes=888888-", "bytes=888888-999999", "bytes=#{length}-#{length}"].each do |http_range|
+      request = Rack::MockRequest.new(@app)
+      response = request.get("/#{File.basename(__FILE__)}", 'HTTP_RANGE' => http_range)
+      assert_equal 416,response.status, "Unsatisfiable range '#{http_range}' should return 416"
+      assert_equal "bytes */#{length}",response['Content-Range'], "416 response should include actual length"
+    end
+  end
+  it 'does not include static cache control headers by default' do
+    env = Rack::MockRequest.env_for("/#{File.basename(__FILE__)}")
+    status, headers, body = @app.call(env)
+    assert !headers.has_key?('Cache-Control')
+  end
+  it 'sets cache control headers on static files if set' do
+    @app.set :static_cache_control, :public
+    env = Rack::MockRequest.env_for("/#{File.basename(__FILE__)}")
+    status, headers, body = @app.call(env)
+    assert headers.has_key?('Cache-Control')
+    assert_equal headers['Cache-Control'], 'public'
+    @app.set :static_cache_control, [:public, :must_revalidate, {:max_age => 300}]
+    env = Rack::MockRequest.env_for("/#{File.basename(__FILE__)}")
+    status, headers, body = @app.call(env)
+    assert headers.has_key?('Cache-Control')
+    assert_equal headers['Cache-Control'], 'public, must-revalidate, max-age=300'
+  end
 end

data/test/streaming_test.rb ADDED

@@ -0,0 +1,140 @@
+require File.expand_path('../helper', __FILE__)
+class StreamingTest < Test::Unit::TestCase
+  Stream = Sinatra::Helpers::Stream
+  it 'returns the concatinated body' do
+    mock_app do
+      get '/' do
+        stream do |out|
+          out << "Hello" << " "
+          out << "World!"
+        end
+      end
+    end
+    get('/')
+    assert_body "Hello World!"
+  end
+  it 'always yields strings' do
+    stream = Stream.new { |out| out << :foo }
+    stream.each { |str| assert_equal 'foo', str }
+  end
+  it 'postpones body generation' do
+    step = 0
+    stream = Stream.new do |out|
+      10.times do
+        out << step
+        step += 1
+      end
+    end
+    stream.each do |s|
+      assert_equal s, step.to_s
+      step += 1
+    end
+  end
+  it 'calls the callback after it is done' do
+    step   = 0
+    final  = 0
+    stream = Stream.new { |o| 10.times { step += 1 }}
+    stream.callback { final = step }
+    stream.each { |str| }
+    assert_equal 10, final
+  end
+  it 'does not trigger the callback if close is set to :keep_open' do
+    step   = 0
+    final  = 0
+    stream = Stream.new(Stream, :keep_open) { |o| 10.times { step += 1 } }
+    stream.callback { final = step }
+    stream.each { |str| }
+    assert_equal 0, final
+  end
+  it 'allows adding more than one callback' do
+    a = b = false
+    stream = Stream.new { }
+    stream.callback { a = true }
+    stream.callback { b = true }
+    stream.each { |str| }
+    assert a, 'should trigger first callback'
+    assert b, 'should trigger second callback'
+  end
+  class MockScheduler
+    def initialize(*)     @schedule, @defer = [], []                end
+    def schedule(&block)  @schedule << block                        end
+    def defer(&block)     @defer    << block                        end
+    def schedule!(*)      @schedule.pop.call until @schedule.empty? end
+    def defer!(*)         @defer.pop.call    until @defer.empty?    end
+  end
+  it 'allows dropping in another scheduler' do
+    scheduler  = MockScheduler.new
+    processing = sending = done = false
+    stream = Stream.new(scheduler) do |out|
+      processing = true
+      out << :foo
+    end
+    stream.each { sending = true}
+    stream.callback { done = true }
+    scheduler.schedule!
+    assert !processing
+    assert !sending
+    assert !done
+    scheduler.defer!
+    assert processing
+    assert !sending
+    assert !done
+    scheduler.schedule!
+    assert sending
+    assert done
+  end
+  it 'schedules exceptions to be raised on the main thread/event loop/...' do
+    scheduler = MockScheduler.new
+    Stream.new(scheduler) { fail 'should be caught' }.each { }
+    scheduler.defer!
+    assert_raise(RuntimeError) { scheduler.schedule! }
+  end
+  it 'does not trigger an infinite loop if you call close in a callback' do
+    stream = Stream.new { |out| out.callback { out.close }}
+    stream.each { |str| }
+  end
+  it 'gives access to route specific params' do
+    mock_app do
+      get('/:name') { stream { |o| o << params[:name] }}
+    end
+    get '/foo'
+    assert_body 'foo'
+  end
+  it 'sets up async.close if available' do
+    ran = false
+    mock_app do
+      get('/') do
+        close = Object.new
+        def close.callback; yield end
+        def close.errback; end
+        env['async.close'] = close
+        stream(:keep_open) do |out|
+          out.callback { ran = true }
+        end
+      end
+    end
+    get '/'
+    assert ran
+  end
+end

data/test/templates_test.rb CHANGED

@@ -1,9 +1,10 @@
-require File.dirname(__FILE__) + '/helper'
+# encoding: UTF-8
+require File.expand_path('../helper', __FILE__)
+File.delete(File.dirname(__FILE__) + '/views/layout.test') rescue nil
 class TestTemplate < Tilt::Template
   def prepare
   end
-  alias compile! prepare # for tilt < 0.7
   def evaluate(scope, locals={}, &block)
     inner = block ? block.call : ''
@@ -14,9 +15,11 @@ class TestTemplate < Tilt::Template
 end
 class TemplatesTest < Test::Unit::TestCase
-  def render_app(base=Sinatra::Base, &block)
+  def render_app(base=Sinatra::Base, options = {}, &block)
+    base, options = Sinatra::Base, base if base.is_a? Hash
     mock_app(base) {
       set :views, File.dirname(__FILE__) + '/views'
+      set options
       get '/', &block
       template(:layout3) { "Layout 3!\n" }
     }
@@ -77,12 +80,48 @@ class TemplatesTest < Test::Unit::TestCase
     assert_equal "Layout 3!\nHello World!\n", body
   end
+  it 'avoids wrapping layouts around nested templates' do
+    render_app { render :str, :nested, :layout => :layout2 }
+    assert ok?
+    assert_equal "<h1>String Layout!</h1>\n<content><h1>Hello From String</h1></content>", body
+  end
+  it 'allows explicitly wrapping layouts around nested templates' do
+    render_app { render :str, :explicitly_nested, :layout => :layout2 }
+    assert ok?
+    assert_equal "<h1>String Layout!</h1>\n<content><h1>String Layout!</h1>\n<h1>Hello From String</h1></content>", body
+  end
+  it 'two independent render calls do not disable layouts' do
+    render_app do
+      render :str, :explicitly_nested, :layout => :layout2
+      render :str, :nested, :layout => :layout2
+    end
+    assert ok?
+    assert_equal "<h1>String Layout!</h1>\n<content><h1>Hello From String</h1></content>", body
+  end
+  it 'is possible to use partials in layouts' do
+    render_app do
+      settings.layout { "<%= erb 'foo' %><%= yield %>" }
+      erb 'bar'
+    end
+    assert ok?
+    assert_equal "foobar", body
+  end
   it 'loads templates from source file' do
     mock_app { enable :inline_templates }
     assert_equal "this is foo\n\n", @app.templates[:foo][0]
     assert_equal "X\n= yield\nX\n", @app.templates[:layout][0]
   end
+  it 'ignores spaces after names of inline templates' do
+    mock_app { enable :inline_templates }
+    assert_equal "There's a space after 'bar'!\n\n", @app.templates[:bar][0]
+    assert_equal "this is not foo\n\n", @app.templates[:"foo bar"][0]
+  end
   it 'loads templates from given source file' do
     mock_app { set :inline_templates, __FILE__ }
     assert_equal "this is foo\n\n", @app.templates[:foo][0]
@@ -98,8 +137,14 @@ class TemplatesTest < Test::Unit::TestCase
     assert @app.templates.empty?
   end
+  it 'allows unicode in inline templates' do
+    mock_app { set :inline_templates, __FILE__ }
+    assert_equal "Den som tror at hemma det är där man bor har aldrig vart hos mig.\n\n",
+      @app.templates[:umlaut][0]
+  end
   it 'loads templates from specified views directory' do
-    render_app { render :test, :hello, :views => options.views + '/foo' }
+    render_app { render :test, :hello, :views => settings.views + '/foo' }
     assert_equal "from another views directory\n", body
   end
@@ -128,6 +173,24 @@ class TemplatesTest < Test::Unit::TestCase
     assert_equal 'bar', body
   end
+  it 'allows setting default content type per template engine' do
+    render_app(:str => { :content_type => :txt }) { render :str, 'foo' }
+    assert_equal 'text/plain;charset=utf-8', response['Content-Type']
+  end
+  it 'setting default content type does not affect other template engines' do
+    render_app(:str => { :content_type => :txt }) { render :test, 'foo' }
+    assert_equal 'text/html;charset=utf-8', response['Content-Type']
+  end
+  it 'setting default content type per template engine does not override content_type' do
+    render_app :str => { :content_type => :txt } do
+      content_type :html
+      render :str, 'foo'
+    end
+    assert_equal 'text/html;charset=utf-8', response['Content-Type']
+  end
   it 'uses templates in superclasses before subclasses' do
     base = Class.new(Sinatra::Base)
     base.template(:foo) { 'template in superclass' }
@@ -144,6 +207,73 @@ class TemplatesTest < Test::Unit::TestCase
     assert ok?
     assert_equal 'template in subclass', body
   end
+  it "is possible to use a different engine for the layout than for the template itself explicitely" do
+    render_app do
+      settings.template(:layout) { 'Hello <%= yield %>!' }
+      render :str, "<%= 'World' %>", :layout_engine => :erb
+    end
+    assert_equal "Hello <%= 'World' %>!", body
+  end
+  it "is possible to use a different engine for the layout than for the template itself globally" do
+    render_app :str => { :layout_engine => :erb } do
+      settings.template(:layout) { 'Hello <%= yield %>!' }
+      render :str, "<%= 'World' %>"
+    end
+    assert_equal "Hello <%= 'World' %>!", body
+  end
+  it "does not leak the content type to the template" do
+    render_app :str => { :layout_engine => :erb } do
+      settings.template(:layout) { 'Hello <%= yield %>!' }
+      render :str, "<%= 'World' %>", :content_type => :txt
+    end
+    assert_equal "text/html;charset=utf-8", headers['Content-Type']
+  end
+  it "is possible to register another template" do
+    Tilt.register "html.erb", Tilt[:erb]
+    render_app { render :erb, :calc }
+    assert_equal '2', body
+  end
+  it "passes scope to the template" do
+    mock_app do
+      template :scoped do
+        'Hello <%= foo %>'
+      end
+      get '/' do
+        some_scope = Object.new
+        def some_scope.foo() 'World!' end
+        erb :scoped, :scope => some_scope
+      end
+    end
+    get '/'
+    assert ok?
+    assert_equal 'Hello World!', body
+  end
+  it "is possible to use custom logic for finding template files" do
+    mock_app do
+      set :views, ["a", "b"].map { |d| File.dirname(__FILE__) + '/views/' + d }
+      def find_template(views, name, engine, &block)
+        Array(views).each { |v| super(v, name, engine, &block) }
+      end
+      get('/:name') do
+        render :str, params[:name].to_sym
+      end
+    end
+    get '/in_a'
+    assert_body 'Gimme an A!'
+    get '/in_b'
+    assert_body 'Gimme a B!'
+  end
 end
 # __END__ : this is not the real end of the script.
@@ -153,6 +283,15 @@ __END__
@@ foo
 this is foo
+@@ bar
+There's a space after 'bar'!
+@@ foo bar
+this is not foo
+@@ umlaut
+Den som tror at hemma det är där man bor har aldrig vart hos mig.
@@ layout
 X
 = yield