force_format 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ac779bcc013cd1f365392fc62a32e2f4f46e44
-  data.tar.gz: fa92721556b7cdf1ab10e2e0939ab5bbb16afd4d
+  metadata.gz: 4345cd2da6375d312b3c78e8d675dce5334cd1c2
+  data.tar.gz: 541fd591fa06f058a59417c6abad05e05b6684da
 SHA512:
-  metadata.gz: 6c61b3540f0d4e658ec60c82327d0de69f7f03238fe5cd3efcb478abd59d13aeacc9812a6aa04e53eba27323c72c6d7c08738a969cd21744a4249c57fddffee8
-  data.tar.gz: 6acfad6780cb668e7ffd489ae62317a1efa9ee6acc350928323dc8ce2719fce90a3b6e91926eb2ef6297bea4fa631b530ef915a02f091754f0fa74e3042e849e
+  metadata.gz: d13f190eb6b6ece7829c9af976a64dac687fba1e4c3b2cf43bf85d595064d8f668ddb5c0be256f65fa3e4b490098530133f7cccede82258ca21c1dbc0cfa29e7
+  data.tar.gz: 1e3c7372ae4bcdc618f9d5f03a1ec3ae8695198442ccb6cb8d2605a757940318d0128ed170548df9f6d52f190b1e1c43cc2b99480de507afaebf0df9a2d2d5e4

data/.gitignore

@@ -21,3 +21,5 @@ test/version_tmp
 tmp/spec/dummy/db/test.sqlite3
 /spec/dummy/log/test.log
 /spec/dummy/db/test.sqlite3
+/spec/dummy3.2/log/test.log
+/spec/dummy4.0/log/test.log

data/.travis.yml

@@ -0,0 +1,31 @@
+language: ruby
+
+script: "bundle exec rake spec"
+bundler_args: ''
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+env:
+  - RAILS_VERSION=3.2
+  - RAILS_VERSION=4.0
+
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      gemfile: gemfiles/4.0.gemfile
+      env: RAILS_VERSION=3.2
+    - rvm: 1.9.3
+      gemfile: gemfiles/4.0.gemfile
+      env: RAILS_VERSION=3.2
+    - rvm: 2.0.0
+      gemfile: gemfiles/3.2.gemfile
+      env: RAILS_VERSION=4.0
+    - rvm: 1.9.3
+      gemfile: gemfiles/3.2.gemfile
+      env: RAILS_VERSION=4.0

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "3.2" do
+  gem "rails", "~> 3.2.14"
+end
+
+appraise "4.0" do
+  gem "rails", "~> 4.0.0"
+end

data/Gemfile

@@ -5,9 +5,6 @@ source "https://rubygems.org"
 # development dependencies will be added by default to the :development group.
 gemspec
 
-# jquery-rails is used by the dummy application
-gem "jquery-rails"
-
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing

data/README.md

@@ -1,16 +1,38 @@
 # force_format
 
-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.
+[![Gem Version](https://badge.fury.io/rb/force_format.png)](http://badge.fury.io/rb/force_format)
+[![Build Status](https://travis-ci.org/marcusg/force_format.png?branch=master)](https://travis-ci.org/marcusg/force_format)
+[![Code Climate](https://codeclimate.com/github/marcusg/force_format.png)](https://codeclimate.com/github/marcusg/force_format)
+[![Dependency Status](https://gemnasium.com/marcusg/force_format.png)](https://gemnasium.com/marcusg/force_format)
 
+Define  the formats your Rails application should respond to within your controllers.
 
-## Requirements
+## Background
+
+Normally a Rails3 application tries to respond to all kinds of formats (e.g. html, xml, json, ...)
+defined via ```respond_to``` inside the controller. Given the following setup for a controller responding
+to html and javascript requests.
+
+    class PagesController < ApplicationController
+
+      def index
+        respond_to do |format|
+          format.html
+          format.js
+        end
+      end
+    end
 
-```rails (3.2.x)```
+All other requests will return a white page with status code 406 (Not Acceptable). FOr some this seems to be a correct behaviour but it may be important for some webapps to render out a error page giving a good description of the error - like 404 pages. In other words: if the action can't handle the requested format render out an error page with an supported format like html.
 
-(This gem is tested with Rails 3.2.x only, but other versions may work too.)
+This is where ```force_format``` joins the game. The gem adds some accessible methods for your controllers based on before_filters. With that you can define the allowed formats for each controller action. If the requested mime-type does not
+match one of the specified formats, ```force_format``` will raise a custom exception wich you can handle on you own (e.g. print out some useful sentences for your users).
+
+Besides this, if you theoretical don't need the ```respond_to``` because you use templates which are rendered by default, you can omit the ```respond_to``` block when using ```force_format```.
+
+## Requirements
+
+```rails >= 3.2```
 
 ## Installation
 
@@ -31,8 +53,8 @@ Or install it yourself as:
 #### 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 
+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.
@@ -45,15 +67,25 @@ 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. 
+
+
+#### Supported format types
+For the moment the following (MIME-)types are available.
+
+    ForceFormat::Controller::FORCE_FORMAT_TYPES
+    => [:html, :js, :json, :pdf, :csv, :zip, :xml]
+
+
+#### Skip the filter
+
+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. 
+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
@@ -62,40 +94,53 @@ for actions that are not specified directly.
       def index
         # should respond with js
       end
-      
+
       def new
         # should respond with json or html
       end
 
     end
-    
 
-#### Exceptions
 
-By default ```force_format``` raises an ```ActionController::RoutingError```
-if a requested format matches none of the attributes specified via ```:for => ...```. 
+#### Handling exceptions
+
+By default ```force_format``` raises an ```ForceFormat::Errors::UnknownFormat```
+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
 
-      rescue_from ActionController::RoutingError, :with => :render_error
+      rescue_from ForceFormat::Errors::UnknownFormat, :with => :render_error
 
       def render_error
         # handle it
       end
     end
-    
 
-You can pass an custom exception lambda to the ```force_format_filter``` method for a better error handling. 
+#### Use custom exception
+
+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! 
+
+#### Widcard accept header
+
+If an user agent sets the accept header wildcard like ```*/*``` ```force_format_filter``` would fallback
+and set the ```request.format``` to *:html*. This is important for access via ```curl``` and I think for the
+google bot too. If you don't want this behaviour of wildcard rewriting you can set the ```:skip_wildcard``` option.
+
+    class PagesController < ApplicationController
+      force_format_filter :for => :html, :skip_wildcard => true
+    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
 2. More robust params checking

data/Rakefile

@@ -1,6 +1,8 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  require 'appraisal'
+  require 'rspec/core/rake_task'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
@@ -21,3 +23,5 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 Bundler::GemHelper.install_tasks
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)

data/force_format.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'shoulda-matchers', '~> 2.4'
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "appraisal", "~> 0.5.2"
 
-  spec.add_dependency "rails", "~> 3.2"
+  spec.add_dependency "rails", ">= 3.2"
 end

data/gemfiles/3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "rails", "~> 3.2.14"
+
+gemspec :path=>"../"

data/gemfiles/3.2.gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: /home/marcus/Work/repos/github/force_format
+  specs:
+    force_format (0.0.6)
+      rails (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    multi_json (1.8.0)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.6)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.2)
+  bundler (~> 1.3)
+  force_format!
+  jquery-rails
+  pry
+  rails (~> 3.2.14)
+  rake (~> 10.1)
+  rspec-rails (~> 2.0)
+  shoulda-matchers (~> 2.4)
+  sqlite3

data/gemfiles/4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jquery-rails"
+gem "rails", "~> 4.0.0"
+
+gemspec :path=>"../"

data/gemfiles/4.0.gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: /home/marcus/Work/repos/github/force_format
+  specs:
+    force_format (0.0.6)
+      rails (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (4.0.0)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.6)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.2)
+  bundler (~> 1.3)
+  force_format!
+  jquery-rails
+  pry
+  rails (~> 4.0.0)
+  rake (~> 10.1)
+  rspec-rails (~> 2.0)
+  shoulda-matchers (~> 2.4)
+  sqlite3

data/lib/force_format/{controller_access.rb → controller.rb}

@@ -1,13 +1,14 @@
 require_relative "errors"
 
 module ForceFormat
-  module ControllerAccess
+  module Controller
     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) }
+    FORCE_FORMAT_EXCEPTION = lambda { |o| raise(UnknownFormat.new(o)) }
     FORCE_FORMAT_WILDCARD = "*/*"
 
+
     module ClassMethods
       include ForceFormat::Errors
 
@@ -29,7 +30,7 @@ module ForceFormat
       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?
+      raise UnsupportedFormat.new("There is no support for #{unsupported} format") if unsupported.any?
 
       if request.format.to_s == FORCE_FORMAT_WILDCARD and not force_format_skip_wildcard_rewrite?
         request.format = :html

data/lib/force_format/errors.rb

@@ -1,6 +1,9 @@
 module ForceFormat
   module Errors
-    class UnsupportedFormatsError < StandardError
+    class UnsupportedFormat < StandardError
+    end
+
+    class UnknownFormat < StandardError
     end
   end
 end

data/lib/force_format/railtie.rb

@@ -1,5 +1,5 @@
-require_relative "controller_access"
-require_relative "view_patch"
+require_relative "controller"
+require_relative "view"
 
 module ForceFormat
 
@@ -7,13 +7,13 @@ module ForceFormat
 
     initializer "force_format.controller" do
       ActiveSupport.on_load :action_controller do
-        include ControllerAccess
+        include Controller
       end
     end
 
     initializer "force_format.view" do
       ActiveSupport.on_load :action_view do
-        include ViewPatch
+        include View
       end
     end
 

data/lib/force_format/version.rb

@@ -1,3 +1,3 @@
 module ForceFormat
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/force_format/{view_patch.rb → view.rb}

@@ -1,5 +1,5 @@
 module ForceFormat
-  module ViewPatch
+  module View
     class ActionView::LookupContext
       def formats=(values)
         if values