notifiably_audited 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODcwNjQ2YTAzNzU1ZmRmNTM5MWRlYjIyMWJkMjA5YzZhMzljMTU2Ng==
+    MjE4ZTc3NjA5YWUxYzdlM2YwODc3N2UwMTM0NDk1NGQwNzFjNzk0OQ==
   data.tar.gz: !binary |-
-    NGJiZWFlNTFkZDEzOWIxOTMyYjZlYzgyZjE4MTI2NTU3N2JhMzYzNg==
+    NGVlN2YzNjMxMWI1MGMxZWQwYzgzMmQzOTI5MGJlNzk0NmIxZGY5MA==
 SHA512:
   metadata.gz: !binary |-
-    NjUxZDhlZDNlZTY2OWVmNzI3MTY0ZTczN2E3ZGY3MjdkMzk5NTc3MWNkOTBj
-    NDUxNjA5NzQwNjNhOTBkZGMxNTZhYzAzMjBhMTNlNDZmZTMyZmM4YzVlN2Ew
-    MTM2YTRkYzIyZWI4MDljMmIxMDRhZTY3ZWY4ZDZiNjhiZjU4YmE=
+    YTVlM2QwMzliMDViNDQxNmM2NDIxOTQ1NDYxMzFhMzQyYWNjYTQ2OWU3NGE0
+    YzhkZmYwYmY3MTZmYWM0MTFmNDVkN2M3N2ZlNzIyNDE4MmUxZmYyYTY3MmUx
+    OTIwMjUxZjY4MGUwYjgzNzc2MDQzNzAxNTUxOTcxMDY3M2UyZDY=
   data.tar.gz: !binary |-
-    OTdlMGIxMmM0YTNiMDkxN2QwZWFjMjVkODc1M2Q1YmQ4ZWVmMWFkZjkyMmY5
-    ZmY5OWVlOTU5NGI5ZTE2MjU1MmM5MjJlNjg2MjJjNmQxMzFjOWUzMTUyYTFh
-    ZWI0ZTE5N2I5MWE3YjhmYzhlN2I0ZWY4YWJjODI4MmY3Mzc0NTY=
+    MmYxOTczOWU2ZGRkM2IxYzFlNWIzMjhhZTRiZTIyNzJlOWY0MDA4NDU0NmVl
+    NzQ4NWU2NWQxYjcxNWEyYThlNWRlYjc5ZTFhMGU3ZjVmY2UyNDg1MmVmY2Qx
+    OTE2ZDI2YjkxNzBjMjcxOGQ4MzNlZjNjZWY1ZWNmNDE2YWNjOGM=

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails30' do
+  gem 'rails', '~> 3.0.0'
+end
+
+appraise 'rails31' do
+  gem 'rails', '~> 3.1.0'
+end
+
+appraise 'rails32' do
+  gem 'rails', '~> 3.2.0'
+end

data/CHANGELOG

@@ -0,0 +1,34 @@
+Audited ChangeLog
+-------------------------------------------------------------------------------
+* 2012-04-10 - Add Audit scopes for creates, updates and destroys [chriswfx]
+* 2011-10-25 - Made ignored_attributes configurable [senny]
+* 2011-09-09 - Rails 3.x support
+               Support for associated audits
+               Support for remote IP address storage
+               Plenty of bug fixes and refactoring
+               [kennethkalmer, ineu, PatrickMa, jrozner, dwarburton, bsiggelkow, dgm]
+* 2009-01-27 - Store old and new values for updates, and store all attributes on destroy.
+               Refactored revisioning methods to work as expected
+* 2008-10-10 - changed to make it work in development mode
+* 2008-09-24 - Add ability to record parent record of the record being audited
+               [Kenneth Kalmer]
+* 2008-04-19 - refactored to make compatible with dirty tracking in edge rails
+               and to stop storing both old and new values in a single audit
+* 2008-04-18 - Fix NoMethodError when trying to access the :previous revision
+               on a model that doesn't have previous revisions [Alex Soto]
+* 2008-03-21 - added #changed_attributes to get access to the changes before a
+               save [Chris Parker]
+* 2007-12-16 - Added #revision_at for retrieving a revision from a specific
+               time [Jacob Atzen]
+* 2007-12-16 - Fix error when getting revision from audit with no changes
+               [Geoffrey Wiseman]
+* 2007-12-16 - Remove dependency on acts_as_list
+* 2007-06-17 - Added support getting previous revisions
+* 2006-11-17 - Replaced use of singleton User.current_user with cache sweeper
+               implementation for auditing the user that made the change
+* 2006-11-17 - added migration generator
+* 2006-08-14 - incorporated changes from Michael Schuerig to write_attribute
+               that saves the new value after every change and not just the
+               first, and performs proper type-casting before doing comparisons
+* 2006-08-14 - The "changes" are now saved as a serialized hash
+* 2006-07-21 - initial version

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2010 Brandon Keepers - Collective Idea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/audited-activerecord.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'audited-activerecord'
+  gem.version = '3.0.0'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your ActiveRecord models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+  gem.license     = 'MIT'
+
+  gem.add_dependency 'audited', gem.version
+  gem.add_dependency 'activerecord', '~> 3.0'
+
+  gem.files         = `git ls-files lib`.split($\).grep(/(active_?record|generators)/)
+  gem.files         << 'LICENSE'
+  gem.require_paths = ['lib']
+end
+

data/audited-mongo_mapper.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'audited-mongo_mapper'
+  gem.version = '3.0.0'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your MongoMapper models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+  gem.license     = 'MIT'
+
+  gem.add_dependency 'audited', gem.version
+  gem.add_dependency 'mongo_mapper', '~> 0.11'
+
+  gem.files         = `git ls-files lib`.split($\).grep(/mongo_mapper/)
+  gem.files         << 'LICENSE'
+  gem.require_paths = ['lib']
+end
+

data/audited.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = 'notifiably_audited'
+  gem.version = '0.0.2'
+
+  gem.authors     = ['Brandon Keepers', 'Kenneth Kalmer', 'Daniel Morrison', 'Brian Ryckbost', 'Steve Richert', 'Ryan Glover']
+  gem.email       = 'info@collectiveidea.com'
+  gem.description = 'Log all changes to your models'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/collectiveidea/audited'
+  gem.license     = 'MIT'
+
+  gem.add_development_dependency 'activerecord', '~> 3.0'
+  gem.add_development_dependency 'appraisal', '~> 0.4'
+  gem.add_development_dependency 'bson_ext', '~> 1.6'
+  gem.add_development_dependency 'mongo_mapper', '~> 0.11'
+  gem.add_development_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'rspec-rails', '~> 2.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.0'
+
+  gem.files         = `git ls-files`.split($\).reject{|f| f =~ /(lib\/audited\-|adapters|generators)/ }
+  gem.test_files    = gem.files.grep(/^spec\//)
+  gem.require_paths = ['lib']
+end
+

data/gemfiles/rails30.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+
+gemspec :name=>"audited", :path=>"../"

data/gemfiles/rails31.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+
+gemspec :name=>"audited", :path=>"../"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :name=>"audited", :path=>"../"

data/lib/audited.rb

@@ -0,0 +1,15 @@
+module Audited
+  VERSION = '3.0.0'
+
+  class << self
+    attr_accessor :ignored_attributes, :current_user_method, :audit_class
+
+    def store
+      Thread.current[:audited_store] ||= {}
+    end
+  end
+
+  @ignored_attributes = %w(lock_version created_at updated_at created_on updated_on)
+
+  @current_user_method = :current_user
+end

data/lib/audited/audit.rb

@@ -0,0 +1,102 @@
+module Audited
+  module Audit
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.setup_audit
+    end
+
+    module ClassMethods
+      def setup_audit
+        belongs_to :auditable,  :polymorphic => true
+        belongs_to :user,       :polymorphic => true
+        belongs_to :associated, :polymorphic => true
+
+        before_create :set_version_number, :set_audit_user
+
+        cattr_accessor :audited_class_names
+        self.audited_class_names = Set.new
+
+        attr_accessible :action, :audited_changes, :comment, :associated
+      end
+
+      # Returns the list of classes that are being audited
+      def audited_classes
+        audited_class_names.map(&:constantize)
+      end
+
+      # All audits made during the block called will be recorded as made
+      # by +user+. This method is hopefully threadsafe, making it ideal
+      # for background operations that require audit information.
+      def as_user(user, &block)
+        Thread.current[:audited_user] = user
+        yield
+      ensure
+        Thread.current[:audited_user] = nil
+      end
+
+      # @private
+      def reconstruct_attributes(audits)
+        attributes = {}
+        result = audits.collect do |audit|
+          attributes.merge!(audit.new_attributes).merge!(:version => audit.version)
+          yield attributes if block_given?
+        end
+        block_given? ? result : attributes
+      end
+
+      # @private
+      def assign_revision_attributes(record, attributes)
+        attributes.each do |attr, val|
+          record = record.dup if record.frozen?
+
+          if record.respond_to?("#{attr}=")
+            record.attributes.has_key?(attr.to_s) ?
+              record[attr] = val :
+              record.send("#{attr}=", val)
+          end
+        end
+        record
+      end
+    end
+
+    # Return an instance of what the object looked like at this revision. If
+    # the object has been destroyed, this will be a new record.
+    def revision
+      clazz = auditable_type.constantize
+      (clazz.find_by_id(auditable_id) || clazz.new).tap do |m|
+        self.class.assign_revision_attributes(m, self.class.reconstruct_attributes(ancestors).merge({ :version => version }))
+      end
+    end
+
+    # Returns a hash of the changed attributes with the new values
+    def new_attributes
+      (audited_changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+        attrs[attr] = values.is_a?(Array) ? values.last : values
+        attrs
+      end
+    end
+
+    # Returns a hash of the changed attributes with the old values
+    def old_attributes
+      (audited_changes || {}).inject({}.with_indifferent_access) do |attrs,(attr,values)|
+        attrs[attr] = Array(values).first
+
+        attrs
+      end
+    end
+
+    private
+    def set_version_number
+      max = self.class.where(
+        :auditable_id => auditable_id,
+        :auditable_type => auditable_type
+      ).order(:version.desc).first.try(:version) || 0
+      self.version = max + 1
+    end
+
+    def set_audit_user
+      self.user = Thread.current[:audited_user] if Thread.current[:audited_user]
+      nil # prevent stopping callback chains
+    end
+  end
+end

data/lib/audited/auditor.rb

@@ -0,0 +1,270 @@
+module Audited
+  # Specify this act if you want changes to your model to be saved in an
+  # audit table.  This assumes there is an audits table ready.
+  #
+  #   class User < ActiveRecord::Base
+  #     audited
+  #   end
+  #
+  # To store an audit comment set model.audit_comment to your comment before
+  # a create, update or destroy operation.
+  #
+  # See <tt>Audited::Adapters::ActiveRecord::Auditor::ClassMethods#audited</tt>
+  # for configuration options
+  module Auditor #:nodoc:
+    extend ActiveSupport::Concern
+
+    CALLBACKS = [:audit_create, :audit_update, :audit_destroy]
+
+    module ClassMethods
+      # == Configuration options
+      #
+      #
+      # * +only+ - Only audit the given attributes
+      # * +except+ - Excludes fields from being saved in the audit log.
+      #   By default, Audited will audit all but these fields:
+      #
+      #     [self.primary_key, inheritance_column, 'lock_version', 'created_at', 'updated_at']
+      #   You can add to those by passing one or an array of fields to skip.
+      #
+      #     class User < ActiveRecord::Base
+      #       audited :except => :password
+      #     end
+      # * +protect+ - If your model uses +attr_protected+, set this to false to prevent Rails from
+      #   raising an error.  If you declare +attr_accessible+ before calling +audited+, it
+      #   will automatically default to false.  You only need to explicitly set this if you are
+      #   calling +attr_accessible+ after.
+      #
+      # * +require_comment+ - Ensures that audit_comment is supplied before
+      #   any create, update or destroy operation.
+      #
+      #     class User < ActiveRecord::Base
+      #       audited :protect => false
+      #       attr_accessible :name
+      #     end
+      #
+      def audited(options = {})
+        # don't allow multiple calls
+        return if self.included_modules.include?(Audited::Auditor::AuditedInstanceMethods)
+
+        class_attribute :non_audited_columns,   :instance_writer => false
+        class_attribute :auditing_enabled,      :instance_writer => false
+        class_attribute :audit_associated_with, :instance_writer => false
+
+        if options[:only]
+          except = self.column_names - options[:only].flatten.map(&:to_s)
+        else
+          except = default_ignored_attributes + Audited.ignored_attributes
+          except |= Array(options[:except]).collect(&:to_s) if options[:except]
+        end
+        self.non_audited_columns = except
+        self.audit_associated_with = options[:associated_with]
+
+        if options[:comment_required]
+          validates_presence_of :audit_comment, :if => :auditing_enabled
+          before_destroy :require_comment
+        end
+
+        attr_accessor :audit_comment
+        unless options[:allow_mass_assignment]
+          attr_accessible :audit_comment
+        end
+
+        has_many :audits, :as => :auditable, :class_name => Audited.audit_class.name
+        Audited.audit_class.audited_class_names << self.to_s
+
+        after_create  :audit_create if !options[:on] || (options[:on] && options[:on].include?(:create))
+        before_update :audit_update if !options[:on] || (options[:on] && options[:on].include?(:update))
+        before_destroy :audit_destroy if !options[:on] || (options[:on] && options[:on].include?(:destroy))
+
+        # Define and set an after_audit callback. This might be useful if you want
+        # to notify a party after the audit has been created.
+        define_callbacks :audit
+        set_callback :audit, :after, :after_audit, :if => lambda { self.respond_to?(:after_audit) }
+
+        attr_accessor :version
+
+        extend Audited::Auditor::AuditedClassMethods
+        include Audited::Auditor::AuditedInstanceMethods
+
+        self.auditing_enabled = true
+      end
+
+      def has_associated_audits
+        has_many :associated_audits, :as => :associated, :class_name => Audited.audit_class.name
+      end
+    end
+
+    module AuditedInstanceMethods
+      # Temporarily turns off auditing while saving.
+      def save_without_auditing
+        without_auditing { save }
+      end
+
+      # Executes the block with the auditing callbacks disabled.
+      #
+      #   @foo.without_auditing do
+      #     @foo.save
+      #   end
+      #
+      def without_auditing(&block)
+        self.class.without_auditing(&block)
+      end
+
+      # Gets an array of the revisions available
+      #
+      #   user.revisions.each do |revision|
+      #     user.name
+      #     user.version
+      #   end
+      #
+      def revisions(from_version = 1)
+        audits = self.audits.from_version(from_version)
+        return [] if audits.empty?
+        revisions = []
+        audits.each do |audit|
+          revisions << audit.revision
+        end
+        revisions
+      end
+
+      # Get a specific revision specified by the version number, or +:previous+
+      def revision(version)
+        revision_with Audited.audit_class.reconstruct_attributes(audits_to(version))
+      end
+
+      # Find the oldest revision recorded prior to the date/time provided.
+      def revision_at(date_or_time)
+        audits = self.audits.up_until(date_or_time)
+        revision_with Audited.audit_class.reconstruct_attributes(audits) unless audits.empty?
+      end
+
+      # List of attributes that are audited.
+      def audited_attributes
+        attributes.except(*non_audited_columns)
+      end
+
+      protected
+
+      def revision_with(attributes)
+        self.dup.tap do |revision|
+          revision.id = id
+          revision.send :instance_variable_set, '@attributes', self.attributes
+          revision.send :instance_variable_set, '@new_record', self.destroyed?
+          revision.send :instance_variable_set, '@persisted', !self.destroyed?
+          revision.send :instance_variable_set, '@readonly', false
+          revision.send :instance_variable_set, '@destroyed', false
+          revision.send :instance_variable_set, '@_destroyed', false
+          revision.send :instance_variable_set, '@marked_for_destruction', false
+          Audited.audit_class.assign_revision_attributes(revision, attributes)
+
+          # Remove any association proxies so that they will be recreated
+          # and reference the correct object for this revision. The only way
+          # to determine if an instance variable is a proxy object is to
+          # see if it responds to certain methods, as it forwards almost
+          # everything to its target.
+          for ivar in revision.instance_variables
+            proxy = revision.instance_variable_get ivar
+            if !proxy.nil? and proxy.respond_to? :proxy_respond_to?
+              revision.instance_variable_set ivar, nil
+            end
+          end
+        end
+      end
+
+      private
+
+      def audited_changes
+        changed_attributes.except(*non_audited_columns).inject({}) do |changes,(attr, old_value)|
+          changes[attr] = [old_value, self[attr]]
+          changes
+        end
+      end
+
+      def audits_to(version = nil)
+        if version == :previous
+          version = if self.version
+                      self.version - 1
+                    else
+                      previous = audits.descending.offset(1).first
+                      previous ? previous.version : 1
+                    end
+        end
+        audits.to_version(version)
+      end
+
+      def audit_create
+        write_audit(:action => 'create', :audited_changes => audited_attributes,
+                    :comment => audit_comment)
+      end
+
+      def audit_update
+        unless (changes = audited_changes).empty? && audit_comment.blank?
+          write_audit(:action => 'update', :audited_changes => changes,
+                      :comment => audit_comment)
+        end
+      end
+
+      def audit_destroy
+        write_audit(:action => 'destroy', :audited_changes => audited_attributes,
+                    :comment => audit_comment)
+      end
+
+      def write_audit(attrs)
+        attrs[:associated] = self.send(audit_associated_with) unless audit_associated_with.nil?
+        self.audit_comment = nil
+        run_callbacks(:audit)  { self.audits.create(attrs) } if auditing_enabled
+      end
+
+      def require_comment
+        if auditing_enabled && audit_comment.blank?
+          errors.add(:audit_comment, "Comment required before destruction")
+          return false
+        end
+      end
+
+      CALLBACKS.each do |attr_name|
+        alias_method "#{attr_name}_callback".to_sym, attr_name
+      end
+
+      def empty_callback #:nodoc:
+      end
+
+    end # InstanceMethods
+
+    module AuditedClassMethods
+      # Returns an array of columns that are audited. See non_audited_columns
+      def audited_columns
+        self.columns.select { |c| !non_audited_columns.include?(c.name) }
+      end
+
+      # Executes the block with auditing disabled.
+      #
+      #   Foo.without_auditing do
+      #     @foo.save
+      #   end
+      #
+      def without_auditing(&block)
+        auditing_was_enabled = auditing_enabled
+        disable_auditing
+        block.call.tap { enable_auditing if auditing_was_enabled }
+      end
+
+      def disable_auditing
+        self.auditing_enabled = false
+      end
+
+      def enable_auditing
+        self.auditing_enabled = true
+      end
+
+      # All audit operations during the block are recorded as being
+      # made by +user+. This is not model specific, the method is a
+      # convenience wrapper around
+      # @see Audit#as_user.
+      def audit_as( user, &block )
+        Audited.audit_class.as_user( user, &block )
+      end
+    end
+  end
+end