rails-observers 0.1.0

data/lib/rails/observers/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Observers
+    VERSION = "0.1.0"
+  end
+end

data/rails-observers.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails/observers/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rails-observers"
+  s.authors     = ["Rafael Mendonça França", "Steve Klabnik"]
+  s.email       = ["rafaelmfranca@gmail.com", "steve@steveklabnik.com"]
+  s.description = %q{Rails observer (removed from core in Rails 4.0)}
+  s.summary     = %q{ActiveModel::Observer, ActiveRecord::Observer and ActionController::Caching::Sweeper extracted from Rails.}
+  s.homepage    = "https://github.com/rails/rails-observers"
+  s.version     = Rails::Observers::VERSION
+
+  s.files         = [".gitignore","Gemfile","LICENSE","README.md","Rakefile","lib/generators/active_record/observer/observer_generator.rb","lib/generators/active_record/observer/templates/observer.rb","lib/generators/rails/observer/USAGE","lib/generators/rails/observer/observer_generator.rb","lib/generators/test_unit/observer/observer_generator.rb","lib/generators/test_unit/observer/templates/unit_test.rb","lib/rails-observers.rb","lib/rails/observers/action_controller/caching.rb","lib/rails/observers/action_controller/caching/sweeping.rb","lib/rails/observers/active_model/active_model.rb","lib/rails/observers/active_model/observer_array.rb","lib/rails/observers/active_model/observing.rb","lib/rails/observers/activerecord/active_record.rb","lib/rails/observers/activerecord/base.rb","lib/rails/observers/activerecord/observer.rb","lib/rails/observers/version.rb","rails-observers.gemspec","test/configuration_test.rb","test/console_test.rb","test/fixtures/developers.yml","test/fixtures/minimalistics.yml","test/fixtures/topics.yml","test/generators/generators_test_helper.rb","test/generators/namespaced_generators_test.rb","test/generators/observer_generator_test.rb","test/helper.rb","test/isolation/abstract_unit.rb","test/lifecycle_test.rb","test/models/observers.rb","test/observer_array_test.rb","test/observing_test.rb","test/rake_test.rb","test/sweeper_test.rb","test/transaction_callbacks_test.rb"]
+  s.test_files    = ["test/configuration_test.rb","test/console_test.rb","test/fixtures/developers.yml","test/fixtures/minimalistics.yml","test/fixtures/topics.yml","test/generators/generators_test_helper.rb","test/generators/namespaced_generators_test.rb","test/generators/observer_generator_test.rb","test/helper.rb","test/isolation/abstract_unit.rb","test/lifecycle_test.rb","test/models/observers.rb","test/observer_array_test.rb","test/observing_test.rb","test/rake_test.rb","test/sweeper_test.rb","test/transaction_callbacks_test.rb"]
+  s.executables   = []
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'railties', '~> 4.0.0.beta'
+
+  s.add_development_dependency 'minitest',     '>= 3'
+  s.add_development_dependency 'activerecord', '~> 4.0.0.beta'
+  s.add_development_dependency 'activemodel', '~> 4.0.0.beta'
+  s.add_development_dependency 'actionmailer', '~> 4.0.0.beta'
+  s.add_development_dependency 'actionpack', '~> 4.0.0.beta'
+  s.add_development_dependency 'sqlite3',      '~> 1.3'
+end

data/test/configuration_test.rb

@@ -0,0 +1,37 @@
+require 'isolation/abstract_unit'
+require 'rails-observers'
+
+class ConfigurationTest < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def setup
+    build_app
+    boot_rails
+    FileUtils.rm_rf("#{app_path}/config/environments")
+  end
+
+  def teardown
+    teardown_app
+  end
+
+  test "config.active_record.observers" do
+    add_to_config <<-RUBY
+      config.active_record.observers = :foo_observer
+    RUBY
+
+    app_file 'app/models/foo.rb', <<-RUBY
+      class Foo < ActiveRecord::Base
+      end
+    RUBY
+
+    app_file 'app/models/foo_observer.rb', <<-RUBY
+      class FooObserver < ActiveRecord::Observer
+      end
+    RUBY
+
+    require "#{app_path}/config/environment"
+
+    _ = ActiveRecord::Base
+    assert defined?(FooObserver)
+  end
+end

data/test/console_test.rb

@@ -0,0 +1,38 @@
+require 'isolation/abstract_unit'
+require 'rails-observers'
+
+class ConsoleTest < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def setup
+    build_app
+    boot_rails
+  end
+
+  def teardown
+    teardown_app
+  end
+
+  def load_environment
+    require "#{rails_root}/config/environment"
+    Rails.application.sandbox = false
+    Rails.application.load_console
+  end
+
+  def test_active_record_does_not_panic_when_referencing_an_observed_constant
+    add_to_config "config.active_record.observers = :user_observer"
+
+    app_file "app/models/user.rb", <<-MODEL
+      class User < ActiveRecord::Base
+      end
+    MODEL
+
+    app_file "app/models/user_observer.rb", <<-MODEL
+      class UserObserver < ActiveRecord::Observer
+      end
+    MODEL
+
+    load_environment
+    assert_nothing_raised { User }
+  end
+end

data/test/fixtures/developers.yml

@@ -0,0 +1,4 @@
+david:
+  id: 1
+  name: David
+  salary: 80000

data/test/fixtures/minimalistics.yml

@@ -0,0 +1,2 @@
+first:
+  id: 1

data/test/fixtures/topics.yml

@@ -0,0 +1,41 @@
+first:
+  id: 1
+  title: The First Topic
+  author_name: David
+  author_email_address: david@loudthinking.com
+  written_on: 2003-07-16t15:28:11.2233+01:00
+  last_read: 2004-04-15
+  bonus_time: 2005-01-30t15:28:00.00+01:00
+  content: Have a nice day
+  approved: false
+  replies_count: 1
+
+second:
+  id: 2
+  title: The Second Topic of the day
+  author_name: Mary
+  written_on: 2004-07-15t15:28:00.0099+01:00
+  content: Have a nice day
+  approved: true
+  replies_count: 0
+  parent_id: 1
+  type: Reply
+
+third:
+  id: 3
+  title: The Third Topic of the day
+  author_name: Carl
+  written_on: 2012-08-12t20:24:22.129346+00:00
+  content: I'm a troll
+  approved: true
+  replies_count: 1
+
+fourth:
+  id: 4
+  title: The Fourth Topic of the day
+  author_name: Carl
+  written_on: 2006-07-15t15:28:00.0099+01:00
+  content: Why not?
+  approved: true
+  type: Reply
+  parent_id: 3

data/test/generators/generators_test_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+
+require 'fileutils'
+
+require 'rails/all'
+require 'rails/generators'
+require 'rails/generators/test_case'
+
+module TestApp
+  class Application < Rails::Application
+  end
+end
+
+# Call configure to load the settings from
+# Rails.application.config.generators to Rails::Generators
+Rails.application.load_generators

data/test/generators/namespaced_generators_test.rb

@@ -0,0 +1,34 @@
+require 'generators/generators_test_helper'
+require 'generators/rails/observer/observer_generator'
+
+class NamespacedObserverGeneratorTest < Rails::Generators::TestCase
+  tests Rails::Generators::ObserverGenerator
+  arguments %w(account)
+  destination File.expand_path("../../tmp", __FILE__)
+
+  def setup
+    super
+    prepare_destination
+    Rails::Generators.namespace = TestApp
+  end
+
+  def teardown
+    super
+    Rails::Generators.namespace = nil
+  end
+
+  def test_invokes_default_orm
+    run_generator
+    assert_file "app/models/test_app/account_observer.rb", /module TestApp/, /  class AccountObserver < ActiveRecord::Observer/
+  end
+
+  def test_invokes_default_orm_with_class_path
+    run_generator ["admin/account"]
+    assert_file "app/models/test_app/admin/account_observer.rb", /module TestApp/, /  class Admin::AccountObserver < ActiveRecord::Observer/
+  end
+
+  def test_invokes_default_test_framework
+    run_generator
+    assert_file "test/unit/test_app/account_observer_test.rb", /module TestApp/, /  class AccountObserverTest < ActiveSupport::TestCase/
+  end
+end

data/test/generators/observer_generator_test.rb

@@ -0,0 +1,33 @@
+require 'generators/generators_test_helper'
+require 'generators/rails/observer/observer_generator'
+
+class ObserverGeneratorTest < Rails::Generators::TestCase
+  tests Rails::Generators::ObserverGenerator
+  destination File.expand_path("../../tmp", __FILE__)
+  arguments %w(account)
+
+  def setup
+    super
+    prepare_destination
+  end
+
+  def test_invokes_default_orm
+    run_generator
+    assert_file "app/models/account_observer.rb", /class AccountObserver < ActiveRecord::Observer/
+  end
+
+  def test_invokes_default_orm_with_class_path
+    run_generator ["admin/account"]
+    assert_file "app/models/admin/account_observer.rb", /class Admin::AccountObserver < ActiveRecord::Observer/
+  end
+
+  def test_invokes_default_test_framework
+    run_generator
+    assert_file "test/unit/account_observer_test.rb", /class AccountObserverTest < ActiveSupport::TestCase/
+  end
+
+  def test_logs_if_the_test_framework_cannot_be_found
+    content = run_generator ["account", "--test-framework=rspec"]
+    assert_match(/rspec \[not found\]/, content)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,74 @@
+require 'minitest/autorun'
+require 'active_record'
+
+require 'rails/observers/activerecord/active_record'
+
+FIXTURES_ROOT = File.expand_path(File.dirname(__FILE__)) + "/fixtures"
+
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+
+  self.fixture_path = FIXTURES_ROOT
+  self.use_instantiated_fixtures  = false
+  self.use_transactional_fixtures = true
+end
+
+ActiveRecord::Base.configurations = { "test" => { adapter: 'sqlite3', database: ':memory:' } }
+ActiveRecord::Base.establish_connection(:test)
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define do
+  create_table :topics do |t|
+    t.string   :title
+    t.string   :author_name
+    t.string   :author_email_address
+    t.datetime :written_on
+    t.time     :bonus_time
+    t.date     :last_read
+    t.text     :content
+    t.text     :important
+    t.boolean  :approved, :default => true
+    t.integer  :replies_count, :default => 0
+    t.integer  :parent_id
+    t.string   :parent_title
+    t.string   :type
+    t.string   :group
+    t.timestamps
+  end
+
+  create_table :comments do |t|
+    t.string :title
+  end
+
+  create_table :minimalistics do |t|
+  end
+
+  create_table :developers do |t|
+    t.string :name
+    t.integer :salary
+  end
+end
+
+class Topic < ActiveRecord::Base
+  has_many :replies, dependent: :destroy, foreign_key: "parent_id"
+end
+
+class Reply < Topic
+  belongs_to :topic, :foreign_key => "parent_id", :counter_cache => true
+end
+
+class Comment < ActiveRecord::Base
+  def self.lol
+    "lol"
+  end
+end
+
+class Developer < ActiveRecord::Base
+end
+
+class Minimalistic < ActiveRecord::Base
+end
+
+ActiveSupport::Deprecation.silence do
+  require 'active_record/test_case'
+end

data/test/isolation/abstract_unit.rb

@@ -0,0 +1,108 @@
+# Note:
+# It is important to keep this file as light as possible
+# the goal for tests that require this is to test booting up
+# rails from an empty state, so anything added here could
+# hide potential failures
+#
+# It is also good to know what is the bare minimum to get
+# Rails booted up.
+require 'fileutils'
+
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'active_support/test_case'
+
+# These files do not require any others and are needed
+# to run the tests
+require "active_support/testing/isolation"
+require "active_support/core_ext/kernel/reporting"
+require 'tmpdir'
+
+module TestHelpers
+  module Paths
+    def app_template_path
+      File.join Dir.tmpdir, 'app_template'
+    end
+
+    def tmp_path(*args)
+      @tmp_path ||= File.realpath(Dir.mktmpdir)
+      File.join(@tmp_path, *args)
+    end
+
+    def app_path(*args)
+      tmp_path(*%w[app] + args)
+    end
+
+    def rails_root
+      app_path
+    end
+  end
+
+  module Generation
+    # Build an application by invoking the generator and going through the whole stack.
+    def build_app(options = {})
+      @prev_rails_env = ENV['RAILS_ENV']
+      ENV['RAILS_ENV'] = 'development'
+
+      FileUtils.rm_rf(app_path)
+      FileUtils.cp_r(app_template_path, app_path)
+
+      # Delete the initializers unless requested
+      unless options[:initializers]
+        Dir["#{app_path}/config/initializers/*.rb"].each do |initializer|
+          File.delete(initializer)
+        end
+      end
+
+      unless options[:gemfile]
+        File.delete "#{app_path}/Gemfile"
+      end
+
+      routes = File.read("#{app_path}/config/routes.rb")
+      if routes =~ /(\n\s*end\s*)\Z/
+        File.open("#{app_path}/config/routes.rb", 'w') do |f|
+          f.puts $` + "\nmatch ':controller(/:action(/:id))(.:format)', :via => :all\n" + $1
+        end
+      end
+
+      add_to_config <<-RUBY
+        config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+        config.session_store :cookie_store, :key => "_myapp_session"
+        config.active_support.deprecation = :log
+        config.action_controller.allow_forgery_protection = false
+        config.eager_load = false
+      RUBY
+    end
+
+    def teardown_app
+      ENV['RAILS_ENV'] = @prev_rails_env if @prev_rails_env
+    end
+
+    def add_to_config(str)
+      environment = File.read("#{app_path}/config/application.rb")
+      if environment =~ /(\n\s*end\s*end\s*)\Z/
+        File.open("#{app_path}/config/application.rb", 'w') do |f|
+          f.puts $` + "\n#{str}\n" + $1
+        end
+      end
+    end
+
+    def app_file(path, contents)
+      FileUtils.mkdir_p File.dirname("#{app_path}/#{path}")
+      File.open("#{app_path}/#{path}", 'w') do |f|
+        f.puts contents
+      end
+    end
+
+    def boot_rails
+      require 'rubygems' unless defined? Gem
+      require 'bundler'
+      Bundler.setup
+    end
+  end
+end
+
+class ActiveSupport::TestCase
+  include TestHelpers::Paths
+  include TestHelpers::Generation
+end

data/test/lifecycle_test.rb

@@ -0,0 +1,249 @@
+require 'helper'
+
+class SpecialDeveloper < Developer; end
+
+class DeveloperObserver < ActiveRecord::Observer
+  def calls
+    @calls ||= []
+  end
+
+  def before_save(developer)
+    calls << developer
+  end
+end
+
+class SalaryChecker < ActiveRecord::Observer
+  observe :special_developer
+  attr_accessor :last_saved
+
+  def before_save(developer)
+    return developer.salary > 80000
+  end
+
+  module Implementation
+    def after_save(developer)
+      self.last_saved = developer
+    end
+  end
+  include Implementation
+end
+
+class TopicaAuditor < ActiveRecord::Observer
+  observe :topic
+
+  attr_reader :topic
+
+  def after_find(topic)
+    @topic = topic
+  end
+end
+
+class TopicObserver < ActiveRecord::Observer
+  attr_reader :topic
+
+  def after_find(topic)
+    @topic = topic
+  end
+
+  # Create an after_save callback, so a notify_observer hook is created
+  # on :topic.
+  def after_save(nothing)
+  end
+end
+
+class MinimalisticObserver < ActiveRecord::Observer
+  attr_reader :minimalistic
+
+  def after_find(minimalistic)
+    @minimalistic = minimalistic
+  end
+end
+
+class MultiObserver < ActiveRecord::Observer
+  attr_reader :record
+
+  def self.observed_class() [ Topic, Developer ] end
+
+  cattr_reader :last_inherited
+  @@last_inherited = nil
+
+  def observed_class_inherited_with_testing(subclass)
+    observed_class_inherited_without_testing(subclass)
+    @@last_inherited = subclass
+  end
+
+  alias_method_chain :observed_class_inherited, :testing
+
+  def after_find(record)
+    @record = record
+  end
+end
+
+class ValidatedComment < Comment
+  attr_accessor :callers
+
+  before_validation :record_callers
+
+  after_validation do
+    record_callers
+  end
+
+  def record_callers
+    callers << self.class if callers
+  end
+end
+
+class ValidatedCommentObserver < ActiveRecord::Observer
+  attr_accessor :callers
+
+  def after_validation(model)
+    callers << self.class if callers
+  end
+end
+
+
+class AroundTopic < Topic
+end
+
+class AroundTopicObserver < ActiveRecord::Observer
+  observe :around_topic
+  def topic_ids
+    @topic_ids ||= []
+  end
+
+  def around_save(topic)
+    topic_ids << topic.id
+    yield(topic)
+    topic_ids << topic.id
+  end
+end
+
+class LifecycleTest < ActiveRecord::TestCase
+  fixtures :topics, :developers, :minimalistics
+
+  def test_before_destroy
+    topic = Topic.find(1)
+    assert_difference 'Topic.count', -(1 + topic.replies.size) do
+      topic.destroy
+    end
+  end
+
+  def test_auto_observer
+    topic_observer = TopicaAuditor.instance
+    assert_nil TopicaAuditor.observed_class
+    assert_equal [Topic], TopicaAuditor.observed_classes.to_a
+
+    topic = Topic.find(1)
+    assert_equal topic.title, topic_observer.topic.title
+  end
+
+  def test_inferred_auto_observer
+    topic_observer = TopicObserver.instance
+    assert_equal Topic, TopicObserver.observed_class
+
+    topic = Topic.find(1)
+    assert_equal topic.title, topic_observer.topic.title
+  end
+
+  def test_observing_two_classes
+    multi_observer = MultiObserver.instance
+
+    topic = Topic.find(1)
+    assert_equal topic.title, multi_observer.record.title
+
+    developer = Developer.find(1)
+    assert_equal developer.name, multi_observer.record.name
+  end
+
+  def test_observing_subclasses
+    multi_observer = MultiObserver.instance
+
+    developer = SpecialDeveloper.find(1)
+    assert_equal developer.name, multi_observer.record.name
+
+    klass = Class.new(Developer)
+    assert_equal klass, multi_observer.last_inherited
+
+    developer = klass.find(1)
+    assert_equal developer.name, multi_observer.record.name
+  end
+
+  def test_after_find_can_be_observed_when_its_not_defined_on_the_model
+    observer = MinimalisticObserver.instance
+    assert_equal Minimalistic, MinimalisticObserver.observed_class
+
+    minimalistic = Minimalistic.find(1)
+    assert_equal minimalistic, observer.minimalistic
+  end
+
+  def test_after_find_can_be_observed_when_its_defined_on_the_model
+    observer = TopicObserver.instance
+    assert_equal Topic, TopicObserver.observed_class
+
+    topic = Topic.find(1)
+    assert_equal topic, observer.topic
+  end
+
+  def test_invalid_observer
+    assert_raise(ArgumentError) { Topic.observers = Object.new; Topic.instantiate_observers }
+  end
+
+  test "model callbacks fire before observers are notified" do
+    callers = []
+
+    comment = ValidatedComment.new
+    comment.callers = ValidatedCommentObserver.instance.callers = callers
+
+    comment.valid?
+    assert_equal [ValidatedComment, ValidatedComment, ValidatedCommentObserver], callers,
+      "model callbacks did not fire before observers were notified"
+  end
+
+  test "able to save developer" do
+    SalaryChecker.instance # activate
+    developer = SpecialDeveloper.new :name => 'Roger', :salary => 100000
+    assert developer.save, "developer with normal salary failed to save"
+  end
+
+  test "unable to save developer with low salary" do
+    SalaryChecker.instance # activate
+    developer = SpecialDeveloper.new :name => 'Rookie', :salary => 50000
+    assert !developer.save, "allowed to save a developer with too low salary"
+  end
+
+  test "able to call methods defined with included module" do # https://rails.lighthouseapp.com/projects/8994/tickets/6065-activerecordobserver-is-not-aware-of-method-added-by-including-modules
+    SalaryChecker.instance # activate
+    developer = SpecialDeveloper.create! :name => 'Roger', :salary => 100000
+    assert_equal developer, SalaryChecker.instance.last_saved
+  end
+
+  test "around filter from observer should accept block" do
+    observer = AroundTopicObserver.instance
+    topic = AroundTopic.new
+    topic.save
+    assert_nil observer.topic_ids.first
+    assert_not_nil observer.topic_ids.last
+  end
+
+  test "able to disable observers" do
+    observer = DeveloperObserver.instance # activate
+    observer.calls.clear
+
+    ActiveRecord::Base.observers.disable DeveloperObserver do
+      Developer.create! :name => 'Ancestor', :salary => 100000
+      SpecialDeveloper.create! :name => 'Descendent', :salary => 100000
+    end
+
+    assert_equal [], observer.calls
+  end
+
+  def test_observer_is_called_once
+    observer = DeveloperObserver.instance # activate
+    observer.calls.clear
+
+    developer = Developer.create! :name => 'Ancestor', :salary => 100000
+    special_developer = SpecialDeveloper.create! :name => 'Descendent', :salary => 100000
+
+    assert_equal [developer, special_developer], observer.calls
+  end
+end