before_render 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tim.teng
+
+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,17 @@
+= before_render
+
+  please reference http://github.com/xtoddx/before_render
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tim.teng. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "before_render"
+    gem.summary = %Q{a gem for before_render plugin}
+    gem.description = %Q{original source: http://github.com/xtoddx/before_render }
+    gem.email = "tim.rubist@gmail.com"
+    gem.homepage = "http://github.com/tteng/before_render"
+    gem.authors = ["tim.teng"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "before_render #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/before_render.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{before_render}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["tim.teng"]
+  s.date = %q{2010-03-26}
+  s.description = %q{original source: http://github.com/xtoddx/before_render }
+  s.email = %q{tim.rubist@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "before_render.gemspec",
+     "lib/action_controller/filters/before_render_filter.rb",
+     "lib/before_render.rb",
+     "lib/before_render_instance.rb",
+     "lib/filter_chain_has_many_types_of_filters.rb",
+     "lib/filter_has_before_render.rb",
+     "test/helper.rb",
+     "test/test_before_render.rb"
+  ]
+  s.homepage = %q{http://github.com/tteng/before_render}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{a gem for before_render plugin}
+  s.test_files = [
+    "test/test_before_render.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/action_controller/filters/before_render_filter.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# 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.
+
+class ActionController::Filters::BeforeRenderFilter < ActionController::Filters::Filter
+  def type
+    :before_render
+  end
+
+  def before_render?
+    true
+  end
+end

data/lib/before_render.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# 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.
+
+##
+#
+# BeforeRender provides a callback chain that runs in the time between when the
+# controller method completes and the render method is invoked.  It can be used
+# to prepare variables for common view options (headers/footers/sidebars) in
+# a DRY manner.
+#
+module BeforeRender
+
+  ##
+  # Adding filters to this will run them after the controller action completes
+  # and before the view logic is invoked.
+  #
+  # This is the same sort of call chain as after filter, but after_filter runs
+  # after the view is complete as well, whereas this runs before the rendering
+  # but after the controller logic.
+  #
+  def append_before_render_filter *filters, &block
+    filter_chain.append_filter_to_chain(filters, :before_render, &block)
+  end
+
+  def prepend_before_render_filter *filters, &block
+    filter_chain.prepend_filter_to_chain(filters, :before_render, &block)
+  end
+
+  alias :before_render_filter :append_before_render_filter
+  alias :before_render :append_before_render_filter
+
+  def skip_before_render_filter *filters
+    filter_chain.skip_filter_in_chain(*filters, &:before_render?)
+  end
+
+  def before_render_filters
+    filter_chain.select(&:before_render?).map(&:method)
+  end
+
+end
+
+ActionController::Filters::Filter.send :include, FilterHasBeforeRender
+ActionController::Base.send :extend, BeforeRender
+ActionController::Base.send :include, BeforeRenderInstance
+ActionController::Filters::FilterChain.send :include, FilterChainHasManyTypesOfFilters

data/lib/before_render_instance.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# 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.
+
+##
+# These methods get mixed into instances of ActionController::Base (by init.rb)
+#
+module BeforeRenderInstance
+  def self.included kls
+    kls.send :alias_method_chain, :render, :before_render_filter
+  end
+
+  ##
+  # This rewrites the vanilla render() call to run all callbacks registered
+  # with before_render method before actually rendering.
+  #
+  def render_with_before_render_filter *opts, &blk
+    run_before_render_filters
+    rv = render_without_before_render_filter(*opts, &blk)
+    return rv
+  end
+
+  private
+  def run_before_render_filters chain=self.class.filter_chain
+    chain.select{|x| x.is_a?(ActionController::Filters::BeforeRenderFilter)}.each do |filter|
+      filter.call(self)
+    end
+  end
+
+end

data/lib/filter_chain_has_many_types_of_filters.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# 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.
+
+module FilterChainHasManyTypesOfFilters
+
+  def self.included kls
+    kls.send :alias_method, :find_filter_append_position, :find_filter_append_positions_multitype
+    kls.send :alias_method, :find_filter_prepend_position, :find_filter_prepend_positions_multitype
+    kls.send :alias_method, :find_or_create_filter, :find_or_create_filter_multitype
+
+    kls.send :cattr_accessor, :filter_order
+    kls.filter_order = [
+      :before,
+      :around,
+      :before_render,
+      :after
+    ]
+  end
+
+  private
+  def map_filter_types_to_positions
+    returning({}) do |rv|
+      self.class.filter_order.each_with_index do |filter, idx|
+        rv[filter] = idx
+      end
+    end
+  end
+
+  def find_filter_append_positions_multitype filters, filter_type
+    positions = map_filter_types_to_positions
+    i = 0
+    pos = positions[filter_type]
+
+    # shortcut the last type
+    return -1 if (pos + 1) >= self.class.filter_order.length
+
+    while self[i] and p2=positions[self[i].type] and p2 <= pos
+      i += 1
+    end
+    i
+  end
+
+  def find_filter_prepend_positions_multitype filters, filter_type
+    positions = map_filter_types_to_positions
+    i = 0
+    pos = positions[filter_type]
+
+    # shortcut the first type
+    return 0 if pos == 0
+
+    while self[i] and p2=positions[self[i].type] and p2 < pos
+      i += 1
+    end
+    i
+  end
+
+  def find_or_create_filter_multitype filter, filter_type, options={}
+    update_filter_in_chain([filter], options)
+    rv = find(filter){|f| f.type == filter_type}
+    rv ||= filter_class(filter_type).new(filter_type, filter, options)
+    rv
+  end
+
+  def filter_class filter_type
+    "ActionController::Filters::#{filter_type.to_s.camelize}Filter".constantize
+  rescue
+    raise "Invalid filter class: ActionController::Filters::#{filter_type.to_s.camelize}Filter"
+  end
+end

data/lib/filter_has_before_render.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2009 Todd Willey <todd@rubidine.com>
+# 
+# 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.
+
+module FilterHasBeforeRender
+  ##
+  # Add default behavior to be overwritten in subclass
+  #
+  def before_render?
+    false
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'before_render'
+
+class Test::Unit::TestCase
+end

data/test/test_before_render.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBeforeRender < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: before_render
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- tim.teng
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "original source: http://github.com/xtoddx/before_render "
+email: tim.rubist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- before_render.gemspec
+- lib/action_controller/filters/before_render_filter.rb
+- lib/before_render.rb
+- lib/before_render_instance.rb
+- lib/filter_chain_has_many_types_of_filters.rb
+- lib/filter_has_before_render.rb
+- test/helper.rb
+- test/test_before_render.rb
+has_rdoc: true
+homepage: http://github.com/tteng/before_render
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: a gem for before_render plugin
+test_files: 
+- test/test_before_render.rb
+- test/helper.rb