welaika-suspenders 2.33 → 2.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1feb33dee0a5957e4e4f475da9afc775414ba866f162781bc160dec04fcdd9f4
-  data.tar.gz: 6b6f4bd1656d5cb86bf9ffbc4d2131ecc69b1dc64bca69199b4e385f3df3e9df
+  metadata.gz: fca0442cb0adbdb8f07149baafe1841af1d44aa4c9028260ed332ffc6dac4c70
+  data.tar.gz: 402be3ceb068fdf2a08344050de8b5516f95cd45c63efab9bbda3c93785548d9
 SHA512:
-  metadata.gz: fe96258397d31d095e8db2b2259117d1a6fb78eebe4b27e39047408b4628ed910b91815cab7087f5bbd9dfa16214b722c72a56399f15f7acc3cf2fdf8ccbb1d9
-  data.tar.gz: 4a01c8d4b248329326ef71e2bde68eb4c5d67672e3a7be437b8e72a6ada4fb2a015730ca27f673faee473030bb70b8881e0bf61639406b4aba9d4cc50a895ada
+  metadata.gz: ca5b9dff76fe3ecca545cd9c7ae09984b65df11895cb31fba42d7439fed0221e509596cbabcda45ecd0d3eecc11f62b16cd9e968313dbfd5434be513b44f6218
+  data.tar.gz: 79104448a207fd73e1a4ee60ae3261d787f9cc91dff76e847bf130a405cc0b7df2f3321b4f6d8bea1609b15c42ffd5ccebc787a9bd488a0d5abfaa8064c39837

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.6.5

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
-rvm: 2.6.3
+rvm: 2.6.5
 cache: bundler
 sudo: false
 before_install:
   - git config --global user.name 'Travis CI'
   - git config --global user.email 'travis-ci@example.com'
   - gem update --system
-  - gem install bundler -v '< 2'
+  - gem install bundler
 install: bundle install
 notifications:
   email: false
+services:
+  - postgresql

data/CHANGELOG_WELAIKA.md

@@ -1,3 +1,18 @@
+2.34 (October 19th, 2019)
+* Change: gitlab ci steps from prepare -> quality -> test to prepare -> test -> quality. We already run some quality checks with overcommit
+* Change: use :login instead of :plain as smtp authentication system
+* Change: use PostgreSQL 11
+* Change: edited rubocop rules
+* Documentation: update readme about suspenders
+* Feature: add sidekiq
+* Change: install foreman if it does not exist
+* Change: update rubocop rules
+* Fix: stick to style-lint 10 for now, because some plugins does not work with 11
+* Change: use bundler 2 by default
+* Feature: add inline_svg gem (from upstream)
+* Change: use a new way to migrate database on heroku (from upstream)
+
+
 2.33 (July 23th, 2019)
 * Feature: allow to deploy to heroku with push --force-with-lease (useful for staging)
 * Fix: make new Chrome versions (really) headless

data/NEWS.md

@@ -1,3 +1,11 @@
+1.53.0 (August 23, 2019)
+* Upgraded: Rails 6.0.
+* New generator: `suspenders:inline_svg` for setting up the inline_svg gem.
+* Changed: silence Puma's startup messages in JS specs.
+* Changed: improve chromedriver configuration.
+* Added: documentation for deploying to Heroku.
+* Fixed: indentation in production config file.
+
 1.52.0 (June 7, 2019)
 * Changed: Setup system tests instead of feature specs
 * Upgraded: Rails 5.2.3

data/README.md

@@ -3,15 +3,21 @@
 This is a [suspenders](https://github.com/thoughtbot/suspenders) fork in use at [weLaika](http://dev.welaika.com).
 Big thanks to [thoughtbot](http://thoughtbot.com/community) for providing such a great starting point.
 
+** Warning! **
+
+welaika-suspenders version 2 will install rails 5.
+welaika-suspenders version 3 will install rails 6.
+
+You may want to use version 2 if you need to use solidus 2.9.x
+
 ## Installation
 
-First ensure you have PostgreSQL, npm, yarn and chromedriver
+First ensure you have PostgreSQL (use the same version specified in `Suspenders::POSTGRES_VERSION`), npm and yarn.
 
-    $ brew install postgresql@10
+    $ brew install postgresql
     $ brew install node
     $ npm install npm@latest -g # To update npm if you have already installed it
     $ brew install yarn
-    $ brew casks install chromedriver
 
 then install the suspenders gem:
 
@@ -23,7 +29,7 @@ If you want to use heroku, please install the [heroku toolbelt](https://toolbelt
 
 Then run:
 
-    welaika-suspenders projectname
+    welaika-suspenders projectname --heroku=true
 
 This will create a Rails app in `projectname` using the latest version of Rails.
 
@@ -40,19 +46,9 @@ See all possible Heroku flags:
 This will create a rails app in `projectname`. This script creates a
 new git repository. It is not meant to be used against an existing repo.
 
-    cd projectname && bin/setup
-
-If you want to add an empty bare repository as origin, run
+Run the bin/setup script
 
-    git remote add origin git@github.com:welaika/projectname.git
-
-## Sentry && Heroku
-
-After deploying for the first time on Heroku, please run
-
-`heroku labs:enable runtime-dyno-metadata`
-
-for Sentry's release detection to work correctly.
+    cd projectname && bin/setup
 
 ## Version number
 

data/docs/heroku_deploy.md

@@ -0,0 +1,22 @@
+# Deploying to Heroku
+
+## Setup
+
+Deploying to Heroku requires two additional steps:
+
+1. Manually add buildpacks `node.js` and `ruby` (in that order) to your Heroku
+   app. This is necessary because build order is important and Heroku's
+   auto-detection will add them in the wrong order.
+
+2. Set the following environment variables:
+
+- `ASSET_HOST`: `siteURL.herokuapp.com`
+- `APPLICATION_HOST`: `siteURL.herokuapp.com`
+- `SMTP_ADDRESS`: `smtp.example.com`
+- `SMTP_DOMAIN`: `example.com`
+- `SMTP_USERNAME`: `username`
+- `SMTP_PASSWORD`: `password`
+
+## Execution
+
+- Use the `./bin/deploy` convention for deploying to Heroku

data/lib/suspenders.rb

@@ -15,6 +15,8 @@ require "suspenders/generators/decorator_generator"
 require "suspenders/generators/faker_generator"
 require "suspenders/generators/security_generator"
 require "suspenders/generators/import_dump_generator"
+require "suspenders/generators/jobs_generator"
+require "suspenders/generators/inline_svg_generator"
 require "suspenders/generators/production/force_tls_generator"
 require "suspenders/generators/production/email_generator"
 require "suspenders/generators/production/timeout_generator"

data/lib/suspenders/actions.rb

@@ -39,7 +39,7 @@ module Suspenders
       end
 
       def invoke!
-        write_out { |existing_json| existing_json.merge(data) }
+        write_out { |existing_json| existing_json.deep_merge(data) }
       end
 
       def revoke!
@@ -60,7 +60,7 @@ module Suspenders
       end
 
       def existing_json
-        JSON.parse(IO.read(destination_file))
+        JSON.parse(IO.read(destination_file), symbolize_names: true)
       rescue Errno::ENOENT
         {}
       end

data/lib/suspenders/app_builder.rb

@@ -100,7 +100,7 @@ module Suspenders
 
     def enable_rack_canonical_host
       config = <<-RUBY
-  config.middleware.use Rack::CanonicalHost, ENV.fetch("APPLICATION_HOST")
+config.middleware.use Rack::CanonicalHost, ENV.fetch('APPLICATION_HOST')
       RUBY
 
       configure_environment "production", config
@@ -113,7 +113,7 @@ module Suspenders
     def setup_asset_host
       replace_in_file 'config/environments/production.rb',
         "# config.action_controller.asset_host = 'http://assets.example.com'",
-        'config.action_controller.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
+        "config.action_controller.asset_host = ENV.fetch('ASSET_HOST', ENV.fetch('APPLICATION_HOST'))"
 
       if File.exist?("config/initializers/assets.rb")
         replace_in_file 'config/initializers/assets.rb',
@@ -123,7 +123,7 @@ module Suspenders
 
       config = <<-EOD
 config.public_file_server.headers = {
-    "Cache-Control" => "public, max-age=31557600",
+    'Cache-Control' => 'public, max-age=31557600',
   }
       EOD
 
@@ -175,7 +175,7 @@ config.public_file_server.headers = {
       template "config_locales_it.yml.erb", "config/locales/it.yml"
 
       config = <<-RUBY
-    config.i18n.available_locales = [:en, :it]
+    config.i18n.available_locales = %i[en it]
     config.i18n.default_locale = :it
     config.time_zone = 'Rome'
       RUBY
@@ -188,10 +188,10 @@ config.public_file_server.headers = {
       action_mailer_asset_host "development", %{"http://localhost:3000"}
       action_mailer_host "test", %{"www.example.com"}
       action_mailer_asset_host "test", %{"http://www.example.com"}
-      action_mailer_host "production", %{ENV.fetch("APPLICATION_HOST")}
+      action_mailer_host "production", %{ENV.fetch('APPLICATION_HOST')}
       action_mailer_asset_host(
         "production",
-        %{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))},
+        %{ENV.fetch('ASSET_HOST', ENV.fetch('APPLICATION_HOST'))},
       )
     end
 
@@ -200,7 +200,9 @@ config.public_file_server.headers = {
     end
 
     def set_up_forego
+      # NOTE: we want to use ruby foreman!
       copy_file "Procfile", "Procfile"
+      Bundler.with_clean_env { run "gem install foreman" }
     end
 
     def setup_default_directories
@@ -236,8 +238,16 @@ config.public_file_server.headers = {
       create_production_heroku_app(flags)
     end
 
+    def configure_automatic_deployment
+      append_file "Procfile", "release: bin/auto_migrate"
+    end
+
+    def setup_bundler_audit
+      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
+      append_file "Rakefile", %{\ntask default: "bundle:audit"\n}
+    end
+
     def copy_miscellaneous_files
-      copy_file "browserslist", "browserslist"
       copy_file "errors.rb", "config/initializers/errors.rb"
       copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
     end
@@ -279,10 +289,8 @@ config.public_file_server.headers = {
       end
     end
 
-    def remove_routes_comment_lines
-      replace_in_file 'config/routes.rb',
-        /Rails\.application\.routes\.draw do.*end/m,
-        "Rails.application.routes.draw do\nend"
+    def run_rubocop_autocorrect
+      Bundler.with_clean_env { run "bundle exec rubocop -a" }
     end
 
     def setup_rakefile

data/lib/suspenders/generators/app_generator.rb

@@ -55,8 +55,6 @@ module Suspenders
       invoke :create_heroku_apps
       invoke :generate_deployment_default
       invoke :remove_config_comment_lines
-      invoke :remove_routes_comment_lines
-      invoke :outro
     end
 
     def customize_gemfile
@@ -149,10 +147,6 @@ module Suspenders
       build :remove_config_comment_lines
     end
 
-    def remove_routes_comment_lines
-      build :remove_routes_comment_lines
-    end
-
     def generate_default
       generate("suspenders:json")
       generate("suspenders:static")
@@ -164,11 +158,12 @@ module Suspenders
       generate("suspenders:factories")
       generate("suspenders:lint")
       generate("suspenders:stylelint")
-      generate("suspenders:views")
       generate("suspenders:decorator")
       generate("suspenders:faker")
       generate("suspenders:security")
       generate("suspenders:import_dump")
+      generate("suspenders:jobs")
+      generate("suspenders:inline_svg")
     end
 
     def generate_deployment_default
@@ -181,7 +176,13 @@ module Suspenders
       generate("suspenders:production:manifest")
     end
 
-    def outro
+    def generate_views
+      generate("suspenders:views")
+    end
+
+    def generate_outro
+      build :run_rubocop_autocorrect
+
       say "Congratulations! You just pulled our suspenders."
       say "Read README.md!"
     end

data/lib/suspenders/generators/factories_generator.rb

@@ -4,7 +4,7 @@ module Suspenders
   class FactoriesGenerator < Generators::Base
     def add_factory_bot
       gem "factory_bot_rails", group: %i(development test)
-      gem "database_cleaner", group: %i(development test)
+      gem "database_cleaner", group: %i(development test), require: false
       Bundler.with_clean_env { run "bundle install" }
     end
 

data/lib/suspenders/generators/inline_svg_generator.rb

@@ -0,0 +1,14 @@
+require_relative "base"
+
+module Suspenders
+  class InlineSvgGenerator < Generators::Base
+    def add_inline_svg
+      gem "inline_svg"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_inline_svg
+      copy_file "inline_svg.rb", "config/initializers/inline_svg.rb"
+    end
+  end
+end

data/lib/suspenders/generators/jobs_generator.rb

@@ -0,0 +1,53 @@
+require_relative "base"
+
+module Suspenders
+  class JobsGenerator < Generators::Base
+    def add_jobs_gem
+      gem "sidekiq"
+      Bundler.with_clean_env { run "bundle install" }
+    end
+
+    def configure_foreman
+      append_to_file(
+        'Procfile',
+        'worker: bundle exec sidekiq -C config/sidekiq.yml'
+      )
+    end
+
+    def configure_sidekiq
+      copy_file(
+        "config_sidekiq.yml",
+        "config/sidekiq.yml"
+      )
+    end
+
+    def configure_sidekiq_web
+      inject_into_file(
+        "config/routes.rb",
+        "require 'sidekiq/web'\n\n",
+        before: "Rails.application.routes.draw do\n"
+      )
+      inject_into_file(
+        "config/routes.rb",
+        "  mount Sidekiq::Web => '/sidekiq'\n",
+        after: "Rails.application.routes.draw do\n"
+      )
+      warn "Sidekiq web is public! Read https://github.com/mperham/sidekiq/wiki/Monitoring to learn how to add authentication"
+    end
+
+    def configure_sidekiq_test
+      copy_file(
+        "spec_support_sidekiq.rb",
+        "spec/support/sidekiq.rb"
+      )
+    end
+
+    def configure_active_job
+      inject_into_file(
+        "config/application.rb",
+        "\n    config.active_job.queue_adapter = :sidekiq",
+        before: "\n  end",
+      )
+    end
+  end
+end

data/lib/suspenders/generators/production/email_generator.rb

@@ -7,7 +7,7 @@ module Suspenders
         copy_file "smtp.rb", "config/smtp.rb"
 
         prepend_file "config/environments/production.rb",
-          %{require Rails.root.join("config/smtp")\n}
+          %{require Rails.root.join('config', 'smtp')\n}
       end
 
       def use_smtp

data/lib/suspenders/generators/production/error_reporting_generator.rb

@@ -35,14 +35,14 @@ module Suspenders
 
       def context_configuration
         <<-RUBY
-    before_action :set_raven_context
+  before_action :set_raven_context
 
-    private
+  private
 
-    def set_raven_context
-      Raven.user_context(id: session[:current_user_id])
-      Raven.extra_context(params: params.to_unsafe_h, url: request.url)
-    end
+  def set_raven_context
+    Raven.user_context(id: session[:current_user_id])
+    Raven.extra_context(params: params.to_unsafe_h, url: request.url)
+  end
         RUBY
       end
     end

data/lib/suspenders/generators/production/manifest_generator.rb

@@ -10,13 +10,14 @@ module Suspenders
           scripts: {},
           env: {
             APPLICATION_HOST: { required: true },
+            AUTO_MIGRATE_DB: { value: "true" },
             EMAIL_RECIPIENTS: { required: true },
             HEROKU_APP_NAME: { required: true },
             HEROKU_PARENT_APP_NAME: { required: true },
             RACK_ENV: { required: true },
             SECRET_KEY_BASE: { generator: "secret" },
           },
-          addons: ["heroku-postgresql"],
+          addons: ["heroku-postgresql", "heroku-redis"],
         )
       end
     end

data/lib/suspenders/generators/production/timeout_generator.rb

@@ -5,6 +5,7 @@ module Suspenders
     class TimeoutGenerator < Generators::Base
       def add_gem
         gem "rack-timeout", group: :production
+        Bundler.with_clean_env { run "bundle install" }
       end
 
       def configure_rack_timeout