123456789_123456789_123456789_123456789_123456789_

Class: Rails::AppBuilder

Relationships & Source Files
Inherits: Object
Defined in: railties/lib/rails/generators/rails/app/app_generator.rb

Overview

The application builder allows you to override elements of the application generator without being forced to reverse the operations of the default generator.

This allows you to override entire operations, like the creation of the Gemfile, README, or JavaScript files, without needing to know exactly what those operations do so you can create another template action.

class CustomAppBuilder < Rails::AppBuilder
  def test
    @generator.gem "rspec-rails", group: [:development, :test]
    run "bundle install"
    generate "rspec:install"
  end
end

Instance Method Summary

Instance Method Details

#app

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 83

def app
  directory "app"

  empty_directory_with_keep_file "app/assets/images"

  keep_file  "app/controllers/concerns"
  keep_file  "app/models/concerns"
end

#bin

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 92

def bin
  directory "bin" do |content|
    "#{shebang}\n" + content
  end
  chmod "bin", 0755 & ~File.umask, verbose: false

  remove_file "bin/spring" unless spring_install?
  remove_file "bin/yarn" if options[:skip_javascript]
end

#bin_when_updating

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 102

def bin_when_updating
  bin
end

#config

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 114

def config
  empty_directory "config"

  inside "config" do
    template "routes.rb"
    template "application.rb"
    template "environment.rb"
    template "cable.yml" unless options[:skip_action_cable]
    template "puma.rb"   unless options[:skip_puma]
    template "spring.rb" if spring_install?
    template "storage.yml" unless skip_active_storage?

    directory "environments"
    directory "initializers"
    directory "locales"
  end
end

#config_target_version

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 253

def config_target_version
  defined?(@config_target_version) ? @config_target_version : Rails::VERSION::STRING.to_f
end

#config_when_updating

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 132

def config_when_updating
  cookie_serializer_config_exist = File.exist?("config/initializers/cookies_serializer.rb")
  action_cable_config_exist      = File.exist?("config/cable.yml")
  active_storage_config_exist    = File.exist?("config/storage.yml")
  rack_cors_config_exist         = File.exist?("config/initializers/cors.rb")
  assets_config_exist            = File.exist?("config/initializers/assets.rb")
  csp_config_exist               = File.exist?("config/initializers/content_security_policy.rb")
  permissions_policy_config_exist = File.exist?("config/initializers/permissions_policy.rb")

  @config_target_version = Rails.application.config.loaded_config_version || "5.0"

  config
  configru

  unless cookie_serializer_config_exist
    gsub_file "config/initializers/cookies_serializer.rb", /json(?!,)/, "marshal"
  end

  if !options[:skip_action_cable] && !action_cable_config_exist
    template "config/cable.yml"
  end

  if !skip_active_storage? && !active_storage_config_exist
    template "config/storage.yml"
  end

  if options[:skip_sprockets] && !assets_config_exist
    remove_file "config/initializers/assets.rb"
  end

  unless rack_cors_config_exist
    remove_file "config/initializers/cors.rb"
  end

  if options[:api]
    unless cookie_serializer_config_exist
      remove_file "config/initializers/cookies_serializer.rb"
    end

    unless csp_config_exist
      remove_file "config/initializers/content_security_policy.rb"
    end

    unless permissions_policy_config_exist
      remove_file "config/initializers/permissions_policy.rb"
    end
  end
end

#configru

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 61

def configru
  template "config.ru"
end

#credentials

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 190

def credentials
  return if options[:pretend] || options[:dummy_app]

  require "rails/generators/rails/credentials/credentials_generator"
  Rails::Generators::CredentialsGenerator.new([], quiet: options[:quiet]).add_credentials_file_silently
end

#database_yml

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 197

def database_yml
  template "config/databases/#{options[:database]}.yml", "config/database.yml"
end

#db

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 201

def db
  directory "db"
end

#gemfile

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 57

def gemfile
  template "Gemfile"
end

#gitattributes

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 69

def gitattributes
  template "gitattributes", ".gitattributes"
end

#gitignore

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 65

def gitignore
  template "gitignore", ".gitignore"
end

#lib

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 205

def lib
  empty_directory "lib"
  empty_directory_with_keep_file "lib/tasks"
  empty_directory_with_keep_file "lib/assets"
end

#log

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 211

def log
  empty_directory_with_keep_file "log"
end

#master_key

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 181

def master_key
  return if options[:pretend] || options[:dummy_app]

  require "rails/generators/rails/master_key/master_key_generator"
  master_key_generator = Rails::Generators::MasterKeyGenerator.new([], quiet: options[:quiet], force: options[:force])
  master_key_generator.add_master_key_file_silently
  master_key_generator.ignore_master_key_file_silently
end

#package_json

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 79

def package_json
  template "package.json"
end

#public_directory

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 215

def public_directory
  directory "public", "public", recursive: false
end

#rakefile

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 45

def rakefile
  template "Rakefile"
end

#readme

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 49

def readme
  copy_file "README.md", "README.md"
end

#ruby_version

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 53

def ruby_version
  template "ruby-version", ".ruby-version"
end

#storage

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 219

def storage
  empty_directory_with_keep_file "storage"
  empty_directory_with_keep_file "tmp/storage"
end

#system_test

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 236

def system_test
  empty_directory_with_keep_file "test/system"

  template "test/application_system_test_case.rb"
end

#test

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 224

def test
  empty_directory_with_keep_file "test/fixtures/files"
  empty_directory_with_keep_file "test/controllers"
  empty_directory_with_keep_file "test/mailers"
  empty_directory_with_keep_file "test/models"
  empty_directory_with_keep_file "test/helpers"
  empty_directory_with_keep_file "test/integration"

  template "test/channels/application_cable/connection_test.rb"
  template "test/test_helper.rb"
end

#tmp

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 242

def tmp
  empty_directory_with_keep_file "tmp"
  empty_directory_with_keep_file "tmp/pids"
  empty_directory "tmp/cache"
  empty_directory "tmp/cache/assets"
end

#vendor

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 249

def vendor
  empty_directory_with_keep_file "vendor"
end

#version_control

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 73

def version_control
  if !options[:skip_git] && !options[:pretend]
    run "git init", capture: options[:quiet], abort_on_failure: false
  end
end

#yarn_when_updating

[ GitHub ]

  
# File 'railties/lib/rails/generators/rails/app/app_generator.rb', line 106

def yarn_when_updating
  template "bin/yarn", force: true do |content|
    "#{shebang}\n" + content
  end

  chmod "bin", 0755 & ~File.umask, verbose: false
end