app_generator_test.rb 29.8 KB
Newer Older
1 2 3
require "generators/generators_test_helper"
require "rails/generators/rails/app/app_generator"
require "generators/shared_generator_tests"
J
José Valim 已提交
4

5 6
DEFAULT_APP_FILES = %w(
  .gitignore
7
  .ruby-version
8
  README.md
9 10 11
  Gemfile
  Rakefile
  config.ru
12 13
  app/assets/config/manifest.js
  app/assets/images
J
José Valim 已提交
14
  app/assets/javascripts
15 16 17
  app/assets/javascripts/application.js
  app/assets/javascripts/cable.js
  app/assets/javascripts/channels
J
José Valim 已提交
18
  app/assets/stylesheets
19 20 21
  app/assets/stylesheets/application.css
  app/channels/application_cable/channel.rb
  app/channels/application_cable/connection.rb
22
  app/controllers
23
  app/controllers/application_controller.rb
F
Francesco Rodriguez 已提交
24
  app/controllers/concerns
25
  app/helpers
26
  app/helpers/application_helper.rb
27
  app/mailers
28
  app/mailers/application_mailer.rb
29
  app/models
30
  app/models/application_record.rb
F
Francesco Rodriguez 已提交
31
  app/models/concerns
32
  app/jobs
33
  app/jobs/application_job.rb
34
  app/views/layouts
35 36 37
  app/views/layouts/application.html.erb
  app/views/layouts/mailer.html.erb
  app/views/layouts/mailer.text.erb
38 39 40
  bin/bundle
  bin/rails
  bin/rake
41
  bin/setup
42 43 44 45 46 47
  bin/update
  bin/yarn
  config/application.rb
  config/boot.rb
  config/cable.yml
  config/environment.rb
48
  config/environments
49 50 51
  config/environments/development.rb
  config/environments/production.rb
  config/environments/test.rb
52
  config/initializers
53 54 55 56 57 58 59 60
  config/initializers/application_controller_renderer.rb
  config/initializers/assets.rb
  config/initializers/backtrace_silencers.rb
  config/initializers/cookies_serializer.rb
  config/initializers/filter_parameter_logging.rb
  config/initializers/inflections.rb
  config/initializers/mime_types.rb
  config/initializers/wrap_parameters.rb
61
  config/locales
62
  config/locales/en.yml
S
schneems 已提交
63
  config/puma.rb
64 65
  config/routes.rb
  config/secrets.yml
66
  config/spring.rb
67
  config/storage.yml
68
  db
69
  db/seeds.rb
70 71
  lib
  lib/tasks
72
  lib/assets
73
  log
74 75 76
  package.json
  public
  test/application_system_test_case.rb
A
Arun Agrawal 已提交
77
  test/test_helper.rb
78
  test/fixtures
79
  test/fixtures/files
M
Mike Moore 已提交
80 81 82 83
  test/controllers
  test/models
  test/helpers
  test/mailers
84
  test/integration
E
eileencodes 已提交
85
  test/system
86
  vendor
87
  tmp
88
  tmp/cache
J
José Valim 已提交
89
  tmp/cache/assets
90 91
)

92 93
class AppGeneratorTest < Rails::Generators::TestCase
  include GeneratorsTestHelper
94
  arguments [destination_root]
95 96

  # brings setup, teardown, and some tests
97
  include SharedGeneratorTests
J
José Valim 已提交
98

99 100
  def default_files
    ::DEFAULT_APP_FILES
101 102
  end

103
  def test_assets
104
    run_generator
105

J
Jeroen Visser 已提交
106 107
    assert_file("app/views/layouts/application.html.erb", /stylesheet_link_tag\s+'application', media: 'all', 'data-turbolinks-track': 'reload'/)
    assert_file("app/views/layouts/application.html.erb", /javascript_include_tag\s+'application', 'data-turbolinks-track': 'reload'/)
108
    assert_file("app/assets/stylesheets/application.css")
A
Arun Agrawal 已提交
109
    assert_file("app/assets/javascripts/application.js")
110 111
  end

112 113 114 115 116
  def test_application_job_file_present
    run_generator
    assert_file("app/jobs/application_job.rb")
  end

117
  def test_invalid_application_name_raises_an_error
118
    content = capture(:stderr) { run_generator [File.join(destination_root, "43-things")] }
119 120 121 122
    assert_equal "Invalid application name 43-things. Please give a name which does not start with numbers.\n", content
  end

  def test_invalid_application_name_is_fixed
123
    run_generator [File.join(destination_root, "things-43")]
124
    assert_file "things-43/config/environment.rb", /Rails\.application\.initialize!/
125
    assert_file "things-43/config/application.rb", /^module Things43$/
126 127
  end

128
  def test_application_new_exits_with_non_zero_code_on_invalid_application_name
129
    quietly { system "rails new test --no-rc" }
130
    assert_equal false, $?.success?
131 132 133
  end

  def test_application_new_exits_with_message_and_non_zero_code_when_generating_inside_existing_rails_directory
134
    app_root = File.join(destination_root, "myfirstapp")
135 136 137 138 139 140 141
    run_generator [app_root]
    output = nil
    Dir.chdir(app_root) do
      output = `rails new mysecondapp`
    end
    assert_equal "Can't initialize a new Rails application within the directory of another, please change to a non-Rails directory first.\nType 'rails' for help.\n", output
    assert_equal false, $?.success?
142 143
  end

144
  def test_application_new_show_help_message_inside_existing_rails_directory
145
    app_root = File.join(destination_root, "myfirstapp")
146 147 148 149
    run_generator [app_root]
    output = Dir.chdir(app_root) do
      `rails new --help`
    end
150
    assert_match(/rails new APP_PATH \[options\]/, output)
151 152 153
    assert_equal true, $?.success?
  end

154 155 156 157 158 159
  def test_application_name_is_detected_if_it_exists_and_app_folder_renamed
    app_root       = File.join(destination_root, "myapp")
    app_moved_root = File.join(destination_root, "myapp_moved")

    run_generator [app_root]

160 161 162
    stub_rails_application(app_moved_root) do
      Rails.application.stub(:is_a?, -> *args { Rails::Application }) do
        FileUtils.mv(app_root, app_moved_root)
163

164 165
        # make sure we are in correct dir
        FileUtils.cd(app_moved_root)
166

167
        generator = Rails::Generators::AppGenerator.new ["rails"], [],
168 169 170 171 172 173
                                                                   destination_root: app_moved_root, shell: @shell
        generator.send(:app_const)
        quietly { generator.send(:update_config_files) }
        assert_file "myapp_moved/config/environment.rb", /Rails\.application\.initialize!/
      end
    end
174
  end
175

176
  def test_app_update_generates_correct_session_key
177
    app_root = File.join(destination_root, "myapp")
178
    run_generator [app_root]
179

180
    stub_rails_application(app_root) do
181
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
182 183 184
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
    end
185
  end
186

187 188 189 190 191 192
  def test_new_application_use_json_serialzier
    run_generator

    assert_file("config/initializers/cookies_serializer.rb", /Rails\.application\.config\.action_dispatch\.cookies_serializer = :json/)
  end

193 194 195
  def test_new_application_not_include_api_initializers
    run_generator

196
    assert_no_file "config/initializers/cors.rb"
197 198
  end

199
  def test_new_application_doesnt_need_defaults
200
    assert_no_file "config/initializers/new_framework_defaults_5_2.rb"
201 202
  end

203 204 205 206 207 208 209 210 211 212 213 214
  def test_new_application_load_defaults
    app_root = File.join(destination_root, "myfirstapp")
    run_generator [app_root]
    output = nil

    Dir.chdir(app_root) do
      output = `./bin/rails r "puts Rails.application.config.assets.unknown_asset_fallback"`
    end

    assert_equal "false\n", output
  end

215
  def test_app_update_keep_the_cookie_serializer_if_it_is_already_configured
216
    app_root = File.join(destination_root, "myapp")
217 218
    run_generator [app_root]

219
    stub_rails_application(app_root) do
220
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
221 222 223 224
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
      assert_file("#{app_root}/config/initializers/cookies_serializer.rb", /Rails\.application\.config\.action_dispatch\.cookies_serializer = :json/)
    end
225 226
  end

227
  def test_app_update_set_the_cookie_serializer_to_marshal_if_it_is_not_already_configured
228
    app_root = File.join(destination_root, "myapp")
229 230 231 232
    run_generator [app_root]

    FileUtils.rm("#{app_root}/config/initializers/cookies_serializer.rb")

233
    stub_rails_application(app_root) do
234
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
235 236
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
237 238
      assert_file("#{app_root}/config/initializers/cookies_serializer.rb",
                  /Valid options are :json, :marshal, and :hybrid\.\nRails\.application\.config\.action_dispatch\.cookies_serializer = :marshal/)
239
    end
240 241
  end

242
  def test_app_update_create_new_framework_defaults
243
    app_root = File.join(destination_root, "myapp")
244 245
    run_generator [app_root]

246
    assert_no_file "#{app_root}/config/initializers/new_framework_defaults_5_2.rb"
247 248

    stub_rails_application(app_root) do
249 250 251
      generator = Rails::Generators::AppGenerator.new ["rails"], { update: true }, destination_root: app_root, shell: @shell
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
252

253
      assert_file "#{app_root}/config/initializers/new_framework_defaults_5_2.rb"
254 255 256
    end
  end

257
  def test_app_update_does_not_create_rack_cors
258
    app_root = File.join(destination_root, "myapp")
259 260 261
    run_generator [app_root]

    stub_rails_application(app_root) do
262
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
263 264 265 266 267 268
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
      assert_no_file "#{app_root}/config/initializers/cors.rb"
    end
  end

269
  def test_app_update_does_not_remove_rack_cors_if_already_present
270
    app_root = File.join(destination_root, "myapp")
271 272 273 274 275
    run_generator [app_root]

    FileUtils.touch("#{app_root}/config/initializers/cors.rb")

    stub_rails_application(app_root) do
276
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
277 278 279 280 281 282
      generator.send(:app_const)
      quietly { generator.send(:update_config_files) }
      assert_file "#{app_root}/config/initializers/cors.rb"
    end
  end

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  def test_app_update_does_not_generate_action_cable_contents_when_skip_action_cable_is_given
    app_root = File.join(destination_root, "myapp")
    run_generator [app_root, "--skip-action-cable"]

    FileUtils.cd(app_root) do
      # For avoid conflict file
      FileUtils.rm("#{app_root}/config/secrets.yml")
      quietly { system("bin/rails app:update") }
    end

    assert_no_file "#{app_root}/config/cable.yml"
    assert_file "#{app_root}/config/environments/production.rb" do |content|
      assert_no_match(/config\.action_cable/, content)
    end
  end

299 300
  def test_application_names_are_not_singularized
    run_generator [File.join(destination_root, "hats")]
301
    assert_file "hats/config/environment.rb", /Rails\.application\.initialize!/
302 303
  end

304 305 306
  def test_gemfile_has_no_whitespace_errors
    run_generator
    absolute = File.expand_path("Gemfile", destination_root)
307
    File.open(absolute, "r") do |f|
308
      f.each_line do |line|
A
Arun Agrawal 已提交
309
        assert_no_match %r{/^[ \t]+$/}, line
310 311 312 313
      end
    end
  end

J
José Valim 已提交
314 315 316
  def test_config_database_is_added_by_default
    run_generator
    assert_file "config/database.yml", /sqlite3/
317
    if defined?(JRUBY_VERSION)
O
Oscar Del Ben 已提交
318
      assert_gem "activerecord-jdbcsqlite3-adapter"
319 320
    else
      assert_gem "sqlite3"
321
    end
322 323 324 325 326
  end

  def test_config_another_database
    run_generator([destination_root, "-d", "mysql"])
    assert_file "config/database.yml", /mysql/
327
    if defined?(JRUBY_VERSION)
O
Oscar Del Ben 已提交
328
      assert_gem "activerecord-jdbcmysql-adapter"
329
    else
330
      assert_gem "mysql2", "'>= 0.3.18', '< 0.5'"
331
    end
J
José Valim 已提交
332 333
  end

334 335 336 337 338
  def test_config_database_app_name_with_period
    run_generator [File.join(destination_root, "common.usage.com"), "-d", "postgresql"]
    assert_file "common.usage.com/config/database.yml", /common_usage_com/
  end

339 340 341
  def test_config_postgresql_database
    run_generator([destination_root, "-d", "postgresql"])
    assert_file "config/database.yml", /postgresql/
342
    if defined?(JRUBY_VERSION)
O
Oscar Del Ben 已提交
343
      assert_gem "activerecord-jdbcpostgresql-adapter"
344
    else
345
      assert_gem "pg", "'~> 0.18'"
346 347 348
    end
  end

349 350
  def test_config_jdbcmysql_database
    run_generator([destination_root, "-d", "jdbcmysql"])
351
    assert_file "config/database.yml", /mysql/
O
Oscar Del Ben 已提交
352
    assert_gem "activerecord-jdbcmysql-adapter"
353 354
  end

355 356
  def test_config_jdbcsqlite3_database
    run_generator([destination_root, "-d", "jdbcsqlite3"])
357
    assert_file "config/database.yml", /sqlite3/
O
Oscar Del Ben 已提交
358
    assert_gem "activerecord-jdbcsqlite3-adapter"
359 360
  end

361 362
  def test_config_jdbcpostgresql_database
    run_generator([destination_root, "-d", "jdbcpostgresql"])
363
    assert_file "config/database.yml", /postgresql/
O
Oscar Del Ben 已提交
364
    assert_gem "activerecord-jdbcpostgresql-adapter"
365 366
  end

A
Arun Agrawal 已提交
367 368 369
  def test_config_jdbc_database
    run_generator([destination_root, "-d", "jdbc"])
    assert_file "config/database.yml", /jdbc/
370
    assert_file "config/database.yml", /mssql/
O
Oscar Del Ben 已提交
371
    assert_gem "activerecord-jdbc-adapter"
A
Arun Agrawal 已提交
372 373
  end

374 375
  if defined?(JRUBY_VERSION)
    def test_config_jdbc_database_when_no_option_given
376
      run_generator
377
      assert_file "config/database.yml", /sqlite3/
O
Oscar Del Ben 已提交
378
      assert_gem "activerecord-jdbcsqlite3-adapter"
379 380 381
    end
  end

382 383 384 385 386 387 388 389 390 391 392
  def test_generator_without_skips
    run_generator
    assert_file "config/application.rb", /\s+require\s+["']rails\/all["']/
    assert_file "config/environments/development.rb" do |content|
      assert_match(/config\.action_mailer\.raise_delivery_errors = false/, content)
    end
    assert_file "config/environments/test.rb" do |content|
      assert_match(/config\.action_mailer\.delivery_method = :test/, content)
    end
    assert_file "config/environments/production.rb" do |content|
      assert_match(/# config\.action_mailer\.raise_delivery_errors = false/, content)
393
      assert_match(/^  config\.read_encrypted_secrets = true/, content)
394 395 396
    end
  end

397
  def test_default_frameworks_are_required_when_others_are_removed
Y
yhirano55 已提交
398
    run_generator [destination_root, "--skip-active-record", "--skip-action-mailer", "--skip-action-cable", "--skip-sprockets", "--skip-test"]
399 400 401 402 403
    assert_file "config/application.rb", /require\s+["']rails["']/
    assert_file "config/application.rb", /require\s+["']active_model\/railtie["']/
    assert_file "config/application.rb", /require\s+["']active_job\/railtie["']/
    assert_file "config/application.rb", /require\s+["']action_controller\/railtie["']/
    assert_file "config/application.rb", /require\s+["']action_view\/railtie["']/
Y
yhirano55 已提交
404
    assert_file "config/application.rb", /require\s+["']active_storage\/engine["']/
405 406
  end

S
schneems 已提交
407 408
  def test_generator_defaults_to_puma_version
    run_generator [destination_root]
R
Roberto Miranda 已提交
409
    assert_gem "puma", "'~> 3.7'"
S
schneems 已提交
410 411
  end

S
schneems 已提交
412 413 414 415 416 417 418 419
  def test_generator_if_skip_puma_is_given
    run_generator [destination_root, "--skip-puma"]
    assert_no_file "config/puma.rb"
    assert_file "Gemfile" do |content|
      assert_no_match(/puma/, content)
    end
  end

420
  def test_generator_if_skip_active_record_is_given
421
    run_generator [destination_root, "--skip-active-record"]
422
    assert_no_directory "db/"
J
José Valim 已提交
423
    assert_no_file "config/database.yml"
424
    assert_no_file "app/models/application_record.rb"
425
    assert_file "config/application.rb", /#\s+require\s+["']active_record\/railtie["']/
426
    assert_file "test/test_helper.rb" do |helper_content|
427
      assert_no_match(/fixtures :all/, helper_content)
428
    end
429 430 431 432 433 434
    assert_file "bin/setup" do |setup_content|
      assert_no_match(/db:setup/, setup_content)
    end
    assert_file "bin/update" do |update_content|
      assert_no_match(/db:migrate/, update_content)
    end
J
José Valim 已提交
435 436
  end

437 438 439 440 441 442 443 444 445 446 447 448
  def test_generator_if_skip_action_mailer_is_given
    run_generator [destination_root, "--skip-action-mailer"]
    assert_file "config/application.rb", /#\s+require\s+["']action_mailer\/railtie["']/
    assert_file "config/environments/development.rb" do |content|
      assert_no_match(/config\.action_mailer/, content)
    end
    assert_file "config/environments/test.rb" do |content|
      assert_no_match(/config\.action_mailer/, content)
    end
    assert_file "config/environments/production.rb" do |content|
      assert_no_match(/config\.action_mailer/, content)
    end
449
    assert_no_directory "app/mailers"
450
    assert_no_directory "test/mailers"
451 452
  end

453 454 455
  def test_generator_has_assets_gems
    run_generator

456 457
    assert_gem "sass-rails"
    assert_gem "uglifier"
458 459
  end

460
  def test_generator_if_skip_sprockets_is_given
461
    run_generator [destination_root, "--skip-sprockets"]
462

463
    assert_no_file "config/initializers/assets.rb"
464 465 466

    assert_file "config/application.rb", /#\s+require\s+["']sprockets\/railtie["']/

467 468 469
    assert_file "Gemfile" do |content|
      assert_no_match(/sass-rails/, content)
      assert_no_match(/uglifier/, content)
470
      assert_no_match(/coffee-rails/, content)
471
    end
472

473
    assert_file "config/environments/development.rb" do |content|
474
      assert_no_match(/config\.assets\.debug/, content)
475
    end
476

477
    assert_file "config/environments/production.rb" do |content|
478 479 480 481
      assert_no_match(/config\.assets\.digest/, content)
      assert_no_match(/config\.assets\.js_compressor/, content)
      assert_no_match(/config\.assets\.css_compressor/, content)
      assert_no_match(/config\.assets\.compile/, content)
482
    end
483
  end
J
José Valim 已提交
484

485 486 487
  def test_generator_if_skip_action_cable_is_given
    run_generator [destination_root, "--skip-action-cable"]
    assert_file "config/application.rb", /#\s+require\s+["']action_cable\/engine["']/
488
    assert_no_file "config/cable.yml"
489
    assert_no_file "app/assets/javascripts/cable.js"
Y
yhirano55 已提交
490
    assert_no_directory "app/assets/javascripts/channels"
491
    assert_no_directory "app/channels"
492 493 494 495 496 497 498
    assert_file "Gemfile" do |content|
      assert_no_match(/redis/, content)
    end
  end

  def test_action_cable_redis_gems
    run_generator
499
    assert_file "Gemfile", /^# gem 'redis'/
500 501
  end

502 503
  def test_generator_if_skip_test_is_given
    run_generator [destination_root, "--skip-test"]
504 505 506

    assert_file "config/application.rb", /#\s+require\s+["']rails\/test_unit\/railtie["']/

507 508 509 510
    assert_file "Gemfile" do |content|
      assert_no_match(/capybara/, content)
      assert_no_match(/selenium-webdriver/, content)
    end
511 512

    assert_no_directory("test")
513 514 515
  end

  def test_generator_if_skip_system_test_is_given
516
    run_generator [destination_root, "--skip-system-test"]
517 518 519 520
    assert_file "Gemfile" do |content|
      assert_no_match(/capybara/, content)
      assert_no_match(/selenium-webdriver/, content)
    end
521 522 523 524

    assert_directory("test")

    assert_no_directory("test/system")
525 526
  end

527
  def test_does_not_generate_system_test_files_if_skip_system_test_is_given
528
    run_generator [destination_root, "--skip-system-test"]
529 530 531 532 533 534 535 536 537

    Dir.chdir(destination_root) do
      quietly { `./bin/rails g scaffold User` }

      assert_no_file("test/application_system_test_case.rb")
      assert_no_file("test/system/users_test.rb")
    end
  end

538 539 540 541 542 543 544 545
  def test_generator_if_api_is_given
    run_generator [destination_root, "--api"]
    assert_file "Gemfile" do |content|
      assert_no_match(/capybara/, content)
      assert_no_match(/selenium-webdriver/, content)
    end
  end

546
  def test_inclusion_of_javascript_runtime
547
    run_generator
548
    if defined?(JRUBY_VERSION)
O
Oscar Del Ben 已提交
549
      assert_gem "therubyrhino"
550 551
    elsif RUBY_PLATFORM =~ /mingw|mswin/
      assert_gem "duktape"
552
    else
S
Sam 已提交
553
      assert_file "Gemfile", /# gem 'mini_racer', platforms: :ruby/
554 555 556
    end
  end

557
  def test_rails_ujs_is_the_default_ujs_library
558 559
    run_generator
    assert_file "app/assets/javascripts/application.js" do |contents|
560
      assert_match %r{^//= require rails-ujs}, contents
561 562 563
    end
  end

564 565
  def test_javascript_is_skipped_if_required
    run_generator [destination_root, "--skip-javascript"]
566 567 568

    assert_no_file "app/assets/javascripts"

569
    assert_file "app/views/layouts/application.html.erb" do |contents|
570 571
      assert_match(/stylesheet_link_tag\s+'application', media: 'all' %>/, contents)
      assert_no_match(/javascript_include_tag\s+'application' \%>/, contents)
572
    end
573

574
    assert_file "Gemfile" do |content|
575
      assert_no_match(/coffee-rails/, content)
576 577 578 579 580
      assert_no_match(/uglifier/, content)
    end

    assert_file "config/environments/production.rb" do |content|
      assert_no_match(/config\.assets\.js_compressor = :uglifier/, content)
581
    end
582
  end
583

S
Sean Griffin 已提交
584 585 586 587 588 589 590 591 592
  def test_coffeescript_is_skipped_if_required
    run_generator [destination_root, "--skip-coffee"]

    assert_file "Gemfile" do |content|
      assert_no_match(/coffee-rails/, content)
      assert_match(/uglifier/, content)
    end
  end

593 594
  def test_generator_for_yarn
    run_generator([destination_root])
595
    assert_file "package.json", /dependencies/
596
    assert_file "config/initializers/assets.rb", /node_modules/
Y
yhirano55 已提交
597 598 599 600 601

    assert_file ".gitignore" do |content|
      assert_match(/node_modules/, content)
      assert_match(/yarn-error\.log/, content)
    end
602 603
  end

604
  def test_generator_for_yarn_skipped
Y
Yuji Yaginuma 已提交
605
    run_generator([destination_root, "--skip-yarn"])
606
    assert_no_file "package.json"
A
Andy Atkinson 已提交
607
    assert_no_file "bin/yarn"
608

Y
Yuji Yaginuma 已提交
609
    assert_file "config/initializers/assets.rb" do |content|
610 611
      assert_no_match(/node_modules/, content)
    end
Y
yuuji.yaginuma 已提交
612 613

    assert_file ".gitignore" do |content|
614 615
      assert_no_match(/node_modules/, content)
      assert_no_match(/yarn-error\.log/, content)
Y
yuuji.yaginuma 已提交
616
    end
617 618
  end

A
Arun Agrawal 已提交
619 620
  def test_inclusion_of_jbuilder
    run_generator
621
    assert_gem "jbuilder"
A
Arun Agrawal 已提交
622 623
  end

624
  def test_inclusion_of_a_debugger
625
    run_generator
626
    if defined?(JRUBY_VERSION) || RUBY_ENGINE == "rbx"
A
Arun Agrawal 已提交
627
      assert_file "Gemfile" do |content|
628
        assert_no_match(/byebug/, content)
A
Arun Agrawal 已提交
629
      end
630
    else
631
      assert_gem "byebug"
A
Arun Agrawal 已提交
632
    end
633 634
  end

635
  def test_inclusion_of_listen_related_configuration_by_default
636
    run_generator
637
    if RbConfig::CONFIG["host_os"] =~ /darwin|linux/
638
      assert_listen_related_configuration
639
    else
640
      assert_no_listen_related_configuration
641 642 643
    end
  end

644
  def test_non_inclusion_of_listen_related_configuration_if_skip_listen
645
    run_generator [destination_root, "--skip-listen"]
646 647 648
    assert_no_listen_related_configuration
  end

649 650
  def test_evented_file_update_checker_config
    run_generator
651 652
    assert_file "config/environments/development.rb" do |content|
      if RbConfig::CONFIG["host_os"] =~ /darwin|linux/
653
        assert_match(/^\s*config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
654
      else
655
        assert_match(/^\s*# config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
656 657 658 659
      end
    end
  end

660
  def test_template_from_dir_pwd
661
    FileUtils.cd(Rails.root)
662
    assert_match(/It works from file!/, run_generator([destination_root, "-m", "lib/template.rb"]))
663 664
  end

J
José Valim 已提交
665
  def test_usage_read_from_file
666 667 668
    assert_called(File, :read, returns: "USAGE FROM FILE") do
      assert_equal "USAGE FROM FILE", Rails::Generators::AppGenerator.desc
    end
J
José Valim 已提交
669 670 671
  end

  def test_default_usage
672 673 674
    assert_called(Rails::Generators::AppGenerator, :usage_path, returns: nil) do
      assert_match(/Create rails files for app generator/, Rails::Generators::AppGenerator.desc)
    end
J
José Valim 已提交
675 676 677
  end

  def test_default_namespace
678
    assert_match "rails:app", Rails::Generators::AppGenerator.namespace
J
José Valim 已提交
679 680
  end

681
  def test_file_is_added_for_backwards_compatibility
682 683
    action :file, "lib/test_file.rb", "heres test data"
    assert_file "lib/test_file.rb", "heres test data"
684 685
  end

686 687 688
  def test_pretend_option
    output = run_generator [File.join(destination_root, "myapp"), "--pretend"]
    assert_no_match(/run  bundle install/, output)
689
    assert_no_match(/run  git init/, output)
690 691
  end

692
  def test_application_name_with_spaces
693
    path = File.join(destination_root, "foo bar")
694 695

    # This also applies to MySQL apps but not with SQLite
696
    run_generator [path, "-d", "postgresql"]
697 698 699 700

    assert_file "foo bar/config/database.yml", /database: foo_bar_development/
  end

701 702
  def test_web_console
    run_generator
703
    assert_gem "web-console"
704 705
  end

706 707 708 709
  def test_web_console_with_dev_option
    run_generator [destination_root, "--dev"]

    assert_file "Gemfile" do |content|
M
Mehmet Emin İNAÇ 已提交
710
      assert_match(/gem 'web-console',\s+github: 'rails\/web-console'/, content)
711
      assert_no_match(/\Agem 'web-console', '>= 3\.3\.0'\z/, content)
712 713 714 715 716 717 718
    end
  end

  def test_web_console_with_edge_option
    run_generator [destination_root, "--edge"]

    assert_file "Gemfile" do |content|
M
Mehmet Emin İNAÇ 已提交
719
      assert_match(/gem 'web-console',\s+github: 'rails\/web-console'/, content)
720
      assert_no_match(/\Agem 'web-console', '>= 3\.3\.0'\z/, content)
721 722 723
    end
  end

724 725 726 727 728 729
  def test_generation_runs_bundle_install
    assert_generates_with_bundler
  end

  def test_dev_option
    assert_generates_with_bundler dev: true
730 731
    rails_path = File.expand_path("../../..", Rails.root)
    assert_file "Gemfile", /^gem\s+["']rails["'],\s+path:\s+["']#{Regexp.escape(rails_path)}["']$/
732 733 734 735
  end

  def test_edge_option
    assert_generates_with_bundler edge: true
736
    assert_file "Gemfile", %r{^gem\s+["']rails["'],\s+github:\s+["']#{Regexp.escape("rails/rails")}["']$}
737 738
  end

739 740
  def test_spring
    run_generator
741
    assert_gem "spring"
742 743 744
  end

  def test_spring_binstubs
745
    jruby_skip "spring doesn't run on JRuby"
746 747 748 749
    command_check = -> command do
      @binstub_called ||= 0

      case command
750
      when "install"
751
        # Called when running bundle, we just want to stub it so nothing to do here.
752
      when "exec spring binstub --all"
753 754 755 756 757 758 759 760
        @binstub_called += 1
        assert_equal 1, @binstub_called, "exec spring binstub --all expected to be called once, but was called #{@install_called} times."
      end
    end

    generator.stub :bundle_command, command_check do
      quietly { generator.invoke_all }
    end
761 762 763
  end

  def test_spring_no_fork
764
    jruby_skip "spring doesn't run on JRuby"
R
Rafael Mendonça França 已提交
765
    assert_called_with(Process, :respond_to?, [[:fork], [:fork]], returns: false) do
766
      run_generator
767

768 769 770
      assert_file "Gemfile" do |content|
        assert_no_match(/spring/, content)
      end
771 772 773 774 775 776
    end
  end

  def test_skip_spring
    run_generator [destination_root, "--skip-spring"]

777
    assert_no_file "config/spring.rb"
778 779 780 781 782
    assert_file "Gemfile" do |content|
      assert_no_match(/spring/, content)
    end
  end

783 784 785 786 787 788 789 790
  def test_spring_with_dev_option
    run_generator [destination_root, "--dev"]

    assert_file "Gemfile" do |content|
      assert_no_match(/spring/, content)
    end
  end

791 792
  def test_generator_if_skip_turbolinks_is_given
    run_generator [destination_root, "--skip-turbolinks"]
793 794 795 796 797 798 799 800 801 802 803 804

    assert_file "Gemfile" do |content|
      assert_no_match(/turbolinks/, content)
    end
    assert_file "app/views/layouts/application.html.erb" do |content|
      assert_no_match(/data-turbolinks-track/, content)
    end
    assert_file "app/assets/javascripts/application.js" do |content|
      assert_no_match(/turbolinks/, content)
    end
  end

805 806 807
  def test_gitignore_when_sqlite3
    run_generator

808
    assert_file ".gitignore" do |content|
809 810 811 812 813
      assert_match(/sqlite3/, content)
    end
  end

  def test_gitignore_when_no_active_record
814
    run_generator [destination_root, "--skip-active-record"]
815

816
    assert_file ".gitignore" do |content|
817
      assert_no_match(/sqlite/i, content)
818 819 820 821 822 823
    end
  end

  def test_gitignore_when_non_sqlite3_db
    run_generator([destination_root, "-d", "mysql"])

824
    assert_file ".gitignore" do |content|
825
      assert_no_match(/sqlite/i, content)
826 827 828
    end
  end

829 830 831 832 833 834 835 836 837 838 839
  def test_inclusion_of_ruby_version
    run_generator

    assert_file "Gemfile" do |content|
      assert_match(/ruby '#{RUBY_VERSION}'/, content)
    end
    assert_file ".ruby-version" do |content|
      assert_match(/#{RUBY_VERSION}/, content)
    end
  end

840 841 842 843 844
  def test_version_control_initializes_git_repo
    run_generator [destination_root]
    assert_directory ".git"
  end

845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
  def test_create_keeps
    run_generator
    folders_with_keep = %w(
      app/assets/images
      app/controllers/concerns
      app/models/concerns
      lib/tasks
      lib/assets
      log
      test/fixtures
      test/fixtures/files
      test/controllers
      test/mailers
      test/models
      test/helpers
      test/integration
      tmp
    )
    folders_with_keep.each do |folder|
      assert_file("#{folder}/.keep")
    end
  end

868 869
  def test_psych_gem
    run_generator
870
    gem_regex = /gem 'psych',\s+'~> 2\.0',\s+platforms: :rbx/
871 872 873 874 875 876 877 878 879 880

    assert_file "Gemfile" do |content|
      if defined?(Rubinius)
        assert_match(gem_regex, content)
      else
        assert_no_match(gem_regex, content)
      end
    end
  end

881
  def test_after_bundle_callback
882
    path = "http://example.org/rails_template"
883
    template = %{ after_bundle { run 'echo ran after_bundle' } }.dup
884 885
    template.instance_eval "def read; self; end" # Make the string respond to read

886
    check_open = -> *args do
887
      assert_equal [ path, "Accept" => "application/x-thor-template" ], args
888 889
      template
    end
890

891
    sequence = ["git init", "install", "exec spring binstub --all", "echo ran after_bundle"]
892
    @sequence_step ||= 0
893
    ensure_bundler_first = -> command do
894 895 896 897 898 899 900 901 902 903 904
      assert_equal sequence[@sequence_step], command, "commands should be called in sequence #{sequence}"
      @sequence_step += 1
    end

    generator([destination_root], template: path).stub(:open, check_open, template) do
      generator.stub(:bundle_command, ensure_bundler_first) do
        generator.stub(:run, ensure_bundler_first) do
          quietly { generator.invoke_all }
        end
      end
    end
905

906
    assert_equal 4, @sequence_step
907 908
  end

E
eileencodes 已提交
909 910 911 912 913 914 915 916
  def test_system_tests_directory_generated
    run_generator

    assert_file("test/system/.keep")
    assert_directory("test/system")
  end

  private
917 918 919 920 921
    def stub_rails_application(root)
      Rails.application.config.root = root
      Rails.application.class.stub(:name, "Myapp") do
        yield
      end
922 923
    end

924 925 926
    def action(*args, &block)
      capture(:stdout) { generator.send(*args, &block) }
    end
O
Oscar Del Ben 已提交
927

928 929 930 931 932 933
    def assert_gem(gem, constraint = nil)
      if constraint
        assert_file "Gemfile", /^\s*gem\s+["']#{gem}["'], #{constraint}$*/
      else
        assert_file "Gemfile", /^\s*gem\s+["']#{gem}["']$*/
      end
934
    end
935

936
    def assert_listen_related_configuration
937 938
      assert_gem "listen"
      assert_gem "spring-watcher-listen"
939

940
      assert_file "config/environments/development.rb" do |content|
941
        assert_match(/^\s*config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
942
      end
943 944
    end

945
    def assert_no_listen_related_configuration
946
      assert_file "Gemfile" do |content|
947 948 949
        assert_no_match(/listen/, content)
      end

950
      assert_file "config/environments/development.rb" do |content|
951
        assert_match(/^\s*# config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
952
      end
953 954
    end

955 956 957 958 959 960 961
    def assert_generates_with_bundler(options = {})
      generator([destination_root], options)

      command_check = -> command do
        @install_called ||= 0

        case command
962
        when "install"
963 964
          @install_called += 1
          assert_equal 1, @install_called, "install expected to be called once, but was called #{@install_called} times"
965
        when "exec spring binstub --all"
966 967 968 969 970 971 972
          # Called when running tests with spring, let through unscathed.
        end
      end

      generator.stub :bundle_command, command_check do
        quietly { generator.invoke_all }
      end
973
    end
974
end