nacelle 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6477e57d6d1fe634a3c9a940e14dcf5b988895683e987d56d37246b81994a3eb
-  data.tar.gz: 5c7d38c042003f3bc54c73806931c100fafcf259be9e923c36cb058301546ebc
+  metadata.gz: bc7d2280de3747f26a968df1e8862382c8e8ac5617ef3f9db4cf8159f8b2c249
+  data.tar.gz: 17cd8e85dd59919c94d15f07d08d0a51dbb5f8ad1a4e05d3d6267efde41e8a35
 SHA512:
-  metadata.gz: ba15b649933306bb4ac18d5fd3a7e42660394d0105d795df93b6b6d6ca283a330727e370b6a169c4315d6df8e23f334b9afa369a33aa478d25c9f349dd41da2d
-  data.tar.gz: a7f13c2431e3e8a9cc84246b28cfa5e1e0327c48d64dd462d71979d1ed68a944e8af0ba11e3f7b5d818bf14456374d474925e779fc195d282927dcbd30ca4bb6
+  metadata.gz: d5ce4bb55a621b8a014a4f76437ccd11015841dd2eb631a22fbdb389321d2009ff601b1a0e71c962a8c06122bec581a43d38a763adafc64a3ce0ad422cc91ebe
+  data.tar.gz: 398ed215fb0759151e64c7af48e516ea58d1c2c330cb05e06e145aeb32a9bd5411aafb1760b25e71bd01ee3e57caba50e8bfcece4dd09c6665250912ccb2da0f

data/.github/workflows/ci.yml

@@ -5,8 +5,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        gemfile: [ rails_7.0, rails_7.1, rails_7.2 ]
-        ruby: [ 3.1, 3.2, 3.3 ]
+        gemfile: [ rails_7.2, rails_8.0, rails_8.1 ]
+        ruby: [ 3.2, 3.3, 3.4 ]
 
     runs-on: ubuntu-latest
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps

data/Appraisals

@@ -1,12 +1,11 @@
-appraise "rails-7.0" do
-  gem "rails", "~>7.0.0"
+appraise "rails-7.2" do
+  gem "rails", "~>7.2.0"
 end
 
-appraise "rails-7.1" do
-  gem "rails", "~>7.1.0"
+appraise "rails-8.0" do
+  gem "rails", "~>8.0.0"
 end
 
-appraise "rails-7.2" do
-  gem "rails", "~>7.2.0"
+appraise "rails-8.1" do
+  gem "rails", "~>8.1.0"
 end
-

data/CLAUDE.md

@@ -0,0 +1,96 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Nacelle is a Rails engine that enables embedding dynamic cell components into CMS content. It works by parsing `<cell>` tags in HTML responses and replacing them with rendered cell content via a controller after filter.
+
+## Core Architecture
+
+### Cell Execution Flow
+
+1. **Request Processing**: HTML responses flow through `Nacelle::AfterFilter` global controller after filter (registered in `lib/nacelle.rb:11`)
+2. **Tag Parsing**: AfterFilter scans the response body for `<cell>` tags using regex and XML parsing (`lib/nacelle/after_filter.rb:38-46`)
+3. **Cell Instantiation**: Tags like `<cell name="my_account/form" />` are converted to `MyAccountCell#form` calls
+4. **Rendering**: Cells render their views from `app/cells/` directory structure
+
+### Key Components
+
+- **Nacelle::Cell** (`lib/nacelle/cell.rb`): Base class for all cells
+  - Provides controller context (request, session, cookies) to cells
+  - Implements custom rendering that looks up views in `app/cells/` directory
+  - Supports helper modules and helper methods
+  - Has cache key/timestamp methods for fragment caching
+
+- **Nacelle::AfterFilter** (`lib/nacelle/after_filter.rb`): Middleware that processes HTML responses
+  - Only processes `text/html` content types
+  - Parses `<cell name="cell_name/action" attr="value" />` tags
+  - Instantiates cell classes and invokes actions with attributes
+
+- **Nacelle::HasCells** (`lib/nacelle/has_cells.rb`): ActiveRecord mixin
+  - Use `has_cells :column_name` to scan model columns for embedded cells
+  - Returns array of cell classes found in the content
+
+- **Nacelle::CellsSerializer** (`lib/nacelle/cells_serializer.rb`): JSON API for CKEditor integration
+  - Endpoint at `/nacelle/cells.json` lists all available cells and their actions
+  - Discovers cells by requiring all files in `app/cells/*.rb`
+  - Optionally loads form HTML from `app/cells/{cell}/{action}_form.html.erb`
+
+### Cell Conventions
+
+- Cell classes must inherit from `Nacelle::Cell` to appear in CKEditor
+- Cell class names follow pattern: `{Name}Cell` (e.g., `TestCell`, `MyAccountCell`)
+- Cell views live in `app/cells/{cell_name}/{action}.html.erb`
+- Actions can accept zero arguments or a hash of attributes
+- Action methods are alphabetically ordered in the CKEditor menu
+
+## Development Commands
+
+### Running Tests
+```bash
+bundle exec rake          # Run all specs (default task)
+bundle exec rspec         # Run all specs
+bundle exec rspec spec/acceptance/nacelle_spec.rb  # Run specific spec file
+```
+
+### Testing Across Rails Versions
+```bash
+bundle exec appraisal install          # Install dependencies for all Rails versions
+bundle exec appraisal rails-7.1 rspec  # Run specs against specific Rails version
+```
+
+## Testing Setup
+
+The test suite uses RSpec with Capybara for acceptance testing. The spec creates a minimal Rails test app inline (`spec/acceptance/nacelle_spec.rb:5-16`) to test the engine's middleware behavior in a realistic environment.
+
+When writing new tests:
+- Place acceptance tests in `spec/acceptance/`
+- The test app is configured with `secret_key_base`, `eager_load: false`, and `hosts: nil`
+- Test cells should inherit from `Nacelle::Cell` and set `view_path` appropriately
+
+## File Structure
+
+```
+lib/nacelle/
+  ├── cell.rb              # Base cell class with rendering logic
+  ├── after_filter.rb      # Middleware for processing <cell> tags
+  ├── has_cells.rb         # ActiveRecord mixin for scanning content
+  └── cells_serializer.rb  # JSON API for CKEditor integration
+
+app/
+  ├── controllers/nacelle/
+  │   └── cells_controller.rb  # Serves JSON list of cells
+  └── assets/javascripts/
+      ├── nacelle/ckeditor.js       # CKEditor integration entry point
+      └── ckeditor/plugins/cells/   # CKEditor plugin for inserting cells
+```
+
+## Important Implementation Details
+
+- Cell tag parsing uses `Hash.from_xml` (requires Nokogiri backend)
+- The AfterFilter runs on all ActionController::Base after_actions
+- Cell names in tags use underscore format: `<cell name="my_account/form" />`
+- Cell classes use CamelCase: `MyAccountCell`
+- Action arity is checked to determine whether to pass attributes hash
+- Missing cells/actions render error message: `<strong>Cell "{name} {action}" not found!</strong>`

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in nacelle.gemspec
 gemspec
 
-gem "rails", "~>7.1.0"
+gem "rails", "~>8.0.0"

data/gemfiles/rails_7.2.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "rails", "~>7.2.0"
-gem "sprockets", "~>3.0"
 
 gemspec path: "../"

data/gemfiles/rails_7.2.gemfile.lock

@@ -1,74 +1,77 @@
 PATH
   remote: ..
   specs:
-    nacelle (0.5.0)
+    nacelle (0.6.0)
       rails
       sprockets-rails
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.2.1)
-      actionpack (= 7.2.1)
-      activesupport (= 7.2.1)
+    actioncable (7.2.3)
+      actionpack (= 7.2.3)
+      activesupport (= 7.2.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.2.1)
-      actionpack (= 7.2.1)
-      activejob (= 7.2.1)
-      activerecord (= 7.2.1)
-      activestorage (= 7.2.1)
-      activesupport (= 7.2.1)
+    actionmailbox (7.2.3)
+      actionpack (= 7.2.3)
+      activejob (= 7.2.3)
+      activerecord (= 7.2.3)
+      activestorage (= 7.2.3)
+      activesupport (= 7.2.3)
       mail (>= 2.8.0)
-    actionmailer (7.2.1)
-      actionpack (= 7.2.1)
-      actionview (= 7.2.1)
-      activejob (= 7.2.1)
-      activesupport (= 7.2.1)
+    actionmailer (7.2.3)
+      actionpack (= 7.2.3)
+      actionview (= 7.2.3)
+      activejob (= 7.2.3)
+      activesupport (= 7.2.3)
       mail (>= 2.8.0)
       rails-dom-testing (~> 2.2)
-    actionpack (7.2.1)
-      actionview (= 7.2.1)
-      activesupport (= 7.2.1)
+    actionpack (7.2.3)
+      actionview (= 7.2.3)
+      activesupport (= 7.2.3)
+      cgi
       nokogiri (>= 1.8.5)
       racc
-      rack (>= 2.2.4, < 3.2)
+      rack (>= 2.2.4, < 3.3)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actiontext (7.2.1)
-      actionpack (= 7.2.1)
-      activerecord (= 7.2.1)
-      activestorage (= 7.2.1)
-      activesupport (= 7.2.1)
+    actiontext (7.2.3)
+      actionpack (= 7.2.3)
+      activerecord (= 7.2.3)
+      activestorage (= 7.2.3)
+      activesupport (= 7.2.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.2.1)
-      activesupport (= 7.2.1)
+    actionview (7.2.3)
+      activesupport (= 7.2.3)
       builder (~> 3.1)
+      cgi
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.2.1)
-      activesupport (= 7.2.1)
+    activejob (7.2.3)
+      activesupport (= 7.2.3)
       globalid (>= 0.3.6)
-    activemodel (7.2.1)
-      activesupport (= 7.2.1)
-    activerecord (7.2.1)
-      activemodel (= 7.2.1)
-      activesupport (= 7.2.1)
+    activemodel (7.2.3)
+      activesupport (= 7.2.3)
+    activerecord (7.2.3)
+      activemodel (= 7.2.3)
+      activesupport (= 7.2.3)
       timeout (>= 0.4.0)
-    activestorage (7.2.1)
-      actionpack (= 7.2.1)
-      activejob (= 7.2.1)
-      activerecord (= 7.2.1)
-      activesupport (= 7.2.1)
+    activestorage (7.2.3)
+      actionpack (= 7.2.3)
+      activejob (= 7.2.3)
+      activerecord (= 7.2.3)
+      activesupport (= 7.2.3)
       marcel (~> 1.0)
-    activesupport (7.2.1)
+    activesupport (7.2.3)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -84,10 +87,11 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (3.3.1)
     builder (3.3.0)
-    byebug (11.1.3)
+    byebug (12.0.0)
     capybara (3.40.0)
       addressable
       matrix
@@ -97,128 +101,141 @@ GEM
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
+    cgi (0.5.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
     crass (1.0.6)
-    date (3.3.4)
-    diff-lcs (1.5.1)
-    drb (2.2.1)
-    erubi (1.13.0)
-    globalid (1.2.1)
+    date (3.5.0)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (5.1.3)
+    erubi (1.13.1)
+    globalid (1.3.0)
       activesupport (>= 6.1)
-    i18n (1.14.5)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    io-console (0.7.2)
-    irb (1.14.0)
+    io-console (0.8.1)
+    irb (1.15.3)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    logger (1.6.0)
-    loofah (2.22.0)
+    logger (1.7.0)
+    loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mail (2.8.1)
+    mail (2.9.0)
+      logger
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.4)
-    matrix (0.4.2)
+    marcel (1.1.0)
+    matrix (0.4.3)
     mini_mime (1.1.5)
-    minitest (5.25.1)
-    net-imap (0.4.14)
+    minitest (5.26.0)
+    net-imap (0.5.12)
       date
       net-protocol
     net-pop (0.1.2)
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.5.0)
+    net-smtp (0.5.1)
       net-protocol
-    nio4r (2.7.3)
-    nokogiri (1.16.7-x86_64-linux)
+    nio4r (2.7.5)
+    nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
-    psych (5.1.2)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.6)
+      date
       stringio
-    public_suffix (6.0.1)
+    public_suffix (6.0.2)
     racc (1.8.1)
-    rack (2.2.9)
-    rack-session (1.0.2)
-      rack (< 3)
-    rack-test (2.1.0)
+    rack (3.2.4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
       rack (>= 1.3)
-    rackup (1.0.0)
-      rack (< 3)
-      webrick
-    rails (7.2.1)
-      actioncable (= 7.2.1)
-      actionmailbox (= 7.2.1)
-      actionmailer (= 7.2.1)
-      actionpack (= 7.2.1)
-      actiontext (= 7.2.1)
-      actionview (= 7.2.1)
-      activejob (= 7.2.1)
-      activemodel (= 7.2.1)
-      activerecord (= 7.2.1)
-      activestorage (= 7.2.1)
-      activesupport (= 7.2.1)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.2.3)
+      actioncable (= 7.2.3)
+      actionmailbox (= 7.2.3)
+      actionmailer (= 7.2.3)
+      actionpack (= 7.2.3)
+      actiontext (= 7.2.3)
+      actionview (= 7.2.3)
+      activejob (= 7.2.3)
+      activemodel (= 7.2.3)
+      activerecord (= 7.2.3)
+      activestorage (= 7.2.3)
+      activesupport (= 7.2.3)
       bundler (>= 1.15.0)
-      railties (= 7.2.1)
-    rails-dom-testing (2.2.0)
+      railties (= 7.2.3)
+    rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
+    rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.2.1)
-      actionpack (= 7.2.1)
-      activesupport (= 7.2.1)
+      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 (7.2.3)
+      actionpack (= 7.2.3)
+      activesupport (= 7.2.3)
+      cgi
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
       zeitwerk (~> 2.6)
-    rake (13.2.1)
-    rdoc (6.7.0)
+    rake (13.3.1)
+    rdoc (6.15.1)
+      erb
       psych (>= 4.0.0)
-    regexp_parser (2.9.2)
-    reline (0.5.9)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.2)
       io-console (~> 0.5)
-    rspec (3.13.0)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.2)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    securerandom (0.3.1)
-    sprockets (3.7.3)
-      base64
+    rspec-support (3.13.6)
+    securerandom (0.4.1)
+    sprockets (4.2.2)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
+      logger
+      rack (>= 2.2.4, < 4)
     sprockets-rails (3.5.2)
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    stringio (3.1.1)
-    thor (1.3.1)
-    timeout (0.4.1)
+    stringio (3.1.7)
+    thor (1.4.0)
+    timeout (0.4.4)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    useragent (0.16.10)
-    webrick (1.8.1)
-    websocket-driver (0.7.6)
+    useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.6.17)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   x86_64-linux
@@ -232,7 +249,6 @@ DEPENDENCIES
   rails (~> 7.2.0)
   rake
   rspec
-  sprockets (~> 3.0)
 
 BUNDLED WITH
    2.4.19

data/gemfiles/{rails_7.0.gemfile → rails_8.0.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~>7.0.0"
-gem "sprockets", "~>3.0"
+gem "rails", "~>8.0.0"
 
 gemspec path: "../"