archipelago-rails 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f916ab9e567301591e63ef33c6c2862e7fd545f27821d37d079c348fdf31489
-  data.tar.gz: e1a648f35bdd36fee3c0c798989a613663a1bfd7c336757bd73005c60417f10a
+  metadata.gz: 7f06023adb9b3ece8f7310941796040dbf5047e9e7521ef0bff4884f5c1605ac
+  data.tar.gz: 7febff261479925f0afb35bb3f0f661da1b26c6ca0b74f1a774bd1f3ce4b0230
 SHA512:
-  metadata.gz: ca210e1dd474885e9b322881e23ecc264ee038914de111080883e2198dd1a0dfe9f85eb6416ba72b7c6db9700fa61419003f94d6736043192c391ea2c1924317
-  data.tar.gz: 846fdc9686466a6ad5ca9a98b74ae5ca3ba9286878f5cedbc9b0410a739988558be826d10b2d49282835e6a675e010757263d4051fb35970924937db47689e5a
+  metadata.gz: 0c80efe03b03d744c2e7f2463efd78d0b7cdf825e4e5ec888aef7ccf17ec48e3960ef550259aded82e639645f655719a7fdf76c6e63bed1ce083c519cdb66af5
+  data.tar.gz: ab7d10432d6e247b3bfce8d3ab76894467c978ecdbfd40af479f55b001ce1cbc802b438e1689f9f1bd0b1aac3d99b6785bd954e7f40a2a5abf8d67a94ff28fbb

data/README.md

@@ -1,87 +1,330 @@
 # archipelago-rails
 
-Rails engine for Archipelago server-driven React islands.
+Rails engine for Archipelago — server-driven React islands with Inertia-style props, form handling, and real-time updates via ActionCable.
 
-## Supported Rails versions
+## Install
+
+Add to your Gemfile:
 
-- Rails `>= 7.1`
+```ruby
+gem "archipelago-rails"
+```
 
-## Development setup
+Then run the install generator:
 
 ```bash
-bundle install
+rails g archipelago:install
 ```
 
-## Run tests
+### React setup (esbuild)
 
 ```bash
-# full suite (core + rails integration tests)
-bin/test
-
-# split tasks
-bundle exec rake test:core
-bundle exec rake test:rails
+rails g archipelago:install:react
 ```
 
-## Rails version matrix (Appraisal)
+This scaffolds frontend bootstrap wiring. Options:
 
 ```bash
-bundle exec appraisal install
-bin/test-appraisal rails-7-1
-bin/test-appraisal rails-7-2
-bin/test-appraisal rails-8-1
+rails g archipelago:install:react --interactive=false --bundler=esbuild --typescript=true
+rails g archipelago:install:react --lazy_registry   # dynamic imports instead of eager
+rails g archipelago:install:react --install          # install npm packages immediately
+```
+
+## Core Concepts
+
+Archipelago lets you embed interactive React components ("islands") inside server-rendered Rails views. Each island receives **props from the server** and can call **server-side actions** that return updated props, errors, or redirects.
+
+```
+┌─────────────────────────────────────┐
+│  Rails View                         │
+│  ┌───────────────────┐              │
+│  │  React Island     │ ← props      │
+│  │  (TeamMembers)    │              │
+│  │  ┌─────────────┐  │              │
+│  │  │ Add Member  │──┼─→ Action     │
+│  │  │ Form        │  │   (server)   │
+│  │  └─────────────┘  │              │
+│  └───────────────────┘              │
+└─────────────────────────────────────┘
 ```
 
-## Notes
+## Building Actions
 
-- Controller/generator tests run against an in-test Rails application harness.
-- JS packages are tested from repository root via `yarn test`.
+Actions live in `app/islands/<component>/` and handle requests from island components.
 
-## Host app setup (React + esbuild)
+### Basic action
 
-After `rails g archipelago:install`, you can scaffold frontend bootstrap wiring:
+```ruby
+# app/islands/team_members/add_member.rb
+class TeamMembers::AddMember < Archipelago::Action
+  param :email, :string, required: true, strip: true, downcase: true
 
-```bash
-rails g archipelago:install:react
+  authorize { current_user.admin? }
+
+  def perform
+    member = Team.find(raw_params[:team_id]).members.create!(email: email)
+
+    props(
+      members: Team.find(raw_params[:team_id]).members.map { |m| { id: m.id, email: m.email } }
+    )
+  end
+end
 ```
 
-The generator writes `.npmrc` with:
+### Action lifecycle
+
+1. **Param coercion** — declared params are validated and coerced
+2. **Authorization** — the `authorize` block runs (raises `Forbidden` on failure)
+3. **`perform`** — your business logic executes
+4. **Response** — returns `ok` (with props), `error` (with field errors), `redirect`, or `forbidden`
+
+### Response helpers
+
+```ruby
+def perform
+  # Return updated props
+  props(members: [...])
+
+  # Or redirect
+  redirect_to "/teams/#{team.id}"
 
-```text
-@archipelago-js:registry=https://registry.npmjs.org
+  # Or add field errors
+  add_error(:email, "is already taken")
+end
 ```
 
-This keeps installs reliable across npm, Yarn classic, pnpm, and bun.
+### `current_user`
 
-By default this runs an interactive wizard with auto-detected defaults
-(bundler, TypeScript, package manager, and local monorepo path).
+Available in all actions, delegating to the configured user method:
 
-For esbuild apps, the wizard also enables auto-registry by default:
-- scans `app/javascript/islands/**/*.{js,jsx,ts,tsx}`
-- writes `app/javascript/archipelago/registry.generated.(js|ts)`
-- wires `package.json` esbuild scripts to run generator first
+```ruby
+def perform
+  team = current_user.teams.find(raw_params[:team_id])
+  # ...
+end
+```
 
-Useful options:
+### ActiveRecord::RecordInvalid
 
-```bash
-# disable prompts and use flags only
-rails g archipelago:install:react --interactive=false --bundler=esbuild --typescript=true
+Archipelago automatically catches `ActiveRecord::RecordInvalid` exceptions and maps them to field-level error responses.
 
-# force TSX output
-rails g archipelago:install:react --typescript=true
+## Params DSL
 
-# disable auto-registry and keep manual registry map in entry file
-rails g archipelago:install:react --auto_registry=false
+Declare expected parameters with type coercion, validation, and transformation:
 
-# install npm packages immediately
-rails g archipelago:install:react --install
+```ruby
+class TeamMembers::UpdateSettings < Archipelago::Action
+  param :name,     :string,  required: true, strip: true, min: 2, max: 100
+  param :email,    :string,  required: true, format: /\A[^@\s]+@[^@\s]+\z/
+  param :role,     :string,  required: true, in: %w[admin member viewer]
+  param :bio,      :string,  empty_as_nil: true
+  param :age,      :integer, min: 13, max: 150
+  param :score,    :float
+  param :active,   :boolean, default: true
+  param :tags,     :array,   of: :string
+  param :metadata, :json
+  param :starts_on, :date
+  param :due_at,    :datetime
+  param :nickname, :string, validate: ->(v) { "is offensive" if offensive?(v) }
 
-# install Archipelago packages from a local monorepo path
-rails g archipelago:install:react --install --local-monorepo-path=/absolute/path/to/cdx
+  # Params become methods: name, email, role, bio, etc.
+  def perform
+    user = current_user
+    user.update!(name: name, email: email, role: role, bio: bio)
+    props(user: serialize(user))
+  end
+end
 ```
 
-Manual refresh command (if needed while a long-running watch is already running):
+### Supported types
+
+| Type | Coercion |
+|------|----------|
+| `:string` | `String(value)` |
+| `:integer` | `Integer(value)` |
+| `:float` | `Float(value)` |
+| `:boolean` | `true/1/"1"/"true"/"on"/"yes"` → `true`, etc. |
+| `:date` | `Date.parse(value)` |
+| `:datetime` | `Time.parse(value)` |
+| `:array` | Pass-through or `JSON.parse`, with optional `of:` typed elements |
+| `:json` | Pass-through or `JSON.parse` |
+
+### Validation options
+
+| Option | Description |
+|--------|-------------|
+| `required: true` | Rejects blank/nil values |
+| `default: value` | Fallback when missing (supports lambdas) |
+| `strip: true` | Strip whitespace (strings only) |
+| `downcase: true` | Downcase (strings only) |
+| `upcase: true` | Upcase (strings only) |
+| `in: [...]` | Value must be in the list |
+| `format: /regex/` | String must match pattern |
+| `min: n` | Minimum value or length |
+| `max: n` | Maximum value or length |
+| `empty_as_nil: true` | Treat `""` / whitespace-only as `nil` |
+| `of: :type` | Element type for arrays |
+| `validate: ->(v) { ... }` | Custom validator; return error string or nil |
+
+## Authorization
+
+### Per-action authorization
+
+Every action should define an `authorize` block:
+
+```ruby
+class TeamMembers::AddMember < Archipelago::Action
+  authorize { current_user.admin? }
+
+  def perform
+    # ...
+  end
+end
+```
+
+When `authorize_by_default` is `true` (the default), actions without an `authorize` block raise `MissingAuthorization`.
+
+### Pundit adapter
+
+Include `Archipelago::PunditAdapter` for Pundit-style authorization:
+
+```ruby
+class TeamMembers::AddMember < Archipelago::Action
+  include Archipelago::PunditAdapter
+
+  authorize { authorize(@team, :add_member?) }
+
+  def perform
+    @team = Team.find(raw_params[:team_id])
+    authorize(@team) # infers query from action name
+    # ...
+  end
+end
+```
+
+The adapter provides:
+- `authorize(record, query = nil)` — raises `Forbidden` if policy denies
+- `policy(record)` — returns the policy instance
+
+### CanCan adapter
+
+Include `Archipelago::CanCanAdapter` for CanCan-style authorization:
+
+```ruby
+class TeamMembers::AddMember < Archipelago::Action
+  include Archipelago::CanCanAdapter
+
+  def perform
+    team = Team.find(raw_params[:team_id])
+    authorize!(:manage, team)
+    # ...
+  end
+end
+```
+
+The adapter provides:
+- `authorize!(action, record)` — raises `Forbidden` if ability denies
+- `current_ability` — returns the ability instance
+
+Configure the ability builder if you don't use a top-level `Ability` class:
+
+```ruby
+Archipelago.configure do |config|
+  config.current_ability = ->(user) { CustomAbility.new(user) }
+end
+```
+
+## Stream Authorization
+
+ActionCable streams can be authorized before subscription:
+
+```ruby
+Archipelago.configure do |config|
+  config.stream_authorizer = ->(connection:, stream_name:, params:) {
+    user = connection.current_user
+    # stream_name is e.g. "TeamMembers:42"
+    team_id = stream_name.split(":").last.to_i
+    user.teams.exists?(id: team_id)
+  }
+
+  # Reject all streams that don't pass through the authorizer
+  config.require_stream_authorization = true
+end
+```
+
+When `require_stream_authorization` is `true`, any stream without a configured authorizer is rejected. When `false` (default), streams are allowed unless an authorizer explicitly denies them.
+
+**Important:** If your streams carry tenant-specific or user-specific data, always configure a `stream_authorizer` or enable `require_stream_authorization`.
+
+## Configuration
+
+```ruby
+# config/initializers/archipelago.rb
+Archipelago.configure do |config|
+  config.root_namespace = "Islands"              # where actions live under app/islands/
+  config.current_user_method = :current_user     # controller method for current user
+  config.authorize_by_default = true             # require authorize blocks
+  config.strict_origin_check = false             # validate redirect origins
+  config.allowed_redirect_hosts = []             # allowed redirect hosts
+  config.stream_authorizer = nil                 # ActionCable stream auth lambda
+  config.require_stream_authorization = false    # reject unauthed streams
+  config.current_ability = nil                   # CanCan ability builder
+end
+```
+
+## Response Contract
+
+All action responses follow a standard JSON shape:
+
+```json
+// ok — updated props
+{ "status": "ok", "props": { ... }, "version": 1716000000000 }
+
+// error — field-level validation errors
+{ "status": "error", "errors": { "email": ["can't be blank"] } }
+
+// redirect
+{ "status": "redirect", "location": "/teams/1" }
+
+// forbidden
+{ "status": "forbidden" }
+```
+
+The `version` field is a monotonic timestamp used by the client to prevent stale broadcasts from overwriting newer data.
+
+## Streams & Broadcasting
+
+When a client sends the `X-Archipelago-Stream` header (or the legacy `__stream` param), successful action responses are automatically broadcast to all subscribers of that stream.
+
+On the client side, `useIslandProps({ stream: "TeamMembers:42" })` auto-subscribes to the stream and merges broadcast props into the component.
+
+## Supported Rails versions
+
+- Rails `>= 7.1`, `< 9.0`
+
+## Development
 
 ```bash
-yarn archipelago:registry
+bundle install
 ```
+
+### Run tests
+
+```bash
+bin/test                          # full suite
+bundle exec rake test:core        # core unit tests
+bundle exec rake test:rails       # rails integration tests
+```
+
+### Rails version matrix (Appraisal)
+
+```bash
+bundle exec appraisal install
+bin/test-appraisal rails-7-1
+bin/test-appraisal rails-7-2
+bin/test-appraisal rails-8-1
+```
+
+## License
+
+MIT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archipelago-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Archipelago