Rails::Generators::Actions

<!DOCTYPE html> <html lang="en"> <head> <title>Rails::Generators::Actions</title> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="stylesheet" href="../../../css/reset.css" type="text/css" media="screen" /> <link rel="stylesheet" href="../../../css/panel.css" type="text/css" media="screen" /> <link rel="stylesheet" href="../../../css/main.css" type="text/css" media="screen" /> <link rel="stylesheet" href="../../../css/github.css" type="text/css" media="screen" /> <script src="../../../js/jquery-3.5.1.min.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/main.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/turbolinks.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/search_index.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/searcher.js" type="text/javascript" charset="utf-8"></script> <script src="../../../panel/tree.js" type="text/javascript" charset="utf-8"></script> <script src="../../../js/searchdoc.js" type="text/javascript" charset="utf-8"></script> <meta name="data-rel-prefix" content="../../../"> <meta name="data-tree-keys" content='["Rails", "Generators", "Actions"]'> <meta property="og:title" value="Rails::Generators::Actions"> <meta name="keywords" content="Rails::Generators::Actions class, gem, gem_group, github, add_source, environment, application, git, vendor, lib, rakefile, initializer, generate, rake, rails_command, route, readme, log, execute_command, quote, optimize_indentation, indentation, with_indentation"> </head> <body> <a class="sr-only sr-only-focusable" href="#content" data-turbolinks="false">Skip to Content</a> <a class="sr-only sr-only-focusable" href="#search" data-turbolinks="false">Skip to Search</a> <input type="checkbox" id="hamburger" class="panel_checkbox"> <label class="panel_mobile_button" for="hamburger"> Menu</label> <nav class="panel panel_tree" id="panel" data-turbolinks-permanent> <div class="header"> <input type="text" placeholder="Search (/) for a class, method, ..." autosave="searchdoc" results="10" id="search" autocomplete="off" tabindex="-1" /> <label class="panel_mobile_button_close" for="hamburger"> Close</label> </div> <div class="tree"> <ul> </ul> </div> <div class="result"> <ul> </ul> </div> <a href="links.html" id="links">index</a> </nav> <div class="banner"> Ruby on Rails 8.0.0 <h2> Module Rails::Generators::Actions </h2> <ul class="files"> <li><a href="../../../files/railties/lib/rails/generators/actions_rb.html">railties/lib/rails/generators/actions.rb</a></li> <li><a href="../../../files/railties/lib/rails/generators/actions/create_migration_rb.html">railties/lib/rails/generators/actions/create_migration.rb</a></li> <li><a href="../../../files/railties/lib/rails/generators/migration_rb.html">railties/lib/rails/generators/migration.rb</a></li> </ul> <div id="version-badge">v8.0.0</div> </div> <main id="bodyContent"> <div id="content">  <div class="sectiontitle">Methods</div> <dl class="methods"> <dt>A</dt> <dd> <ul> <li> <a href="#method-i-add_source">add_source</a>, </li> <li> <a href="#method-i-application">application</a> </li> </ul> </dd> <dt>E</dt> <dd> <ul> <li> <a href="#method-i-environment">environment</a>, </li> <li> <a href="#method-i-execute_command">execute_command</a> </li> </ul> </dd> <dt>G</dt> <dd> <ul> <li> <a href="#method-i-gem">gem</a>, </li> <li> <a href="#method-i-gem_group">gem_group</a>, </li> <li> <a href="#method-i-generate">generate</a>, </li> <li> <a href="#method-i-git">git</a>, </li> <li> <a href="#method-i-github">github</a> </li> </ul> </dd> <dt>I</dt> <dd> <ul> <li> <a href="#method-i-indentation">indentation</a>, </li> <li> <a href="#method-i-initializer">initializer</a> </li> </ul> </dd> <dt>L</dt> <dd> <ul> <li> <a href="#method-i-lib">lib</a>, </li> <li> <a href="#method-i-log">log</a> </li> </ul> </dd> <dt>O</dt> <dd> <ul> <li> <a href="#method-i-optimize_indentation">optimize_indentation</a> </li> </ul> </dd> <dt>Q</dt> <dd> <ul> <li> <a href="#method-i-quote">quote</a> </li> </ul> </dd> <dt>R</dt> <dd> <ul> <li> <a href="#method-i-rails_command">rails_command</a>, </li> <li> <a href="#method-i-rake">rake</a>, </li> <li> <a href="#method-i-rakefile">rakefile</a>, </li> <li> <a href="#method-i-readme">readme</a>, </li> <li> <a href="#method-i-route">route</a> </li> </ul> </dd> <dt>V</dt> <dd> <ul> <li> <a href="#method-i-vendor">vendor</a> </li> </ul> </dd> <dt>W</dt> <dd> <ul> <li> <a href="#method-i-with_indentation">with_indentation</a> </li> </ul> </dd> </dl>  <h2 class="sectiontitle">Instance Public methods</h2> <div class="method"> <h3 class="title method-title" id="method-i-add_source"> add_source(source, options = {}, &block) <a href="../../../classes/Rails/Generators/Actions.html#method-i-add_source" name="method-i-add_source" class="permalink">Link</a> </h3> <div class="description"> Add the given source to <code>Gemfile</code> If block is given, gem entries in block are wrapped into the source group. <pre><code>add_source "http://gems.github.com/" add_source "http://gems.github.com/" do gem "rspec-rails" end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-add_source_source')" id="l_method-i-add_source_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L151" target="_blank" class="github_url">on GitHub</a> <div id="method-i-add_source_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 151 def add_source(source, options = {}, &block) log :source, source in_root do if block append_file_with_newline "Gemfile", "\nsource #{quote(source)} do", force: true with_indentation(&block) append_file_with_newline "Gemfile", "end", force: true else prepend_file "Gemfile", "source #{quote(source)}\n", verbose: false end end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-application"> application(data = nil, options = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-application" name="method-i-application" class="permalink">Link</a> </h3> <div class="description"> </div> <div class="aka"> Alias for: <a href="Actions.html#method-i-environment">environment</a> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-environment"> environment(data = nil, options = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-environment" name="method-i-environment" class="permalink">Link</a> </h3> <div class="description"> Adds configuration code to a Rails runtime environment. By default, adds code inside the <code>Application</code> class in <code>config/application.rb</code> so that it applies to all environments. <pre><code>environment %(config.asset_host = "cdn.provider.com") </code></pre> Results in: <pre><code># config/application.rb class Application < Rails::Application config.asset_host = "cdn.provider.com" # ... end </code></pre> If the <code>:env</code> option is specified, the code will be added to the corresponding file in <code>config/environments</code> instead. <pre><code>environment %(config.asset_host = "localhost:3000"), env: "development" </code></pre> Results in: <pre><code># config/environments/development.rb Rails.application.configure do config.asset_host = "localhost:3000" # ... end </code></pre> <code>:env</code> can also be an array. In which case, the code is added to each corresponding file in <code>config/environments</code>. The code can also be specified as the return value of the block: <pre><code>environment do %(config.asset_host = "cdn.provider.com") end environment(nil, env: "development") do %(config.asset_host = "localhost:3000") end </code></pre> </div> <div class="aka"> Also aliased as: <a href="Actions.html#method-i-application">application</a> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-environment_source')" id="l_method-i-environment_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L206" target="_blank" class="github_url">on GitHub</a> <div id="method-i-environment_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 206 def environment(data = nil, options = {}) sentinel = "class Application < Rails::Application\n" env_file_sentinel = "Rails.application.configure do\n" data ||= yield if block_given? in_root do if options[:env].nil? inject_into_file "config/application.rb", optimize_indentation(data, 4), after: sentinel, verbose: false else Array(options[:env]).each do |env| inject_into_file "config/environments/#{env}.rb", optimize_indentation(data, 2), after: env_file_sentinel, verbose: false end end end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-gem"> gem(*args) <a href="../../../classes/Rails/Generators/Actions.html#method-i-gem" name="method-i-gem" class="permalink">Link</a> </h3> <div class="description"> Adds a <code>gem</code> declaration to the <code>Gemfile</code> for the specified gem. <pre><code>gem "rspec", group: :test gem "technoweenie-restful-authentication", lib: "restful-authentication", source: "http://gems.github.com/" gem "rails", "3.0", git: "https://github.com/rails/rails" gem "RedCloth", ">= 4.1.0", "< 4.2.0" gem "rspec", comment: "Put this comment above the gem declaration" </code></pre> Note that this method only adds the gem to the <code>Gemfile</code>; it does not install the gem. <h4 id="method-i-gem-label-Options">Options</h4> <dl class="rdoc-list label-list"><dt><code>:version</code> <dd> The version constraints for the gem, specified as a string or an array of strings: <pre><code>gem "my_gem", version: "~> 1.1" gem "my_gem", version: [">= 1.1", "< 2.0"] </code></pre> Alternatively, can be specified as one or more arguments following the gem name: <pre><code>gem "my_gem", ">= 1.1", "< 2.0" </code></pre> </dd><dt><code>:comment</code> <dd> Outputs a comment above the <code>gem</code> declaration in the <code>Gemfile</code>. <pre><code>gem "my_gem", comment: "First line.\nSecond line." </code></pre> Outputs: <pre><code># First line. # Second line. gem "my_gem" </code></pre> </dd><dt><code>:group</code> <dd> The gem group in the <code>Gemfile</code> that the gem belongs to. </dd><dt><code>:git</code> <dd> The URL of the git repository for the gem. </dd></dl> Any additional options passed to this method will be appended to the <code>gem</code> declaration in the <code>Gemfile</code>. For example: <pre><code>gem "my_gem", comment: "Edge my_gem", git: "https://example.com/my_gem.git", branch: "master" </code></pre> Outputs: <pre><code># Edge my_gem gem "my_gem", git: "https://example.com/my_gem.git", branch: "master" </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-gem_source')" id="l_method-i-gem_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L67" target="_blank" class="github_url">on GitHub</a> <div id="method-i-gem_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 67 def gem(*args) options = args.extract_options! name, *versions = args # Set the message to be shown in logs. Uses the git repo if one is given, # otherwise use name (version). parts, message = [ quote(name) ], name.dup # Output a comment above the gem declaration. comment = options.delete(:comment) if versions = versions.any? ? versions : options.delete(:version) _versions = Array(versions) _versions.each do |version| parts << quote(version) end message << " (#{_versions.join(", ")})" end message = options[:git] if options[:git] log :gemfile, message parts << quote(options) unless options.empty? in_root do str = [] if comment comment.each_line do |comment_line| str << indentation str << "# #{comment_line}" end str << "\n" end str << indentation str << "gem #{parts.join(", ")}" append_file_with_newline "Gemfile", str.join, verbose: false end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-gem_group"> gem_group(*names, &block) <a href="../../../classes/Rails/Generators/Actions.html#method-i-gem_group" name="method-i-gem_group" class="permalink">Link</a> </h3> <div class="description"> Wraps gem entries inside a group. <pre><code>gem_group :development, :test do gem "rspec-rails" end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-gem_group_source')" id="l_method-i-gem_group_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L111" target="_blank" class="github_url">on GitHub</a> <div id="method-i-gem_group_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 111 def gem_group(*names, &block) options = names.extract_options! str = names.map(&:inspect) str << quote(options) unless options.empty? str = str.join(", ") log :gemfile, "group #{str}" in_root do append_file_with_newline "Gemfile", "\ngroup #{str} do", force: true with_indentation(&block) append_file_with_newline "Gemfile", "end", force: true end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-generate"> generate(what, *args) <a href="../../../classes/Rails/Generators/Actions.html#method-i-generate" name="method-i-generate" class="permalink">Link</a> </h3> <div class="description"> Runs another generator. <pre><code>generate "scaffold", "Post title:string body:text" generate "scaffold", "Post", "title:string", "body:text" </code></pre> The first argument is the generator name, and the remaining arguments are joined together and passed to the generator. </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-generate_source')" id="l_method-i-generate_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L332" target="_blank" class="github_url">on GitHub</a> <div id="method-i-generate_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 332 def generate(what, *args) log :generate, what options = args.extract_options! options[:abort_on_failure] = !options[:inline] rails_command "generate #{what} #{args.join(" ")}", options end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-git"> git(commands = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-git" name="method-i-git" class="permalink">Link</a> </h3> <div class="description"> Runs one or more git commands. <pre><code>git :init # => runs `git init` git add: "this.file that.rb" # => runs `git add this.file that.rb` git commit: "-m 'First commit'" # => runs `git commit -m 'First commit'` git add: "good.rb", rm: "bad.cxx" # => runs `git add good.rb; git rm bad.cxx` </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-git_source')" id="l_method-i-git_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L237" target="_blank" class="github_url">on GitHub</a> <div id="method-i-git_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 237 def git(commands = {}) if commands.is_a?(Symbol) run "git #{commands}" else commands.each do |cmd, options| run "git #{cmd} #{options}" end end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-github"> github(repo, options = {}, &block) <a href="../../../classes/Rails/Generators/Actions.html#method-i-github" name="method-i-github" class="permalink">Link</a> </h3> <div class="description"> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-github_source')" id="l_method-i-github_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L125" target="_blank" class="github_url">on GitHub</a> <div id="method-i-github_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 125 def github(repo, options = {}, &block) str = [quote(repo)] str << quote(options) unless options.empty? str = str.join(", ") log :github, "github #{str}" in_root do if @indentation.zero? append_file_with_newline "Gemfile", "\ngithub #{str} do", force: true else append_file_with_newline "Gemfile", "#{indentation}github #{str} do", force: true end with_indentation(&block) append_file_with_newline "Gemfile", "#{indentation}end", force: true end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-initializer"> initializer(filename, data = nil) <a href="../../../classes/Rails/Generators/Actions.html#method-i-initializer" name="method-i-initializer" class="permalink">Link</a> </h3> <div class="description"> Creates an initializer file in <code>config/initializers/</code>. The code can be specified as an argument or as the return value of the block. <pre><code>initializer "api.rb", <<~RUBY API_KEY = "123456" RUBY initializer "api.rb" do %(API_KEY = "123456") end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-initializer_source')" id="l_method-i-initializer_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L319" target="_blank" class="github_url">on GitHub</a> <div id="method-i-initializer_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 319 def initializer(filename, data = nil) log :initializer, filename data ||= yield if block_given? create_file("config/initializers/#{filename}", optimize_indentation(data), verbose: false) end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-lib"> lib(filename, data = nil) <a href="../../../classes/Rails/Generators/Actions.html#method-i-lib" name="method-i-lib" class="permalink">Link</a> </h3> <div class="description"> Creates a file in <code>lib/</code>. The contents can be specified as an argument or as the return value of the block. <pre><code>lib "foreign.rb", <<~RUBY # Foreign code is fun RUBY lib "foreign.rb" do "# Foreign code is fun" end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-lib_source')" id="l_method-i-lib_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L275" target="_blank" class="github_url">on GitHub</a> <div id="method-i-lib_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 275 def lib(filename, data = nil) log :lib, filename data ||= yield if block_given? create_file("lib/#{filename}", optimize_indentation(data), verbose: false) end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-rails_command"> rails_command(command, options = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-rails_command" name="method-i-rails_command" class="permalink">Link</a> </h3> <div class="description"> Runs the specified Rails command. <pre><code>rails_command "db:migrate" rails_command "db:migrate", env: "production" rails_command "db:migrate", abort_on_failure: true rails_command "stats", capture: true rails_command "gems:install", sudo: true </code></pre> <h4 id="method-i-rails_command-label-Options">Options</h4> <dl class="rdoc-list label-list"><dt><code>:env</code> <dd> The Rails environment in which to run the command. Defaults to <code>ENV["RAILS_ENV"] || "development"</code>. </dd><dt><code>:abort_on_failure</code> <dd> Whether to halt the generator if the command exits with a non-success exit status. </dd><dt><code>:capture</code> <dd> Whether to capture and return the output of the command. </dd><dt><code>:sudo</code> <dd> Whether to run the command using <code>sudo</code>. </dd></dl> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-rails_command_source')" id="l_method-i-rails_command_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L391" target="_blank" class="github_url">on GitHub</a> <div id="method-i-rails_command_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 391 def rails_command(command, options = {}) if options[:inline] log :rails, command command, *args = Shellwords.split(command) in_root do silence_warnings do ::Rails::Command.invoke(command, args, **options) end end else execute_command :rails, command, options end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-rake"> rake(command, options = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-rake" name="method-i-rake" class="permalink">Link</a> </h3> <div class="description"> Runs the specified Rake task. <pre><code>rake "db:migrate" rake "db:migrate", env: "production" rake "db:migrate", abort_on_failure: true rake "stats", capture: true rake "gems:install", sudo: true </code></pre> <h4 id="method-i-rake-label-Options">Options</h4> <dl class="rdoc-list label-list"><dt><code>:env</code> <dd> The Rails environment in which to run the task. Defaults to <code>ENV["RAILS_ENV"] || "development"</code>. </dd><dt><code>:abort_on_failure</code> <dd> Whether to halt the generator if the task exits with a non-success exit status. </dd><dt><code>:capture</code> <dd> Whether to capture and return the output of the task. </dd><dt><code>:sudo</code> <dd> Whether to run the task using <code>sudo</code>. </dd></dl> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-rake_source')" id="l_method-i-rake_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L364" target="_blank" class="github_url">on GitHub</a> <div id="method-i-rake_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 364 def rake(command, options = {}) execute_command :rake, command, options end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-rakefile"> rakefile(filename, data = nil) <a href="../../../classes/Rails/Generators/Actions.html#method-i-rakefile" name="method-i-rakefile" class="permalink">Link</a> </h3> <div class="description"> Creates a Rake tasks file in <code>lib/tasks/</code>. The code can be specified as an argument or as the return value of the block. <pre><code>rakefile "bootstrap.rake", <<~RUBY task :bootstrap do puts "Boots! Boots! Boots!" end RUBY rakefile "bootstrap.rake" do project = ask("What is the UNIX name of your project?") <<~RUBY namespace :#{project} do task :bootstrap do puts "Boots! Boots! Boots!" end end RUBY end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-rakefile_source')" id="l_method-i-rakefile_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L302" target="_blank" class="github_url">on GitHub</a> <div id="method-i-rakefile_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 302 def rakefile(filename, data = nil) log :rakefile, filename data ||= yield if block_given? create_file("lib/tasks/#{filename}", optimize_indentation(data), verbose: false) end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-readme"> readme(path) <a href="../../../classes/Rails/Generators/Actions.html#method-i-readme" name="method-i-readme" class="permalink">Link</a> </h3> <div class="description"> Reads the given file at the source root and prints it in the console. <pre><code>readme "README" </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-readme_source')" id="l_method-i-readme_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L442" target="_blank" class="github_url">on GitHub</a> <div id="method-i-readme_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 442 def readme(path) log File.read(find_in_source_paths(path)) end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-route"> route(routing_code, namespace: nil) <a href="../../../classes/Rails/Generators/Actions.html#method-i-route" name="method-i-route" class="permalink">Link</a> </h3> <div class="description"> Make an entry in Rails routing file <code>config/routes.rb</code> <pre><code>route "root 'welcome#index'" route "root 'admin#index'", namespace: :admin </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-route_source')" id="l_method-i-route_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L409" target="_blank" class="github_url">on GitHub</a> <div id="method-i-route_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 409 def route(routing_code, namespace: nil) namespace = Array(namespace) namespace_pattern = route_namespace_pattern(namespace) routing_code = namespace.reverse.reduce(routing_code) do |code, name| "namespace :#{name} do\n#{rebase_indentation(code, 2)}end" end log :route, routing_code in_root do if namespace_match = match_file("config/routes.rb", namespace_pattern) base_indent, *, existing_block_indent = namespace_match.captures.compact.map(&:length) existing_line_pattern = /^[ ]{,#{existing_block_indent}}\S.+\n?/ routing_code = rebase_indentation(routing_code, base_indent + 2).gsub(existing_line_pattern, "") namespace_pattern = /#{Regexp.escape namespace_match.to_s}/ end inject_into_file "config/routes.rb", routing_code, after: namespace_pattern, verbose: false, force: false if behavior == :revoke && namespace.any? && namespace_match empty_block_pattern = /(#{namespace_pattern})((?:\s*end\n){1,#{namespace.size}})/ gsub_file "config/routes.rb", empty_block_pattern, verbose: false, force: true do |matched| beginning, ending = empty_block_pattern.match(matched).captures ending.sub!(/\A\s*end\n/, "") while !ending.empty? && beginning.sub!(/^[ ]*namespace .+ do\n\s*\z/, "") beginning + ending end end end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-vendor"> vendor(filename, data = nil) <a href="../../../classes/Rails/Generators/Actions.html#method-i-vendor" name="method-i-vendor" class="permalink">Link</a> </h3> <div class="description"> Creates a file in <code>vendor/</code>. The contents can be specified as an argument or as the return value of the block. <pre><code>vendor "foreign.rb", <<~RUBY # Foreign code is fun RUBY vendor "foreign.rb" do "# Foreign code is fun" end </code></pre> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-vendor_source')" id="l_method-i-vendor_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L258" target="_blank" class="github_url">on GitHub</a> <div id="method-i-vendor_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 258 def vendor(filename, data = nil) log :vendor, filename data ||= yield if block_given? create_file("vendor/#{filename}", optimize_indentation(data), verbose: false) end</pre> </div> </div> </div> <h2 class="sectiontitle">Instance Private methods</h2> <div class="method"> <h3 class="title method-title" id="method-i-execute_command"> execute_command(executor, command, options = {}) <a href="../../../classes/Rails/Generators/Actions.html#method-i-execute_command" name="method-i-execute_command" class="permalink">Link</a> </h3> <div class="description"> Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided. </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-execute_command_source')" id="l_method-i-execute_command_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L461" target="_blank" class="github_url">on GitHub</a> <div id="method-i-execute_command_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 461 def execute_command(executor, command, options = {}) # :doc: log executor, command sudo = options[:sudo] && !Gem.win_platform? ? "sudo " : "" config = { env: { "RAILS_ENV" => (options[:env] || ENV["RAILS_ENV"] || "development") }, verbose: false, capture: options[:capture], abort_on_failure: options[:abort_on_failure], } in_root { run("#{sudo}#{Shellwords.escape Gem.ruby} bin/#{executor} #{command}", config) } end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-indentation"> indentation() <a href="../../../classes/Rails/Generators/Actions.html#method-i-indentation" name="method-i-indentation" class="permalink">Link</a> </h3> <div class="description"> Indent the <code>Gemfile</code> to the depth of @indentation </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-indentation_source')" id="l_method-i-indentation_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L494" target="_blank" class="github_url">on GitHub</a> <div id="method-i-indentation_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 494 def indentation # :doc: " " * @indentation end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-log"> log(*args) <a href="../../../classes/Rails/Generators/Actions.html#method-i-log" name="method-i-log" class="permalink">Link</a> </h3> <div class="description"> Define log for backwards compatibility. If just one argument is sent, invoke say, otherwise invoke say_status. Differently from say and similarly to say_status, this method respects the quiet? option given. </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-log_source')" id="l_method-i-log_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L450" target="_blank" class="github_url">on GitHub</a> <div id="method-i-log_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 450 def log(*args) # :doc: if args.size == 1 say args.first.to_s unless options.quiet? else args << (behavior == :invoke ? :green : :red) say_status(*args) end end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-optimize_indentation"> optimize_indentation(value, amount = 0) <a href="../../../classes/Rails/Generators/Actions.html#method-i-optimize_indentation" name="method-i-optimize_indentation" class="permalink">Link</a> </h3> <div class="description"> Returns optimized string with indentation </div> <div class="aka"> Also aliased as: <a href="Actions.html#method-i-rebase_indentation">rebase_indentation</a> </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-optimize_indentation_source')" id="l_method-i-optimize_indentation_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L487" target="_blank" class="github_url">on GitHub</a> <div id="method-i-optimize_indentation_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 487 def optimize_indentation(value, amount = 0) # :doc: return "#{value}\n" unless value.is_a?(String) "#{value.strip_heredoc.indent(amount).chomp}\n" end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-quote"> quote(value) <a href="../../../classes/Rails/Generators/Actions.html#method-i-quote" name="method-i-quote" class="permalink">Link</a> </h3> <div class="description"> Always returns value in double quotes. </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-quote_source')" id="l_method-i-quote_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L475" target="_blank" class="github_url">on GitHub</a> <div id="method-i-quote_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 475 def quote(value) # :doc: if value.respond_to? :each_pair return value.map do |k, v| "#{k}: #{quote(v)}" end.join(", ") end return value.inspect unless value.is_a? String "\"#{value.tr("'", '"')}\"" end</pre> </div> </div> </div> <div class="method"> <h3 class="title method-title" id="method-i-with_indentation"> with_indentation(&block) <a href="../../../classes/Rails/Generators/Actions.html#method-i-with_indentation" name="method-i-with_indentation" class="permalink">Link</a> </h3> <div class="description"> Manage <code>Gemfile</code> indentation for a DSL action block </div> <div class="sourcecode"> Source: <a href="javascript:toggleSource('method-i-with_indentation_source')" id="l_method-i-with_indentation_source">show</a> | <a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/railties/lib/rails/generators/actions.rb#L499" target="_blank" class="github_url">on GitHub</a> <div id="method-i-with_indentation_source" class="dyn-source"> <pre># File railties/lib/rails/generators/actions.rb, line 499 def with_indentation(&block) # :doc: @indentation += 1 instance_eval(&block) ensure @indentation -= 1 end</pre> </div> </div> </div> </div> </main> </body> </html>

CINXE.COM

Rails::Generators::Actions