force_format 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28bd300a1fa894d648a065a26018ecf8ac37c3d3
-  data.tar.gz: 8eefca9fc7f88b18668829c9e7dcf02ee89c55a5
+  metadata.gz: 2fe49634705c6855feceebc92a404d1387131592
+  data.tar.gz: 4612743defc0c159744ff61c0446a9f9a597a192
 SHA512:
-  metadata.gz: 62449330b602903831c8abec45e214ecce5314cec8c5104fdee9e7c90159809aab31ebc1c63c092a36313ee5a1ef4b95fdd9b9b77bd113fd84d27251aaef89e9
-  data.tar.gz: 40aaacd7294b881fbce2125039df48e131b5d28ec3d80acfafdd26bdd88a49241ac9378a95d263aafe317887bb684068814a90b4d1346e3ae40b7a24f9d9548a
+  metadata.gz: 9e8dd46441bd10e71348585584b5a06f75b2785755a7d83872b2c804b1c7fffb3132e23fb0025c992c15b3ef2bd2d9aa5a0f19051483da453dfd7adc53609704
+  data.tar.gz: f09a265a3532b543204e86e62100a6bb757b417c8260807a8540bee041722f17ba9f292edb75abb29ed74286e6a454cfead4cbe6239591dc43ee59657f56aea0

data/README.md

@@ -28,6 +28,8 @@ Or install it yourself as:
 
 ## Usage
 
+#### Basics
+
 Include the ```force_format_filter``` method in your controllers.
 The important param is the ```:for => [:my, :formats]```. 
 With that given array of fomat types you can define the formats the 
@@ -47,6 +49,8 @@ and ```:unless => ...``` parameters like the Rails filters.
 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 => ...```.
 
+#### And more options...
+
 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. 
@@ -66,6 +70,8 @@ for actions that are not specified directly.
     end
     
 
+#### Exceptions
+
 By default ```force_format``` raises an ```ActionController::RoutingError```
 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```:
@@ -79,13 +85,20 @@ It should be easy to rescue from this exception, for example in your ```applicat
         # handle it
       end
     end
+    
 
+You can pass an custom exception lambda to the ```force_format_filter``` method for a better error handling. 
+
+    class PagesController < ApplicationController
+      force_format_filter :for => :html, :exception => lambda { |msg| raise(MyApp::AwesomeException.new(msg)) }
+    end
 
+NOTE: Call the method ```force_format_filter``` only once per controller! 
+If you call it multiple times, the last one would be used.
 
 ## TODO
 1. More tests
-3. More robust params checking
-4. Custom exception
+2. More robust params checking
 
 
 ## Contributing

data/lib/force_format/controller_access.rb

@@ -4,12 +4,13 @@ module ControllerAccess
   extend ActiveSupport::Concern
   FORCE_FORMAT_TYPES = [:html, :js, :json, :pdf, :csv, :zip, :xml]
   FORCE_FORMAT_DEFAULT_TYPES = [:html]
+  FORCE_FORMAT_EXCEPTION = lambda { |o| raise(ActionController::RoutingError, o) }
 
   module ClassMethods
     include ForceFormat::Errors
 
     def force_format_filter(opts={})
-      send(:before_filter, :force_format_filter_method, opts.slice(:only, :except, :if, :unless, :for))
+      send(:before_filter, :force_format_filter_method, opts.slice(:only, :except, :if, :unless, :for, :exception))
     end
 
     def skip_force_format_filter(opts={})
@@ -21,19 +22,22 @@ module ControllerAccess
   private
 
   def force_format_filter_method
-    force_formats = force_format_extract_options_from_filter_chain
+    force_formats = force_format_extract_formats
     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
     unless force_formats.include?(format.try(:to_sym))
-      raise ActionController::RoutingError, "Format '#{format}' not supported for #{request.path.inspect}"
+      force_format_extract_exception.call("Format '#{format}' not supported for #{request.path.inspect}")
     end
   end
 
-  def force_format_extract_options_from_filter_chain
+  def force_format_load_filter_chain
     filter = self._process_action_callbacks.find { |f| f.filter == :force_format_filter_method }
-    force_formats = filter.options[:for]
+  end
+
+  def force_format_extract_formats
+    force_formats = force_format_load_filter_chain.options[:for]
 
     if force_formats.is_a? (Array || Symbol)
       [*force_formats]
@@ -48,4 +52,8 @@ module ControllerAccess
     end
   end
 
+  def force_format_extract_exception
+    force_format_load_filter_chain.options[:exception] || FORCE_FORMAT_EXCEPTION
+  end
+
 end

data/lib/force_format/version.rb

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

data/spec/base_spec.rb

@@ -341,4 +341,51 @@ describe PagesController, :type => :controller do
   end
 
 
+  context "force_format_filter is used with unsupported format" do
+
+    controller do
+      send "force_format_filter", :for => {:index => :what}
+
+      def index
+        render "with_js"
+      end
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "index", :format => :html }.to raise_error(UnsupportedFormatsError)
+    end
+
+  end
+
+  context "force_format_filter is used with unsupported format" do
+
+    controller do
+      send "force_format_filter", :for => {:index => :what}
+
+      def index
+        render "with_js"
+      end
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "index", :format => :html }.to raise_error(UnsupportedFormatsError)
+    end
+
+  end
+
+  context "force_format_filter is used with a custom exception" do
+
+    controller do
+      send "force_format_filter", :for => [:js], :exception => lambda { |o| raise(ActiveRecord::RecordNotFound, o) }
+
+      def index
+        render "with_js"
+      end
+    end
+
+    it "should respond with RoutingError for html" do
+      expect { get "index", :format => :html }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ require 'rspec/rails'
 require 'rspec/autorun'
 require 'force_format'
 require 'pry'
+require_relative '../lib/force_format/errors'
+
+include ForceFormat::Errors
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: force_format
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - |