rails3_before_render 0.2.0

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/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.2"

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'activesupport', '>=3.0.0'
+
+group :test do
+  gem 'actionpack', '>=3.0.0'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Vladimir Penkin
+
+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,52 @@
+Rails3 Before Render  [![Build Status](https://secure.travis-ci.org/shell/rails3_before_render.png)](https://secure.travis-ci.org/shell/rails3_before_render.png)
+===========================
+
+## Introduction
+  Add a hook like before_filter to your controllers that gets executed between
+when your action is completed and the template is rendered.  It can really
+DRY up loading some data that is used for views (headers / layouts / etc).
+
+  Plugin was inspired by before_render by Todd Willey, which works for rails2 only. New *ActiveSupport::Callbacks* methods were used, in analogy with ActionDispatch.
+
+Provided methods:
+
+- before_render
+- prepend\_before\_render
+- skip\_before\_render
+   
+## Installation       
+  
+    gem 'rails3_before_render'
+  
+  Warning: Rails 3 only. Rails2 users can use [before_render](<https://github.com/xtoddx/before_render>) by Todd Willey.
+ 
+## Usage
+  before_render / prepend\_before\_render / skip\_before\_render works as other filters. Options like :except and :only can be passed to filter.
+
+    class PostsController < ApplicationController
+      before_render :ping, :except => [:destroy]
+  
+      def index; end     
+  
+      def new; end
+    
+      def show; end
+  
+      def destroy; end                                                                          
+              
+      private
+        def ping
+          Rails.logger.info "Ping-Pong actions"
+        end
+    end       
+       
+  Method ping will be executed after your actions and before template is rendered.
+
+## TODO
+
+- Tests should not throw runtime error(happening right now if comment one of provided aliased methods)
+
+## Author
+Copyright (c) 2011 Vladimir Penkin, released under the MIT license
+
+Thanks to Drake Wilson (@menostos) for initiative to convert this to ruby gem.

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the rails3_before_render plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/rails3_before_render.rb

@@ -0,0 +1,4 @@
+require 'rails3_before_render/version'
+require 'active_support/concern'
+require 'rails3_before_render/before_render'
+require 'rails3_before_render/before_render_instance'

data/lib/rails3_before_render/before_render.rb

@@ -0,0 +1,32 @@
+module Rails3BeforeRender
+  module BeforeRender
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def append_before_render_filter(*names, &blk)
+        _insert_callbacks(names, blk) do |name, options|
+          set_callback(:render, :before, name, options)
+        end
+      end
+
+     def prepend_before_render_filter(*names, &blk)
+       _insert_callbacks(names, blk) do |name, options|
+         set_callback(:render, :before, name, options.merge(:prepend => true))
+       end
+     end
+
+     def skip_before_render_filter(*names, &blk)
+       _insert_callbacks(names, blk) do |name, options|
+         skip_callback(:render, :before, name, options)
+       end
+     end
+
+    alias_method :before_render, :append_before_render_filter
+    alias_method :prepend_before_render, :prepend_before_render_filter
+    alias_method :skip_before_render, :skip_before_render_filter
+   end
+
+  end
+end
+
+AbstractController::Base.send :include,  Rails3BeforeRender::BeforeRender

data/lib/rails3_before_render/before_render_instance.rb

@@ -0,0 +1,19 @@
+module Rails3BeforeRender
+  module BeforeRenderInstance
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :render, :before_render_filter
+      define_callbacks :render
+    end
+
+    def render_with_before_render_filter *opts, &blk
+      run_callbacks :render, action_name do
+        render_without_before_render_filter(*opts, &blk)
+      end
+    end
+
+  end
+end
+
+ActionController::Base.send :include,  Rails3BeforeRender::BeforeRenderInstance

data/lib/rails3_before_render/version.rb

@@ -0,0 +1,3 @@
+module Rails3BeforeRender
+  VERSION = "0.2.0"
+end

data/rails3_before_render.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails3_before_render/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["shell"]
+  gem.email         = ["shell"]
+  gem.description   = %q{provides a before_render method for action_controllers}
+  gem.summary       = %q{before_render will be called after your action and before the view is rendered}
+  gem.homepage      = ""
+
+  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.name          = "rails3_before_render"
+  gem.require_paths = ["lib"]
+  gem.version       = Rails3BeforeRender::VERSION
+end

data/test/before_render_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class BeforeRenderTest < Test::Unit::TestCase
+
+  def test_before_render 
+    assert ActionController::Base.respond_to?(:before_render)
+  end                                          
+
+  def test_skip_before_render 
+    assert ActionController::Base.respond_to?(:skip_before_render)
+  end                                          
+       
+  def test_prepend_before_render 
+    assert ActionController::Base.respond_to?(:prepend_before_render)
+  end                                          
+            
+end

data/test/rails3_before_render_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class SampleController < ActionController::Base   
+  before_filter :action_one
+  after_filter :action_three
+  before_render :action_two, :except => [:new]
+  skip_before_render :action_two, :only => [:show]
+  
+  attr_accessor :actions
+  
+  def index; render :text => ''; end            
+  def new;   render :text => ''; end            
+  def show;  render :text => ''; end
+  
+  def reset_actions    
+    @actions = ''
+  end    
+  
+  private         
+  def action_one
+    @actions << 'a'
+  end
+  def action_two
+    @actions << 'b'    
+  end
+  def action_three
+    @actions << 'c'    
+  end
+end
+
+class SampleControllerTest < ActionController::TestCase
+  setup do 
+    @request.env['REQUEST_METHOD'] = 'GET'
+    @request.action = 'index'
+    
+    @controller.reset_actions
+  end
+
+  def test_before_render_in_place
+    with_routing do |set|
+      set.draw do 
+        match ':controller(/:action)'
+      end
+      process :index
+    end
+    assert_equal @controller.actions, 'abc'
+  end 
+  
+  def test_before_render_except_option
+    with_routing do |set|
+      set.draw do 
+        match ':controller(/:action)'
+      end
+      process :new
+    end
+    assert_equal @controller.actions, 'ac'
+  end   
+  
+  def test_skip_before_render
+    with_routing do |set|
+      set.draw do 
+        match ':controller(/:action)'
+      end
+      process :show
+    end
+    assert_equal @controller.actions, 'ac'    
+  end     
+  
+end  

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+
+require 'test/unit'
+require 'active_support'
+
+ENV["RAILS_ENV"] = "test"
+require 'action_pack'
+require 'action_controller'
+require File.expand_path('../../lib/rails3_before_render', __FILE__)

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rails3_before_render
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- shell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies: []
+description: provides a before_render method for action_controllers
+email:
+- shell
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails3_before_render.rb
+- lib/rails3_before_render/before_render.rb
+- lib/rails3_before_render/before_render_instance.rb
+- lib/rails3_before_render/version.rb
+- rails3_before_render.gemspec
+- test/before_render_test.rb
+- test/rails3_before_render_test.rb
+- test/test_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: before_render will be called after your action and before the view is rendered
+test_files:
+- test/before_render_test.rb
+- test/rails3_before_render_test.rb
+- test/test_helper.rb