jellyfish 0.4.0 → 0.5.0

data/CHANGES.md

@@ -1,5 +1,28 @@
 # CHANGES
 
+## Jellyfish 0.5.0 -- 2012-10-18
+
+### Incompatible changes
+
+* Some internal constants are removed.
+* Renamed `Respond` to `Response`.
+
+### Enhancements
+
+* Now Jellyfish would always use the custom error handler to handle the
+  particular exception even if `handle_exceptions` set to false. That is,
+  now setting `handle_exceptions` to false would only disable default
+  error handling. This behavior makes more sense since if you want the
+  exception bubble out then you shouldn't define the custom error handler
+  in the first place. If you define it, you must mean you want to use it.
+
+* Eliminated some uninitialized instance variable warnings.
+
+* Now you can access the original app via `jellyfish` in the controller.
+
+* `Jellyfish::Controller` no longer includes `Jellyfish`, which would remove
+  those `DSL` methods accidentally included in previous version (0.4.0-).
+
 ## Jellyfish 0.4.0 -- 2012-10-14
 
 * Now you can define your own custom controller like:

data/Gemfile

@@ -0,0 +1,7 @@
+
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'bacon'

data/README.md

@@ -1,4 +1,4 @@
-# Jellyfish
+# Jellyfish[![Build Status](https://secure.travis-ci.org/godfat/jellyfish.png?branch=master)](http://travis-ci.org/godfat/jellyfish)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 
@@ -29,7 +29,7 @@ Rack applications or Rack middlewares. Under 200 lines of code.
 * No templates
 * No ORM
 * No `dup` in `call`
-* Regular expression routes, e.g. `get %r{/(\d+)}`
+* Regular expression routes, e.g. `get %r{^/(?<id>\d+)$}`
 * String routes, e.g. `get '/'`
 * Custom routes, e.g. `get Matcher.new`
 * Build for either Rack applications or Rack middlewares

data/example/config.ru

@@ -1,6 +1,8 @@
 
 require 'jellyfish'
 
+Overheat = Class.new(RuntimeError)
+
 class Tank
   include Jellyfish
   handle_exceptions false
@@ -63,10 +65,19 @@ class Tank
   get '/chunked' do
     Body.new
   end
+
+  get '/overheat' do
+    raise Overheat
+  end
 end
 
 class Heater
   include Jellyfish
+  handle Overheat do
+    status 500
+    "It's overheated\n"
+  end
+
   get '/status' do
     temperature
   end

data/jellyfish.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2012-10-14"
+  s.date = "2012-10-18"
   s.description = "Pico web framework for building API-centric web applications, either\nRack applications or Rack middlewares. Under 200 lines of code."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   ".gitmodules",
   ".travis.yml",
   "CHANGES.md",
+  "Gemfile",
   "LICENSE",
   "README.md",
   "Rakefile",
@@ -27,13 +28,57 @@ Gem::Specification.new do |s|
   "lib/jellyfish/public/404.html",
   "lib/jellyfish/public/500.html",
   "lib/jellyfish/sinatra.rb",
+  "lib/jellyfish/test.rb",
   "lib/jellyfish/version.rb",
+  "sinatra/builder_test.rb",
+  "sinatra/coffee_test.rb",
+  "sinatra/contest.rb",
+  "sinatra/creole_test.rb",
+  "sinatra/delegator_test.rb",
+  "sinatra/encoding_test.rb",
+  "sinatra/erb_test.rb",
+  "sinatra/extensions_test.rb",
+  "sinatra/filter_test.rb",
+  "sinatra/haml_test.rb",
+  "sinatra/helper.rb",
+  "sinatra/helpers_test.rb",
+  "sinatra/integration/app.rb",
+  "sinatra/integration_helper.rb",
+  "sinatra/integration_test.rb",
+  "sinatra/less_test.rb",
+  "sinatra/liquid_test.rb",
+  "sinatra/mapped_error_test.rb",
+  "sinatra/markaby_test.rb",
+  "sinatra/markdown_test.rb",
+  "sinatra/middleware_test.rb",
+  "sinatra/nokogiri_test.rb",
+  "sinatra/rack_test.rb",
+  "sinatra/radius_test.rb",
+  "sinatra/rdoc_test.rb",
+  "sinatra/readme_test.rb",
+  "sinatra/request_test.rb",
+  "sinatra/response_test.rb",
+  "sinatra/result_test.rb",
+  "sinatra/route_added_hook_test.rb",
+  "sinatra/routing_test.rb",
+  "sinatra/sass_test.rb",
+  "sinatra/scss_test.rb",
+  "sinatra/server_test.rb",
+  "sinatra/settings_test.rb",
+  "sinatra/sinatra_test.rb",
+  "sinatra/slim_test.rb",
+  "sinatra/static_test.rb",
+  "sinatra/streaming_test.rb",
+  "sinatra/templates_test.rb",
+  "sinatra/textile_test.rb",
   "task/.gitignore",
-  "task/gemgem.rb"]
+  "task/gemgem.rb",
+  "test/sinatra/test_base.rb"]
   s.homepage = "https://github.com/godfat/jellyfish"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
   s.summary = "Pico web framework for building API-centric web applications, either"
+  s.test_files = ["test/sinatra/test_base.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/jellyfish.rb

@@ -3,14 +3,9 @@ module Jellyfish
   autoload :VERSION, 'jellyfish/version'
   autoload :Sinatra, 'jellyfish/sinatra'
 
-  REQUEST_METHOD = 'REQUEST_METHOD'
-  PATH_INFO      = 'PATH_INFO'
-  LOCATION       = 'Location'
-  RACK_ERRORS    = 'rack.errors'
-
   # -----------------------------------------------------------------
 
-  class Respond < RuntimeError
+  class Response < RuntimeError
     def headers
       @headers ||= {'Content-Type' => 'text/html'}
     end
@@ -20,23 +15,23 @@ module Jellyfish
     end
   end
 
-  class InternalError < Respond; def status; 500; end; end
-  class NotFound      < Respond; def status; 404; end; end
-  class Found         < Respond
+  class InternalError < Response; def status; 500; end; end
+  class NotFound      < Response; def status; 404; end; end
+  class Found         < Response # this would be raised in redirect
     attr_reader :url
     def initialize url; @url = url                             ; end
     def status        ; 302                                    ; end
-    def headers       ; super.merge(LOCATION => url)           ; end
+    def headers       ; super.merge('Location' => url)         ; end
     def body          ; super.map{ |b| b.gsub('VAR_URL', url) }; end
   end
 
   # -----------------------------------------------------------------
 
   class Controller
-    include Jellyfish
-    attr_reader   :routes, :env
-    def initialize routes
-      @routes = routes
+    attr_reader :routes, :jellyfish, :env
+    def initialize routes, jellyfish
+      @routes, @jellyfish = routes, jellyfish
+      @status, @headers, @body = nil
     end
 
     def call env
@@ -50,12 +45,12 @@ module Jellyfish
       [status || 200, headers || {}, body]
     end
 
-    def forward  ; raise(NotFound.new)  ; end
-    def found url; raise(Found.new(url)); end
+    def forward  ; raise(Jellyfish::NotFound.new)     ; end
+    def found url; raise(Jellyfish::   Found.new(url)); end
     alias_method :redirect, :found
 
-    def path_info     ; env[PATH_INFO]      || '/'  ; end
-    def request_method; env[REQUEST_METHOD] || 'GET'; end
+    def path_info     ; env['PATH_INFO']      || '/'  ; end
+    def request_method; env['REQUEST_METHOD'] || 'GET'; end
 
     %w[status headers].each do |field|
       module_eval <<-RUBY
@@ -89,7 +84,7 @@ module Jellyfish
 
     private
     def actions
-      routes[request_method.downcase] || raise(NotFound.new)
+      routes[request_method.downcase] || raise(Jellyfish::NotFound.new)
     end
 
     def dispatch
@@ -101,7 +96,7 @@ module Jellyfish
           match = route.match(path_info)
           break match, block if match
         end
-      } || raise(NotFound.new)
+      } || raise(Jellyfish::NotFound.new)
     end
   end
 
@@ -136,7 +131,7 @@ module Jellyfish
   def controller        ; Controller; end
 
   def call env
-    ctrl = controller.new(self.class.routes)
+    ctrl = controller.new(self.class.routes, self)
     ctrl.call(env)
   rescue NotFound => e # forward
     if app
@@ -145,24 +140,25 @@ module Jellyfish
       handle(ctrl, e)
     end
   rescue Exception => e
-    handle(ctrl, e, env[RACK_ERRORS])
+    handle(ctrl, e, env['rack.errors'])
   end
 
   def protect ctrl, env
     yield
   rescue Exception => e
-    handle(ctrl, e, env[RACK_ERRORS])
+    handle(ctrl, e, env['rack.errors'])
   end
 
   private
   def handle ctrl, e, stderr=nil
-    raise e unless self.class.handle_exceptions
     handler = self.class.handlers.find{ |klass, block|
       break block if e.kind_of?(klass)
     }
     if handler
       ctrl.block_call(e, handler)
-    elsif e.kind_of?(Respond) # InternalError ends up here if no handlers
+    elsif !self.class.handle_exceptions
+      raise e
+    elsif e.kind_of?(Response) # InternalError ends up here if no handlers
       [e.status, e.headers, e.body]
     else # fallback and see if there's any InternalError handler
       log_error(e, stderr)

data/lib/jellyfish/test.rb

@@ -0,0 +1,22 @@
+
+require 'bacon'
+require 'rack'
+require 'jellyfish'
+
+Bacon.summary_on_exit
+
+shared :jellyfish do
+  %w[options get head post put delete patch].each do |method|
+    instance_eval <<-RUBY
+      def #{method} path='/', app=app
+        app.call('PATH_INFO' => path, 'REQUEST_METHOD' => '#{method}'.upcase)
+      end
+    RUBY
+  end
+end
+
+module Kernel
+  def eq? rhs
+    self == rhs
+  end
+end

data/lib/jellyfish/version.rb

@@ -1,4 +1,4 @@
 
 module Jellyfish
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/sinatra/builder_test.rb

@@ -0,0 +1,95 @@
+require File.expand_path('../helper', __FILE__)
+
+begin
+require 'builder'
+
+class BuilderTest < Test::Unit::TestCase
+  def builder_app(options = {}, &block)
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'
+      set options
+      get '/', &block
+    }
+    get '/'
+  end
+
+  it 'renders inline Builder strings' do
+    builder_app { builder 'xml.instruct!' }
+    assert ok?
+    assert_equal %{<?xml version="1.0" encoding="UTF-8"?>\n}, body
+  end
+
+  it 'defaults content type to xml' do
+    builder_app { builder 'xml.instruct!' }
+    assert ok?
+    assert_equal "application/xml;charset=utf-8", response['Content-Type']
+  end
+
+  it 'defaults allows setting content type per route' do
+    builder_app do
+      content_type :html
+      builder 'xml.instruct!'
+    end
+    assert ok?
+    assert_equal "text/html;charset=utf-8", response['Content-Type']
+  end
+
+  it 'defaults allows setting content type globally' do
+    builder_app(:builder => { :content_type => 'html' }) do
+      builder 'xml.instruct!'
+    end
+    assert ok?
+    assert_equal "text/html;charset=utf-8", response['Content-Type']
+  end
+
+  it 'renders inline blocks' do
+    builder_app {
+      @name = "Frank & Mary"
+      builder do |xml|
+        xml.couple @name
+      end
+    }
+    assert ok?
+    assert_equal "<couple>Frank &amp; Mary</couple>\n", body
+  end
+
+  it 'renders .builder files in views path' do
+    builder_app {
+      @name = "Blue"
+      builder :hello
+    }
+    assert ok?
+    assert_equal %(<exclaim>You're my boy, Blue!</exclaim>\n), body
+  end
+
+  it "renders with inline layouts" do
+    mock_app {
+      layout do
+        %(xml.layout { xml << yield })
+      end
+      get('/') { builder %(xml.em 'Hello World') }
+    }
+    get '/'
+    assert ok?
+    assert_equal "<layout>\n<em>Hello World</em>\n</layout>\n", body
+  end
+
+  it "renders with file layouts" do
+    builder_app {
+      builder %(xml.em 'Hello World'), :layout => :layout2
+    }
+    assert ok?
+    assert_equal "<layout>\n<em>Hello World</em>\n</layout>\n", body
+  end
+
+  it "raises error if template not found" do
+    mock_app {
+      get('/') { builder :no_such_template }
+    }
+    assert_raise(Errno::ENOENT) { get('/') }
+  end
+end
+
+rescue LoadError
+  warn "#{$!.to_s}: skipping builder tests"
+end

data/sinatra/coffee_test.rb

@@ -0,0 +1,92 @@
+require File.expand_path('../helper', __FILE__)
+
+begin
+require 'coffee-script'
+require 'execjs'
+
+begin
+  ExecJS.compile '1'
+rescue Exception
+  raise LoadError, 'unable to execute JavaScript'
+end
+
+class CoffeeTest < Test::Unit::TestCase
+  def coffee_app(options = {}, &block)
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'
+      set(options)
+      get '/', &block
+    }
+    get '/'
+  end
+
+  it 'renders inline Coffee strings' do
+    coffee_app { coffee "alert 'Aye!'\n" }
+    assert ok?
+    assert body.include?("alert('Aye!');")
+  end
+
+  it 'defaults content type to javascript' do
+    coffee_app { coffee "alert 'Aye!'\n" }
+    assert ok?
+    assert_equal "application/javascript;charset=utf-8", response['Content-Type']
+  end
+
+  it 'defaults allows setting content type per route' do
+    coffee_app do
+      content_type :html
+      coffee "alert 'Aye!'\n"
+    end
+    assert ok?
+    assert_equal "text/html;charset=utf-8", response['Content-Type']
+  end
+
+  it 'defaults allows setting content type globally' do
+    coffee_app(:coffee => { :content_type => 'html' }) do
+      coffee "alert 'Aye!'\n"
+    end
+    assert ok?
+    assert_equal "text/html;charset=utf-8", response['Content-Type']
+  end
+
+  it 'renders .coffee files in views path' do
+    coffee_app { coffee :hello }
+    assert ok?
+    assert_include body, "alert(\"Aye!\");"
+  end
+
+  it 'ignores the layout option' do
+    coffee_app { coffee :hello, :layout => :layout2 }
+    assert ok?
+    assert_include body, "alert(\"Aye!\");"
+  end
+
+  it "raises error if template not found" do
+    mock_app {
+      get('/') { coffee :no_such_template }
+    }
+    assert_raise(Errno::ENOENT) { get('/') }
+  end
+
+  it "passes coffee options to the coffee engine" do
+    coffee_app { coffee "alert 'Aye!'\n", :no_wrap => true }
+    assert ok?
+    assert_body "alert('Aye!');"
+  end
+
+  it "passes default coffee options to the coffee engine" do
+    mock_app do
+      set :coffee, :no_wrap => true # default coffee style is :nested
+      get '/' do
+        coffee "alert 'Aye!'\n"
+      end
+    end
+    get '/'
+    assert ok?
+    assert_body "alert('Aye!');"
+  end
+end
+
+rescue LoadError
+  warn "#{$!.to_s}: skipping coffee tests"
+end