Class: Rails::Generators::GeneratedAttribute

Inherits:
Object
  • Object
show all
Defined in:
railties/lib/rails/generators/generated_attribute.rb

Overview

:nodoc:

Constant Summary collapse

INDEX_OPTIONS =
%w(index uniq)
UNIQ_INDEX_OPTIONS =
%w(uniq)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, type = nil, index_type = false, attr_options = {}) ⇒ GeneratedAttribute

Returns a new instance of GeneratedAttribute.


58
59
60
61
62
63
64
# File 'railties/lib/rails/generators/generated_attribute.rb', line 58

def initialize(name, type=nil, index_type=false, attr_options={})
  @name           = name
  @type           = type || :string
  @has_index      = INDEX_OPTIONS.include?(index_type)
  @has_uniq_index = UNIQ_INDEX_OPTIONS.include?(index_type)
  @attr_options   = attr_options
end

Instance Attribute Details

#attr_optionsObject (readonly)

Returns the value of attribute attr_options


10
11
12
# File 'railties/lib/rails/generators/generated_attribute.rb', line 10

def attr_options
  @attr_options
end

#index_nameObject


108
109
110
111
112
113
114
# File 'railties/lib/rails/generators/generated_attribute.rb', line 108

def index_name
  @index_name ||= if polymorphic?
    %w(id type).map { |t| "#{name}_#{t}" }
  else
    column_name
  end
end

#nameObject

Returns the value of attribute name


9
10
11
# File 'railties/lib/rails/generators/generated_attribute.rb', line 9

def name
  @name
end

#typeObject

Returns the value of attribute type


9
10
11
# File 'railties/lib/rails/generators/generated_attribute.rb', line 9

def type
  @type
end

Class Method Details

.parse(column_definition) ⇒ Object


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'railties/lib/rails/generators/generated_attribute.rb', line 14

def parse(column_definition)
  name, type, has_index = column_definition.split(':')

  # if user provided "name:index" instead of "name:string:index"
  # type should be set blank so GeneratedAttribute's constructor
  # could set it to :string
  has_index, type = type, nil if INDEX_OPTIONS.include?(type)

  type, attr_options = *parse_type_and_options(type)
  type = type.to_sym if type

  if type && reference?(type)
    references_index = UNIQ_INDEX_OPTIONS.include?(has_index) ? { unique: true } : true
    attr_options[:index] = references_index
  end

  new(name, type, has_index, attr_options)
end

.reference?(type) ⇒ Boolean

Returns:

  • (Boolean)

33
34
35
# File 'railties/lib/rails/generators/generated_attribute.rb', line 33

def reference?(type)
  [:references, :belongs_to].include? type
end

Instance Method Details

#column_nameObject


116
117
118
# File 'railties/lib/rails/generators/generated_attribute.rb', line 116

def column_name
  @column_name ||= reference? ? "#{name}_id" : name
end

#defaultObject


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'railties/lib/rails/generators/generated_attribute.rb', line 80

def default
  @default ||= case type
    when :integer                     then 1
    when :float                       then 1.5
    when :decimal                     then "9.99"
    when :datetime, :timestamp, :time then Time.now.to_s(:db)
    when :date                        then Date.today.to_s(:db)
    when :string                      then name == "type" ? "" : "MyString"
    when :text                        then "MyText"
    when :boolean                     then false
    when :references, :belongs_to     then nil
    else
      ""
  end
end

#field_typeObject


66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'railties/lib/rails/generators/generated_attribute.rb', line 66

def field_type
  @field_type ||= case type
    when :integer              then :number_field
    when :float, :decimal      then :text_field
    when :time                 then :time_select
    when :datetime, :timestamp then :datetime_select
    when :date                 then :date_select
    when :text                 then :text_area
    when :boolean              then :check_box
    else
      :text_field
  end
end

#foreign_key?Boolean

Returns:

  • (Boolean)

120
121
122
# File 'railties/lib/rails/generators/generated_attribute.rb', line 120

def foreign_key?
  !!(name =~ /_id$/)
end

#has_index?Boolean

Returns:

  • (Boolean)

136
137
138
# File 'railties/lib/rails/generators/generated_attribute.rb', line 136

def has_index?
  @has_index
end

#has_uniq_index?Boolean

Returns:

  • (Boolean)

140
141
142
# File 'railties/lib/rails/generators/generated_attribute.rb', line 140

def has_uniq_index?
  @has_uniq_index
end

#human_nameObject


104
105
106
# File 'railties/lib/rails/generators/generated_attribute.rb', line 104

def human_name
  name.humanize
end

#inject_index_optionsObject


152
153
154
# File 'railties/lib/rails/generators/generated_attribute.rb', line 152

def inject_index_options
  has_uniq_index? ? ", unique: true" : ""
end

#inject_optionsObject


148
149
150
# File 'railties/lib/rails/generators/generated_attribute.rb', line 148

def inject_options
  "".tap { |s| options_for_migration.each { |k,v| s << ", #{k}: #{v.inspect}" } }
end

#options_for_migrationObject


156
157
158
159
160
161
162
163
164
165
166
167
# File 'railties/lib/rails/generators/generated_attribute.rb', line 156

def options_for_migration
  @attr_options.dup.tap do |options|
    if required?
      options.delete(:required)
      options[:null] = false
    end

    if reference? && !polymorphic?
      options[:foreign_key] = true
    end
  end
end

#password_digest?Boolean

Returns:

  • (Boolean)

144
145
146
# File 'railties/lib/rails/generators/generated_attribute.rb', line 144

def password_digest?
  name == 'password' && type == :digest 
end

#plural_nameObject


96
97
98
# File 'railties/lib/rails/generators/generated_attribute.rb', line 96

def plural_name
  name.sub(/_id$/, '').pluralize
end

#polymorphic?Boolean

Returns:

  • (Boolean)

128
129
130
# File 'railties/lib/rails/generators/generated_attribute.rb', line 128

def polymorphic?
  self.attr_options[:polymorphic]
end

#reference?Boolean

Returns:

  • (Boolean)

124
125
126
# File 'railties/lib/rails/generators/generated_attribute.rb', line 124

def reference?
  self.class.reference?(type)
end

#required?Boolean

Returns:

  • (Boolean)

132
133
134
# File 'railties/lib/rails/generators/generated_attribute.rb', line 132

def required?
  self.attr_options[:required]
end

#singular_nameObject


100
101
102
# File 'railties/lib/rails/generators/generated_attribute.rb', line 100

def singular_name
  name.sub(/_id$/, '').singularize
end