Class: Rails::Generators::ScaffoldControllerGenerator

Do not use. This class is for internal use only.

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `NamedBase`, `Base`, Thor::Group
Instance Chain: self, `ResourceHelpers`, `NamedBase`, `Base`, `Actions`, Thor::Actions, Thor::Group
Inherits:	Rails::Generators::NamedBase `::Object` Thor::Group Rails::Generators::Base Rails::Generators::NamedBase Rails::Generators::ScaffoldControllerGenerator
Defined in:	railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

Class Attribute Summary

`Base` - Inherited

.exit_on_failure?

Class Method Summary

`NamedBase` - Inherited

.check_class_collision	Add a class collisions name to be checked on class initialization.
.new

`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	Make class option aware of options and aliases.
.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 `::Rails` namespace if a previous added hook is being used.

Instance Attribute Summary

`ResourceHelpers` - Included

#controller_file_name, #controller_name

`NamedBase` - Inherited

#file_name, #inside_template, #inside_template?, #mountable_engine?, #pluralize_table_names?, #uncountable?

`Base` - Inherited

#namespaced?

Instance Method Summary

#create_controller_files
#attachments?(name) ⇒ Boolean private
#permitted_params private

`ResourceHelpers` - Included

#initialize	Set controller variables on initialization.
#assign_controller_names!, #controller_class_name, #controller_class_path, #controller_file_path, #controller_i18n_scope,
#orm_class	Loads the `ORM::Generators::ActiveModel` class.
#orm_instance	Initialize `ORM::Generators::ActiveModel` to access instance methods.

`NamedBase` - Inherited

#application_name	Tries to retrieve the application name or simply return application.
#assign_names!, #attributes_names, #class_name, #class_path, #edit_helper, #file_path, #fixture_file_name, #human_name, #i18n_scope, #index_helper, #model_resource_name, #namespaced_class_path, #new_helper,
#parse_attributes!	Convert attributes array into `GeneratedAttribute` objects.
#plural_file_name, #plural_name, #plural_route_name, #plural_table_name, #redirect_resource_name, #regular_class_path, #route_url, #show_helper,
#singular_name	FIXME: We are avoiding to use alias because a bug on thor that make this method public and add it to the task list.
#singular_route_name, #singular_table_name, #table_name, #url_helper_prefix

`Base` - Inherited

#class_collisions	Check whether the given class names are already taken by user application or Ruby on `::Rails`.
#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 `Gemfile`
#application	Alias for Actions#environment.
#environment	Adds configuration code to a Rails runtime environment.
#gem	Adds a `gem` declaration to the `Gemfile` for the specified gem.
#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 `config/initializers/`.
#lib	Creates a file in `lib/`.
#rails_command	Runs the specified Rails command.
#rake	Runs the specified Rake task.
#rakefile	Creates a Rake tasks file in `lib/tasks/`.
#readme	Reads the given file at the source root and prints it in the console.
#route	Make an entry in Rails routing file `config/routes.rb`.
#vendor	Creates a file in `vendor/`.
#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 `Gemfile` to the depth of @indentation.
#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 `Gemfile` indentation for a DSL action block.
#initialize

Constructor Details

This class inherits a constructor from Rails::Generators::NamedBase

Instance Method Details

#attachments?(name) ⇒ `Boolean` (private)

[ GitHub ]

# File 'railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb', line 50


def attachments?(name)
  attribute = attributes.find { |attr| attr.name == name }
  attribute&.attachments?
end

#create_controller_files

[ GitHub ]

# File 'railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb', line 22


def create_controller_files
  template_file = options.api? ? "api_controller.rb" : "controller.rb"
  template template_file, File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
end

#permitted_params (private)

[ GitHub ]

# File 'railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb', line 43


def permitted_params
  attachments, others = attributes_names.partition { |name| attachments?(name) }
  params = others.map { |name| ":#{name}" }
  params += attachments.map { |name| "#{name}: []" }
  params.join(", ")
end

Class: Rails::Generators::ScaffoldControllerGenerator

Class Attribute Summary

Base - Inherited

Class Method Summary

NamedBase - Inherited

Base - Inherited

Instance Attribute Summary

ResourceHelpers - Included

NamedBase - Inherited

Base - Inherited

Instance Method Summary

ResourceHelpers - Included

NamedBase - Inherited

Base - Inherited

Actions - Included

Constructor Details

Instance Method Details

#attachments?(name) ⇒ Boolean (private)

#create_controller_files

#permitted_params (private)

`Base` - Inherited

`NamedBase` - Inherited

`Base` - Inherited

`ResourceHelpers` - Included

`NamedBase` - Inherited

`Base` - Inherited

`ResourceHelpers` - Included

`NamedBase` - Inherited

`Base` - Inherited

`Actions` - Included

#attachments?(name) ⇒ `Boolean` (private)