Module: RailsAuditLog

Defined in:
lib/rails_audit_log.rb,
lib/rails_audit_log/engine.rb,
lib/rails_audit_log/version.rb,
app/concerns/rails_audit_log/auditable.rb,
app/concerns/rails_audit_log/controller.rb,
app/jobs/rails_audit_log/application_job.rb,
app/models/rails_audit_log/audit_log_entry.rb,
app/jobs/rails_audit_log/write_audit_log_job.rb,
app/models/rails_audit_log/application_record.rb,
app/helpers/rails_audit_log/application_helper.rb,
app/controllers/rails_audit_log/application_controller.rb,
lib/generators/rails_audit_log/install/install_generator.rb

Defined Under Namespace

Modules: ApplicationHelper, Auditable, Controller, Generators Classes: ApplicationController, ApplicationJob, ApplicationRecord, AuditLogEntry, Engine, WriteAuditLogJob

Constant Summary collapse

VERSION = 
"0.7.0"

Class Method Summary collapse

Class Method Details

.actor ⇒ Object 



25
26
27
 
# File 'lib/rails_audit_log.rb', line 25

def self.actor
  Thread.current[:rails_audit_log_actor]
end

.actor=(actor) ⇒ Object 



29
30
31
 
# File 'lib/rails_audit_log.rb', line 29

def self.actor=(actor)
  Thread.current[:rails_audit_log_actor] = actor
end

.audit_log_reason(value) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/rails_audit_log.rb', line 61

def self.audit_log_reason(value)
  previous = self.reason
  self.reason = value
  yield
ensure
  self.reason = previous
end

.batch_audit ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rails_audit_log.rb', line 69

def self.batch_audit
  return yield if Thread.current[:rails_audit_log_batch]

  Thread.current[:rails_audit_log_batch] = []
  begin
    result = yield
    batch = Thread.current[:rails_audit_log_batch]
    AuditLogEntry.insert_all!(batch) if batch.any?
    result
  ensure
    Thread.current[:rails_audit_log_batch] = nil
  end
end

.batch_audit_buffer ⇒ Object 



83
84
85
 
# File 'lib/rails_audit_log.rb', line 83

def self.batch_audit_buffer
  Thread.current[:rails_audit_log_batch]
end

.disable ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/rails_audit_log.rb', line 45

def self.disable
  previous = Thread.current[:rails_audit_log_disabled]
  Thread.current[:rails_audit_log_disabled] = true
  yield
ensure
  Thread.current[:rails_audit_log_disabled] = previous
end

.enabled? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/rails_audit_log.rb', line 41

def self.enabled?
  !Thread.current[:rails_audit_log_disabled]
end

.reason ⇒ Object 



53
54
55
 
# File 'lib/rails_audit_log.rb', line 53

def self.reason
  Thread.current[:rails_audit_log_reason]
end

.reason=(value) ⇒ Object 



57
58
59
 
# File 'lib/rails_audit_log.rb', line 57

def self.reason=(value)
  Thread.current[:rails_audit_log_reason] = value
end

.request_metadata ⇒ Object 



17
18
19
 
# File 'lib/rails_audit_log.rb', line 17

def self.request_metadata
  Thread.current[:rails_audit_log_request_metadata]
end

.request_metadata=(value) ⇒ Object 



21
22
23
 
# File 'lib/rails_audit_log.rb', line 21

def self.request_metadata=(value)
  Thread.current[:rails_audit_log_request_metadata] = value
end

.version_at(record, time) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/rails_audit_log.rb', line 87

def self.version_at(record, time)
  entry = AuditLogEntry
    .where(item_type: record.class.name, item_id: record.id)
    .where(created_at: ..time)
    .order(created_at: :desc, id: :desc)
    .first

  return nil if entry.nil? || entry.event == "destroy"

  klass = record.class
  column_names = klass.column_names.map(&:to_s)
  to_attrs = (entry.object_changes || {})
    .select { |k, _| column_names.include?(k) }
    .transform_values { |v| v[1] }
  attrs = entry.object.present? ? entry.object.merge(to_attrs) : to_attrs

  instance = klass.new
  instance.assign_attributes(attrs.except("id"))
  instance.id = attrs.fetch("id") { entry.item_id }
  instance
end

.with_actor(actor) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/rails_audit_log.rb', line 33

def self.with_actor(actor)
  previous = self.actor
  self.actor = actor
  yield
ensure
  self.actor = previous
end