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
|
# frozen_string_literal: true
module ActiveRecord
class ReadonlyAttributeError < ActiveRecordError
end
module ReadonlyAttributes
extend ActiveSupport::Concern
included do
class_attribute :_attr_readonly, instance_accessor: false, default: []
end
module ClassMethods
# Attributes listed as readonly will be used to create a new record.
# Assigning a new value to a readonly attribute on a persisted record raises an error.
#
# By setting +config.active_record.raise_on_assign_to_attr_readonly+ to +false+, it will
# not raise. The value will change in memory, but will not be persisted on +save+.
#
# ==== Examples
#
# class Post < ActiveRecord::Base
# attr_readonly :title
# end
#
# post = Post.create!(title: "Introducing Ruby on Rails!")
# post.title = "a different title" # raises ActiveRecord::ReadonlyAttributeError
# post.update(title: "a different title") # raises ActiveRecord::ReadonlyAttributeError
def attr_readonly(*attributes)
self._attr_readonly |= attributes.map(&:to_s)
if ActiveRecord.raise_on_assign_to_attr_readonly
include(HasReadonlyAttributes)
end
end
# Returns an array of all the attributes that have been specified as readonly.
def readonly_attributes
_attr_readonly
end
def readonly_attribute?(name) # :nodoc:
_attr_readonly.include?(name)
end
end
module HasReadonlyAttributes # :nodoc:
def write_attribute(attr_name, value)
if !new_record? && self.class.readonly_attribute?(attr_name.to_s)
raise ReadonlyAttributeError.new(attr_name)
end
super
end
def _write_attribute(attr_name, value)
if !new_record? && self.class.readonly_attribute?(attr_name.to_s)
raise ReadonlyAttributeError.new(attr_name)
end
super
end
end
end
end
|