sinatra-contrib 1.4.7 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07b51967ed5d44b1b33b30808e889bea7f108f23
-  data.tar.gz: 10bb9a0e8d0242f9b965925831faddb891621366
+  metadata.gz: a2219eae01829dc23fe37858de893ee0bae5ae98
+  data.tar.gz: 04ee39f956e7420d07cbc39f853dc97f43a9702b
 SHA512:
-  metadata.gz: a1cf5ddaab8baa205ddd02411904e7c7eac393573a352f0a9be0757797a60e07ff9ce7a2d84b870ca7495724ac8bf116f788c517ed0b0023c5823d492071a7d7
-  data.tar.gz: d7c55267680752f344a9248d3af5ef8440689edd415c08a31324cb3e8c290e18418df275afc8b7e7dc8b55d4026b94a47581c1ee3dd14beef04c48d5ab1b2519
+  metadata.gz: 5c2e640a53fd704cb2fe4f152da9dac0b75bc69b59386ce805b30f2e7e9716dcebbaf493f9f63738cf57407515082dcf4f6bdbde142546708356fb5423434c23
+  data.tar.gz: b35240ae66107dc1ebdd39e69a6efaebe6580ec852bf8f552b0c6f0e28404636b5ba3fafba3ccf0c84358b954772fc7c76204e8801f4f4348b35d20d42f3e075

data/README.md

@@ -1,16 +1,16 @@
-[![Build Status](https://secure.travis-ci.org/sinatra/sinatra-contrib.png)](http://travis-ci.org/sinatra/sinatra-contrib)
+# Sinatra::Contrib
 
 Collection of common Sinatra extensions, semi-officially supported.
 
-# Goals
+## Goals
 
 * For every future Sinatra release, have at least one fully compatible release
 * High code quality, high test coverage
 * Include plugins people usually ask for a lot
 
-# Included extensions
+## Included extensions
 
-## Common Extensions
+### Common Extensions
 
 These are common extension which will not add significant overhead or change any
 behavior of already existing APIs. They do not add any dependencies not already
@@ -49,34 +49,45 @@ Currently included:
   logger instance using +logger+ setting. That logger then will
   be available as #logger helper method in your routes and views.
 
-## Custom Extensions
+* `sinatra/required_params`: Ensure if required query parameters exist
+
+### Custom Extensions
 
 These extensions may add additional dependencies and enhance the behavior of the
 existing APIs.
 
 Currently included:
 
-* `sinatra/decompile`: Recreates path patterns from Sinatra's internal data
-  structures (used by other extensions).
-
 * `sinatra/reloader`: Automatically reloads Ruby files on code changes.
 
-## Other Tools
+### Other Tools
 
 * `sinatra/extension`: Mixin for writing your own Sinatra extensions.
 
 * `sinatra/test_helpers`: Helper methods to ease testing your Sinatra
   application. Partly extracted from Sinatra. Testing framework agnostic
 
-# Installation
-Add `gem 'sinatra-contrib'` to *Gemfile*, then execute `bundle install`.  
+## Installation
+
+Add `gem 'sinatra-contrib'` to *Gemfile*, then execute `bundle install`.
 
 If you don't use Bundler, install the gem manually by executing `gem install sinatra-contrib` in your command line.
 
+### Git
+
+If you want to use the gem from git, for whatever reason, you can do the following:
+
+```ruby
+github 'sinatra/sinatra' do
+  gem 'sinatra-contrib'
+end
+```
+
+Within this block you can also specify other gems from this git repository.
 
-# Usage
+## Usage
 
-## Classic Style
+### Classic Style
 
 A single extension (example: sinatra-content-for):
 
@@ -99,7 +110,7 @@ require 'sinatra'
 require 'sinatra/contrib/all'
 ```
 
-## Modular Style
+### Modular Style
 
 A single extension (example: sinatra-content-for):
 
@@ -138,7 +149,7 @@ class MyApp < Sinatra::Base
 end
 ```
 
-## Documentation
+### Documentation
 
 For more info check the [official docs](http://www.sinatrarb.com/contrib/) and
-[api docs](http://rubydoc.info/gems/sinatra-contrib/1.4.0/frames).
+[api docs](http://www.rubydoc.info/gems/sinatra-contrib).

data/Rakefile

@@ -57,7 +57,6 @@ task :release => :gemspec do
     gem push sinatra-contrib*.gem  &&
     git commit --allow-empty -a -m '#{Sinatra::Contrib::VERSION} release'  &&
     git tag -s v#{Sinatra::Contrib::VERSION} -m '#{Sinatra::Contrib::VERSION} release'  &&
-    git tag -s #{Sinatra::Contrib::VERSION} -m '#{Sinatra::Contrib::VERSION} release'  &&
     git push && (git push origin master || true) &&
     git push --tags && (git push origin --tags || true)
   SH

data/lib/sinatra/config_file.rb

@@ -128,9 +128,9 @@ module Sinatra
       Dir.chdir(root || '.') do
         paths.each do |pattern|
           Dir.glob(pattern) do |file|
+            raise UnsupportedConfigType unless ['.yml', '.erb'].include?(File.extname(file))
             $stderr.puts "loading config file '#{file}'" if logging?
-            document = IO.read(file)
-            document = ERB.new(document).result if file.split('.').include?('erb')
+            document = ERB.new(IO.read(file)).result
             yaml = config_for_env(YAML.load(document)) || {}
             yaml.each_pair do |key, value|
               for_env = config_for_env(value)
@@ -141,6 +141,12 @@ module Sinatra
       end
     end
 
+    class UnsupportedConfigType < Exception
+      def message
+        'Invalid config file type, use .yml or .yml.erb'
+      end
+    end
+
     private
 
     # Given a +hash+ with some application configuration it returns the

data/lib/sinatra/content_for.rb

@@ -27,6 +27,15 @@ module Sinatra
   #     # layout.erb
   #     <%= yield_content :some_key %>
   #
+  # If you have provided +yield_content+ with a block and no content for the
+  # specified key is found, it will render the results of the block provided
+  # to yield_content.
+  #
+  #     # layout.erb
+  #     <%= yield_content :some_key_with_no_content do %>
+  #       <chunk of="default html">...</chunk>
+  #     <% end %>
+  #
   # === Classic Application
   #
   # To use the helpers in a classic application all you need to do is require
@@ -59,6 +68,46 @@ module Sinatra
   # layout, inside the <head> tag, and each view can call <tt>content_for</tt>
   # setting the appropriate set of tags that should be added to the layout.
   #
+  # == Limitations
+  #
+  # Due to the rendering process limitation using <tt><%= yield_content %></tt>
+  # from within nested templates do not work above the <tt><%= yield %> statement.
+  # For more details https://github.com/sinatra/sinatra-contrib/issues/140#issuecomment-48831668
+  #
+  #     # app.rb
+  #     get '/' do
+  #       erb :body, :layout => :layout do
+  #         erb :foobar
+  #       end
+  #     end
+  #
+  #     # foobar.erb
+  #     <% content_for :one do %>
+  #       <script>
+  #         alert('one');
+  #       </script>
+  #     <% end %>
+  #     <% content_for :two do %>
+  #       <script>
+  #         alert('two');
+  #       </script>
+  #     <% end %>
+  #
+  # Using <tt><%= yield_content %></tt> before <tt><%= yield %></tt> will cause only the second
+  # alert to display:
+  #
+  #     # body.erb
+  #     # Display only second alert
+  #     <%= yield_content :one %>
+  #     <%= yield %>
+  #     <%= yield_content :two %>
+  #
+  #     # body.erb
+  #     # Display both alerts
+  #     <%= yield %>
+  #     <%= yield_content :one %>
+  #     <%= yield_content :two %>
+  #
   module ContentFor
     include Capture
 
@@ -68,6 +117,10 @@ module Sinatra
     #       <script type="text/javascript" src="/foo.js"></script>
     #     <% end %>
     #
+    # You can also pass an immediate value instead of a block:
+    #
+    #     <% content_for :title, "foo" %>
+    #
     # You can call +content_for+ multiple times with the same key
     # (in the example +:head+), and when you render the blocks for
     # that key all of them will be rendered, in the same order you
@@ -75,7 +128,8 @@ module Sinatra
     #
     # Your blocks can also receive values, which are passed to them
     # by <tt>yield_content</tt>
-    def content_for(key, &block)
+    def content_for(key, value = nil, &block)
+      block ||= proc { |*| value }
       content_blocks[key.to_sym] << capture_later(&block)
     end
 
@@ -93,6 +147,13 @@ module Sinatra
       content_blocks[key.to_sym].any?
     end
 
+    # Unset a named block of content. For example:
+    #
+    #    <% clear_content_for :head %>
+    def clear_content_for(key)
+      content_blocks.delete(key.to_sym) if content_for?(key)
+    end
+
     # Render the captured blocks for a given key. For example:
     #
     #     <head>
@@ -111,6 +172,7 @@ module Sinatra
     # Would pass <tt>1</tt> and <tt>2</tt> to all the blocks registered
     # for <tt>:head</tt>.
     def yield_content(key, *args)
+      return yield(*args) if block_given? && content_blocks[key.to_sym].empty?
       content_blocks[key.to_sym].map { |b| capture(*args, &b) }.join
     end
 

data/lib/sinatra/contrib.rb

@@ -19,13 +19,13 @@ module Sinatra
       helpers :JSON
       helpers :LinkHeader
       helpers :Streaming
+      helpers :RequiredParams
     end
 
     ##
     # Other extensions you don't want to be loaded unless needed.
     module Custom
       # register :Compass
-      register :Decompile
       register :Reloader
     end
 

data/lib/sinatra/contrib/version.rb

@@ -1,17 +1,6 @@
 module Sinatra
   module Contrib
-    def self.version
-      VERSION
-    end
-
-    SIGNATURE = [1, 4, 7]
-    VERSION   = SIGNATURE.join('.')
-
-    VERSION.extend Comparable
-    def VERSION.<=>(other)
-      other = other.split('.').map { |i| i.to_i } if other.respond_to? :split
-      SIGNATURE <=> Array(other)
-    end
+    VERSION = ::Sinatra::VERSION
   end
 end
 

data/lib/sinatra/cookies.rb

@@ -166,7 +166,7 @@ module Sinatra
       alias member?  has_key?
 
       def index(value)
-        warn "Hash#index is deprecated; use Hash#key" if RUBY_VERSION > '1.9'
+        warn "Hash#index is deprecated; use Hash#key"
         key(value)
       end
 

data/lib/sinatra/link_header.rb

@@ -90,7 +90,7 @@ module Sinatra
       link          = (response["Link"] ||= "")
 
       urls.map do |url|
-        link << "\n" unless link.empty?
+        link << ",\n" unless link.empty?
         link << (http_pattern % url)
         html_pattern % url
       end.join "\n"
@@ -117,7 +117,7 @@ module Sinatra
     def link_headers
       yield if block_given?
       return "" unless response.include? "Link"
-      response["Link"].lines.map do |line|
+      response["Link"].split(",\n").map do |line|
         url, *opts = line.split(';').map(&:strip)
         "<link href=\"#{url[1..-2]}\" #{opts.join " "} />"
       end.join "\n"

data/lib/sinatra/namespace.rb

@@ -1,6 +1,6 @@
 require 'backports'
 require 'sinatra/base'
-require 'sinatra/decompile'
+require 'mustermann'
 
 module Sinatra
 
@@ -48,6 +48,14 @@ module Sinatra
   #       # More admin routes...
   #     end
   #
+  # Regex is also accepted:
+  #
+  #     namespace /\/posts\/([^\/&?]+)\// do
+  #       get { haml :blog }
+  #
+  #       # More blog routes...
+  #     end
+  #
   # When you define a filter or an error handler, or register an extension or a
   # set of helpers within a namespace, they only affect the routes defined in
   # it.  For instance, lets define a before filter to prevent the access of
@@ -89,6 +97,18 @@ module Sinatra
   #       # More admin routes...
   #     end
   #
+  # Redirecting within the namespace can be done using redirect_to:
+  #
+  #     namespace '/admin' do
+  #       get '/foo'  do
+  #         redirect_to '/bar' # Redirects to /admin/bar
+  #       end
+  #
+  #       get '/foo' do
+  #         redirect '/bar' # Redirects to /bar
+  #       end
+  #     end
+  #
   # === Classic Application Setup
   #
   # To be able to use namespaces in a classic application all you need to do is
@@ -97,7 +117,8 @@ module Sinatra
   #     require "sinatra"
   #     require "sinatra/namespace"
   #
-  #     # The rest of your classic application code goes here...
+  #     namespace '/users' do
+  #     end
   #
   # === Modular Application Setup
   #
@@ -110,9 +131,60 @@ module Sinatra
   #     class MyApp < Sinatra::Base
   #       register Sinatra::Namespace
   #
-  #       # The rest of your modular application code goes here...
+  #       namespace '/users' do
+  #       end
   #     end
   #
+  # === Within an extension
+  #
+  # To be able to use namespaces within an extension, you need to first create
+  # an extension. This includes defining the `registered(app)` method in the
+  # module.
+  #
+  #     require 'sinatra/base' # For creating Sinatra extensions
+  #     require 'sinatra/namespace' # To create namespaces
+  #
+  #     module Zomg # Keep everything under "Zomg" namespace for sanity
+  #       module Routes # Define a new "Routes" module
+  #
+  #         self.registered(app)
+  #           # First, register the Namespace extension
+  #           app.register Sinatra::Namespace
+  #
+  #           # This defines an `/api` namespace on the application
+  #           app.namespace '/api' do
+  #             get '/users' do
+  #               # do something with `GET "/api/users"`
+  #             end
+  #           end
+  #
+  #         end
+  #       end
+  #
+  #       # Lastly, register the extension to use in our app
+  #       Sinatra.register Routes
+  #     end
+  #
+  # In order to use this extension, is the same as any other Sinatra extension:
+  #
+  #     module Zomg
+  #       # Define our app class, we use modular app for this example
+  #       class App < Sinatra::Base
+  #         # this gives us all the namespaces we defined earlier
+  #         register Routes
+  #
+  #         get '/' do
+  #           "Welcome to my application!"
+  #         end
+  #       end
+  #     end
+  #
+  #     Zomg::App.run! # Don't forget to start your app ;)
+  #
+  # Phew! That was a mouthful.
+  #
+  # I hope that helps you use `Sinatra::Namespace` in every way imaginable!
+  #
   module Namespace
     def self.new(base, pattern, conditions = {}, &block)
       Module.new do
@@ -137,6 +209,10 @@ module Sinatra
       def template_cache
         super.fetch(:nested, @namespace) { Tilt::Cache.new }
       end
+
+      def redirect_to(uri, *args)
+        redirect("#{@namespace.pattern}#{uri}", *args)
+      end
     end
 
     module SharedMethods
@@ -147,7 +223,6 @@ module Sinatra
 
     module NamespacedMethods
       include SharedMethods
-      include Sinatra::Decompile
       attr_reader :base, :templates
 
       def self.prefixed(*names)
@@ -187,9 +262,10 @@ module Sinatra
       end
 
       def error(*codes, &block)
-        args  = Sinatra::Base.send(:compile!, "ERROR", regexpify(@pattern), block)
+        args  = Sinatra::Base.send(:compile!, "ERROR", /.*/, block)
         codes = codes.map { |c| Array(c) }.flatten
         codes << Exception if codes.empty?
+        codes << Sinatra::NotFound if codes.include?(404)
 
         codes.each do |c|
           errors = @errors[c] ||= []
@@ -226,6 +302,10 @@ module Sinatra
         template name, &block
       end
 
+      def pattern
+        @pattern
+      end
+
       private
 
       def app
@@ -246,22 +326,14 @@ module Sinatra
       end
 
       def prefixed_path(a, b)
-        return a || b || // unless a and b
-        a, b = decompile(a), decompile(b) unless a.class == b.class
-        a, b = regexpify(a), regexpify(b) unless a.class == b.class
-        path = a.class.new "#{a}#{b}"
-        path = /^#{path}$/ if path.is_a? Regexp and base == app
-        path
-      end
+        return a || b || /.*/ unless a and b
+        return Mustermann.new(b) if a == /.*/
 
-      def regexpify(pattern)
-        pattern = Sinatra::Base.send(:compile, pattern).first.inspect
-        pattern.gsub! /^\/(\^|\\A)?|(\$|\\z)?\/$/, ''
-        Regexp.new pattern
+        Mustermann.new(a) + Mustermann.new(b)
       end
 
       def prefixed(method, pattern = nil, conditions = {}, &block)
-        default = '*' if method == :before or method == :after
+        default = /.*/ if method == :before or method == :after
         pattern, conditions = compile pattern, conditions, default
         result = base.send(method, pattern, conditions, &block)
         invoke_hook :route_added, method.to_s.upcase, pattern, block
@@ -281,7 +353,7 @@ module Sinatra
       include SharedMethods
     end
 
-    def self.extend_object(base)
+    def self.extended(base)
       base.extend BaseMethods
     end
   end