List of attributes that are audited.
# File lib/audited/auditor.rb, line 144 def audited_attributes attributes.except(*non_audited_columns) end
Combine multiple audits into one.
# File lib/audited/auditor.rb, line 149 def combine_audits(audits_to_combine) combine_target = audits_to_combine.last combine_target.audited_changes = audits_to_combine.pluck(:audited_changes).reduce(&:merge) combine_target.comment = "#{combine_target.comment}\nThis audit is the result of multiple audits being combined." transaction do combine_target.save! audits_to_combine.unscope(:limit).where("version < ?", combine_target.version).delete_all end end
Get a specific revision specified by the version number, or
:previous
Returns nil for versions greater than revisions
count
# File lib/audited/auditor.rb, line 131 def revision(version) if version == :previous || self.audits.last.version >= version revision_with Audited.audit_class.reconstruct_attributes(audits_to(version)) end end
Find the oldest revision recorded prior to the date/time provided.
# File lib/audited/auditor.rb, line 138 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
Gets an array of the revisions available
user.revisions.each do |revision| user.name user.version end
# File lib/audited/auditor.rb, line 115 def revisions(from_version = 1) return [] unless audits.from_version(from_version).exists? all_audits = audits.select([:audited_changes, :version]).to_a targeted_audits = all_audits.select { |audit| audit.version >= from_version } previous_attributes = reconstruct_attributes(all_audits - targeted_audits) targeted_audits.map do |audit| previous_attributes.merge!(audit.new_attributes) revision_with(previous_attributes.merge!(version: audit.version)) end end
Temporarily turns off auditing while saving.
# File lib/audited/auditor.rb, line 94 def save_without_auditing without_auditing { save } end
Executes the block with the auditing callbacks disabled.
@foo.without_auditing do @foo.save end
# File lib/audited/auditor.rb, line 104 def without_auditing(&block) self.class.without_auditing(&block) end
# File lib/audited/auditor.rb, line 166 def audited_columns self.class.audited_columns end
# File lib/audited/auditor.rb, line 162 def non_audited_columns self.class.non_audited_columns end
# File lib/audited/auditor.rb, line 196 def rails_below?(rails_version) Gem::Version.new(Rails::VERSION::STRING) < Gem::Version.new(rails_version) end
# File lib/audited/auditor.rb, line 170 def revision_with(attributes) dup.tap do |revision| revision.id = id revision.send :instance_variable_set, '@attributes', self.attributes if rails_below?('4.2.0') revision.send :instance_variable_set, '@new_record', destroyed? revision.send :instance_variable_set, '@persisted', !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. revision.instance_variables.each do |ivar| proxy = revision.instance_variable_get ivar if !proxy.nil? && proxy.respond_to?(:proxy_respond_to?) revision.instance_variable_set ivar, nil end end end end
# File lib/audited/auditor.rb, line 223 def audit_create write_audit(action: 'create', audited_changes: audited_attributes, comment: audit_comment) end
# File lib/audited/auditor.rb, line 235 def audit_destroy write_audit(action: 'destroy', audited_changes: audited_attributes, comment: audit_comment) unless new_record? end
# File lib/audited/auditor.rb, line 228 def audit_update unless (changes = audited_changes).empty? && audit_comment.blank? write_audit(action: 'update', audited_changes: changes, comment: audit_comment) end end
# File lib/audited/auditor.rb, line 202 def audited_changes all_changes = respond_to?(:changes_to_save) ? changes_to_save : changes if audited_options[:only].present? all_changes.slice(*audited_columns) else all_changes.except(*non_audited_columns) end end
# File lib/audited/auditor.rb, line 285 def auditing_enabled return run_conditional_check(audited_options[:if]) && run_conditional_check(audited_options[:unless], matching: false) && self.class.auditing_enabled end
# File lib/audited/auditor.rb, line 300 def auditing_enabled=(val) self.class.auditing_enabled = val end
# File lib/audited/auditor.rb, line 211 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
# File lib/audited/auditor.rb, line 265 def combine_audits_if_needed max_audits = audited_options[:max_audits] if max_audits && (extra_count = audits.count - max_audits) > 0 audits_to_combine = audits.limit(extra_count + 1) combine_audits(audits_to_combine) end end
# File lib/audited/auditor.rb, line 259 def comment_required_state? auditing_enabled && ((audited_options[:on].include?(:create) && self.new_record?) || (audited_options[:on].include?(:update) && self.persisted? && self.changed?)) end
# File lib/audited/auditor.rb, line 253 def presence_of_audit_comment if comment_required_state? errors.add(:audit_comment, "Comment can't be blank!") unless audit_comment.present? end end
# File lib/audited/auditor.rb, line 304 def reconstruct_attributes(audits) attributes = {} audits.each { |audit| attributes.merge!(audit.new_attributes) } attributes end
# File lib/audited/auditor.rb, line 273 def require_comment if auditing_enabled && audit_comment.blank? errors.add(:audit_comment, "Comment can't be blank!") return false if Rails.version.start_with?('4.') throw(:abort) end end
# File lib/audited/auditor.rb, line 291 def run_conditional_check(condition, matching: true) return true if condition.blank? return condition.call(self) == matching if condition.respond_to?(:call) return send(condition) == matching if respond_to?(condition.to_sym) true end
# File lib/audited/auditor.rb, line 240 def write_audit(attrs) attrs[:associated] = send(audit_associated_with) unless audit_associated_with.nil? self.audit_comment = nil if auditing_enabled run_callbacks(:audit) { audit = audits.create(attrs) combine_audits_if_needed if attrs[:action] != 'create' audit } end end