Skip to content

pr_description.md

Latest commit

 

History

History
213 lines (167 loc) · 6.25 KB

pr_description.md

File metadata and controls

213 lines (167 loc) · 6.25 KB

Summary

Reorganized repository into a monorepo structure to support multiple React on Rails demo applications with shared tooling, comprehensive version management, and robust automation scripts.

Key Changes

🏗️ Monorepo Structure

  • packages/shakacode-demo-common/ - Shared configuration and utilities (renamed from react_on_rails_shakacode-demo-common)
  • demos/ - Directory for demo applications (to be populated)
  • bin/ - Ruby executables for demo management (new-demo, scaffold-demo, update-all-demos)
  • scripts/ - Legacy bash scripts (kept for compatibility)
  • lib/demo_scripts/ - Ruby modules for demo creation with full RSpec test coverage
  • docs/ - Comprehensive documentation for contributors and version management

🔒 Security Fixes (PR Review)

  • ✅ Added input validation to prevent path traversal attacks in demo creation scripts
  • ✅ Fixed variable expansion syntax error in scaffold-demo.sh
  • ✅ Fixed subshell issue in test-all.sh that prevented failure tracking

📦 Package Renaming (Breaking Change)

  • Module: ReactOnRailsDemoCommon → DemoCommon
  • Files: lib/react_on_rails_shakacode-demo-common/ → lib/shakacode-demo-common/
  • Generator: react_on_rails_shakacode-demo-common:install → shakacode-demo-common:install
  • Updated all references throughout codebase
  • Updated README with correct monorepo installation examples

🛠️ Development Infrastructure

Ruby Scripts (Recommended):

  • bin/new-demo - Create basic demo with version control
  • bin/scaffold-demo - Create advanced demo with options
  • bin/update-all-demos - Bulk update gem versions across demos

Shared Dependencies:

  • Created Gemfile.development_dependencies for inherited dev gems
  • Demos use eval_gemfile pattern for consistency

Code Quality:

  • ✅ RuboCop configured and passing (0 offenses)
  • ✅ Prettier installed for code formatting
  • ✅ Lefthook pre-commit hooks for quality checks
  • ✅ Full RSpec test suite for Ruby scripts

📚 Documentation Updates

  • ✅ VERSION_MANAGEMENT.md - Comprehensive guide for managing gem versions
  • ✅ CONTRIBUTING_SETUP.md - Development setup and hooks
  • ✅ Updated all bash script references to Ruby programs
  • ✅ Added cypress-playwright-on-rails reference
  • ✅ Documented Gemfile.development_dependencies pattern

🎨 Code Formatting

  • Added Prettier at monorepo root with configuration
  • Formatted all markdown, YAML, JSON, and JavaScript files
  • Added npm scripts: npm run format and npm run format:check

🔧 Script Improvements

  • ✅ JavaScript dependencies now install after Rails generators
  • ✅ Scripts support both npm and pnpm
  • ✅ Dry-run mode for safe testing
  • ✅ Pre-flight checks (git status, directory existence)
  • ✅ Proper error handling and reporting

⚙️ CI/CD Configuration

  • Updated GitHub Actions workflow for monorepo structure
  • Fixed shallow clone issues for PR diffs
  • Proper shell quoting for robustness
  • Tests run selectively for changed demos (max 5)

Version Management

Global Defaults (.demo-versions)

SHAKAPACKER_VERSION="~> 8.0"
REACT_ON_RAILS_VERSION="~> 16.0"

Creating Demos

Basic demo:

bin/new-demo my-demo

With custom versions:

bin/new-demo my-demo \
  --shakapacker-version '~> 8.1' \
  --react-on-rails-version '~> 16.1'

Advanced scaffolding:

bin/scaffold-demo my-advanced-demo \
  --react-on-rails-version '16.0.0.beta.1'

With custom Rails/generator arguments:

bin/new-demo my-demo \
  --rails-args="--skip-test,--api" \
  --react-on-rails-args="--redux,--node"

Bulk Updates

bin/update-all-demos \
  --react-on-rails-version '~> 16.1' \
  --shakapacker-version '~> 8.1'

Breaking Changes

Module Rename

Before:

require 'react_on_rails_shakacode-demo-common'
ReactOnRailsDemoCommon.root
rails generate react_on_rails_shakacode-demo-common:install

After:

require 'shakacode-demo-common'
DemoCommon.root
rails generate shakacode-demo-common:install

Installation in Monorepo

Before:

gem 'react_on_rails_shakacode-demo-common', github: 'shakacode/react_on_rails_shakacode-demo-common'

After (within monorepo):

# In demo's Gemfile
eval_gemfile File.expand_path("../../Gemfile.development_dependencies", __dir__)
gem 'shakacode-demo-common', path: '../../packages/shakacode-demo-common'

After (from GitHub):

gem 'shakacode-demo-common', github: 'shakacode/react_on_rails-demos', glob: 'packages/shakacode-demo-common/*.gemspec'

Test Plan

  • ✅ All RSpec tests pass
  • ✅ RuboCop linting passes (0 offenses)
  • ✅ Prettier formatting applied
  • ✅ Demo creation scripts validated
  • ✅ Security vulnerabilities addressed
  • ✅ CI workflow updated and tested
  • ✅ Module renaming completed throughout codebase

Migration Guide

For existing consumers:

  1. Update Gemfile:

    # Old
gem 'react_on_rails_shakacode-demo-common', github: '...'

# New
gem 'shakacode-demo-common', github: 'shakacode/react_on_rails-demos', glob: 'packages/shakacode-demo-common/*.gemspec'

  2. Update require statements:

    # Old
require 'react_on_rails_shakacode-demo-common'

# New
require 'shakacode-demo-common'

  3. Update module references:

    # Old
ReactOnRailsDemoCommon.root

# New
DemoCommon.root

  4. Update generator commands:

    # Old
rails generate react_on_rails_shakacode-demo-common:install

# New
rails generate shakacode-demo-common:install

Future Enhancements

  • Git branch support in bin/new-demo (planned)
  • Additional demo templates
  • Automated demo deployment workflows
  • Integration with cypress-playwright-on-rails

Related Documentation

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com