Sha256: 367296ca9f69d33968c7c909c5ddb1002c64a5ac0aa85d7e69426402e3292709
Contents?: true
Size: 1.94 KB
Versions: 41
Compression:
Stored size: 1.94 KB
Contents
# 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
Version data entries
41 entries across 41 versions & 5 rubygems