attribute.rb 3.2 KB
Newer Older
1 2 3
module ActiveRecord
  class Attribute # :nodoc:
    class << self
4 5
      def from_database(name, value, type)
        FromDatabase.new(name, value, type)
6 7
      end

8 9
      def from_user(name, value, type)
        FromUser.new(name, value, type)
10
      end
11

12 13 14 15
      def with_cast_value(name, value, type)
        WithCastValue.new(name, value, type)
      end

16 17 18 19 20 21
      def null(name)
        Null.new(name)
      end

      def uninitialized(name, type)
        Uninitialized.new(name, type)
22
      end
23 24
    end

25
    attr_reader :name, :value_before_type_cast, :type
26 27 28

    # This method should not be called directly.
    # Use #from_database or #from_user
29 30
    def initialize(name, value_before_type_cast, type)
      @name = name
31 32 33 34 35 36
      @value_before_type_cast = value_before_type_cast
      @type = type
    end

    def value
      # `defined?` is cheaper than `||=` when we get back falsy values
37
      @value = original_value unless defined?(@value)
38 39 40
      @value
    end

41 42 43 44
    def original_value
      type_cast(value_before_type_cast)
    end

45 46 47 48
    def value_for_database
      type.type_cast_for_database(value)
    end

49 50 51 52 53 54 55 56
    def changed_from?(old_value)
      type.changed?(old_value, value, value_before_type_cast)
    end

    def changed_in_place_from?(old_value)
      type.changed_in_place?(old_value, value)
    end

57
    def with_value_from_user(value)
58
      self.class.from_user(name, value, type)
59 60 61
    end

    def with_value_from_database(value)
62
      self.class.from_database(name, value, type)
63 64
    end

65 66 67 68
    def with_cast_value(value)
      self.class.with_cast_value(name, value, type)
    end

69
    def type_cast(*)
70 71 72
      raise NotImplementedError
    end

73 74 75 76
    def initialized?
      true
    end

77 78 79 80
    def came_from_user?
      false
    end

81 82 83 84 85 86 87
    def ==(other)
      self.class == other.class &&
        name == other.name &&
        value_before_type_cast == other.value_before_type_cast &&
        type == other.type
    end

88 89 90 91 92 93 94 95
    protected

    def initialize_dup(other)
      if defined?(@value) && @value.duplicable?
        @value = @value.dup
      end
    end

96
    class FromDatabase < Attribute # :nodoc:
97 98 99 100 101
      def type_cast(value)
        type.type_cast_from_database(value)
      end
    end

102
    class FromUser < Attribute # :nodoc:
103 104 105
      def type_cast(value)
        type.type_cast_from_user(value)
      end
106 107 108 109

      def came_from_user?
        true
      end
110
    end
111

112 113 114 115 116 117 118 119 120 121
    class WithCastValue < Attribute # :nodoc:
      def type_cast(value)
        value
      end

      def changed_in_place_from?(old_value)
        false
      end
    end

122 123 124
    class Null < Attribute # :nodoc:
      def initialize(name)
        super(name, nil, Type::Value.new)
125
      end
126

127 128
      def value
        nil
129
      end
130 131 132 133 134

      def with_value_from_database(value)
        raise ActiveModel::MissingAttributeError, "can't write unknown attribute `#{name}`"
      end
      alias_method :with_value_from_user, :with_value_from_database
135 136 137
    end

    class Uninitialized < Attribute # :nodoc:
138 139
      def initialize(name, type)
        super(name, nil, type)
140 141 142
      end

      def value
143 144 145 146 147 148
        if block_given?
          yield name
        end
      end

      def value_for_database
149 150 151 152
      end

      def initialized?
        false
153 154
      end
    end
155
    private_constant :FromDatabase, :FromUser, :Null, :Uninitialized
156 157
  end
end