sinatra-contrib 1.3.2 → 1.4.0

data/lib/sinatra/reloader.rb

@@ -13,7 +13,7 @@ module Sinatra
   #
   # === Classic Application
   #
-  # To enable the realoader in a classic application all you need to do is
+  # To enable the reloader in a classic application all you need to do is
   # require it:
   #
   #     require "sinatra"
@@ -23,7 +23,7 @@ module Sinatra
   #
   # === Modular Application
   #
-  # To enable the realoader in a modular application all you need to do is
+  # To enable the reloader in a modular application all you need to do is
   # require it, and then, register it:
   #
   #     require "sinatra/base"
@@ -75,7 +75,7 @@ module Sinatra
   module Reloader
 
     # Watches a file so it can tell when it has been updated, and what
-    # elements contains.
+    # elements does it contain.
     class Watcher
 
       # Represents an element of a Sinatra application that may need to
@@ -95,8 +95,8 @@ module Sinatra
       # Collection of file +Watcher+ that can be associated with a
       # Sinatra application.  That way, we can know which files belong
       # to a given application and which files have been modified.  It
-      # also provides a mechanism to inform a Watcher the elements
-      # defined in the file being watched and if it changes should be
+      # also provides a mechanism to inform a Watcher of the elements
+      # defined in the file being watched and if its changes should be
       # ignored.
       class List
         @app_list_map = Hash.new { |hash, key| hash[key] = new }
@@ -113,7 +113,7 @@ module Sinatra
           end
         end
 
-        # Lets the +Watcher+ for the file localted at +path+ know that the
+        # Lets the +Watcher+ for the file located at +path+ know that the
         # +element+ is defined there, and adds the +Watcher+ to the +List+,
         # if it isn't already there.
         def watch(path, element)
@@ -159,7 +159,7 @@ module Sinatra
         !ignore? && !removed? && mtime != File.mtime(path)
       end
 
-      # Updates the file being watched mtime.
+      # Updates the mtime of the file being watched.
       def update
         @mtime = File.mtime(path)
       end

data/lib/sinatra/respond_with.rb

@@ -1,11 +1,11 @@
-require 'sinatra/base'
 require 'sinatra/json'
+require 'sinatra/base'
 
 module Sinatra
-  ##
+  #
   # = Sinatra::RespondWith
   #
-  # This extensions lets Sinatra automatically choose what template to render or
+  # These extensions let Sinatra automatically choose what template to render or
   # action to perform depending on the request's Accept header.
   #
   # Example:
@@ -53,8 +53,8 @@ module Sinatra
   # == Security
   #
   # Since methods are triggered based on client input, this can lead to security
-  # issues (but not as seviere as those might apear in the first place: keep in
-  # mind that only known file extensions are used). You therefore should limit
+  # issues (but not as severe as those might appear in the first place: keep in
+  # mind that only known file extensions are used). You should limit
   # the possible formats you serve.
   #
   # This is possible with the +provides+ condition:
@@ -64,7 +64,7 @@ module Sinatra
   #   end
   #
   # However, since you have to set +provides+ for every route, this extension
-  # adds a app global (class method) `respond_to`, that let's you define content
+  # adds an app global (class method) `respond_to`, that lets you define content
   # types for all routes:
   #
   #   respond_to :html, :json, :xml, :atom
@@ -118,9 +118,9 @@ module Sinatra
         @app.halt 406
       end
 
-      def method_missing(meth, *args, &block)
-        return super if args.any? or block.nil? or not @app.mime_type(meth)
-        on(meth, &block)
+      def method_missing(method, *args, &block)
+        return super if args.any? or block.nil? or not @app.mime_type(method)
+        on(method, &block)
       end
     end
 
@@ -138,15 +138,18 @@ module Sinatra
             if args.any?
               locals = { :object => object }
               locals.merge! object.to_hash if object.respond_to? :to_hash
-              args << { :locals => locals }
-              halt send(*args)
+
+              renderer = args.first
+              options = args[1..-1] + [{:locals => locals}]
+
+              halt send(renderer, *options)
             end
           end
           if object
             exts.each do |ext|
               halt json(object) if ext == :json
-              next unless meth = "to_#{ext}" and object.respond_to? meth
-              halt(*object.send(meth))
+              next unless object.respond_to? method = "to_#{ext}"
+              halt(*object.send(method))
             end
           end
           false
@@ -161,7 +164,7 @@ module Sinatra
       private
 
       def template_for(name, exts)
-        # in production this is cached, so don't worry to much about runtime
+        # in production this is cached, so don't worry too much about runtime
         possible = []
         settings.template_engines[:all].each do |engine|
           exts.each { |ext| possible << [engine, "#{name}.#{ext}"] }
@@ -224,6 +227,7 @@ module Sinatra
       :css  => [:less,  :sass, :scss],
       :xml  => [:builder, :nokogiri],
       :js   => [:coffee],
+      :json => [:yajl],
       :html => [:erb, :erubis, :haml, :slim, :liquid, :radius, :mab, :markdown,
         :textile, :rdoc],
       :all  => Sinatra::Templates.instance_methods.map(&:to_sym) + [:mab] -

data/lib/sinatra/streaming.rb

@@ -7,7 +7,7 @@ module Sinatra
   # = Sinatra::Streaming
   #
   # Sinatra 1.3 introduced the +stream+ helper. This addon improves the
-  # streaming API by making the stream object immitate an IO object, turing
+  # streaming API by making the stream object immitate an IO object, turning
   # it into a real Deferrable and making the body play nicer with middleware
   # unaware of streaming.
   #
@@ -44,9 +44,9 @@ module Sinatra
   #
   # == Better Middleware Handling
   #
-  # Blocks passed to #map! or #map will actually be applied while streaming
-  # (as you might suspect, #map! applies modifications to the current body,
-  # #map creates a new one):
+  # Blocks passed to #map! or #map will actually be applied when streaming
+  # takes place (as you might have suspected, #map! applies modifications
+  # to the current body, while #map creates a new one):
   #
   #   class StupidMiddleware
   #     def initialize(app) @app = app end
@@ -89,7 +89,7 @@ module Sinatra
   #
   #   require "sinatra/base"
   #   require "sinatra/streaming"
-  #   
+  #
   #   class MyApp < Sinatra::Base
   #     helpers Sinatra::Streaming
   #   end
@@ -264,4 +264,4 @@ module Sinatra
   end
 
   helpers Streaming
-end
+end

data/lib/sinatra/test_helpers.rb

@@ -72,7 +72,7 @@ module Sinatra
 
     def session
       return {} unless last_request?
-      raise Rack::Test:Error, "session not enabled for app" unless last_env["rack.session"] or app.session?
+      raise Rack::Test::Error, "session not enabled for app" unless last_env["rack.session"] or app.session?
       last_request.session
     end
 

data/sinatra-contrib.gemspec

@@ -1,7 +1,7 @@
 # Run `rake sinatra-contrib.gemspec` to update the gemspec.
 Gem::Specification.new do |s|
   s.name        = "sinatra-contrib"
-  s.version     = "1.3.2"
+  s.version     = "1.4.0"
   s.description = "Collection of useful Sinatra extensions"
   s.homepage    = "http://github.com/sinatra/sinatra-contrib"
   s.summary     = s.description
@@ -10,17 +10,10 @@ Gem::Specification.new do |s|
   s.authors = [
     "Konstantin Haase",
     "Gabriel Andretta",
-    "Trevor Bramble",
     "Nicolas Sanguinetti",
-    "Ilya Shindyapin",
-    "Masahiro Fujiwara",
-    "Adrian Pacała",
-    "Andrew Crump",
     "Eliot Shepard",
-    "Eric Marden",
-    "Gray Manley",
+    "Andrew Crump",
     "Matt Lyon",
-    "lest",
     "undr"
   ]
 
@@ -28,17 +21,10 @@ Gem::Specification.new do |s|
   s.email = [
     "konstantin.mailinglists@googlemail.com",
     "ohhgabriel@gmail.com",
-    "inbox@trevorbramble.com",
     "contacto@nicolassanguinetti.info",
-    "ilya@shindyapin.com",
-    "m-fujiwara@axsh.net",
-    "altpacala@gmail.com",
-    "andrew.crump@ieee.org",
     "eshepard@slower.net",
-    "eric.marden@gmail.com",
-    "g.manley@tukaiz.com",
+    "andrew.crump@ieee.org",
     "matt@flowerpowered.com",
-    "just.lest@gmail.com",
     "undr@yandex.ru"
   ]
 
@@ -70,6 +56,7 @@ Gem::Specification.new do |s|
     "sinatra-contrib.gemspec",
     "spec/capture_spec.rb",
     "spec/config_file/key_value.yml",
+    "spec/config_file/key_value.yml.erb",
     "spec/config_file/key_value_override.yml",
     "spec/config_file/missing_env.yml",
     "spec/config_file/with_envs.yml",
@@ -79,10 +66,6 @@ Gem::Specification.new do |s|
     "spec/content_for/different_key.erubis",
     "spec/content_for/different_key.haml",
     "spec/content_for/different_key.slim",
-    "spec/content_for/footer.erb",
-    "spec/content_for/footer.erubis",
-    "spec/content_for/footer.haml",
-    "spec/content_for/footer.slim",
     "spec/content_for/layout.erb",
     "spec/content_for/layout.erubis",
     "spec/content_for/layout.haml",
@@ -129,7 +112,7 @@ Gem::Specification.new do |s|
     "spec/streaming_spec.rb"
   ]
 
-  s.add_dependency "sinatra",   "~> 1.3.0"
+  s.add_dependency "sinatra",   "~> 1.4.2"
   s.add_dependency "backports", ">= 2.0"
   s.add_dependency "tilt",      "~> 1.3"
   s.add_dependency "rack-test"

data/spec/capture_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'backports'
 require 'slim'
 require_relative 'spec_helper'
@@ -20,6 +21,7 @@ describe Sinatra::Capture do
 
   shared_examples_for "a template language" do |engine|
     lang = engine == :erubis ? :erb : engine
+    require "#{engine}"
 
     it "captures content" do
       render(engine, "simple_#{lang}").should == "Say Hello World!"
@@ -32,8 +34,15 @@ describe Sinatra::Capture do
 
   describe('haml')   { it_behaves_like "a template language", :haml   }
   describe('slim')   { it_behaves_like "a template language", :slim   }
-  describe('erb')    { it_behaves_like "a template language", :erb    }
   describe('erubis') { it_behaves_like "a template language", :erubis }
+
+  describe 'erb' do
+    it_behaves_like "a template language", :erb
+
+    it "handles utf-8 encoding" do
+      render(:erb, "utf_8").should == "UTF-8 –"
+    end
+  end
 end
 
 __END__
@@ -78,3 +87,7 @@ Say
     World
   #{b.strip}!
 Hello #{a.strip}
+
+@@ utf_8
+<% a = capture do %>–<% end %>
+UTF-8 <%= a %>

data/spec/config_file/key_value.yml.erb

@@ -0,0 +1,6 @@
+---
+foo: <%= "bar" %>
+something: <%= 42 %>
+nested:
+  a: <%= 1 %>
+  b: <%= 2 %>

data/spec/config_file_spec.rb

@@ -23,6 +23,16 @@ describe Sinatra::ConfigFile do
     settings.nested[:a].should == 1
   end
 
+  it 'should render options in ERB tags' do
+    config_file 'key_value.yml.erb'
+    settings.foo.should == "bar"
+    settings.something.should == 42
+    settings.nested['a'].should == 1
+    settings.nested[:a].should == 1
+    settings.nested['b'].should == 2
+    settings.nested[:b].should == 2
+  end
+
   it 'should recognize env specific settings per file' do
     config_file 'with_envs.yml'
     settings.foo.should == 'test'

data/spec/content_for_spec.rb

@@ -138,13 +138,13 @@ describe Sinatra::ContentFor do
           render(inner, :passes_values).should == "<i>1</i>2"
         end
       end
-      
+
       describe "with content_for? in Ruby" do
-        it 'renders block if key is set' do 
+        it 'renders block if key is set' do
           content_for(:foo) { "foot" }
           render(inner, :footer).should == "foot"
         end
-        
+
         it 'does not render a block if different key' do
           content_for(:different_key) { "foot" }
           render(inner, :footer).should be_empty

data/spec/cookies_spec.rb

@@ -154,11 +154,11 @@ describe Sinatra::Cookies do
       end.should be_nil
     end
 
-    it 'expiers existing cookies' do
+    it 'expires existing cookies' do
       cookie_route("foo=bar") do
         cookies.clear
         response['Set-Cookie']
-      end.should include("foo=; expires=Thu, 01-Jan-1970 00:00:00 GMT")
+      end.should include("foo=;", "expires=", "1970 00:00:00")
     end
   end
 
@@ -185,16 +185,32 @@ describe Sinatra::Cookies do
     it 'removes response cookies from cookies hash' do
       cookie_route do
         cookies['foo'] = 'bar'
-        cookies.clear
+        cookies.delete 'foo'
         cookies['foo']
       end.should be_nil
     end
 
-    it 'expiers existing cookies' do
+    it 'expires existing cookies' do
       cookie_route("foo=bar") do
         cookies.delete 'foo'
         response['Set-Cookie']
-      end.should include("foo=; expires=Thu, 01-Jan-1970 00:00:00 GMT")
+      end.should include("foo=;", "expires=", "1970 00:00:00")
+    end
+
+    it 'honours the app cookie_options' do
+      @cookie_app.class_eval do
+        set :cookie_options, {
+          :path => '/foo',
+          :domain => 'bar.com',
+          :secure => true,
+          :httponly => true
+        }
+      end
+      cookie_header = cookie_route("foo=bar") do
+        cookies.delete 'foo'
+        response['Set-Cookie']
+      end
+      cookie_header.should include("path=/foo;", "domain=bar.com;", "secure;", "HttpOnly")
     end
 
     it 'does not touch other cookies' do
@@ -466,7 +482,11 @@ describe Sinatra::Cookies do
     end
 
     it 'raises an exception if key does not exist' do
-      error = RUBY_VERSION >= '1.9' ? KeyError : IndexError
+      error = if defined? JRUBY_VERSION
+        IndexError
+      else
+        RUBY_VERSION >= '1.9' ? KeyError : IndexError
+      end
       expect { cookies.fetch('foo') }.to raise_exception(error)
     end
 

data/spec/json_spec.rb

@@ -1,4 +1,6 @@
 require 'backports'
+require 'multi_json'
+
 require_relative 'spec_helper'
 require_relative 'okjson'
 
@@ -41,8 +43,8 @@ describe Sinatra::JSON do
   end
 
   it "encodes objects to json out of the box" do
-    mock_app { get('/') { json :foo => [1, 'bar'] } }
-    results_in 'foo' => [1, 'bar']
+    mock_app { get('/') { json :foo => [1, 'bar', nil] } }
+    results_in 'foo' => [1, 'bar', nil]
   end
 
   it "sets the content type to 'application/json'" do
@@ -107,7 +109,7 @@ describe Sinatra::JSON do
     get('/').body.should == '42'
   end
 
-  describe('Yajl')    { it_should_behave_like "a json encoder", "yajl", "Yajl::Encoder" }
+  describe('Yajl')    { it_should_behave_like "a json encoder", "yajl", "Yajl::Encoder" } unless defined? JRUBY_VERSION
   describe('JSON')    { it_should_behave_like "a json encoder", "json", "::JSON"        }
   describe('OkJson')  { it_should_behave_like "a json encoder", nil,    "OkJson"        }
   describe('to_json') { it_should_behave_like "a json encoder", "json", ":to_json"      }

data/spec/multi_route_spec.rb

@@ -2,25 +2,23 @@ require 'backports'
 require_relative 'spec_helper'
 
 describe Sinatra::MultiRoute do
-  before do
-    count = 0
+
+  it 'does not break normal routing' do
     mock_app do
-      set(:some_condition) { |_| count += 1 }
       register Sinatra::MultiRoute
       get('/') { 'normal' }
-      get('/foo', '/bar', :some_condition => true) { 'paths' }
-      route('PUT', 'POST', '/') { 'verb' }
-      route(:get, '/baz') { 'symbol as verb' }
     end
-    @count = count
-  end
 
-  it 'does still allow normal routing' do
     get('/').should be_ok
     body.should be == 'normal'
   end
 
-  it 'supports multpile routes' do
+  it 'supports multiple routes' do
+    mock_app do
+      register Sinatra::MultiRoute
+      get('/foo', '/bar') { 'paths' }
+    end
+
     get('/foo').should be_ok
     body.should be == 'paths'
     get('/bar').should be_ok
@@ -28,10 +26,22 @@ describe Sinatra::MultiRoute do
   end
 
   it 'triggers conditions' do
-    @count.should be == 4
+    count = 0
+    mock_app do
+      register Sinatra::MultiRoute
+      set(:some_condition) { |_| count += 1 }
+      get('/foo', '/bar', :some_condition => true) { 'paths' }
+    end
+
+    count.should be == 4
   end
 
-  it 'supports multpile verbs' do
+  it 'supports multiple verbs' do
+    mock_app do
+      register Sinatra::MultiRoute
+      route('PUT', 'POST', '/') { 'verb' }
+    end
+
     post('/').should be_ok
     body.should be == 'verb'
     put('/').should be_ok
@@ -39,7 +49,12 @@ describe Sinatra::MultiRoute do
   end
 
   it 'takes symbols as verbs' do
+    mock_app do
+      register Sinatra::MultiRoute
+      route(:get, '/baz') { 'symbol as verb' }
+    end
+
     get('/baz').should be_ok
     body.should be == 'symbol as verb'
   end
-end
+end