Class: ActiveRecord::Generators::DeviseGenerator

Inherits:
Base
  • Object
show all
Includes:
Devise::Generators::OrmHelpers
Defined in:
lib/generators/active_record/devise_generator.rb

Instance Method Summary collapse

Methods included from Devise::Generators::OrmHelpers

#model_contents

Instance Method Details

#ar_configObject


97
98
99
100
101
102
103
104
105
106
107
# File 'lib/generators/active_record/devise_generator.rb', line 97

def ar_config
  if ActiveRecord::Base.configurations.respond_to?(:configs_for)
    if rails61_and_up?
      ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: "primary").configuration_hash
    else
      ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, spec_name: "primary").config
    end
  else
    ActiveRecord::Base.configurations[Rails.env]
  end
end

#copy_devise_migrationObject


16
17
18
19
20
21
22
# File 'lib/generators/active_record/devise_generator.rb', line 16

def copy_devise_migration
  if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
    migration_template "migration_existing.rb", "#{migration_path}/add_devise_to_#{table_name}.rb", migration_version: migration_version
  else
    migration_template "migration.rb", "#{migration_path}/devise_create_#{table_name}.rb", migration_version: migration_version
  end
end

#generate_modelObject


24
25
26
# File 'lib/generators/active_record/devise_generator.rb', line 24

def generate_model
  invoke "active_record:model", [name], migration: false unless model_exists? && behavior == :invoke
end

#inet?Boolean

Returns:

  • (Boolean)

81
82
83
# File 'lib/generators/active_record/devise_generator.rb', line 81

def inet?
  postgresql?
end

#inject_devise_contentObject


28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/generators/active_record/devise_generator.rb', line 28

def inject_devise_content
  content = model_contents

  class_path = if namespaced?
    class_name.to_s.split("::")
  else
    [class_name]
  end

  indent_depth = class_path.size - 1
  content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"

  inject_into_class(model_path, class_path.last, content) if model_exists?
end

#ip_columnObject


76
77
78
79
# File 'lib/generators/active_record/devise_generator.rb', line 76

def ip_column
  # Padded with spaces so it aligns nicely with the rest of the columns.
  "%-8s" % (inet? ? "inet" : "string")
end

#migration_dataObject


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
68
69
70
71
72
73
74
# File 'lib/generators/active_record/devise_generator.rb', line 43

def migration_data
<<RUBY
## Database authenticatable
t.string :email,              null: false, default: ""
t.string :encrypted_password, null: false, default: ""

## Recoverable
t.string   :reset_password_token
t.datetime :reset_password_sent_at

## Rememberable
t.datetime :remember_created_at

## Trackable
# t.integer  :sign_in_count, default: 0, null: false
# t.datetime :current_sign_in_at
# t.datetime :last_sign_in_at
# t.#{ip_column} :current_sign_in_ip
# t.#{ip_column} :last_sign_in_ip

## Confirmable
# t.string   :confirmation_token
# t.datetime :confirmed_at
# t.datetime :confirmation_sent_at
# t.string   :unconfirmed_email # Only if using reconfirmable

## Lockable
# t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
# t.string   :unlock_token # Only if unlock strategy is :email or :both
# t.datetime :locked_at
RUBY
end

#migration_versionObject


109
110
111
112
113
# File 'lib/generators/active_record/devise_generator.rb', line 109

def migration_version
  if rails5_and_up?
    "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
  end
end

#postgresql?Boolean

Returns:

  • (Boolean)

93
94
95
# File 'lib/generators/active_record/devise_generator.rb', line 93

def postgresql?
  ar_config && ar_config['adapter'] == 'postgresql'
end

#primary_key_stringObject


119
120
121
122
# File 'lib/generators/active_record/devise_generator.rb', line 119

def primary_key_string
  key_string = options[:primary_key_type]
  ", id: :#{key_string}" if key_string
end

#primary_key_typeObject


115
116
117
# File 'lib/generators/active_record/devise_generator.rb', line 115

def primary_key_type
  primary_key_string if rails5_and_up?
end

#rails5_and_up?Boolean

Returns:

  • (Boolean)

85
86
87
# File 'lib/generators/active_record/devise_generator.rb', line 85

def rails5_and_up?
  Rails::VERSION::MAJOR >= 5
end

#rails61_and_up?Boolean

Returns:

  • (Boolean)

89
90
91
# File 'lib/generators/active_record/devise_generator.rb', line 89

def rails61_and_up?
  Rails::VERSION::MAJOR > 6 || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR >= 1)
end