welaika-suspenders 2.29.0.alpha.1 → 2.29.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2bc8b6b54027c607ac3d40740602bb464a24c69baebdccbf0274b6bcf52b541
-  data.tar.gz: c6145805c840fd18b6e4b40e63332de24bc626f6f0de7b8f7fc83b816f2b7e5a
+  metadata.gz: 99c15d50a9c274c2685a1a9807bd5dd3c68e23308e4f9367da74d1ca7270aef1
+  data.tar.gz: 28b04a2011baaa632eb1ab8889bf413a42aede7b102e2b167760aea3fd808c31
 SHA512:
-  metadata.gz: 9d92f5e43680df4e9dca8a24618153f3d98cd5ee5de61504b0b8a0fddc796a33b25b90a9189d501150ace679d85343de2a566bcc97e66092cead0ebc9545b55c
-  data.tar.gz: 90adc4777638db3f20b4caac5ca84a7fadb5a7acf3662f041a396d9a304fca49483c871e65b86f62fb9841393b42620336e63c12548fcc62b6df8c1f3f913f9e
+  metadata.gz: 113ae2339f91f79d66f7cee8fba15e2f11f78cbad5fd0db05ae75e8dec9c2b1342da198c2f4118dde86256a2266a2557f39ae885ce28fb57819d612d95327e27
+  data.tar.gz: 3c9fad55bfb2c5826956a20de2b1a4255df2b0ab4a7f44defe47d39be6b7f37e55f11ae6a256f26001362455cb4557c82dd32b2bcf7e9e2ba1fe377312cd8ac4

data/lib/suspenders/app_builder.rb

@@ -313,25 +313,11 @@ you can deploy to staging and production with:
         "Rails.application.routes.draw do\nend"
     end
 
-    def setup_default_rake_task
-      append_file 'Rakefile' do
-        <<-EOS
-task(:default).clear
-
-if defined? RSpec
-  task(:spec).clear
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.verbose = false
-  end
-end
-
-task default: :rubocop
-task default: :slim_lint
-task default: 'brakeman:check'
-task default: 'bundle:audit'
-task default: :spec
-        EOS
-      end
+    def setup_rakefile
+      # NOTE: we named our file `rakefile_template` and not
+      # `Rakefile` because otherwise `copy_file` would copy the
+      # rails `Rakefile` into the project folder.
+      copy_file 'rakefile_template.rb', 'Rakefile', force: true
     end
 
     private

data/lib/suspenders/generators/app_generator.rb

@@ -104,17 +104,19 @@ module Suspenders
       build :configure_action_mailer
       build :configure_locales_and_time_zone
       build :configure_time_formats
-      build :setup_default_rake_task
+      build :setup_rakefile
       build :replace_default_puma_configuration
       build :set_up_forego
       build :setup_rack_mini_profiler
     end
 
     def create_local_heroku_setup
-      say "Creating local Heroku setup"
-      build :create_review_apps_setup_script
-      build :create_deploy_script
-      build :create_heroku_application_manifest_file
+      if options[:heroku]
+        say "Creating local Heroku setup"
+        build :create_review_apps_setup_script
+        build :create_deploy_script
+        build :create_heroku_application_manifest_file
+      end
     end
 
     def create_heroku_apps

data/lib/suspenders/generators/decorator_generator.rb

@@ -7,7 +7,7 @@ module Suspenders
       File.dirname(__FILE__),
     )
 
-    def add_factory_bot
+    def add_draper_gem
       gem "draper"
       Bundler.with_clean_env { run "bundle install" }
     end

data/lib/suspenders/generators/factories_generator.rb

@@ -9,6 +9,7 @@ module Suspenders
 
     def add_factory_bot
       gem "factory_bot_rails", group: %i(development test)
+      gem "database_cleaner", group: %i(development test)
       Bundler.with_clean_env { run "bundle install" }
     end
 
@@ -16,6 +17,10 @@ module Suspenders
       copy_file "factory_bot_rspec.rb", "spec/support/factory_bot.rb"
     end
 
+    def set_up_factory_lint
+      copy_file 'factory_bot.rake', 'lib/tasks/factory_bot.rake'
+    end
+
     def provide_dev_prime_task
       copy_file "dev.rake", "lib/tasks/dev.rake"
     end

data/lib/suspenders/generators/lint_generator.rb

@@ -11,24 +11,36 @@ module Suspenders
       gem 'rubocop', require: false, group: :development
       gem 'rubocop-rspec', require: false, group: :development
       gem 'slim_lint', require: false, group: :development
+      gem 'overcommit', require: false, group: :development
+      gem 'rubycritic', require: false, group: :development
       Bundler.with_clean_env { run "bundle install" }
     end
 
     def setup_rubocop
-      copy_file "rubocop.rake", "lib/tasks/rubocop.rake"
       copy_file "rubocop.yml", ".rubocop.yml"
       copy_file "rubocop_todo.yml", ".rubocop_todo.yml"
     end
 
     def setup_slim_lint
-      copy_file "slim-lint.rake", "lib/tasks/slim-lint.rake"
       copy_file "slim-lint.yml", ".slim-lint.yml"
     end
 
+    def setup_overcommit
+      run "overcommit --install"
+      copy_file "overcommit.yml", ".overcommit.yml", force: true
+      run "overcommit --sign"
+    end
+
+    def setup_rubycritic
+      copy_file "reek", ".reek"
+    end
+
     def create_binstubs
       Bundler.with_clean_env do
         run "bundle binstubs rubocop"
         run "bundle binstubs slim_lint"
+        run "bundle binstubs overcommit"
+        run "bundle binstubs rubycritic"
       end
     end
   end

data/lib/suspenders/generators/security_generator.rb

@@ -13,15 +13,6 @@ module Suspenders
       Bundler.with_clean_env { run "bundle install" }
     end
 
-
-    def setup_brakeman
-      copy_file "brakeman.rake", "lib/tasks/brakeman.rake"
-    end
-
-    def setup_bundler_audit
-      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
-    end
-
     def create_binstubs
       Bundler.with_clean_env { run "bundle binstubs brakeman" }
     end

data/lib/suspenders/version.rb

@@ -4,5 +4,5 @@ module Suspenders
     read("#{File.dirname(__FILE__)}/../../.ruby-version").
     strip.
     freeze
-  VERSION = "2.29.0.alpha.1".freeze
+  VERSION = "2.29.0.alpha.2".freeze
 end

data/spec/features/new_project_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe "Suspend a new project with default configuration" do
   it "ensures project specs pass" do
     Dir.chdir(project_path) do
       Bundler.with_clean_env do
-        expect(`rake`).to include('0 failures')
+        expect(`bundle exec rspec spec/`).to include('0 failures')
       end
     end
   end
@@ -230,6 +230,7 @@ RSpec.describe "Suspend a new project with default configuration" do
     expect(File).to exist("#{project_path}/bin/brakeman")
     expect(File).to exist("#{project_path}/bin/rubocop")
     expect(File).to exist("#{project_path}/bin/rspec")
+    expect(File).to exist("#{project_path}/bin/overcommit")
   end
 
   it "removes comments and extra newlines from config files" do

data/templates/Gemfile.erb

@@ -1,54 +1,53 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 git_source(:github) do |repo_name|
-  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
   "https://github.com/#{repo_name}.git"
 end
 
-ruby "<%= Suspenders::RUBY_VERSION %>"
-
-gem "active_interaction", "~> 3.6"
-gem "autoprefixer-rails"
-gem "coffee-rails", "~> 4.2"
-gem "email_validator"
-gem "flutie"
-gem "jquery-rails" #TODO keep  it?
-gem "pg", ">= 0.18", "< 2.0"
-gem "puma", "~> 3.11"
-gem "rack-canonical-host"
-gem "rails", "<%= Suspenders::RAILS_VERSION %>"
-gem "rails-i18n"
-gem "recipient_interceptor"
-gem "sass-rails", "~> 5.0"
-gem "title"
-gem "uglifier", ">= 1.3.0"
-gem "bootsnap", ">= 1.1.0", require: false
+ruby '<%= Suspenders::RUBY_VERSION %>'
+
+gem 'active_interaction', '~> 3.6'
+gem 'autoprefixer-rails'
+gem 'coffee-rails', '~> 4.2'
+gem 'email_validator'
+gem 'flutie'
+gem 'pg', '>= 0.18', '< 2.0'
+gem 'puma', '~> 3.11'
+gem 'rack-canonical-host'
+gem 'rails', '<%= Suspenders::RAILS_VERSION %>'
+gem 'rails-i18n'
+gem 'recipient_interceptor'
+gem 'sass-rails', '~> 5.0'
+gem 'title'
+gem 'uglifier', '>= 1.3.0'
+gem 'bootsnap', '>= 1.1.0', require: false
 <% if options[:webpack] %>
-gem "webpacker"
+gem 'webpacker'
 <% end %>
 
 group :development do
-  gem "letter_opener"
-  gem "listen", ">= 3.0.5", "< 3.2"
-  gem "rack-mini-profiler", require: false
-  gem "spring"
-  gem "web-console", ">= 3.3.0"
+  gem 'letter_opener'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+  gem 'rack-mini-profiler', require: false
+  gem 'spring'
+  gem 'web-console', '>= 3.3.0'
 end
 
 group :development, :test do
-  gem "awesome_print"
-  gem "dotenv-rails"
-  gem "pry-byebug"
-  gem "pry-rails"
+  gem 'awesome_print'
+  gem 'dotenv-rails'
+  gem 'pry-byebug'
+  gem 'pry-rails'
 end
 
 group :test do
-  gem "launchy"
-  gem "simplecov", require: false
-  gem "timecop"
-  gem "webmock"
+  gem 'launchy'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
 end
 
-gem "welaika-suspenders", "~> <%= Suspenders::VERSION %>", group: [:development, :test]
+gem 'welaika-suspenders', '~> <%= Suspenders::VERSION %>', group: %i[development test]

data/templates/bin_setup

@@ -1,24 +1,34 @@
-#!/bin/sh
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
 
-# Set up Rails app. Run this script immediately after cloning the codebase.
+APP_ROOT = File.expand_path('..', __dir__)
 
-# Exit if any subcommand fails
-set -e
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
 
-# Set up Ruby dependencies via Bundler
-gem install bundler --conservative
-bundle check || bundle install
+chdir APP_ROOT do
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
-# Set up database and add any development seed data
-bin/rails dev:prime
+  system('bin/yarn')
 
-if [ ! -d .git/safe ] && echo $PATH | grep .git/safe > /dev/null; then
-  echo "-----------------------------------------------------------------------"
-  echo
-  echo "-> When you trust this repo, remember to run: mkdir -p .git/safe"
-  echo
-fi
+  puts "\n== Copying sample files =="
+  unless File.exist?('.env.local')
+    cp '.env', '.env.local'
+  end
 
-# Only if this isn't CI
-# if [ -z "$CI" ]; then
-# fi
+  puts "\n== Preparing database and seeds =="
+  system! 'bin/rake dev:prime'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+
+  puts "\n== Activating overcommit =="
+  system! 'bin/overcommit --install'
+end

data/templates/chromedriver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "selenium/webdriver"
+require 'selenium/webdriver'
 
 Capybara.register_driver :chrome do |app|
   Capybara::Selenium::Driver.new(app, browser: :chrome)
@@ -8,12 +8,14 @@ end
 
 Capybara.register_driver :headless_chrome do |app|
   capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
-    chromeOptions: { args: %w(headless disable-gpu) },
+    chromeOptions: { args: %w[headless disable-gpu] }
   )
 
-  Capybara::Selenium::Driver.new app,
+  Capybara::Selenium::Driver.new(
+    app,
     browser: :chrome,
     desired_capabilities: capabilities
+  )
 end
 
 Capybara.javascript_driver = :headless_chrome

data/templates/factory_bot.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'database_cleaner'
+
+namespace :factory_bot do
+  desc 'Verify that all FactoryBot factories are valid'
+  task lint: :environment do
+    if Rails.env.test?
+      sh 'bundle exec rails db:migrate'
+      DatabaseCleaner.clean_with :truncation
+      DatabaseCleaner.strategy = :transaction
+      DatabaseCleaner.cleaning do
+        FactoryBot.lint(traits: true)
+      end
+    else
+      system('bundle exec rake factory_bot:lint RAILS_ENV=test')
+      raise if $CHILD_STATUS.exitstatus.nonzero?
+    end
+  end
+end

data/templates/overcommit.yml

@@ -0,0 +1,14 @@
+gemfile: 'Gemfile'
+
+verify_signatures: false # (default: true)
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+    command: ['bundle', 'exec', 'rubocop'] # Invoke within Bundler context
+
+  SlimLint:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+    command: ['bundle', 'exec', 'slim-lint'] # Invoke within Bundler context

data/templates/rails_helper.rb

@@ -2,7 +2,9 @@
 
 ENV['RACK_ENV'] = 'test'
 
-require File.expand_path('../../config/environment', __FILE__)
+require File.expand_path('../config/environment', __dir__)
+
+
 abort('DATABASE_URL environment variable is set') if ENV['DATABASE_URL']
 
 require 'rspec/rails'
@@ -26,4 +28,3 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace('gem name')
 end
-

data/templates/rakefile_template.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks
+task(:default).clear
+
+desc 'Run linters, quality, security and tests'
+task :default do
+  sh 'bundle exec rubocop'
+  sh 'bundle exec rubycritic app/ config/ lib/ --no-browser --minimum-score 94 --format console'
+  sh 'bundle exec bundle-audit check --update'
+  sh 'bundle exec brakeman -z'
+  sh 'bundle exec rails db:migrate RAILS_ENV=test'
+  sh 'bundle exec rake factory_bot:lint RAILS_ENV=test'
+  sh 'bundle exec rspec spec/'
+end

data/templates/reek

@@ -0,0 +1,7 @@
+---
+IrresponsibleModule:
+  enabled: false
+
+UtilityFunction:
+  exclude:
+    - 'QueriesHelper'

data/templates/rubocop.yml

@@ -25,3 +25,6 @@ Metrics/LineLength:
 
 Rails:
   Enabled: true
+
+Style/Documentation:
+  Enabled: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: welaika-suspenders
 version: !ruby/object:Gem::Version
-  version: 2.29.0.alpha.1
+  version: 2.29.0.alpha.2
 platform: ruby
 authors:
 - thoughtbot
@@ -117,9 +117,7 @@ files:
 - templates/bin_deploy
 - templates/bin_setup
 - templates/bin_setup_review_app.erb
-- templates/brakeman.rake
 - templates/browserslist
-- templates/bundler_audit.rake
 - templates/capybara_helpers.rb
 - templates/chromedriver.rb
 - templates/config_locales_it.yml.erb
@@ -128,23 +126,25 @@ files:
 - templates/dotfiles/.env
 - templates/email.rb
 - templates/errors.rb
+- templates/factory_bot.rake
 - templates/factory_bot_rspec.rb
 - templates/faker_rspec.rb
 - templates/flashes_helper.rb
 - templates/i18n.rb
 - templates/json_encoding.rb
+- templates/overcommit.yml
 - templates/postgresql_database.yml.erb
 - templates/puma.rb
 - templates/queries_helper_rspec.rb
 - templates/rack_mini_profiler.rb
 - templates/rails_helper.rb
-- templates/rubocop.rake
+- templates/rakefile_template.rb
+- templates/reek
 - templates/rubocop.yml
 - templates/rubocop_todo.yml
 - templates/secrets.yml
 - templates/sentry.rb
 - templates/shoulda_matchers_config_rspec.rb
-- templates/slim-lint.rake
 - templates/slim-lint.yml
 - templates/slim.rb
 - templates/smtp.rb

data/templates/brakeman.rake

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.env.development? || Rails.env.test?
-  namespace :brakeman do
-    desc 'Run Brakeman'
-    task :run, :output_files do |_t, args|
-      require 'brakeman'
-
-      files = args[:output_files].split(' ') if args[:output_files]
-      Brakeman.run app_path: '.', output_files: files, print_report: true
-    end
-
-    desc 'Check your code with Brakeman'
-    task :check do
-      require 'brakeman'
-      result = Brakeman.run app_path: '.', print_report: true
-      exit Brakeman::Warnings_Found_Exit_Code unless result.filtered_warnings.empty?
-    end
-  end
-end

data/templates/bundler_audit.rake

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.env.development? || Rails.env.test?
-  require 'bundler/audit/task'
-  Bundler::Audit::Task.new
-end

data/templates/rubocop.rake

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.env.development? || Rails.env.test?
-  require 'rubocop/rake_task'
-
-  RuboCop::RakeTask.new
-end

data/templates/slim-lint.rake

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-if Rails.env.development? || Rails.env.test?
-  require 'slim_lint/rake_task'
-  SlimLint::RakeTask.new do |t|
-    t.files = ['app/views']
-  end
-end