pakada-dispatch 0.0.2 → 0.0.3

data/lib/pakada/dispatch.rb

@@ -1,6 +1,8 @@
 require "pakada"
 require "rack/mount"
+require "yajl"
 
+require "pakada/dispatch/util"
 require "pakada/dispatch/controller"
 require "pakada/dispatch/module"
 require "pakada/dispatch/version"

data/lib/pakada/dispatch/controller.rb

@@ -1,8 +1,10 @@
 class Pakada
   class Dispatch
     Action = Struct.new :block, :options
-
+    
     module Controller
+      include Util
+
       def self.build(&block)
         Class.new do
           include Controller
@@ -14,7 +16,7 @@ class Pakada
       
       def initialize(env)
         @request, @response = Rack::Request.new(env), Rack::Response.new
-        @params = request.env["rack.routing_args"] || {}
+        @params = request.env["pakada.dispatch.params"] || {}
       end
       
       def call_action(name, options = {})
@@ -22,7 +24,58 @@ class Pakada
         raise ArgumentError, "No such action - #{name}" unless action
         
         @options = action.options.merge options
-        instance_eval &action.block
+        catch(:finish) { instance_eval &action.block }
+      end
+      
+      def finish!
+        throw :finish
+      end
+      
+      def redirect(*args)
+        response.status = (Fixnum === args[0]) ? args.shift : 303
+
+        if Symbol === args[0]
+          url = url(*args)
+        elsif args[0].respond_to? :to_url
+          url = args[0].to_url
+        elsif args[0]
+          url = args[0]
+        end
+          
+        response.headers["Location"] = url
+        finish!
+      end
+      
+      def forbidden(format = nil)
+        response.status = 403
+        if format == :json
+          response.headers["Content-Type"] = "application/json"
+          response.write Yajl::Encoder.encode({
+            :status => {
+              :code => 403,
+              :message => "Forbidden"
+            }
+          })
+        else
+          response.write "403 Forbidden"
+        end
+        finish!
+      end
+      
+      def not_found(format = nil)
+        response.status = 404
+        if format == :json
+          response.headers["Content-Type"] = "application/json"
+          response.write Yajl::Encoder.encode({
+            :status => {
+              :code => 404,
+              :message => "Not Found"
+            }
+          })
+        else
+          response.write "404 Not Found"
+        end
+        finish!
       end
       
       module ClassMethods

data/lib/pakada/dispatch/module.rb

@@ -1,6 +1,8 @@
 class Pakada
   class Dispatch
     module Module
+      include Util
+      
       attr_reader :controllers
       
       def load_controllers
@@ -52,7 +54,7 @@ class Pakada
           mod = Pakada[params[:module]]
           controller = mod.controllers[params[:controller].to_sym] if mod
           if controller
-            controller.action(params[:action].to_sym).call env
+            controller.action(params[:action]).call(env)
           else
             [404, {"X-Cascade" => "pass"}, []]
           end
@@ -62,9 +64,5 @@ class Pakada
         Pakada[:dispatch].router.add_route app, {:path_info => route}, defaults, name
       end
     end
-    
-    def url(*args)
-      router.url({}, *args)
-    end
   end
 end

data/lib/pakada/dispatch/util.rb

@@ -0,0 +1,12 @@
+class Pakada
+  class Dispatch
+    module Util
+      def url(*args)
+        params = args.find {|a| a.kind_of?(Hash) }
+        args << params = {} unless params
+        params[:only_path] = true
+        Pakada[:dispatch].router.url({}, *args)
+      end
+    end
+  end
+end

data/lib/pakada/dispatch/version.rb

@@ -1,5 +1,5 @@
 class Pakada
   class Dispatch
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/pakada-dispatch.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "pakada"
   s.add_dependency "rack-mount"
+  s.add_dependency "yajl-ruby"
   
   s.add_development_dependency "rspec"
   s.add_development_dependency "fakefs"

data/spec/controller_spec.rb

@@ -77,7 +77,7 @@ describe "SomeController" do
     
     it "populates #params with the routing parameters" do
       params = {:foo => :bar}
-      controller = subject.new "rack.routing_args" => params
+      controller = subject.new "pakada.dispatch.params" => params
       controller.params.should == params
       
       controller = subject.new({})
@@ -119,6 +119,127 @@ describe "SomeController" do
       end
     end
   end
+  
+  describe "#finish!" do
+    it "immediately finishes the action's execution" do
+      finishing = nil
+      subject.action :foo do
+        finishing = :now
+        finish!
+        finishing = :nooot
+      end
+      
+      subject.new({}).call_action :foo
+      finishing.should == :now
+    end
+  end
+  
+  describe "#redirect" do
+    describe "when called with a URL string" do
+      it "redirects to the URL and finishes" do
+        controller = subject.new({})
+        controller.should_receive :finish!
+        controller.redirect "/something"
+        
+        controller.response.headers["Location"].should == "/something"
+      end
+    end
+    
+    describe "when called with an object that responds to #to_url" do
+      it "redirects to the URL returned by #to_url and finishes" do
+        controller = subject.new({})
+        controller.should_receive :finish!
+        controller.redirect stub("object", :to_url => "/something")
+        
+        controller.response.headers["Location"].should == "/something"
+      end
+    end
+    
+    describe "when called with a route name and (optionally) a hash" do
+      it "redirects to the URL generated by Util#url and finishes" do
+        controller = subject.new({})
+        controller.should_receive :finish!
+        controller.should_receive(:url).with(:myroute, :key => "value") { "/something" }
+        controller.redirect :myroute, :key => "value"
+        
+        controller.response.headers["Location"].should == "/something"
+      end
+    end
+    
+    it "accepts an HTTP status code" do
+      controller = subject.new({})
+      controller.stub :finish!
+      controller.redirect 302, "/"
+      
+      controller.response.status.should == 302
+    end
+    
+    it "uses 303 See Other as the default HTTP status code" do
+      controller = subject.new({})
+      controller.stub :finish!
+      controller.redirect "/"
+      
+      controller.response.status.should == 303
+    end
+  end
+  
+  describe "#not_found" do
+    it "sets a 404 status code, writes a message and finishes" do
+      subject.action(:foo) { not_found }
+      controller = subject.new({})
+      
+      controller.should_receive :finish!
+      controller.call_action :foo
+      
+      controller.response.status.should == 404
+      controller.response.body.join.should == "404 Not Found"
+    end
+    
+    describe "when called with :json as argument" do
+      it "writes the message in JSON format" do
+        subject.action(:foo) { not_found :json }
+        controller = subject.new({})
+        controller.call_action :foo
+        
+        controller.response.headers["Content-Type"].should == "application/json"
+        Yajl::Parser.parse(controller.response.body.join).should == {
+          "status" => {
+            "code" => 404,
+            "message" => "Not Found"
+          }
+        }
+      end
+    end
+  end
+  
+  describe "#forbidden" do
+    it "sets a 403 status code, writes a message and finishes" do
+      subject.action(:foo) { forbidden }
+      controller = subject.new({})
+      
+      controller.should_receive :finish!
+      controller.call_action :foo
+      
+      controller.response.status.should == 403
+      controller.response.body.join.should == "403 Forbidden"
+    end
+    
+    describe "when called with :json as argument" do
+      it "writes the message in JSON format" do
+        subject.action(:foo) { forbidden :json }
+        controller = subject.new({})
+        controller.call_action :foo
+        
+        controller.response.headers["Content-Type"].should == "application/json"
+        Yajl::Parser.parse(controller.response.body.join).should == {
+          "status" => {
+            "code" => 403,
+            "message" => "Forbidden"
+          }
+        }
+      end
+    end
+  end
 end
 
 describe Pakada::Dispatch::Action do

data/spec/module_spec.rb

@@ -279,20 +279,4 @@ describe Pakada::Dispatch::Module do
       end
     end
   end
-  
-  describe "#uri" do
-    before { Pakada.boot }
-    
-    subject { Pakada[:dispatch] }
-    
-    it "passes over to #router.url" do
-      subject.route :myroute, "/:key" => "foo#bar", :key => "value"
-      
-      subject.router.should_receive(:url).with({}, :myroute, :key => "value2").and_return("/value2")
-      subject.url(:myroute, :key => "value2").should == "/value2"
-      
-      subject.router.should_receive(:url).with({}).and_return("/")
-      subject.url.should == "/"
-    end
-  end
 end

data/spec/util_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Pakada::Dispatch::Util do
+  subject do
+    Class.new { include Pakada::Dispatch::Util }.new
+  end
+  
+  describe "#uri" do
+    before do
+      Pakada.stub(:[]).and_return stub("dispatch", :router => stub("router"))
+    end
+    
+    it "passes over to Pakada::Dispatch#router.url" do
+      Pakada[:dispatch].router.should_receive(:url).with({}, :myroute, {
+        :key => "value",
+        :only_path => true
+      }).once.and_return("/value")
+      subject.url(:myroute, :key => "value").should == "/value"
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Lars Gierth
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +01:00
+date: 2011-01-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,7 @@ dependencies:
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: yajl-ruby
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -53,11 +53,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: fakefs
+  name: rspec
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -69,6 +69,19 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: 
 email: 
 - lars.gierth@gmail.com
@@ -89,12 +102,14 @@ files:
 - lib/pakada/dispatch.rb
 - lib/pakada/dispatch/controller.rb
 - lib/pakada/dispatch/module.rb
+- lib/pakada/dispatch/util.rb
 - lib/pakada/dispatch/version.rb
 - pakada-dispatch.gemspec
 - spec/controller_spec.rb
 - spec/dispatch_spec.rb
 - spec/module_spec.rb
 - spec/spec_helper.rb
+- spec/util_spec.rb
 has_rdoc: true
 homepage: https://rubygems.org/gems/pakada-dispatch
 licenses: []
@@ -109,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 375942273
+      hash: -572190931
       segments: 
       - 0
       version: "0"
@@ -118,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 375942273
+      hash: -572190931
       segments: 
       - 0
       version: "0"