callbacks 0.0.1 → 0.0.2

data/History.txt

@@ -3,3 +3,10 @@
 * First release
   * API not yet stable
   * Only supports adding hooks to classes not instances. Instances are planned for 0.2
+
+== 0.0.2 / 2008-09-28
+
+* Second release!
+  * API still not stable
+  * Callbacks now picks up "before#{callback}" and "after_#{callback}" instance methods automatically
+  * Some documentation added

data/Manifest.txt

@@ -3,9 +3,9 @@ Manifest.txt
 README.txt
 Rakefile
 Version.txt
-bin/callbacks
 ext/metaid.rb
 lib/callback.rb
+lib/callbackchain.rb
 lib/callbacks.rb
 lib/classmethods.rb
 lib/instancemethods.rb

data/README.txt

@@ -13,6 +13,7 @@ This package makes it simple to add callbacks a.k.a. "hooks" to ruby classes
 * It now only supports adding callbacks to classes
 * Different callbacks for instances comes with version 0.2
 * I haven't decided yet on the API, maybe I'll swap "callback_methods" with "hooks"
+* When using add_callback_method before the method itself is defined, it won't work
 
 == SYNOPSIS:
 
@@ -27,6 +28,8 @@ This package makes it simple to add callbacks a.k.a. "hooks" to ruby classes
     o = Object.new
     o.inspect #will print "Going to inspect Object"
 
+  For more code examples see: http://callbacks.rubyforge.com
+
 == REQUIREMENTS:
 
 * ruby 1.8 (might work with ruby1.9)

data/Rakefile

@@ -20,6 +20,8 @@ PROJ.exclude = %w(.git pkg/ nbproject/ doc/ ^test[0-9]*.rb$ website/ )
 PROJ.rdoc.exclude = %w(Version.txt)
 PROJ.rdoc.remote_dir = 'docs/'
 
+PROJ.rcov.opts << "--exclude rcov.rb"
+
 PROJ.spec.opts << '--color'
 
 # EOF

data/Version.txt

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/callbackchain.rb

@@ -0,0 +1,6 @@
+#Just a test!
+module Callbacks
+  class CallbackChain < Hash
+  
+  end
+end

data/lib/callbacks.rb

@@ -2,26 +2,19 @@
 module Callbacks
   require 'observer'
   require 'ext/metaid.rb'
+  require 'callbackchain.rb'
   require 'instancemethods.rb'
   require 'classmethods.rb'
   require 'callback.rb'
-  
-  #  CALLBACKS = [
-  #    'song_halfway',
-  #    'song_end',
-  #    'boot',
-  #    'shutdown',
-  #  ]
-  
-  CALLBACKS = []
 
   #Sets all things right
   def self.included(base) #:nodoc:
-    base.extend Observable
+    base.extend Observable #why?
     base.extend Callbacks::ClassMethods
     base.send(:include, Callbacks::InstanceMethods)
   end
 end
 
 #TODO: add aliases like add_hook(), callbacks(), et cetera
-#TODO: feature to add hooks/callbacks to instances instead of only classes
+#TODO: feature to add hooks/callbacks to instances instead of only classes
+#TODO: make all of the activesupport features/tests work

data/lib/classmethods.rb

@@ -8,13 +8,13 @@ module Callbacks
    
     def callback_actions
       #Use one @, else it gets stored in the module and then it will be avaiable in every class that uses callback
-      @callback_actions ||= {}
+      @callback_actions ||= CallbackChain.new
     end
    
     def add_callback_methods(*callbacks)
       callbacks.each do |callback|
         self.callback_methods << callback.to_sym
-        self.build_callback_method(callback)
+        self.build_callback_methods(callback)
       end
     end
     
@@ -30,21 +30,9 @@ module Callbacks
       self.callback_methods.delete(method.to_sym)
     end
     
-    def build_callback_method(method)
-        
-      #instance_eval do
-      instance_eval <<-"end_eval"
-
-          def before_#{method}(*callbacks, &block)
-            add_callback_action :before, :#{method}, *callbacks, &block
-          end
-
-          def after_#{method}(*callbacks, &block)
-            add_callback_action :after, :#{method}, *callbacks, &block
-          end
-
-      end_eval
-      #end
+    def build_callback_methods(method)
+      build_before_callback_method(method)
+      build_after_callback_method(method)
       
       class_eval <<-"end_eval"
         def #{method}_with_callbacks
@@ -66,12 +54,35 @@ module Callbacks
       ca[method][type] = [] if ca[method][type].nil?
       
       if block_given?
-        ca[method][type] << Callback.new(method, nil, &block)
+        callback = Callback.new(method, nil, &block)
       else
         code.each do |c|
-          ca[method][type] << Callback.new(method, c)
+          callback = Callback.new(method, c)
         end
       end
+      ca[method][type] << callback
+      return callback
+    end
+    
+    private
+    def build_before_callback_method(method)
+      instance_eval <<-"end_eval"
+      
+          def before_#{method}(*callbacks, &block)
+            add_callback_action :before, :#{method}, *callbacks, &block
+          end
+
+      end_eval
+    end
+    
+    def build_after_callback_method(method)
+      instance_eval <<-"end_eval"
+
+          def after_#{method}(*callbacks, &block)
+            add_callback_action :after, :#{method}, *callbacks, &block
+          end
+
+      end_eval
     end
     
   end

data/lib/instancemethods.rb

@@ -2,20 +2,31 @@ module Callbacks
   module InstanceMethods
     
     def callback_actions(show_classvars = true)
-      return self.class_callback_actions
+      callback_actions = self.class_callback_actions
       #return self.instance_callbacks if show_classvars == false
       #return self.class_callback_actions + self.instance_callback_actions if show_classvars == true
     end
     
-    #Really don't know what this does :p But it works!
-    #I'm really, really bad at metaprogramming
-    def callback_actions_for(method, type)
+    def callback_actions_for(method, type)  
+      #Do the rescue if [method] does not exist (nil), [type] will fail
       begin
-        return self.callback_actions[method] if type.nil?
-        return self.callback_actions[method][type] ||= []
+        callback_actions = self.callback_actions[method][type] ||= []
       rescue NoMethodError
-        return []
+        callback_actions = []
       end
+      
+      #If the before/after_ method exists, and it is not already added,
+      # add it!
+      #Dit kan mooier!
+      if self.respond_to?("#{type}_#{method}")
+        if not callback_actions.include? "#{type}_#{method}".to_sym
+          #callback_actions << Callback.new(method, "#{type}_#{method}".to_sym)
+          callback = self.class.add_callback_action(type, method, "#{type}_#{method}".to_sym)
+          callback_actions << callback
+        end
+      end
+      
+      return callback_actions
     end
     
     def class_callback_actions
@@ -35,4 +46,4 @@ module Callbacks
       #Should I return something?
     end
   end
-end
+end

data/tasks/gem.rake

@@ -91,7 +91,7 @@ namespace :gem do
   end
 
   desc 'Install the gem'
-  task :install => [:clobber, :package] do
+  task :install => [:clobber, 'gem:package'] do
     sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
 
     # use this version of the command for rubygems > 1.0.0
@@ -109,6 +109,11 @@ namespace :gem do
   desc 'Reinstall the gem'
   task :reinstall => [:uninstall, :install]
 
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+
 end  # namespace :gem
 
 desc 'Alias to gem:package'

data/tasks/manifest.rake

@@ -15,9 +15,9 @@ namespace :manifest do
       lines.map! do |line|
         case line
         when %r/^(-{3}|\+{3})/; nil
-        when %r/^@/; Console::ANSICode.blue line
-        when %r/^\+/; Console::ANSICode.green line
-        when %r/^\-/; Console::ANSICode.red line
+        when %r/^@/; ANSICode.blue line
+        when %r/^\+/; ANSICode.green line
+        when %r/^\-/; ANSICode.red line
         else line end
       end
     end

data/tasks/rubyforge.rake

@@ -1,4 +1,3 @@
-# $Id$
 
 if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
 
@@ -7,7 +6,7 @@ require 'rake/contrib/sshpublisher'
 
 namespace :gem do
   desc 'Package and upload to RubyForge'
-  task :release => [:clobber, :package] do |t|
+  task :release => [:clobber, 'gem:package'] do |t|
     v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
     abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
     pkg = "pkg/#{PROJ.gem._spec.full_name}"
@@ -18,6 +17,7 @@ namespace :gem do
     end
 
     rf = RubyForge.new
+    rf.configure rescue nil
     puts 'Logging in'
     rf.login
 

data/tasks/setup.rb

@@ -18,7 +18,7 @@ PROJ = OpenStruct.new(
   :email => nil,
   :url => "\000",
   :version => ENV['VERSION'] || '0.0.0',
-  :exclude => %w(tmp$ bak$ ~$ CVS .svn/ ^pkg/),
+  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
   :release_name => ENV['RELEASE'],
 
   # System Defaults
@@ -58,7 +58,7 @@ PROJ = OpenStruct.new(
 
   # File Annotations
   :notes => OpenStruct.new(
-    :exclude => %w(^tasks/setup.rb$),
+    :exclude => %w(^tasks/setup\.rb$),
     :extensions => %w(.txt .rb .erb) << '',
     :tags => %w(FIXME OPTIMIZE TODO)
   ),
@@ -74,8 +74,8 @@ PROJ = OpenStruct.new(
   # Rdoc
   :rdoc => OpenStruct.new(
     :opts => [],
-    :include => %w(^lib/ ^bin/ ^ext/ .txt$),
-    :exclude => %w(extconf.rb$),
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$),
+    :exclude => %w(extconf\.rb$),
     :main => nil,
     :dir => 'doc',
     :remote_dir => nil
@@ -159,6 +159,8 @@ GEM  = WIN32 ? 'gem.bat'  : 'gem'
 end
 HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
             system("svn --version 2>&1 > #{DEV_NULL}"))
+HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
+            system("git --version 2>&1 > #{DEV_NULL}"))
 
 # Reads a file at +path+ and spits out an array of the +paragraphs+
 # specified.

data/test/test_callbacks.rb

@@ -153,6 +153,38 @@ class CallbacksTest < Test::Unit::TestCase
     assert_equal ['before_exit'], $tests_run
   end
   
+#  def test_should_not_raise_error_when_method_not_exist
+#    assert_nothing_raised do 
+#      Tester.add_callback_methods :doesnotexist
+#    end
+#  end
+  
+#  def test_no_method_callback_should_not_add_method
+#    Tester.add_callback_methods :nomethodcallback
+#    t = Tester.new
+#    
+#    assert_raise NameError do 
+#      t.nomethodcallback
+#    end
+#  end
+  
+  def test_should_use_defined_methods_in_class_as_callback
+    Tester.add_callback_methods :callback_with_defined_method
+    t = Tester.new
+    t.callback_with_defined_method
+    assert $tests_run.length > 0
+  end
+  
+  def test_callback_should_only_be_certain_types
+    assert_nothing_raised do 
+      Callback.new(:inspect, 'print "This is a test"')
+    end
+    
+    assert_raise RuntimeError do 
+      Callback.new(:inspect, [])
+    end
+  end
+  
   #  def test_callbacks_created_in_class_should_be_vissible_in_instance
   #    Tester.add_callback_methods :boot, :exit
   #    t = Tester.new

data/test/tester_class.rb

@@ -15,6 +15,15 @@ class Tester
     return "testing"
   end
   
+  def before_callback_with_defined_method
+    text = "This is before the method ran and is generated by a defined method in the class"
+    $tests_run << text
+    return text
+  end
+  
+  def callback_with_defined_method
+  end
+  
   def fill_globalvar_tests_run
     $tests_run << 'fill_globalvar_tests_run'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: callbacks
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Leon Bogaert
@@ -9,29 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-20 00:00:00 +02:00
+date: 2008-09-28 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: This package makes it simple to add callbacks a.k.a. "hooks" to ruby classes
 email: leon@vanutsteen.nl
-executables: 
-- callbacks
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
 - README.txt
-- bin/callbacks
 files: 
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
 - Version.txt
-- bin/callbacks
 - ext/metaid.rb
 - lib/callback.rb
+- lib/callbackchain.rb
 - lib/callbacks.rb
 - lib/classmethods.rb
 - lib/instancemethods.rb
@@ -77,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: callbacks
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: This package makes it simple to add callbacks a

data/bin/callbacks

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), '..', 'lib', 'callbacks'))
-
-# Put your code here
-
-# EOF