nextgen 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab42df3afedd51d12bad9ba602f2cc8d6f1ab94af01305c6c7beac8ed6430f42
-  data.tar.gz: 3c1956f80e9780ce64813080ee27e377821f28fdecc8ab54d1a92610ef7ad9a7
+  metadata.gz: 5e8c4dd4b29b2e8afac9f923b72b56daf86a73e5bae75285b2af1b604ccc45c0
+  data.tar.gz: 8fafac6254aa48ccc290f303e02012d906de34e947f2c32e4f9245e8d34e76d9
 SHA512:
-  metadata.gz: 20a0a482b9c6abc27a2394573a70ebdf40f68222718afdf3a0605769af67c3718168da5a288520334219c4ebeb2ea9231e478ff4d55e9f157e8a9e771af71f64
-  data.tar.gz: 5a9d0e288814f314093cacf5919e683c531083baa16f511ef35d9ba6d18e1daf0134201dae8b98587a75adb3e923653cdf21e35e01aeff9851d0bab2aa4e5199
+  metadata.gz: 2ee5135257dfcb2096400b1ab15ce501108817606ee30b00bcfb42505106a49a3e0a8fe3fcbbe4543c3d5a01873dada585b3a40861788248b35f44bcf0cabe82
+  data.tar.gz: 0c9ed43018047dabb368c64190fe65136675a622c49735b1b8f156d21915cf977e3449ab57cf89c19ed67f14592a7ac82f4d5743e803f9cc73a081f9a71e634c

data/config/generators.yml

@@ -122,7 +122,9 @@ shoulda:
 sidekiq:
   prompt: "Sidekiq"
   description: "Install sidekiq gem to use in production"
-  requires: active_job
+  requires:
+    - active_job
+    - skip_solid
 
 staging:
   prompt: "Staging environment"
@@ -141,6 +143,7 @@ thor:
 tomo:
   prompt: "Tomo"
   description: "Install tomo gem for SSH-based deployment"
+  requires: skip_kamal
 
 vcr:
   prompt: "VCR"

data/config/rails_versions.yml

@@ -0,0 +1,57 @@
+current: &current
+  args: []
+  label: "%%CURRENT_VERSION%%"
+  asset_pipelines:
+    sprockets: Sprockets (default)
+    propshaft: Propshaft
+  databases:
+    sqlite3: SQLite3 (default)
+    postgresql: PostgreSQL (recommended)
+    mysql: MySQL
+    trilogy: Trilogy
+    oracle: Oracle
+    sqlserver: SQLServer
+    jdbcmysql: JDBCMySQL
+    jdbcsqlite3: JDBCSQLite3
+    jdbcpostgresql: JDBCPostgreSQL
+    jdbc: JDBC
+  default_features:
+    brakeman: Brakeman
+    ci: GitHub Actions CI
+    rubocop: RuboCop
+  optional_features:
+    devcontainer: devcontainer files
+
+edge:
+  <<: *current
+  args: ["--edge"]
+  label: "edge (7-2-stable)"
+
+main:
+  args: ["--main"]
+  label: "main (%%MAIN_VERSION%%)"
+  asset_pipelines:
+    propshaft: Propshaft (default)
+    sprockets: Sprockets
+  databases:
+    sqlite3: SQLite3 (default)
+    postgresql: PostgreSQL (recommended)
+    mysql: MySQL
+    trilogy: Trilogy
+    oracle: Oracle
+    sqlserver: SQLServer
+    jdbcmysql: JDBCMySQL
+    jdbcsqlite3: JDBCSQLite3
+    jdbcpostgresql: JDBCPostgreSQL
+    jdbc: JDBC
+    mariadb-mysql: MariaDB-MySQL
+    mariadb-trilogy: MariaDB-Trilogy
+  default_features:
+    brakeman: Brakeman
+    ci: GitHub Actions CI
+    kamal: Kamal
+    rubocop: RuboCop
+    solid: Solid Cache+Queue
+    thruster: Thruster
+  optional_features:
+    devcontainer: devcontainer files

data/lib/nextgen/commands/create.rb

@@ -21,7 +21,6 @@ module Nextgen
     def initialize(app_path, _options)
       @app_path = File.expand_path(app_path)
       @app_name = File.basename(@app_path).gsub(/\W/, "_").squeeze("_").camelize
-      @rails_opts = RailsOptions.new
     end
 
     def run # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
@@ -39,13 +38,15 @@ module Nextgen
 
       continue_if "Ready to start?"
 
-      ask_rails_version
+      rails_version = ask_rails_version
+      @rails_opts = RailsOptions.new(version: rails_version)
+
       ask_database
       ask_full_stack_or_api
       ask_frontend_management unless rails_opts.api?
       ask_css unless rails_opts.api? || rails_opts.skip_asset_pipeline?
       ask_javascript unless rails_opts.api? || rails_opts.skip_asset_pipeline?
-      ask_rails_tools
+      ask_rails_features
       ask_rails_frameworks
       ask_test_framework
       ask_system_testing if rails_opts.frontend? && rails_opts.test_framework?
@@ -78,9 +79,9 @@ module Nextgen
 
       create_initial_commit_message
       copy_package_json if node?
-      Nextgen::Rails.run "new", *rails_new_args
+      Nextgen::RailsCommand.run "new", *rails_new_args
       Dir.chdir(app_path) do
-        Nextgen::Rails.run "app:template", "LOCATION=#{write_generators_script}"
+        Nextgen::RailsCommand.run "app:template", "LOCATION=#{write_generators_script}"
       end
 
       say <<~DONE.gsub(/^/, "  ")
@@ -88,7 +89,7 @@ module Nextgen
 
         #{green("Done!")}
 
-        A Rails #{rails_version} app was generated in #{cyan(app_path)}.
+        A Rails #{rails_opts.version_label} app was generated in #{cyan(app_path)}.
         Run #{yellow("bin/setup")} in that directory to get started.
 
 
@@ -118,31 +119,17 @@ module Nextgen
       )
     end
 
-    def rails_version
-      rails_opts.edge? ? "edge (#{Rails.edge_branch} branch)" : Rails.version
-    end
-
     def ask_rails_version
-      selected = prompt.select(
-        "What version of Rails will you use?",
-        Rails.version => :current,
-        "edge (#{Rails.edge_branch} branch)" => :edge
-      )
-      rails_opts.edge! if selected == :edge
+      options = %i[current edge main].to_h do |key|
+        version = RailsVersion.public_send(key)
+        [version.label, version]
+      end
+      prompt.select("What version of Rails will you use?", options)
     end
 
     def ask_database
-      common_databases = {
-        "SQLite3 (default)" => "sqlite3",
-        "PostgreSQL (recommended)" => "postgresql",
-        "MySQL" => "mysql"
-      }
-      all_databases = common_databases.merge(
-        %w[MySQL Trilogy Oracle SQLServer JDBCMySQL JDBCSQLite3 JDBCPostgreSQL JDBC].to_h do |name|
-          [name, name.downcase]
-        end,
-        "None (disable Active Record)" => nil
-      )
+      common_databases = rails_opts.databases.slice(:sqlite3, :postgresql, :mysql).invert
+      all_databases = rails_opts.databases.invert.merge("None (disable Active Record)" => nil)
       rails_opts.database =
         prompt_select("Which database?", common_databases.merge("More options..." => false)) ||
         prompt_select("Which database?", all_databases)
@@ -158,12 +145,8 @@ module Nextgen
     end
 
     def ask_frontend_management
-      frontend = prompt_select(
-        "How will you manage frontend assets?",
-        "Sprockets (default)" => "sprockets",
-        "Propshaft" => "propshaft",
-        "Vite" => :vite
-      )
+      options = rails_opts.asset_pipelines.invert.merge("Vite" => :vite)
+      frontend = prompt_select("How will you manage frontend assets?", options)
 
       if frontend == :vite
         rails_opts.vite!
@@ -196,15 +179,9 @@ module Nextgen
       )
     end
 
-    def ask_rails_tools
-      opt_out = {
-        "Brakeman" => "brakeman",
-        "GitHub Actions CI" => "ci",
-        "RuboCop" => "rubocop"
-      }
-      opt_in = {
-        "devcontainer files" => "devcontainer"
-      }
+    def ask_rails_features
+      opt_out = rails_opts.default_features.invert
+      opt_in = rails_opts.optional_features.invert
 
       answers = prompt.multi_select(
         "Rails can preinstall the following. Which do you need?",
@@ -212,27 +189,27 @@ module Nextgen
         default: opt_out.keys.reverse
       )
 
-      rails_opts.devcontainer! if answers.delete("devcontainer")
-      (opt_out.values - answers).each { rails_opts.skip_optional_feature!(_1) }
+      (opt_out.values - answers).each { rails_opts.skip_default_feature!(_1) }
+      (opt_in.values & answers).each { rails_opts.enable_optional_feature!(_1) }
     end
 
     def ask_rails_frameworks
       frameworks = {
-        "JBuilder" => "jbuilder",
-        "Action Mailer" => "action_mailer",
-        "Active Job" => "active_job",
-        "Action Cable" => "action_cable"
+        "JBuilder" => :jbuilder,
+        "Action Mailer" => :action_mailer,
+        "Active Job" => :active_job,
+        "Action Cable" => :action_cable
       }
 
       unless rails_opts.api? || rails_opts.skip_javascript?
-        frameworks = {"Hotwire" => "hotwire"}.merge(frameworks)
+        frameworks = {"Hotwire" => :hotwire}.merge(frameworks)
       end
 
       unless rails_opts.skip_active_record?
         frameworks.merge!(
-          "Active Storage" => "active_storage",
-          "Action Text" => "action_text",
-          "Action Mailbox" => "action_mailbox"
+          "Active Storage" => :active_storage,
+          "Action Text" => :action_text,
+          "Action Mailbox" => :action_mailbox
         )
       end
 
@@ -242,14 +219,14 @@ module Nextgen
         default: frameworks.keys.reverse
       )
 
-      (frameworks.values - answers).each { rails_opts.skip_optional_feature!(_1) }
+      (frameworks.values - answers).each { rails_opts.skip_default_feature!(_1) }
     end
 
     def ask_test_framework
       rails_opts.test_framework = prompt_select(
         "Which test framework will you use?",
-        "Minitest (default)" => "minitest",
-        "RSpec" => "rspec",
+        "Minitest (default)" => :minitest,
+        "RSpec" => :rspec,
         "None" => nil
       )
     end
@@ -277,7 +254,7 @@ module Nextgen
       path = File.join(app_path, "tmp", "initial_nextgen_commit")
       FileUtils.mkdir_p(File.dirname(path))
       File.write(path, <<~COMMIT)
-        Init project with `rails new` (#{Nextgen::Rails.version})
+        Init project with `rails new` (#{rails_opts.version_label})
 
         Nextgen generated this project with the following `rails new` options:
 
@@ -289,10 +266,10 @@ module Nextgen
 
     def rails_new_args
       [app_path, "--no-rc", *rails_opts.to_args].tap do |args|
-        # Work around a Rails bug where --edge causes --no-rc to get ignored.
+        # Work around a Rails bug where --edge and --main cause --no-rc to get ignored.
         # Specifying --rc= with a non-existent file has the same effect as --no-rc.
         @rc_token ||= SecureRandom.hex(8)
-        args << "--rc=#{@rc_token}" if rails_opts.edge?
+        args << "--rc=#{@rc_token}" if args.intersect?(%w[--edge --main])
       end
     end
 

data/lib/nextgen/generators/dotenv.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
-install_gem "dotenv", version: ">= 3.0", group: %i[development test]
+# kamal is incompatible with the latest version of dotenv, so fall back
+# to using the legacy dotenv-rails gem in that case.
+if File.read("Gemfile.lock").match?(/\bkamal\b/)
+  install_gem "dotenv-rails", group: %i[development test]
+else
+  install_gem "dotenv", version: ">= 3.0", group: %i[development test]
+end
 copy_file ".env.sample"
 gitignore "/.env*", "!/.env.sample"

data/lib/nextgen/generators/vite.rb

@@ -117,7 +117,8 @@ say_git "Remove sprockets"
 remove_file "config/initializers/assets.rb"
 comment_lines "config/environments/development.rb", /^\s*config\.assets\./
 comment_lines "config/environments/production.rb", /^\s*config\.assets\./
-gsub_file "app/views/layouts/application.html.erb", /^.*<%= stylesheet_link_tag.*$/, ""
+gsub_file "app/views/layouts/application.html.erb", /^.*<%= javascript_include_tag.*\n/, ""
+gsub_file "app/views/layouts/application.html.erb", /^.*<%= stylesheet_link_tag.*\n/, ""
 remove_gem "sprockets-rails"
 
 if File.exist?(".github/workflows/ci.yml")

data/lib/nextgen/{rails.rb → rails_command.rb}

@@ -1,22 +1,8 @@
 # frozen_string_literal: true
 
-require "rails/version"
-
 module Nextgen
-  module Rails
+  module RailsCommand
     class << self
-      def version
-        ::Rails.version
-      end
-
-      def edge_branch
-        if version.match?(/[a-z]/i)
-          "main"
-        else
-          version[/^\d+\.\d+/].tr(".", "-") + "-stable"
-        end
-      end
-
       def run(*args, raise_on_error: true)
         command = "rails", *args
         say_status :run, *command.join(" ")

data/lib/nextgen/rails_options.rb

@@ -1,52 +1,44 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Nextgen
   class RailsOptions
-    DATABASES = %w[
-      postgresql
-      mysql
-      trilogy
-      sqlite3
-      oracle
-      sqlserver
-      jdbcmysql
-      jdbcsqlite3
-      jdbcpostgresql
-      jdbc
-    ].freeze
-
-    TEST_FRAMEWORKS = %w[minitest rspec].freeze
+    extend Forwardable
 
-    ASSET_PIPELINES = %w[sprockets propshaft].freeze
+    TEST_FRAMEWORKS = %i[minitest rspec].freeze
 
-    OPTIONAL_FEATURES = %w[
+    FRAMEWORKS = %i[
       action_mailer
       action_mailbox
       action_text
       active_job
       active_storage
       action_cable
-      brakeman
-      ci
       hotwire
       jbuilder
-      rubocop
     ].freeze
 
     attr_reader :asset_pipeline, :css, :javascript, :database, :test_framework
 
-    def initialize
+    def_delegators :version, :asset_pipelines, :databases, :default_features, :optional_features
+
+    def initialize(version:)
+      @version = version
       @api = false
-      @edge = false
       @vite = false
-      @devcontainer = nil
+      @enable_features = []
       @skip_features = []
       @skip_system_test = false
-      @test_framework = "minitest"
+      @test_framework = :minitest
+    end
+
+    def version_label
+      version.label
     end
 
     def asset_pipeline=(pipeline)
-      raise ArgumentError, "Unknown asset pipeline: #{pipeline}" unless [nil, *ASSET_PIPELINES].include?(pipeline)
+      raise ArgumentError, "Unknown asset pipeline: #{pipeline}" unless [nil, *asset_pipelines.keys].include?(pipeline)
 
       @asset_pipeline = pipeline
     end
@@ -80,7 +72,7 @@ module Nextgen
     end
 
     def database=(db)
-      raise ArgumentError, "Unknown database: #{db}" unless [nil, *DATABASES].include?(db)
+      raise ArgumentError, "Unknown database: #{db}" unless [nil, *databases.keys].include?(db)
 
       @database = db
     end
@@ -99,14 +91,6 @@ module Nextgen
       !!@test_framework
     end
 
-    def edge!
-      @edge = true
-    end
-
-    def edge?
-      @edge
-    end
-
     def devcontainer!
       @devcontainer = true
     end
@@ -131,15 +115,15 @@ module Nextgen
     end
 
     def minitest?
-      @test_framework == "minitest"
+      @test_framework == :minitest
     end
 
     def rspec?
-      @test_framework == "rspec"
+      @test_framework == :rspec
     end
 
     def rubocop?
-      !skip_optional_feature?("rubocop")
+      !skip_default_feature?(:rubocop)
     end
 
     def active_record?
@@ -163,7 +147,7 @@ module Nextgen
     end
 
     def skip_test?
-      defined?(@test_framework) && [nil, "rspec"].include?(@test_framework)
+      defined?(@test_framework) && [nil, :rspec].include?(@test_framework)
     end
 
     def system_testing?
@@ -171,28 +155,43 @@ module Nextgen
     end
 
     def action_mailer?
-      !skip_optional_feature?("action_mailer")
+      !skip_default_feature?(:action_mailer)
     end
 
     def active_job?
-      !skip_optional_feature?("active_job")
+      !skip_default_feature?(:active_job)
     end
 
-    def skip_optional_feature!(feature)
-      raise ArgumentError, "Unknown feature: #{feature}" unless OPTIONAL_FEATURES.include?(feature)
+    def skip_kamal?
+      # Depending on the Rails version, kamal may not exist, in which case we can consider it "skipped".
+      !skippable_features.include?(:kamal) || skip_default_feature?(:kamal)
+    end
+
+    def skip_solid?
+      !skippable_features.include?(:solid) || skip_default_feature?(:solid)
+    end
+
+    def enable_optional_feature!(feature)
+      raise ArgumentError, "Unknown feature: #{feature}" unless optional_features.include?(feature)
+
+      enable_features << feature
+    end
+
+    def skip_default_feature!(feature)
+      raise ArgumentError, "Unknown feature: #{feature}" unless skippable_features.include?(feature)
 
       skip_features << feature
     end
 
-    def skip_optional_feature?(feature)
-      raise ArgumentError, "Unknown feature: #{feature}" unless OPTIONAL_FEATURES.include?(feature)
+    def skip_default_feature?(feature)
+      raise ArgumentError, "Unknown feature: #{feature}" unless skippable_features.include?(feature)
 
       skip_features.include?(feature)
     end
 
     def to_args # rubocop:disable Metrics/PerceivedComplexity
       [].tap do |args|
-        args << "--edge" if edge?
+        args.push(*version.args)
         args << "--api" if api?
         args << "--skip-active-record" if skip_active_record?
         args << "--skip-asset-pipeline" if skip_asset_pipeline?
@@ -203,13 +202,17 @@ module Nextgen
         args << "--database=#{database}" if database
         args << "--css=#{css}" if css
         args << "--javascript=#{javascript}" if javascript
-        args << "--devcontainer" if @devcontainer
-        args.push(*skip_features.map { "--skip-#{_1.tr("_", "-")}" })
+        args.push(*enable_features.map { "--#{_1.to_s.tr("_", "-")}" })
+        args.push(*skip_features.map { "--skip-#{_1.to_s.tr("_", "-")}" })
       end
     end
 
     private
 
-    attr_reader :skip_features
+    attr_reader :enable_features, :skip_features, :version
+
+    def skippable_features
+      FRAMEWORKS + default_features.keys
+    end
   end
 end

data/lib/nextgen/rails_version.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "open-uri"
+require "rails/version"
+require "yaml"
+
+module Nextgen
+  RailsVersion = Struct.new(
+    :args,
+    :label,
+    :asset_pipelines,
+    :databases,
+    :default_features,
+    :optional_features,
+    keyword_init: true
+  )
+
+  class << RailsVersion
+    def current
+      from_yaml(:current) do |version|
+        version.label.sub!("%%CURRENT_VERSION%%") { ::Rails.version }
+      end
+    end
+
+    def edge
+      from_yaml(:edge)
+    end
+
+    def main
+      from_yaml(:main) do |version|
+        version.label.sub!("%%MAIN_VERSION%%") { main_version }
+      end
+    end
+
+    private
+
+    def from_yaml(key)
+      @yaml ||= begin
+        yaml_path = File.expand_path("../../config/rails_versions.yml", __dir__)
+        YAML.load_file(yaml_path, aliases: true, symbolize_names: true)
+      end
+      new(**@yaml.fetch(key)).tap do |version|
+        yield(version) if block_given?
+      end.freeze
+    end
+
+    def main_version
+      @main_version ||= begin
+        version_rb = URI.open("https://raw.githubusercontent.com/rails/rails/main/version.rb").read
+        version_pattern = /\s+MAJOR\s+= (\d+)\n\s*MINOR\s+= (\d+)\n\s*TINY\s+= (\d+)\n\s*PRE\s+= "(\w+)"/
+        version_rb.match(version_pattern)&.captures&.join(".")
+      rescue OpenURI::HTTPError
+        "unknown"
+      end
+    end
+  end
+end

data/lib/nextgen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nextgen
-  VERSION = "0.22.0"
+  VERSION = "0.24.0"
 end

data/template/.overcommit.yml.tt

@@ -68,6 +68,8 @@ PreCommit:
     enabled: true
     required_executable: npx
     command: ["npx", "--no-install", "stylelint"]
+    env:
+      NODE_OPTIONS: --no-deprecation
     include:
       - app/assets/**/*.css
       - app/components/**/*.css

data/template/DEPLOYMENT.md

@@ -8,4 +8,4 @@ These environment variables affect how the app functions when deployed in produc
 - `RAILS_ENV` **REQUIRED** - "production"
 - `RAILS_MAX_THREADS` - Number of threads per Puma process (default: 3)
 - `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)
+- `WEB_CONCURRENCY` - Number of Puma processes (default: 1)

data/template/bin/setup

@@ -11,7 +11,7 @@ def setup!
   run "bin/rails db:prepare" if database_present?
   run "yarn install --check-files" if yarn_needed?
   run "bin/rails tmp:create" if tmp_missing?
-  run "bin/rails restart"
+  run "bin/rails restart" if pid_present?
 
   if git_safe_needed?
     say_status :notice,
@@ -56,6 +56,10 @@ def tmp_missing?
   !Dir.exist?("tmp/pids")
 end
 
+def pid_present?
+  Dir["tmp/pids/*.pid"].any?
+end
+
 def git_safe_needed?
   ENV["PATH"].include?(".git/safe/../../bin") && !Dir.exist?(".git/safe")
 end

data/template/lib/tasks/rubocop.rake

@@ -3,4 +3,6 @@
 return unless Gem.loaded_specs.key?("rubocop")
 
 require "rubocop/rake_task"
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options.push "-c", ".rubocop.yml"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nextgen
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-07 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -92,6 +92,7 @@ files:
 - LICENSE.txt
 - README.md
 - config/generators.yml
+- config/rails_versions.yml
 - exe/nextgen
 - lib/nextgen.rb
 - lib/nextgen/actions.rb
@@ -139,8 +140,9 @@ files:
 - lib/nextgen/generators/tomo.rb
 - lib/nextgen/generators/vcr.rb
 - lib/nextgen/generators/vite.rb
-- lib/nextgen/rails.rb
+- lib/nextgen/rails_command.rb
 - lib/nextgen/rails_options.rb
+- lib/nextgen/rails_version.rb
 - lib/nextgen/thor_extensions.rb
 - lib/nextgen/tidy_gemfile.rb
 - lib/nextgen/version.rb