nextgen 0.1.0

data/template/app/frontend/stylesheets/base.css

@@ -0,0 +1,8 @@
+/*
+  This file is for base element styles, like:
+
+  - Any @font-face declarations needed custom web fonts.
+  - Default font-family on the body element.
+  - Default foreground, background, and link colors.
+  - Global CSS variables (declared on :root), such as color palette.
+*/

data/template/app/frontend/stylesheets/index.css

@@ -0,0 +1,3 @@
+@import "modern-normalize";
+@import "reset";
+@import "base";

data/template/app/frontend/stylesheets/reset.css

@@ -0,0 +1,36 @@
+:root {
+  line-height: 1.5;
+  -webkit-font-smoothing: antialiased;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+figure,
+p,
+ol,
+ul {
+  margin: 0;
+}
+
+ol,
+ul {
+  list-style: none;
+  padding-inline: 0;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5 {
+  font-size: inherit;
+  font-weight: inherit;
+}
+
+img {
+  display: block;
+  max-inline-size: 100%;
+}

data/template/app/helpers/inline_svg_helper.rb

@@ -0,0 +1,9 @@
+module InlineSvgHelper
+  def inline_svg_tag(filename, title: nil)
+    svg = ViteInlineSvgFileLoader.named(filename)
+    svg = svg.sub(/\A<svg/, '<svg role="img"')
+    svg = svg.sub(/\A<svg.*?>/, safe_join(['\0', "\n", tag.title(title)])) if title.present?
+
+    svg.strip.html_safe # rubocop:disable Rails/OutputSafety
+  end
+end

data/template/app/views/home/index.html.erb.tt

@@ -0,0 +1,5 @@
+<%% provide(:title, "Home") %>
+<p>Find me in app/views/home/index.html.erb</p>
+<% if File.exist?("package.json") && File.read("package.json").match?(%r{@hotwired/stimulus}) -%>
+<p>Stimulus says, <i data-controller=hello></i></p>
+<% end -%>

data/template/bin/setup

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+# 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 method.
+def setup!
+  run "bundle install" if bundle_needed?
+  run "overcommit --install" if overcommit_installable?
+  run "bin/rails db:prepare" if database_present?
+  run "yarn install" if yarn_needed?
+  run "bin/rails tmp:create" if tmp_missing?
+  env ".env", from: ".env.sample"
+  run "bin/rails restart"
+
+  if git_safe_needed?
+    say_status :notice,
+      "Remember to run #{colorize("mkdir -p .git/safe", :yellow)} to trust the binstubs in this project",
+      :magenta
+  end
+
+  say_status :Ready!,
+    "Use #{colorize("bin/rails s", :yellow)} to start the app, " \
+    "or #{colorize("bin/rake", :yellow)} to run tests"
+end
+
+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)
+  end
+end
+
+def run?(command)
+  run command, silent: true, echo: false, exception: false
+end
+
+def bundle_needed?
+  !run("bundle check", silent: true, exception: false)
+end
+
+def overcommit_installable?
+  File.exist?(".overcommit.yml") && !File.exist?(".git/hooks/overcommit-hook") && run?("overcommit -v")
+end
+
+def database_present?
+  File.exist?("config/database.yml")
+end
+
+def yarn_needed?
+  File.exist?("yarn.lock") && !run("yarn check --check-files", silent: true, exception: false)
+end
+
+def tmp_missing?
+  !Dir.exist?("tmp/pids")
+end
+
+def git_safe_needed?
+  ENV["PATH"].include?(".git/safe/../../bin") && !Dir.exist?(".git/safe")
+end
+
+def with_original_bundler_env(&block)
+  return yield unless defined?(Bundler)
+
+  Bundler.with_original_env(&block)
+end
+
+def env(env_file, from:)
+  return unless File.exist?(from)
+
+  unless File.exist?(env_file)
+    say_status(:copy, "#{from} → #{env_file}", :magenta)
+    require "fileutils"
+    FileUtils.cp(from, env_file)
+  end
+
+  keys = ->(f) { File.readlines(f).filter_map { |l| l[/^([^#\s][^=\s]*)/, 1] } }
+
+  missing = keys[from] - keys[env_file]
+  return if missing.empty?
+
+  say_status(:WARNING, "Your #{env_file} file is missing #{missing.join(", ")}. Refer to #{from} for details.", :red)
+end
+
+def say_status(label, message, color = :green)
+  label = label.to_s.rjust(12)
+  puts [colorize(label, color), message].join(" ")
+end
+
+def colorize(str, color)
+  return str unless color_supported?
+
+  code = {red: 31, green: 32, yellow: 33, blue: 34, magenta: 35}.fetch(color)
+  "\e[0;#{code};49m#{str}\e[0m"
+end
+
+def color_supported?
+  if ENV["TERM"] == "dumb" || !ENV["NO_COLOR"].to_s.empty?
+    false
+  else
+    [$stdout, $stderr].all? { |io| io.respond_to?(:tty?) && io.tty? }
+  end
+end
+
+Dir.chdir(File.expand_path("..", __dir__)) do
+  setup!
+end

data/template/config/initializers/generators.rb

@@ -0,0 +1,5 @@
+Rails.application.config.generators do |g|
+  # Disable generators we don't need.
+  g.javascripts false
+  g.stylesheets false
+end

data/template/config/initializers/rack_mini_profiler.rb

@@ -0,0 +1,4 @@
+return unless defined?(Rack::MiniProfiler)
+
+# https://github.com/MiniProfiler/rack-mini-profiler#configuration-options
+Rack::MiniProfiler.config.enable_hotwire_turbo_drive_support = true

data/template/config/initializers/sidekiq.rb

@@ -0,0 +1,32 @@
+return unless defined?(Sidekiq)
+
+# Disable SSL certificate verification if using Heroku Redis
+# redis_opts = {
+#   ssl_params: {
+#     verify_mode: OpenSSL::SSL::VERIFY_NONE
+#   }
+# }
+# Sidekiq.configure_server do |config|
+#   config.redis = redis_opts
+# end
+# Sidekiq.configure_client do |config|
+#   config.redis = redis_opts
+# end
+
+# Enable Rails CurrentAttributes to flow transparently through to Sidekiq jobs
+# require "sidekiq/middleware/current_attributes"
+# Sidekiq::CurrentAttributes.persist(Myapp::Current)
+
+require "sidekiq/web"
+
+Sidekiq::Web.app_url = "/"
+
+sidekiq_username = ENV.fetch("SIDEKIQ_WEB_USERNAME", nil)
+sidekiq_password = ENV.fetch("SIDEKIQ_WEB_PASSWORD", nil)
+
+Sidekiq::Web.use(Rack::Auth::Basic, "Sidekiq") do |username, password|
+  if sidekiq_username.present? && sidekiq_password.present?
+    ActiveSupport::SecurityUtils.secure_compare(username, sidekiq_username) &
+      ActiveSupport::SecurityUtils.secure_compare(password, sidekiq_password)
+  end
+end

data/template/config/sidekiq.yml

@@ -0,0 +1,5 @@
+---
+:queues:
+  - default
+
+:concurrency: <%= ENV["SIDEKIQ_CONCURRENCY"] || ENV["RAILS_MAX_THREADS"] || 5 %>

data/template/lib/puma/plugin/open.rb

@@ -0,0 +1,14 @@
+require "puma/plugin"
+
+Puma::Plugin.create do
+  def start(launcher)
+    return unless defined?(Rails) && defined?(Launchy)
+    return unless Rails.env.development?
+
+    binding = launcher.options[:binds].grep(/^tcp|ssl/).first
+    return if binding.nil?
+
+    url = binding.sub(/^tcp/, "http").sub(/^ssl/, "https").sub("0.0.0.0", "localhost")
+    Launchy.open(url)
+  end
+end

data/template/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,52 @@
+return unless Rails.env.development?
+
+require "annotate"
+task :set_annotation_options do # rubocop:disable Rake/Desc, Metrics/BlockLength
+  # You can override any of these by setting an environment variable of the same name.
+  Annotate.set_defaults(
+    "routes" => "false",
+    "models" => "true",
+    "position_in_routes" => "before",
+    "position_in_class" => "before",
+    "position_in_test" => "before",
+    "position_in_fixture" => "before",
+    "position_in_factory" => "before",
+    "position_in_serializer" => "before",
+    "show_foreign_keys" => "true",
+    "show_complete_foreign_keys" => "false",
+    "show_indexes" => "true",
+    "simple_indexes" => "false",
+    "model_dir" => "app/models",
+    "root_dir" => "",
+    "include_version" => "false",
+    "require" => "",
+    "exclude_tests" => "true",
+    "exclude_fixtures" => "false",
+    "exclude_factories" => "false",
+    "exclude_serializers" => "false",
+    "exclude_scaffolds" => "true",
+    "exclude_controllers" => "true",
+    "exclude_helpers" => "true",
+    "exclude_sti_subclasses" => "false",
+    "ignore_model_sub_dir" => "false",
+    "ignore_columns" => nil,
+    "ignore_routes" => nil,
+    "ignore_unknown_models" => "false",
+    "hide_limit_column_types" => "integer,bigint,boolean",
+    "hide_default_column_types" => "json,jsonb,hstore",
+    "skip_on_db_migrate" => "false",
+    "format_bare" => "true",
+    "format_rdoc" => "false",
+    "format_markdown" => "false",
+    "sort" => "false",
+    "force" => "false",
+    "frozen" => "false",
+    "classified_sort" => "true",
+    "trace" => "false",
+    "wrapper_open" => nil,
+    "wrapper_close" => nil,
+    "with_comment" => "true"
+  )
+end
+
+Annotate.load_tasks

data/template/lib/tasks/erblint.rake

@@ -0,0 +1,11 @@
+desc "Run erblint"
+task :erblint do
+  sh "bin/erblint --lint-all"
+end
+
+namespace :erblint do
+  desc "Autocorrect erblint offenses"
+  task :autocorrect do
+    sh "bin/erblint --lint-all -a"
+  end
+end

data/template/lib/tasks/eslint.rake

@@ -0,0 +1,11 @@
+desc "Run ESLint"
+task :eslint do
+  sh "yarn lint:js"
+end
+
+namespace :eslint do
+  desc "Autocorrect ESLint offenses"
+  task :autocorrect do
+    sh "yarn fix:js"
+  end
+end

data/template/lib/tasks/rubocop.rake

@@ -0,0 +1,4 @@
+return unless Gem.loaded_specs.key?("rubocop")
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new

data/template/lib/tasks/stylelint.rake

@@ -0,0 +1,11 @@
+desc "Run Stylelint"
+task :stylelint do
+  sh "yarn lint:css"
+end
+
+namespace :stylelint do
+  desc "Autocorrect Stylelint offenses"
+  task :autocorrect do
+    sh "yarn fix:css"
+  end
+end

data/template/lib/templates/rspec/system/system_spec.rb

@@ -0,0 +1,10 @@
+require "rails_helper"
+
+RSpec.describe "<%= class_name %>" do
+  pending "add some scenarios (or delete) #{__FILE__}"
+
+  # it "renders a message on the home page" do
+  #   visit "/"
+  #   expect(page).to have_content("Hello, world!")
+  # end
+end

data/template/lib/vite_inline_svg_file_loader.rb

@@ -0,0 +1,25 @@
+module ViteInlineSvgFileLoader
+  class << self
+    def named(filename)
+      vite = ViteRuby.instance
+      vite_asset_path = vite.manifest.path_for(filename)
+
+      if vite.dev_server_running?
+        fetch_from_dev_server(vite_asset_path)
+      else
+        Rails.public_path.join(vite_asset_path.sub(%r{^/}, "")).read
+      end
+    end
+
+    private
+
+    def fetch_from_dev_server(path)
+      config = ViteRuby.config
+      dev_server_uri = URI("#{config.protocol}://#{config.host_with_port}#{path}")
+      response = Net::HTTP.get_response(dev_server_uri)
+      raise "Failed to load inline SVG from #{dev_server_uri}" unless response.is_a?(Net::HTTPSuccess)
+
+      response.body
+    end
+  end
+end

data/template/package.json

@@ -0,0 +1,6 @@
+{
+  "private": true,
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

data/template/postcss.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: [require("autoprefixer")],
+};

data/template/spec/support/factory_bot.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/template/spec/support/mailer.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end

data/template/spec/support/shoulda.rb

@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/template/spec/support/system.rb

@@ -0,0 +1,17 @@
+require "capybara/rails"
+require "capybara/rspec"
+
+Capybara.default_max_wait_time = 2
+Capybara.disable_animation = true
+
+RSpec.configure do |config|
+  config.before(:each, type: :system) do
+    driven_by :selenium,
+      using: (ENV["SHOW_BROWSER"] ? :chrome : :headless_chrome),
+      screen_size: [1400, 1400] do |options|
+        # Allows running in Docker
+        options.add_argument("--disable-dev-shm-usage")
+        options.add_argument("--no-sandbox")
+      end
+  end
+end

data/template/test/application_system_test_case.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+require "capybara/rails"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium,
+    using: (ENV["SHOW_BROWSER"] ? :chrome : :headless_chrome),
+    screen_size: [1400, 1400] do |options|
+      # Allows running in Docker
+      options.add_argument("--disable-dev-shm-usage")
+      options.add_argument("--no-sandbox")
+    end
+
+  setup do
+    Capybara.default_max_wait_time = 2
+    Capybara.disable_animation = true
+    Capybara.server = :puma, {Silent: true}
+  end
+end

data/template/test/helpers/inline_svg_helper_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class InlineSvgHelperTest < ActionView::TestCase
+  test "inline_svg_tag returns contents of svg file as html_safe string" do
+    svg_result = inline_svg_tag("images/example.svg")
+    assert_predicate(svg_result, :html_safe?)
+    assert_equal(<<~EXPECTED_SVG.strip, svg_result)
+      <svg role="img" width="180" height="180" viewBox="0 0 180 180" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <rect x="2" y="2" width="176" height="176" rx="6" fill="white" stroke="#CCCCCC" stroke-width="4" stroke-miterlimit="0" stroke-linecap="round"/>
+      </svg>
+    EXPECTED_SVG
+  end
+
+  test "inline_svg_tag adds a <title> to the svg if specified" do
+    svg_result = inline_svg_tag("images/example.svg", title: "rounded box")
+    assert_equal(<<~EXPECTED_SVG.strip, svg_result)
+      <svg role="img" width="180" height="180" viewBox="0 0 180 180" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <title>rounded box</title>
+      <rect x="2" y="2" width="176" height="176" rx="6" fill="white" stroke="#CCCCCC" stroke-width="4" stroke-miterlimit="0" stroke-linecap="round"/>
+      </svg>
+    EXPECTED_SVG
+  end
+end

data/template/test/support/factory_bot.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:active_support_test_case) do
+  include FactoryBot::Syntax::Methods
+end

data/template/test/support/mailer.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:active_support_test_case) do
+  setup { ActionMailer::Base.deliveries.clear }
+end

data/template/test/support/shoulda.rb

@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :minitest
+    with.library :rails
+  end
+end

data/template/test/support/vite.rb

@@ -0,0 +1,5 @@
+return if ViteRuby.config.auto_build
+
+# Compile assets once at the start of testing
+millis = Benchmark.ms { ViteRuby.commands.build }
+puts format("Built Vite assets (%.1fms)", millis)