aboutsummaryrefslogtreecommitdiffstats
path: root/activemodel/lib/active_model/attributes.rb
diff options
context:
space:
mode:
authorLisa Ugray <lisa.ugray@shopify.com>2017-10-12 14:13:45 -0400
committerLisa Ugray <lisa.ugray@shopify.com>2017-10-18 13:05:30 -0400
commit7e9ded512dd58a923a3be038843708dbba4215f6 (patch)
treecf31a52147933fb1275d4e7e7a1ae2bb59418f12 /activemodel/lib/active_model/attributes.rb
parentded41a9b84299f536bc136d78069a50a2e867768 (diff)
downloadrails-7e9ded512dd58a923a3be038843708dbba4215f6.tar.gz
rails-7e9ded512dd58a923a3be038843708dbba4215f6.tar.bz2
rails-7e9ded512dd58a923a3be038843708dbba4215f6.zip
Start bringing attributes API to AM
This is the first PR of a WIP to bring the attributes API to ActiveModel. It is not yet ready for public API. The `attributes_dirty_test.rb` file was created based on `dirty_test.rb`, and the simplifications in the diff do much to motivate this change. ``` diff activemodel/test/cases/dirty_test.rb activemodel/test/cases/attributes_dirty_test.rb 3a4 > require "active_model/attributes" 5c6 < class DirtyTest < ActiveModel::TestCase --- > class AttributesDirtyTest < ActiveModel::TestCase 7,41c8,12 < include ActiveModel::Dirty < define_attribute_methods :name, :color, :size < < def initialize < @name = nil < @color = nil < @size = nil < end < < def name < @name < end < < def name=(val) < name_will_change! < @name = val < end < < def color < @color < end < < def color=(val) < color_will_change! unless val == @color < @color = val < end < < def size < @size < end < < def size=(val) < attribute_will_change!(:size) unless val == @size < @size = val < end --- > include ActiveModel::Model > include ActiveModel::Attributes > attribute :name, :string > attribute :color, :string > attribute :size, :integer ```
Diffstat (limited to 'activemodel/lib/active_model/attributes.rb')
-rw-r--r--activemodel/lib/active_model/attributes.rb89
1 files changed, 89 insertions, 0 deletions
diff --git a/activemodel/lib/active_model/attributes.rb b/activemodel/lib/active_model/attributes.rb
new file mode 100644
index 0000000000..3e34d3b83a
--- /dev/null
+++ b/activemodel/lib/active_model/attributes.rb
@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "active_model/type"
+
+module ActiveModel
+ module Attributes #:nodoc:
+ extend ActiveSupport::Concern
+ include ActiveModel::AttributeMethods
+ include ActiveModel::Dirty
+
+ included do
+ attribute_method_suffix "="
+ class_attribute :attribute_types, :_default_attributes, instance_accessor: false
+ self.attribute_types = {}
+ self._default_attributes = {}
+ end
+
+ module ClassMethods
+ def attribute(name, cast_type = Type::Value.new, **options)
+ self.attribute_types = attribute_types.merge(name.to_s => cast_type)
+ self._default_attributes = _default_attributes.merge(name.to_s => options[:default])
+ define_attribute_methods(name)
+ end
+
+ private
+
+ def define_method_attribute=(name)
+ safe_name = name.unpack("h*".freeze).first
+ ActiveModel::AttributeMethods::AttrNames.set_name_cache safe_name, name
+
+ generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
+ def __temp__#{safe_name}=(value)
+ name = ::ActiveModel::AttributeMethods::AttrNames::ATTR_#{safe_name}
+ write_attribute(name, value)
+ end
+ alias_method #{(name + '=').inspect}, :__temp__#{safe_name}=
+ undef_method :__temp__#{safe_name}=
+ STR
+ end
+ end
+
+ def initialize(*)
+ super
+ clear_changes_information
+ end
+
+ private
+
+ def write_attribute(attr_name, value)
+ name = if self.class.attribute_alias?(attr_name)
+ self.class.attribute_alias(attr_name).to_s
+ else
+ attr_name.to_s
+ end
+
+ cast_type = self.class.attribute_types[name]
+
+ deserialized_value = ActiveModel::Type.lookup(cast_type).cast(value)
+ attribute_will_change!(name) unless deserialized_value == attribute(name)
+ instance_variable_set("@#{name}", deserialized_value)
+ deserialized_value
+ end
+
+ def attribute(name)
+ if instance_variable_defined?("@#{name}")
+ instance_variable_get("@#{name}")
+ else
+ default = self.class._default_attributes[name]
+ default.respond_to?(:call) ? default.call : default
+ end
+ end
+
+ # Handle *= for method_missing.
+ def attribute=(attribute_name, value)
+ write_attribute(attribute_name, value)
+ end
+ end
+
+ module AttributeMethods #:nodoc:
+ AttrNames = Module.new {
+ def self.set_name_cache(name, value)
+ const_name = "ATTR_#{name}"
+ unless const_defined? const_name
+ const_set const_name, value.dup.freeze
+ end
+ end
+ }
+ end
+end