lazy_observers 0.0.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Appraisals

@@ -0,0 +1,12 @@
+appraise "rails-2.3" do
+  gem "activerecord", "~> 2.3.6", :require => "active_record"
+end
+
+appraise "rails-3.0" do
+  gem "activerecord", "~> 3.0.15", :require => "active_record"
+end
+
+appraise "rails-3.2" do
+  gem "activerecord", "~> 3.2.6", :require => "active_record"
+end
+

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2'
+gem 'sqlite3'
+gem 'appraisal'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    lazy_observers (0.0.1)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  lazy_observers!
+  rake
+  rspec (~> 2)
+  sqlite3

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'appraisal'
+
+task :spec do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/lazy_observers/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end
+
+task :default do
+  sh "bundle exec rake appraisal:install && bundle exec rake appraisal spec"
+end

data/Readme.md

@@ -0,0 +1,52 @@
+Make Activerecord Observers not load observed models -> faster/safer environment boot.
+ - faster tests + console
+ - able to boot environment without/with empty/with old database
+
+Works on rails 2.3 + 3.0 (not 3.2)
+
+Install
+=======
+
+    gem install lazy_observers
+
+Usage
+=====
+
+    class FooObserver < ActiveRecord::Observer
+      lazy_observe "User", "Foo::Bar"
+
+      ...
+    end
+
+### Extend models from gems after they are loaded
+
+    LazyObservers.on_load("Arturo::Feature") do |klass|
+      Arturo::Feature.class_eval do
+        ... funky hacks ...
+      end
+    end
+
+### Catch models that are loaded in application startup.
+
+    LazyObservers.debug_active_record_loading
+
+`script/console` or `rails c`
+
+### Verify you did not misspell
+Loads all classes registered via observers, to make sure you did not misspell</br>
+(negates the effect of lazyness, so only use for debugging)
+
+
+    LazyObservers.check_classes
+
+
+# TODO
+ - Rails 3.0: does not work for models that are loaded before the observers
+ - Rails 3.2: blows up
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/lazy_observers.png)](http://travis-ci.org/grosser/lazy_observers)

data/gemfiles/rails-2.3.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "appraisal"
+gem "activerecord", "~> 2.3.6", :require=>"active_record"
+
+gemspec :path=>"../"

data/gemfiles/rails-2.3.gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: /Users/mgrosser/code/tools/lazy_observers
+  specs:
+    lazy_observers (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.6)
+  appraisal
+  lazy_observers!
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/rails-3.0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "appraisal"
+gem "activerecord", "~> 3.0.15", :require=>"active_record"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.0.gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: /Users/mgrosser/code/tools/lazy_observers
+  specs:
+    lazy_observers (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.15)
+      activesupport (= 3.0.15)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.15)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
+    i18n (0.5.0)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.15)
+  appraisal
+  lazy_observers!
+  rake
+  rspec (~> 2)
+  sqlite3

data/gemfiles/rails-3.2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "rake"
+gem "rspec", "~>2"
+gem "sqlite3"
+gem "appraisal"
+gem "activerecord", "~> 3.2.6", :require=>"active_record"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.2.gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: /Users/mgrosser/code/tools/lazy_observers
+  specs:
+    lazy_observers (0.0.0)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.2.6)
+  appraisal
+  lazy_observers!
+  rake
+  rspec (~> 2)
+  sqlite3

data/lazy_observers.gemspec

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+name = "lazy_observers"
+require "#{name}/version"
+
+Gem::Specification.new name, LazyObservers::VERSION do |s|
+  s.summary = "Makes Activerecord Observers lazy, do not load model on startup and only listen once a model got loaded."
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
+  s.add_runtime_dependency "activerecord"
+end

data/lib/lazy_observers.rb

@@ -0,0 +1,83 @@
+require 'lazy_observers/version'
+require 'active_record'
+require 'active_record/observer'
+
+module LazyObservers
+  def self.register_observed(klass)
+    class_name = klass.name
+    loaded << [klass, class_name]
+    observers.each do |observer, observed|
+      connect!(observer, klass) if observed.include?(class_name)
+    end
+    (on_loads[class_name]||[]).each{|block| block.call(klass) }
+  end
+
+  def self.register_observer(observer, classes)
+    observers[observer] = classes
+    loaded.each do |klass, name|
+      connect!(observer, klass) if classes.include?(name)
+    end
+  end
+
+  def self.on_load(class_name, &block)
+    on_loads[class_name] ||= []
+    on_loads[class_name] << block
+  end
+
+  # to check you did not specify a class that does not exist
+  def self.check_classes
+    observers.values.flatten.uniq.each { |klass| klass.constantize }
+  end
+
+  def self.debug_active_record_loading
+    ActiveRecord::Base.send(:extend, LazyObservers::InheritedDebugger)
+  end
+
+  private
+
+  def self.on_loads
+    @on_loads ||= {}
+  end
+
+  def self.observers
+    @observers ||= {}
+  end
+
+  def self.loaded
+    @loaded ||= []
+  end
+
+  def self.connect!(observer, klass)
+    observer.instance.observed_class_inherited(klass)
+  end
+end
+
+ActiveRecord::Base.send(:subclasses).each{|klass| LazyObservers.register_observed(klass) }
+
+ActiveRecord::Observer.class_eval do
+  def self.lazy_observe(*classes)
+    raise "pass class names, not classes or symbols!" unless classes.all?{|klass| klass.is_a?(String) }
+    define_method(:observed_classes) { Set.new }
+    LazyObservers.register_observer self, classes
+  end
+end
+
+module LazyObservers
+  module InheritedNotifier
+    def inherited(subclass)
+      LazyObservers.register_observed subclass
+      super
+    end
+  end
+
+  module InheritedDebugger
+    def inherited(subclass)
+      puts subclass
+      puts caller
+      puts "-" * 72
+      super
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, LazyObservers::InheritedNotifier)

data/lib/lazy_observers/version.rb

@@ -0,0 +1,3 @@
+module LazyObservers
+  VERSION = '0.0.1'
+end

data/spec/app/groups.rb

@@ -0,0 +1,5 @@
+class Group < ActiveRecord::Base
+end
+
+class InheritedGroup < Group
+end

data/spec/app/inherited_movie.rb

@@ -0,0 +1,2 @@
+class InheritedMovie < Movie
+end

data/spec/app/movie.rb

@@ -0,0 +1,2 @@
+class Movie < ActiveRecord::Base
+end

data/spec/app/movie_observer.rb

@@ -0,0 +1,19 @@
+class MovieObserver < ActiveRecord::Observer
+  lazy_observe "Movie"
+
+  def called
+    @called ||= []
+  end
+
+  def after_update(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_save(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_create(*args)
+    @called << [:after_create, args]
+  end
+end

data/spec/app/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/app/post_observer.rb

@@ -0,0 +1,19 @@
+class PostObserver < ActiveRecord::Observer
+  lazy_observe "Post"
+
+  def called
+    @called ||= []
+  end
+
+  def after_update(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_save(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_create(*args)
+    @called << [:after_create, args]
+  end
+end

data/spec/app/product_observer.rb

@@ -0,0 +1,19 @@
+class ProductObserver < ActiveRecord::Observer
+  lazy_observe "Product"
+
+  def called
+    @called ||= []
+  end
+
+  def after_update(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_save(*args)
+    @called << [:after_update, args]
+  end
+
+  def after_create(*args)
+    @called << [:after_create, args]
+  end
+end

data/spec/app/products.rb

@@ -0,0 +1,5 @@
+class Product < ActiveRecord::Base
+end
+
+class InheritedProduct < Product
+end

data/spec/app/stupid_observer.rb

@@ -0,0 +1,3 @@
+class StupidObserver < ActiveRecord::Observer
+  lazy_observe Movie
+end

data/spec/app/user_observer.rb

@@ -0,0 +1,3 @@
+class UserObserver < ActiveRecord::Observer
+  lazy_observe "User"
+end

data/spec/database.rb

@@ -0,0 +1,29 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:",
+)
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+  end
+
+  create_table :posts do |t|
+    t.string :title
+  end
+
+  create_table :movies do |t|
+    t.string :title
+  end
+
+  create_table :products do |t|
+    t.string :title
+  end
+
+  create_table :groups do |t|
+    t.string :name
+  end
+end

data/spec/lazy_observers_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+require File.expand_path("../app/user_observer", __FILE__)
+require File.expand_path("../app/post_observer", __FILE__)
+require File.expand_path("../app/product_observer", __FILE__)
+
+describe LazyObservers do
+  it "has a VERSION" do
+    LazyObservers::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  it "does not load models when being loaded" do
+    defined?(UserObserver).should == "constant"
+    UserObserver.instance
+    defined?(User).should == nil
+  end
+
+  it "makes the observer observe nothing" do
+    PostObserver.instance.observed_classes.should == Set.new
+  end
+
+  it "listens to events after models are loaded" do
+    PostObserver.instance.called.should == []
+    defined?(Post).should == nil
+    require File.expand_path("../app/post", __FILE__)
+    post = Post.create!
+    PostObserver.instance.called.should == [[:after_create, [post]], [:after_update, [post]]]
+  end
+
+  it "listens to events if models are loaded before observer" do
+    defined?(MovieObserver).should == nil
+    require File.expand_path("../app/movie_observer", __FILE__)
+    MovieObserver.instance.called.should == []
+    movie = Movie.create!
+    MovieObserver.instance.called.should == [[:after_create, [movie]], [:after_update, [movie]]]
+  end
+
+  it "observes inherited classes" do
+    defined?(Product).should == nil
+    defined?(InheritedProduct).should == nil
+    require File.expand_path("../app/products", __FILE__)
+
+    # no duplicates (sets are weirdly nested :/ )
+    ProductObserver.instance.observed_classes.map{|x| x.is_a?(Set) ? x.to_a : x }.flatten.map{|x| x.is_a?(Set) ? x.to_a : x }.flatten.should == [Product, InheritedProduct]
+
+    # for inherited
+    ProductObserver.instance.called.should == []
+    product = InheritedProduct.create!
+    ProductObserver.instance.called.should == [[:after_create, [product]], [:after_update, [product]]]
+
+    ProductObserver.instance.called.clear
+
+    # for normal
+    ProductObserver.instance.called.should == []
+    product = Product.create!
+    ProductObserver.instance.called.should == [[:after_create, [product]], [:after_update, [product]]]
+  end
+
+  it "blows up when you pass it a class, since this means you did not understand the concept" do
+    expect{
+      require File.expand_path("../app/stupid_observer", __FILE__)
+    }.to raise_error(/not classes or symbols/i)
+  end
+
+  it "calls callback when matching class is loaded" do
+    loaded = []
+    LazyObservers.on_load("Group") do |klass|
+      loaded << klass
+    end
+    require File.expand_path("../app/groups", __FILE__)
+    loaded.should == [Group]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.expand_path("../database", __FILE__)
+
+$LOAD_PATH.unshift 'lib'
+
+# movie is used to test that things loaded before lazy_observers also gets observed
+raise if defined?(Movie)
+raise if defined?(LazyObservers.loaded)
+require File.expand_path("../app/movie", __FILE__)
+require "lazy_observers"
+raise unless defined?(LazyObservers.loaded)

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: lazy_observers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- gemfiles/rails-2.3.gemfile
+- gemfiles/rails-2.3.gemfile.lock
+- gemfiles/rails-3.0.gemfile
+- gemfiles/rails-3.0.gemfile.lock
+- gemfiles/rails-3.2.gemfile
+- gemfiles/rails-3.2.gemfile.lock
+- lazy_observers.gemspec
+- lib/lazy_observers.rb
+- lib/lazy_observers/version.rb
+- spec/app/groups.rb
+- spec/app/inherited_movie.rb
+- spec/app/movie.rb
+- spec/app/movie_observer.rb
+- spec/app/post.rb
+- spec/app/post_observer.rb
+- spec/app/product_observer.rb
+- spec/app/products.rb
+- spec/app/stupid_observer.rb
+- spec/app/user_observer.rb
+- spec/database.rb
+- spec/lazy_observers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/lazy_observers
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3828034774033645633
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3828034774033645633
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Makes Activerecord Observers lazy, do not load model on startup and only
+  listen once a model got loaded.
+test_files: []