nextgen 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6db9fb7cd60bea395ad5018e18a905246e877a34bc6f8742194e7302035b5ad
-  data.tar.gz: f3538f1ec8b8bd8280caa19f0410a04c43376343de6b2d5870ff01f7ea17eb17
+  metadata.gz: c12df02c71f082201cf7bf8c9e24c4f3d2d1c30a9969a70cf91b5597375b0648
+  data.tar.gz: cd01af3eebf2075ef05b9d1bc5c1dc4856acc101589f87bb0c5d8d59126553d4
 SHA512:
-  metadata.gz: 7ebb05f8e034cbd54cc88cafebb45da4dd6d0f165a2495c108441ad4816d7ad417bbf8be86389a32cad148bcc7fbe2b997f6c655c5df6bc95f6ea26b60576adb
-  data.tar.gz: 4ac4898307cb50f20650dcf45d4090a1c3af2c32cd316e0e0a24187db074919e92baf8bb81cefa4a1f50813641e680c12e09acbfcdbc826f401355721c9ba1ef
+  metadata.gz: 630e92302ffd0d5f87b3e37c9d64fb4f4f6fa7a67ce45b585e1398bab30566097e3f092e54b922db3f8a68ba83c8b0d661fbde48c8f636baff3f908af4de724c
+  data.tar.gz: 760e9b02cc4b8bb948a2e6d707af9bfdfd212658699e80578249ca7ca02ec1763f5baebc2583d8e44c7b054d718a458536acce757414334224090df31361ef26

data/README.md

@@ -28,7 +28,7 @@ Nextgen is an **interactive** and flexible alternative to `rails new` that inclu
 
 Nextgen generates apps using **Rails 7.1**.
 
-- **Ruby 3.0+** is required
+- **Ruby 3.1+** is required
 - **Rubygems 3.4.8+** is required (run `gem update --system` to get it)
 - **Node 18.12+ and Yarn** are required if you choose Vite or other Node-based options
 - Additional tools may be required depending on the options you select (e.g. PostgreSQL)

data/config/generators.yml

@@ -119,6 +119,10 @@ sidekiq:
   description: "Install sidekiq gem to use in production"
   requires: active_job
 
+staging:
+  prompt: "Staging environment"
+  description: "Define a staging environment"
+
 stylelint:
   prompt: "Stylelint"
   description: "Install stylelint and apply prettier format to CSS"

data/lib/nextgen/actions/bundler.rb

@@ -13,7 +13,7 @@ module Nextgen
           false
         else
           say_status :gemfile, [name, version].compact.join(", ")
-          gemfile.add(name, version: version, group: group, require: require)
+          gemfile.add(name, version:, group:, require:)
           true
         end
       end
@@ -44,7 +44,7 @@ module Nextgen
 
       Bundler.with_original_env do
         say_status :bundle, cmd, :green if verbose
-        run! full_command, env: {"BUNDLE_IGNORE_MESSAGES" => "1"}, verbose: false, capture: capture
+        run! full_command, env: {"BUNDLE_IGNORE_MESSAGES" => "1"}, verbose: false, capture:
       end
     end
 
@@ -55,6 +55,10 @@ module Nextgen
       false
     end
 
+    def bundler_ruby_file_supported?
+      bundler_version_satisifed?(">= 2.4.20")
+    end
+
     def noisy_bundler_version?
       bundler_version_satisifed?("< 2.4.17")
     end

data/lib/nextgen/actions/yarn.rb

@@ -7,7 +7,7 @@ module Nextgen
     alias add_yarn_package add_yarn_packages
 
     def remove_yarn_packages(*packages, capture: false)
-      yarn_command "remove #{packages.map(&:shellescape).join(" ")}", capture: capture
+      yarn_command "remove #{packages.map(&:shellescape).join(" ")}", capture:
     end
     alias remove_yarn_package remove_yarn_packages
 

data/lib/nextgen/actions.rb

@@ -22,7 +22,7 @@ module Nextgen
         result, status = Open3.capture2e(env, cmd)
         success = status.success?
       else
-        result = success = run(cmd, env: env, verbose: verbose)
+        result = success = run(cmd, env:, verbose:)
       end
 
       return result if success
@@ -82,9 +82,9 @@ module Nextgen
 
     def document_deploy_var(var_name, desc = nil, required: false, default: nil)
       insertion = "`#{var_name}`"
+      insertion << " **REQUIRED**" if required
       insertion << " - #{desc}" if desc.present?
       insertion << " (default: #{default})" unless default.nil?
-      insertion.prepend "**REQUIRED** " if required
 
       copy_file "DEPLOYMENT.md" unless File.exist?("DEPLOYMENT.md")
       inject_into_file "DEPLOYMENT.md", "#{insertion}\n- ", after: /^## Environment variables.*?^- /m

data/lib/nextgen/commands/create.rb

@@ -26,9 +26,9 @@ module Nextgen
       say <<~BANNER
         Welcome to nextgen, the interactive Rails app generator!
 
-        You are about to create a Rails app named "#{app_name}" in the following directory:
+        You are about to create a Rails app named "#{cyan(app_name)}" in the following directory:
 
-          #{app_path}
+          #{cyan(app_path)}
 
         You'll be asked ~10 questions about database, test framework, and other options.
         The standard Rails "omakase" experience will be selected by default.
@@ -83,10 +83,10 @@ module Nextgen
       say <<~DONE.gsub(/^/, "  ")
 
 
-        #{set_color("Done!", :green)}
+        #{green("Done!")}
 
-        A Rails #{rails_version} app was generated in #{set_color(app_path, :cyan)}.
-        Run #{set_color("bin/setup", :yellow)} in that directory to get started.
+        A Rails #{rails_version} app was generated in #{cyan(app_path)}.
+        Run #{yellow("bin/setup")} in that directory to get started.
 
 
       DONE
@@ -96,7 +96,7 @@ module Nextgen
 
     attr_accessor :app_path, :app_name, :rails_opts, :generators
 
-    def_delegators :shell, :say, :set_color
+    def_delegators :shell, :say
 
     def continue_if(question)
       if prompt.yes?(question)
@@ -141,12 +141,12 @@ module Nextgen
         "None (disable Active Record)" => nil
       )
       rails_opts.database =
-        prompt.select("Which database?", common_databases.merge("More options..." => false)) ||
-        prompt.select("Which database?", all_databases)
+        prompt_select("Which database?", common_databases.merge("More options..." => false)) ||
+        prompt_select("Which database?", all_databases)
     end
 
     def ask_full_stack_or_api
-      api = prompt.select(
+      api = prompt_select(
         "What style of Rails app do you need?",
         "Standard, full-stack Rails (default)" => false,
         "API only" => true
@@ -155,12 +155,13 @@ module Nextgen
     end
 
     def ask_frontend_management
-      frontend = prompt.select(
+      frontend = prompt_select(
         "How will you manage frontend assets?",
         "Sprockets (default)" => "sprockets",
         "Propshaft" => "propshaft",
         "Vite" => :vite
       )
+
       if frontend == :vite
         rails_opts.asset_pipeline = nil
         rails_opts.javascript = "vite"
@@ -170,7 +171,7 @@ module Nextgen
     end
 
     def ask_css
-      rails_opts.css = prompt.select(
+      rails_opts.css = prompt_select(
         "Which CSS framework will you use with the asset pipeline?",
         "None (default)" => nil,
         "Bootstrap" => "bootstrap",
@@ -182,7 +183,7 @@ module Nextgen
     end
 
     def ask_javascript
-      rails_opts.javascript = prompt.select(
+      rails_opts.javascript = prompt_select(
         "Which JavaScript bundler will you use with the asset pipeline?",
         "Importmap (default)" => "importmap",
         "Bun" => "bun",
@@ -223,7 +224,7 @@ module Nextgen
     end
 
     def ask_test_framework
-      rails_opts.test_framework = prompt.select(
+      rails_opts.test_framework = prompt_select(
         "Which test framework will you use?",
         "Minitest (default)" => "minitest",
         "RSpec" => "rspec",
@@ -232,7 +233,7 @@ module Nextgen
     end
 
     def ask_system_testing
-      system_testing = prompt.select(
+      system_testing = prompt_select(
         "Include system testing (capybara)?",
         "Yes (default)" => true,
         "No" => false
@@ -241,7 +242,7 @@ module Nextgen
     end
 
     def ask_optional_enhancements
-      @generators = Generators.compatible_with(rails_opts: rails_opts)
+      @generators = Generators.compatible_with(rails_opts:)
 
       answers = prompt.multi_select(
         "Which optional enhancements would you like to add?",
@@ -309,5 +310,10 @@ module Nextgen
     def shell
       @shell ||= Thor::Base.shell.new
     end
+
+    def cyan(string) = shell.set_color(string, :cyan)
+    def green(string) = shell.set_color(string, :green)
+    def yellow(string) = shell.set_color(string, :yellow)
+    def prompt_select(question, choices) = prompt.select(question, choices, cycle: true)
   end
 end

data/lib/nextgen/generators/base.rb

@@ -33,7 +33,11 @@ end
 
 if File.exist?(".ruby-version") && File.read(".ruby-version").match?(/\A\d+\.\d+.\d+.\s*\z/m)
   say_git "DRY up Gemfile and .ruby-version file"
-  replacement = 'ruby Pathname.new(__dir__).join(".ruby-version").read.strip'
+  replacement = if bundler_ruby_file_supported?
+                  'ruby file: ".ruby-version"'
+                else
+                  'ruby Pathname.new(__dir__).join(".ruby-version").read.strip'
+                end
   gsub_file "Gemfile", /^ruby "\d.*"$/, replacement
 end
 

data/lib/nextgen/generators/eslint.rb

@@ -1,7 +1,9 @@
 say_git "Install eslint"
 add_yarn_packages(
-  "eslint",
+  "@eslint/js",
+  "eslint@^9",
   "eslint-config-prettier",
+  "eslint-formatter-compact",
   "eslint-plugin-prettier",
   "prettier",
   "npm-run-all",
@@ -14,7 +16,7 @@ add_package_json_scripts(
   lint: "npm-run-all lint:**",
   fix: "npm-run-all fix:**"
 )
-copy_file ".eslintrc.cjs"
+copy_file "eslint.config.js"
 
 say_git "Add eslint to default rake task"
 copy_file "lib/tasks/eslint.rake"

data/lib/nextgen/generators/staging.rb

@@ -0,0 +1,12 @@
+copy_file "config/environments/staging.rb"
+gsub_file "DEPLOYMENT.md", '"production"', '"production" or "staging"' if File.exist?("DEPLOYMENT.md")
+
+%w[config/cable.yml config/database.yml].each do |file|
+  next unless File.exist?(file)
+
+  config_yml = File.read(file)
+  config_yml.sub!(/^production:\n(  .*\n)+/) do |match|
+    match + "\n" + match.gsub("production", "staging")
+  end
+  File.write(file, config_yml)
+end

data/lib/nextgen/generators/vite.rb

@@ -46,9 +46,13 @@ say_git "Install autoprefixer"
 add_yarn_packages "postcss@^8.4.24", "autoprefixer@^10.4.14"
 copy_file "postcss.config.cjs"
 
-say_git "Disable autoBuild in test environment"
-gsub_file "config/vite.json", /("test": \{.+?"autoBuild":\s*)true/m, '\1false'
-copy_test_support_file "vite.rb"
+# TODO: rspec support
+if File.exist?("test/application_system_test_case.rb")
+  say_git "Disable autoBuild in test environment"
+  gsub_file "config/vite.json", /("test": \{.+?"autoBuild":\s*)true/m, '\1false'
+  copy_file "test/vite_helper.rb"
+  inject_into_file "test/application_system_test_case.rb", "\nrequire \"vite_helper\"", after: /require "test_helper"$/
+end
 
 say_git "Install modern-normalize and base stylesheets"
 add_yarn_package "modern-normalize@^2.0.0"
@@ -84,11 +88,11 @@ end
 copy_file "app/helpers/inline_svg_helper.rb"
 copy_file "app/frontend/images/example.svg"
 # TODO: rspec support
-copy_file "test/helpers/inline_svg_helper_test.rb" if minitest?
+copy_file "test/helpers/inline_svg_helper_test.rb" if File.exist?("test/vite_helper.rb")
 
 say_git "Add a `yarn start` script"
 start = "concurrently -i -k --kill-others-on-fail -p none 'RUBY_DEBUG_OPEN=true bin/rails s' 'bin/vite dev'"
-add_package_json_script start: start
+add_package_json_script(start:)
 add_yarn_package "concurrently", dev: true
 gsub_file "README.md", %r{bin/rails s(erver)?}, "yarn start"
 gsub_file "bin/setup", %r{bin/rails s(erver)?}, "yarn start"

data/lib/nextgen/generators.rb

@@ -40,7 +40,7 @@ module Nextgen
       name = name.to_sym
       raise ArgumentError, "Generator #{name.inspect} was already added" if generators.key?(name)
 
-      generators[name] = {node: node, prompt: prompt, description: description}
+      generators[name] = {node:, prompt:, description:}
       activate(name) unless prompt
     end
 

data/lib/nextgen/rails.rb

@@ -29,10 +29,10 @@ module Nextgen
         Thor::Base.shell.new.say_status(...)
       end
 
-      def with_original_bundler_env(&block)
+      def with_original_bundler_env(&)
         return yield unless defined?(Bundler)
 
-        Bundler.with_original_env(&block)
+        Bundler.with_original_env(&)
       end
     end
   end

data/lib/nextgen/thor_extensions.rb

@@ -23,7 +23,7 @@ module Nextgen
 
       if given_args.first == "help"
         retry_with_args = ["help"] if given_args.length > 1
-      elsif (e.unknown & %w[-h --help]).any?
+      elsif e.unknown.intersect?(%w[-h --help])
         retry_with_args = ["help", (given_args - e.unknown).first]
       end
       raise unless retry_with_args.any?

data/lib/nextgen/tidy_gemfile.rb

@@ -27,7 +27,7 @@ module Nextgen
     def add(gem, version: nil, group: nil, require: nil)
       return false if include?(gem)
 
-      gem_line = build_gem_line(gem, version: version, require: require, indent: group ? "  " : "")
+      gem_line = build_gem_line(gem, version:, require:, indent: group ? "  " : "")
 
       if group
         group_line = create_group_if_needed(group)

data/lib/nextgen/version.rb

@@ -1,3 +1,3 @@
 module Nextgen
-  VERSION = "0.12.0".freeze
+  VERSION = "0.14.0".freeze
 end

data/template/.github/workflows/ci.yml.tt

@@ -73,7 +73,7 @@ jobs:
           bundler-cache: true
       - run: bin/erblint --lint-all
 <% end -%>
-<% if Dir[".eslintrc*"].any? -%>
+<% if Dir["eslint.config.*"].any? -%>
   eslint:
     name: "Lint / eslint"
     runs-on: ubuntu-latest

data/template/.overcommit.yml.tt

@@ -13,7 +13,7 @@ PreCommit:
     include: "**/*.html.erb"
 <% end -%>
 
-<% if File.exist?(".eslintrc.cjs") -%>
+<% if File.exist?("eslint.config.js") -%>
   EsLint:
     enabled: true
     required_executable: npx

data/template/DEPLOYMENT.md

@@ -5,6 +5,7 @@
 These environment variables affect how the app functions when deployed in production.
 
 - `RAILS_DISABLE_SSL` - Disable HSTS and secure cookies
+- `RAILS_ENV` **REQUIRED** - "production"
 - `RAILS_MAX_THREADS` - Number of threads per Puma process (default: 5)
-- **REQUIRED** `SECRET_KEY_BASE` - Unique, secret key used to encrypt and sign cookies and other sensitive data
+- `SECRET_KEY_BASE` **REQUIRED** - Unique, secret key used to encrypt and sign cookies and other sensitive data
 - `WEB_CONCURRENCY` - Number of Puma processes (default: number of CPUs)

data/template/bin/setup

@@ -27,7 +27,7 @@ def run(command, echo: true, silent: false, exception: true)
   say_status(:run, command, :blue) if echo
   with_original_bundler_env do
     options = silent ? {out: File::NULL, err: File::NULL} : {}
-    system(command, exception: exception, **options)
+    system(command, exception:, **options)
   end
 end
 
@@ -59,10 +59,10 @@ def git_safe_needed?
   ENV["PATH"].include?(".git/safe/../../bin") && !Dir.exist?(".git/safe")
 end
 
-def with_original_bundler_env(&block)
+def with_original_bundler_env(&)
   return yield unless defined?(Bundler)
 
-  Bundler.with_original_env(&block)
+  Bundler.with_original_env(&)
 end
 
 def env(env_file, from:)

data/template/config/environments/staging.rb

@@ -0,0 +1,2 @@
+# The staging environment is based on production
+require_relative "production"

data/template/eslint.config.js

@@ -0,0 +1,32 @@
+/** @type {import("@types/eslint").Linter.Config */
+
+import globals from "globals";
+import js from "@eslint/js";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export default [
+  js.configs.recommended,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: "module",
+      globals: {
+        ...globals.browser,
+        ...globals.es2021,
+      },
+    },
+    rules: {
+      "no-unused-vars": [
+        "error",
+        {
+          args: "after-used",
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+        },
+      ],
+      "no-var": "error",
+      "prettier/prettier": "error",
+    },
+  },
+];

data/template/test/helpers/inline_svg_helper_test.rb

@@ -1,4 +1,5 @@
 require "test_helper"
+require "vite_helper"
 
 class InlineSvgHelperTest < ActionView::TestCase
   test "inline_svg_tag returns contents of svg file as html_safe string" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nextgen
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -133,6 +133,7 @@ files:
 - lib/nextgen/generators/rubocop.rb
 - lib/nextgen/generators/shoulda.rb
 - lib/nextgen/generators/sidekiq.rb
+- lib/nextgen/generators/staging.rb
 - lib/nextgen/generators/stylelint.rb
 - lib/nextgen/generators/thor.rb
 - lib/nextgen/generators/tomo.rb
@@ -146,7 +147,6 @@ files:
 - template/.editorconfig
 - template/.env.sample
 - template/.erb-lint.yml.tt
-- template/.eslintrc.cjs
 - template/.github/PULL_REQUEST_TEMPLATE.md.tt
 - template/.github/dependabot.yml
 - template/.github/workflows/ci.yml.tt
@@ -168,10 +168,12 @@ files:
 - template/app/helpers/inline_svg_helper.rb
 - template/app/views/home/index.html.erb.tt
 - template/bin/setup
+- template/config/environments/staging.rb
 - template/config/initializers/generators.rb
 - template/config/initializers/rack_mini_profiler.rb
 - template/config/initializers/sidekiq.rb
 - template/config/sidekiq.yml
+- template/eslint.config.js
 - template/lib/puma/plugin/open.rb
 - template/lib/tasks/auto_annotate_models.rake
 - template/lib/tasks/erblint.rake
@@ -194,8 +196,8 @@ files:
 - template/test/support/mailer.rb
 - template/test/support/shoulda.rb
 - template/test/support/vcr.rb.tt
-- template/test/support/vite.rb
 - template/test/support/webmock.rb
+- template/test/vite_helper.rb
 homepage: https://github.com/mattbrictson/nextgen
 licenses:
 - MIT
@@ -213,14 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Generate your next Rails app interactively!

data/template/.eslintrc.cjs

@@ -1,26 +0,0 @@
-/** @type {import("@types/eslint").Linter.Config */
-
-module.exports = {
-  env: {
-    browser: true,
-    es2021: true,
-  },
-  parserOptions: {
-    ecmaVersion: 2022,
-    sourceType: "module",
-  },
-  plugins: ["prettier"],
-  rules: {
-    "no-unused-vars": [
-      "error",
-      {
-        args: "after-used",
-        argsIgnorePattern: "^_",
-        varsIgnorePattern: "^_",
-      },
-    ],
-    "no-var": "error",
-    "prettier/prettier": "error",
-  },
-  extends: ["eslint:recommended", "prettier"],
-};