Class: Rails::Generators::MasterKeyGenerator
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Base ,
Thor::Group
|
|
Instance Chain:
|
|
Inherits: |
Rails::Generators::Base
|
Defined in: | railties/lib/rails/generators/rails/master_key/master_key_generator.rb |
Constant Summary
-
MASTER_KEY_PATH =
# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 11Pathname.new("config/master.key")
Class Attribute Summary
Base
- Inherited
Class Method Summary
Base
- Inherited
.base_root | Returns the base root for a common set of generators. |
.default_source_root | Returns the default source root for a given generator. |
.desc | Tries to get the description from a USAGE file one folder above the source root otherwise uses a default description. |
.hide! | Convenience method to hide this generator from the available ones when running rails generator command. |
.hook_for | Invoke a generator based on the value supplied by the user to the given option named “name”. |
.namespace | Convenience method to get the namespace from the class name. |
.remove_hook_for | Remove a previously added hook. |
.source_root | Returns the source root for this generator using default_source_root as default. |
.add_shebang_option! | Small macro to add ruby as an option to the generator with proper default value plus an instance helper method called shebang. |
.banner | Use Rails default banner. |
.base_name | Sets the base_name taking into account the current class namespace. |
.default_aliases_for_option | Returns default aliases for the option name given doing a lookup in aliases. |
.default_for_option | Returns default for the option name given doing a lookup in config. |
.default_generator_root, | |
.default_value_for_option | Returns the default value for the option name given doing a lookup in options. |
.generator_name | Removes the namespaces and get the generator name. |
.usage_path, | |
.class_option | |
.inherited | Cache source root and add lib/generators/base/generator/templates to source paths. |
.hooks | Keep hooks configuration that are used on prepare_for_invocation. |
.prepare_for_invocation | Prepare class invocation to search on |
Instance Attribute Summary
Base
- Inherited
Instance Method Summary
- #add_master_key_file
- #add_master_key_file_silently(key = nil)
- #ignore_master_key_file
- #ignore_master_key_file_silently
- #key_file_generator private
- #key_ignore private
Base
- Inherited
#class_collisions | Check whether the given class names are already taken by user application or Ruby on |
#extract_last_module | Takes in an array of nested modules and extracts the last module. |
#indent, | |
#module_namespacing | Wrap block with namespace of current application if namespace exists and is not skipped. |
#namespace, #namespace_dirs, #namespaced_path, #wrap_with_namespace |
Actions
- Included
#add_source | Add the given source to |
#application | Alias for Actions#environment. |
#environment | Adds configuration code to a Rails runtime environment. |
#gem | Adds a |
#gem_group | Wraps gem entries inside a group. |
#generate | Runs another generator. |
#git | Runs one or more git commands. |
#github, | |
#initializer | Creates an initializer file in |
#lib | Creates a file in |
#rails_command | Runs the specified Rails command. |
#rake | Runs the specified Rake task. |
#rakefile | Creates a Rake tasks file in |
#readme | Reads the given file at the source root and prints it in the console. |
#route | Make an entry in Rails routing file |
#vendor | Creates a file in |
#append_file_with_newline | Append string to a file with a newline if necessary. |
#execute_command | Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided. |
#indentation | Indent the |
#log | Define log for backwards compatibility. |
#match_file, | |
#optimize_indentation | Returns optimized string with indentation. |
#quote | Always returns value in double quotes. |
#rebase_indentation | Alias for Actions#optimize_indentation. |
#route_namespace_pattern, | |
#with_indentation | Manage |
#initialize |
Instance Method Details
#add_master_key_file
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 13
def add_master_key_file unless MASTER_KEY_PATH.exist? key = ActiveSupport::EncryptedFile.generate_key log "Adding #{MASTER_KEY_PATH} to store the master encryption key: #{key}" log "" log "Save this in a password manager your team can access." log "" log "If you lose the key, no one, including you, can access anything encrypted with it." log "" add_master_key_file_silently(key) log "" end end
#add_master_key_file_silently(key = nil)
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 29
def add_master_key_file_silently(key = nil) unless MASTER_KEY_PATH.exist? key_file_generator.add_key_file_silently(MASTER_KEY_PATH, key) end end
#ignore_master_key_file
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 35
def ignore_master_key_file key_file_generator.ignore_key_file(MASTER_KEY_PATH, ignore: key_ignore) end
#ignore_master_key_file_silently
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 39
def ignore_master_key_file_silently key_file_generator.ignore_key_file_silently(MASTER_KEY_PATH, ignore: key_ignore) end
#key_file_generator (private)
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 44
def key_file_generator EncryptionKeyFileGenerator.new([], ) end
#key_ignore (private)
[ GitHub ]# File 'railties/lib/rails/generators/rails/master_key/master_key_generator.rb', line 48
def key_ignore [ "", "# Ignore master key for decrypting credentials and more.", "/#{MASTER_KEY_PATH}", "" ].join("\n") end