hub_kernel-interface 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a110bf3b15c7fbe91d280d688cadadb134e3e2ab7bbf2ef513d56b23ccbb94d6
-  data.tar.gz: eed0d2ced815810fb69566fcf8d23782855a9034c5ff4e9d498c9b18c82ca165
+  metadata.gz: 9ec695e1e219b18dba2295e8220f822ac9794349257dd4b3cbf25eafc48c28f8
+  data.tar.gz: 98594b01c83ef1d32d8ae54d46ad1a09f735476d619beeb4e6a19f21e2e2bda6
 SHA512:
-  metadata.gz: ce020e02f3fb14ac881793f935ddb4f2e25f5f9a848da3c15a7ebb8e64a285dcda66f235fe19bcda4fee37316e0d34bc00cbb191de458f08c890083644a6190c
-  data.tar.gz: e3468ec19dc532b3a6092084f9e7bb07d20a78072679f86976a946be4dd2ad439d4934add1168d2338a28b450659910f6ccd8a06c425ce3f72214c326a72f316
+  metadata.gz: f3761790ed1527d238b1e28b74ed0d696a4bbe158d27fb4627a8e98258764278de133390ac4575705aec1bfdd89c684dd8241367709bde4ebf683e118fe05063
+  data.tar.gz: 638b9ae5eb1dd64ab0ec9383c80744b23e3a709bdbad9e4f2bdfd1b39fa65fb2150cf630f7271daece97694c3cb40575e0edb3fcd66a3027dfa58d3b2a28504e

data/README.md

@@ -27,6 +27,19 @@ HubKernel::Authz.check = ->(person, action, account) { true }
 HubKernel::Context.scope = ->(account, &call) { call.call }
 ```
 
+A scope that declares a `person:` keyword is given the calling person as well as the account:
+
+```ruby
+HubKernel::Context.scope = ->(account, person:, &call) { call.call }
+```
+
+A hub method called by name reads the person who made the call, and reading it outside a call
+gives `nil`:
+
+```ruby
+HubKernel::Context.person
+```
+
 An interface gem lists the methods a person may call on an account, and calls one by name:
 
 ```ruby

data/lib/hub_kernel/context.rb

@@ -1,5 +1,15 @@
 module HubKernel
   module Context
     singleton_class.attr_accessor :scope
+
+    def self.person = Thread.current[:hub_kernel_person]
+
+    def self.with_person(person)
+      previous = self.person
+      Thread.current[:hub_kernel_person] = person
+      yield
+    ensure
+      Thread.current[:hub_kernel_person] = previous
+    end
   end
 end

data/lib/hub_kernel/exposes.rb

@@ -46,7 +46,7 @@ module HubKernel
       exposure = exposed(name) || raise(UnexposedMethodError, "#{exposing_hub} does not expose #{name}")
       refuse_unless_allowed(exposure, person, account)
       refuse_missing_values(exposure, values)
-      within_account(account) { public_send(exposure.name, **values.slice(*exposure.takes)) }
+      Context.with_person(person) { within_account(account, person) { public_send(exposure.name, **values.slice(*exposure.takes)) } }
     end
 
     def exposure_problems
@@ -83,12 +83,15 @@ module HubKernel
       answer
     end
 
-    def within_account(account, &call)
+    def within_account(account, person, &call)
       raise UnwiredPortError, "hub_kernel's account scope is not filled" unless Context.scope
+      return Context.scope.call(account, person: person, &call) if scope_takes_person?
 
       Context.scope.call(account, &call)
     end
 
+    def scope_takes_person? = (Context.scope.respond_to?(:parameters) ? Context.scope : Context.scope.method(:call)).parameters.any? { |kind, name| %i[key keyreq].include?(kind) && name == :person }
+
     def refuse_missing_values(exposure, values)
       missing = keywords(exposure, :keyreq) - values.keys
       raise MissingArgumentError, "Give #{missing.join(", ")}" if missing.any?

data/lib/hub_kernel/interface/version.rb

@@ -1,5 +1,5 @@
 module HubKernel
   module Interface
-    VERSION = "0.10.0"
+    VERSION = "0.11.0"
   end
 end

data/the_local/agents/hub_kernel-interface-develop.md

@@ -20,6 +20,7 @@ The contract between a hub and the interfaces that call it from outside the app.
 - `exposures_for` — returns the declarations the permission check lets a person call on an account.
 - `allows?` — asks the permission check whether a person may call one exposed method on an account, returning `true` or `false`.
 - `call_exposed` — calls an exposed method by name with a person, an account and its values, behind the permission check and inside the account scope, and returns the method's value.
+- `HubKernel::Context.person` — returns the person making the call by name, readable from inside a hub method, and `nil` outside a call.
 - `exposure_problems` — returns one message per declaration the hub has no method for, or whose values do not match the method's keywords.
 - `HubKernel::Interface.find` — returns the hub served at a name, or `nil`.
 - `HubKernel::Interface.served` — returns a hash of every served name to its hub.

data/the_local/agents/hub_kernel-interface-install.md

@@ -67,6 +67,7 @@ The contract between an app's hubs and the interfaces that call them from outsid
    - It must call the block exactly once, inside the scope.
    - It must return the block's value, since that value is what the call by name returns.
    - If the app has no account scoping, ask before using `->(account, &call) { call.call }`.
+   - A scope that also needs the calling person declares a `person:` keyword and is given both: `HubKernel::Context.scope = ->(account, person:, &call) { call.call }`. A scope taking only the account keeps working.
 
 6. Run `bin/rails runner 'p HubKernel::Interface.hubs, HubKernel::Authz.check, HubKernel::Context.scope'` and confirm it prints the hub list and two callables, none of them empty or `nil`.
 

data/the_local/interface.yml

@@ -15,6 +15,7 @@ develop:
   - allows?
   - call_exposed
   - exposure_problems
+  - HubKernel::Context.person
   - HubKernel::Interface.find
   - HubKernel::Interface.served
   - HubKernel::Interface.check!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hub_kernel-interface
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - tylercschneider