jellyfish 0.6.0 → 0.8.0

data/jellyfish.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "0.6.0"
+  s.version = "0.8.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-11-02"
-  s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middlewares. Under 200 lines of code."
+  s.date = "2013-06-15"
+  s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middlewares. Around 200 lines of code."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
   ".gitignore",
@@ -19,13 +19,14 @@ Gem::Specification.new do |s|
   "README.md",
   "Rakefile",
   "TODO.md",
-  "example/config.ru",
-  "example/rainbows.rb",
-  "example/server.sh",
   "jellyfish.gemspec",
   "jellyfish.png",
   "lib/jellyfish.rb",
+  "lib/jellyfish/chunked_body.rb",
+  "lib/jellyfish/multi_actions.rb",
   "lib/jellyfish/newrelic.rb",
+  "lib/jellyfish/normalized_params.rb",
+  "lib/jellyfish/normalized_path.rb",
   "lib/jellyfish/public/302.html",
   "lib/jellyfish/public/404.html",
   "lib/jellyfish/public/500.html",
@@ -34,15 +35,29 @@ Gem::Specification.new do |s|
   "lib/jellyfish/version.rb",
   "task/.gitignore",
   "task/gemgem.rb",
-  "test/sinatra/test_base.rb"]
+  "test/sinatra/test_base.rb",
+  "test/sinatra/test_chunked_body.rb",
+  "test/sinatra/test_error.rb",
+  "test/sinatra/test_multi_actions.rb",
+  "test/sinatra/test_routing.rb",
+  "test/test_from_readme.rb",
+  "test/test_inheritance.rb"]
   s.homepage = "https://github.com/godfat/jellyfish"
+  s.licenses = ["Apache License 2.0"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.0.3"
   s.summary = "Pico web framework for building API-centric web applications."
-  s.test_files = ["test/sinatra/test_base.rb"]
+  s.test_files = [
+  "test/sinatra/test_base.rb",
+  "test/sinatra/test_chunked_body.rb",
+  "test/sinatra/test_error.rb",
+  "test/sinatra/test_multi_actions.rb",
+  "test/sinatra/test_routing.rb",
+  "test/test_from_readme.rb",
+  "test/test_inheritance.rb"]
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rack>, [">= 0"])

data/lib/jellyfish.rb

@@ -4,6 +4,14 @@ module Jellyfish
   autoload :Sinatra , 'jellyfish/sinatra'
   autoload :NewRelic, 'jellyfish/newrelic'
 
+  autoload :MultiActions    , 'jellyfish/multi_actions'
+  autoload :NormalizedParams, 'jellyfish/normalized_params'
+  autoload :NormalizedPath  , 'jellyfish/normalized_path'
+
+  autoload :ChunkedBody, 'jellyfish/chunked_body'
+
+  GetValue = Object.new
+
   class Response < RuntimeError
     def headers
       @headers ||= {'Content-Type' => 'text/html'}
@@ -27,34 +35,30 @@ module Jellyfish
   # -----------------------------------------------------------------
 
   class Controller
-    module Call
-      def call env
-        @env = env
-        block_call(*dispatch)
-      end
-
-      def block_call argument, block
-        ret = instance_exec(argument, &block)
-        body ret if body.nil? # prefer explicitly set values
-        body ''  if body.nil? # at least give an empty string
-        [status || 200, headers || {}, body]
-      rescue LocalJumpError
-        jellyfish.log("Use `next' if you're trying to `return' or" \
-                      " `break' from the block.", env['rack.errors'])
-        raise
-      end
-    end
-    include Call
-
     attr_reader :routes, :jellyfish, :env
     def initialize routes, jellyfish
       @routes, @jellyfish = routes, jellyfish
       @status, @headers, @body = nil
     end
 
-    def request  ; @request ||= Rack::Request.new(env); end
-    def forward  ; raise(Jellyfish::NotFound.new)     ; end
-    def found url; raise(Jellyfish::   Found.new(url)); end
+    def call env
+      @env = env
+      block_call(*dispatch)
+    end
+
+    def block_call argument, block
+      val = instance_exec(argument, &block)
+      [status || 200, headers || {}, body || with_each(val || '')]
+    rescue LocalJumpError
+      jellyfish.log("Use `next' if you're trying to `return' or" \
+                    " `break' from the block.", env['rack.errors'])
+      raise
+    end
+
+    def request   ; @request ||= Rack::Request.new(env); end
+    def halt *args; throw(:halt, *args)                ; 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
@@ -62,8 +66,8 @@ module Jellyfish
 
     %w[status headers].each do |field|
       module_eval <<-RUBY
-        def #{field} value=nil
-          if value.nil?
+        def #{field} value=GetValue
+          if value == GetValue
             @#{field}
           else
             @#{field} = value
@@ -72,13 +76,13 @@ module Jellyfish
       RUBY
     end
 
-    def body value=nil
-      if value.nil?
+    def body value=GetValue
+      if value == GetValue
         @body
-      elsif value.respond_to?(:each) # per rack SPEC
+      elsif value.nil?
         @body = value
       else
-        @body = [value]
+        @body = with_each(value)
       end
     end
 
@@ -106,40 +110,70 @@ module Jellyfish
         end
       } || raise(Jellyfish::NotFound.new)
     end
+
+    def with_each value
+      if value.respond_to?(:each) then value else [value] end
+    end
   end
 
   # -----------------------------------------------------------------
 
   module DSL
-    def handlers; @handlers ||= {}; end
     def routes  ; @routes   ||= {}; end
-
-    def handle_exceptions value=nil
-      if value.nil?
+    def handlers; @handlers ||= {}; end
+    def handle exception, &block; handlers[exception] = block; end
+    def handle_exceptions value=GetValue
+      if value == GetValue
         @handle_exceptions
       else
         @handle_exceptions = value
       end
     end
 
-    def handle exception, &block; handlers[exception] = block; end
+    def controller_include *value
+      (@controller_include ||= []).push(*value)
+    end
+
+    def controller value=GetValue
+      if value == GetValue
+        @controller ||= controller_inject(
+          const_set(:Controller, Class.new(Controller)))
+      else
+        @controller   = controller_inject(value)
+      end
+    end
+
+    def controller_inject value
+      controller_include.
+        inject(value){ |ctrl, mod| ctrl.__send__(:include, mod) }
+    end
 
     %w[options get head post put delete patch].each do |method|
       module_eval <<-RUBY
-        def #{method} route, &block
+        def #{method} route=//, &block
+          raise TypeError.new("Route \#{route} should respond to :match") \
+            unless route.respond_to?(:match)
           (routes['#{method}'] ||= []) << [route, block]
         end
       RUBY
     end
+
+    def inherited sub
+      sub.handle_exceptions(handle_exceptions)
+      sub.controller_include(*controller_include)
+      [:handlers, :routes].each{ |m|
+        val = __send__(m).inject({}){ |r, (k, v)| r[k] = v.dup; r }
+        sub.__send__(m).replace(val) # dup the routing arrays
+      }
+    end
   end
 
   # -----------------------------------------------------------------
 
   def initialize app=nil; @app = app; end
-  def controller        ; Controller; end
 
   def call env
-    ctrl = controller.new(self.class.routes, self)
+    ctrl = self.class.controller.new(self.class.routes, self)
     ctrl.call(env)
   rescue NotFound => e # forward
     if app
@@ -167,10 +201,7 @@ module Jellyfish
 
   private
   def handle ctrl, e, stderr=nil
-    handler = self.class.handlers.find{ |klass, block|
-      break block if e.kind_of?(klass)
-    }
-    if handler
+    if handler = best_handler(e)
       ctrl.block_call(e, handler)
     elsif !self.class.handle_exceptions
       raise e
@@ -182,6 +213,19 @@ module Jellyfish
     end
   end
 
+  def best_handler e
+    handlers = self.class.handlers
+    if handlers.key?(e.class)
+      handlers[e.class]
+    else # or find the nearest match and cache it
+      ancestors         = e.class.ancestors
+      handlers[e.class] = handlers.
+        inject([nil, Float::INFINITY]){ |(handler, val), (klass, block)|
+          idx = ancestors.index(klass) || Float::INFINITY # lower is better
+          if idx < val then [block, idx] else [handler, val] end }.first
+    end
+  end
+
   # -----------------------------------------------------------------
 
   def self.included mod

data/lib/jellyfish/chunked_body.rb

@@ -0,0 +1,20 @@
+
+require 'jellyfish'
+
+module Jellyfish
+  class ChunkedBody
+    include Enumerable
+    attr_reader :body
+    def initialize &body
+      @body = body
+    end
+
+    def each &block
+      if block
+        body.call(block)
+      else
+        to_enum(:each)
+      end
+    end
+  end
+end

data/lib/jellyfish/multi_actions.rb

@@ -0,0 +1,35 @@
+
+require 'jellyfish'
+
+
+
+module Jellyfish
+  module MultiActions
+    Identity = lambda{|_|_}
+
+    def call env
+      @env = env
+      catch(:halt){
+        dispatch.inject(nil){ |_, route_block| block_call(*route_block) }
+      } || block_call(nil, Identity) # respond the default if halted
+    end
+
+    def dispatch
+      acts = actions.map{ |(route, block)|
+        case route
+        when String
+          [route, block] if route == path_info
+        else#Regexp, using else allows you to use custom matcher
+          match = route.match(path_info)
+          [match, block] if match
+        end
+      }.compact
+
+      if acts.empty?
+        raise(Jellyfish::NotFound.new)
+      else
+        acts
+      end
+    end
+  end
+end

data/lib/jellyfish/newrelic.rb

@@ -1,7 +1,6 @@
 
 require 'jellyfish'
 require 'rack/request'
-
 require 'new_relic/agent/instrumentation/controller_instrumentation'
 
 module Jellyfish

data/lib/jellyfish/normalized_params.rb

@@ -0,0 +1,55 @@
+
+require 'jellyfish'
+require 'rack/request'
+
+
+module Jellyfish
+  module NormalizedParams
+    attr_reader :params
+    def block_call argument, block
+      initialize_params(argument)
+      super
+    end
+
+    private
+    def initialize_params argument
+      @params = force_encoding(indifferent_params(
+      if argument.kind_of?(MatchData)
+        # merge captured data from matcher into params as sinatra
+        request.params.merge(Hash[argument.names.zip(argument.captures)])
+      else
+        request.params
+      end))
+    end
+
+    # 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
+
+    # stolen from sinatra
+    # Fixes encoding issues by casting params to Encoding.default_external
+    def force_encoding(data, encoding=Encoding.default_external)
+      return data if data.respond_to?(:rewind) # e.g. Tempfile, File, etc
+      if data.respond_to?(:force_encoding)
+        data.force_encoding(encoding).encode!
+      elsif data.respond_to?(:each_value)
+        data.each_value{ |v| force_encoding(v, encoding) }
+      elsif data.respond_to?(:each)
+        data.each{ |v| force_encoding(v, encoding) }
+      end
+      data
+    end
+  end
+end

data/lib/jellyfish/normalized_path.rb

@@ -0,0 +1,13 @@
+
+require 'jellyfish'
+require 'uri'
+
+
+module Jellyfish
+  module NormalizedPath
+    def path_info
+      path = URI.decode_www_form_component(super, Encoding.default_external)
+      if path.start_with?('/') then path else "/#{path}" end
+    end
+  end
+end

data/lib/jellyfish/sinatra.rb

@@ -1,54 +1,13 @@
 
 require 'jellyfish'
-require 'rack/request'
+require 'jellyfish/multi_actions'
+require 'jellyfish/normalized_params'
+require 'jellyfish/normalized_path'
 
 module Jellyfish
   module Sinatra
-    attr_reader :params
-    def block_call argument, block
-      initialize_params(argument)
-      super
-    end
-
-    private
-    def initialize_params argument
-      @params ||= force_encoding(indifferent_params(
-      if argument.kind_of?(MatchData)
-        # merge captured data from matcher into params as sinatra
-        request.params.merge(Hash[argument.names.zip(argument.captures)])
-      else
-        request.params
-      end))
-    end
-
-    # 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
-
-    # stolen from sinatra
-    # Fixes encoding issues by casting params to Encoding.default_external
-    def force_encoding(data, encoding=Encoding.default_external)
-      return data if data.respond_to?(:rewind) # e.g. Tempfile, File, etc
-      if data.respond_to?(:force_encoding)
-        data.force_encoding(encoding).encode!
-      elsif data.respond_to?(:each_value)
-        data.each_value{ |v| force_encoding(v, encoding) }
-      elsif data.respond_to?(:each)
-        data.each{ |v| force_encoding(v, encoding) }
-      end
-      data
-    end
+    include MultiActions
+    include NormalizedParams
+    include NormalizedPath
   end
 end