jellyfish 0.5.2 → 0.5.3

data/CHANGES.md

@@ -1,5 +1,52 @@
 # CHANGES
 
+## Jellyfish 0.5.3 -- 2012-10-26
+
+### Enhancements for Jellyfish core
+
+* Respond an empty string response if the block gives a nil.
+* Added Jellyfish#log method which allow you to use the same
+  way as Jellyfish log things.
+* rescue LocalJumpError and give a hint if you're trying to
+  return or break from the block. You should use `next` instead.
+  Or you can simply pass lambda which you can safely `return`.
+  For example: `get '/path', &lambda{ return "body" }`
+
+### Enhancements for Sinatra flavored controller
+
+* Introduced `initialize_params` and only initialize them whenever
+  it's not yet set, giving you the ability to initialize params
+  before calling `block_call`, thus you can customize params more
+  easily. An example for making NewRelic work would be like this:
+
+``` ruby
+class Controller < Api::Controller
+  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+  def block_call argument, block
+    path = if argument.respond_to?(:regexp)
+             argument.regexp
+           else
+             argument
+           end.to_s[1..-1]
+    name = "#{env['REQUEST_METHOD']} #{path}"
+    initialize_params(argument)                     # magic category, see:
+                      # NewRelic::MetricParser::WebTransaction::Jellyfish
+    perform_action_with_newrelic_trace(:category => 'Controller/Jellyfish',
+                                       :path     => path                  ,
+                                       :name     => name                  ,
+                                       :request  => request               ,
+                                       :params   => params ){ super }
+  end
+end
+
+module NewRelic::MetricParser::WebTransaction::Jellyfish
+  include NewRelic::MetricParser::WebTransaction::Pattern
+  def is_web_transaction?; true; end
+  def category ; 'Jellyfish'; end
+end
+```
+
 ## Jellyfish 0.5.2 -- 2012-10-20
 
 ### Incompatible changes

data/example/config.ru

@@ -69,6 +69,11 @@ class Tank
   get '/overheat' do
     raise Overheat
   end
+
+  # get a hint that use `next' instead;
+  get '/return' do; return; end
+  get '/break'  do; break ; end
+  get '/next'   do; next  ; end # this works
 end
 
 class Heater

data/jellyfish.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "jellyfish"
-  s.version = "0.5.2"
+  s.version = "0.5.3"
 
   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-20"
+  s.date = "2012-10-26"
   s.description = "Pico web framework for building API-centric web applications.\nFor Rack applications or Rack middlewares. Under 200 lines of code."
   s.email = ["godfat (XD) godfat.org"]
   s.files = [

data/lib/jellyfish.rb

@@ -42,7 +42,13 @@ module Jellyfish
     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
 
     def forward  ; raise(Jellyfish::NotFound.new)     ; end
@@ -152,6 +158,11 @@ module Jellyfish
     stderr.puts("[#{self.class.name}] #{e.inspect} #{e.backtrace}")
   end
 
+  def log msg, stderr
+    return unless stderr
+    stderr.puts("[#{self.class.name}] #{msg}")
+  end
+
   private
   def handle ctrl, e, stderr=nil
     handler = self.class.handlers.find{ |klass, block|

data/lib/jellyfish/sinatra.rb

@@ -6,18 +6,22 @@ module Jellyfish
   class Sinatra < Controller
     attr_reader :request, :params
     def block_call argument, block
-      @request = Rack::Request.new(env)
-      @params  = force_encoding(indifferent_params(
+      initialize_params(argument)
+      super
+    end
+
+    private
+    def initialize_params argument
+      @request ||= Rack::Request.new(env)
+      @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))
-      super
     end
 
-    private
     # stolen from sinatra
     # Enable string or symbol key access to the nested params hash.
     def indifferent_params(params)

data/lib/jellyfish/version.rb

@@ -1,4 +1,4 @@
 
 module Jellyfish
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jellyfish
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-20 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack