force_format 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,23 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+*.gem
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp/spec/dummy/db/test.sqlite3
+/spec/dummy/log/test.log
+/spec/dummy/db/test.sqlite3

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in force_format.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# 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
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Marcus Geißler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# 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...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'force_format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install force_format
+
+## 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. 
+
+    ```
+    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 
+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
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForceFormat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/force_format.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'force_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "force_format"
+  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.summary       = %q{Forcing the format Rails controllers should respond to}
+  spec.homepage      = "https://github.com/marcusg/force_format"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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 "sqlite3"
+
+  spec.add_dependency "rails", "~> 3.2.14"
+end

data/lib/force_format.rb

@@ -0,0 +1,2 @@
+require "force_format/version"
+require 'force_format/railtie'

data/lib/force_format/controller_access.rb

@@ -0,0 +1,38 @@
+require_relative "errors"
+
+module ControllerAccess
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    include ForceFormat::Errors
+    FORCE_FORMAT_TYPES = [:html, :js, :json, :pdf, :csv, :zip, :xml]
+    FORCE_FORMAT_DEFAULT_TYPES = [:html]
+
+    def force_format_filter(opts={})
+      forced_formats = extract_options(opts)
+
+      unsupported = forced_formats - FORCE_FORMAT_TYPES
+      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|
+        format = controller.request.format
+        unless forced_formats.include?(format.try(:to_sym))
+          raise ActionController::RoutingError, "Format '#{format}' not supported for #{request.path.inspect}"
+        end
+      end
+    end
+
+    private
+
+    def extract_options(opts)
+      if opts[:for].is_a?(Array)
+        opts[:for]
+      elsif opts[:for].is_a?(Symbol)
+        [opts[:for]]
+      else
+        FORCE_FORMAT_DEFAULT_TYPES
+      end
+    end
+
+  end
+end

data/lib/force_format/errors.rb

@@ -0,0 +1,6 @@
+module ForceFormat
+  module Errors
+    class UnsupportedFormatsError < StandardError
+    end
+  end
+end

data/lib/force_format/railtie.rb

@@ -0,0 +1,22 @@
+require_relative "controller_access"
+require_relative "view_patch"
+
+module ForceFormat
+
+  class Railtie < Rails::Railtie
+
+    initializer "force_format.controller" do
+      ActiveSupport.on_load :action_controller do
+        include ControllerAccess
+      end
+    end
+
+    initializer "force_format.view" do
+      ActiveSupport.on_load :action_view do
+        include ViewPatch
+      end
+    end
+
+  end
+
+end

data/lib/force_format/version.rb

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

data/lib/force_format/view_patch.rb

@@ -0,0 +1,11 @@
+module ViewPatch
+  class ActionView::LookupContext
+    def formats=(values)
+      if values
+        values.concat(default_formats) if values.delete "*/*"
+        values << :html if values.empty?
+      end
+      super(values)
+    end
+  end
+end

data/lib/tasks/force_format_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :force_format do
+#   # Task goes here
+# end

data/spec/base_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe PagesController, :type => :controller do
+
+  context "force_format_filter is not used" do
+
+    controller do
+      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 [:html] for all actions" do
+
+    controller do
+      send "force_format_filter", :for => [:html]
+
+      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
+
+  end
+
+  context "force_format_filter is used with [:html, :js] for all actions" do
+
+    controller do
+      send "force_format_filter", :for => [:html, :js]
+
+      def index
+        render "with_html_js"
+      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 200 for js" do
+      get "index", :format => :js
+      response.code.should eq("200")
+    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
+
+  end
+
+
+  context "force_format_filter is used with no format specified for all actions" do
+
+    controller do
+      send "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 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
+
+  end
+
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.