app_generator_test.rb 28.9 KB
Newer Older
1 2
# frozen_string_literal: true

3 4 5
require "generators/generators_test_helper"
require "rails/generators/rails/app/app_generator"
require "generators/shared_generator_tests"
J
José Valim 已提交
6

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

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

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

101 102
  def default_files
    ::DEFAULT_APP_FILES
103 104
  end

105
  def test_assets
106
    run_generator
107

J
Jeroen Visser 已提交
108 109
    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'/)
110
    assert_file("app/assets/stylesheets/application.css")
A
Arun Agrawal 已提交
111
    assert_file("app/assets/javascripts/application.js")
112 113
  end

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

119
  def test_invalid_application_name_raises_an_error
120
    content = capture(:stderr) { run_generator [File.join(destination_root, "43-things")] }
121 122 123 124
    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
125
    run_generator [File.join(destination_root, "things-43")]
126
    assert_file "things-43/config/environment.rb", /Rails\.application\.initialize!/
127
    assert_file "things-43/config/application.rb", /^module Things43$/
128 129
  end

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

  def test_application_new_exits_with_message_and_non_zero_code_when_generating_inside_existing_rails_directory
136
    app_root = File.join(destination_root, "myfirstapp")
137 138 139 140 141 142 143
    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?
144 145
  end

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

156 157 158 159 160 161
  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]

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

166 167
        # make sure we are in correct dir
        FileUtils.cd(app_moved_root)
168

169
        generator = Rails::Generators::AppGenerator.new ["rails"], [],
170 171 172 173 174 175
                                                                   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
176
  end
177

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

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

189 190 191 192 193 194
  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

195 196 197
  def test_new_application_not_include_api_initializers
    run_generator

198
    assert_no_file "config/initializers/cors.rb"
199 200
  end

201
  def test_new_application_doesnt_need_defaults
202
    assert_no_file "config/initializers/new_framework_defaults_5_2.rb"
203 204
  end

205 206 207 208 209 210 211 212 213 214 215 216
  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

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

221
    stub_rails_application(app_root) do
222
      generator = Rails::Generators::AppGenerator.new ["rails"], [], destination_root: app_root, shell: @shell
223 224 225 226
      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
227 228
  end

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

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

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

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

248
    assert_no_file "#{app_root}/config/initializers/new_framework_defaults_5_2.rb"
249 250

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

255
      assert_file "#{app_root}/config/initializers/new_framework_defaults_5_2.rb"
256 257 258
    end
  end

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

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

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

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

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

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
  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

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

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

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

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

336 337 338 339 340
  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

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

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

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

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

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

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

384 385 386 387 388 389 390 391 392 393 394
  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)
395
      assert_match(/^  config\.read_encrypted_secrets = true/, content)
396 397 398
    end
  end

399
  def test_default_frameworks_are_required_when_others_are_removed
Y
yhirano55 已提交
400
    run_generator [destination_root, "--skip-active-record", "--skip-action-mailer", "--skip-action-cable", "--skip-sprockets", "--skip-test"]
401 402 403 404 405
    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 已提交
406
    assert_file "config/application.rb", /require\s+["']active_storage\/engine["']/
407 408
  end

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

S
schneems 已提交
414 415 416 417 418 419 420 421
  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

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

439 440 441 442 443 444 445 446 447 448 449 450
  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
451
    assert_no_directory "app/mailers"
452
    assert_no_directory "test/mailers"
453 454
  end

455 456 457
  def test_generator_has_assets_gems
    run_generator

458 459
    assert_gem "sass-rails"
    assert_gem "uglifier"
460 461
  end

462
  def test_generator_if_skip_sprockets_is_given
463
    run_generator [destination_root, "--skip-sprockets"]
464

465
    assert_no_file "config/initializers/assets.rb"
466 467 468

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

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

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

479
    assert_file "config/environments/production.rb" do |content|
480 481 482 483
      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)
484
    end
485
  end
J
José Valim 已提交
486

487 488 489
  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["']/
490
    assert_no_file "config/cable.yml"
491
    assert_no_file "app/assets/javascripts/cable.js"
Y
yhirano55 已提交
492
    assert_no_directory "app/assets/javascripts/channels"
493
    assert_no_directory "app/channels"
494 495 496 497 498 499 500
    assert_file "Gemfile" do |content|
      assert_no_match(/redis/, content)
    end
  end

  def test_action_cable_redis_gems
    run_generator
501
    assert_file "Gemfile", /^# gem 'redis'/
502 503
  end

504 505
  def test_generator_if_skip_test_is_given
    run_generator [destination_root, "--skip-test"]
506 507 508

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

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

    assert_no_directory("test")
515 516 517
  end

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

    assert_directory("test")

    assert_no_directory("test/system")
527 528
  end

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

    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

540
  def test_inclusion_of_javascript_runtime
541
    run_generator
542
    if defined?(JRUBY_VERSION)
O
Oscar Del Ben 已提交
543
      assert_gem "therubyrhino"
544 545
    elsif RUBY_PLATFORM =~ /mingw|mswin/
      assert_gem "duktape"
546
    else
S
Sam 已提交
547
      assert_file "Gemfile", /# gem 'mini_racer', platforms: :ruby/
548 549 550
    end
  end

551
  def test_rails_ujs_is_the_default_ujs_library
552 553
    run_generator
    assert_file "app/assets/javascripts/application.js" do |contents|
554
      assert_match %r{^//= require rails-ujs}, contents
555 556 557
    end
  end

558 559
  def test_javascript_is_skipped_if_required
    run_generator [destination_root, "--skip-javascript"]
560 561 562

    assert_no_file "app/assets/javascripts"

563
    assert_file "app/views/layouts/application.html.erb" do |contents|
564 565
      assert_match(/stylesheet_link_tag\s+'application', media: 'all' %>/, contents)
      assert_no_match(/javascript_include_tag\s+'application' \%>/, contents)
566
    end
567

568
    assert_file "Gemfile" do |content|
569
      assert_no_match(/coffee-rails/, content)
570 571 572 573 574
      assert_no_match(/uglifier/, content)
    end

    assert_file "config/environments/production.rb" do |content|
      assert_no_match(/config\.assets\.js_compressor = :uglifier/, content)
575
    end
576
  end
577

S
Sean Griffin 已提交
578 579 580 581 582 583 584 585 586
  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

A
Arun Agrawal 已提交
587 588
  def test_inclusion_of_jbuilder
    run_generator
589
    assert_gem "jbuilder"
A
Arun Agrawal 已提交
590 591
  end

592
  def test_inclusion_of_a_debugger
593
    run_generator
594
    if defined?(JRUBY_VERSION) || RUBY_ENGINE == "rbx"
A
Arun Agrawal 已提交
595
      assert_file "Gemfile" do |content|
596
        assert_no_match(/byebug/, content)
A
Arun Agrawal 已提交
597
      end
598
    else
599
      assert_gem "byebug"
A
Arun Agrawal 已提交
600
    end
601 602
  end

603
  def test_inclusion_of_listen_related_configuration_by_default
604
    run_generator
605
    if RbConfig::CONFIG["host_os"] =~ /darwin|linux/
606
      assert_listen_related_configuration
607
    else
608
      assert_no_listen_related_configuration
609 610 611
    end
  end

612
  def test_non_inclusion_of_listen_related_configuration_if_skip_listen
613
    run_generator [destination_root, "--skip-listen"]
614 615 616
    assert_no_listen_related_configuration
  end

617 618
  def test_evented_file_update_checker_config
    run_generator
619 620
    assert_file "config/environments/development.rb" do |content|
      if RbConfig::CONFIG["host_os"] =~ /darwin|linux/
621
        assert_match(/^\s*config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
622
      else
623
        assert_match(/^\s*# config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
624 625 626 627
      end
    end
  end

628
  def test_template_from_dir_pwd
629
    FileUtils.cd(Rails.root)
630
    assert_match(/It works from file!/, run_generator([destination_root, "-m", "lib/template.rb"]))
631 632
  end

J
José Valim 已提交
633
  def test_usage_read_from_file
634 635 636
    assert_called(File, :read, returns: "USAGE FROM FILE") do
      assert_equal "USAGE FROM FILE", Rails::Generators::AppGenerator.desc
    end
J
José Valim 已提交
637 638 639
  end

  def test_default_usage
640 641 642
    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 已提交
643 644 645
  end

  def test_default_namespace
646
    assert_match "rails:app", Rails::Generators::AppGenerator.namespace
J
José Valim 已提交
647 648
  end

649
  def test_file_is_added_for_backwards_compatibility
650 651
    action :file, "lib/test_file.rb", "heres test data"
    assert_file "lib/test_file.rb", "heres test data"
652 653
  end

654 655 656
  def test_pretend_option
    output = run_generator [File.join(destination_root, "myapp"), "--pretend"]
    assert_no_match(/run  bundle install/, output)
657
    assert_no_match(/run  git init/, output)
658 659
  end

660
  def test_application_name_with_spaces
661
    path = File.join(destination_root, "foo bar")
662 663

    # This also applies to MySQL apps but not with SQLite
664
    run_generator [path, "-d", "postgresql"]
665 666 667 668

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

669 670
  def test_web_console
    run_generator
671
    assert_gem "web-console"
672 673
  end

674 675 676 677
  def test_web_console_with_dev_option
    run_generator [destination_root, "--dev"]

    assert_file "Gemfile" do |content|
M
Mehmet Emin İNAÇ 已提交
678
      assert_match(/gem 'web-console',\s+github: 'rails\/web-console'/, content)
679
      assert_no_match(/\Agem 'web-console', '>= 3\.3\.0'\z/, content)
680 681 682 683 684 685 686
    end
  end

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

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

692 693 694 695 696 697
  def test_generation_runs_bundle_install
    assert_generates_with_bundler
  end

  def test_dev_option
    assert_generates_with_bundler dev: true
698 699
    rails_path = File.expand_path("../../..", Rails.root)
    assert_file "Gemfile", /^gem\s+["']rails["'],\s+path:\s+["']#{Regexp.escape(rails_path)}["']$/
700 701 702 703
  end

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

707 708
  def test_spring
    run_generator
709
    assert_gem "spring"
710 711 712
  end

  def test_spring_binstubs
713
    jruby_skip "spring doesn't run on JRuby"
714 715 716 717
    command_check = -> command do
      @binstub_called ||= 0

      case command
718
      when "install"
719
        # Called when running bundle, we just want to stub it so nothing to do here.
720
      when "exec spring binstub --all"
721 722 723 724 725 726 727 728
        @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
729 730 731
  end

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

736 737 738
      assert_file "Gemfile" do |content|
        assert_no_match(/spring/, content)
      end
739 740 741 742 743 744
    end
  end

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

745
    assert_no_file "config/spring.rb"
746 747 748 749 750
    assert_file "Gemfile" do |content|
      assert_no_match(/spring/, content)
    end
  end

751 752 753 754 755 756 757 758
  def test_spring_with_dev_option
    run_generator [destination_root, "--dev"]

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

759 760
  def test_generator_if_skip_turbolinks_is_given
    run_generator [destination_root, "--skip-turbolinks"]
761 762 763 764 765 766 767 768 769 770 771 772

    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

773 774 775
  def test_gitignore_when_sqlite3
    run_generator

776
    assert_file ".gitignore" do |content|
777 778 779 780 781
      assert_match(/sqlite3/, content)
    end
  end

  def test_gitignore_when_no_active_record
782
    run_generator [destination_root, "--skip-active-record"]
783

784
    assert_file ".gitignore" do |content|
785
      assert_no_match(/sqlite/i, content)
786 787 788 789 790 791
    end
  end

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

792
    assert_file ".gitignore" do |content|
793
      assert_no_match(/sqlite/i, content)
794 795 796
    end
  end

797 798 799 800 801 802 803 804 805 806 807
  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

808 809 810 811 812
  def test_version_control_initializes_git_repo
    run_generator [destination_root]
    assert_directory ".git"
  end

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
  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

836 837
  def test_psych_gem
    run_generator
838
    gem_regex = /gem 'psych',\s+'~> 2\.0',\s+platforms: :rbx/
839 840 841 842 843 844 845 846 847 848

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

849
  def test_after_bundle_callback
850
    path = "http://example.org/rails_template"
851
    template = %{ after_bundle { run 'echo ran after_bundle' } }.dup
852 853
    template.instance_eval "def read; self; end" # Make the string respond to read

854
    check_open = -> *args do
855
      assert_equal [ path, "Accept" => "application/x-thor-template" ], args
856 857
      template
    end
858

859
    sequence = ["git init", "install", "exec spring binstub --all", "echo ran after_bundle"]
860
    @sequence_step ||= 0
861
    ensure_bundler_first = -> command do
862 863 864 865 866 867 868 869 870 871 872
      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
873

874
    assert_equal 4, @sequence_step
875 876
  end

E
eileencodes 已提交
877 878 879 880 881 882 883 884
  def test_system_tests_directory_generated
    run_generator

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

  private
885 886 887 888 889
    def stub_rails_application(root)
      Rails.application.config.root = root
      Rails.application.class.stub(:name, "Myapp") do
        yield
      end
890 891
    end

892 893 894
    def action(*args, &block)
      capture(:stdout) { generator.send(*args, &block) }
    end
O
Oscar Del Ben 已提交
895

896 897 898 899 900 901
    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
902
    end
903

904
    def assert_listen_related_configuration
905 906
      assert_gem "listen"
      assert_gem "spring-watcher-listen"
907

908
      assert_file "config/environments/development.rb" do |content|
909
        assert_match(/^\s*config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
910
      end
911 912
    end

913
    def assert_no_listen_related_configuration
914
      assert_file "Gemfile" do |content|
915 916 917
        assert_no_match(/listen/, content)
      end

918
      assert_file "config/environments/development.rb" do |content|
919
        assert_match(/^\s*# config\.file_watcher = ActiveSupport::EventedFileUpdateChecker/, content)
920
      end
921 922
    end

923 924 925 926 927 928 929
    def assert_generates_with_bundler(options = {})
      generator([destination_root], options)

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

        case command
930
        when "install"
931 932
          @install_called += 1
          assert_equal 1, @install_called, "install expected to be called once, but was called #{@install_called} times"
933
        when "exec spring binstub --all"
934 935 936 937 938 939 940
          # Called when running tests with spring, let through unscathed.
        end
      end

      generator.stub :bundle_command, command_check do
        quietly { generator.invoke_all }
      end
941
    end
942
end