better_app_gen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 721659195e0a7e2ee4457d05891e43e3e013c98dabd09bbabbad900a3c4321d5
+  data.tar.gz: 602beed079b01394f79859d134fe3d45198a7a823fb8d6b761d48dbaa17d3cbe
+SHA512:
+  metadata.gz: 45ba11604764fd6aaf9ff589126a65f40096d49485dd6b71ec1b665a5005743c3f31c326bdb7416faaa3da59f8b3160415576c6f7b19ac66080d58eae96515b7
+  data.tar.gz: a8e81ffd71ccd05e32efec4807e52cfe49c7e4f49b324ae0bbb0f6a75775153b97597f371649c35d6c522deb128626f0f010b45a7de19bf59cb8effba6fb0e50

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,134 @@
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "bin/**/*"
+    - "vendor/**/*"
+    - "spec/fixtures/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/ClassLength:
+  Max: 200
+
+# RSpec cops
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+# Disable Capybara cops (not used)
+Capybara:
+  Enabled: false
+
+Capybara/RSpec:
+  Enabled: false
+
+Capybara/RSpec/PredicateMatcher:
+  Enabled: false
+
+# Override deprecated RSpec/Capybara/* cops (now Capybara/*)
+Capybara/CurrentPathExpectation:
+  Enabled: false
+Capybara/MatchStyle:
+  Enabled: false
+Capybara/NegationMatcher:
+  Enabled: false
+Capybara/SpecificActions:
+  Enabled: false
+Capybara/SpecificFinders:
+  Enabled: false
+Capybara/SpecificMatcher:
+  Enabled: false
+Capybara/VisibilityMatcher:
+  Enabled: false
+
+# Disable FactoryBot cops (not used)
+FactoryBot:
+  Enabled: false
+
+# Override deprecated RSpec/FactoryBot/* cops (now FactoryBot/*)
+FactoryBot/AttributeDefinedStatically:
+  Enabled: false
+FactoryBot/ConsistentParenthesesStyle:
+  Enabled: false
+FactoryBot/CreateList:
+  Enabled: false
+FactoryBot/FactoryClassName:
+  Enabled: false
+FactoryBot/FactoryNameStyle:
+  Enabled: false
+FactoryBot/IdSequence:
+  Enabled: false
+FactoryBot/RedundantFactoryOption:
+  Enabled: false
+FactoryBot/SyntaxMethods:
+  Enabled: false
+
+# Disable RSpec/Rails cops (not a Rails app)
+RSpecRails:
+  Enabled: false
+
+# Override deprecated RSpec/Rails/* cops (now RSpecRails/*)
+RSpecRails/AvoidSetupHook:
+  Enabled: false
+RSpecRails/HaveHttpStatus:
+  Enabled: false
+RSpecRails/HttpStatus:
+  Enabled: false
+RSpecRails/InferredSpecType:
+  Enabled: false
+RSpecRails/MinitestAssertions:
+  Enabled: false
+RSpecRails/NegationBeValid:
+  Enabled: false
+RSpecRails/TravelAround:
+  Enabled: false
+
+# Allow longer parameter lists for configuration objects
+Metrics/ParameterLists:
+  Max: 8
+
+# Allow higher complexity for CLI commands
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Allow predicate names without ?
+Naming/PredicateMethod:
+  Enabled: false
+
+# Allow more memoized helpers for orchestrator tests that need many mocks
+RSpec/MultipleMemoizedHelpers:
+  Max: 12

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-16
+
+### Added
+
+- Initial release of better_app_gen gem
+- CLI for generating Rails 8 applications with `new`, `check`, and `version` commands
+- Solid Stack integration (Cache, Queue, Cable) backed by PostgreSQL
+- Vite 7 + Tailwind CSS 4 + Stimulus frontend setup
+- Multi-database PostgreSQL configuration (primary, cache, queue, cable)
+- UUID primary keys by default across all models
+- Docker development environment with helper scripts (dc-up, dc-down, dc-shell, etc.)
+- Production Docker support with multi-stage Dockerfile, Thruster, Jemalloc, and YJIT
+- DEPLOY.md documentation for production deployments
+- Configurable locale support (en, it, de, fr, es, pt, nl, pl, ru, ja, zh)
+- Optional SimpleForm integration with Tailwind styling
+- Configurable Rails and Vite server ports
+- Comprehensive dependency checking (Ruby, Rails, Node, Yarn, Git, PostgreSQL)
+- Comprehensive test suite with SimpleCov coverage
+- better_vite_helper gem for improved Vite integration
+- CLAUDE.md for Claude Code guidance
+- GitHub Actions workflows for CI and release
+- RELEASE.md with release process documentation

data/CLAUDE.md

@@ -0,0 +1,84 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+BetterAppGen is a Ruby gem that generates Rails 8 applications with an opinionated, production-ready stack. It creates apps with Solid Stack (Cache, Queue, Cable backed by PostgreSQL), Vite 7 + Tailwind CSS 4, multi-database architecture, UUID primary keys, and Docker support.
+
+## Commands
+
+```bash
+# Install dependencies
+bin/setup
+
+# Run tests
+bundle exec rspec
+
+# Run a single test file
+bundle exec rspec spec/configuration_spec.rb
+
+# Run linter
+bundle exec rubocop
+
+# Auto-fix linting issues
+bundle exec rubocop -A
+
+# Test the CLI locally
+bundle exec bin/better_app_gen new test-app --skip-docker
+
+# Check dependencies
+bundle exec bin/better_app_gen check
+```
+
+## Architecture
+
+### Entry Points
+- `exe/better_app_gen` - CLI executable
+- `lib/better_app_gen.rb` - Main module, loads all components
+
+### Core Components
+- `lib/better_app_gen/cli.rb` - Thor-based CLI with `new`, `check`, `version` commands
+- `lib/better_app_gen/configuration.rb` - Immutable config object, validates app name, ports, locale
+- `lib/better_app_gen/app_generator.rb` - Orchestrator that runs generators in sequence
+- `lib/better_app_gen/dependency_checker.rb` - Validates Ruby, Rails, Node, Yarn, Git, PostgreSQL versions
+
+### Generators (`lib/better_app_gen/generators/`)
+Each generator inherits from `Base` and implements `generate!`:
+- `rails_app.rb` - Creates base Rails app with `rails new`
+- `gemfile.rb` - Adds gems (solid_cache, solid_queue, solid_cable, better_vite_helper, etc.)
+- `database.rb` - Multi-database config (primary, cache, queue, cable)
+- `solid_stack.rb` - Solid Cache/Queue/Cable configuration in config/application.rb
+- `vite.rb` - Vite + Tailwind CSS + Stimulus setup
+- `home_controller.rb` - HomeController with root route
+- `locale.rb` - i18n configuration
+- `docker.rb` - Docker development environment
+- `simple_form.rb` - Optional SimpleForm with Tailwind
+
+### Templates (`lib/better_app_gen/templates/`)
+ERB templates organized by destination path. Access config values via `@config` binding.
+
+## Key Patterns
+
+- **Bundler isolation**: Use `Bundler.with_unbundled_env` when running shell commands that need system gems (rails, yarn)
+- **Config access in templates**: Templates receive `@config` with methods like `app_name`, `app_name_pascal`, `rails_port`, `vite_port`, `locale`, `timezone`
+- **Locale handling**: Only `en` and `it` have translation templates; other locales trigger a warning
+
+## Supported Locales
+en, it, de, fr, es, pt, nl, pl, ru, ja, zh (only en/it include translation files)
+
+## Commit Convention
+Use conventional commits format:
+- `feat:` new feature
+- `fix:` bug fix
+- `docs:` documentation changes
+- `refactor:` code refactoring
+- `test:` adding/updating tests
+- `chore:` maintenance tasks
+- `ci:` CI/CD changes
+
+## Release
+See `RELEASE.md`. Automated via GitHub Actions:
+1. Run "Prepare Release" workflow with version
+2. Merge the PR
+3. Tag auto-created → publishes to RubyGems

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Pandev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,174 @@
+# BetterAppGen
+
+Generate Rails 8 applications with an opinionated, production-ready stack.
+
+## Features
+
+- **Solid Stack**: PostgreSQL-backed caching, jobs, and WebSockets (no Redis needed)
+  - Solid Cache for caching
+  - Solid Queue for background jobs
+  - Solid Cable for Action Cable
+- **Modern Frontend**: Vite 7 + Tailwind CSS 4 + Stimulus
+- **Multi-Database Architecture**: Separate databases for app, cache, queue, and cable
+- **UUID Primary Keys**: By default across all models
+- **Docker Development**: Complete Docker setup for development
+- **Production Docker**: Optimized multi-stage Dockerfile with Thruster, Jemalloc, and YJIT
+- **Configurable Locale**: Support for multiple languages (en, it, de, fr, es, pt, nl, pl, ru, ja, zh)
+
+## Installation
+
+```bash
+gem install better_app_gen
+```
+
+## Usage
+
+### Generate a New Application
+
+```bash
+# Basic usage (English locale, default ports)
+better_app_gen new my-app
+
+# With SimpleForm
+better_app_gen new my-app --with-simple-form
+
+# With Italian locale
+better_app_gen new my-app --locale it
+
+# Custom ports
+better_app_gen new my-app --rails-port 3001 --vite-port 5174
+
+# Skip Docker
+better_app_gen new my-app --skip-docker
+
+# Combine options
+better_app_gen new my-app --with-simple-form --locale it --rails-port 3001
+```
+
+### Check Dependencies
+
+```bash
+better_app_gen check
+```
+
+### View Version
+
+```bash
+better_app_gen version
+```
+
+## Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--with-simple-form` | false | Include SimpleForm with Tailwind CSS styling |
+| `--rails-port PORT` | 3000 | Rails server port |
+| `--vite-port PORT` | 5173 | Vite dev server port |
+| `--skip-docker` | false | Skip Docker configuration |
+| `--locale LOCALE` | en | Default locale (en, it, de, fr, es, pt, nl, pl, ru, ja, zh) |
+
+## Generated Application Structure
+
+```
+my-app/
+├── app/
+│   ├── assets/
+│   │   ├── javascripts/
+│   │   │   ├── application.js
+│   │   │   └── controllers/
+│   │   └── stylesheets/
+│   │       └── application.css
+│   ├── controllers/
+│   │   └── home_controller.rb
+│   ├── helpers/
+│   │   └── home_helper.rb
+│   └── views/
+│       ├── home/
+│       │   └── index.html.erb
+│       └── layouts/
+│           └── application.html.erb
+├── config/
+│   ├── application.rb
+│   ├── database.yml
+│   ├── initializers/
+│   │   └── better_vite_helper.rb
+│   └── routes.rb
+├── db/
+│   ├── migrate/
+│   ├── cache_migrate/
+│   ├── queue_migrate/
+│   └── cable_migrate/
+├── .docker/
+│   ├── Dockerfile.dev
+│   ├── Dockerfile.prod
+│   └── DEPLOY.md
+├── bin/
+│   ├── dev
+│   ├── docker-entrypoint
+│   └── docker-entrypoint.prod
+├── script/
+│   ├── dc-up
+│   ├── dc-down
+│   ├── dc-shell
+│   └── ...
+├── compose.yml
+├── compose.runner.yml
+├── vite.config.js
+├── postcss.config.js
+├── Procfile.dev
+└── ...
+```
+
+## Development Workflow
+
+### With Docker (Recommended)
+
+```bash
+cd my-app
+script/dc-up         # Start Docker containers
+script/dc-shell      # Open shell in Rails container
+rails db:create      # Create databases
+rails db:schema:load # Load schema
+exit                 # Exit shell
+script/dc-down && script/dc-up  # Restart containers
+```
+
+### Without Docker
+
+```bash
+cd my-app
+bundle install
+yarn install
+rails db:create db:schema:load
+bin/dev              # Start Rails + Vite
+```
+
+## Requirements
+
+- Ruby >= 3.2.0
+- Rails >= 8.0.0
+- Node.js >= 20.0.0
+- Yarn >= 4.0.0
+- PostgreSQL >= 16
+- Git
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+```bash
+git clone https://github.com/umbertopeserico/better_app_gen.git
+cd better_app_gen
+bin/setup
+rake spec
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbertopeserico/better_app_gen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/RELEASE.md

@@ -0,0 +1,25 @@
+# Release Process
+
+## Setup (one-time)
+
+Add `RUBYGEMS_API_KEY` secret in GitHub: Settings → Secrets → Actions
+
+Get your API key from https://rubygems.org/profile/api_keys
+
+## Release Steps
+
+### 1. Prepare Release
+Go to **Actions → Prepare Release → Run workflow** and enter the version (e.g., `0.2.0`)
+
+This creates a PR with:
+- Updated `lib/better_app_gen/version.rb`
+- Updated `CHANGELOG.md`
+
+### 2. Review and Merge
+Review the PR and merge to main.
+
+That's it! After merge:
+1. Tag is created automatically
+2. Tests run
+3. Gem is published to RubyGems
+4. GitHub Release is created

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/better_app_gen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "better_app_gen"
+
+BetterAppGen::CLI.start(ARGV)

data/lib/better_app_gen/app_generator.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "tty-spinner"
+require "pastel"
+
+module BetterAppGen
+  # Main orchestrator for generating a complete Rails application
+  class AppGenerator
+    attr_reader :config, :pastel
+
+    def initialize(config)
+      @config = config
+      @pastel = Pastel.new
+    end
+
+    def generate!
+      run_generator("Creating Rails application", Generators::RailsApp)
+      run_generator("Configuring Gemfile", Generators::Gemfile)
+      run_generator("Setting up database configuration", Generators::Database)
+      run_generator("Configuring Solid Stack", Generators::SolidStack)
+      run_generator("Setting up Vite + Tailwind CSS", Generators::Vite)
+      run_generator("Creating HomeController", Generators::HomeController)
+      run_generator("Configuring locale", Generators::Locale)
+      run_generator("Setting up Docker", Generators::Docker) unless config.skip_docker
+      run_generator("Configuring SimpleForm", Generators::SimpleForm) if config.with_simple_form
+      run_post_generation_tasks
+    end
+
+    private
+
+    def run_generator(description, generator_class)
+      spinner = TTY::Spinner.new("[:spinner] #{description}...", format: :dots)
+      spinner.auto_spin
+
+      begin
+        generator = generator_class.new(config)
+        generator.generate!
+        spinner.success(pastel.green("done"))
+      rescue StandardError => e
+        spinner.error(pastel.red("failed"))
+        raise e
+      end
+    end
+
+    def run_post_generation_tasks
+      spinner = TTY::Spinner.new("[:spinner] Installing dependencies...", format: :dots)
+      spinner.auto_spin
+
+      begin
+        Dir.chdir(config.app_path) do
+          # Run outside of bundler environment
+          Bundler.with_unbundled_env do
+            system("bundle install > /dev/null 2>&1")
+            system("yarn install > /dev/null 2>&1")
+          end
+        end
+        spinner.success(pastel.green("done"))
+      rescue StandardError => e
+        spinner.error(pastel.red("failed"))
+        raise e
+      end
+    end
+  end
+end
+
+# Require all generators
+require_relative "generators/rails_app"
+require_relative "generators/gemfile"
+require_relative "generators/database"
+require_relative "generators/solid_stack"
+require_relative "generators/vite"
+require_relative "generators/home_controller"
+require_relative "generators/locale"
+require_relative "generators/docker"
+require_relative "generators/simple_form"