rails5_before_render 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e53f2f676804a737714ddcfd953d653bf8b57af2
+  data.tar.gz: ac9bcb6870d6e86c5d0bbf4203850bc3b05f670b
+SHA512:
+  metadata.gz: 4acb4385e10fdccb4e520d32054dccdc116f9f964d86e9d8fdf9480be0884b9d0b6adbf5548fdc28ae25f53cf65d11d28d6399f76a1eb92b08cfbf76fa2b2df8
+  data.tar.gz: b20f37bb4c9241d60044cbe1c9434f4136cf4b004afeefad08d9125d97fb083bf1ed65bc96d6011ae4396c991756fd169ce92d758d1357b66b3fad9d0ff29b66

data/.gitignore

@@ -0,0 +1,89 @@
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+/node_modules
+/yarn-error.log
+
+.byebug_history
+
+# We need to use structure.sql, so ignore schema.rb
+/db/schema.rb
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### RubyMine ###
+
+.idea/
+
+# CMake
+cmake-build-debug/
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Ruby plugin and RubyMine
+/.rakeTasks
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### Emacs ###
+*~
+\#*\#
+*.elc
+auto-save-list
+.\#*

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

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,53 @@
+Before Render  
+===========================
+
+## 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 heavily based on Vladimir Penkin's rails3_before_render which in turn
+is based on before_filter for Rails 2 by Todd Willey. 
+
+Provided methods:
+
+- before_render
+- prepend\_before\_render
+- skip\_before\_render
+   
+## Installation       
+  
+    gem 'rails4_before_render'
+  
+Warning: Rails 5 only. 
+ 
+## 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.
+
+## Author
+Copyright (c) 2013 Nilesh Chaudhari, released under the MIT license. Plugin heavily based on
+Vladimir Penkin's rails3_before_render which in turn is based on before_filter for Rails 2 by
+Todd Willey. Updated by Todd Knarr to supersede the outdated version on RubyGems and to depend
+explicitly on Rails 5.x so it won't break with later versions, gem renamed to avoid collision
+with the outdated version.

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 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/before_render.rb

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

data/lib/before_render/before_render.rb

@@ -0,0 +1,42 @@
+require 'action_controller'
+
+module Rails5BeforeRender
+    module BeforeRender
+        extend ActiveSupport::Concern
+        include ActiveSupport::Callbacks
+
+        included do
+            define_callbacks :render,
+                             terminator: ->(controller, result_lambda) { result_lambda.call if result_lambda.is_a?(Proc); controller.performed? },
+                             skip_after_callbacks_if_terminated: true
+        end
+
+        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 :append_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
+
+ActionController::Base.include Rails5BeforeRender::BeforeRender

data/lib/before_render/before_render_instance.rb

@@ -0,0 +1,15 @@
+require 'action_controller'
+
+module Rails5BeforeRender
+    module BeforeRenderInstance
+
+        def render(*args, &blk)
+            run_callbacks :render do
+                super
+            end
+        end
+
+    end
+end
+
+ActionController::Base.prepend Rails5BeforeRender::BeforeRenderInstance

data/lib/before_render/version.rb

@@ -0,0 +1,3 @@
+module BeforeRender
+    VERSION = "0.3.0"
+end

data/rails5_before_render.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/before_render/version', __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.authors       = ["nilesh", "tknarr"]
+    gem.email         = ["mail@nilesh.org", "tknarr@silverglass.org"]
+    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      = "https://github.com/tknarr/before_render"
+
+    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          = "rails5_before_render"
+    gem.require_paths = ["lib"]
+    gem.version       = BeforeRender::VERSION
+    gem.licenses      = ["MIT"]
+
+    gem.add_dependency 'rails', '~> 5.0'
+
+    gem.add_development_dependency "bundler", "~> 1.16"
+    gem.add_development_dependency "rake", "~> 12.3"
+    gem.add_development_dependency "minitest", "~> 5.0"
+end

data/test/before_render_controller_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class SampleController < ActionController::Base
+    before_action :action_one
+    after_action :action_three
+    if ActionController::Base.respond_to?(:before_render)
+        before_render :action_two_a, :except => [:new]
+    end
+    if ActionController::Base.respond_to?(:skip_before_render)
+        skip_before_render :action_two_a, :only => [:show]
+    end
+    if ActionController::Base.respond_to?(:prepend_before_render)
+        prepend_before_render :action_two_b, :only => [:update]
+    end
+
+    attr_accessor :actions
+
+    def index;  render :plain => 'index'; end
+    def new;    render :plain => 'new'; end
+    def show;   render :plain => 'show'; end
+    def update; render :plain => 'update'; end
+
+    def reset_actions
+        @actions = ''
+    end
+
+    private
+    def action_one
+        @actions << 'a'
+    end
+    def action_two_a
+        @actions << 'b'
+    end
+    def action_two_b
+        @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
+                get 'sample/index'
+            end
+            process :index
+        end
+        assert_equal 'abc', @controller.actions
+    end
+
+    def test_before_render_except_option
+        with_routing do |set|
+            set.draw do
+                get 'sample/new'
+            end
+            process :new
+        end
+        assert_equal 'ac', @controller.actions
+    end
+
+    def test_skip_before_render
+        with_routing do |set|
+            set.draw do
+                get 'sample/show'
+            end
+            process :show
+        end
+        assert_equal 'ac', @controller.actions
+    end
+
+    def test_prepend_before_render
+        with_routing do |update|
+            update.draw do
+                get 'sample/update'
+            end
+            process :update
+        end
+        assert_equal 'aBbc', @controller.actions
+    end
+
+end

data/test/before_render_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class BeforeRenderTest < Minitest::Test
+
+    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/test_helper.rb

@@ -0,0 +1,5 @@
+ENV["RAILS_ENV"] = "test"
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'before_render'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rails5_before_render
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- nilesh
+- tknarr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: provides a before_render method for action_controllers
+email:
+- mail@nilesh.org
+- tknarr@silverglass.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/before_render.rb
+- lib/before_render/before_render.rb
+- lib/before_render/before_render_instance.rb
+- lib/before_render/version.rb
+- rails5_before_render.gemspec
+- test/before_render_controller_test.rb
+- test/before_render_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tknarr/before_render
+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.6.12
+signing_key: 
+specification_version: 4
+summary: before_render will be called after your action and before the view is rendered
+test_files:
+- test/before_render_controller_test.rb
+- test/before_render_test.rb
+- test/test_helper.rb