Class: Rails::AppBuilder

Inherits:
Object
  • Object
show all
Defined in:
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.

Instance Method Summary collapse

Instance Method Details

#appObject


56
57
58
59
60
61
62
63
64
# File 'lib/rails/generators/rails/app/app_generator.rb', line 56

def app
  directory 'app'

  keep_file  'app/assets/images'
  empty_directory_with_keep_file 'app/assets/javascripts/channels' unless options[:skip_action_cable]

  keep_file  'app/controllers/concerns'
  keep_file  'app/models/concerns'
end

#binObject


66
67
68
69
70
71
# File 'lib/rails/generators/rails/app/app_generator.rb', line 66

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

#configObject


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/rails/generators/rails/app/app_generator.rb', line 73

def config
  empty_directory "config"

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

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

#config_when_updatingObject


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/rails/generators/rails/app/app_generator.rb', line 91

def config_when_updating
  cookie_serializer_config_exist = File.exist?('config/initializers/cookies_serializer.rb')
  action_cable_config_exist = File.exist?('config/cable.yml')
  rack_cors_config_exist = File.exist?('config/initializers/cors.rb')

  config

  gsub_file 'config/environments/development.rb', /^(\s+)config\.file_watcher/, '\1# config.file_watcher'

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

  unless action_cable_config_exist
    template 'config/cable.yml'
  end

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

#configruObject


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

def configru
  template "config.ru"
end

#database_ymlObject


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

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

#dbObject


117
118
119
# File 'lib/rails/generators/rails/app/app_generator.rb', line 117

def db
  directory "db"
end

#gemfileObject


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

def gemfile
  template "Gemfile"
end

#gitignoreObject


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

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

#libObject


121
122
123
124
125
# File 'lib/rails/generators/rails/app/app_generator.rb', line 121

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

#logObject


127
128
129
# File 'lib/rails/generators/rails/app/app_generator.rb', line 127

def log
  empty_directory_with_keep_file 'log'
end

#public_directoryObject


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

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

#rakefileObject


36
37
38
# File 'lib/rails/generators/rails/app/app_generator.rb', line 36

def rakefile
  template "Rakefile"
end

#readmeObject


40
41
42
# File 'lib/rails/generators/rails/app/app_generator.rb', line 40

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

#testObject


135
136
137
138
139
140
141
142
143
144
145
# File 'lib/rails/generators/rails/app/app_generator.rb', line 135

def test
  empty_directory_with_keep_file 'test/fixtures'
  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/test_helper.rb'
end

#tmpObject


147
148
149
150
151
# File 'lib/rails/generators/rails/app/app_generator.rb', line 147

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

#vendorObject


153
154
155
156
# File 'lib/rails/generators/rails/app/app_generator.rb', line 153

def vendor
  vendor_javascripts
  vendor_stylesheets
end

#vendor_javascriptsObject


158
159
160
161
162
# File 'lib/rails/generators/rails/app/app_generator.rb', line 158

def vendor_javascripts
  unless options[:skip_javascript]
    empty_directory_with_keep_file 'vendor/assets/javascripts'
  end
end

#vendor_stylesheetsObject


164
165
166
# File 'lib/rails/generators/rails/app/app_generator.rb', line 164

def vendor_stylesheets
  empty_directory_with_keep_file 'vendor/assets/stylesheets'
end