rails-render_hooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1091d4e28aa999c15e246d30b20c154d90232d94
+  data.tar.gz: 7368ed7dda9cb22b97133232ccc0dd064b6fce66
+SHA512:
+  metadata.gz: d42637eea5e9d116ca0e74a1b383dad26097f6b2cd387f17a7c7640887ec23f27bab415df56ef198087412c20cb30f62d4232fb0a3964b6ebdf2be766c84953d
+  data.tar.gz: 14741159673abd8b59f8f4812e5f32567ef40b5e52b83ed317c6f60c171b09b3c2d06b2d5c4551cdffce8dff65293f171356652a4f043f68f4bc760c6efb78fc

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1.2
+gemfile:
+  - gemfiles/rails_3_2_x.gemfile
+  - gemfiles/rails_4_0_x.gemfile
+  - gemfiles/rails_4_1_x.gemfile

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-render_hooks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 pinzolo
+
+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.md

@@ -0,0 +1,65 @@
+# rails-render_hooks
+
+[![Build Status](https://secure.travis-ci.org/pinzolo/rails-render_hooks.png)](http://travis-ci.org/pinzolo/rails-render_hooks)
+[![Coverage Status](https://coveralls.io/repos/pinzolo/rails-render_hooks/badge.png)](https://coveralls.io/r/pinzolo/rails-render_hooks)
+
+This gem provides new callbacks to your controller (on RoR).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-render_hooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-render_hooks
+
+## Hooks
+
+* before_render
+* prepend_before_render
+* skip_before_render
+* after_render
+* prepend_after_render
+* skip_after_render
+* around_render
+* prepend_around_render
+* skip_around_render
+
+## Ordering of hooks
+
+1. before_action (before_filter)
+1. around_action (around_filter)
+1. prepend_around_render
+1. prepend_before_render
+1. before_render
+1. around_render
+1. rendering
+1. around_render
+1. after_render
+1. prepend_after_render
+1. prepend_around_render
+1. around_action (around_filter)
+1. after_action (after_filter)
+
+## Supported versions
+
+* Ruby: 1.9.3, 2.0.0, 2.1.2
+* Rails: 3.2.x, 4.0.x, 4.1.x
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails-render_hooks/fork )
+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 a new Pull Request
+
+## Changelog
+
+* v1.0.0 (2014-06-10 JST): First release

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the 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/gemfiles/rails_3_2_x.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~>3.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4_0_x.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~>4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4_1_x.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "activesupport", "~>4.1.0"
+
+gemspec :path => "../"
+

data/lib/rails/render_hooks/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module RenderHooks
+    VERSION = "1.0.0"
+  end
+end

data/lib/rails/render_hooks.rb

@@ -0,0 +1,49 @@
+require "rails/render_hooks/version"
+require "active_support/concern"
+require "action_controller"
+
+module RenderHooks
+  extend ActiveSupport::Concern
+
+  included do
+    define_callbacks :process_render
+    alias_method_chain :render, :render_hooks
+  end
+
+  def render_with_render_hooks(*options, &block)
+    if ActiveSupport::VERSION::STRING >= '4.0.0'
+      run_callbacks(:process_render) do
+        render_without_render_hooks(*options, &block)
+      end
+    else
+      run_callbacks(:process_render, action_name) do
+        render_without_render_hooks(*options, &block)
+      end
+    end
+  end
+
+  module ClassMethods
+    [:before, :after, :around].each do |callback|
+      define_method "#{callback}_render" do |*names, &block|
+        _insert_callbacks(names, block) do |name, options|
+          set_callback(:process_render, callback, name, options)
+        end
+      end
+      alias_method :"append_#{callback}_render", :"#{callback}_render"
+
+      define_method "prepend_#{callback}_render" do |*names, &block|
+        _insert_callbacks(names, block) do |name, options|
+          set_callback(:process_render, callback, name, options.merge(:prepend => true))
+        end
+      end
+
+      define_method "skip_#{callback}_render" do |*names, &block|
+        _insert_callbacks(names, block) do |name, options|
+          skip_callback(:process_render, callback, name, options)
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.__send__(:include, RenderHooks)

data/rails-render_hooks.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/render_hooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-render_hooks"
+  spec.version       = Rails::RenderHooks::VERSION
+  spec.authors       = ["pinzolo"]
+  spec.email         = ["pinzolo@gmail.com"]
+  spec.summary       = %q{Add callbacks for render method}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/pinzolo/rails-render_hooks"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "actionpack", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "coveralls"
+end

data/test/render_hooks_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+
+class SampleController < ActionController::Base
+  include RenderHooks
+
+  before_filter :exec_before_action
+  after_filter :exec_after_action
+  around_filter :exec_around_action
+  prepend_before_render :exec_prepend_before_render
+  before_render :exec_before_render, except: [:new]
+  skip_before_render :exec_before_render, only: [:show]
+  prepend_after_render :exec_prepend_after_render
+  after_render :exec_after_render, except: [:new]
+  skip_after_render :exec_after_render, only: [:show]
+  prepend_around_render :exec_prepend_around_render
+  around_render :exec_around_render, except: [:new]
+  skip_around_render :exec_around_render, only: [:show]
+
+  attr_accessor :footmarks
+
+  [:index, :new, :show].each do |action|
+    define_method(action) { render text: '' }
+  end
+
+  def reset
+    @footmarks = []
+  end
+
+  private
+  [:action, :render].each do |type|
+    [:before, :after].each do |callback|
+      define_method(:"exec_#{callback}_#{type}") do
+        @footmarks << "exec_#{callback}_#{type}"
+      end
+      define_method(:"exec_prepend_#{callback}_#{type}") do
+        @footmarks << "exec_prepend_#{callback}_#{type}"
+      end
+    end
+  end
+
+  def exec_around_action
+    @footmarks << "exec_around_action_1"
+    yield
+    @footmarks << "exec_around_action_2"
+  end
+
+  def exec_around_render
+    @footmarks << "exec_around_render_1"
+    yield
+    @footmarks << "exec_around_render_2"
+  end
+
+  def exec_prepend_around_render
+    @footmarks << "exec_prepend_around_render_1"
+    yield
+    @footmarks << "exec_prepend_around_render_2"
+  end
+end
+
+class SampleControllerTest < ActionController::TestCase
+  setup do
+    @controller.reset
+  end
+
+  def test_in_place
+    exec_action(:index)
+    assert_equal @controller.footmarks, ["exec_before_action",
+                                         "exec_around_action_1",
+                                         "exec_prepend_around_render_1",
+                                         "exec_prepend_before_render",
+                                         "exec_before_render",
+                                         "exec_around_render_1",
+                                         "exec_around_render_2",
+                                         "exec_after_render",
+                                         "exec_prepend_after_render",
+                                         "exec_prepend_around_render_2",
+                                         "exec_around_action_2",
+                                         "exec_after_action"]
+  end
+
+  def test_with_except_option
+    exec_action(:new)
+    assert_equal @controller.footmarks, ["exec_before_action",
+                                         "exec_around_action_1",
+                                         "exec_prepend_around_render_1",
+                                         "exec_prepend_before_render",
+                                         "exec_prepend_after_render",
+                                         "exec_prepend_around_render_2",
+                                         "exec_around_action_2",
+                                         "exec_after_action"]
+  end
+
+  def test_skip
+    exec_action(:show)
+    assert_equal @controller.footmarks, ["exec_before_action",
+                                         "exec_around_action_1",
+                                         "exec_prepend_around_render_1",
+                                         "exec_prepend_before_render",
+                                         "exec_prepend_after_render",
+                                         "exec_prepend_around_render_2",
+                                         "exec_around_action_2",
+                                         "exec_after_action"]
+  end
+  private
+
+  def exec_action(action)
+    with_routing do |set|
+      set.draw do
+        get ':controller(/:action)'
+      end
+      process action
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "coveralls"
+require "simplecov"
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/bundle/'
+end
+
+require "active_support/version"
+if ActiveSupport::VERSION::STRING >= '4.1.0'
+  require 'minitest'
+  require 'minitest/autorun'
+else
+  require 'test/unit'
+end
+
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path('../../lib/rails/render_hooks', __FILE__)
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rails-render_hooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pinzolo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add callbacks for render method
+email:
+- pinzolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3_2_x.gemfile
+- gemfiles/rails_4_0_x.gemfile
+- gemfiles/rails_4_1_x.gemfile
+- lib/rails/render_hooks.rb
+- lib/rails/render_hooks/version.rb
+- rails-render_hooks.gemspec
+- test/render_hooks_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pinzolo/rails-render_hooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Add callbacks for render method
+test_files:
+- test/render_hooks_test.rb
+- test/test_helper.rb