nextgen 0.1.0

data/lib/nextgen/generators/shoulda.rb

@@ -0,0 +1,6 @@
+say_git "Install shoulda gems"
+install_gem "shoulda-context", group: :test if minitest?
+install_gem "shoulda-matchers", group: :test
+
+say_git "Include shoulda methods in tests"
+copy_test_support_file "shoulda.rb"

data/lib/nextgen/generators/sidekiq.rb

@@ -0,0 +1,30 @@
+say_git "Install the sidekiq gem in the :production group, with a binstub"
+install_gem "sidekiq", version: "~> 7.0", group: :production
+binstub "sidekiq"
+
+say_git "Add a sidekiq entry to the Procfile"
+append_to_file "Procfile", "worker: bundle exec sidekiq -C config/sidekiq.yml\n"
+
+say_git "Configure Active Job to use the sidekiq adapter in production"
+uncomment_lines "config/environments/production.rb", /config\.active_job/
+gsub_file "config/environments/production.rb",
+  /active_job\.queue_adapter\s*=\s*:.+/,
+  "active_job.queue_adapter = :sidekiq"
+gsub_file "config/environments/production.rb", " (and separate queues per environment)", ""
+gsub_file "config/environments/production.rb",
+  /queue_name_prefix = .*$/,
+  "queue_name_prefix = nil # Not supported by sidekiq"
+
+say_git "Mount the Sidekiq web console at /sidekiq, secured with basic auth"
+copy_file "config/initializers/sidekiq.rb"
+route 'mount Sidekiq::Web => "/sidekiq" if defined?(Sidekiq)'
+
+say_git "Allow SIDEKIQ_CONCURRENCY env var to set concurrency"
+document_deploy_var "SIDEKIQ_CONCURRENCY", "Number of threads used per Sidekiq process", default: "5"
+copy_file "config/sidekiq.yml"
+
+if File.exist?("config/database.yml")
+  gsub_file "config/database.yml",
+    'ENV.fetch("RAILS_MAX_THREADS") { 5 }',
+    '[5, *ENV.values_at("RAILS_MAX_THREADS", "SIDEKIQ_CONCURRENCY")].map(&:to_i).max'
+end

data/lib/nextgen/generators/stylelint.rb

@@ -0,0 +1,24 @@
+say_git "Install stylelint"
+add_yarn_packages(
+  "stylelint",
+  "stylelint-config-standard",
+  "stylelint-declaration-strict-value",
+  "stylelint-prettier",
+  "prettier",
+  "npm-run-all",
+  dev: true
+)
+add_package_json_scripts(
+  "lint:css": "stylelint 'app/{components,frontend,assets/stylesheets}/**/*.css'",
+  "fix:css": "npm run -- lint:css --fix",
+  lint: "npm-run-all lint:**",
+  fix: "npm-run-all fix:**"
+)
+copy_file ".stylelintrc.cjs"
+
+say_git "Add stylelint to default rake task"
+copy_file "lib/tasks/stylelint.rake"
+add_lint_task "stylelint"
+
+say_git "Auto-correct any existing issues"
+run "yarn fix:css", capture: true

data/lib/nextgen/generators/thor.rb

@@ -0,0 +1,2 @@
+copy_file "Thorfile"
+binstub "thor"

data/lib/nextgen/generators/tomo.rb

@@ -0,0 +1,10 @@
+say_git "Install the tomo gem in the :development group, with a binstub"
+install_gem "tomo", version: "~> 1.18", group: :development, require: false
+binstub "tomo"
+
+say_git "Initialize the tomo config file"
+if File.exist?(".tomo/config.rb")
+  say_status :skip, ".tomo/config.rb exists", :blue
+else
+  bundle_command! "exec tomo init"
+end

data/lib/nextgen/generators/vite.rb

@@ -0,0 +1,103 @@
+say_git "Install the vite_rails gem"
+install_gem "vite_rails", version: "~> 3.0"
+
+say_git "Move asset pipeline files into app/frontend"
+remove_file "app/assets/stylesheets/application.css"
+remove_file "app/javascript/application.js"
+move "app/javascript", "app/frontend"
+move "app/assets/images", "app/frontend/images"
+move "app/assets/stylesheets", "app/frontend/stylesheets"
+remove_dir "app/assets"
+inject_into_class "config/application.rb", "Application", <<-RUBY
+  # Prevents Rails from trying to eager-load the contents of app/frontend
+  config.javascript_path = "frontend"
+
+RUBY
+
+say_git "Run the vite installer"
+bundle_command "exec vite install"
+gsub_file "app/views/layouts/application.html.erb",
+  /vite_javascript_tag 'application' %>/,
+  'vite_javascript_tag "application", "data-turbo-track": "reload" %>'
+
+say_git "Replace vite-plugin-ruby with vite-plugin-rails"
+add_yarn_packages "rollup@^3.26.3", "vite-plugin-rails@0.1.0"
+remove_yarn_package "vite-plugin-ruby"
+gsub_file "vite.config.ts", "import RubyPlugin from 'vite-plugin-ruby'", 'import ViteRails from "vite-plugin-rails"'
+gsub_file "vite.config.ts", /^\s*?RubyPlugin\(\)/, <<~TYPESCRIPT.gsub(/^/, "    ").rstrip
+  ViteRails({
+    envVars: { RAILS_ENV: "development" },
+    envOptions: { defineOn: "import.meta.env" },
+    fullReload: {
+      additionalPaths: [],
+    },
+  })
+TYPESCRIPT
+
+say_git "Move vite package from devDependencies to dependencies"
+if (vite_version = File.read("package.json")[/"vite":\s*"(.+?)"/, 1])
+  remove_yarn_package "vite", capture: true
+  add_yarn_package "vite@#{vite_version}"
+end
+
+say_git "Install autoprefixer"
+add_yarn_packages "postcss@^8.4.24", "autoprefixer@^10.4.14"
+copy_file "postcss.config.js"
+
+say_git "Disable autoBuild in test environment"
+gsub_file "config/vite.json", /("test": \{.+?"autoBuild":\s*)true/m, '\1false'
+copy_test_support_file "vite.rb"
+
+say_git "Install modern-normalize and base stylesheets"
+add_yarn_package "modern-normalize@^2.0.0"
+copy_file "app/frontend/stylesheets/index.css"
+copy_file "app/frontend/stylesheets/base.css"
+copy_file "app/frontend/stylesheets/reset.css"
+
+say_git "Configure turbo/stimulus"
+package_json = File.read("package.json")
+if package_json.match?(%r{@hotwired/turbo-rails})
+  prepend_to_file "app/frontend/entrypoints/application.js", <<~JS
+    import "@hotwired/turbo-rails";
+  JS
+end
+if package_json.match?(%r{@hotwired/stimulus})
+  add_yarn_package "stimulus-vite-helpers"
+  copy_file "app/frontend/controllers/index.js", force: true
+  prepend_to_file "app/frontend/entrypoints/application.js", <<~JS
+    import "~/controllers";
+  JS
+end
+prepend_to_file "app/frontend/entrypoints/application.js", <<~JS
+  import "~/stylesheets/index.css";
+JS
+
+say_git "Add InlineSvgHelper"
+if File.read("config/application.rb").match?(/^\s*config\.autoload_lib/)
+  copy_file "lib/vite_inline_svg_file_loader.rb"
+else
+  empty_directory "app/lib"
+  copy_file "lib/vite_inline_svg_file_loader.rb", "app/lib/vite_inline_svg_file_loader.rb"
+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?
+
+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_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"
+remove_file "Procfile.dev"
+
+say_git "Remove jsbundling-rails"
+remove_gem "jsbundling-rails"
+
+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.*$/, ""
+remove_gem "sprockets-rails"

data/lib/nextgen/generators.rb

@@ -0,0 +1,87 @@
+require "yaml"
+
+module Nextgen
+  class Generators
+    def self.compatible_with(rails_opts:)
+      yaml_path = File.expand_path("../../config/generators.yml", __dir__)
+      new.tap do |g|
+        YAML.load_file(yaml_path).each do |name, options|
+          options ||= {}
+          requirements = Array(options["requires"])
+          next unless requirements.all? { |req| rails_opts.public_send("#{req}?") }
+
+          g.add(
+            name.to_sym,
+            prompt: options["prompt"],
+            description: options["description"],
+            node: !!options["node"]
+          )
+        end
+
+        g.deactivate_node unless rails_opts.requires_node?
+      end
+    end
+
+    def initialize
+      @generators = {}
+    end
+
+    def node_active?
+      !!generators.fetch(:node)[:active]
+    end
+
+    def all_active
+      generators.each_with_object([]) do |(name, meta), result|
+        result << name if meta[:active]
+      end
+    end
+
+    def add(name, node: false, prompt: nil, description: nil)
+      name = name.to_sym
+      raise ArgumentError, "Generator #{name.inspect} was already added" if generators.key?(name)
+
+      generators[name] = {node: node, prompt: prompt, description: description}
+      activate(name) unless prompt
+    end
+
+    def optional
+      generators.each_with_object({}) do |(name, meta), result|
+        result[meta[:prompt]] = name if meta[:prompt]
+      end
+    end
+
+    def activate(*optional_generators)
+      optional_generators.each do |name|
+        name = name.to_sym
+        gen = generators.fetch(name)
+        gen[:active] = true
+        activate(:node) if name != :node && gen[:node]
+      end
+    end
+
+    def deactivate_node
+      generators.fetch(:node)[:active] = false
+    end
+
+    def to_ruby_script
+      apply_statements = all_active.map do |generator|
+        description = generators.fetch(generator)[:description]
+        path = Nextgen.generators_path.join("#{generator}.rb")
+        "apply_as_git_commit #{path.to_s.inspect}, message: #{description.inspect}"
+      end
+
+      <<~SCRIPT
+        require #{File.expand_path("../nextgen", __dir__).inspect}
+        extend Nextgen::Actions
+
+        with_nextgen_source_path do
+          #{apply_statements.join("\n  ")}
+        end
+      SCRIPT
+    end
+
+    private
+
+    attr_reader :generators
+  end
+end

data/lib/nextgen/rails.rb

@@ -0,0 +1,39 @@
+require "rails/version"
+
+module Nextgen
+  module Rails
+    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(" ")
+        with_original_bundler_env do
+          system(*command, exception: raise_on_error)
+        end
+      end
+
+      private
+
+      def say_status(...)
+        Thor::Base.shell.new.say_status(...)
+      end
+
+      def with_original_bundler_env(&block)
+        return yield unless defined?(Bundler)
+
+        Bundler.with_original_env(&block)
+      end
+    end
+  end
+end

data/lib/nextgen/rails_options.rb

@@ -0,0 +1,191 @@
+module Nextgen
+  class RailsOptions
+    DATABASES = %w[
+      postgresql
+      mysql
+      sqlite3
+      oracle
+      sqlserver
+      jdbcmysql
+      jdbcsqlite3
+      jdbcpostgresql
+      jdbc
+    ].freeze
+
+    TEST_FRAMEWORKS = %w[minitest rspec].freeze
+
+    ASSET_PIPELINES = %w[sprockets propshaft].freeze
+
+    OPTIONAL_FRAMEWORKS = %w[
+      action_mailer
+      action_mailbox
+      action_text
+      active_job
+      active_storage
+      action_cable
+      hotwire
+      jbuilder
+    ].freeze
+
+    attr_reader :asset_pipeline, :css, :javascript, :database, :test_framework
+
+    def initialize
+      @api = false
+      @edge = false
+      @skip_frameworks = []
+      @skip_system_test = false
+      @test_framework = "minitest"
+    end
+
+    def asset_pipeline=(pipeline)
+      raise ArgumentError, "Unknown asset pipeline: #{pipeline}" unless [nil, *ASSET_PIPELINES].include?(pipeline)
+
+      @asset_pipeline = pipeline
+    end
+
+    def css=(framework)
+      raise ArgumentError, "Can't specify css in API mode" if api?
+      raise ArgumentError, "Can't specify css when asset pipeline is disabled" if skip_asset_pipeline?
+
+      @css = framework
+    end
+
+    def javascript=(framework)
+      raise ArgumentError, "Can't specify javascript in API mode" if api? && framework
+
+      if skip_asset_pipeline? && framework != "vite"
+        raise ArgumentError, "Can't specify javascript when asset pipeline is disabled"
+      end
+
+      @javascript = framework
+    end
+
+    def vite?
+      @javascript == "vite"
+    end
+
+    def skip_javascript?
+      defined?(@javascript) && @javascript.nil?
+    end
+
+    def database=(db)
+      raise ArgumentError, "Unknown database: #{db}" unless [nil, *DATABASES].include?(db)
+
+      @database = db
+    end
+
+    def postgresql?
+      database == "postgresql"
+    end
+
+    def test_framework=(framework)
+      raise ArgumentError, "Unknown test framework: #{framework}" unless [nil, *TEST_FRAMEWORKS].include?(framework)
+
+      @test_framework = framework
+    end
+
+    def test_framework?
+      !!@test_framework
+    end
+
+    def edge!
+      @edge = true
+    end
+
+    def edge?
+      @edge
+    end
+
+    def api!
+      raise ArgumentError, "Can't specify API mode if css is already specified" if css
+      raise ArgumentError, "Can't specify API mode if javascript is already specified" if javascript
+
+      @api = true
+    end
+
+    def api?
+      @api
+    end
+
+    def frontend?
+      !api?
+    end
+
+    def requires_node?
+      %w[bootstrap bulma postcss sass].include?(css) || %w[webpack esbuild rollup vite].include?(javascript)
+    end
+
+    def rspec?
+      @test_framework == "rspec"
+    end
+
+    def active_record?
+      !skip_active_record?
+    end
+
+    def skip_active_record?
+      defined?(@database) && @database.nil?
+    end
+
+    def skip_asset_pipeline?
+      defined?(@asset_pipeline) && @asset_pipeline.nil?
+    end
+
+    def skip_system_test!
+      @skip_system_test = true
+    end
+
+    def skip_system_test?
+      @skip_system_test
+    end
+
+    def skip_test?
+      defined?(@test_framework) && [nil, "rspec"].include?(@test_framework)
+    end
+
+    def system_testing?
+      !(api? || test_framework.nil? || skip_system_test?)
+    end
+
+    def action_mailer?
+      !skip_optional_framework?("action_mailer")
+    end
+
+    def active_job?
+      !skip_optional_framework?("active_job")
+    end
+
+    def skip_optional_framework!(framework)
+      raise ArgumentError, "Unknown framework: #{framework}" unless OPTIONAL_FRAMEWORKS.include?(framework)
+
+      skip_frameworks << framework
+    end
+
+    def skip_optional_framework?(framework)
+      raise ArgumentError, "Unknown framework: #{framework}" unless OPTIONAL_FRAMEWORKS.include?(framework)
+
+      skip_frameworks.include?(framework)
+    end
+
+    def to_args # rubocop:disable Metrics/PerceivedComplexity
+      [].tap do |args|
+        args << "--edge" if edge?
+        args << "--api" if api?
+        args << "--skip-active-record" if skip_active_record?
+        args << "--skip-asset-pipeline" if skip_asset_pipeline?
+        args << "--skip-javascript" if skip_javascript?
+        args << "--skip-test" if skip_test?
+        args << "--skip-system-test" if skip_system_test?
+        args << "--asset-pipeline=#{asset_pipeline}" if asset_pipeline
+        args << "--database=#{database}" if database
+        args << "--css=#{css}" if css
+        args << "--javascript=#{javascript}" if javascript
+        args.push(*skip_frameworks.map { "--skip-#{_1.tr("_", "-")}" })
+      end
+    end
+
+    private
+
+    attr_reader :skip_frameworks
+  end
+end

data/lib/nextgen/thor_extensions.rb

@@ -0,0 +1,48 @@
+module Nextgen
+  module ThorExtensions
+    def self.extended(base)
+      super
+      base.check_unknown_options!
+    end
+
+    def start(given_args = ARGV, config = {})
+      config[:shell] ||= Thor::Base.shell.new
+      handle_help_switches(given_args) do |args|
+        dispatch(nil, args, nil, config)
+      end
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      handle_exception_on_start(e, config)
+    end
+
+    private
+
+    def handle_help_switches(given_args)
+      yield(given_args.dup)
+    rescue Thor::UnknownArgumentError => e
+      retry_with_args = []
+
+      if given_args.first == "help"
+        retry_with_args = ["help"] if given_args.length > 1
+      elsif (e.unknown & %w[-h --help]).any?
+        retry_with_args = ["help", (given_args - e.unknown).first]
+      end
+      raise unless retry_with_args.any?
+
+      yield(retry_with_args)
+    end
+
+    def handle_exception_on_start(error, config)
+      case error
+      when Errno::EPIPE
+        # Ignore
+      when Thor::Error, Interrupt
+        raise unless config.fetch(:exit_on_failure, true)
+
+        config[:shell]&.say_error(error.message, :red)
+        exit(false)
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/nextgen/tidy_gemfile.rb

@@ -0,0 +1,71 @@
+module Nextgen
+  class TidyGemfile
+    def self.clean!(path = "Gemfile")
+      gemfile = new(path)
+      gemfile.clean
+      gemfile.save
+    end
+
+    def initialize(path = "Gemfile")
+      @path = path
+      @gemfile = File.read(path)
+    end
+
+    def include?(gem)
+      gemfile.match?(/^\s*gem\s+['"]#{gem}['"]/)
+    end
+
+    def clean
+      @gemfile = gemfile
+        .gsub(/^\s*#.*/, "")          # remove comments
+        .gsub(/(\s*\n)+/, "\n")       # remove blank lines
+        .gsub(/^(ruby.*)/, "\n\\1\n") # ensure blank space around "ruby" line
+        .gsub(/^(group.*)/, "\n\\1")  # ensure blank space before each "group" block
+      nil
+    end
+
+    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 ? "  " : "")
+
+      if group
+        group_line = create_group_if_needed(group)
+        gemfile.sub!(/#{Regexp.quote(group_line)}/, '\0' + gem_line)
+      else
+        gemfile.sub!(/^(#|gem\s)/, gem_line + '\0')
+      end
+
+      # Add a blank line after the gem if the subsequent line starts with a comment
+      gemfile.sub!(/(#{Regexp.quote(gem_line)})(\s*#)/, "\\1\n\\2")
+      true
+    end
+
+    def remove(gem)
+      !!gemfile.gsub!(/^( *#.*?\n)?\s*gem\s+['"]#{gem}['"].*\n/, "")
+    end
+
+    def save
+      File.write(@path, gemfile.rstrip + "\n")
+      true
+    end
+
+    private
+
+    attr_reader :gemfile
+
+    def create_group_if_needed(group)
+      group_line = "group " + Array(group).map(&:inspect).join(", ") + " do\n"
+      gemfile << "\n#{group_line}end\n" unless gemfile.include?(group_line)
+      group_line
+    end
+
+    def build_gem_line(gem, version:, require:, indent:)
+      line = %(gem "#{gem}")
+      line << ", #{version.to_s.inspect}" if version
+      line << ", require: #{require.inspect}" unless require.nil?
+
+      indent + line + "\n"
+    end
+  end
+end

data/lib/nextgen/version.rb

@@ -0,0 +1,3 @@
+module Nextgen
+  VERSION = "0.1.0".freeze
+end

data/lib/nextgen.rb

@@ -0,0 +1,17 @@
+require "pathname"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/nextgen/generators")
+loader.inflector.inflect("cli" => "CLI")
+loader.setup
+
+module Nextgen
+  def self.generators_path
+    Pathname.new(__dir__).join("nextgen/generators")
+  end
+
+  def self.template_path
+    Pathname.new(__dir__).join("../template")
+  end
+end

data/template/.editorconfig

@@ -0,0 +1,14 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_style = tab

data/template/.env.sample

@@ -0,0 +1,2 @@
+# These environment variables are needed to run the app locally.
+# Copy these into a file named .env to have them loaded automatically.

data/template/.erb-lint.yml.tt

@@ -0,0 +1,25 @@
+---
+EnableDefaultLinters: true
+exclude:
+  - "node_modules/**/*"
+  - "vendor/**/*"
+linters:
+  ErbSafety:
+    enabled: true
+<% if File.exist?(".rubocop.yml") -%>
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Lint/UselessAssignment:
+        Enabled: false
+      Naming/FileName:
+        Enabled: false
+      Rails/OutputSafety:
+        Enabled: false
+<% end -%>