Class: ActiveRecord::ConnectionAdapters::Column
- Inherits:
-
Object
- Object
- ActiveRecord::ConnectionAdapters::Column
- Defined in:
- lib/active_record/connection_adapters/abstract/schema_definitions.rb
Overview
An abstract definition of a column in a table.
Direct Known Subclasses
Defined Under Namespace
Modules: Format
Instance Attribute Summary collapse
-
#default ⇒ Object
readonly
Returns the value of attribute default.
-
#limit ⇒ Object
readonly
Returns the value of attribute limit.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#null ⇒ Object
readonly
Returns the value of attribute null.
-
#precision ⇒ Object
readonly
Returns the value of attribute precision.
-
#primary ⇒ Object
Returns the value of attribute primary.
-
#scale ⇒ Object
readonly
Returns the value of attribute scale.
-
#sql_type ⇒ Object
readonly
Returns the value of attribute sql_type.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
Class Method Summary collapse
-
.binary_to_string(value) ⇒ Object
Used to convert from BLOBs to Strings.
-
.string_to_binary(value) ⇒ Object
Used to convert from Strings to BLOBs.
- .string_to_date(string) ⇒ Object
- .string_to_dummy_time(string) ⇒ Object
- .string_to_time(string) ⇒ Object
-
.value_to_boolean(value) ⇒ Object
convert something to a boolean.
-
.value_to_decimal(value) ⇒ Object
convert something to a BigDecimal.
Instance Method Summary collapse
- #extract_default(default) ⇒ Object
-
#human_name ⇒ Object
Returns the human name of the column name.
-
#initialize(name, default, sql_type = nil, null = true) ⇒ Column
constructor
Instantiates a new column in the table.
-
#klass ⇒ Object
Returns the Ruby class that corresponds to the abstract data type.
- #number? ⇒ Boolean
- #text? ⇒ Boolean
-
#type_cast(value) ⇒ Object
Casts value (which is a String) to an appropriate instance.
- #type_cast_code(var_name) ⇒ Object
Constructor Details
#initialize(name, default, sql_type = nil, null = true) ⇒ Column
Instantiates a new column in the table.
name
is the column’s name, such as supplier_id
in supplier_id int(11)
. default
is the type-casted default value, such as new
in sales_stage varchar(20) default 'new'
. sql_type
is only used to extract the column’s length, if necessary. For example 60
in company_name varchar(60)
. null
determines if this column allows NULL
values.
23 24 25 26 27 28 29 30 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 23 def initialize(name, default, sql_type = nil, null = true) @name, @sql_type, @null = name, sql_type, null @limit, @precision, @scale = extract_limit(sql_type), extract_precision(sql_type), extract_scale(sql_type) @type = simplified_type(sql_type) @default = extract_default(default) @primary = nil end |
Instance Attribute Details
#default ⇒ Object (readonly)
Returns the value of attribute default.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def default @default end |
#limit ⇒ Object (readonly)
Returns the value of attribute limit.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def limit @limit end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def name @name end |
#null ⇒ Object (readonly)
Returns the value of attribute null.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def null @null end |
#precision ⇒ Object (readonly)
Returns the value of attribute precision.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def precision @precision end |
#primary ⇒ Object
Returns the value of attribute primary.
15 16 17 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 15 def primary @primary end |
#scale ⇒ Object (readonly)
Returns the value of attribute scale.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def scale @scale end |
#sql_type ⇒ Object (readonly)
Returns the value of attribute sql_type.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def sql_type @sql_type end |
#type ⇒ Object (readonly)
Returns the value of attribute type.
14 15 16 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 14 def type @type end |
Class Method Details
.binary_to_string(value) ⇒ Object
Used to convert from BLOBs to Strings
111 112 113 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 111 def binary_to_string(value) value end |
.string_to_binary(value) ⇒ Object
Used to convert from Strings to BLOBs
106 107 108 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 106 def string_to_binary(value) value end |
.string_to_date(string) ⇒ Object
115 116 117 118 119 120 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 115 def string_to_date(string) return string unless string.is_a?(String) return nil if string.empty? fast_string_to_date(string) || fallback_string_to_date(string) end |
.string_to_dummy_time(string) ⇒ Object
129 130 131 132 133 134 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 129 def string_to_dummy_time(string) return string unless string.is_a?(String) return nil if string.empty? string_to_time "2000-01-01 #{string}" end |
.string_to_time(string) ⇒ Object
122 123 124 125 126 127 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 122 def string_to_time(string) return string unless string.is_a?(String) return nil if string.empty? fast_string_to_time(string) || fallback_string_to_time(string) end |
.value_to_boolean(value) ⇒ Object
convert something to a boolean
137 138 139 140 141 142 143 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 137 def value_to_boolean(value) if value == true || value == false value else %w(true t 1).include?(value.to_s.downcase) end end |
.value_to_decimal(value) ⇒ Object
convert something to a BigDecimal
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 146 def value_to_decimal(value) # Using .class is faster than .is_a? and # subclasses of BigDecimal will be handled # in the else clause if value.class == BigDecimal value elsif value.respond_to?(:to_d) value.to_d else value.to_s.to_d end end |
Instance Method Details
#extract_default(default) ⇒ Object
100 101 102 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 100 def extract_default(default) type_cast(default) end |
#human_name ⇒ Object
Returns the human name of the column name.
Examples
Column.new('sales_stage', ...).human_name # => 'Sales stage'
96 97 98 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 96 def human_name Base.human_attribute_name(@name) end |
#klass ⇒ Object
Returns the Ruby class that corresponds to the abstract data type.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 41 def klass case type when :integer then Fixnum when :float then Float when :decimal then BigDecimal when :datetime then Time when :date then Date when :timestamp then Time when :time then Time when :text, :string then String when :binary then String when :boolean then Object end end |
#number? ⇒ Boolean
36 37 38 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 36 def number? [:float, :integer, :decimal].include? type end |
#text? ⇒ Boolean
32 33 34 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 32 def text? [:string, :text].include? type end |
#type_cast(value) ⇒ Object
Casts value (which is a String) to an appropriate instance.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 57 def type_cast(value) return nil if value.nil? case type when :string then value when :text then value when :integer then value.to_i rescue value ? 1 : 0 when :float then value.to_f when :decimal then self.class.value_to_decimal(value) when :datetime then self.class.string_to_time(value) when :timestamp then self.class.string_to_time(value) when :time then self.class.string_to_dummy_time(value) when :date then self.class.string_to_date(value) when :binary then self.class.binary_to_string(value) when :boolean then self.class.value_to_boolean(value) else value end end |
#type_cast_code(var_name) ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/active_record/connection_adapters/abstract/schema_definitions.rb', line 75 def type_cast_code(var_name) case type when :string then nil when :text then nil when :integer then "(#{var_name}.to_i rescue #{var_name} ? 1 : 0)" when :float then "#{var_name}.to_f" when :decimal then "#{self.class.name}.value_to_decimal(#{var_name})" when :datetime then "#{self.class.name}.string_to_time(#{var_name})" when :timestamp then "#{self.class.name}.string_to_time(#{var_name})" when :time then "#{self.class.name}.string_to_dummy_time(#{var_name})" when :date then "#{self.class.name}.string_to_date(#{var_name})" when :binary then "#{self.class.name}.binary_to_string(#{var_name})" when :boolean then "#{self.class.name}.value_to_boolean(#{var_name})" else nil end end |