Skip to content

Instantly share code, notes, and snippets.

@verticonaut
Created September 2, 2010 11:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save verticonaut/562171 to your computer and use it in GitHub Desktop.
Save verticonaut/562171 to your computer and use it in GitHub Desktop.
module ActiveRecord
module ConnectionAdapters
class TableDefinition
# Creates author columns ...
#
# @param Symbol type The desired type for the columns, defaults to :string
# @param Hash *args Column options from rails
def authors(type=:string, *args)
options = args.extract_options!
column(:created_by, type, options)
column(:updated_by, type, options)
end
end
class Table
# Adds author (created_by and updated_by) columns to the table
# ===== Example
# t.authors
#
# @param Symbol type The desired type for the columns, defaults to :string
# @see SchemaStatements#add_authors
def authors(type=:string)
@base.add_authors(@table_name, type)
end
# Removes the author columns (created_by and updated_by) from the table.
# ===== Example
# t.remove_authors
def remove_authors
@base.remove_authors(@table_name)
end
end
module SchemaStatements
# Adds author columns (created_by and updated_by) to the named table.
# ===== Examples
# add_authors(:suppliers)
def add_authors(table_name, type=:string)
add_column table_name, :created_by, type
add_column table_name, :updated_by, type
end
# Removes the author columns (created_by and updated_by) from the table definition.
# ===== Examples
# remove_authors(:suppliers)
def remove_authors(table_name)
remove_column table_name, :updated_by
remove_column table_name, :created_by
end
end
end
# = Active Record Author
#
# Active Record automatically authors create and update operations if the
# table has fields named <tt>created_by</tt> or
# <tt>updated_by</tt>.
#
# Authoring can be turned off by setting:
#
# <tt>ActiveRecord::Base.record_authors = false</tt>
module Author
extend ActiveSupport::Concern
included do
class_inheritable_accessor :record_authors, :instance_writer => false
self.record_authors = true
end
private
def create #:nodoc:
if record_authors
current_author = Concern::Audit::Author.current
all_author_attributes.each do |column|
write_attribute(column.to_s, current_author) if respond_to?(column) && self.send(column).nil?
end
end
super
end
def update(*args) #:nodoc:
if should_record_authors?
current_author = Concern::Audit::Author.current
author_attributes_for_update_in_model.each do |column|
column = column.to_s
next if attribute_changed?(column)
write_attribute(column, current_author)
end
end
super
end
def should_record_authors?
record_authors && (!partial_updates? || changed?)
end
def author_attributes_for_update_in_model
author_attributes_for_update.select { |c| respond_to?(c) }
end
def author_attributes_for_update #:nodoc:
[:updated_by]
end
def author_attributes_for_create #:nodoc:
[:created_by]
end
def all_author_attributes #:nodoc:
author_attributes_for_create + author_attributes_for_update
end
end
Base.class_eval do
include Author
end
end
module Concern
module Audit
module Author
def self.current=(author)
Thread.current[:current_author] = author
end
def self.current
Thread.current[:current_author]
end
end
end
end
@verticonaut
Copy link
Author

This is basically a copy of the 'timestamps' feature as provided by rails.

Add author columns through migrations:

    t.authors  # this is the same as t.authors(:string)

Then you can set the current author using (e.g. in an application in a before_filter:

    Concern::Audit::Author.current="bad_man"

Each AR save or update then will update the fields created_by and modified_by automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment