dm-observer 0.9.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Mark Bates
+
+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

@@ -0,0 +1,32 @@
+README
+======
+DataMapper::Observer allows you to add callback hooks to many models. This is
+similar to observers in ActiveRecord.
+
+Example:
+
+class Adam
+  include DataMapper::Resource
+
+  property :id, Integer, :serial => true
+  property :name, String
+end
+
+class AdamObserver
+  include DataMapper::Observer
+
+  observe Adam
+
+  before :save do
+    # log message
+  end
+
+  before :get_drunk do
+    # eat something
+  end
+
+  after_class_method :unite do
+    raise "Call for help!"
+  end
+
+end

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-observer'
+  s.version          = '0.9.2'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin for observing Resource Models'
+  s.description      = s.summary
+  s.author           = 'Mark Bates'
+  s.email            = 'mark@mackframework.com'
+  s.homepage         = 'http://github.com/sam/dm-more/tree/master/dm-observer'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core', "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/lib/dm-observer.rb

@@ -0,0 +1,91 @@
+module DataMapper
+  # Observers allow you to add callback hooks to DataMapper::Resource objects
+  # in a separate class. This is great for separating out logic that is not
+  # really part of the model, but needs to be triggered by a model, or models.
+  module Observer
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      attr_accessor :observing
+
+      def initialize
+        self.observing = []
+      end
+
+      # Assign an Array of Class names to watch.
+      #   observe User, Article, Topic
+      def observe(*args)
+        # puts "#{self.to_s} observing... #{args.collect{|c| Extlib::Inflection.classify(c.to_s)}.join(', ')}"
+        self.observing = args
+      end
+
+      def before(sym, &block)
+        self.observing.each do |klass|
+          klass.before(sym.to_sym, &block)
+        end
+      end
+
+      def after(sym, &block)
+        self.observing.each do |klass|
+          klass.after(sym.to_sym, &block)
+        end
+      end
+
+      def before_class_method(sym, &block)
+        self.observing.each do |klass|
+          klass.before_class_method(sym.to_sym, &block)
+        end
+      end
+
+      def after_class_method(sym, &block)
+        self.observing.each do |klass|
+          klass.after_class_method(sym.to_sym, &block)
+        end
+      end
+
+    end # ClassMethods
+
+  end # Observer
+end # DataMapper
+
+if $0 == __FILE__
+  require 'rubygems'
+
+  gem 'dm-core', '=0.9.2'
+  require 'dm-core'
+
+  FileUtils.touch(File.join(Dir.pwd, "migration_test.db"))
+  DataMapper.setup(:default, "sqlite3://#{Dir.pwd}/migration_test.db")
+
+  class Foo
+    include DataMapper::Resource
+
+    property :id, Integer, :serial => true
+    property :bar, Text
+  end
+
+  Foo.auto_migrate!
+
+  class FooObserver
+    include DataMapper::Observer
+
+    observe :foo
+
+    before :save do
+      raise "Hell!" if self.bar.nil?
+      puts "hi"
+    end
+
+    after :save do
+      puts "bye"
+    end
+
+  end
+
+  Foo.new(:bar => "hello").save
+
+end

data/spec/integration/dm-observer_spec.rb

@@ -0,0 +1,129 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::Observer do
+  before :all do
+    class Adam
+      include DataMapper::Resource
+
+      property :id, Integer, :serial => true
+      property :name, String
+      attr_accessor :done
+
+      def falling?
+        @falling
+      end
+
+      def dig_a_hole_to_china
+        @done = true
+      end
+
+      def drink
+        @happy = true
+      end
+
+      def happy?
+        @happy
+      end
+
+      def self.unite
+        [Adam.new(:name => "Adam 1"), Adam.new(:name => "Adam 2")]
+      end
+
+    end
+    Adam.auto_migrate!
+
+    module Alcohol
+      class Beer
+        include DataMapper::Resource
+
+        property :id, Integer, :serial => true
+        property :name, String
+
+        def drink
+          @empty = true
+        end
+
+        def empty?
+          @empty
+        end
+
+      end
+    end
+    Alcohol::Beer.auto_migrate!
+
+
+    class AdamObserver
+      include DataMapper::Observer
+
+      observe Adam
+
+      before :save do
+        @falling = true
+      end
+
+      before :dig_a_hole_to_china do
+        throw :halt
+      end
+
+      after_class_method :unite do
+        raise "Call for help!"
+      end
+
+    end
+
+    class DrinkingObserver
+      include DataMapper::Observer
+
+      observe Adam, Alcohol::Beer
+
+      after :drink do
+        @refrigerated = true
+      end
+
+    end
+
+  end
+
+  before(:each) do
+    @adam = Adam.new
+    @beer = Alcohol::Beer.new
+  end
+
+  it "should assign a callback" do
+    @adam.should_not be_falling
+    @adam.name = "Adam French"
+    @adam.save
+    @adam.should be_falling
+  end
+
+  it "should be able to trigger an abort" do
+     @adam.dig_a_hole_to_china
+     @adam.done.should be_nil
+  end
+
+  it "observe should add a class to the neighborhood watch" do
+    AdamObserver.should have(1).observing
+    AdamObserver.observing.first.should == Adam
+  end
+
+  it "observe should add more than one class to the neighborhood watch" do
+    DrinkingObserver.should have(2).observing
+    DrinkingObserver.observing.first.should == Adam
+    DrinkingObserver.observing[1].should == Alcohol::Beer
+  end
+
+  it "should observe multiple classes with the same method name" do
+    @adam.should_not be_happy
+    @beer.should_not be_empty
+    @adam.drink
+    @beer.drink
+    @adam.should be_happy
+    @beer.should be_empty
+  end
+
+  it "should wrap class methods" do
+    lambda {Adam.unite}.should raise_error('Call for help!')
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+gem "dm-core"
+require 'dm-core'
+require 'pathname'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-observer'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '=0.9.2'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: dm-observer
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin for observing Resource Models
+email: mark@mackframework.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-observer.rb
+- spec/integration/dm-observer_spec.rb
+- spec/spec_helper.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-observer
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin for observing Resource Models
+test_files: []
+