force_format 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee457c3ed5a5a3e98ea89a9c52460069ba8fee0
-  data.tar.gz: d8dfc05478b54c95741cb9df84fc2787ba9fee11
+  metadata.gz: a1866205dca78a0b08e5ac3f71874418eff03487
+  data.tar.gz: d7e6868ffd9742d3e3719e4fd6d20b762eee4dd3
 SHA512:
-  metadata.gz: 59c829db48c25d9495634809a61d3f21fd6c1f5b815c3e152287564ed0f7448dd5925e402d356e6c38825f0e6ffe4c20d715e3ee151620362bbd1282e7fc7a01
-  data.tar.gz: e75df2b5a815be82273d32d7e39c71738f1f866b74e24c4c757e70234290ce9a675987f3082a72d709363b699d6ec42e695ae7fa96acdda16488d61ed3edf9b5
+  metadata.gz: 7d977a2e03662310507ca4cae5b9313e76cdb6647b066f37e2f1356cfb4a9e9d606b93517cb99b9055f1855f82659b022f13a3b8727440e366a405f80a547e00
+  data.tar.gz: 1c5156e06744368cd0a386eca1bc370023ffed67cd7ba8db0218fea225f4c9d9323b0c27214a07b75681e0b060078c6ea49145b3be0378c32a0f0a328e08bf7b

data/.ruby-gemset

@@ -0,0 +1 @@
+force-format

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/README.md

@@ -1,9 +1,16 @@
 # force_format
 
-Define the formats your Rails application should respond to. 
-Normally a Rails3 application tries to respond to all kinds of formats (e.g. html, xml, json, ...). 
-Unfortunately this will raise Errors if the template for the given format can not be found. 
-This is where ```force_format``` joins the game...
+Define the formats your Rails application should respond to within your controllers.
+Normally a Rails3 application tries to respond to all kinds of formats (e.g. html, xml, json, ...).
+Unfortunately this will raise errors if the template for the given format can not be found.
+This is where ```force_format``` joins the game.
+
+
+## Requirements
+
+```rails (3.2.x)```
+
+(This gem is tested with Rails 3.2.x only, but other versions may work too.)
 
 ## Installation
 
@@ -21,41 +28,44 @@ Or install it yourself as:
 
 ## Usage
 
-Include the ```force_format_filter``` method in your controllers. 
-The important param is the ```:for => [:my, :formats]```
-In addition it accepts ```:only => ...```, ```:except => ...```, ```:if => ...``` 
-and ```:unless => ...``` parameters like the Rails filters. 
+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 
+action should respond to (and hopefully find a template).
+In addition it accepts ```:only => ...```, ```:except => ...```, ```:if => ...```
+and ```:unless => ...``` parameters like the Rails filters.
+
+
 
-    ```
     class PagesController < ApplicationController
       force_format_filter :for => [:html, :js], :only => :index
-      
+
       def index
       end
     end
-    
-    ```
-    
-By default ```force_format``` raises an ```ActionController::RoutingError``` 
-if a requested format is not specified via ```:for => []```. It should be easy to 
+
+
+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```:
 
-    ```
+   
     class ApplicationController < ActionController::Base
 
       rescue_from ActionController::RoutingError, :with => :render_error
-      
+
       def render_error
         # handle it
       end
     end
-    
-    ```
+
 
 
 ## TODO
-1. more tests
-2. ability to skip before filters
+1. More tests
+2. Ability to skip before filters
+3. More robust params checking
+4. Custom exception
 
 
 ## Contributing

data/force_format.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = ForceFormat::VERSION
   spec.authors       = ["Marcus Geißler\n"]
   spec.email         = ["marcus3006@gmail.com"]
-  spec.description   = %q{Define the formats your Rails application should respond to}
+  spec.description   = %q{Define the formats your Rails application should respond to in your controllers}
   spec.summary       = %q{Forcing the format Rails controllers should respond to}
   spec.homepage      = "https://github.com/marcusg/force_format"
   spec.license       = "MIT"
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency "rake", '~> 10.1'
+  spec.add_development_dependency 'rspec-rails', '~> 2.0'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.4'
   spec.add_development_dependency "sqlite3"
 
-  spec.add_dependency "rails", "~> 3.2.14"
+  spec.add_dependency "rails", "~> 3.2"
 end

data/lib/force_format/controller_access.rb

@@ -15,6 +15,7 @@ module ControllerAccess
       raise UnsupportedFormatsError.new("There is no support for #{unsupported} format") if unsupported.any?
 
       self.send(:before_filter, opts.slice(:only, :except, :if, :unless)) do |controller|
+        return if controller.instance_variable_get("@_skip_force_format_filter") == true
         format = controller.request.format
         unless forced_formats.include?(format.try(:to_sym))
           raise ActionController::RoutingError, "Format '#{format}' not supported for #{request.path.inspect}"
@@ -22,6 +23,12 @@ module ControllerAccess
       end
     end
 
+    def skip_force_format_filter(opts={})
+      self.send(:prepend_before_filter, opts.slice(:only, :except, :if, :unless)) do |controller|
+        controller.instance_variable_set("@_skip_force_format_filter", true)
+      end
+    end
+
     private
 
     def extract_options(opts)

data/lib/force_format/version.rb

@@ -1,3 +1,3 @@
 module ForceFormat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/base_spec.rb

@@ -138,4 +138,137 @@ describe PagesController, :type => :controller do
   end
 
 
+  context "force_format_filter is used with skip_format_filter specified for all actions" do
+
+    controller do
+      send "force_format_filter"
+      send "skip_force_format_filter"
+
+      def index
+      end
+    end
+
+    it "should respond with 200 for html" do
+      get "index"
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for html" do
+      get "index", :format => :html
+      response.code.should eq("200")
+    end
+
+    it "should respond with MissingTemplate for js" do
+      expect { get "index", :format => :js }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for xml" do
+      expect { get "index", :format => :xml }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for json" do
+      expect { get "index", :format => :json }.to raise_error(ActionView::MissingTemplate)
+    end
+
+  end
+
+
+
+  context "force_format_filter is used with skip_format_filter specified for all actions" do
+
+    controller do
+      send "skip_force_format_filter"
+
+      def index
+      end
+    end
+
+    it "should respond with 200 for html" do
+      get "index"
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for html" do
+      get "index", :format => :html
+      response.code.should eq("200")
+    end
+
+    it "should respond with MissingTemplate for js" do
+      expect { get "index", :format => :js }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for xml" do
+      expect { get "index", :format => :xml }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for json" do
+      expect { get "index", :format => :json }.to raise_error(ActionView::MissingTemplate)
+    end
+
+  end
+
+
+
+  context "force_format_filter is used with no format specified for all actions" do
+
+    controller do
+      send "force_format_filter", :only => :index
+      send "skip_force_format_filter", :only => :skipped
+
+      def new
+        render "with_html"
+      end
+
+      def index
+        render "with_html"
+      end
+    end
+
+    it "should respond with 200 for html" do
+      get "index"
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for html" do
+      get "index", :format => :html
+      response.code.should eq("200")
+    end
+
+    it "should respond with RoutingError for js" do
+      expect { get "index", :format => :js }.to raise_error(ActionController::RoutingError)
+    end
+
+    it "should respond with RoutingError for xml" do
+      expect { get "index", :format => :xml }.to raise_error(ActionController::RoutingError)
+    end
+
+    it "should respond with RoutingError for json" do
+      expect { get "index", :format => :json }.to raise_error(ActionController::RoutingError)
+    end
+
+
+    it "should respond with 200 for html" do
+      get "new"
+      response.code.should eq("200")
+    end
+
+    it "should respond with 200 for html" do
+      get "new", :format => :html
+      response.code.should eq("200")
+    end
+
+    it "should respond with MissingTemplate for js" do
+      expect { get "new", :format => :js }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for xml" do
+      expect { get "new", :format => :xml }.to raise_error(ActionView::MissingTemplate)
+    end
+
+    it "should respond with MissingTemplate for json" do
+      expect { get "new", :format => :json }.to raise_error(ActionView::MissingTemplate)
+    end
+
+  end
+
 end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Dummy::Application.routes.draw do
   get "pages/index"
+  get "pages/new"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: force_format
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - |
@@ -29,44 +29,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -87,15 +87,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.14
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.14
-description: Define the formats your Rails application should respond to
+        version: '3.2'
+description: Define the formats your Rails application should respond to in your controllers
 email:
 - marcus3006@gmail.com
 executables: []
@@ -103,7 +103,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - LICENSE
 - README.md

data/.rvmrc

@@ -1 +0,0 @@
-rvm use ruby-2.0.0-p247@force-format --create