gnarails 3.0.0 → 3.0.1

data/gnarly.rb

@@ -2,7 +2,7 @@
 # to look up files
 def source_paths
   Array(super) +
-    [File.expand_path(File.dirname(__FILE__))]
+    [__dir__]
 end
 
 def create_gnarly_rails_app
@@ -16,14 +16,17 @@ def create_gnarly_rails_app
 
   add_gems
 
-  run "bundle install"
+  run_bundle
 
   after_bundle do
     setup_testing
+    setup_binstubs
     setup_database
-    setup_scss
+    setup_assets
     setup_gitignore
-    setup_analysis
+    setup_linting
+    setup_pronto
+    setup_simplecov
     setup_environments
     setup_readme
     remove_dir "test"
@@ -35,28 +38,24 @@ end
 
 def add_gems
   gem_group :development, :test do
-    gem 'axe-matchers'
-    gem 'bullet'
-    gem 'bundler-audit'
-    gem 'capybara'
-    gem 'dotenv-rails'
-    gem 'factory_bot_rails'
-    gem 'gnar-style', require: false
-    gem 'launchy'
-    gem 'lol_dba'
-    gem 'okcomputer'
-    gem 'pronto'
-    gem 'pronto-brakeman', require: false
-    gem 'pronto-rubocop', require: false
-    gem 'pronto-scss', require: false
-    gem 'pry-byebug'
-    gem 'pry-rails'
-    gem 'rspec-its'
-    gem 'rspec-rails', '~> 3.7'
-    gem 'scss_lint', require: false
-    gem 'selenium-webdriver'
-    gem 'shoulda-matchers'
-    gem 'simplecov', require: false
+    gem "axe-core-capybara"
+    gem "axe-core-rspec"
+    gem "bullet"
+    gem "dotenv-rails"
+    gem "factory_bot_rails"
+    gem "gnar-style", require: false
+    gem "launchy"
+    gem "lol_dba"
+    gem "okcomputer"
+    gem "pronto"
+    gem "pronto-rubocop", require: false
+    gem "pry-byebug"
+    gem "pry-rails"
+    gem "rspec-its"
+    gem "rspec-rails", "~> 4"
+    gem "rubocop-rspec", require: false
+    gem "shoulda-matchers"
+    gem "simplecov", require: false
   end
 end
 
@@ -64,17 +63,26 @@ def setup_database
   remove_file "config/database.yml"
   copy_file "templates/database.yml", "config/database.yml"
   gsub_file "config/database.yml", "__application_name__", app_name
-
   gsub_file "Gemfile", /.*sqlite.*\n/, ""
 end
 
-def setup_scss
-  run "mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss"
+def setup_assets
+  run "yarn add esbuild-rails"
+  remove_file "esbuild.config.js"
+  copy_file "templates/esbuild.config.js", "esbuild.config.js"
+  run "npm set-script build 'node esbuild.config.js'"
 end
 
 def setup_gitignore
-  remove_file ".gitignore"
-  copy_file "templates/.gitignore", ".gitignore"
+  append_to_file ".gitignore" do
+    <<~GITIGNORE
+      # Ignore Byebug command history file.
+      .byebug_history
+
+      # Ignore output of simplecov
+      coverage
+    GITIGNORE
+  end
 end
 
 def setup_testing
@@ -115,7 +123,8 @@ end
 def system_tests_rails_helper_text
   <<~SYSTEM_TESTS
     require "capybara/rails"
-    require "axe/rspec"
+    require "axe-rspec"
+    require "axe-capybara"
     require "selenium/webdriver"
   SYSTEM_TESTS
 end
@@ -188,27 +197,29 @@ def limit_test_logging
   end
 end
 
-def setup_analysis
-  setup_linting
-  setup_pronto
-  setup_brakeman
-  setup_simplecov
+def setup_binstubs
+  remove_file "bin/setup"
+  copy_file "templates/bin/setup", "bin/setup"
+  run "chmod +x bin/setup"
+
+  copy_file "templates/bin/rspec", "bin/rspec"
+  run "chmod +x bin/rspec"
+
+  copy_file "templates/bin/rubocop", "bin/rubocop"
+  run "chmod +x bin/rubocop"
 end
 
 def setup_linting
   copy_file "templates/.rubocop.yml", ".rubocop.yml"
-  copy_file "templates/.scss-lint.yml", ".scss-lint.yml"
 end
 
 def setup_pronto
   copy_file "templates/.pronto.yml", ".pronto.yml"
-  copy_file "templates/bin/ci_pronto", "bin/ci_pronto"
-  run "chmod +x bin/ci_pronto"
-end
 
-def setup_brakeman
-  copy_file "templates/bin/brakeman", "bin/brakeman"
-  run "chmod +x bin/brakeman"
+  copy_file "templates/bin/pronto", "bin/pronto"
+  run "chmod +x bin/pronto"
+
+  copy_file ".github/workflows/pronto.yml", ".github/workflows/pronto.yml"
 end
 
 def setup_simplecov
@@ -230,7 +241,7 @@ end
 
 def setup_environments
   setup_dotenv
-  setup_ci
+  setup_github_workflows
   setup_docker
   setup_procfile
   configure_i18n
@@ -243,10 +254,12 @@ def setup_dotenv
   gsub_file ".env.test", "__application_name__", app_name
 end
 
-def setup_ci
-  copy_file "templates/.circleci/config.yml", ".circleci/config.yml"
-  gsub_file ".circleci/config.yml", "__ruby_version__", RUBY_VERSION
-  gsub_file ".circleci/config.yml", "__application_name__", app_name
+def setup_github_workflows
+  copy_file "templates/.github/workflows/run-tests.yml", ".github/workflows/run-tests.yml"
+  copy_file "templates/.github/workflows/brakeman.yml", ".github/workflows/brakeman.yml"
+
+  copy_file ".github/actions/test-rails/action.yml", ".github/actions/test-rails/action.yml"
+  copy_file ".github/workflows/bundler-audit.yml", ".github/workflows/bundler-audit.yml"
 end
 
 def setup_docker
@@ -305,16 +318,21 @@ def post_install_instructions
   puts "* Install ChromeDriver for default headless acceptance tests: brew cask install chromedriver"
   puts "* Follow the post-install instructions to set up circle to allow gnarbot to comment on PRs."
   puts "  * https://github.com/TheGnarCo/gnarails#post-install"
+  puts "=========="
+  puts "* Make sure your package.json has the following scripts:"
+  puts "* \`\"build\": \"node esbuild.config.js\"\`"
+  puts "* \`\"build:css\": \"sass ./app/assets/stylesheets/application.sass.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules\"\`"
 end
 
 def format_ruby
-  run "bundle exec rubocop --auto-correct"
+  run "bin/rubocop -A"
 end
 
 def completion_notification
   puts ""
   ascii_art
   post_install_instructions
+  puts ""
 end
 
 create_gnarly_rails_app

data/lib/gnarails/cli/application.rb

@@ -7,180 +7,52 @@ module Gnarails
 
       add_runtime_options!
 
-      WEBPACKS = %w[react vue angular elm stimulus].freeze
-
-      method_option :ruby,
-        type: :string,
-        aliases: "-r",
-        default: Thor::Util.ruby_command,
-        desc: "Path to the Ruby binary of your choice", banner: "PATH"
-
-      method_option :skip_namespace,
-        type: :boolean,
-        default: false,
-        desc: "Skip namespace (affects only isolated applications)"
-
-      method_option :skip_yarn,
-        type: :boolean,
-        default: false,
-        desc: "Don't use Yarn for managing JavaScript dependencies"
-
-      method_option :skip_gemfile,
-        type: :boolean,
-        default: false,
-        desc: "Don't create a Gemfile"
-
-      method_option :skip_git,
-        type: :boolean,
-        aliases: "-G",
-        default: false,
-        desc: "Skip .gitignore file"
-
-      method_option :skip_keeps,
-        type: :boolean,
-        default: false,
-        desc: "Skip source control .keep files"
-
-      method_option :skip_action_mailer,
-        type: :boolean,
-        aliases: "-M",
-        default: false,
-        desc: "Skip Action Mailer files"
-
-      method_option :skip_active_record,
-        type: :boolean,
-        aliases: "-O",
-        default: false,
-        desc: "Skip Active Record files"
-
-      method_option :skip_active_storage,
-        type: :boolean,
-        default: false,
-        desc: "Skip Active Storage files"
-
-      method_option :skip_puma,
-        type: :boolean,
-        aliases: "-P",
-        default: false,
-        desc: "Skip Puma related files"
-
-      method_option :skip_action_cable,
-        type: :boolean,
-        aliases: "-C",
-        default: false,
-        desc: "Skip Action Cable files"
-
-      method_option :skip_sprockets,
-        type: :boolean,
-        aliases: "-S",
-        default: false,
-        desc: "Skip Sprockets files"
-
-      method_option :skip_spring,
-        type: :boolean,
-        default: false,
-        desc: "Don't install Spring application preloader"
-
-      method_option :skip_listen,
-        type: :boolean,
-        default: false,
-        desc: "Don't generate configuration that depends on the listen gem"
-
-      method_option :skip_coffee,
-        type: :boolean,
-        default: false,
-        desc: "Don't use CoffeeScript"
-
-      method_option :skip_javascript,
-        type: :boolean,
-        aliases: "-J",
-        default: false,
-        desc: "Skip JavaScript files"
-
-      method_option :skip_turbolinks,
-        type: :boolean,
-        default: false,
-        desc: "Skip turbolinks gem"
-
-      method_option :skip_test,
-        type: :boolean,
-        aliases: "-T",
-        default: false,
-        desc: "Skip test files"
-
-      method_option :skip_system_test,
-        type: :boolean,
-        default: false,
-        desc: "Skip system test files"
-
-      method_option :skip_bootsnap,
-        type: :boolean,
-        default: false,
-        desc: "Skip bootsnap gem"
-
-      method_option :dev,
-        type: :boolean,
-        default: false,
-        desc: "Setup the application with Gemfile pointing to your Rails checkout"
-
-      method_option :edge,
-        type: :boolean,
-        default: false,
-        desc: "Setup the application with Gemfile pointing to Rails repository"
-
-      method_option :rc,
-        type: :string,
-        default: nil,
-        desc: "Path to file containing extra configuration options for rails command"
-
-      method_option :no_rc,
-        type: :boolean,
-        default: false,
-        desc: "Skip loading of extra configuration options from .railsrc file"
-
-      method_option :api,
-        type: :boolean,
-        desc: "Preconfigure smaller stack for API only apps"
-
-      method_option :skip_bundle,
-        type: :boolean,
-        aliases: "-B",
-        default: false,
-        desc: "Don't run bundle install"
-
-      method_option :webpack,
-        type: :string,
-        default: nil,
-        desc: "Preconfigure for app-like JavaScript with Webpack (options: #{WEBPACKS.join('/')})"
-
       desc "new APP_PATH [options]", "generate a gnarly rails app"
       long_desc <<-LONGDESC
         `gnarails new NAME` will create a new rails application called NAME,
         pre-built with the same helpful default configuration you can expect from
         any rails project built by The Gnar Company.
 
-        By default, we pass arguments to `rails new` that skip test unit
-        generation and use postgres instead of sqlite as the default database.
+        By default, we pass arguments to `rails new` that:
+        - skip test unit (We'll install rspec later)
+        - use postgres over SQLlite,
+        - use Propshaft,
+        - Bundle CSS with cssbundling (using sass)
+        - bundle JS with esbuild
 
         You should also be able to pass any other arguments you would expect to
-        be able to when generating a new rails app.
+        be able to when generating a new rails app. Use `rails -h` for more
+        information.
       LONGDESC
       def new(name)
-        Kernel.system "rails new #{name} #{cli_options(options)}"
+        Kernel.system command(name, options)
       end
 
+      DEFAULT_OPTIONS = [
+        "--asset-pipeline=propshaft",
+        "--skip-test-unit",
+        "--css=sass",
+        "--javascript=esbuild",
+        "--database=postgresql",
+      ].freeze
+
       no_tasks do
+        def command(name, options)
+          "rails new #{name} #{cli_options(options)}"
+        end
+
         def cli_options(options)
-          options_string = "-m #{Gnarails.template_file} --skip-test-unit --database=postgresql"
+          options_string = "-m #{Gnarails.template_file} " + DEFAULT_OPTIONS.join(" ")
           options.each_with_object(options_string) do |(k, v), str|
             str << cli_option(k, v)
           end
         end
 
         def cli_option(key, value)
-          if value == false
+          case value
+          when false
             ""
-          elsif value == true
+          when true
             " --#{key}"
           else
             " --#{key}=#{value}"

data/lib/gnarails/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gnarails
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/templates/.github/workflows/brakeman.yml

@@ -0,0 +1,22 @@
+name: Brakeman
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Brakeman
+      run: |
+        gem install brakeman --no-document
+        brakeman --exit-on-warn --separate-models -o tmp/brakeman.html -o tmp/brakeman.text .
+        brakeman_exit_code=$?
+        cat tmp/brakeman.text
+        exit $brakeman_exit_code

data/templates/.github/workflows/run-tests.yml

@@ -0,0 +1,26 @@
+name: Run Tests
+on: [push]
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    env:
+      RAILS_ENV: test
+      DATABASE_PASSWORD: password
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_PASSWORD: password
+        ports: ["5432:5432"]
+        options:
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Test
+        uses: ./.github/actions/test-rails

data/templates/README.md

@@ -4,10 +4,9 @@
 
  ```sh
 $ bundle install
-$ bundle exec rake db:create
-$ bundle exec rake db:migrate
-$ bundle exec rake db:seed
-$ bundle exec rails s
+$ yarn install
+$ bin/setup
+$ bin/dev
 $ open http://localhost:3000
 ```
 
@@ -64,7 +63,7 @@ $ docker-compose up
 
 To run rspec:
 ```sh
-$ docker-compose run web bundle exec rspec
+$ docker-compose run web ./bin/rspec
 ```
 
 ### Using pry with Docker

data/templates/bin/pronto

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'pronto' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pronto", "pronto")

data/templates/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/templates/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/templates/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  system! "yarn install --pure-lockfile"
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/templates/docker-compose.yml/docker-compose-standard.yml

@@ -4,7 +4,7 @@ services:
     image: postgres
   web:
     build: .
-    command: bash -c 'rm -f tmp/pids/server.pid && bundle exec rails s --port 3000 --binding 0.0.0.0'
+    command: bash -c 'rm -f tmp/pids/server.pid && bin/dev --binding 0.0.0.0'
     volumes:
       - .:/app
     ports:

data/templates/esbuild.config.js

@@ -0,0 +1,11 @@
+const path = require('path')
+const rails = require('esbuild-rails')
+
+require('esbuild').build({
+  entryPoints: ['application.js'],
+  bundle: true,
+  outdir: path.join(process.cwd(), 'app/assets/builds'),
+  absWorkingDir: path.join(process.cwd(), 'app/javascript'),
+  watch: process.argv.includes('--watch'),
+  plugins: [rails()],
+}).catch(() => process.exit(1))

data/test-app/app/views/layouts/application.html.erb

@@ -4,8 +4,8 @@
     <title>RailsTestApp</title>
     <%= csrf_meta_tags %>
 
-    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
-    <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_include_tag "application", defer: true %>
   </head>
 
   <body>

data/test-app/spec/system/viewing_all_job_postings_spec.rb

@@ -5,17 +5,17 @@ RSpec.feature "Viewing all job postings", type: :system do
     create_list :job_posting, 1
     visit job_postings_path
 
-    expect(page).to be_accessible
+    expect(page).to be_axe_clean
   end
 
   scenario "N+1 query proteection" do
     job_posting = create :job_posting
-    job_posting.comments.create(body: "first comment")
-    job_posting.comments.create(body: "second comment")
+    job_posting.comments.create!(body: "first comment")
+    job_posting.comments.create!(body: "second comment")
 
     another_posting = create :job_posting
-    another_posting.comments.create(body: "third comment")
-    another_posting.comments.create(body: "fourth comment")
+    another_posting.comments.create!(body: "third comment")
+    another_posting.comments.create!(body: "fourth comment")
 
     expect { visit job_postings_path }
       .to raise_error Bullet::Notification::UnoptimizedQueryError
@@ -25,10 +25,6 @@ RSpec.feature "Viewing all job postings", type: :system do
     posting = create :job_posting
     visit job_postings_path
 
-    expect(has_job_posting?(posting)).to be true
-  end
-
-  def has_job_posting?(posting)
     within(".job-posting-#{posting.id}") do
       expect(page).to have_css("td.posting-title", text: posting.title)
     end