sinatra-contrib 1.3.0

data/spec/respond_with/bar.erb

@@ -0,0 +1 @@
+Girl! I wanna take you to a ... bar!

data/spec/respond_with/bar.json.erb

@@ -0,0 +1 @@
+json!

data/spec/respond_with/foo.html.erb

@@ -0,0 +1 @@
+Hello <%= name %>!

data/spec/respond_with/not_html.sass

@@ -0,0 +1,2 @@
+body
+  color: red

data/spec/respond_with_spec.rb

@@ -0,0 +1,289 @@
+require 'backports'
+require_relative 'spec_helper'
+require_relative 'okjson'
+
+describe Sinatra::RespondWith do
+  def provides(*args)
+    @provides = args
+  end
+
+  def respond_app(&block)
+    types = @provides
+    mock_app do
+      set :app_file, __FILE__
+      set :views, root + '/respond_with'
+      register Sinatra::RespondWith
+      respond_to(*types) if types
+      class_eval(&block)
+    end
+  end
+
+  def respond_to(*args, &block)
+    respond_app { get('/') { respond_to(*args, &block) } }
+  end
+
+  def respond_with(*args, &block)
+    respond_app { get('/') { respond_with(*args, &block) } }
+  end
+
+  def req(*types)
+    p = types.shift if types.first.is_a? String and types.first.start_with? '/'
+    accept = types.map { |t| Sinatra::Base.mime_type(t).to_s }.join ','
+    get (p || '/'), {}, 'HTTP_ACCEPT' => accept
+  end
+
+  describe "Helpers#respond_to" do
+    it 'allows defining handlers by file extensions' do
+      respond_to do |format|
+        format.html { "html!" }
+        format.json { "json!" }
+      end
+
+      req(:html).body.should == "html!"
+      req(:json).body.should == "json!"
+    end
+
+    it 'respects quality' do
+      respond_to do |format|
+        format.html { "html!" }
+        format.json { "json!" }
+      end
+
+      req("text/html;q=0.7, application/json;q=0.3").body.should == "html!"
+      req("text/html;q=0.3, application/json;q=0.7").body.should == "json!"
+    end
+
+    it 'allows using mime types' do
+      respond_to do |format|
+        format.on('text/html') { "html!" }
+        format.json { "json!" }
+      end
+
+      req(:html).body.should == "html!"
+    end
+
+    it 'allows using wildcards in format matchers' do
+      respond_to do |format|
+        format.on('text/*') { "text!" }
+        format.json { "json!" }
+      end
+
+      req(:html).body.should == "text!"
+    end
+
+    it 'allows using catch all wildcards in format matchers' do
+      respond_to do |format|
+        format.on('*/*') { "anything!" }
+        format.json { "json!" }
+      end
+
+      req(:html).body.should == "anything!"
+    end
+
+    it 'prefers concret over generic' do
+      respond_to do |format|
+        format.on('text/*') { "text!" }
+        format.on('*/*') { "anything!" }
+        format.json { "json!" }
+      end
+
+      req(:json).body.should == "json!"
+      req(:html).body.should == "text!"
+    end
+
+    it 'does not set up default handlers' do
+      respond_to
+      req.should_not be_ok
+      status.should == 406
+    end
+  end
+
+  describe "Helpers#respond_with" do
+    describe "matching" do
+      it 'allows defining handlers by file extensions' do
+        respond_with(:ignore) do |format|
+          format.html { "html!" }
+          format.json { "json!" }
+        end
+
+        req(:html).body.should == "html!"
+        req(:json).body.should == "json!"
+      end
+
+      it 'respects quality' do
+        respond_with(:ignore) do |format|
+          format.html { "html!" }
+          format.json { "json!" }
+        end
+
+        req("text/html;q=0.7, application/json;q=0.3").body.should == "html!"
+        req("text/html;q=0.3, application/json;q=0.7").body.should == "json!"
+      end
+
+      it 'allows using mime types' do
+        respond_with(:ignore) do |format|
+          format.on('text/html') { "html!" }
+          format.json { "json!" }
+        end
+
+        req(:html).body.should == "html!"
+      end
+
+      it 'allows using wildcards in format matchers' do
+        respond_with(:ignore) do |format|
+          format.on('text/*') { "text!" }
+          format.json { "json!" }
+        end
+
+        req(:html).body.should == "text!"
+      end
+
+      it 'allows using catch all wildcards in format matchers' do
+        respond_with(:ignore) do |format|
+          format.on('*/*') { "anything!" }
+          format.json { "json!" }
+        end
+
+        req(:html).body.should == "anything!"
+      end
+
+      it 'prefers concret over generic' do
+        respond_with(:ignore) do |format|
+          format.on('text/*') { "text!" }
+          format.on('*/*') { "anything!" }
+          format.json { "json!" }
+        end
+
+        req(:json).body.should == "json!"
+        req(:html).body.should == "text!"
+      end
+    end
+
+    describe "default behavior" do
+      it 'converts objects to json out of the box' do
+        respond_with 'a' => 'b'
+        OkJson.decode(req(:json).body).should == {'a' => 'b'}
+      end
+
+      it 'handles multiple routes correctly' do
+        respond_app do
+          get('/') { respond_with 'a' => 'b' }
+          get('/:name') { respond_with 'a' => params[:name] }
+        end
+        OkJson.decode(req('/',  :json).body).should == {'a' => 'b'}
+        OkJson.decode(req('/b', :json).body).should == {'a' => 'b'}
+        OkJson.decode(req('/c', :json).body).should == {'a' => 'c'}
+      end
+
+      it "calls to_EXT if available" do
+        respond_with Struct.new(:to_pdf).new("hello")
+        req(:pdf).body.should == "hello"
+      end
+
+      it 'results in a 406 if format cannot be produced' do
+        respond_with({})
+        req(:html).should_not be_ok
+        status.should == 406
+      end
+    end
+
+    describe 'templates' do
+      it 'looks for templates with name.target.engine' do
+        respond_with :foo, :name => 'World'
+        req(:html).should be_ok
+        body.should == "Hello World!"
+      end
+
+      it 'looks for templates with name.engine for specific engines' do
+        respond_with :bar
+        req(:html).should be_ok
+        body.should == "Girl! I wanna take you to a ... bar!"
+      end
+
+      it 'does not use name.engine for engines producing other formats' do
+        respond_with :not_html
+        req(:html).should_not be_ok
+        status.should == 406
+        body.should be_empty
+      end
+
+      it 'falls back to #json if no template is found' do
+        respond_with :foo, :name => 'World'
+        req(:json).should be_ok
+        OkJson.decode(body).should == {'name' => 'World'}
+      end
+
+      it 'favors templates over #json' do
+        respond_with :bar, :name => 'World'
+        req(:json).should be_ok
+        body.should == 'json!'
+      end
+
+      it 'falls back to to_EXT if no template is found' do
+        object = {:name => 'World'}
+        def object.to_pdf; "hi" end
+        respond_with :foo, object
+        req(:pdf).should be_ok
+        body.should == "hi"
+      end
+    end
+
+    describe 'customizing' do
+      it 'allows customizing' do
+        respond_with(:foo, :name => 'World') { |f| f.html { 'html!' }}
+        req(:html).should be_ok
+        body.should == "html!"
+      end
+
+      it 'falls back to default behavior if none matches' do
+        respond_with(:foo, :name => 'World') { |f| f.json { 'json!' }}
+        req(:html).should be_ok
+        body.should == "Hello World!"
+      end
+
+      it 'favors generic rule over default behavior' do
+        respond_with(:foo, :name => 'World') { |f| f.on('*/*') { 'generic!' }}
+        req(:html).should be_ok
+        body.should == "generic!"
+      end
+    end
+  end
+
+  describe :respond_to do
+    it 'acts as global provides condition' do
+      respond_app do
+        respond_to :json, :html
+        get('/a') { 'ok' }
+        get('/b') { 'ok' }
+      end
+
+      req('/b', :xml).should_not be_ok
+      req('/b', :html).should be_ok
+    end
+
+    it 'still allows provides' do
+      respond_app do
+        respond_to :json, :html
+        get('/a') { 'ok' }
+        get('/b', :provides => :json) { 'ok' }
+      end
+
+      req('/b', :html).should_not be_ok
+      req('/b', :json).should be_ok
+    end
+
+    it 'plays well with namespaces' do
+      respond_app do
+        register Sinatra::Namespace
+        namespace '/a' do
+          respond_to :json
+          get { 'json' }
+        end
+        get('/b') { 'anything' }
+      end
+
+      req('/a', :html).should_not be_ok
+      req('/b', :html).should be_ok
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'sinatra/contrib'
+
+RSpec.configure do |config|
+  config.expect_with :rspec, :stdlib
+  config.include Sinatra::TestHelpers
+end

data/spec/streaming_spec.rb

@@ -0,0 +1,436 @@
+require 'backports'
+require_relative 'spec_helper'
+
+describe Sinatra::Streaming do
+  def stream(&block)
+    rack_middleware = @use
+    out = nil
+    mock_app do
+      rack_middleware.each { |args| use(*args) }
+      helpers Sinatra::Streaming
+      get('/') { out = stream(&block) }
+    end
+    get('/')
+    out
+  end
+
+  def use(*args)
+    @use << args
+  end
+
+  before do
+    @use = []
+  end
+
+  context 'stream test helper' do
+    it 'runs the given block' do
+      ran = false
+      stream { ran = true }
+      ran.should be_true
+    end
+
+    it 'returns the stream object' do
+      out = stream { }
+      out.should be_a(Sinatra::Helpers::Stream)
+    end
+
+    it 'fires a request against that stream' do
+      stream { |out| out << "Hello World!" }
+      last_response.should be_ok
+      body.should be == "Hello World!"
+    end
+
+    it 'passes the stream object to the block' do
+      passed   = nil
+      returned = stream { |out| passed = out }
+      passed.should be == returned
+    end
+  end
+
+  context Sinatra::Streaming::Stream do
+    it 'should extend the stream object' do
+      out = stream { }
+      out.should be_a(Sinatra::Streaming::Stream)
+    end
+
+    it 'should not extend stream objects of other apps' do
+      out = nil
+      mock_app { get('/') { out = stream { }}}
+      get('/')
+      out.should be_a(Sinatra::Helpers::Stream)
+      out.should_not be_a(Sinatra::Streaming::Stream)
+    end
+  end
+
+  context EventMachine::Deferrable do
+    it 'allows attaching more than one callback' do
+      a = b = false
+      stream do |out|
+        out.callback { a = true }
+        out.callback { b = true }
+      end
+      a.should be_true
+      b.should be_true
+    end
+
+    it 'triggers callbacks after streaming' do
+      triggered = false
+      stream do |out|
+        out.callback { triggered = true }
+        triggered.should be_false
+      end
+      triggered.should be_true
+    end
+  end
+
+  context 'app' do
+    it 'is the app instance the stream was created from' do
+      out = stream { }
+      out.app.should be_a(Sinatra::Base)
+    end
+  end
+
+  context 'lineno' do
+    it 'defaults to 0' do
+      stream { }.lineno.should be == 0
+    end
+
+    it 'does not increase on write' do
+      stream do |out|
+        out << "many\nlines\n"
+        out.lineno.should be == 0
+      end
+    end
+
+    it 'is writable' do
+      out = stream { }
+      out.lineno = 10
+      out.lineno.should be == 10
+    end
+  end
+
+  context 'pos' do
+    it 'defaults to 0' do
+      stream { }.pos.should be == 0
+    end
+
+    it 'increases when writing data' do
+      stream do |out|
+        out.pos.should be == 0
+        out << 'hi'
+        out.pos.should be == 2
+      end
+    end
+
+    it 'is writable' do
+      out = stream { }
+      out.pos = 10
+      out.pos.should be == 10
+    end
+
+    it 'aliased to #tell' do
+      out = stream { }
+      out.tell.should be == 0
+      out.pos = 10
+      out.tell.should be == 10
+    end
+  end
+
+  context 'closed' do
+    it 'returns false while streaming' do
+      stream { |out| out.should_not be_closed }
+    end
+
+    it 'returns true after streaming' do
+      stream {}.should be_closed
+    end
+  end
+
+  context 'map!' do
+    it 'applies transformations later' do
+      stream do |out|
+        out.map! { |s| s.upcase }
+        out << 'ok'
+      end
+      body.should be == "OK"
+    end
+
+    it 'is chainable' do
+      stream do |out|
+        out.map! { |s| s.upcase }
+        out.map! { |s| s.reverse }
+        out << 'ok'
+      end
+      body.should be == "KO"
+    end
+
+    it 'works with middleware' do
+      middleware = Class.new do
+        def initialize(app) @app = app end
+        def call(env)
+          status, headers, body = @app.call(env)
+          body.map! { |s| s.upcase }
+          [status, headers, body]
+        end
+      end
+
+      use middleware
+      stream { |out| out << "ok" }
+      body.should be == "OK"
+    end
+
+    it 'modifies each value separately' do
+      stream do |out|
+        out.map! { |s| s.reverse }
+        out << "ab" << "cd"
+      end
+      body.should be == "badc"
+    end
+  end
+
+  context 'map' do
+    it 'works with middleware' do
+      middleware = Class.new do
+        def initialize(app) @app = app end
+        def call(env)
+          status, headers, body = @app.call(env)
+          [status, headers, body.map(&:upcase)]
+        end
+      end
+
+      use middleware
+      stream { |out| out << "ok" }
+      body.should be == "OK"
+    end
+
+    it 'is chainable' do
+      middleware = Class.new do
+        def initialize(app) @app = app end
+        def call(env)
+          status, headers, body = @app.call(env)
+          [status, headers, body.map(&:upcase).map(&:reverse)]
+        end
+      end
+
+      use middleware
+      stream { |out| out << "ok" }
+      body.should be == "KO"
+    end
+
+    it 'can be written as each.map' do
+      middleware = Class.new do
+        def initialize(app) @app = app end
+        def call(env)
+          status, headers, body = @app.call(env)
+          [status, headers, body.each.map(&:upcase)]
+        end
+      end
+
+      use middleware
+      stream { |out| out << "ok" }
+      body.should be == "OK"
+    end
+
+    it 'does not modify the original body' do
+      stream do |out|
+        out.map { |s| s.reverse }
+        out << 'ok'
+      end
+      body.should be == 'ok'
+    end
+  end
+
+  context 'write' do
+    it 'writes to the stream' do
+      stream { |out| out.write 'hi' }
+      body.should be == 'hi'
+    end
+
+    it 'returns the number of bytes' do
+      stream do |out|
+        out.write('hi').should be == 2
+        out.write('hello').should be == 5
+      end
+    end
+
+    it 'accepts non-string objects' do
+      stream do |out|
+        out.write(12).should be == 2
+      end
+    end
+
+    it 'should be aliased to syswrite' do
+      stream { |out| out.syswrite('hi').should be == 2 }
+      body.should be == 'hi'
+    end
+
+    it 'should be aliased to write_nonblock' do
+      stream { |out| out.write_nonblock('hi').should be == 2 }
+      body.should be == 'hi'
+    end
+  end
+
+  context 'print' do
+    it 'writes to the stream' do
+      stream { |out| out.print('hi') }
+      body.should be == 'hi'
+    end
+
+    it 'accepts multiple arguments' do
+      stream { |out| out.print(1, 2, 3, 4) }
+      body.should be == '1234'
+    end
+
+    it 'returns nil' do
+      stream { |out| out.print('hi').should be_nil }
+    end
+  end
+
+  context 'printf' do
+    it 'writes to the stream' do
+      stream { |out| out.printf('hi') }
+      body.should be == 'hi'
+    end
+
+    it 'interpolates the format string' do
+      stream { |out| out.printf("%s: %d", "answer", 42) }
+      body.should be == 'answer: 42'
+    end
+
+    it 'returns nil' do
+      stream { |out| out.printf('hi').should be_nil }
+    end
+  end
+
+  context 'putc' do
+    it 'writes the first character of a string' do
+      stream { |out| out.putc('hi') }
+      body.should be == 'h'
+    end
+
+    it 'writes the character corresponding to an integer' do
+      stream { |out| out.putc(42) }
+      body.should be == '*'
+    end
+
+    it 'returns nil' do
+      stream { |out| out.putc('hi').should be_nil }
+    end
+  end
+
+  context 'puts' do
+    it 'writes to the stream' do
+      stream { |out| out.puts('hi') }
+      body.should be == "hi\n"
+    end
+
+    it 'accepts multiple arguments' do
+      stream { |out| out.puts(1, 2, 3, 4) }
+      body.should be == "1\n2\n3\n4\n"
+    end
+
+    it 'returns nil' do
+      stream { |out| out.puts('hi').should be_nil }
+    end
+  end
+
+  context 'close' do
+    it 'sets #closed? to true' do
+      stream do |out|
+        out.close
+        out.should be_closed
+      end
+    end
+
+    it 'sets #closed_write? to true' do
+      stream do |out|
+        out.should_not be_closed_write
+        out.close
+        out.should be_closed_write
+      end
+    end
+
+    it 'fires callbacks' do
+      stream do |out|
+        fired = false
+        out.callback { fired = true }
+        out.close
+        fired.should be_true
+      end
+    end
+
+    it 'prevents from further writing' do
+      stream do |out|
+        out.close
+        expect { out << 'hi' }.to raise_error(IOError, 'not opened for writing')
+      end
+    end
+  end
+
+  context 'close_read' do
+    it 'raises the appropriate exception' do
+      expect { stream { |out| out.close_read }}.
+        to raise_error(IOError, "closing non-duplex IO for reading")
+    end
+  end
+
+  context 'closed_read?' do
+    it('returns true') { stream { |out| out.should be_closed_read }}
+  end
+
+  context 'rewind' do
+    it 'resets pos' do
+      stream do |out|
+        out << 'hi'
+        out.rewind
+        out.pos.should be == 0
+      end
+    end
+
+    it 'resets lineno' do
+      stream do |out|
+        out.lineno = 10
+        out.rewind
+        out.lineno.should be == 0
+      end
+    end
+  end
+
+  raises = %w[
+    bytes eof? eof getbyte getc gets read read_nonblock readbyte readchar
+    readline readlines readpartial sysread ungetbyte ungetc
+  ]
+
+  enum    = %w[chars each_line each_byte each_char lines]
+  dummies = %w[flush fsync internal_encoding pid]
+
+  raises.each do |method|
+    context method do
+      it 'raises the appropriate exception' do
+        expect { stream { |out| out.public_send(method) }}.
+          to raise_error(IOError, "not opened for reading")
+      end
+    end
+  end
+
+  enum.each do |method|
+    context method do
+      it 'creates an Enumerator' do
+        stream { |out| out.public_send(method).should be_a(Enumerator) }
+      end
+
+      it 'calling each raises the appropriate exception' do
+        expect { stream { |out| out.public_send(method).each { }}}.
+          to raise_error(IOError, "not opened for reading")
+      end
+    end
+  end
+
+  dummies.each do |method|
+    context method do
+      it 'returns nil' do
+        stream { |out| out.public_send(method).should be_nil }
+      end
+    end
+  end
+end