aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord/lib/active_record/type/value.rb
blob: 8cd99df2b4da50b90e4c3847a94267ce1b579810 (plain) (blame)
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
module ActiveRecord
  module Type
    class Value # :nodoc:
      attr_reader :precision, :scale, :limit

      # Valid options are +precision+, +scale+, and +limit+.
      # They are only used when dumping schema.
      def initialize(options = {})
        options.assert_valid_keys(:precision, :scale, :limit)
        @precision = options[:precision]
        @scale = options[:scale]
        @limit = options[:limit]
      end

      # The simplified that this object represents. Subclasses
      # should override this method.
      def type; end

      # Takes an input from the database, or from attribute setters,
      # and casts it to a type appropriate for this object. This method
      # should not be overriden by subclasses. Instead, override `cast_value`.
      def type_cast(value)
        cast_value(value) unless value.nil?
      end

      def type_cast_for_database(value)
        type_cast_for_write(value)
      end

      def type_cast_for_schema(value)
        value.inspect
      end

      def text?
        false
      end

      def number?
        false
      end

      def binary?
        false
      end

      def serialized?
        false
      end

      def klass # :nodoc:
        ::Object
      end

      def type_cast_for_write(value) # :nodoc:
        value
      end

      private

      # Responsible for casting values from external sources to the appropriate
      # type. Called by `type_cast` for all values except `nil`.
      def cast_value(value) # :api: public
        value
      end
    end
  end
end