auser-backcall 0.0.2

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.2 Extended callbacks to external classes
+v0.0.1 Initial release

data/Manifest

@@ -0,0 +1,8 @@
+CHANGELOG
+lib/backcall.rb
+lib/core/proc.rb
+Manifest
+Rakefile
+README
+spec/callback_spec.rb
+spec/spec_helper.rb

data/README

@@ -0,0 +1,77 @@
+= Backcall
+  Ari Lerner
+  CitrusByte
+  http://blog.citrusbyte.com
+
+== DESCRIPTION:
+  
+  * Backcall, Ari Lerner, Citrusbyte (http://blog.citrusbyte.com) - Simply add super lightweight, memory-efficient before and after callbacks.
+
+== Basics
+
+  Simply require backcall
+    require 'backcall'
+  
+  And include callbacks in your classes
+    include Backcall::Callbacks in your class
+    
+  Then you can call before or after on any method, for instance:
+  
+  class TestCallbacks  
+    before :world, :hello
+    after :world, :thanks
+    def hello(caller)
+      string << "hello "
+    end
+    def world
+      string << "world"
+    end
+    def thanks(caller)
+      string << ", thank you"
+    end
+  end
+  
+  TestCallbacks.new.world 
+  => "hello world, thank you"
+  
+  You can write callbacks currently in the following forms:
+  
+  * before :world, :hello, :hi, :you
+  * before :world do 
+      puts "hello "
+    end
+  * before :world, {:hello => "OutsideClass"}
+  * before :world, {:hello => OutsideClass}
+  
+  Note on the last two:
+  If you call the last style with a string, it expects the OutsideClass 
+  If you call the last one, your class with create a method that calls new on the class that you send to it, It will keep 
+
+== INSTALL:
+
+  gem install backcall
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Ari Lerner. CitrusByte
+
+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,14 @@
+require 'rubygems'
+require 'echoe'
+
+task :default => :test
+
+Echoe.new("backcall") do |p|
+  p.author = "Ari Lerner"
+  p.email = "ari.lerner@citrusbyte.com"
+  p.summary = "Add basic memory-efficient before and after callbacks, easily"
+  p.url = "http://blog.citrusbyte.com"
+  p.dependencies = %w(facets)  
+  p.install_message = "For more information, check http://blog.citrusbyte.com\n*** Ari Lerner @ <ari.lerner@citrusbyte.com> ***"
+  p.include_rakefile = true
+end

data/backcall.gemspec

@@ -0,0 +1,47 @@
+
+# Gem::Specification for Backcall-0.0.2
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{backcall}
+  s.version = "0.0.2"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ari Lerner"]
+  s.date = %q{2008-06-12}
+  s.description = %q{Add basic memory-efficient before and after callbacks, easily}
+  s.email = %q{ari.lerner@citrusbyte.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/backcall.rb", "lib/core/proc.rb", "README"]
+  s.files = ["CHANGELOG", "lib/backcall.rb", "lib/core/proc.rb", "Manifest", "Rakefile", "README", "spec/callback_spec.rb", "spec/spec_helper.rb", "backcall.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://blog.citrusbyte.com}
+  s.post_install_message = %q{For more information, check http://blog.citrusbyte.com
+*** Ari Lerner @ <ari.lerner@citrusbyte.com> ***}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Backcall", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{backcall}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{Add basic memory-efficient before and after callbacks, easily}
+
+  s.add_dependency(%q<facets>, [">= 0"])
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'echoe'
+# 
+# task :default => :test
+# 
+# Echoe.new("backcall") do |p|
+#   p.author = "Ari Lerner"
+#   p.email = "ari.lerner@citrusbyte.com"
+#   p.summary = "Add basic memory-efficient before and after callbacks, easily"
+#   p.url = "http://blog.citrusbyte.com"
+#   p.dependencies = %w(facets)  
+#   p.install_message = "For more information, check http://blog.citrusbyte.com\n*** Ari Lerner @ <ari.lerner@citrusbyte.com> ***"
+#   p.include_rakefile = true
+# end

data/lib/backcall.rb

@@ -0,0 +1,134 @@
+=begin rdoc
+Basic callbacks
+=end
+# Require core changes
+Dir[File.join(File.dirname(__FILE__), "core/*")].each {|a| require a }
+
+module Callbacks
+  module ClassMethods
+    def define_callback_module(mod)
+      callbacks << mod
+    end
+    def define_callback_class(cla)
+      classes << cla
+    end
+    def callback(type, m, *args, &block)
+      arr = []                
+      args.each do |arg|
+        arr << case arg.class.to_s
+        when "Hash"
+          arg.collect do |meth, klass|
+            case klass.class.to_s
+            when "String"
+              define_callback_class(klass)
+              "self.#{klass.to_s.downcase}.#{meth}(self)"
+            else
+              "#{klass}.send :#{meth}, self"
+            end              
+          end
+        when "Symbol"
+          "self.send :#{arg}, self"
+        end
+      end
+
+      string = ""
+      if block_given?
+        num = store_proc(block.to_proc)
+        arr << <<-EOM
+          self.class.get_proc(#{num}).bind(self).call
+        EOM
+      end
+
+      string = create_eval_for_mod_with_string_and_type!(m, type) do
+        arr.join("\n")
+      end        
+
+      mMode = Module.new {eval string}
+
+      define_callback_module(mMode)
+    end
+    def before(m, *args, &block)
+      callback(:before, m, *args, &block)
+    end
+    def after(m, *args, &block)
+      callback(:after, m, *args, &block)
+    end
+
+    def create_eval_for_mod_with_string_and_type!(meth, type=nil, &block)
+      str = ""
+      case type
+      when :before          
+        str << <<-EOD
+          def #{meth}(*args)
+            #{yield}
+            super
+          end
+        EOD
+      when :after
+        str << <<-EOD
+          def #{meth}(*args)
+            super
+            #{yield}
+          end
+        EOD
+      else
+        str << <<-EOD
+          def #{meth}(*args)
+            #{yield}
+          end
+        EOD
+      end
+      str
+    end
+
+    def callbacks
+      @callbacks ||= []
+    end
+    def classes
+      @classes ||= []
+    end
+  end
+
+  module InstanceMethods
+    def initialize(*args)
+      extend_callbacks
+      extend_callback_methods
+    end
+    
+    def extend_callback_methods
+      unless self.class.classes.empty? 
+        self.class.classes.each do |klass|
+          m = %{def #{klass.to_s.downcase};@#{klass.to_s.downcase} ||= #{klass}.new;end}
+          self.class.class_eval m unless self.class.method_defined?(m)
+        end
+      end
+    end
+    
+    def extend_callbacks
+      unless self.class.callbacks.empty?
+        self.class.callbacks.each do |mod|
+          self.extend(mod)
+        end
+      end
+    end
+  end
+
+  module ProcStoreMethods
+    def store_proc(proc)
+      proc_storage << proc
+      proc_storage.index(proc)
+    end
+    def get_proc(num)
+      proc_storage[num]
+    end
+    def proc_storage
+      @proc_store ||= []
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.extend         ProcStoreMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/core/proc.rb

@@ -0,0 +1,12 @@
+class Proc
+  def bind(object)
+    block, time = self, Time.now
+    (class << object; self; end).class_eval do
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+      method = instance_method(method_name)
+      remove_method(method_name)
+      method
+    end.bind(object)
+  end
+end

data/spec/callback_spec.rb

@@ -0,0 +1,200 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class TestCallbacks
+  include Callbacks
+  attr_reader :str
+  
+  before :world, :hello
+  after :world, :thanks
+  
+  def hello(caller)
+    string << "hello "
+  end
+  def world
+    string << "world"
+  end
+  def thanks(caller)
+    string << ", thank you"
+  end
+  after :pop, :boom
+  def pop
+    string << "pop"
+  end
+  def boom(caller)
+    string << " goes boom"
+  end    
+  def string
+    @str ||= String.new
+  end
+end
+describe "Callbacks" do
+  before(:each) do
+    @klass = TestCallbacks.new
+  end
+  it "should retain it's class identifier" do
+    @klass.class.should == TestCallbacks
+  end
+  it "should callback the method before the method runs" do
+    @klass.world.should == "hello world, thank you"
+  end
+  it "should callback the method before the method runs" do
+    @klass.pop.should == "pop goes boom"
+  end
+end
+class TestMultipleCallbacks
+  include Callbacks
+  attr_reader :str
+  def hi(caller)
+    string << "hi, "
+  end
+  def hello(caller)
+    string << "hello "
+  end
+  def world
+    string << "world"
+  end
+  def string
+    @str ||= String.new
+  end
+  before :world, :hi, :hello
+end
+describe "Multiple callbacks" do
+  before(:each) do
+    @klass = TestMultipleCallbacks.new
+  end
+  it "should be able to have multiple callbacks on the same call" do
+    @klass.world.should == "hi, hello world"
+  end
+end
+class OutsideClass
+  def self.hello(caller)
+    puts "hello"
+  end
+end
+class TestOutsideClass
+  include Callbacks
+  before :world, {:hello => OutsideClass}
+  def world
+    "world"
+  end
+end
+describe "Options" do
+  before(:each) do
+    @c = TestOutsideClass.new
+  end
+  it "should be able to pass external class options to the callback" do
+    OutsideClass.should_receive(:hello).and_return "hello"
+    @c.world
+  end
+end
+class BlockClass
+  include Callbacks
+  before :world do
+    string << "hello "
+  end
+  def world
+    string << "world"
+  end
+  def string
+    @string ||= ""
+  end
+end
+describe "Block callbacks" do
+  it "should call the block on the callback" do
+    BlockClass.new.world.should == "hello world"
+  end
+end
+class BlockAndMethodClass
+  include Callbacks
+  before :world, :hi do
+    string << "hello "
+  end
+  def world
+    string << "world"
+  end
+  def hi(caller)
+    string << "hi, "
+  end
+  def string
+    @string ||= ""
+  end
+end
+describe "Block and method callbacks" do
+  it "should call the block on the callback and add the block" do
+    BlockAndMethodClass.new.world.should == "hi, hello world"
+  end
+end
+class ExternalMethodCallClass
+  include Callbacks
+  before :world, :hello
+  after :hello, :peter
+  
+  def world
+    string << "world"
+  end
+  def hello(caller)
+    string << "hello "
+  end
+  def peter(caller)
+    string << "peter "
+  end
+  def string
+    @string ||= ""
+  end
+end
+describe "External method callbacks inside a method" do
+  it "should call the block on the callback and add the " do
+    ExternalMethodCallClass.new.world.should == "hello peter world"
+  end
+end
+class OutsideBindingClass
+  def hello(caller)
+    caller.string << "hello"
+  end
+end
+class BindingClass
+  include Callbacks
+  before :world, :hello => "OutsideBindingClass"
+  def world
+    string << "#{@hello} world"
+  end
+  def string
+    @string ||= ""
+  end
+end
+describe "Methods" do
+  it "should have access to the local variables of the call" do
+    BindingClass.new.world.should == "hello world"
+  end
+end
+class EvilOutsideClass
+  attr_reader :name
+  def get_name(caller)
+    @name = caller.hello
+  end
+  def show_name(caller)
+    @name
+  end
+end
+class BindingClass
+  include Callbacks
+  before :print, {:get_name => "EvilOutsideClass"}
+  def print
+    "hello"
+  end
+  def hello
+    "franke"
+  end
+end
+describe "Variables on the plugin callbacker class" do
+  it "should call the methods from the class itself on a singeton method" do
+    BindingClass.new.methods.include?("eviloutsideclass").should == true
+  end
+  it "should call get_name on EvilOutsideClass" do
+    @bc = BindingClass.new
+    @eoc = EvilOutsideClass.new
+    @bc.should_receive("eviloutsideclass").and_return(@eoc)
+    @eoc.should_receive("get_name").and_return("bob")
+    @bc.print
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.join(File.dirname(__FILE__), %w(.. lib)))
+
+%w(test/spec backcall).each do |library|
+  begin
+    require library
+  rescue
+    STDERR.puts "== Cannot run test without #{library}"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: auser-backcall
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ari Lerner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Add basic memory-efficient before and after callbacks, easily
+email: ari.lerner@citrusbyte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/backcall.rb
+- lib/core/proc.rb
+- README
+files: 
+- CHANGELOG
+- lib/backcall.rb
+- lib/core/proc.rb
+- Manifest
+- Rakefile
+- README
+- spec/callback_spec.rb
+- spec/spec_helper.rb
+- backcall.gemspec
+has_rdoc: true
+homepage: http://blog.citrusbyte.com
+post_install_message: |-
+  For more information, check http://blog.citrusbyte.com
+  *** Ari Lerner @ <ari.lerner@citrusbyte.com> ***
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Backcall
+- --main
+- README
+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: backcall
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Add basic memory-efficient before and after callbacks, easily
+test_files: []
+