dm-observers 0.0.1

data/AUTHORS

@@ -0,0 +1 @@
+Carlos A. Paramio (carlos@evolve.st)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Carlos A. Paramio (carlos@evolve.st)
+
+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,126 @@
+This is a DataMapper plugin that provides observers for DataMapper resource
+classes. It's compatible with DataMapper 0.9.1
+
+== Setup
+DataMapper observer capabilities are automatically available when you
+'require dm-observers' into your application.
+
+== Basic Usage
+
+  require 'dm-observers'
+
+  DataMapper.setup(:default, 'sqlite3::memory:')
+
+  class MyModel
+    include DataMapper::Resource
+    include DataMapper::Observers::Observable
+    property :id, Integer, :key => true
+    
+    def my_instance_method
+      puts "my_instance_method called"
+    end
+  end
+
+  class MyObserver < DataMapper::Observers::Observer
+    
+    before :save do
+      puts "before :save block..."
+    end
+    
+    after :destroy do
+      puts "after :destroy block..."
+    end
+    
+    before :my_instance_method do
+      puts "before :my_instance_method block..."
+      # ...
+    end
+    
+    before :my_instance_method do |object|
+      puts "before :my_instance_method block with object parameter #{object.inspect}..."
+      #...
+    end
+    
+    # ...
+  end
+
+  MyObserver.instance.observed_class = MyModel
+
+  MyModel.auto_migrate!
+  object = MyModel.new
+  
+  object.my_instance_method
+  ---- output ----
+  before :my_instance_method block...
+  before :my_instance_method block with object parameter #<MyModel id=nil>...
+  my_instance_method called
+  ---- output ----
+  
+  object.save
+  ---- output ----
+  before :save block...
+  ---- output ----
+
+  object.destroy
+  ---- output ----
+  after :destroy block...
+  ---- output ----
+
+
+The methods "before" and "after" take a target method parameter -- the name of the method at
+the model to observe -- and a block -- the code to execute before/after the target method is
+executed. The syntax is pretty similar to model hooks, just that it doesn't support class methods
+or method symbols yet.
+
+The block supports a parameter, that will be filled with the object instance that sent the
+update notification to the observers.
+
+
+== Observers for DataMapper Resources
+
+The observers defined for DataMapper Resources can be automatically added to the model,
+if the observer class name is prefixed with the name of the model to observe, and suffixed
+with 'Observer'. Example:
+
+  class MyModel
+    # ...
+  end
+
+  class MyModelObserver
+    # ...
+  end
+
+  MyModelObserver.instance # The observer is automatically added to the MyModel class.
+
+
+You can include all the observers instanciations at some bootstrap block of your project.
+
+
+== Custom messages to the observer
+
+Additionally to the default hooks called on the observers, you can send a custom message
+to them using the notify_observers method:
+
+  class MyModel
+    include DataMapper::Resource
+    include DataMapper::Observers::Observable
+    property :id, Integer, :key => true
+  
+    def do_something
+      # ...
+      MyModel.notify_observers(:purge_old_data, self)
+    end
+  end
+
+  class MyModelObserver < DataMapper::Observers::Observer
+    def purge_old_data(object)
+      puts "Purge Old Data..."
+      # ...
+    end
+  end
+
+  MyModelObserver.instance
+  MyModel.new.do_something
+  ---- output ----
+  Purge Old Data...
+  ---- output ----

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+desc "Generate Documentation"
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "DataMapper Observers"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include(FileList[ 'lib/**/*.rb', 'README', 'LICENSE'])
+end
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-observers'
+  s.version          = '0.9.1'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin for performing observers for data models'
+  s.description      = s.summary
+  s.author           = 'Carlos A. Paramio'
+  s.email            = 'carlosparamio@gmail.com'
+  s.homepage         = 'http://github.com/carlosparamio/dm-observers/tree/master'
+  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}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+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')
+end

data/TODO

@@ -0,0 +1,2 @@
+* Add support to observe class methods
+* Add more specs for observer blocks definitions and observable notifications

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: dm-observers
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Carlos Paramio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+description: This is a DataMapper plugin that provides observers for DataMapper resource classes. It's compatible with DataMapper 0.9.1.
+email: carlosparamio@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- AUTHORS
+- LICENSE
+- README
+- Rakefile
+- TODO
+has_rdoc: true
+homepage: http://github.com/carlosparamio/dm-observers/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: DataMapper Observers gem
+test_files: []
+