before_or_404 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugene Korpan
+
+MIT License
+
+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.rdoc

@@ -0,0 +1,84 @@
+== BeforeOr404 {<img src="https://travis-ci.org/eugenekorpan/before_or_404.png" alt="Build Status" />}[https://travis-ci.org/eugenekorpan/before_or_404] {<img src="https://codeclimate.com/github/eugenekorpan/before_or_404.png" />}[https://codeclimate.com/github/eugenekorpan/before_or_404]
+
+Very simple gem that adds additional filter <code>before_or_404</code> to ActionController::Base.
+It behaves just as a regular <code>before_filter</code> but in a case when error raises in the filter it returns 404 page with 404 status.
+
+== Installation
+
+1 Add this line to your application's Gemfile:
+
+    gem 'before_or_404'
+
+2 And then execute:
+
+    $ bundle
+
+== When to use it
+
+Let's say you have a restful controller and appropriate url to edit a resource 
+
+    http://bestsite.com/books/3/edit
+
+And you have a <code>before_filter</code> to avoid duplication
+
+    class BooksController < ApplicationController
+      before_filter :find_book, :only => [:show, :edit, :update, :destroy]
+
+      ...
+
+      private
+
+      def find_book
+        @book = Book.find(params[:id])
+      end
+    end
+
+But what if I manually change the id in the url to one which is invalid
+
+    http://bestsite.com/books/just a super book/edit
+
+Then this url considered to be invalid and hence user should see 404 page ("Page not found")
+In this case you could do the next
+  
+    class BooksController < ApplicationController
+      before_filter :find_book, :only => [:show, :edit, :update, :destroy]
+
+      ...
+
+      private
+
+      def page_not_found
+        render 'public/404', status: 404
+      end
+
+      def find_book
+        @book = Book.find_by_id(params[:id])
+        @book || page_not_found
+      end
+    end
+
+But this meens you should do this in every <code>before_filter</code> where you find a resource by id which comes as a part of url.
+As alternative you could use <code>before_or_404</code> instead of <code>before_filter</code>.
+
+== Usage Example
+
+    class UsersController < ApplicationController
+      before_or_404 :find_user, only: [:show, :edit, :destroy]
+
+      ...
+
+      private
+
+      def find_user
+        @user = User.find(params[:id])
+      end
+
+    end
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (<code>git checkout -b my-new-feature</code>)
+3. Commit your changes (<code>git commit -am 'Added some feature'</code>)
+4. Push to the branch (<code>git push origin my-new-feature</code>)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/before_or_404.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'before_or_404/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "before_or_404"
+  gem.version       = BeforeOr404::VERSION
+  gem.authors       = ["Eugene Korpan"]
+  gem.email         = ["korpan.eugene@gmail.com"]
+  gem.description   = %q{adds before_filter which renders 404 page if exception was raised}
+  gem.summary       = %q{adds before_filter which renders 404 page if exception was raised}
+  gem.homepage      = "https://github.com/eugenekorpan/before_or_404"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/before_or_404.rb

@@ -0,0 +1,3 @@
+require 'before_or_404/version'
+require 'before_or_404/filter_wrapper'
+require 'before_or_404/action_controller_extensions'

data/lib/before_or_404/action_controller_extensions.rb

@@ -0,0 +1,27 @@
+module ActionControllerExtensions
+  def before_or_404(*names, &blk)
+    _insert_callbacks(names, blk) do |name, options|
+      set_callback :process_action, :before, wrapper_for(name).method, options
+    end
+  end
+
+  def prepend_before_or_404(*names, &blk)
+    _insert_callbacks(names, blk) do |name, options|
+      set_callback(:process_action, :before, wrapper_for(name).method, options.merge(:prepend => true))
+    end
+  end
+
+  def skip_before_or_404(*names, &blk)
+    _insert_callbacks(names, blk) do |name, options|
+      skip_callback(:process_action, :before, wrapper_for(name).method, options)
+    end
+  end
+
+  private
+
+  def wrapper_for(name)
+    BeforeOr404::FilterWrapper.new(name, self)
+  end
+end
+
+ActionController::Base.send :extend, ActionControllerExtensions

data/lib/before_or_404/filter_wrapper.rb

@@ -0,0 +1,29 @@
+module BeforeOr404
+  class FilterWrapper
+    def initialize(original_method, klass)
+      @original_method = original_method
+      @klass         = klass
+      @wrapped       = false
+      wrap!
+    end
+
+    def method
+      @name ||= :"before_or_404_#{Time.now.to_i}_#{@original_method}"
+    end
+
+    def wrap!
+      return @wrapped if @wrapped
+
+      @klass.class_eval %Q{
+        def #{method}
+          begin
+        #{@original_method}
+          rescue
+            render 'public/404', status: 404
+          end
+        end
+      }
+      @wrapped = true
+    end
+  end
+end

data/lib/before_or_404/version.rb

@@ -0,0 +1,3 @@
+module BeforeOr404
+  VERSION = '0.0.1'
+end

data/spec/lib/action_controller_extensions_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe ActionController::Base do
+  subject { ActionController::Base }
+
+  it { should respond_to(:before_or_404)}
+  it { should respond_to(:prepend_before_or_404)}
+  it { should respond_to(:skip_before_or_404)}
+
+end

data/spec/lib/filter_wrapper_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe BeforeOr404::FilterWrapper do
+  let(:acb) { ActionController::Base }
+
+  subject { BeforeOr404::FilterWrapper.new(:find_user, acb) }
+
+  context '#method' do
+    it 'should generate name' do
+      expect(subject.method).to be
+      expect(subject.method).to_not be_blank
+    end
+
+    it 'should generate only one name for single instance' do
+      expect(subject.method).to eql(subject.method)
+    end
+
+    it 'should generate uniq names for different instances' do
+      find = BeforeOr404::FilterWrapper.new(:find, acb)
+      fetch = BeforeOr404::FilterWrapper.new(:fetch, acb)
+      expect(find.method).to_not eql(fetch.method)
+    end
+  end
+
+  context '#wrap!' do
+    it 'should add wrapped method' do
+      subject.wrap!
+      expect(acb.instance_methods).to include(subject.method)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'action_controller'
+require 'before_or_404'
+require 'before_or_404/action_controller_extensions'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: before_or_404
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eugene Korpan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies: []
+description: adds before_filter which renders 404 page if exception was raised
+email:
+- korpan.eugene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- before_or_404.gemspec
+- lib/before_or_404.rb
+- lib/before_or_404/action_controller_extensions.rb
+- lib/before_or_404/filter_wrapper.rb
+- lib/before_or_404/version.rb
+- spec/lib/action_controller_extensions_spec.rb
+- spec/lib/filter_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/eugenekorpan/before_or_404
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: adds before_filter which renders 404 page if exception was raised
+test_files:
+- spec/lib/action_controller_extensions_spec.rb
+- spec/lib/filter_wrapper_spec.rb
+- spec/spec_helper.rb