force_format 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a968ff510d11c69b4429c7f611873c9329e0d3dd
-  data.tar.gz: e41c0108cdb7b26af2622c7aa1cac7ad144c84c5
+  metadata.gz: 28bd300a1fa894d648a065a26018ecf8ac37c3d3
+  data.tar.gz: 8eefca9fc7f88b18668829c9e7dcf02ee89c55a5
 SHA512:
-  metadata.gz: 885860ffa29446ae06b1ca60119f645777d62b669649129e127e9f8bf761ade6def5c6453670778805c618133d4608c5bfa08258dc4565f6825c3e729afafe5a
-  data.tar.gz: 1e1f4969071e189f20fa6c325ff96aa900c455cab5dc0c3b53c35a27c3b627ffdf0918c15c4f086bce90506499e2d76ea6fbc5b4b2f12b31460f2b010de8367d
+  metadata.gz: 62449330b602903831c8abec45e214ecce5314cec8c5104fdee9e7c90159809aab31ebc1c63c092a36313ee5a1ef4b95fdd9b9b77bd113fd84d27251aaef89e9
+  data.tar.gz: 40aaacd7294b881fbce2125039df48e131b5d28ec3d80acfafdd26bdd88a49241ac9378a95d263aafe317887bb684068814a90b4d1346e3ae40b7a24f9d9548a

data/README.md

@@ -43,11 +43,32 @@ and ```:unless => ...``` parameters like the Rails filters.
       def index
       end
     end
+    
+If you want to skip the filter in inherited controllers, use the ```skip_force_format_filter``` method. 
+It accepts the same parameters the ```force_format_filter``` methods except ```:for => ...```.
 
+Maybe you want to define the formats more granular, for example different per action. 
+To accomplish this, pass an hash with action names and required formats. Add a *:default* key with formats 
+for actions that are not specified directly. 
+
+
+    class PagesController < ApplicationController
+      force_format_filter :for => {:index => :js, :default => [:json, :html]}
+
+      def index
+        # should respond with js
+      end
+      
+      def new
+        # should respond with json or html
+      end
+
+    end
+    
 
 By default ```force_format``` raises an ```ActionController::RoutingError```
-if a requested format is not specified via ```:for => []```. It should be easy to
-rescue from this exception, for example in your ```application_controller.rb```:
+if a requested format matches none of the attributes specified via ```:for => ...```. 
+It should be easy to rescue from this exception, for example in your ```application_controller.rb```:
 
    
     class ApplicationController < ActionController::Base
@@ -63,7 +84,6 @@ rescue from this exception, for example in your ```application_controller.rb```:
 
 ## TODO
 1. More tests
-2. Ability to skip before filters
 3. More robust params checking
 4. Custom exception
 

data/lib/force_format/controller_access.rb

@@ -22,6 +22,7 @@ module ControllerAccess
 
   def force_format_filter_method
     force_formats = force_format_extract_options_from_filter_chain
+    return unless force_formats
     unsupported = force_formats - FORCE_FORMAT_TYPES
     raise UnsupportedFormatsError.new("There is no support for #{unsupported} format") if unsupported.any?
     format = request.format
@@ -33,7 +34,18 @@ module ControllerAccess
   def force_format_extract_options_from_filter_chain
     filter = self._process_action_callbacks.find { |f| f.filter == :force_format_filter_method }
     force_formats = filter.options[:for]
-    force_formats.is_a?(Array) ? force_formats : (force_formats.is_a?(Symbol) ? [force_formats] : FORCE_FORMAT_DEFAULT_TYPES)
+
+    if force_formats.is_a? (Array || Symbol)
+      [*force_formats]
+    elsif force_formats.is_a? Hash
+      if force_formats[self.action_name.to_sym]
+        [*force_formats[self.action_name.to_sym]]
+      else
+        force_formats[:default] ? [*force_formats[:default]] : nil
+      end
+    else
+      FORCE_FORMAT_DEFAULT_TYPES
+    end
   end
 
 end

data/lib/force_format/version.rb

@@ -1,3 +1,3 @@
 module ForceFormat
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/base_spec.rb

@@ -271,4 +271,74 @@ describe PagesController, :type => :controller do
 
   end
 
+
+  context "force_format_filter is used with format specified more than once" do
+
+    controller do
+      send "force_format_filter", :for => {:index => [:js], :new => :json}
+
+      def index
+        render "with_js"
+      end
+
+      def new
+        render "with_json"
+      end
+    end
+
+    it "should respond with 200 for js" do
+      get "index", :format => :js
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for json" do
+      get "new", :format => :json
+      response.code.should eq("200")
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "index", :format => :html }.to raise_error(ActionController::RoutingError)
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "new", :format => :html }.to raise_error(ActionController::RoutingError)
+    end
+
+  end
+
+  context "force_format_filter is used with format specified more than once but used default" do
+
+    controller do
+      send "force_format_filter", :for => {:index => :js, :default => [:json]}
+
+      def index
+        render "with_js"
+      end
+
+      def new
+        render "with_json"
+      end
+    end
+
+    it "should respond with 200 for js" do
+      get "index", :format => :js
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for json" do
+      get "new", :format => :json
+      response.code.should eq("200")
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "index", :format => :html }.to raise_error(ActionController::RoutingError)
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "new", :format => :html }.to raise_error(ActionController::RoutingError)
+    end
+
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: force_format
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - |
@@ -146,6 +146,9 @@ files:
 - spec/dummy/app/views/pages/with_html.html.erb
 - spec/dummy/app/views/pages/with_html_js.html.erb
 - spec/dummy/app/views/pages/with_html_js.js.erb
+- spec/dummy/app/views/pages/with_js.js.erb
+- spec/dummy/app/views/pages/with_json.json.erb
+- spec/dummy/app/views/pages/with_xml.xml.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -210,6 +213,9 @@ test_files:
 - spec/dummy/app/views/pages/with_html.html.erb
 - spec/dummy/app/views/pages/with_html_js.html.erb
 - spec/dummy/app/views/pages/with_html_js.js.erb
+- spec/dummy/app/views/pages/with_js.js.erb
+- spec/dummy/app/views/pages/with_json.json.erb
+- spec/dummy/app/views/pages/with_xml.xml.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb