sinatra 0.3.1 → 0.3.2

data/README.rdoc

@@ -79,7 +79,7 @@ User agent matching:
     # matches non-songbird browsers
   end
 
-= Static files
+== Static files
 
 Put all of your static content in the ./public directory
 
@@ -260,91 +260,75 @@ on Array, Symbol, Fixnum, NilClass.
 
 == Configuration and Reloading
 
-Sinatra supports multiple environments and re-loading.  Re-loading happens on
-every request when in :development.  Wrap your configurations in
-<tt>configure</tt> (i.e. Database connections, Constants, etc.) to protect
-them from re-loading and to only work in certain environments.
+Sinatra supports multiple environments and reloading. Reloading happens
+before every request when running under the :development environment. Wrap
+your configurations in <tt>configure</tt> (i.e. Database connections, Constants,
+etc.) to protect them from reloading or to target specific environments.
 
 All environments:
 
   configure do
-
+    ...
   end
 
-Production
+Production:
 
   configure :production do
-
+    ...
   end
 
 Two at a time:
 
   configure :production, :test do
-
+    ...
   end
 
 This is also really nifty for error handling.
 
-= Error handling
+== Error handling
 
-== Not Found
+Error handlers run inside the current Sinatra::EventContext instance, which
+means you get all the goodies it has to offer (i.e. haml, erb, throw :halt,
+etc.)
 
-Remember:  These are run inside the Sinatra::EventContext which means you get
-all the goodies is has to offer (i.e. haml, erb, :halt, etc.)
+=== Not Found
 
-Whenever NotFound is raised this will be called
+When Sinatra::NotFound is raised, the not_found handler is invoked:
 
   not_found do
     'This is nowhere to be found'
   end
 
-== Error
+=== Error
 
-By default +error+ will catch Sinatra::ServerError
+By default, the +error+ handler is invoked on Sinatra::ServerError or when
+an unknown error occurs.
 
-Sinatra will pass you the error via the 'sinatra.error' in request.env
+The exception can be obtained from the 'sinatra.error' variable in
+request.env.
 
   error do
     'Sorry there was a nasty error - ' + request.env['sinatra.error'].name
   end
 
-Custom error mapping:
+Custom errors:
 
   error MyCustomError do
     'So what happened was...' + request.env['sinatra.error'].message
   end
 
-then if this happens:
+Then, if this happens:
 
   get '/' do
     raise MyCustomError, 'something bad'
   end
 
-you gets this:
+You get this:
 
   So what happened was... something bad
 
-one guess what this does ;)
-
-  not_found do
-    'I have no clue what you're looking for'
-  end
-
-Because Sinatra gives you a default <tt>not_found</tt> and <tt>error</tt> do
-:production that are secure.  If you want to customize only for :production
-but want to keep the friendly helper screens for :development then do this:
-
-  configure :production do
-
-    not_found do
-      "We're so sorry, but we don't what this is"
-    end
-
-    error do
-      "Something really nasty happened.  We're on it!"
-    end
-
-  end
+Sinatra installs special not_found and error handlers when running under
+the development.
 
 == Mime types
 
@@ -360,12 +344,9 @@ interface for Ruby web frameworks. One of Rack's most interesting capabilities
 for application developers is support for "middleware" -- components that sit
 between the server and your application monitoring and/or manipulating the
 HTTP request/response to provide various types of common functionality.
-What's more, middleware is portable between web frameworks, so middleware
-components developed under, e.g., Merb, can be used with Sinatra and vice
-versa.
 
-Sinatra makes building Rack middleware pipelines a cinch via a top-level +use+
-method:
+Sinatra makes building Rack middleware pipelines a cinch via a top-level
++use+ method:
 
   require 'sinatra'
   require 'my_custom_middleware'
@@ -393,24 +374,12 @@ typically don't have to +use+ them explicitly.
 
 == Testing
 
-=== Methods
-
-  get_it path, params
-  get_it path, params.merge(:env => { 'HTTP_HOST' => 'www.sinatrarb.com' }) or
-  get_it path, params.merge(:env => { :host => 'www.sinatrarb.com' })
-
-RESTful:
-
-  post_it '/foo', '<myxml></myxml>', 'HTTP_ACCEPT' => 'application/xml'
-
-also works with:
-
-  get_it, post_it, put_it, delete_it, head_it
-
 === Test/Unit
 
-  require 'my_sinatra_app'
+  require 'rubygems'
+  require 'sinatra'
   require 'sinatra/test/unit'
+  require 'my_sinatra_app'
 
   class MyAppTest < Test::Unit::TestCase
 
@@ -428,31 +397,52 @@ also works with:
 
   end
 
-=== Specs
+=== Test/Spec
 
-  require 'my_sinatra_app'
+  require 'rubygems'
+  require 'sinatra'
   require 'sinatra/test/spec'
+  require 'my_sinatra_app'
 
-  context 'My app'
+  describe 'My app' do
 
-    should "show a default page" do
+    it "should show a default page" do
       get_it '/'
       should.be.ok
       body.should.equal 'My Default Page!'
     end
+
     ...
 
   end
 
-=== Test Helpers
+=== RSpec
+
+  require 'rubygems'
+  require 'spec'
+  require 'sinatra'
+  require 'sinatra/test/rspec'
+  require 'my_sinatra_app'
+
+  describe 'My app' do
+    it 'should show a default page' do
+      get_it '/'
+      @response.should be_ok
+      @response.body.should == 'My Default Page!'
+    end
+
+    ...
+
+  end
 
-See Sinatra::Test::Methods
+See Sinatra::Test::Methods for more information on +get_it+, +post_it+,
++put_it+, and friends.
 
 == Command line
 
-Run your sinatra file like:
+Sinatra applications can be run directly:
 
-  ruby myapp.rb [options]
+  ruby myapp.rb [-h] [-x] [-p PORT] [-e ENVIRONMENT]
 
 Options are:
 

data/Rakefile

@@ -1,4 +1,6 @@
+require 'rubygems'
 require 'rake/clean'
+require 'fileutils'
 
 task :default => :test
 
@@ -54,7 +56,7 @@ end
 
 # Rubyforge Release / Publish Tasks ==================================
 
-desc 'Publish API docs to rubyforge'
+desc 'Publish website to rubyforge'
 task 'publish:doc' => 'doc/api/index.html' do
   sh 'scp -rp doc/* rubyforge.org:/var/www/gforge-projects/sinatra/'
 end
@@ -66,6 +68,77 @@ task 'publish:gem' => [package('.gem'), package('.tar.gz')] do |t|
   end
 end
 
+# Website ============================================================
+# Building docs requires HAML and the hanna gem:
+#   gem install mislav-hanna --source=http://gems.github.com
+
+task 'doc'     => ['doc:api','doc:site']
+
+desc 'Generate Hanna RDoc under doc/api'
+task 'doc:api' => ['doc/api/index.html']
+
+file 'doc/api/index.html' => FileList['lib/**/*.rb','README.rdoc'] do |f|
+  rb_files = f.prerequisites
+  sh((<<-end).gsub(/\s+/, ' '))
+    hanna --charset utf8 \
+          --fmt html \
+          --inline-source \
+          --line-numbers \
+          --main README.rdoc \
+          --op doc/api \
+          --title 'Sinatra API Documentation' \
+          #{rb_files.join(' ')}
+  end
+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
+
+def haml(locals={})
+  require 'haml'
+  template = File.read('doc/template.haml')
+  haml = Haml::Engine.new(template, :format => :html4, :attr_wrapper => '"')
+  haml.render(Object.new, locals)
+end
+
+desc 'Build website HTML and stuff'
+task 'doc:site' => ['doc/index.html', 'doc/book.html']
+
+file 'doc/index.html' => %w[README.rdoc doc/template.haml] do |file|
+  File.open(file.name, 'w') do |file|
+    file << haml(:title => 'Sinatra', :content => rdoc_to_html('README.rdoc'))
+  end
+end
+CLEAN.include 'doc/index.html'
+
+file 'doc/book.html' => ['book/output/sinatra-book.html'] do |file|
+  File.open(file.name, 'w') do |file|
+    book_content = File.read('book/output/sinatra-book.html')
+    file << haml(:title => 'Sinatra Book', :content => book_content)
+  end
+end
+CLEAN.include 'doc/book.html'
+
+file 'book/output/sinatra-book.html' => FileList['book/**'] do |f|
+  unless File.directory?('book')
+    sh 'git clone git://github.com/cschneid/sinatra-book.git book'
+  end
+  sh((<<-SH).strip.gsub(/\s+/, ' '))
+    cd book &&
+    git fetch origin &&
+    git rebase origin/master &&
+    thor book:build
+  SH
+end
+CLEAN.include 'book/output/sinatra-book.html'
+
+desc 'Build the Sinatra book'
+task 'doc:book' => ['book/output/sinatra-book.html']
+
 # Gemspec Helpers ====================================================
 
 file 'sinatra.gemspec' => FileList['{lib,test,images}/**','Rakefile'] do |f|
@@ -78,6 +151,7 @@ file 'sinatra.gemspec' => FileList['{lib,test,images}/**','Rakefile'] do |f|
     split("\n").
     sort.
     reject{ |file| file =~ /^\./ }.
+    reject { |file| file =~ /^doc/ }.
     map{ |file| "    #{file}" }.
     join("\n")
   # piece file back together and write...
@@ -86,26 +160,3 @@ file 'sinatra.gemspec' => FileList['{lib,test,images}/**','Rakefile'] do |f|
   File.open(f.name, 'w') { |io| io.write(spec) }
   puts "updated #{f.name}"
 end
-
-# Hanna RDoc =========================================================
-#
-# Building docs requires the hanna gem:
-#   gem install mislav-hanna --source=http://gems.github.com
-
-desc 'Generate Hanna RDoc under doc/api'
-task :doc => ['doc/api/index.html']
-
-file 'doc/api/index.html' => FileList['lib/**/*.rb','README.rdoc'] do |f|
-  rb_files = f.prerequisites
-  sh((<<-end).gsub(/\s+/, ' '))
-    hanna --charset utf8 \
-          --fmt html \
-          --inline-source \
-          --line-numbers \
-          --main README.rdoc \
-          --op doc/api \
-          --title 'Sinatra API Documentation' \
-          #{rb_files.join(' ')}
-  end
-end
-CLEAN.include 'doc/api'

data/lib/sinatra.rb

@@ -49,18 +49,13 @@ module Rack #:nodoc:
   module Utils
     extend self
   end
-
-  module Handler
-    autoload :Mongrel, ::File.dirname(__FILE__) + "/sinatra/rack/handler/mongrel"
-  end
-
 end
 
 
 module Sinatra
   extend self
 
-  VERSION = '0.3.0'
+  VERSION = '0.3.2'
 
   class NotFound < RuntimeError
     def self.code ; 404 ; end
@@ -202,20 +197,16 @@ module Sinatra
   class Static
     include Rack::Utils
 
-    def invoke(request)
-      return unless File.file?(
-        Sinatra.application.options.public + unescape(request.path_info)
-      )
-      Result.new(block, {}, 200)
+    def initialize(app)
+      @app = app
     end
 
-    def block
-      Proc.new do
-        send_file Sinatra.application.options.public +
-          unescape(request.path_info), :disposition => nil
-      end
+    def invoke(request)
+      path = @app.options.public + unescape(request.path_info)
+      return unless File.file?(path)
+      block = Proc.new { send_file path, :disposition => nil }
+      Result.new(block, {}, 200)
     end
-
   end
 
   # Methods for sending files and streams to the browser instead of rendering.
@@ -224,13 +215,12 @@ module Sinatra
       :type         => 'application/octet-stream'.freeze,
       :disposition  => 'attachment'.freeze,
       :stream       => true,
-      :buffer_size  => 4096
+      :buffer_size  => 8192
     }.freeze
 
     class MissingFile < RuntimeError; end
 
     class FileStreamer
-
       attr_reader :path, :options
 
       def initialize(path, options)
@@ -242,18 +232,17 @@ module Sinatra
       end
 
       def each
+        size = options[:buffer_size]
         File.open(path, 'rb') do |file|
-          while buf = file.read(options[:buffer_size])
+          while buf = file.read(size)
             yield buf
           end
         end
       end
-
     end
 
   protected
-
-    # Sends the file by streaming it 4096 bytes at a time. This way the
+    # Sends the file by streaming it 8192 bytes at a time. This way the
     # whole file doesn't need to be read into memory at once.  This makes
     # it feasible to send even large files.
     #
@@ -274,7 +263,7 @@ module Sinatra
     #   is read (true) or to read the entire file before sending (false).
     #   Defaults to true.
     # * <tt>:buffer_size</tt> - specifies size (in bytes) of the buffer used
-    #   to stream the file. Defaults to 4096.
+    #   to stream the file. Defaults to 8192.
     # * <tt>:status</tt> - specifies the status code to send with the
     #   response. Defaults to '200 OK'.
     # * <tt>:last_modified</tt> - an optional RFC 2616 formatted date value
@@ -319,12 +308,14 @@ module Sinatra
       options[:filename] ||= File.basename(path)
       options[:type] ||= Rack::File::MIME_TYPES[File.extname(options[:filename])[1..-1]] || 'text/plain'
       options[:last_modified] ||= File.mtime(path).httpdate
+      options[:stream] = true unless options.key?(:stream)
+      options[:buffer_size] ||= DEFAULT_SEND_FILE_OPTIONS[:buffer_size]
       send_file_headers! options
 
       if options[:stream]
         throw :halt, [options[:status] || 200, FileStreamer.new(path, options)]
       else
-        File.open(path, 'rb') { |file| throw :halt, [options[:status] || 200, file.read] }
+        File.open(path, 'rb') { |file| throw :halt, [options[:status] || 200, [file.read]] }
       end
     end
 
@@ -359,7 +350,7 @@ module Sinatra
     # See +send_file+ for more information on HTTP Content-* headers and caching.
     def send_data(data, options = {}) #:doc:
       send_file_headers! options.merge(:length => data.size)
-      throw :halt, [options[:status] || 200, data]
+      throw :halt, [options[:status] || 200, [data]]
     end
 
   private
@@ -1285,7 +1276,7 @@ module Sinatra
     # Called immediately after the application is initialized or reloaded to
     # register default events, templates, and error handlers.
     def load_default_configuration!
-      events[:get] << Static.new
+      events[:get] << Static.new(self)
       configure do
         error do
           '<h1>Internal Server Error</h1>'
@@ -1467,9 +1458,7 @@ end
 
 at_exit do
   raise $! if $!
-  if Sinatra.application.options.run
-    Sinatra.run
-  end
+  Sinatra.run if Sinatra.application.options.run
 end
 
 mime :xml, 'application/xml'

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.3.1'
-  s.date = "2008-09-08"
+  s.version = '0.3.2'
+  s.date = "2008-11-02"
 
   s.description = "Classy web-development dressed in a DSL"
   s.summary     = "Classy web-development dressed in a DSL"
@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
     images/404.png
     images/500.png
     lib/sinatra.rb
-    lib/sinatra/rack/handler/mongrel.rb
     lib/sinatra/test/methods.rb
     lib/sinatra/test/rspec.rb
     lib/sinatra/test/spec.rb
@@ -70,7 +69,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'rack', '>= 0.4.0'
 
   s.has_rdoc = true
-  s.homepage = "http://sinatrarb.com"
+  s.homepage = "http://sinatra.rubyforge.org"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sinatra", "--main", "README.rdoc"]
   s.require_paths = %w[lib]
   s.rubyforge_project = 'sinatra'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Blake Mizerany
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 -07:00
+date: 2008-11-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,7 +39,6 @@ files:
 - images/404.png
 - images/500.png
 - lib/sinatra.rb
-- lib/sinatra/rack/handler/mongrel.rb
 - lib/sinatra/test/methods.rb
 - lib/sinatra/test/rspec.rb
 - lib/sinatra/test/spec.rb
@@ -81,7 +80,7 @@ files:
 - test/views/no_layout/no_layout.builder
 - test/views/no_layout/no_layout.haml
 has_rdoc: true
-homepage: http://sinatrarb.com
+homepage: http://sinatra.rubyforge.org
 post_install_message: 
 rdoc_options: 
 - --line-numbers

data/lib/sinatra/rack/handler/mongrel.rb

@@ -1,85 +0,0 @@
-require 'mongrel'
-require 'stringio'
-
-
-module Rack
-  module Handler
-    class Mongrel < ::Mongrel::HttpHandler
-      def self.run(app, options={})
-        server = ::Mongrel::HttpServer.new(options[:Host] || '0.0.0.0',
-                                           options[:Port] || 8080)
-        # Acts like Rack::URLMap, utilizing Mongrel's own path finding methods.
-        # Use is similar to #run, replacing the app argument with a hash of 
-        # { path=>app, ... } or an instance of Rack::URLMap.
-        if options[:map]
-          if app.is_a? Hash
-            app.each do |path, appl|
-              path = '/'+path unless path[0] == ?/
-              server.register(path, Rack::Handler::Mongrel.new(appl))
-            end
-          elsif app.is_a? URLMap
-            app.instance_variable_get(:@mapping).each do |(host, path, appl)|
-             next if !host.nil? && !options[:Host].nil? && options[:Host] != host
-             path = '/'+path unless path[0] == ?/
-             server.register(path, Rack::Handler::Mongrel.new(appl))
-            end
-          else
-            raise ArgumentError, "first argument should be a Hash or URLMap"
-          end
-        else
-          server.register('/', Rack::Handler::Mongrel.new(app))
-        end
-        yield server  if block_given?
-        server.run.join
-      end
-
-      def initialize(app)
-        @app = app
-      end
-
-      def process(request, response)
-        env = {}.replace(request.params)
-        env.delete "HTTP_CONTENT_TYPE"
-        env.delete "HTTP_CONTENT_LENGTH"
-
-        env["SCRIPT_NAME"] = ""  if env["SCRIPT_NAME"] == "/"
-
-        env.update({"rack.version" => [0,1],
-                     "rack.input" => request.body || StringIO.new(""),
-                     "rack.errors" => STDERR,
-
-                     "rack.multithread" => true,
-                     "rack.multiprocess" => false, # ???
-                     "rack.run_once" => false,
-
-                     "rack.url_scheme" => "http",
-                   })
-        env["QUERY_STRING"] ||= ""
-        env.delete "PATH_INFO"  if env["PATH_INFO"] == ""
-
-        status, headers, body = @app.call(env)
-
-        begin
-          response.status = status.to_i
-          headers.each { |k, vs|
-            vs.each { |v|
-              response.header[k] = v
-            }
-          }
-          # taken from Merb until we have a better solution that conforms
-          # to the Rack::Standard
-          if Proc === body
-            body.call(response)
-          else
-            body.each { |part|
-              response.body << part
-            }
-          end
-          response.finished
-        ensure
-          body.close  if body.respond_to? :close
-        end
-      end
-    end
-  end
-end