suspenders 1.53.0 → 1.54.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (102) hide show
  1. checksums.yaml +4 -4
  2. data/.ruby-version +1 -1
  3. data/.travis.yml +4 -3
  4. data/CONTRIBUTING.md +15 -15
  5. data/GOALS.md +65 -0
  6. data/NEWS.md +29 -0
  7. data/README.md +2 -4
  8. data/docs/heroku_deploy.md +2 -5
  9. data/lib/suspenders.rb +6 -0
  10. data/lib/suspenders/actions.rb +2 -2
  11. data/lib/suspenders/adapters/heroku.rb +14 -1
  12. data/lib/suspenders/app_builder.rb +3 -71
  13. data/lib/suspenders/generators/advisories_generator.rb +19 -0
  14. data/lib/suspenders/generators/app_generator.rb +7 -33
  15. data/lib/suspenders/generators/base.rb +39 -0
  16. data/lib/suspenders/generators/ci_generator.rb +19 -9
  17. data/lib/suspenders/generators/db_optimizations_generator.rb +3 -15
  18. data/lib/suspenders/generators/js_driver_generator.rb +1 -2
  19. data/lib/suspenders/generators/preloader_generator.rb +122 -0
  20. data/lib/suspenders/generators/production/compression_generator.rb +14 -0
  21. data/lib/suspenders/generators/production/deployment_generator.rb +1 -12
  22. data/lib/suspenders/generators/production/email_generator.rb +5 -8
  23. data/lib/suspenders/generators/production/manifest_generator.rb +1 -0
  24. data/lib/suspenders/generators/production/single_redirect.rb +15 -0
  25. data/lib/suspenders/generators/production/timeout_generator.rb +1 -0
  26. data/lib/suspenders/generators/profiler_generator.rb +35 -0
  27. data/lib/suspenders/generators/runner_generator.rb +48 -0
  28. data/lib/suspenders/generators/staging/pull_requests_generator.rb +2 -10
  29. data/lib/suspenders/generators/static_generator.rb +4 -0
  30. data/lib/suspenders/generators/stylesheet_base_generator.rb +5 -6
  31. data/lib/suspenders/generators/testing_generator.rb +0 -11
  32. data/lib/suspenders/version.rb +1 -1
  33. data/spec/adapters/heroku_spec.rb +28 -2
  34. data/spec/expand_json_spec.rb +89 -0
  35. data/spec/features/advisories_spec.rb +24 -0
  36. data/spec/features/ci_spec.rb +31 -0
  37. data/spec/features/db_optimizations_spec.rb +19 -0
  38. data/spec/features/heroku_spec.rb +6 -13
  39. data/spec/features/new_project_spec.rb +5 -27
  40. data/spec/features/preloader_spec.rb +25 -0
  41. data/spec/features/production/compression_spec.rb +23 -0
  42. data/spec/features/production/manifest_spec.rb +2 -0
  43. data/spec/features/production/single_redirect_spec.rb +25 -0
  44. data/spec/features/profiler_spec.rb +20 -0
  45. data/spec/features/runner_spec.rb +30 -0
  46. data/spec/features/static_spec.rb +17 -0
  47. data/spec/support/contain_json_matcher.rb +16 -10
  48. data/spec/support/project_files.rb +12 -0
  49. data/spec/support/rails_template.rb +1 -0
  50. data/spec/support/suspenders.rb +16 -13
  51. data/suspenders.gemspec +1 -2
  52. data/templates/Gemfile.erb +1 -6
  53. data/templates/application.scss +0 -1
  54. data/templates/bin_auto_migrate +5 -0
  55. data/templates/bin_deploy +0 -2
  56. data/templates/bin_setup +2 -2
  57. data/templates/bin_setup_review_app.erb +0 -1
  58. data/templates/chromedriver.rb +10 -0
  59. data/templates/descriptions/advisories.md +5 -0
  60. data/templates/descriptions/analytics.md +4 -0
  61. data/templates/descriptions/ci.md +4 -0
  62. data/templates/descriptions/compression.md +4 -0
  63. data/templates/descriptions/db_optimizations.md +2 -0
  64. data/templates/descriptions/deployment.md +5 -0
  65. data/templates/descriptions/email.md +9 -0
  66. data/templates/descriptions/factories.md +12 -0
  67. data/templates/descriptions/force_tls.md +1 -0
  68. data/templates/descriptions/forms.md +1 -0
  69. data/templates/descriptions/inline_svg.md +2 -0
  70. data/templates/descriptions/jobs.md +3 -0
  71. data/templates/descriptions/js_driver.md +4 -0
  72. data/templates/descriptions/json.md +1 -0
  73. data/templates/descriptions/lint.md +3 -0
  74. data/templates/descriptions/manifest.md +2 -0
  75. data/templates/descriptions/preloader.md +3 -0
  76. data/templates/descriptions/profiler.md +7 -0
  77. data/templates/descriptions/pull_requests.md +4 -0
  78. data/templates/descriptions/runner.md +10 -0
  79. data/templates/descriptions/single_redirect.md +1 -0
  80. data/templates/descriptions/static.md +5 -0
  81. data/templates/descriptions/stylelint.md +3 -0
  82. data/templates/descriptions/stylesheet_base.md +4 -0
  83. data/templates/descriptions/testing.md +9 -0
  84. data/templates/descriptions/timeout.md +4 -0
  85. data/templates/descriptions/views.md +8 -0
  86. data/templates/partials/ci_simplecov.rb +16 -0
  87. data/templates/partials/db_optimizations_configuration.rb +7 -0
  88. data/templates/partials/deployment_readme.md +8 -0
  89. data/templates/partials/email_smtp.rb +3 -0
  90. data/templates/partials/profiler_readme.md +8 -0
  91. data/templates/partials/pull_requests_config.rb +5 -0
  92. data/templates/partials/runner_readme.md +31 -0
  93. data/templates/partials/runner_setup.rb +3 -0
  94. data/templates/rack_mini_profiler.rb +2 -0
  95. data/templates/rails_helper.rb +4 -1
  96. data/templates/{dotfiles/.env → sample_env} +0 -1
  97. data/templates/spec_helper.rb +4 -7
  98. data/templates/spring.rb +6 -0
  99. data/templates/suspenders_gitignore +1 -1
  100. metadata +75 -25
  101. data/templates/dotfiles/.ctags +0 -2
  102. data/templates/puma.rb +0 -28
@@ -6,5 +6,9 @@ module Suspenders
6
6
  gem "high_voltage"
7
7
  Bundler.with_clean_env { run "bundle install" }
8
8
  end
9
+
10
+ def make_placeholder_directory
11
+ empty_directory_with_keep_file "app/views/pages"
12
+ end
9
13
  end
10
14
  end
@@ -3,11 +3,14 @@ require_relative "base"
3
3
  module Suspenders
4
4
  class StylesheetBaseGenerator < Generators::Base
5
5
  def add_stylesheet_gems
6
- gem "bourbon", ">= 5.0.1"
7
- gem "neat", ">= 3.0.1"
6
+ gem "bourbon", ">= 6.0.0"
8
7
  Bundler.with_clean_env { run "bundle install" }
9
8
  end
10
9
 
10
+ def remove_prior_config
11
+ remove_file "app/assets/stylesheets/application.css"
12
+ end
13
+
11
14
  def add_css_config
12
15
  copy_file(
13
16
  "application.scss",
@@ -16,10 +19,6 @@ module Suspenders
16
19
  )
17
20
  end
18
21
 
19
- def remove_prior_config
20
- remove_file "app/assets/stylesheets/application.css"
21
- end
22
-
23
22
  def install_bitters
24
23
  run "bitters install --path app/assets/stylesheets"
25
24
  end
@@ -40,16 +40,5 @@ module Suspenders
40
40
  def configure_action_mailer_in_specs
41
41
  copy_file "action_mailer.rb", "spec/support/action_mailer.rb"
42
42
  end
43
-
44
- private
45
-
46
- def empty_directory_with_keep_file(destination)
47
- empty_directory(destination, {})
48
- keep_file(destination)
49
- end
50
-
51
- def keep_file(destination)
52
- create_file(File.join(destination, ".keep"))
53
- end
54
43
  end
55
44
  end
@@ -4,5 +4,5 @@ module Suspenders
4
4
  read("#{File.dirname(__FILE__)}/../../.ruby-version").
5
5
  strip.
6
6
  freeze
7
- VERSION = "1.53.0".freeze
7
+ VERSION = "1.54.0".freeze
8
8
  end
@@ -11,9 +11,9 @@ module Suspenders
11
11
  Heroku.new(app_builder).set_heroku_remotes
12
12
 
13
13
  expect(app_builder).to have_received(:append_file).
14
- with(setup_file, /heroku join --app #{app_name.dasherize}-production/)
14
+ with(setup_file, /heroku apps:info --app #{app_name.dasherize}-production/)
15
15
  expect(app_builder).to have_received(:append_file).
16
- with(setup_file, /heroku join --app #{app_name.dasherize}-staging/)
16
+ with(setup_file, /heroku apps:info --app #{app_name.dasherize}-staging/)
17
17
  end
18
18
 
19
19
  it "sets the heroku rails secrets" do
@@ -55,6 +55,26 @@ module Suspenders
55
55
  )
56
56
  end
57
57
 
58
+ it "configures nodejs and ruby packs" do
59
+ app_builder = double(app_name: app_name)
60
+ allow(app_builder).to receive(:run)
61
+
62
+ Heroku.new(app_builder).set_heroku_buildpacks
63
+
64
+ %w(staging production).each do |remote|
65
+ expect(app_builder).to(
66
+ have_configured_buildpack(
67
+ remote_name: remote, index: 1, packname: "heroku/nodejs",
68
+ ),
69
+ )
70
+ expect(app_builder).to(
71
+ have_configured_buildpack(
72
+ remote_name: remote, index: 2, packname: "heroku/ruby",
73
+ ),
74
+ )
75
+ end
76
+ end
77
+
58
78
  def app_name
59
79
  SuspendersTestHelpers::APP_NAME
60
80
  end
@@ -67,6 +87,12 @@ module Suspenders
67
87
  def have_configured_var(remote_name, var)
68
88
  have_received(:run).with(/config:add #{var}=.+ --remote #{remote_name}/)
69
89
  end
90
+
91
+ def have_configured_buildpack(remote_name:, index:, packname:)
92
+ have_received(:run).with(
93
+ /buildpacks:add --index #{index} #{packname} --remote #{remote_name}/,
94
+ )
95
+ end
70
96
  end
71
97
  end
72
98
  end
@@ -0,0 +1,89 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe Suspenders::Actions::ExpandJson do
4
+ let(:destination_root) { File.join(root_path, "tmp") }
5
+ let(:destination_file_name) { "app.json" }
6
+ let(:destination_path) { File.join(destination_root, destination_file_name) }
7
+
8
+ before do
9
+ FileUtils.rm destination_path if File.exist?(destination_path)
10
+ end
11
+
12
+ describe "#invoke!" do
13
+ context "when calling multiple times with the same root key" do
14
+ before do
15
+ described_class.new(
16
+ destination_root,
17
+ destination_file_name,
18
+ env: {
19
+ SMTP_ADDRESS: { required: true },
20
+ },
21
+ ).invoke!
22
+ end
23
+
24
+ it "deep merges the hash" do
25
+ described_class.new(
26
+ destination_root,
27
+ destination_file_name,
28
+ env: {
29
+ HEROKU_APP_NAME: { required: true },
30
+ },
31
+ ).invoke!
32
+
33
+ expected = <<~JSON
34
+ {
35
+ "env": {
36
+ "SMTP_ADDRESS": {
37
+ "required": true
38
+ },
39
+ "HEROKU_APP_NAME": {
40
+ "required": true
41
+ }
42
+ }
43
+ }
44
+ JSON
45
+ expect(existing_json).to eq(expected.chomp)
46
+ end
47
+ end
48
+ end
49
+
50
+ describe "#revoke!" do
51
+ before do
52
+ described_class.new(
53
+ destination_root,
54
+ destination_file_name,
55
+ env: {
56
+ foo: { required: true },
57
+ bar: { required: true },
58
+ },
59
+ ).invoke!
60
+ end
61
+
62
+ it "removes data from the JSON" do
63
+ described_class.new(
64
+ destination_root,
65
+ destination_file_name,
66
+ env: {
67
+ foo: { required: true },
68
+ },
69
+ ).revoke!
70
+
71
+ expected = <<~JSON
72
+ {
73
+ "env": {
74
+ "bar": {
75
+ "required": true
76
+ }
77
+ }
78
+ }
79
+ JSON
80
+ expect(existing_json).to eq(expected.chomp)
81
+ end
82
+ end
83
+
84
+ private
85
+
86
+ def existing_json
87
+ IO.read(destination_path)
88
+ end
89
+ end
@@ -0,0 +1,24 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe "suspenders:advisories", type: :generator do
4
+ it "configures bundler-audit" do
5
+ with_app { generate("suspenders:advisories") }
6
+
7
+ run_in_project do
8
+ expect(`rake -T`).to include("rake bundle:audit")
9
+ end
10
+ expect("lib/tasks/bundler_audit.rake").to \
11
+ match_contents(/Bundler::Audit::Task.new/)
12
+ expect("Gemfile").to match_contents(/bundler-audit/)
13
+ end
14
+
15
+ it "removes bundler-audit" do
16
+ with_app { destroy("suspenders:advisories") }
17
+
18
+ expect("Gemfile").not_to match_contents(/bundler-audit/)
19
+ expect("lib/tasks/bundler_audit.rake").not_to exist_as_a_file
20
+ run_in_project do
21
+ expect(`rake -T`).not_to include("rake bundle:audit")
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,31 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe "suspenders:ci", type: :generator do
4
+ it "configures Circle with SimpleCov" do
5
+ with_app { generate("suspenders:ci") }
6
+
7
+ expect("Gemfile").to match_contents(/simplecov/)
8
+ expect("test/test_helper.rb").to match_contents(/SimpleCov.coverage_dir/)
9
+ expect("test/test_helper.rb").to match_contents(/SimpleCov.start/)
10
+ expect("circle.yml").to exist_as_a_file
11
+ end
12
+
13
+ it "removes Circle and SimpleCov" do
14
+ with_app { destroy("suspenders:ci") }
15
+
16
+ expect("circle.yml").not_to exist_as_a_file
17
+ expect("test/test_helper.rb").not_to match_contents(/SimpleCov/)
18
+ expect("Gemfile").not_to match_contents(/simplecov/)
19
+ end
20
+
21
+ it "configures RSpec" do
22
+ with_app do
23
+ copy_file "spec_helper.rb", "spec/spec_helper.rb"
24
+
25
+ generate("suspenders:ci")
26
+ end
27
+
28
+ expect("spec/spec_helper.rb").to match_contents(/SimpleCov.coverage_dir/)
29
+ expect("spec/spec_helper.rb").to match_contents(/SimpleCov.start/)
30
+ end
31
+ end
@@ -0,0 +1,19 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe "suspenders:db_optimizations", type: :generator do
4
+ it "configures bullet" do
5
+ with_app { generate("suspenders:db_optimizations") }
6
+
7
+ expect("Gemfile").to match_contents(/bullet/)
8
+ expect("config/environments/development.rb").to \
9
+ match_contents(/Bullet.enable/)
10
+ end
11
+
12
+ it "removes bullet" do
13
+ with_app { destroy("suspenders:db_optimizations") }
14
+
15
+ expect("Gemfile").not_to match_contents(/bullet/)
16
+ expect("config/environments/development.rb").not_to \
17
+ match_contents(/Bullet.enable/)
18
+ end
19
+ end
@@ -27,8 +27,8 @@ RSpec.describe "Heroku" do
27
27
  bin_setup_path = "#{project_path}/bin/setup"
28
28
  bin_setup = IO.read(bin_setup_path)
29
29
 
30
- expect(bin_setup).to match(/^if heroku join --app #{app_name}-production/)
31
- expect(bin_setup).to match(/^if heroku join --app #{app_name}-staging/)
30
+ expect(bin_setup).to assert_access_to_heroku_app("#{app_name}-production")
31
+ expect(bin_setup).to assert_access_to_heroku_app("#{app_name}-staging")
32
32
  expect(bin_setup).to match(/^git config heroku.remote staging/)
33
33
  expect("bin/setup").to be_executable
34
34
 
@@ -36,17 +36,6 @@ RSpec.describe "Heroku" do
36
36
 
37
37
  expect(readme).to include("./bin/deploy staging")
38
38
  expect(readme).to include("./bin/deploy production")
39
-
40
- circle_yml_path = "#{project_path}/circle.yml"
41
- circle_yml = IO.read(circle_yml_path)
42
-
43
- expect(circle_yml).to include <<-YML.strip_heredoc
44
- deployment:
45
- staging:
46
- branch: master
47
- commands:
48
- - bin/deploy staging
49
- YML
50
39
  end
51
40
  end
52
41
 
@@ -63,6 +52,10 @@ RSpec.describe "Heroku" do
63
52
  end
64
53
  end
65
54
 
55
+ def assert_access_to_heroku_app(app_name)
56
+ match(/^if heroku apps:info --app #{app_name}/)
57
+ end
58
+
66
59
  def clean_up
67
60
  drop_dummy_database
68
61
  remove_project_directory
@@ -44,9 +44,7 @@ RSpec.describe "Suspend a new project with default configuration" do
44
44
  end
45
45
 
46
46
  it "copies dotfiles" do
47
- %w[.ctags .env].each do |dotfile|
48
- expect(File).to exist("#{project_path}/#{dotfile}")
49
- end
47
+ expect(File).to exist("#{project_path}/.env")
50
48
  end
51
49
 
52
50
  it "doesn't generate test directory" do
@@ -86,28 +84,11 @@ RSpec.describe "Suspend a new project with default configuration" do
86
84
  expect(hound_config_file).to include "enabled: true"
87
85
  end
88
86
 
89
- it "ensures Gemfile contains `rack-mini-profiler`" do
90
- gemfile = IO.read("#{project_path}/Gemfile")
91
-
92
- expect(gemfile).to include %{gem "rack-mini-profiler", require: false}
93
- end
94
-
95
- it "ensures .sample.env defaults to RACK_MINI_PROFILER=0" do
96
- env = IO.read("#{project_path}/.env")
97
-
98
- expect(env).to include "RACK_MINI_PROFILER=0"
99
- end
100
-
101
87
  it "initializes ActiveJob to avoid memory bloat" do
102
88
  expect(File).
103
89
  to exist("#{project_path}/config/initializers/active_job.rb")
104
90
  end
105
91
 
106
- it "creates a rack-mini-profiler initializer" do
107
- expect(File).
108
- to exist("#{project_path}/config/initializers/rack_mini_profiler.rb")
109
- end
110
-
111
92
  it "records pageviews through Segment if ENV variable set" do
112
93
  expect(analytics_partial).
113
94
  to include(%{<% if ENV["SEGMENT_KEY"] %>})
@@ -256,8 +237,6 @@ RSpec.describe "Suspend a new project with default configuration" do
256
237
 
257
238
  expect(bin_setup).to include("PARENT_APP_NAME=#{app_name.dasherize}-staging")
258
239
  expect(bin_setup).to include("APP_NAME=#{app_name.dasherize}-staging-pr-$1")
259
- expect(bin_setup).
260
- to include("heroku run rails db:migrate --exit-code --app $APP_NAME")
261
240
  expect(bin_setup).to include("heroku ps:scale worker=1 --app $APP_NAME")
262
241
  expect(bin_setup).to include("heroku restart --app $APP_NAME")
263
242
 
@@ -268,7 +247,7 @@ RSpec.describe "Suspend a new project with default configuration" do
268
247
  bin_deploy_path = "#{project_path}/bin/deploy"
269
248
  bin_deploy = IO.read(bin_deploy_path)
270
249
 
271
- expect(bin_deploy).to include("heroku run rails db:migrate --exit-code")
250
+ expect(bin_deploy).to include("git push")
272
251
  expect("bin/deploy").to be_executable
273
252
  end
274
253
 
@@ -293,17 +272,16 @@ RSpec.describe "Suspend a new project with default configuration" do
293
272
  expect(gemfile).to match(/sassc-rails/)
294
273
  end
295
274
 
296
- it "adds and configures bourbon and neat" do
275
+ it "adds and configures bourbon" do
297
276
  gemfile = read_project_file("Gemfile")
298
277
 
299
278
  expect(gemfile).to match(/bourbon/)
300
- expect(gemfile).to match(/neat/)
301
279
  end
302
280
 
303
- it "configures bourbon, neat, and bitters" do
281
+ it "configures bourbon, and bitters" do
304
282
  app_css = read_project_file(%w(app assets stylesheets application.scss))
305
283
  expect(app_css).to match(
306
- /normalize\.css\/normalize.*bourbon.*neat.*base/m,
284
+ /normalize\.css\/normalize.*bourbon.*base/m,
307
285
  )
308
286
  end
309
287
 
@@ -0,0 +1,25 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe "suspenders:preloader", type: :generator do
4
+ it "adds binstubs for Spring" do
5
+ with_app { generate("suspenders:preloader") }
6
+
7
+ expect("bin/rails").to match_contents(/spring/)
8
+ expect("config/spring.rb").to exist_as_a_file
9
+ expect("config/environments/test.rb").to \
10
+ match_contents(/config.cache_classes = false/)
11
+ expect("Gemfile").to match_contents(/spring/)
12
+ expect("Gemfile").to match_contents(/spring-watcher-listen/)
13
+ end
14
+
15
+ it "removes Spring binstubs" do
16
+ with_app { destroy("suspenders:preloader") }
17
+
18
+ expect("config/environments/test.rb").to \
19
+ match_contents(/config.cache_classes = true/)
20
+ expect("config/spring.rb").not_to exist_as_a_file
21
+ expect("bin/rails").not_to match_contents(/spring/)
22
+ expect("Gemfile").not_to match_contents(/spring-watcher-listen/)
23
+ expect("Gemfile").not_to match_contents(/spring/)
24
+ end
25
+ end
@@ -0,0 +1,23 @@
1
+ require "spec_helper"
2
+
3
+ RSpec.describe "suspenders:production:compression", type: :generator do
4
+ context "generate" do
5
+ it "adds Rack::Deflater to the middleware" do
6
+ with_app { generate("suspenders:production:compression") }
7
+
8
+ expect("config/environments/production.rb").to match_contents(
9
+ %r{config.middleware.use Rack::Deflater},
10
+ )
11
+ end
12
+ end
13
+
14
+ context "destroy" do
15
+ it "removes Rack::Deflater to the middleware" do
16
+ with_app { destroy("suspenders:production:compression") }
17
+
18
+ expect("config/environments/production.rb").not_to match_contents(
19
+ %r{Rack::Deflater},
20
+ )
21
+ end
22
+ end
23
+ end