archipelago-rails 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f06023adb9b3ece8f7310941796040dbf5047e9e7521ef0bff4884f5c1605ac
-  data.tar.gz: 7febff261479925f0afb35bb3f0f661da1b26c6ca0b74f1a774bd1f3ce4b0230
+  metadata.gz: cc3ff097bdcb50e59b6ace832f59db53b77d1bf2d4d50e10da0595b38804afbd
+  data.tar.gz: cd849b78be869b5626e4582ddd8966be6626bce1540dcb7cb2b1613ebf238d03
 SHA512:
-  metadata.gz: 0c80efe03b03d744c2e7f2463efd78d0b7cdf825e4e5ec888aef7ccf17ec48e3960ef550259aded82e639645f655719a7fdf76c6e63bed1ce083c519cdb66af5
-  data.tar.gz: ab7d10432d6e247b3bfce8d3ab76894467c978ecdbfd40af479f55b001ce1cbc802b438e1689f9f1bd0b1aac3d99b6785bd954e7f40a2a5abf8d67a94ff28fbb
+  metadata.gz: 92f4432fa77ce8ee1442c210a29dbee01c22e6dac9958c7f1652290a1d9e5cde97eff943276e9d755beeff6c601958370d4a6c4c4a601fad1399a133c91df437
+  data.tar.gz: 12efedc0b57f6d59fc3a3edca4e08f51c93f3fb07a727f606939c2cca39cdc3106558ceb0a2cc11c5728f38f4f2325d431eb7635e0f338e6f566eba304f5cfe3

data/README.md

@@ -57,15 +57,17 @@ Actions live in `app/islands/<component>/` and handle requests from island compo
 ```ruby
 # app/islands/team_members/add_member.rb
 class TeamMembers::AddMember < Archipelago::Action
-  param :email, :string, required: true, strip: true, downcase: true
+  param :team_id, :integer, required: true
+  param :email,   :string,  required: true, strip: true, downcase: true
 
-  authorize { current_user.admin? }
+  authorize { current_user.teams.exists?(id: team_id) }
 
   def perform
-    member = Team.find(raw_params[:team_id]).members.create!(email: email)
+    team = current_user.teams.find(team_id)
+    team.members.create!(email: email)
 
     props(
-      members: Team.find(raw_params[:team_id]).members.map { |m| { id: m.id, email: m.email } }
+      members: team.members.map { |m| { id: m.id, email: m.email } }
     )
   end
 end
@@ -73,7 +75,7 @@ end
 
 ### Action lifecycle
 
-1. **Param coercion** — declared params are validated and coerced
+1. **Param coercion** — declared params are validated and coerced into typed accessors
 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`
@@ -82,14 +84,11 @@ end
 
 ```ruby
 def perform
-  # Return updated props
-  props(members: [...])
+  props(members: [...])         # return updated props
 
-  # Or redirect
-  redirect_to "/teams/#{team.id}"
+  redirect_to "/teams/#{team_id}" # or redirect
 
-  # Or add field errors
-  add_error(:email, "is already taken")
+  add_error(:email, "is already taken") # or add field errors
 end
 ```
 
@@ -99,7 +98,7 @@ Available in all actions, delegating to the configured user method:
 
 ```ruby
 def perform
-  team = current_user.teams.find(raw_params[:team_id])
+  project = current_user.projects.find(project_id)
   # ...
 end
 ```
@@ -192,12 +191,13 @@ Include `Archipelago::PunditAdapter` for Pundit-style authorization:
 class TeamMembers::AddMember < Archipelago::Action
   include Archipelago::PunditAdapter
 
-  authorize { authorize(@team, :add_member?) }
+  param :team_id, :integer, required: true
 
   def perform
-    @team = Team.find(raw_params[:team_id])
-    authorize(@team) # infers query from action name
-    # ...
+    team = current_user.teams.find(team_id)
+    authorize(team) # infers query from action class name
+    team.members.create!(email: email)
+    props(members: team.members.as_json)
   end
 end
 ```
@@ -214,10 +214,13 @@ Include `Archipelago::CanCanAdapter` for CanCan-style authorization:
 class TeamMembers::AddMember < Archipelago::Action
   include Archipelago::CanCanAdapter
 
+  param :team_id, :integer, required: true
+
   def perform
-    team = Team.find(raw_params[:team_id])
+    team = current_user.teams.find(team_id)
     authorize!(:manage, team)
-    # ...
+    team.members.create!(email: email)
+    props(members: team.members.as_json)
   end
 end
 ```
@@ -325,6 +328,12 @@ bin/test-appraisal rails-7-2
 bin/test-appraisal rails-8-1
 ```
 
+## Stability
+
+This library follows [Semantic Versioning](https://semver.org/). The public API surface — `Archipelago::Action`, the Params DSL, `authorize`, response helpers (`props`, `redirect_to`, `add_error`), configuration options, stream authorization, and the Pundit/CanCan adapter interfaces — is considered stable. Breaking changes will only occur in major version bumps.
+
+Internal modules, resolver internals, and the `raw_params` hash shape are not part of the public contract and may change in minor releases.
+
 ## License
 
 MIT

data/test/archipelago/resolver_test.rb

@@ -77,4 +77,13 @@ class ResolverTest < ArchipelagoTestCase
       Archipelago::Resolver.new.resolve(component: "UnknownIsland", operation: "add_member")
     end
   end
+
+  def test_rejects_handler_that_does_not_inherit_from_action
+    not_an_action = Class.new
+    Archipelago.map "TeamMembers#not_action" => not_an_action
+
+    assert_raises(Archipelago::ResolutionError) do
+      Archipelago::Resolver.new.resolve(component: "TeamMembers", operation: "not_action")
+    end
+  end
 end

metadata

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