mongoid-audit 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16dc7230bd554ec94129e00a7396c4809814ef4e
-  data.tar.gz: 53ac0d33d6703176078ba5210e908763f1eb71eb
+  metadata.gz: 50bb3934bb4dae8960bb1513eee0c969db1c5984
+  data.tar.gz: 17bc52f155696941b1f9136eeafbb455e30232d2
 SHA512:
-  metadata.gz: c05c11c7d6e1e196a71d1ce1381790f5d2d470a550bda13ea535f36e18532a3c802c91a9c9ea542c5d9f9ae1444d9da743950f7053fda6501730ff6ce0ea4e8d
-  data.tar.gz: 4c15da80af5fb5c54758561eefb17ef4bf2b2c05ec7b86dabcdbe92027fa09a63585cd39e9c05b2a3c7ec5b355db2feaed798349a4952f43100374b5d04bf5ef
+  metadata.gz: 5926f65b34af90012152b9645f4f51a4a35fba2aac2c7369ce65a420880263e7773c3c05699cfbfce4a91788d5a5d09d25df3317bffb289e820076901d1fef82
+  data.tar.gz: 32ec2981cb51c405128b6858a63f4ee322b9baf7c11e25690606c4705a0955b7a0a157f8119f05ad57c04ed345ca8831b64ed08f6e3f94f1dc2619fe916d01c0

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid-audit

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/lib/mongoid-audit/mongoid_observer.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+module Mongoid
+
+  # 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. Mongoid's observers work similar to ActiveRecord's. Example:
+  #
+  #   class CommentObserver < Mongoid::Observer
+  #     def after_save(comment)
+  #       Notifications.comment(
+  #         "admin@do.com", "New comment was posted", comment
+  #       ).deliver
+  #     end
+  #   end
+  #
+  # This Observer sends an email when a Comment#save is finished.
+  #
+  #   class ContactObserver < Mongoid::Observer
+  #     def after_create(contact)
+  #       contact.logger.info('New contact added!')
+  #     end
+  #
+  #     def after_destroy(contact)
+  #       contact.logger.warn("Contact with an id of #{contact.id} was destroyed!")
+  #     end
+  #   end
+  #
+  # This Observer uses logger to log when specific callbacks are triggered.
+  #
+  # == Observing a class that can't be inferred
+  #
+  # Observers will by default be mapped to the class with which they share a
+  # name. So CommentObserver will be tied to observing Comment,
+  # ProductManagerObserver to ProductManager, and so on. If you want to
+  # name your observer differently than the class you're interested in
+  # observing, you can use the Observer.observe class method which takes
+  # either the concrete class (Product) or a symbol for that class (:product):
+  #
+  #   class AuditObserver < Mongoid::Observer
+  #     observe :account
+  #
+  #     def after_update(account)
+  #       AuditTrail.new(account, "UPDATED")
+  #     end
+  #   end
+  #
+  # If the audit observer needs to watch more than one kind of object,
+  # this can be specified with multiple arguments:
+  #
+  #   class AuditObserver < Mongoid::Observer
+  #     observe :account, :balance
+  #
+  #     def after_update(record)
+  #       AuditTrail.new(record, "UPDATED")
+  #     end
+  #   end
+  #
+  # The AuditObserver will now act on both updates to Account and Balance
+  # by treating them both as records.
+  #
+  # == Available callback methods
+  #
+  # * after_initialize
+  # * before_validation
+  # * after_validation
+  # * before_create
+  # * around_create
+  # * after_create
+  # * before_update
+  # * around_update
+  # * after_update
+  # * before_upsert
+  # * around_upsert
+  # * after_upsert
+  # * before_save
+  # * around_save
+  # * after_save
+  # * before_destroy
+  # * around_destroy
+  # * after_destroy
+  #
+  # == Storing Observers in Rails
+  #
+  # If you're using Mongoid within Rails, observer classes are usually stored
+  # in +app/models+ with the naming convention of +app/models/audit_observer.rb+.
+  #
+  # == Configuration
+  #
+  # In order to activate an observer, list it in the +config.mongoid.observers+
+  # configuration setting in your +config/application.rb+ file.
+  #
+  #   config.mongoid.observers = :comment_observer, :signup_observer
+  #
+  # Observers will not be invoked unless you define them in your
+  # application configuration.
+  #
+  # == Loading
+  #
+  # Observers register themselves with the model class that they observe,
+  # since it is the class that notifies them of events when they occur.
+  # As a side-effect, when an observer is loaded, its corresponding model
+  # class is loaded.
+  #
+  # Observers are loaded after the application initializers, so that
+  # observed models can make use of extensions. If by any chance you are
+  # using observed models in the initialization, you can
+  # still load their observers by calling +ModelObserver.instance+ before.
+  # Observers are singletons and that call instantiates and registers them.
+  class Observer < ActiveModel::Observer
+
+    private
+
+    # Adds the specified observer to the class.
+    #
+    # @example Add the observer.
+    #   observer.add_observer!(Document)
+    #
+    # @param [ Class ] klass The child observer to add.
+    #
+    # @since 2.0.0.rc.8
+    def add_observer!(klass)
+      super
+      define_callbacks(klass)
+    end
+
+    # Defines all the callbacks for each observer of the model.
+    #
+    # @example Define all the callbacks.
+    #   observer.define_callbacks(Document)
+    #
+    # @param [ Class ] klass The model to define them on.
+    #
+    # @since 2.0.0.rc.8
+    def define_callbacks(klass)
+      observer = self
+      observer_name = observer.class.name.underscore.gsub('/', '__')
+      Mongoid::Callbacks.observables.each do |callback|
+        next unless respond_to?(callback)
+        callback_meth = :"_notify_#{observer_name}_for_#{callback}"
+        unless klass.respond_to?(callback_meth)
+          klass.send(:define_method, callback_meth) do |&block|
+            if value = observer.update(callback, self, &block)
+              value
+            else
+              block.call if block
+            end
+          end
+          klass.send(callback, callback_meth)
+        end
+      end
+      self
+    end
+
+    # Are the observers disabled for the object?
+    #
+    # @api private
+    #
+    # @example If the observer disabled?
+    #   Observer.disabled_for(band)
+    #
+    # @param [ Document ] object The model instance.
+    #
+    # @return [ true, false ] If the observer is disabled.
+    def disabled_for?(object)
+      klass = object.class
+      return false unless klass.respond_to?(:observers)
+      klass.observers.disabled_for?(self) || Mongoid.observers.disabled_for?(self)
+    end
+  end
+end

data/lib/mongoid-audit/sweeper.rb

@@ -1,5 +1,5 @@
 module Mongoid::Audit
-  class Sweeper < Mongoid::Observer
+  class Sweeper < ActiveModel::Observer
     def controller
       Thread.current[:mongoid_history_sweeper_controller]
     end
@@ -8,6 +8,10 @@ module Mongoid::Audit
       Thread.current[:mongoid_history_sweeper_controller] = value
     end
 
+    def self.observed_classes
+      [ Mongoid::Audit.tracker_class ]
+    end
+
     # Hook to ActionController::Base#around_filter.
     # Runs before a controller action is run.
     # It should always return true so controller actions

data/lib/mongoid-audit/tracker.rb

@@ -5,6 +5,8 @@ module Mongoid::Audit
     included do
       include Mongoid::Document
       include Mongoid::Timestamps
+      include ActiveModel::Observing
+
       attr_writer :trackable
 
       field       :association_chain,       :type => Array,     :default => []
@@ -18,15 +20,6 @@ module Mongoid::Audit
       Mongoid::Audit.tracker_class_name = self.name.tableize.singularize.to_sym
 
       index({'association_chain.name' => 1, 'association_chain.id' => 1})
-
-      # install model observer and action controller filter
-      Mongoid::Audit::Sweeper.send(:observe, Mongoid::Audit.tracker_class_name)
-      if defined?(ActionController) and defined?(ActionController::Base)
-        ActionController::Base.class_eval do
-          before_filter { |controller| Mongoid::Audit::Sweeper.instance.before(controller) }
-          after_filter { |controller| Mongoid::Audit::Sweeper.instance.after(controller) }
-        end
-      end
     end
 
     def undo!(modifier)

data/lib/mongoid-audit/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Audit
-    VERSION = "0.1.7"
+    VERSION = "0.2.0"
   end
 end

data/lib/mongoid-audit.rb

@@ -1,6 +1,10 @@
 require 'mongoid-audit/version'
 require 'easy_diff'
 require 'mongoid'
+require 'rails-observers'
+require 'rails/observers/active_model/active_model'
+
+
 
 module Mongoid
   module Audit
@@ -15,6 +19,30 @@ module Mongoid
   end
 end
 
+unless Mongoid.const_defined?('Observer')
+  require "rails"
+  module Rails
+    module Mongoid
+      class Railtie < Rails::Railtie
+        initializer "instantiate observers" do
+          config.after_initialize do
+            ::Mongoid::Audit.tracker_class.add_observer ::Mongoid::Audit::Sweeper.instance
+
+            # install model observer and action controller filter
+            # Mongoid::Audit::Sweeper.send(:observe, Mongoid::Audit.tracker_class_name)
+            if defined?(ActionController) and defined?(ActionController::Base)
+              ActionController::Base.class_eval do
+                before_filter { |controller| ::Mongoid::Audit::Sweeper.instance.before(controller) }
+                after_filter { |controller| ::Mongoid::Audit::Sweeper.instance.after(controller) }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
 if Object.const_defined?("RailsAdmin")
   require "mongoid-audit/rails_admin"
 end
@@ -26,4 +54,3 @@ require 'mongoid-audit/sweeper'
 Mongoid::Audit.modifier_class_name = "User"
 Mongoid::Audit.trackable_class_options = {}
 Mongoid::Audit.current_user_method ||= :current_user
-

data/mongoid-audit.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency('easy_diff', ">= 0")
-  gem.add_runtime_dependency('mongoid', ">= 3.0.0")
+  gem.add_runtime_dependency('mongoid', ">= 3.1.0")
+  gem.add_runtime_dependency('rails-observers', "~> 0.1.1")
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec', "~> 2.13.0")
   gem.add_development_dependency('bundler', '>= 1.0.0')
   gem.add_development_dependency('database_cleaner', "~> 0.9.1")
-  gem.add_development_dependency('activesupport', '~> 3.2.13')
+  gem.add_development_dependency('activesupport', '~> 4.0.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-audit
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Gleb Tv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rails-observers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.13
+        version: 4.0.0
 description: Mongoid Audit
 email:
 - glebtv@gmail.com
@@ -117,6 +131,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
 - LICENSE.txt
@@ -124,6 +140,7 @@ files:
 - Rakefile
 - config/mongoid.yml
 - lib/mongoid-audit.rb
+- lib/mongoid-audit/mongoid_observer.rb
 - lib/mongoid-audit/rails_admin.rb
 - lib/mongoid-audit/sweeper.rb
 - lib/mongoid-audit/trackable.rb