SpiritSC-case_collection_observer 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.1.0
+	Init project...

data/Manifest

@@ -0,0 +1,14 @@
+CHANGELOG
+LICENSE
+Manifest
+README
+Rakefile
+generators/case_observer/USAGE
+generators/case_observer/case_observer_generator.rb
+generators/case_observer/templates/case_collection_observer.rb
+generators/case_observer/templates/case_collection_observer_test.rb
+init.rb
+lib/case_collection_observer.rb
+lib/case_collection_observer/base.rb
+lib/case_collection_observer/version.rb
+lib/casecollectionobserver.rb

data/README

@@ -0,0 +1,139 @@
+== Case Collection Observer v. 0.1.0
+Simple notifier for object in HM and HABTM associations in AR...
+
+<b>Usage:</b>
+
+* Installation
+	sudo gem install case_collection_observer --source http://gems.github.com/
+	
+* Generator:
+
+	script/console case_observer OBSERVER_NAME MODELS_TO_OBSERVE [options]
+	
+	# options:
+		--skip-test => Skip all tests for observer
+	
+<b>Rails example:</b>
+
+- Simple construction with "has_many" association
+
+	# "Post" and "Comment" models
+		
+		class Post < ActiveRecord::Base
+			has_many_with_observer :comments
+		end
+		
+		class Comment < ActiveRecord::Base
+			belongs_to :post
+		end
+			
+	# simple "Blog" observer for "Post" model
+		
+		class BlogObserver < ActiveRecord::Observer
+			observe :post
+			
+			def before_save_comments(comment)
+			end
+			
+			def after_save_comments(comment)
+			end
+			
+			def before_destroy_comments(comment)
+			end
+			
+			def after_destroy_comments(comment)
+			end
+		end
+		
+- Simple construction with "has_many :through" association
+	
+	# "Post", "Category" and "Categorization" models
+		
+		class Post < ActiveRecord::Base
+			has_many :categorization
+			has_many_with_observer :categories, :through => :categorization
+		end
+		
+		class Category < ActiveRecord::Base
+			has_many :categorization
+			has_many_with_observer :posts, :through => :categorization
+		end
+		
+		class Categorization < ActiveRecord::Base
+			belongs_to :post
+			belongs_to :category
+		end
+		
+	# simple "Blog" observer for "Post" and "Category" models
+		
+		class BlogObserver < ActiveRecord::Observer
+			observe :post, :category
+			
+			def before_save_posts(post)
+			end
+			
+			def after_save_posts(post)
+			end
+			
+			def before_destroy_posts(post)
+			end
+			
+			def after_destroy_posts(post)
+			end
+			
+			def before_save_categories(category)
+			end
+			
+			def after_save_categories(category)
+			end
+			
+			def before_destroy_categories(category)
+			end
+			
+			def after_destroy_categories(category)
+			end
+		end 
+		
+- Simple construction with "has_and_belongs_to_many" association
+
+	# "Post", "Category" models and "categories_posts" table
+		
+		class Post < ActiveRecord::Base
+			has_and_belongs_to_many_with_observer :categories
+		end
+		
+		class Category < ActiveRecord::Base
+			has_and_belongs_to_many_with_observer :posts
+		end
+		
+	# simple "Blog" observer for "Post" and "Category" models
+		
+		class BlogObserver < ActiveRecord::Observer
+			observe :post, :category
+			
+			def before_save_posts(post)
+			end
+			
+			def after_save_posts(post)
+			end
+			
+			def before_destroy_posts(post)
+			end
+			
+			def after_destroy_posts(post)
+			end
+			
+			def before_save_categories(category)
+			end
+			
+			def after_save_categories(category)
+			end
+			
+			def before_destroy_categories(category)
+			end
+			
+			def after_destroy_categories(category)
+			end
+		end
+		
+Copyright © 2009 Szymon Czarnecki

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('case_collection_observer', '0.1.0') do |p|
+  p.description    = "Simple notifier for object in HM and HABTM associations in AR..."
+  p.url            = "http://github.com/SpiritSC/Case-Collection-Observer"
+  p.author         = "Szymon Czarnecki"
+  p.email          = "spirit_sc@thinkdifferent.pl"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/case_collection_observer.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{case_collection_observer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Szymon Czarnecki"]
+  s.date = %q{2009-09-21}
+  s.description = %q{Simple notifier for object in HM and HABTM associations in AR...}
+  s.email = %q{spirit_sc@thinkdifferent.pl}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/case_collection_observer.rb", "lib/case_collection_observer/base.rb", "lib/case_collection_observer/version.rb", "lib/casecollectionobserver.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "generators/case_observer/USAGE", "generators/case_observer/case_observer_generator.rb", "generators/case_observer/templates/case_collection_observer.rb", "generators/case_observer/templates/case_collection_observer_test.rb", "init.rb", "lib/case_collection_observer.rb", "lib/case_collection_observer/base.rb", "lib/case_collection_observer/version.rb", "lib/casecollectionobserver.rb", "case_collection_observer.gemspec"]
+  s.homepage = %q{http://github.com/SpiritSC/Case-Collection-Observer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Case_collection_observer", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{case_collection_observer}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple notifier for object in HM and HABTM associations in AR...}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/generators/case_observer/case_observer_generator.rb

@@ -0,0 +1,60 @@
+class CaseObserverGenerator < Rails::Generator::NamedBase
+  attr_accessor :observer
+  attr_accessor :models
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @observer = class_name
+    @models = @args
+  end
+  
+  def manifest
+    record do |m|
+      # Check existing folders
+      m.directory "app/models"
+      m.directory "test/unit"
+      
+      # Copy observer
+      m.template "case_collection_observer.rb", "app/models/#{observer_singular}_observer.rb"
+      
+      # Copy observer tests
+      unless options[:skip_test]
+        m.template "case_collection_observer_test.rb", "test/unit/#{observer_singular}_observer_test.rb"
+      end
+    end
+  end
+  
+  def observer_singular
+    observer.underscore
+  end
+  
+  def observer_singular_class
+    observer_singular.camelize
+  end
+  
+  def models_singular
+    models.collect { |m| m.underscore }
+  end
+  
+  def models_singular_sym
+    models_singular.collect { |m| ":#{m.to_sym}" }
+  end
+  
+  protected
+    def banner
+      "\nCase Collection Observer usage:\n" + 
+      "========================================================" +
+      "\n#{$0} case_observer OBSERVER_NAME MODELS_TO_OBSERVE [options]\n"
+    end
+    
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Case Collection Observer options:'
+      opt.separator '========================================================'
+      opt.on("--skip-test", "Skip all tests for observer") { |value| options[:skip_test] = value }    
+    end
+    
+    def usage_message
+      ''
+    end
+end

data/generators/case_observer/templates/case_collection_observer.rb

@@ -0,0 +1,18 @@
+class <%= observer_singular_class %>Observer < ActiveRecord::Observer
+  <% unless models.empty? %>
+  observe <%= models_singular_sym.join(', ') %>
+  <% end %>
+  <% for model in models_singular %>
+  def before_save_<%= model.pluralize %>(<%= model %>)
+  end
+  
+  def after_save_<%= model.pluralize %>(<%= model %>)
+  end
+  
+  def before_destroy_<%= model.pluralize %>(<%= model %>)
+  end
+  
+  def after_destroy_<%= model.pluralize %>(<%= model %>)
+  end
+  <% end %>
+end

data/generators/case_observer/templates/case_collection_observer_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class <%= observer_singular_class %>ObserverTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require "case_collection_observer"

data/lib/case_collection_observer.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/case_collection_observer/base"

data/lib/case_collection_observer/base.rb

@@ -0,0 +1,67 @@
+module CaseCollectionObserver
+  module Base
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+      end
+    end
+  
+    module InstanceMethods
+    end
+  
+    module ClassMethods
+      def has_many_with_observer(association_id, options = {}, &extension)
+        has_many association_id, case_observer_options(association_id, options), &extension
+        case_observer_callbacks(association_id)
+      end
+      
+      def has_and_belongs_to_many_with_observer(association_id, options = {}, &extension)
+        has_and_belongs_to_many association_id, case_observer_options(association_id, options), &extension
+        case_observer_callbacks(association_id)
+      end
+      
+      private
+        def case_observer_callbacks(association_id)
+          ["before_save_#{association_id}", "after_save_#{association_id}", 
+           "before_destroy_#{association_id}", "after_destroy_#{association_id}"].each do |method|
+             define_method method do |record|
+               self.class.changed
+               self.class.notify_observers(method, record)
+             end
+          end
+        end
+      
+        def case_observer_options(association_id, options = {})
+          callbacks = %w(before_add after_add before_remove after_remove)
+          callbacks.each do |callback_name|
+            new_callback = case callback_name.to_sym
+            when :before_add
+              "before_save_#{association_id}".to_sym
+            when :after_add
+              "after_save_#{association_id}".to_sym
+            when :before_remove
+              "before_destroy_#{association_id}".to_sym
+            when :after_remove
+              "after_destroy_#{association_id}".to_sym
+            end
+            if options[callback_name.to_sym]
+              defined_callbacks = options[callback_name.to_sym]
+              options[callback_name.to_sym] = [defined_callbacks, new_callback]
+            else
+              options[callback_name.to_sym] = new_callback
+            end
+          end
+          return options
+        end
+    end
+  end
+end
+
+if defined?(::ActiveRecord)
+  module ::ActiveRecord
+    class Base
+      include CaseCollectionObserver::Base
+    end
+  end
+end

data/lib/case_collection_observer/version.rb

@@ -0,0 +1,9 @@
+module CaseCollectionObserver
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/casecollectionobserver.rb

@@ -0,0 +1 @@
+require "case_collection_observer"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: SpiritSC-case_collection_observer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Szymon Czarnecki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple notifier for object in HM and HABTM associations in AR...
+email: spirit_sc@thinkdifferent.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README
+- lib/case_collection_observer.rb
+- lib/case_collection_observer/base.rb
+- lib/case_collection_observer/version.rb
+- lib/casecollectionobserver.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- generators/case_observer/USAGE
+- generators/case_observer/case_observer_generator.rb
+- generators/case_observer/templates/case_collection_observer.rb
+- generators/case_observer/templates/case_collection_observer_test.rb
+- init.rb
+- lib/case_collection_observer.rb
+- lib/case_collection_observer/base.rb
+- lib/case_collection_observer/version.rb
+- lib/casecollectionobserver.rb
+- case_collection_observer.gemspec
+has_rdoc: false
+homepage: http://github.com/SpiritSC/Case-Collection-Observer
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Case_collection_observer
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: case_collection_observer
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple notifier for object in HM and HABTM associations in AR...
+test_files: []
+