sinatra-sinatra 0.9.1.1 → 0.9.1.2

data/CHANGES

@@ -1,3 +1,11 @@
+= 0.9.2 / unreleased
+
+ * Development mode source file reloading has been removed. The
+   "shotgun" (http://rtomayko.github.com/shotgun/) program can be
+   used to achieve the same basic functionality in most situations.
+   Passenger users should use the "tmp/always_restart.txt"
+   file (http://tinyurl.com/c67o4h). [#166]
+
 = 0.9.1.1 / 2009-03-09
 
  * Fix directory traversal vulnerability in default static files

data/README.rdoc

@@ -285,13 +285,7 @@ A route can punt processing to the next matching route using <tt>pass</tt>:
 The route block is immediately exited and control continues with the next
 matching route. If no matching route is found, a 404 is returned.
 
-== Configuration and Reloading
-
-Sinatra supports multiple environments and reloading. Reloading happens
-before each request when running under the <tt>:development</tt>
-environment. Wrap your configurations (e.g., database connections, constants,
-etc.) in <tt>configure</tt> blocks to protect them from reloading or to
-target specific environments.
+== Configuration
 
 Run once, at startup, in any environment:
 
@@ -300,14 +294,14 @@ Run once, at startup, in any environment:
   end
 
 Run only when the environment (RACK_ENV environment variable) is set to
-<tt>:production</tt>.
+<tt>:production</tt>:
 
   configure :production do
     ...
   end
 
-Run when the environment (RACK_ENV environment variable) is set to
-either <tt>:production</tt> or <tt>:test</tt>.
+Run when the environment is set to either <tt>:production</tt> or
+<tt>:test</tt>:
 
   configure :production, :test do
     ...

data/Rakefile

@@ -33,7 +33,7 @@ def spec
 end
 
 def package(ext='')
-  "dist/sinatra-#{spec.version}" + ext
+  "pkg/sinatra-#{spec.version}" + ext
 end
 
 desc 'Build packages'
@@ -44,15 +44,15 @@ task :install => package('.gem') do
   sh "gem install #{package('.gem')}"
 end
 
-directory 'dist/'
-CLOBBER.include('dist')
+directory 'pkg/'
+CLOBBER.include('pkg')
 
-file package('.gem') => %w[dist/ sinatra.gemspec] + spec.files do |f|
+file package('.gem') => %w[pkg/ sinatra.gemspec] + spec.files do |f|
   sh "gem build sinatra.gemspec"
   mv File.basename(f.name), f.name
 end
 
-file package('.tar.gz') => %w[dist/] + spec.files do |f|
+file package('.tar.gz') => %w[pkg/] + spec.files do |f|
   sh <<-SH
     git archive \
       --prefix=sinatra-#{source_version}/ \
@@ -64,7 +64,7 @@ end
 # Rubyforge Release / Publish Tasks ==================================
 
 desc 'Publish gem and tarball to rubyforge'
-task 'publish:gem' => [package('.gem'), package('.tar.gz')] do |t|
+task 'release' => [package('.gem'), package('.tar.gz')] do |t|
   sh <<-end
     rubyforge add_release sinatra sinatra #{spec.version} #{package('.gem')} &&
     rubyforge add_file    sinatra sinatra #{spec.version} #{package('.tar.gz')}
@@ -95,12 +95,6 @@ file 'doc/api/index.html' => FileList['lib/**/*.rb','README.rdoc'] do |f|
 end
 CLEAN.include 'doc/api'
 
-def rdoc_to_html(file_name)
-  require 'rdoc/markup/to_html'
-  rdoc = RDoc::Markup::ToHtml.new
-  rdoc.convert(File.read(file_name))
-end
-
 # Gemspec Helpers ====================================================
 
 def source_version
@@ -108,12 +102,7 @@ def source_version
   line.match(/.*VERSION = '(.*)'/)[1]
 end
 
-project_files =
-  FileList[
-    '{lib,test,compat,images}/**',
-    'Rakefile', 'CHANGES', 'README.rdoc'
-  ]
-file 'sinatra.gemspec' => project_files do |f|
+task 'sinatra.gemspec' => FileList['{lib,test,compat}/**','Rakefile','CHANGES','*.rdoc'] do |f|
   # read spec file and split out manifest section
   spec = File.read(f.name)
   head, manifest, tail = spec.split("  # = MANIFEST =\n")

data/lib/sinatra/base.rb

@@ -14,6 +14,7 @@ module Sinatra
       @env['HTTP_USER_AGENT']
     end
 
+    # Returns an array of acceptable media types for the response
     def accept
       @env['HTTP_ACCEPT'].to_s.split(',').map { |a| a.strip }
     end
@@ -162,6 +163,8 @@ module Sinatra
       not_found
     end
 
+    # Rack response body used to deliver static files. The file contents are
+    # generated iteratively in 8K chunks.
     class StaticFile < ::File #:nodoc:
       alias_method :to_path, :path
       def each
@@ -215,7 +218,18 @@ module Sinatra
   end
 
   # Template rendering methods. Each method takes a the name of a template
-  # to render as a Symbol and returns a String with the rendered output.
+  # to render as a Symbol and returns a String with the rendered output,
+  # as well as an optional hash with additional options.
+  #
+  # `template` is either the name or path of the template as symbol
+  # (Use `:'subdir/myview'` for views in subdirectories), or a string
+  # that will be rendered.
+  #
+  # Possible options are:
+  #   :layout       If set to false, no layout is rendered, otherwise
+  #                 the specified layout is used (Ignored for `sass`)
+  #   :locals       A hash with local variables that should be available
+  #                 in the template
   module Templates
     def erb(template, options={})
       require 'erb' unless defined? ::ERB
@@ -223,13 +237,13 @@ module Sinatra
     end
 
     def haml(template, options={})
-      require 'haml' unless defined? ::Haml
+      require 'haml' unless defined? ::Haml::Engine
       options[:options] ||= self.class.haml if self.class.respond_to? :haml
       render :haml, template, options
     end
 
     def sass(template, options={}, &block)
-      require 'sass' unless defined? ::Sass
+      require 'sass' unless defined? ::Sass::Engine
       options[:layout] = false
       render :sass, template, options
     end
@@ -368,13 +382,16 @@ module Sinatra
       self.class
     end
 
-    # Exit the current block and halt the response.
+    # Exit the current block, halts any further processing
+    # of the request, and returns the specified response.
     def halt(*response)
       response = response.first if response.length == 1
       throw :halt, response
     end
 
     # Pass control to the next matching route.
+    # If there are no more matching routes, Sinatra will
+    # return a 404 response.
     def pass
       throw :pass
     end
@@ -435,6 +452,9 @@ module Sinatra
       # No matching route found or all routes passed -- forward downstream
       # when running as middleware; 404 when running as normal app.
       if @app
+        # Call bypassed method before forward to catch behavior that should
+        # happen even if no routes are hit.
+        bypassed if respond_to?(:bypassed)
         forward
       else
         raise NotFound
@@ -553,12 +573,14 @@ module Sinatra
     @middleware = []
     @errors     = {}
     @prototype  = nil
+    @extensions = []
 
     class << self
       attr_accessor :routes, :filters, :conditions, :templates,
         :middleware, :errors
 
-    public
+      # Sets an option to the given value.  If the value is a proc,
+      # the proc will be called every time the option is accessed.
       def set(option, value=self)
         if value.kind_of?(Proc)
           metadef(option, &value)
@@ -574,14 +596,19 @@ module Sinatra
         self
       end
 
+      # Same as calling `set :option, true` for each of the given options.
       def enable(*opts)
         opts.each { |key| set(key, true) }
       end
 
+      # Same as calling `set :option, false` for each of the given options.
       def disable(*opts)
         opts.each { |key| set(key, false) }
       end
 
+      # Define a custom error handler. Optionally takes either an Exception
+      # class, or an HTTP status code to specify which errors should be
+      # handled.
       def error(codes=Exception, &block)
         if codes.respond_to? :each
           codes.each { |err| error(err, &block) }
@@ -590,23 +617,25 @@ module Sinatra
         end
       end
 
+      # Sugar for `error(404) { ... }`
       def not_found(&block)
         error 404, &block
       end
 
+      # Define a named template. The block must return the template source.
       def template(name, &block)
         templates[name] = block
       end
 
+      # Define the layout template. The block must return the template source.
       def layout(name=:layout, &block)
         template name, &block
       end
 
-      def use_in_file_templates!
-        ignore = [/lib\/sinatra.*\.rb/, /\(.*\)/, /rubygems\/custom_require\.rb/]
-        file = caller.
-          map  { |line| line.sub(/:\d+.*$/, '') }.
-          find { |line| ignore.all? { |pattern| line !~ pattern } }
+      # Load embeded templates from the file; uses the caller's __FILE__
+      # when no file is specified.
+      def use_in_file_templates!(file=nil)
+        file ||= caller_files.first
         if data = ::IO.read(file).split('__END__')[1]
           data.gsub!(/\r\n/, "\n")
           template = nil
@@ -627,10 +656,15 @@ module Sinatra
         Rack::Mime.mime_type(type, nil)
       end
 
+      # Define a before filter. Filters are run before all requests
+      # within the same context as route handlers and may access/modify the
+      # request and response.
       def before(&block)
         @filters << block
       end
 
+      # Add a route condition. The route is considered non-matching when the
+      # block returns false.
       def condition(&block)
         @conditions << block
       end
@@ -667,6 +701,8 @@ module Sinatra
       end
 
     public
+      # Defining a `GET` handler also automatically defines
+      # a `HEAD` handler.
       def get(path, opts={}, &block)
         conditions = @conditions.dup
         route('GET', path, opts, &block)
@@ -698,10 +734,16 @@ module Sinatra
             lambda { unbound_method.bind(self).call }
           end
 
+        invoke_hook(:route_added, verb, path)
+
         (routes[verb] ||= []).
           push([pattern, keys, conditions, block]).last
       end
 
+      def invoke_hook(name, *args)
+        extensions.each { |e| e.send(name, *args) if e.respond_to?(name) }
+      end
+
       def compile(path)
         keys = []
         if path.respond_to? :to_str
@@ -728,13 +770,20 @@ module Sinatra
       end
 
     public
+      # Makes the methods defined in the block and in the Modules given
+      # in `extensions` available to the handlers and templates
       def helpers(*extensions, &block)
         class_eval(&block)  if block_given?
         include *extensions if extensions.any?
       end
 
+      def extensions
+        (@extensions + (superclass.extensions rescue [])).uniq
+      end
+
       def register(*extensions, &block)
         extensions << Module.new(&block) if block_given?
+        @extensions += extensions
         extensions.each do |extension|
           extend extension
           extension.registered(self) if extension.respond_to?(:registered)
@@ -745,16 +794,20 @@ module Sinatra
       def test? ; environment == :test ; end
       def production? ; environment == :production ; end
 
+      # Set configuration options for Sinatra and/or the app.
+      # Allows scoping of settings for certain environments.
       def configure(*envs, &block)
-        return if reloading?
         yield if envs.empty? || envs.include?(environment.to_sym)
       end
 
+      # Use the specified Rack middleware
       def use(middleware, *args, &block)
         @prototype = nil
         @middleware << [middleware, args, block]
       end
 
+      # Run the Sinatra app as a self-hosted server using
+      # Thin, Mongrel or WEBrick (in that order)
       def run!(options={})
         set options
         handler      = detect_rack_handler
@@ -785,28 +838,13 @@ module Sinatra
         builder.use Rack::Session::Cookie if sessions? && !test?
         builder.use Rack::CommonLogger if logging?
         builder.use Rack::MethodOverride if methodoverride?
-        @middleware.each { |c, args, bk| builder.use(c, *args, &bk) }
+        @middleware.each { |c,a,b| builder.use(c, *a, &b) }
         builder.run super
         builder.to_app
       end
 
       def call(env)
-        synchronize do
-          reload! if reload?
-          prototype.call(env)
-        end
-      end
-
-      def reloading?
-        @reloading
-      end
-
-      def reload!
-        @reloading = true
-        reset!
-        $LOADED_FEATURES.delete("sinatra.rb")
-        ::Kernel.load app_file
-        @reloading = false
+        synchronize { prototype.call(env) }
       end
 
       def reset!(base=superclass)
@@ -817,6 +855,7 @@ module Sinatra
         @errors     = base.errors.dup
         @middleware = base.middleware.dup
         @prototype  = nil
+        @extensions = []
       end
 
     protected
@@ -858,6 +897,20 @@ module Sinatra
         (class << self; self; end).
           send :define_method, message, &block
       end
+
+      # Like Kernel#caller but excluding certain magic entries and without
+      # line / method information; the resulting array contains filenames only.
+      def caller_files
+        ignore = [
+          /lib\/sinatra.*\.rb$/, # all sinatra code
+          /\(.*\)/,              # generated code
+          /custom_require\.rb$/, # rubygems require hacks
+          /active_support/,      # active_support require hacks
+        ]
+        caller(1).
+          map    { |line| line.split(/:\d/, 2).first }.
+          reject { |file| ignore.any? { |pattern| file =~ pattern } }
+      end
     end
 
     set :raise_errors, true
@@ -878,8 +931,7 @@ module Sinatra
     set :root, Proc.new { app_file && File.expand_path(File.dirname(app_file)) }
     set :views, Proc.new { root && File.join(root, 'views') }
     set :public, Proc.new { root && File.join(root, 'public') }
-    set :reload, Proc.new { app_file? && app_file !~ /\.ru$/i && development? }
-    set :lock, Proc.new { reload? }
+    set :lock, false
 
     # static files route
     get(/.*[^\/]$/) do
@@ -980,14 +1032,17 @@ module Sinatra
   class Application < Default
   end
 
+  # Sinatra delegation mixin. Mixing this module into an object causes all
+  # methods to be delegated to the Sinatra::Application class. Used primarily
+  # at the top-level.
   module Delegator #:nodoc:
     def self.delegate(*methods)
       methods.each do |method_name|
         eval <<-RUBY, binding, '(__DELEGATE__)', 1
           def #{method_name}(*args, &b)
-            ::Sinatra::Application.#{method_name}(*args, &b)
+            ::Sinatra::Application.send(#{method_name.inspect}, *args, &b)
           end
-          private :#{method_name}
+          private #{method_name.inspect}
         RUBY
       end
     end
@@ -998,6 +1053,8 @@ module Sinatra
              :production?, :use_in_file_templates!, :helpers
   end
 
+  # Create a new Sinatra application. The block is evaluated in the new app's
+  # class scope.
   def self.new(base=Base, options={}, &block)
     base = Class.new(base)
     base.send :class_eval, &block if block_given?

data/lib/sinatra/main.rb

@@ -6,26 +6,14 @@ module Sinatra
     # we assume that the first file that requires 'sinatra' is the
     # app_file. all other path related options are calculated based
     # on this path by default.
-    set :app_file, lambda {
-      ignore = [
-        /lib\/sinatra.*\.rb$/, # all sinatra code
-        /\(.*\)/,              # generated code
-        /custom_require\.rb$/  # rubygems require hacks
-      ]
-      path =
-        caller.map{ |line| line.split(/:\d/, 2).first }.find do |file|
-          next if ignore.any? { |pattern| file =~ pattern }
-          file
-        end
-      path || $0
-    }.call
+    set :app_file, caller_files.first || $0
 
     set :run, Proc.new { $0 == app_file }
 
     if run? && ARGV.any?
       require 'optparse'
       OptionParser.new { |op|
-        op.on('-x')        {       set :mutex, true }
+        op.on('-x')        {       set :lock, true }
         op.on('-e env')    { |val| set :environment, val.to_sym }
         op.on('-s server') { |val| set :server, val }
         op.on('-p port')   { |val| set :port, val.to_i }

data/sinatra.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'sinatra'
-  s.version = '0.9.1.1'
-  s.date = '2009-03-09'
+  s.version = '0.9.1.2'
+  s.date = '2009-03-24'
 
   s.description = "Classy web-development dressed in a DSL"
   s.summary     = "Classy web-development dressed in a DSL"
@@ -78,7 +78,6 @@ Gem::Specification.new do |s|
     test/mapped_error_test.rb
     test/middleware_test.rb
     test/options_test.rb
-    test/reload_test.rb
     test/request_test.rb
     test/response_test.rb
     test/result_test.rb
@@ -104,7 +103,8 @@ Gem::Specification.new do |s|
   s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/}
 
   s.extra_rdoc_files = %w[README.rdoc LICENSE]
-  s.add_dependency 'rack', '>= 0.9.1', '< 1.0'
+  s.add_dependency 'rack',    '>= 0.9.1', '< 1.0'
+  s.add_development_dependency 'shotgun', '>= 0.2',   '< 1.0'
 
   s.has_rdoc = true
   s.homepage = "http://sinatra.rubyforge.org"

data/test/base_test.rb

@@ -42,7 +42,7 @@ end
 describe "Sinatra::Base as Rack middleware" do
 
   app = lambda { |env|
-    [210, {'X-Downstream' => 'true'}, ['Hello from downstream']] }
+    [210, {'X-Downstream' => 'true', 'X-Bypass-Test' => '1' || ''}, ['Hello from downstream']] }
 
   class TestMiddleware < Sinatra::Base
   end
@@ -58,6 +58,10 @@ describe "Sinatra::Base as Rack middleware" do
   end
 
   class TestMiddleware < Sinatra::Base
+    def bypassed
+      env['X-Bypass-Test'] = '1'
+    end
+
     get '/' do
       'Hello from middleware'
     end
@@ -78,6 +82,11 @@ describe "Sinatra::Base as Rack middleware" do
     assert_equal 'Hello from downstream', response.body
   end
 
+  it 'calls #bypassed before forwarding downstream' do
+    response = request.get('/missing')
+    assert_equal '1', response['X-Bypass-Test']
+  end
+
   class TestMiddleware < Sinatra::Base
     get '/low-level-forward' do
       app.call(env)

data/test/extensions_test.rb

@@ -25,6 +25,12 @@ describe 'Registering extensions' do
     end
   end
 
+  module PainExtensions
+    def foo=(name); end
+    def bar?(name); end
+    def fizz!(name); end
+  end
+
   it 'will add the methods to the DSL for the class in which you register them and its subclasses' do
     Sinatra::Base.register FooExtensions
     assert Sinatra::Base.respond_to?(:foo)
@@ -50,6 +56,16 @@ describe 'Registering extensions' do
       map { |m| m.to_sym }.include?(:im_hiding_in_ur_foos)
   end
 
+  it 'will handle special method names' do
+    Sinatra::Default.register PainExtensions
+    assert Sinatra::Delegator.private_instance_methods.
+      map { |m| m.to_sym }.include?(:foo=)
+    assert Sinatra::Delegator.private_instance_methods.
+      map { |m| m.to_sym }.include?(:bar?)
+    assert Sinatra::Delegator.private_instance_methods.
+      map { |m| m.to_sym }.include?(:fizz!)
+  end
+
   it 'will not delegate methods on Base#register' do
     Sinatra::Base.register QuuxExtensions
     assert !Sinatra::Delegator.private_instance_methods.include?("quux")

data/test/options_test.rb

@@ -319,56 +319,8 @@ describe_option 'public' do
   end
 end
 
-describe_option 'reload' do
-  it 'is enabled when
-        app_file is set,
-        is not a rackup file,
-        and we are in development' do
-    @base.app_file = __FILE__
-    @base.set(:environment, :development)
-    assert @base.reload?
-
-    @default.app_file = __FILE__
-    @default.set(:environment, :development)
-    assert @default.reload?
-  end
-
-  it 'is disabled if app_file is not set' do
-    assert ! @base.reload?
-    assert ! @default.reload?
-  end
-
-  it 'is disabled if app_file is a rackup file' do
-    @base.app_file = 'config.ru'
-    assert ! @base.reload?
-
-    @default.app_file = 'config.ru'
-    assert ! @base.reload?
-  end
-
-  it 'is disabled if we are not in development' do
-    @base.set(:environment, :foo)
-    assert ! @base.reload
-
-    @default.set(:environment, :bar)
-    assert ! @default.reload
-  end
-end
-
 describe_option 'lock' do
-  it 'is enabled when reload is enabled' do
-    @base.enable(:reload)
-    assert @base.lock?
-
-    @default.enable(:reload)
-    assert @default.lock?
-  end
-
-  it 'is disabled when reload is disabled' do
-    @base.disable(:reload)
+  it 'is disabled by default' do
     assert ! @base.lock?
-
-    @default.disable(:reload)
-    assert ! @default.lock?
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-sinatra
 version: !ruby/object:Gem::Version 
-  version: 0.9.1.1
+  version: 0.9.1.2
 platform: ruby
 authors: 
 - Blake Mizerany
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-09 00:00:00 -07:00
+date: 2009-03-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: shotgun
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.2"
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
 description: Classy web-development dressed in a DSL
 email: sinatrarb@googlegroups.com
 executables: []
@@ -99,7 +112,6 @@ files:
 - test/mapped_error_test.rb
 - test/middleware_test.rb
 - test/options_test.rb
-- test/reload_test.rb
 - test/request_test.rb
 - test/response_test.rb
 - test/result_test.rb
@@ -161,7 +173,6 @@ test_files:
 - test/mapped_error_test.rb
 - test/middleware_test.rb
 - test/options_test.rb
-- test/reload_test.rb
 - test/request_test.rb
 - test/response_test.rb
 - test/result_test.rb

data/test/reload_test.rb

@@ -1,68 +0,0 @@
-require File.dirname(__FILE__) + '/helper'
-
-$reload_count = 0
-$reload_app = nil
-
-describe "Reloading" do
-  before {
-    @app = mock_app(Sinatra::Default)
-    $reload_app = @app
-  }
-
-  after {
-    $reload_app = nil
-  }
-
-  it 'is enabled by default when in development and the app_file is set' do
-    @app.set :app_file, __FILE__
-    @app.set :environment, :development
-    assert_same true, @app.reload
-    assert_same true, @app.reload?
-  end
-
-  it 'is disabled by default when running in non-development environment' do
-    @app.set :app_file, __FILE__
-    @app.set :environment, :test
-    assert !@app.reload
-    assert_same false, @app.reload?
-  end
-
-  it 'is disabled by default when no app_file is available' do
-    @app.set :app_file, nil
-    @app.set :environment, :development
-    assert !@app.reload
-    assert_same false, @app.reload?
-  end
-
-  it 'is disabled when app_file is a rackup (.ru) file' do
-    @app.set :app_file, __FILE__.sub(/\.rb$/, '.ru')
-    @app.set :environment, :development
-    assert !@app.reload
-    assert_same false, @app.reload?
-  end
-
-  it 'can be turned off explicitly' do
-    @app.set :app_file, __FILE__
-    @app.set :environment, :development
-    assert_same true, @app.reload
-    @app.set :reload, false
-    assert_same false, @app.reload
-    assert_same false, @app.reload?
-  end
-
-  it 'reloads the app_file each time a request is made' do
-    @app.set :app_file, File.dirname(__FILE__) + '/data/reload_app_file.rb'
-    @app.set :reload, true
-    @app.get('/') { 'Hello World' }
-
-    get '/'
-    assert_equal 200, status
-    assert_equal 'Hello from reload file', body
-    assert_equal 1, $reload_count
-
-    get '/'
-    assert_equal 200, status
-    assert_equal 'Hello from reload file', body
-    assert_equal 2, $reload_count
-  end
-end