callbacks 0.0.1

data/tasks/spec.rake

@@ -0,0 +1,55 @@
+# $Id$
+
+if HAVE_SPEC_RAKE_SPECTASK
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.ruby_opts = PROJ.ruby_opts
+      t.spec_opts = PROJ.spec.opts
+      t.spec_files = PROJ.spec.files
+      t.libs += PROJ.libs
+      t.rcov = true
+      t.rcov_dir = PROJ.rcov.dir
+      t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
+    end
+
+    RCov::VerifyTask.new(:verify) do |t| 
+      t.threshold = PROJ.rcov.threshold
+      t.index_html = File.join(PROJ.rcov.dir, 'index.html')
+      t.require_exact_threshold = PROJ.rcov.threshold_exact
+    end
+
+    task :verify => :rcov
+    remove_desc_for_task %w(spec:clobber_rcov)
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,48 @@
+# $Id$
+
+if HAVE_SVN
+
+unless PROJ.svn.root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn.root = (m.nil? ? '' : m[1])
+end
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
+
+namespace :svn do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags => 'svn:prereqs' do |t|
+    tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
+    tags.gsub!(%r/\/$/, '')
+    tags = tags.split("\n").sort {|a,b| b <=> a}
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag => 'svn:prereqs' 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
+
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(svn.root, svn.tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn.path
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,38 @@
+# $Id$
+
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test.opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+# EOF

data/test/profile.rb

@@ -0,0 +1,16 @@
+$: << '../lib'
+$: << 'lib'
+$: << 'test'
+require 'tester_class.rb'
+
+Tester.add_callback_methods :boot, :exit
+Tester.before_boot do
+  p 'before boot'
+end
+
+Tester.after_boot 'p "after_boot"'
+
+Tester.after_exit Proc.new {self.test}
+
+t = Tester.new
+p t.boot

data/test/test_callbacks.rb

@@ -0,0 +1,168 @@
+class CallbacksTest < Test::Unit::TestCase
+  
+  def setup
+    Object.send(:remove_const, :Tester)  if defined? Tester
+    load 'test/tester_class.rb'
+    $tests_run = []
+  end
+  
+  def test_class_should_return_values
+    t = Tester.new
+    assert_equal 'booting', t.boot
+    assert_equal 'exiting', t.exit
+  end
+  
+  def test_should_create_methods_in_class
+    Tester.add_callback_methods :boot
+    
+    assert_nothing_raised { Tester.new.boot }
+    assert_nothing_raised { Tester.new.boot_without_callbacks }
+    assert_nothing_raised { Tester.before_boot('p "ehlo"') }
+    assert_nothing_raised { Tester.after_boot('p "ehlo"') }
+  end
+  
+  def test_remove_callback
+    Tester.add_callback_methods :boot, :exit
+    Tester.remove_callback_method :boot
+    Tester.remove_callback_method :exit
+    
+    assert_equal [], Tester.callback_methods
+    assert_raise(NoMethodError) { Tester.before_boot }
+    assert_raise(NoMethodError) { Tester.after_boot }
+    
+  end
+  
+  def test_should_create_callback_methods_in_class
+    Tester.add_callback_methods :boot, :exit
+    assert_equal [:boot, :exit], Tester.callback_methods
+  end
+  
+  def test_class_should_create_before_and_after_method
+    Tester.add_callback_methods :boot
+    methods = Tester.methods.grep(/(^before_.+$|^after_.+$)/)
+    
+    assert methods.include?('before_boot')
+    assert methods.include?('after_boot')
+  end
+  
+  def test_class_callbacks_should_run_callbacks
+    Tester.add_callback_methods :boot, :exit
+    
+    Tester.before_boot do
+      $tests_run << 'before_boot'
+    end
+    
+    Tester.after_exit do
+      $tests_run << 'after_exit'
+    end
+    
+    t = Tester.new
+    assert_equal 'booting', t.boot
+    assert $tests_run.include?('before_boot')
+    
+    assert_equal 'exiting', t.exit
+    assert $tests_run.include?('after_exit')
+  end
+  
+  def test_class_callbacks_should_run_symbol
+    Tester.add_callback_methods :exit
+    Tester.before_exit :fill_globalvar_tests_run
+    t = Tester.new
+    t.exit
+    
+    assert_equal 'fill_globalvar_tests_run', $tests_run.first
+  end
+  
+  def test_class_callbacks_should_run_block_in_self
+    Tester.add_callback_methods :exit
+    
+    Tester.before_exit do
+      $tests_run << self.boot
+    end
+    
+    t = Tester.new
+    assert_equal 'exiting', t.exit
+    
+    assert_equal 'booting', $tests_run.first
+  end
+  
+  def test_class_callbacks_should_run_string
+    Tester.add_callback_methods :boot
+    Tester.after_boot '$tests_run << "after_test"'
+    t = Tester.new
+    t.boot
+    
+    assert_equal 'after_test', $tests_run.first
+  end
+  
+  def test_class_callbacks_should_run_method
+    
+  end
+  
+  def test_class_callbacks_should_raise_when_wrong_argument
+    
+  end
+  
+  def test_class_without_actions_should_not_give_exception
+    Tester.add_callback_methods :boot, :exit
+    t = Tester.new
+    assert_nothing_raised do 
+      t.boot
+    end
+  end
+  
+  def test_class_without_actions_should_return_original_retval
+    Tester.add_callback_methods :boot, :exit
+    t = Tester.new
+    assert_equal 'booting', t.boot
+  end
+  
+  def test_callback_methods_of_two_classes_should_be_kept_seperate
+    tester_two_class = Tester.dup
+    tester_three_class = Tester.dup
+    Tester.add_callback_methods :exit
+    tester_two_class.add_callback_methods :boot
+    
+    assert_equal [], tester_three_class.callback_methods
+    assert_equal [:exit], Tester.callback_methods
+    assert_equal [:boot], tester_two_class.callback_methods
+    
+  end
+  
+  def test_callback_actions_of_two_classes_should_be_kept_seperate
+    Tester.add_callback_methods :exit
+    tester_two_class = Tester.dup
+    tester_three_class = Tester.dup
+    
+    tester_two_class.before_exit do
+      $tests_run << 'before_exit'
+    end
+    
+    Tester.after_exit do
+      $tests_run << 'after_exit'
+    end
+
+    assert_equal({}, tester_three_class.callback_actions)
+    
+    Tester.new.exit
+    assert_equal ['after_exit'], $tests_run
+    
+    $tests_run = []
+    
+    tester_two_class.new.exit
+    assert_equal ['before_exit'], $tests_run
+  end
+  
+  #  def test_callbacks_created_in_class_should_be_vissible_in_instance
+  #    Tester.add_callback_methods :boot, :exit
+  #    t = Tester.new
+  #    assert_equal [:boot, :exit], t.callbacks
+  #  end
+  
+  #  def test_callback_created_in_instance_should_not_be_vissible_in_class
+  #    t = Tester.new
+  #    t.add_callback :boot
+  #    assert_equal [], Tester.callbacks
+  #  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')

data/test/tester_class.rb

@@ -0,0 +1,23 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'callbacks'
+
+class Tester
+
+  def boot
+    return "booting"
+  end
+
+  def exit
+    return "exiting"
+  end
+
+  def testing
+    return "testing"
+  end
+  
+  def fill_globalvar_tests_run
+    $tests_run << 'fill_globalvar_tests_run'
+  end
+
+  include Callbacks
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: callbacks
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leon Bogaert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-20 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
+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/callbacks.rb
+- lib/classmethods.rb
+- lib/instancemethods.rb
+- spec/callbacks_spec.rb
+- spec/spec_helper.rb
+- tasks/ann.rake
+- tasks/bones.rake
+- tasks/gem.rake
+- tasks/manifest.rake
+- tasks/notes.rake
+- tasks/post_load.rake
+- tasks/rdoc.rake
+- tasks/rubyforge.rake
+- tasks/setup.rb
+- tasks/spec.rake
+- tasks/svn.rake
+- tasks/test.rake
+- test/profile.rb
+- test/test_callbacks.rb
+- test/test_helper.rb
+- test/tester_class.rb
+has_rdoc: true
+homepage: www.vanutsteen.nl
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+- ext
+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: callbacks
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: This package makes it simple to add callbacks a
+test_files: 
+- test/test_helper.rb
+- test/test_callbacks.rb