jellyfish 0.3.0 → 0.4.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.rbc

data/CHANGES.md

@@ -1,5 +1,65 @@
 # CHANGES
 
+## Jellyfish 0.4.0 -- 2012-10-14
+
+* Now you can define your own custom controller like:
+
+``` ruby
+require 'jellyfish'
+class Heater
+  include Jellyfish
+  get '/status' do
+    temperature
+  end
+
+  def controller; Controller; end
+  class Controller < Jellyfish::Controller
+    def temperature
+      "30\u{2103}\n"
+    end
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Heater.new
+```
+
+* Now it's possible to use a custom matcher instead of regular expression:
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  class Matcher
+    def match path
+      path.reverse == 'match/'
+    end
+  end
+  get Matcher.new do |match|
+    "#{match}\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+* Added a Sinatra flavor controller
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  def controller; Jellyfish::Sinatra; end
+  get %r{^/(?<id>\d+)$} do
+    "Jelly ##{params[:id]}\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
 ## Jellyfish 0.3.0 -- 2012-10-13
 
 * Birthday!

data/README.md

@@ -16,7 +16,7 @@ Rack applications or Rack middlewares. Under 200 lines of code.
 ## DESIGN:
 
 * Learn the HTTP way instead of using some pointless helpers
-* Learn the Rack way instead of wrapping Rack functionality, again
+* Learn the Rack way instead of wrapping Rack functionalities, again
 * Learn regular expression for routes instead of custom syntax
 * Embrace simplicity over convenience
 * Don't make things complicated only for _some_ convenience, but
@@ -28,8 +28,10 @@ Rack applications or Rack middlewares. Under 200 lines of code.
 * Simple
 * No templates
 * No ORM
+* No `dup` in `call`
 * Regular expression routes, e.g. `get %r{/(\d+)}`
 * String routes, e.g. `get '/'`
+* Custom routes, e.g. `get Matcher.new`
 * Build for either Rack applications or Rack middlewares
 
 ## WHY?
@@ -57,6 +59,7 @@ class Tank
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
@@ -71,10 +74,31 @@ class Tank
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
-### Different HTTP status
+### Custom matcher routes
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  class Matcher
+    def match path
+      path.reverse == 'match/'
+    end
+  end
+  get Matcher.new do |match|
+    "#{match}\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+### Different HTTP status and custom headers
 
 ``` ruby
 require 'jellyfish'
@@ -85,10 +109,11 @@ class Tank
     headers_merge 'X-Jellyfish-Mana' => '200'
     body "Jellyfish 100/200\n"
     status 201
-    'return is ignored in this case'
+    'return is ignored if body has already been set'
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
@@ -103,6 +128,7 @@ class Tank
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
@@ -117,6 +143,7 @@ class Tank
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
@@ -135,6 +162,49 @@ class Tank
   end
 end
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
+### Custom controller
+
+``` ruby
+require 'jellyfish'
+class Heater
+  include Jellyfish
+  get '/status' do
+    temperature
+  end
+
+  def controller; Controller; end
+  class Controller < Jellyfish::Controller
+    def temperature
+      "30\u{2103}\n"
+    end
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
+run Heater.new
+```
+
+### Sinatra flavor controller
+
+Currently support:
+
+* Indifferent params
+
+``` ruby
+require 'jellyfish'
+class Tank
+  include Jellyfish
+  def controller; Jellyfish::Sinatra; end
+  get %r{^/(?<id>\d+)$} do
+    "Jelly ##{params[:id]}\n"
+  end
+end
+use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 run Tank.new
 ```
 
@@ -157,6 +227,7 @@ class Tank
 end
 
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 use Heater
 run Tank.new
 ```
@@ -181,6 +252,7 @@ end
 
 HugeTank = Rack::Builder.new do
   use Rack::ContentLength
+  use Rack::ContentType, 'text/plain'
   use Heater
   run Tank.new
 end
@@ -209,10 +281,33 @@ class Tank
 end
 
 use Rack::ContentLength
+use Rack::ContentType, 'text/plain'
 use Protector
 run Tank.new
 ```
 
+### Chunked transfer encoding (streaming)
+
+You would need a proper server setup.
+Here's an example with Rainbows and fibers:
+
+``` ruby
+class Tank
+  include Jellyfish
+  class Body
+    def each
+      (0..4).each{ |i| yield "#{i}\n"; Rainbows.sleep(0.1) }
+    end
+  end
+  get '/chunked' do
+    Body.new
+  end
+end
+use Rack::Chunked
+use Rack::ContentType, 'text/plain'
+run Tank.new
+```
+
 ## CONTRIBUTORS:
 
 * Lin Jen-Shin (@godfat)

data/{config.ru → example/config.ru}

@@ -18,8 +18,7 @@ class Tank
     headers_merge 'X-Jellyfish-Mana' => '200'
     body "Jellyfish 100/200\n"
     status 201
-
-    'return is ignored in this case'
+    'return is ignored if body has already been set'
   end
 
   get '/env' do
@@ -42,17 +41,48 @@ class Tank
   get '/yell' do
     yell
   end
+
+  class Matcher
+    def match path
+      path.reverse == 'match/'
+    end
+  end
+  get Matcher.new do |match|
+    "#{match}\n"
+  end
+
+  class Body
+    def each
+      if Object.const_defined?(:Rainbows)
+        (0..4).each{ |i| yield "#{i}\n"; Rainbows.sleep(0.1) }
+      else
+        yield "You need Rainbows + FiberSpawn (or so) for this\n"
+      end
+    end
+  end
+  get '/chunked' do
+    Body.new
+  end
 end
 
 class Heater
   include Jellyfish
   get '/status' do
-    "30\u{2103}\n"
+    temperature
+  end
+
+  def controller; Controller; end
+  class Controller < Jellyfish::Controller
+    def temperature
+      "30\u{2103}\n"
+    end
   end
 end
 
 HugeTank = Rack::Builder.new do
+  use Rack::Chunked
   use Rack::ContentLength
+  use Rack::ContentType, 'text/plain'
   use Heater
   run Tank.new
 end

data/example/rainbows.rb

@@ -0,0 +1,4 @@
+
+Rainbows! do
+  use :FiberSpawn
+end

data/example/server.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+rainbows -Ilib -c example/rainbows.rb example/config.ru

data/jellyfish.gemspec

@@ -2,14 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "0.3.0"
+  s.version = "0.4.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-13"
+  s.date = "2012-10-14"
   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 = [
+  ".gitignore",
   ".gitmodules",
   ".travis.yml",
   "CHANGES.md",
@@ -17,12 +18,15 @@ Gem::Specification.new do |s|
   "README.md",
   "Rakefile",
   "TODO.md",
-  "config.ru",
+  "example/config.ru",
+  "example/rainbows.rb",
+  "example/server.sh",
   "jellyfish.gemspec",
   "lib/jellyfish.rb",
   "lib/jellyfish/public/302.html",
   "lib/jellyfish/public/404.html",
   "lib/jellyfish/public/500.html",
+  "lib/jellyfish/sinatra.rb",
   "lib/jellyfish/version.rb",
   "task/.gitignore",
   "task/gemgem.rb"]

data/lib/jellyfish.rb

@@ -1,6 +1,7 @@
 
 module Jellyfish
   autoload :VERSION, 'jellyfish/version'
+  autoload :Sinatra, 'jellyfish/sinatra'
 
   REQUEST_METHOD = 'REQUEST_METHOD'
   PATH_INFO      = 'PATH_INFO'
@@ -19,8 +20,8 @@ module Jellyfish
     end
   end
 
-  class NotFound      < Respond; def status; 404; end; end
   class InternalError < Respond; def status; 500; end; end
+  class NotFound      < Respond; def status; 404; end; end
   class Found         < Respond
     attr_reader :url
     def initialize url; @url = url                             ; end
@@ -94,11 +95,11 @@ module Jellyfish
     def dispatch
       actions.find{ |(route, block)|
         case route
-        when Regexp
-          match = route.match(path_info)
-          break match, block if match
         when String
           break route, block if route == path_info
+        else#Regexp, using else allows you to use custom matcher
+          match = route.match(path_info)
+          break match, block if match
         end
       } || raise(NotFound.new)
     end
@@ -132,39 +133,40 @@ module Jellyfish
   # -----------------------------------------------------------------
 
   def initialize app=nil; @app = app; end
+  def controller        ; Controller; end
 
   def call env
-    controller = Controller.new(self.class.routes)
-    controller.call(env)
+    ctrl = controller.new(self.class.routes)
+    ctrl.call(env)
   rescue NotFound => e # forward
     if app
-      protect(controller, env){ app.call(env) }
+      protect(ctrl, env){ app.call(env) }
     else
-      handle(controller, e)
+      handle(ctrl, e)
     end
   rescue Exception => e
-    handle(controller, e, env[RACK_ERRORS])
+    handle(ctrl, e, env[RACK_ERRORS])
   end
 
-  def protect controller, env
+  def protect ctrl, env
     yield
   rescue Exception => e
-    handle(controller, e, env[RACK_ERRORS])
+    handle(ctrl, e, env[RACK_ERRORS])
   end
 
   private
-  def handle controller, e, stderr=nil
+  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
-      controller.block_call(e, handler)
+      ctrl.block_call(e, handler)
     elsif e.kind_of?(Respond) # 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)
-      handle(controller, InternalError.new)
+      handle(ctrl, InternalError.new)
     end
   end
 

data/lib/jellyfish/sinatra.rb

@@ -0,0 +1,37 @@
+
+require 'jellyfish'
+require 'rack/request'
+
+module Jellyfish
+  class Sinatra < Controller
+    attr_reader :request, :params
+    def block_call argument, block
+      @request = Rack::Request.new(env)
+      @params  = indifferent_params(if argument.kind_of?(MatchData)
+      then # merge captured data from matcher into params as sinatra
+        request.params.merge(Hash[argument.names.zip(argument.captures)])
+      else
+        request.params
+      end)
+
+      super
+    end
+
+    private
+    # stolen from sinatra
+    # Enable string or symbol key access to the nested params hash.
+    def indifferent_params(params)
+      params = indifferent_hash.merge(params)
+      params.each do |key, value|
+        next unless value.is_a?(Hash)
+        params[key] = indifferent_params(value)
+      end
+    end
+
+    # stolen from sinatra
+    # Creates a Hash with indifferent access.
+    def indifferent_hash
+      Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+    end
+  end
+end

data/lib/jellyfish/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jellyfish
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-13 00:00:00.000000000 Z
+date: 2012-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,6 +36,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .gitmodules
 - .travis.yml
 - CHANGES.md
@@ -43,12 +44,15 @@ files:
 - README.md
 - Rakefile
 - TODO.md
-- config.ru
+- example/config.ru
+- example/rainbows.rb
+- example/server.sh
 - jellyfish.gemspec
 - lib/jellyfish.rb
 - lib/jellyfish/public/302.html
 - lib/jellyfish/public/404.html
 - lib/jellyfish/public/500.html
+- lib/jellyfish/sinatra.rb
 - lib/jellyfish/version.rb
 - task/.gitignore
 - task/gemgem.rb