ninja-decorators 0.6.0

data/.gitignore

@@ -0,0 +1,7 @@
+.idea
+*.iws
+*.iml
+*.ipr
+pkg
+coverage
+rdoc

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-11-21
+
+* 1 major enhancement:
+  * Initial release - around filters only

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/ninja_decorators.rb
+test/test_helper.rb
+test/test_ninja_decorators.rb
+test/ninja_class.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+For more information on ninja_decorators, see http://github.com/haruska/ninja-decorators
+
+

data/README.rdoc

@@ -0,0 +1,89 @@
+= ninja_decorators
+
+http://github.com/haruska/ninja-decorators
+
+== DESCRIPTION:
+
+Implements before_filter, after_filter, and around_filter decorators
+similar to Rails but can be used anywhere
+
+== FEATURES/PROBLEMS:
+
+Currently, only around_filter is implemented. Also, need to change
+syntax to :only and :except filters similar to Rails
+
+== SYNOPSIS:
+
+Similar to Rails, the following will execute the method common_around around
+both the foo and bar methods:
+
+require 'rubygems'
+require 'ninja_decorators'
+
+class NinjaClass
+  include NinjaDecorators
+
+  attr_accessor :ret
+
+  around_filter :common_around, [:foo, :bar]
+
+  def foo
+    @ret += "foo"
+  end
+
+  def bar
+    @ret += "bar"
+  end
+
+  private
+
+  def common_around
+    @ret = "common "
+    yield
+    @ret += " around"
+  end
+end
+
+produces
+
+irb(main):076:0> n = NinjaClass.new
+=> #
+irb(main):077:0> n.bar
+=> "common bar around"
+irb(main):078:0> n.foo
+=> "common foo around"
+
+
+== REQUIREMENTS:
+
+rubygems
+
+== INSTALL:
+
+sudo gem install haruska-ninja-decorators
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008-2009 Jason Haruska, Kevin Menard
+Portions Copyright (c) 2005-2009 David Heinemeier Hansson
+
+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/Rakefile

@@ -0,0 +1,54 @@
+require 'rake'
+require 'rake/gempackagetask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ninja-decorators"
+    gemspec.summary = "before_filter, after_filter, and around_filter for ruby without rails"
+    gemspec.email = "contact@haruska.com"
+    gemspec.homepage = "http://github.com/haruska/ninja-decorators/"
+    gemspec.authors = ["Jason Haruska", "Kevin Menard"]    
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "blah #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 6
+:patch: 0

data/lib/ninja_decorators.rb

@@ -0,0 +1,112 @@
+require "rubygems"
+
+module NinjaDecorators
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def delayed_alias_method_chains
+      @delayed_alias_method_chains ||= {}
+    end
+  
+    def method_added(meth)
+      if delayed_alias_method_chains[meth.to_s]
+        chains_arr = delayed_alias_method_chains.delete(meth.to_s)
+        chains_arr.each do |chain|
+          chain.each_pair do |filter_type, filtered_method_builder|
+            ninja_method_chain meth, filter_type, &filtered_method_builder
+          end
+        end
+      end
+    end
+
+    def around_filter(around_method, method_names)
+      filter_factory(around_method, method_names, :around)
+    end
+
+    def before_filter(before_method, method_names)
+      filter_factory(before_method, method_names, :before)
+    end
+
+    def after_filter(after_method, method_names)
+      filter_factory(after_method, method_names, :after)
+    end
+
+    def filter_factory(filter_method, method_names, filter_type)
+      method_names.each do |meth|
+
+        # Build up a proc that will construct the filtered method.  Execution of the proc is delayed
+        # until we encounter the alias_method_chain call.
+        filtered_method_builder = Proc.new do
+          # Get a reference to the unfiltered method or, more accurately, the original method with
+          # all previous filters already applied.  This new filtered method builds up on the filters
+          # already applied.
+          unfiltered_method = instance_method "#{meth}_without_#{filter_type.to_s}_filter_wrapper"
+
+          # Define the newly filtered method.
+          case filter_type
+            when :before
+              define_method("#{meth}_with_before_filter_wrapper") do |*args|
+                send(filter_method, *args)
+                unfiltered_method.bind(self).call(*args)
+              end
+
+            when :around
+              define_method("#{meth}_with_around_filter_wrapper") do |*args|
+                send(filter_method, *args) do |*ar_args|
+                  unfiltered_method.bind(self).call(*ar_args)
+                end
+              end
+
+            when :after
+              define_method("#{meth}_with_after_filter_wrapper") do |*args|
+                unfiltered_method.bind(self).call(*args)
+                send(filter_method, *args)
+              end
+          end
+        end
+
+        # If the method to filter has been defined already.
+        if self.instance_methods.include?(meth.to_s)
+
+          # Filter the method with before_method.
+          ninja_method_chain meth, "#{filter_type.to_s}_filter_wrapper", &filtered_method_builder
+
+        # If the method to filter has not been defined already, delay wrapping until it has.
+        else
+          delayed_alias_method_chains[meth.to_s] ||= []
+          delayed_alias_method_chains[meth.to_s] << {"#{filter_type.to_s}_filter_wrapper" => filtered_method_builder}
+        end
+      end
+    end
+
+    # This was largely lifted from ActiveSupport's alias_method_chain.  We needed to be able to yield to a block
+    # that could construct the with_* methods while having access to the aliased without_* methods.
+    def ninja_method_chain(target, feature)
+      # Strip out punctuation on predicates or bang methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+
+      with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
+
+      alias_method without_method, target
+
+      yield if block_given?
+
+      alias_method target, with_method
+
+      case
+      when public_method_defined?(without_method)
+        public target
+      when protected_method_defined?(without_method)
+        protected target
+      when private_method_defined?(without_method)
+        private target
+      end
+    end
+
+  end
+  
+end

data/ninja-decorators.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ninja-decorators}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Haruska", "Kevin Menard"]
+  s.date = %q{2009-05-27}
+  s.email = %q{contact@haruska.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "Manifest.txt",
+     "PostInstall.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/ninja_decorators.rb",
+     "ninja-decorators.gemspec",
+     "test/after_ninja_subject.rb",
+     "test/around_ninja_subject.rb",
+     "test/before_ninja_subject.rb",
+     "test/ninja_decorators_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/haruska/ninja-decorators/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{before_filter, after_filter, and around_filter for ruby without rails}
+  s.test_files = [
+    "test/after_ninja_subject.rb",
+     "test/around_ninja_subject.rb",
+     "test/before_ninja_subject.rb",
+     "test/ninja_decorators_test.rb",
+     "test/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/test/after_ninja_subject.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../lib/ninja_decorators'
+
+class AfterNinjaSubject
+  include NinjaDecorators
+
+  after_filter :common_before, [:foo, :bar, :nested]
+  after_filter :nested_before, [:nested]
+
+  attr_accessor :ret
+
+  def initialize
+    @ret = ""
+  end
+
+  def foo
+    @ret += "foo"
+  end
+
+  def bar
+    @ret += "bar"
+  end
+
+  def nested
+    @ret += "nested"
+  end
+
+  private
+
+  def common_before
+    @ret += "common "
+    yield if block_given?
+    @ret += " around"
+  end
+
+  def nested_before
+    @ret += "nesting "
+    yield if block_given?
+    @ret += " completed"
+  end
+end

data/test/around_ninja_subject.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../lib/ninja_decorators'
+
+class AroundNinjaSubject
+  include NinjaDecorators
+
+  around_filter :common_around, [:foo, :bar, :nested]
+  around_filter :nested_around, [:nested]
+
+  attr_accessor :ret
+
+  def initialize
+    @ret = ""
+  end
+  
+  def foo
+    @ret += "foo"
+  end
+  
+  def bar
+    @ret += "bar"
+  end
+  
+  def nested
+    @ret += "nested"
+  end
+  
+  private
+  
+  def common_around
+    @ret += "common "
+    yield
+    @ret += " around"
+  end
+  
+  def nested_around
+    @ret += "nesting "
+    yield
+    @ret += " completed"
+  end
+end

data/test/before_ninja_subject.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../lib/ninja_decorators'
+
+class BeforeNinjaSubject
+  include NinjaDecorators
+
+  before_filter :common_before, [:foo, :bar, :nested]
+  before_filter :nested_before, [:nested]
+
+  attr_accessor :ret
+
+  def initialize
+    @ret = ""
+  end
+
+  def foo
+    @ret += "foo"
+  end
+
+  def bar
+    @ret += "bar"
+  end
+
+  def nested
+    @ret += "nested"
+  end
+
+  private
+
+  def common_before
+    @ret += "common "
+    yield if block_given?
+    @ret += " around"
+  end
+
+  def nested_before
+    @ret += "nesting "
+    yield if block_given?
+    @ret += " completed"
+  end
+end

data/test/ninja_decorators_test.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'around_ninja_subject'
+require 'before_ninja_subject'
+require 'after_ninja_subject'
+
+class TestNinjaDecorators < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_simple_around_filter
+    ninja = AroundNinjaSubject.new
+    assert_equal "common foo around", ninja.foo
+    ninja.ret = ""
+    assert_equal "common bar around", ninja.bar
+  end
+  
+  def test_nested_around_filter
+    ninja = AroundNinjaSubject.new
+    assert_equal "nesting common nested around completed", ninja.nested
+  end
+
+  def test_simple_before_filter
+    ninja = BeforeNinjaSubject.new
+    assert_equal "common  aroundfoo", ninja.foo
+    ninja.ret = ""
+    assert_equal "common  aroundbar", ninja.bar
+  end
+
+  def test_nested_before_filter
+    ninja = BeforeNinjaSubject.new
+    assert_equal "nesting  completedcommon  aroundnested", ninja.nested
+  end
+
+  def test_simple_after_filter
+    ninja = AfterNinjaSubject.new
+    assert_equal "foocommon  around", ninja.foo
+    ninja.ret = ""
+    assert_equal "barcommon  around", ninja.bar
+  end
+
+  def test_nested_after_filter
+    ninja = AfterNinjaSubject.new
+    assert_equal "nestedcommon  aroundnesting  completed", ninja.nested
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ninja_decorators'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ninja-decorators
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Jason Haruska
+- Kevin Menard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-27 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: contact@haruska.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/ninja_decorators.rb
+- ninja-decorators.gemspec
+- test/after_ninja_subject.rb
+- test/around_ninja_subject.rb
+- test/before_ninja_subject.rb
+- test/ninja_decorators_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/haruska/ninja-decorators/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: before_filter, after_filter, and around_filter for ruby without rails
+test_files: 
+- test/after_ninja_subject.rb
+- test/around_ninja_subject.rb
+- test/before_ninja_subject.rb
+- test/ninja_decorators_test.rb
+- test/test_helper.rb