sun-sword 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3549043ef82d7091d8e6d984f86eefaf03ea039f2844f34f2b4f73e308006e1
-  data.tar.gz: 7d311b8b6e938425160c8d83d9a4122c7ced6271cec8e361caf91156b407c99b
+  metadata.gz: e7f2301ad37844f511cef0f9439948ee35b7e74411e7a28989fcac4ff0ed3bb4
+  data.tar.gz: e37e5d005d3cb2fc82ce039570f9f6f5117c7347d4b1cc1c662df60b62fc85d3
 SHA512:
-  metadata.gz: 8d1e7a1946d73a1172608407db3d9edfb29d7832445cbd6eeb75bc648f05934250be28f1bc614b00e757a5984b08cd4ab82b8a22f60c994ad715bf0b21faa523
-  data.tar.gz: 9617f1d30d53033195b5387d677c79526db7744550529f51828a3b6470f2aca849b755e666c64190de81121d0e2880fbd0157be400f1789e2ec1a4f0e00f2fbb
+  metadata.gz: cbc03f139610daf61f3c260efac697aa0229aba1bccd608a1d207fccdf74254e43f639870a09d0f6b8ae80b6c21f3436e1ec935368934c65accf25a5d5fd2646
+  data.tar.gz: 88ea0d19496ba67f716f7d1479b99e03efb8191c4609bc3c08c5d7131cac98204e4a9f634a2572e548873f1fca0cc612b4db9a0780f82fa355418c5ac76c9d5e

data/CHANGELOG.md

@@ -1,5 +1,60 @@
+# 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).
+
 ## [Unreleased]
 
-## [0.1.0] - 2024-09-08
+### Changed
+- 🔄 Removed engine support from frontend generator only
+- 🔄 Scaffold generator retains full engine support with `--engine` and `--engine_structure` options
+- 📝 Updated documentation to clarify engine support differences
+
+## [0.0.12] - 2025-11-07
+
+### Added
+- ✨ Engine support for frontend generator with `--engine` option
+- ✨ Engine support for scaffold generator with `--engine` option
+- ✨ `--engine_structure` option to load structure files from different engines
+- ✨ Auto-detect engine paths (engines/, components/, gems/)
+- ✨ Multiple engine support for modular Rails applications
+- 📝 ENGINE_SUPPORT.md comprehensive documentation
+- 📝 Updated USAGE with engine examples
+
+### Changed
+- 🔄 Frontend generator now supports path_app helper for engine routing
+- 🔄 Scaffold generator now supports engine-specific paths
+- 🔄 Structure file path resolution supports engines
+- 📝 Updated README with engine usage examples
+
+### Fixed
+- 🐛 All path references now use helpers for engine compatibility
+
+## [0.0.11] - 2025-11-07
+
+### Changed
+- 🔄 Migrated from Yarn/NPM to Bun for faster package management
+- 🔄 Updated all `yarn` commands to `bun` commands
+- 📦 All frontend dependencies now installed via Bun
+
+### Added
+- ✨ RSpec structure matching rider-kick (co-located specs)
+- ✨ generator_spec gem for better generator testing
+- ✨ Support directory for test helpers
+- 📝 MIGRATION_TO_BUN.md documentation
+
+### Fixed
+- ✅ All 37 RSpec tests now passing
+- 🧹 Cleaned up root-level development artifacts
+
+## [0.0.1] - 2024-01-01
+
+### Added
+- 🎉 Initial release
+- ⚡ Vite + Tailwind v4 + Hotwire (Turbo + Stimulus) integration
+- 🎨 Frontend generator with modern stack
+- 📝 Scaffold generator for Clean Architecture
+- 🏗️ View scaffolds aligned with domain
 
-- Initial release

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sun-sword.gemspec
+gemspec
+
+group :development, :test do
+  gem 'byebug'
+  gem 'rubocop-performance'
+  gem 'rubocop-rails-omakase', require: false
+end
+# --- SunSword Package frontend
+gem 'stimulus-rails'
+gem 'turbo-rails'
+gem 'vite_rails'
+
+group :development do
+  gem 'listen'
+end

data/Gemfile.lock

@@ -0,0 +1,252 @@
+PATH
+  remote: .
+  specs:
+    sun-sword (0.0.12)
+      activesupport (>= 7.0, < 9.0)
+      hashie (>= 5.0, < 6.0)
+      thor (>= 1.2, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (8.1.1)
+      actionview (= 8.1.1)
+      activesupport (= 8.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.1.1)
+      activesupport (= 8.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    builder (3.3.0)
+    byebug (12.0.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.5)
+    crass (1.0.6)
+    date (3.5.0)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    dry-cli (1.3.0)
+    erb (6.0.0)
+    erubi (1.13.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    generator_spec (0.10.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    hashie (5.0.0)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.1)
+    irb (1.15.3)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.16.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.26.2)
+    mutex_m (0.3.0)
+    nokogiri (1.18.10-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.10-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.6.0)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.2.4)
+    rack-proxy (0.7.7)
+      rack
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.1)
+      actionpack (= 8.1.1)
+      activesupport (= 8.1.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rdoc (6.16.1)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.2)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rails-omakase (1.1.0)
+      rubocop (>= 1.72)
+      rubocop-performance (>= 1.24)
+      rubocop-rails (>= 2.30)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    stimulus-rails (1.3.4)
+      railties (>= 6.0.0)
+    stringio (3.1.9)
+    thor (1.4.0)
+    tsort (0.2.0)
+    turbo-rails (2.0.20)
+      actionpack (>= 7.1.0)
+      railties (>= 7.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    vite_rails (3.0.19)
+      railties (>= 5.1, < 9)
+      vite_ruby (~> 3.0, >= 3.2.2)
+    vite_ruby (3.9.2)
+      dry-cli (>= 0.7, < 2)
+      logger (~> 1.6)
+      mutex_m
+      rack-proxy (~> 0.6, >= 0.6.1)
+      zeitwerk (~> 2.2)
+    zeitwerk (2.7.3)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal (~> 2.5)
+  bundler (>= 2.4, < 3.0)
+  byebug
+  generator_spec (>= 0.9, < 1.0)
+  listen
+  rake (>= 13.0, < 14.0)
+  rspec (>= 3.12, < 4.0)
+  rubocop (>= 1.63, < 2.0)
+  rubocop-performance
+  rubocop-rails-omakase
+  stimulus-rails
+  sun-sword!
+  turbo-rails
+  vite_rails
+
+BUNDLED WITH
+   2.7.2

data/README.md

@@ -1,10 +1,35 @@
 # SunSword
+Rails generators for a **modern frontend stack**: Vite, Tailwind (v4), Hotwire (Turbo + Stimulus), plus view scaffolds aligned with your domain.
+
 This gem provides helper interfaces and classes to assist in the construction of application with
 Clean Architecture, as described in [Robert Martin's seminal book](https://www.amazon.com/gp/product/0134494164).
 
+---
+## ✨ Features
+
+- **One-shot frontend setup**  
+  Installs and wires **Vite**, **Tailwind v4**, **Turbo**, **Stimulus**, HMR, and sensible defaults using **Bun**.
+- **Scaffolded views & components**  
+  Opinionated but flexible ERB views, partials, and Stimulus controllers.
+- **Clean integration with Rails 8 + Vite Ruby**  
+  Ships `vite.config.ts`, `config/vite.json`, `Procfile.dev`, `bin/watch`, and entrypoints.
+- **Fast package management with Bun**  
+  All frontend dependencies (Vite, Tailwind, Turbo, Stimulus) are installed via Bun for maximum speed.
 
+---
 ## Installation
 
+### Prerequisites
+
+Make sure you have **Bun** installed on your system:
+
+```bash
+# Install Bun (if not already installed)
+curl -fsSL https://bun.sh/install | bash
+```
+
+### Add to Gemfile
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,32 +37,57 @@ gem 'rider-kick'
 gem 'sun-sword'
 ```
 
-
 And then execute:
 ```bash
-    $ rails generate sun_sword:frontend
+    $ bundle install
+    $ rails generate sun_sword:frontend --setup
     $ rubocop -A
 ```
+
+The generator will automatically install frontend dependencies using Bun.
+---
 ## Usage
+
+### Basic Usage
 ```bash
-Description:
-     Clean Architecture CRUD generator
-
-Example:
-    To Generate Frontend:
-        bin/rails  generate sun_sword:init
-        bin/rails  generate sun_sword:frontend --setup
-        
-    To Generate scaffold:
-        bin/rails  generate sun_sword:scaffold Models::Contact actor:user
-```
+# Init configuration
+bin/rails generate sun_sword:init
+
+# Setup frontend (main app only)
+bin/rails generate sun_sword:frontend --setup
+
+# Generate scaffold (main app)
+bin/rails generate sun_sword:scaffold user
+bin/rails generate sun_sword:scaffold product scope:dashboard
 
+# Generate scaffold (specific engine)
+bin/rails generate sun_sword:scaffold user --engine=admin
+
+# Generate to one engine, use structure from another
+bin/rails generate sun_sword:scaffold product --engine=api --engine_structure=core
+```
+---
+## Generated structure
+```text
+app/
+    frontend/
+      entrypoints/
+        application.js
+        stimulus.js
+      pages/
+        web.js
+        stimulus.js
+      stylesheets/
+        application.css   # Tailwind v4 style (@import, @plugin, @source)
+      assets/
+```
+---
 ## Philosophy
 
 The intention of this gem is to help you build applications that are built from the use case down,
 and decisions about I/O can be deferred until the last possible moment.
 
-## Clean Architecture
+### Clean Architecture
 This structure provides helper interfaces and classes to assist in the construction of application with Clean Architecture, as described in Robert Martin's seminal book.
 
 ```
@@ -54,7 +104,7 @@ This structure provides helper interfaces and classes to assist in the construct
     - use_cases (Just Usecase)
     - utils (Class Reusable)
 ```
-## Screaming architecture - use cases as an organisational principle
+### Screaming architecture - use cases as an organisational principle
 Uncle Bob suggests that your source code organisation should allow developers to easily find a listing of all use cases your application provides. Here's an example of how this might look in a this application.
 ```
 - app
@@ -82,4 +132,13 @@ Note that the use case name contains:
     # admin_fetch_info.rb [specific usecase]
     # fetch_info.rb [generic usecase] every role can access it
 ```
+---
+## Contributing
+
+- Fork & bundle install
+- ```bin/rails generate sun_sword:frontend --setup``` in a throwaway app to test changes
+- Add/adjust generator tests where possible
+- ```bundle exec rspec```
+- Open a PR 🎉
 
+See CONTRIBUTING.md for more.

data/Rakefile

@@ -1,12 +1,8 @@
-# frozen_string_literal: true
+# Rakefile
+require 'rspec/core/rake_task'
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = '{app,lib}/**/*_spec.rb'
+end
 
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: :spec

data/lib/generators/sun_sword/USAGE

@@ -1,10 +1,29 @@
 Description:
-     Clean Architecture CRUD generator
-     rails new jendral_jack -d=postgresql -T --skip-javascript --skip-asset-pipeline
+     Clean Architecture CRUD generator with Engine support (scaffold only)
+     rails new jendral_jack -d=postgresql -T --skip-javascript
 
 Example:
+    # Init configuration
     bin/rails generate sun_sword:init
+
+    # Frontend setup (main app only)
     bin/rails generate sun_sword:frontend --setup
-    bin/rails generate sun_sword:scaffold contacts<check in db/structure>
 
+    # Scaffold (main app)
+    bin/rails generate sun_sword:scaffold contacts
+    bin/rails generate sun_sword:scaffold products scope:dashboard
+
+    # Scaffold (specific engine)
+    bin/rails generate sun_sword:scaffold users --engine=admin
+
+    # Scaffold (engine with structure from another engine)
+    bin/rails generate sun_sword:scaffold products --engine=api --engine_structure=core
+
+Available Options:
+    --scope=SCOPE_NAME            # Generate files in specific scope directory
+    --engine=ENGINE_NAME          # Generate scaffold files to specific engine
+    --engine_structure=ENGINE     # Load structure file from specific engine
+
+Note: Structure files must be in db/structures/[name]_structure.yaml
+      For engines: [engine_path]/db/structures/[name]_structure.yaml