Class: Rails::Generators::GeneratedAttribute

Inherits:
Object
  • Object
show all
Defined in:
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.



61
62
63
64
65
66
67
 
# File 'lib/rails/generators/generated_attribute.rb', line 61

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_options ⇒ Object (readonly)

Returns the value of attribute attr_options.



12
13
14
 
# File 'lib/rails/generators/generated_attribute.rb', line 12

def attr_options
  @attr_options
end

#index_name ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/rails/generators/generated_attribute.rb', line 115

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

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.parse(column_definition) ⇒ Object 



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

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)
    if UNIQ_INDEX_OPTIONS.include?(has_index)
      attr_options[:index] = { unique: true }
    end
  end

  new(name, type, has_index, attr_options)
end

.reference?(type) ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/rails/generators/generated_attribute.rb', line 36

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

Instance Method Details

#attachment? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/rails/generators/generated_attribute.rb', line 163

def attachment?
  type == :attachment
end

#attachments? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/rails/generators/generated_attribute.rb', line 167

def attachments?
  type == :attachments
end

#column_name ⇒ Object 



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

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

#default ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rails/generators/generated_attribute.rb', line 85

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,
                    :attachment, :attachments,
                    :rich_text                   then nil
               else
                 ""
  end
end

#field_type ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rails/generators/generated_attribute.rb', line 69

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 :rich_text                then :rich_text_area
                  when :boolean                  then :check_box
                  when :attachment, :attachments then :file_field
                  else
                    :text_field
  end
end

#foreign_key? ⇒ Boolean

Returns:

  • (Boolean) 


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

def foreign_key?
  name.end_with?("_id")
end

#has_index? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_index?
  @has_index
end

#has_uniq_index? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_uniq_index?
  @has_uniq_index
end

#human_name ⇒ Object 



111
112
113
 
# File 'lib/rails/generators/generated_attribute.rb', line 111

def human_name
  name.humanize
end

#inject_index_options ⇒ Object 



179
180
181
 
# File 'lib/rails/generators/generated_attribute.rb', line 179

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

#inject_options ⇒ Object 



175
176
177
 
# File 'lib/rails/generators/generated_attribute.rb', line 175

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

#options_for_migration ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/rails/generators/generated_attribute.rb', line 183

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

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

#password_digest? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#plural_name ⇒ Object 



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

def plural_name
  name.delete_suffix("_id").pluralize
end

#polymorphic? ⇒ Boolean

Returns:

  • (Boolean) 


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

def polymorphic?
  attr_options[:polymorphic]
end

#reference? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#required? ⇒ Boolean

Returns:

  • (Boolean) 


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

def required?
  reference? && Rails.application.config.active_record.belongs_to_required_by_default
end

#rich_text? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/rails/generators/generated_attribute.rb', line 159

def rich_text?
  type == :rich_text
end

#singular_name ⇒ Object 



107
108
109
 
# File 'lib/rails/generators/generated_attribute.rb', line 107

def singular_name
  name.delete_suffix("_id").singularize
end

#token? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/rails/generators/generated_attribute.rb', line 155

def token?
  type == :token
end

#virtual? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/rails/generators/generated_attribute.rb', line 171

def virtual?
  rich_text? || attachment? || attachments?
end