/usr/lib/ruby/vendor_ruby/sequel/plugins/timestamps.rb is in ruby-sequel 3.33.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | module Sequel
module Plugins
# The timestamps plugin creates hooks that automatically set create and
# update timestamp fields. Both field names used are configurable, and you
# can also set whether to overwrite existing create timestamps (false
# by default), or whether to set the update timestamp when creating (also
# false by default).
#
# Usage:
#
# # Timestamp all model instances using +created_at+ and +updated_at+
# # (called before loading subclasses)
# Sequel::Model.plugin :timestamps
#
# # Timestamp Album instances, with custom column names
# Album.plugin :timestamps, :create=>:created_on, :update=>:updated_on
#
# # Timestamp Artist instances, forcing an overwrite of the create
# # timestamp, and setting the update timestamp when creating
# Album.plugin :timestamps, :force=>true, :update_on_create=>true
module Timestamps
# Configure the plugin by setting the avialable options. Note that
# if this method is run more than once, previous settings are ignored,
# and it will just use the settings given or the default settings. Options:
# * :create - The field to hold the create timestamp (default: :created_at)
# * :force - Whether to overwrite an existing create timestamp (default: false)
# * :update - The field to hold the update timestamp (default: :updated_at)
# * :update_on_create - Whether to set the update timestamp to the create timestamp when creating (default: false)
def self.configure(model, opts={})
model.instance_eval do
@create_timestamp_field = opts[:create]||:created_at
@update_timestamp_field = opts[:update]||:updated_at
@create_timestamp_overwrite = opts[:force]||false
@set_update_timestamp_on_create = opts[:update_on_create]||false
end
end
module ClassMethods
# The field to store the create timestamp
attr_reader :create_timestamp_field
# The field to store the update timestamp
attr_reader :update_timestamp_field
# Whether to overwrite the create timestamp if it already exists
def create_timestamp_overwrite?
@create_timestamp_overwrite
end
# Copy the class instance variables used from the superclass to the subclass
def inherited(subclass)
super
[:@create_timestamp_field, :@update_timestamp_field, :@create_timestamp_overwrite, :@set_update_timestamp_on_create].each do |iv|
subclass.instance_variable_set(iv, instance_variable_get(iv))
end
end
# Whether to set the update timestamp to the create timestamp when creating
def set_update_timestamp_on_create?
@set_update_timestamp_on_create
end
end
module InstanceMethods
# Set the create timestamp when creating
def before_create
set_create_timestamp
super
end
# Set the update timestamp when updating
def before_update
set_update_timestamp
super
end
private
# If the object has accessor methods for the create timestamp field, and
# the create timestamp value is nil or overwriting it is allowed, set the
# create timestamp field to the time given or the current time. If setting
# the update timestamp on creation is configured, set the update timestamp
# as well.
def set_create_timestamp(time=nil)
field = model.create_timestamp_field
meth = :"#{field}="
self.send(meth, time||=Sequel.datetime_class.now) if respond_to?(field) && respond_to?(meth) && (model.create_timestamp_overwrite? || send(field).nil?)
set_update_timestamp(time) if model.set_update_timestamp_on_create?
end
# Set the update timestamp to the time given or the current time if the
# object has a setter method for the update timestamp field.
def set_update_timestamp(time=nil)
meth = :"#{model.update_timestamp_field}="
self.send(meth, time||Sequel.datetime_class.now) if respond_to?(meth)
end
end
end
end
end
|