rails-observers 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ebf1dea2a2c82e54123428320e6685c5765da02
-  data.tar.gz: 52ef78d1ccb52ed81cd43e91d582b18976f18123
+  metadata.gz: b392355135b13b4df763c2abc659d165e20b6e45
+  data.tar.gz: 2c18a08fed97bde7a943dd69c17c8a627b3ef459
 SHA512:
-  metadata.gz: c2465a6f154cd1de2b3439333d2abc2719db0dd0a3294779e09df4caf31f37b66fe61a4ae0622a558011bd6e96a383a243814ee7afee059649aac335cbd24f7f
-  data.tar.gz: ee0dd0aca9d35994d059e92341861319ca4aab3aa00ae104b19e28d94a646798163fb926f00fbe5e5eb177bf1598d331e4e3ceb19eda161323fc0b151c1a4a02
+  metadata.gz: b724b5ac60c875bece3c11557d5f33c166307184ce3bfd4dde182eea4d22cef0b69db6847db9e0d884a7a37a551b302570ca4f1e2dad403d956f8ddac1f8d3a3
+  data.tar.gz: 1b62e5a3d11ee66f5fa4e1c4fe0e40ce25a6779c538e0d32151933cb7b8a7d5527994d08a444acc0b9a4c5bc8ee8761992a7554fd6d340060900528d19283d07

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Steve Klabnik, Rafael Mendonça França
+Copyright (c) 2012-2016 Steve Klabnik, Rafael Mendonça França
 
 MIT License
 

data/README.md

@@ -6,9 +6,9 @@ Rails Observers (removed from core in Rails 4.0)
 ## Installation
 
 Add this line to your application's Gemfile:
-
-    gem 'rails-observers'
-
+```ruby
+gem 'rails-observers'
+```
 And then execute:
 
     $ bundle
@@ -30,7 +30,8 @@ Observer classes respond to life cycle callbacks to implement trigger-like
 behavior outside the original class. This is a great way to reduce the
 clutter that normally comes when the model class is burdened with
 functionality that doesn't pertain to the core responsibility of the
-class. Example:
+class. Observers are put in `app/models` (e.g.
+`app/models/comment_observer.rb`). Example:
 
 ```ruby
 class CommentObserver < ActiveRecord::Observer
@@ -56,16 +57,31 @@ end
 
 This Observer uses logger to log when specific callbacks are triggered.
 
-Please note that observers are called in the order that they are defined. That means that callbacks in an observer
+The convention is to name observers after the class they observe. If you
+absolutely need to override this, or want to use one observer for several
+classes, use `observe`:
+
+```ruby
+class NotificationsObserver < ActiveRecord::Observer
+  observe :comment, :like
+
+  def after_create(record)
+    # notifiy users of new comment or like
+  end
+
+end
+```
+
+Please note that observers are called in the order that they are defined. This means that callbacks in an observer
 will always be called *after* callbacks defined in the model itself. Likewise, `has_one` and `has_many`
-use callbacks to enforce `:dependent => :destroy`. Therefore, associated records will be destroyed before
-the observer's `before_destory` is called.
+use callbacks to enforce `dependent: :destroy`. Therefore, associated records will be destroyed before
+the observer's `before_destroy` is called.
 
 For an observer to be active, it must be registered first. This can be done by adding the following line into the `application.rb`:
 
     config.active_record.observers = :contact_observer
 
-Obeservers can also be registered on an environment-specific basis by simply using the corresponding environment's configuration file instead of `application.rb`.
+Observers can also be registered on an environment-specific basis by simply using the corresponding environment's configuration file instead of `application.rb`.
 
 ### Action Controller Sweeper
 
@@ -78,9 +94,9 @@ class ListSweeper < ActionController::Caching::Sweeper
 
   def after_save(record)
     list = record.is_a?(List) ? record : record.list
-    expire_page(:controller => "lists", :action => %w( show public feed ), :id => list.id)
-    expire_action(:controller => "lists", :action => "all")
-    list.shares.each { |share| expire_page(:controller => "lists", :action => "show", :id => share.url_key) }
+    expire_page(controller: "lists", action: %w( show public feed ), id: list.id)
+    expire_action(controller: "lists", action: "all")
+    list.shares.each { |share| expire_page(controller: "lists", action: "show", id: share.url_key) }
   end
 end
 ```
@@ -90,7 +106,7 @@ The sweeper is assigned in the controllers that wish to have its job performed u
 ```ruby
 class ListsController < ApplicationController
   caches_action :index, :show, :public, :feed
-  cache_sweeper :list_sweeper, :only => [ :edit, :destroy, :share ]
+  cache_sweeper :list_sweeper, only: [ :edit, :destroy, :share ]
 end
 ```
 
@@ -101,7 +117,7 @@ You can also name an explicit class in the declaration of a sweeper, which is ne
 ```ruby
 class ListsController < ApplicationController
   caches_action :index, :show, :public, :feed
-  cache_sweeper OpenBar::Sweeper, :only => [ :edit, :destroy, :share ]
+  cache_sweeper OpenBar::Sweeper, only: [ :edit, :destroy, :share ]
 end
 ```
 

data/lib/rails/observers/action_controller/caching/sweeper.rb

@@ -0,0 +1,61 @@
+module ActionController #:nodoc:
+  module Caching
+    class Sweeper < ActiveRecord::Observer #:nodoc:
+      attr_accessor :controller
+
+      def initialize(*args)
+        super
+        @controller = nil
+      end
+
+      def before(controller)
+        self.controller = controller
+        callback(:before) if controller.perform_caching
+        true # before method from sweeper should always return true
+      end
+
+      def after(controller)
+        self.controller = controller
+        callback(:after) if controller.perform_caching
+      end
+
+      def around(controller)
+        before(controller)
+        yield
+        after(controller)
+      ensure
+        clean_up
+      end
+
+      protected
+      # gets the action cache path for the given options.
+      def action_path_for(options)
+        Actions::ActionCachePath.new(controller, options).path
+      end
+
+      # Retrieve instance variables set in the controller.
+      def assigns(key)
+        controller.instance_variable_get("@#{key}")
+      end
+
+      private
+      def clean_up
+        # Clean up, so that the controller can be collected after this request
+        self.controller = nil
+      end
+
+      def callback(timing)
+        controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
+        action_callback_method_name     = "#{controller_callback_method_name}_#{controller.action_name}"
+
+        __send__(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
+        __send__(action_callback_method_name)     if respond_to?(action_callback_method_name, true)
+      end
+
+      def method_missing(method, *arguments, &block)
+        return super unless @controller
+        @controller.__send__(method, *arguments, &block)
+      end
+    end
+  end
+end

data/lib/rails/observers/action_controller/caching/sweeping.rb

@@ -39,9 +39,9 @@ module ActionController #:nodoc:
             sweeper_instance = (sweeper.is_a?(Symbol) ? Object.const_get(sweeper.to_s.classify) : sweeper).instance
 
             if sweeper_instance.is_a?(Sweeper)
-              around_filter(sweeper_instance, :only => configuration[:only])
+              around_action(sweeper_instance, :only => configuration[:only])
             else
-              after_filter(sweeper_instance, :only => configuration[:only])
+              after_action(sweeper_instance, :only => configuration[:only])
             end
           end
         end
@@ -49,63 +49,7 @@ module ActionController #:nodoc:
     end
 
     if defined?(ActiveRecord) and defined?(ActiveRecord::Observer)
-      class Sweeper < ActiveRecord::Observer #:nodoc:
-        attr_accessor :controller
-
-        def initialize(*args)
-          super
-          @controller = nil
-        end
-
-        def before(controller)
-          self.controller = controller
-          callback(:before) if controller.perform_caching
-          true # before method from sweeper should always return true
-        end
-
-        def after(controller)
-          self.controller = controller
-          callback(:after) if controller.perform_caching
-        end
-
-        def around(controller)
-          before(controller)
-          yield
-          after(controller)
-        ensure
-          clean_up
-        end
-
-        protected
-        # gets the action cache path for the given options.
-        def action_path_for(options)
-          Actions::ActionCachePath.new(controller, options).path
-        end
-
-        # Retrieve instance variables set in the controller.
-        def assigns(key)
-          controller.instance_variable_get("@#{key}")
-        end
-
-        private
-        def clean_up
-          # Clean up, so that the controller can be collected after this request
-          self.controller = nil
-        end
-
-        def callback(timing)
-          controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
-          action_callback_method_name     = "#{controller_callback_method_name}_#{controller.action_name}"
-
-          __send__(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
-          __send__(action_callback_method_name)     if respond_to?(action_callback_method_name, true)
-        end
-
-        def method_missing(method, *arguments, &block)
-          return super unless @controller
-          @controller.__send__(method, *arguments, &block)
-        end
-      end
+      require 'rails/observers/action_controller/caching/sweeper'
     end
   end
 end

data/lib/rails/observers/action_controller/caching.rb

@@ -3,7 +3,7 @@ module ActionController #:nodoc:
     extend ActiveSupport::Autoload
 
     eager_autoload do
-      autoload :Sweeper,  'rails/observers/action_controller/caching/sweeping'
+      autoload :Sweeper,  'rails/observers/action_controller/caching/sweeper'
       autoload :Sweeping, 'rails/observers/action_controller/caching/sweeping'
     end
 

data/lib/rails/observers/active_resource/observing.rb

@@ -0,0 +1,41 @@
+require 'rails/observers/active_model/observing'
+
+module ActiveResource
+  module Observing
+    def self.prepended(context)
+      context.include ActiveModel::Observing
+    end
+
+    def create(*)
+      notify_observers(:before_create)
+      if result = super
+        notify_observers(:after_create)
+      end
+      result
+    end
+
+    def save(*)
+      notify_observers(:before_save)
+      if result = super
+        notify_observers(:after_save)
+      end
+      result
+    end
+
+    def update(*)
+      notify_observers(:before_update)
+      if result = super
+        notify_observers(:after_update)
+      end
+      result
+    end
+
+    def destroy(*)
+      notify_observers(:before_destroy)
+      if result = super
+        notify_observers(:after_destroy)
+      end
+      result
+    end
+  end
+end

data/lib/rails/observers/activerecord/observer.rb

@@ -123,3 +123,7 @@ module ActiveRecord
       end
   end
 end
+
+if defined?(ActionController) and defined?(ActionController::Caching::Sweeping)
+  require 'rails/observers/action_controller/caching/sweeper'
+end

data/lib/rails/observers/railtie.rb

@@ -6,10 +6,8 @@ module Rails
       initializer "active_record.observer", :before => "active_record.set_configs" do |app|
         ActiveSupport.on_load(:active_record) do
           require "rails/observers/activerecord/active_record"
-
-          if observers = app.config.respond_to?(:active_record) && app.config.active_record.delete(:observers)
-            send :observers=, observers
-          end
+          observers = app.config.active_record.delete(:observers)
+          self.observers = observers if observers
         end
       end
 
@@ -19,14 +17,46 @@ module Rails
         end
       end
 
+      initializer "active_resource.observer" do |app|
+        ActiveSupport.on_load(:active_resource) do
+          require 'rails/observers/active_resource/observing'
+
+          prepend ActiveResource::Observing
+        end
+      end
+
       config.after_initialize do |app|
+        begin
+          # Eager load `ActiveRecord::Base` to avoid circular references when
+          # loading a constant for the first time.
+          #
+          # E.g. loading a `User` model that references `ActiveRecord::Base`
+          # which calls `instantiate_observers` to instantiate a `UserObserver`
+          # which eventually calls `observed_class` thus constantizing `"User"`,
+          # the class we're loading. 💣💥
+          require "active_record/base"
+        rescue LoadError
+        end
+
         ActiveSupport.on_load(:active_record) do
           ActiveRecord::Base.instantiate_observers
 
-          ActionDispatch::Reloader.to_prepare do
+          # Rails 5.1 forward-compat. AD::R is deprecated to AS::R in Rails 5.
+          reloader = defined?(ActiveSupport::Reloader) ? ActiveSupport::Reloader : ActionDispatch::Reloader
+          reloader.to_prepare do
             ActiveRecord::Base.instantiate_observers
           end
         end
+
+        ActiveSupport.on_load(:active_resource) do
+          self.instantiate_observers
+
+          # Rails 5.1 forward-compat. AD::R is deprecated to AS::R in Rails 5.
+          reloader = defined?(ActiveSupport::Reloader) ? ActiveSupport::Reloader : ActionDispatch::Reloader
+          reloader.to_prepare do
+            ActiveResource::Base.instantiate_observers
+          end
+        end
       end
     end
   end

data/lib/rails/observers/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Observers
-    VERSION = "0.1.2"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-observers
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Rafael Mendonça França
@@ -9,104 +9,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 description: Rails observer (removed from core in Rails 4.0)
@@ -117,12 +131,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- 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
@@ -131,37 +141,21 @@ files:
 - 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/sweeper.rb
 - lib/rails/observers/action_controller/caching/sweeping.rb
 - lib/rails/observers/active_model.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/active_resource/observing.rb
 - lib/rails/observers/activerecord/active_record.rb
 - lib/rails/observers/activerecord/base.rb
 - lib/rails/observers/activerecord/observer.rb
 - lib/rails/observers/railtie.rb
 - lib/rails/observers/version.rb
-- rails-observers.gemspec
-- rails-observers.gemspec.erb
-- 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
 homepage: https://github.com/rails/rails-observers
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -169,36 +163,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: ActiveModel::Observer, ActiveRecord::Observer and ActionController::Caching::Sweeper
   extracted from Rails.
-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
+test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.ruby-version

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
- - 1.9.3
-before_install: gem install bundler
-script: bundle exec rake test
-notifications:
-  email: false
-  irc:
-    on_success: change
-    on_failure: always
-    channels:
-      - "irc.freenode.org#rails-contrib"

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in active_record-observers.gemspec
-gemspec
-
-gem 'activerecord-deprecated_finders'
-
-gem 'mocha', require: false