change_requests 0.2.0 → 0.2.2

data/lib/change_requests/models/concerns/actor_columns.rb

@@ -23,8 +23,11 @@ module ChangeRequests
       class_methods do
         # `label: false` for a reference that names who *may* act rather than who did - the
         # eligibility rows carry no snapshot, because nothing has happened yet to snapshot.
+        #
+        # `identity: true` also snapshots `config.actor_identity`, which is what lets the gem tell
+        # that Admin#7 and User#99 are one human. Null unless the host configured it (§9.4).
         def actor_reference(prefix, optional: false, allow_system: false, registry: :actor_types,
-                            label: true)
+                            label: true, identity: false)
           declare_type_validation(prefix, optional: optional, allow_system: allow_system,
                                           registry: registry)
 
@@ -33,7 +36,7 @@ module ChangeRequests
             validates :"#{prefix}_label", presence: true if label
           end
 
-          define_actor_accessors(prefix, registry: registry, label: label)
+          define_actor_accessors(prefix, registry: registry, label: label, identity: identity)
         end
 
         # QuorumPermission carries a type and nothing else: NULL there means "any registered class".
@@ -57,7 +60,7 @@ module ChangeRequests
                     allow_nil: true
         end
 
-        def define_actor_accessors(prefix, registry:, label:)
+        def define_actor_accessors(prefix, registry:, label:, identity:)
           generated = Module.new do
             # No `*_id=` override: the column is a string, so ActiveRecord already casts on
             # assignment. A User with a uuid key and an Admin with a bigint key share it (§5.7).
@@ -66,10 +69,11 @@ module ChangeRequests
 
               return nil if type.blank?
 
-              triple = { type: type, id: public_send(:"#{prefix}_id") }
-              triple[:label] = public_send(:"#{prefix}_label") if label
+              reference = { type: type, id: public_send(:"#{prefix}_id") }
+              reference[:label] = public_send(:"#{prefix}_label") if label
+              reference[:identity] = public_send(:"#{prefix}_identity") if identity
 
-              triple
+              reference
             end
 
             define_method(:"#{prefix}=") do |actor|
@@ -82,6 +86,8 @@ module ChangeRequests
               public_send(:"#{prefix}_type=", attributes[:type])
               public_send(:"#{prefix}_id=", attributes[:id])
               public_send(:"#{prefix}_label=", attributes[:label]) if label
+              public_send(:"#{prefix}_identity=", ChangeRequests.config.actor_identity&.call(actor)) \
+                if identity && actor
             end
           end
 

data/lib/change_requests/models/event.rb

@@ -41,6 +41,8 @@ module ChangeRequests
 
     # Expiry, the reaper and undeclared-operation cancellation have no actor. The sentinel keeps the
     # triple not-null so no presenter or export branches on nil.
-    def system_actor? = actor_type == SYSTEM_ACTOR[:type]
+    def system_actor?
+      actor_type == SYSTEM_ACTOR[:type]
+    end
   end
 end

data/lib/change_requests/models/quorum.rb

@@ -47,8 +47,13 @@ module ChangeRequests
     validates :name, format: { with: NAME_FORMAT }, allow_nil: true
     validates :name, uniqueness: { scope: :change_request_stage_id }, allow_nil: true
 
-    def any_match? = permission_match == "any"
-    def all_match? = permission_match == "all"
+    def any_match?
+      permission_match == "any"
+    end
+
+    def all_match?
+      permission_match == "all"
+    end
 
     # A nameless quorum has no display text of its own; the stage's label is the honest answer.
     def label

data/lib/change_requests/models/request.rb

@@ -23,7 +23,7 @@ module ChangeRequests
     # so the row stays readable once the actor and the payload's records are gone.
     readonly_after_create :operation_key, :operation_version, :service, :method_name,
                           :payload, :payload_labels,
-                          :requester_type, :requester_id, :requester_label,
+                          :requester_type, :requester_id, :requester_label, :requester_identity,
                           :tenant_type, :tenant_id,
                           :max_attempts
 
@@ -37,7 +37,7 @@ module ChangeRequests
     has_many :attempts, -> { order(:number) },
              class_name: "ChangeRequests::Attempt", inverse_of: :change_request
 
-    actor_reference :requester
+    actor_reference :requester, identity: true
     actor_reference :executer, optional: true
     actor_reference :tenant, optional: true, registry: :tenant_types
 
@@ -56,5 +56,14 @@ module ChangeRequests
     def current_stage
       stages.find_by(position: current_stage_position)
     end
+
+    # The attempts rows *are* the count; there is no counter column (§19.12). `max_attempts` is
+    # readonly after create and `>= 1` by CHECK, so there is no zero case to defend against.
+    #
+    # It answers "is there an attempt left", not "may this be executed" - Guards::Execute combines
+    # it with the status, and M3a's Commands::Execute and M3b's reaper both read it.
+    def retryable?
+      attempts.count < max_attempts
+    end
   end
 end

data/lib/change_requests/models/stage.rb

@@ -35,11 +35,18 @@ module ChangeRequests
                      format: { with: NAME_FORMAT },
                      uniqueness: { scope: :change_request_id }
 
-    def any_quorum? = satisfied_by == "any_quorum"
-    def all_quorums? = satisfied_by == "all_quorums"
+    def any_quorum?
+      satisfied_by == "any_quorum"
+    end
+
+    def all_quorums?
+      satisfied_by == "all_quorums"
+    end
 
     # Still accepting decisions. A closed stage is immutable and a rejected one stopped the request.
-    def open? = pending? || satisfied?
+    def open?
+      pending? || satisfied?
+    end
 
     # Display text, resolved separately from the identifier (§5.9).
     def label

data/lib/change_requests/operation.rb

@@ -25,11 +25,15 @@ module ChangeRequests
       @workflow       = Workflow.new
     end
 
-    def method_name = @method_name&.to_sym
+    def method_name
+      @method_name&.to_sym
+    end
 
     # The two defaults below resolve lazily: initializer order is the host's, and an operations file
     # that loads before the configuration file should still see the host's defaults.
-    def max_attempts = @max_attempts || ChangeRequests.config.default_max_attempts
+    def max_attempts
+      @max_attempts || ChangeRequests.config.default_max_attempts
+    end
 
     def expires_in
       return @expires_in if @expires_in_set

data/lib/change_requests/operations.rb

@@ -25,11 +25,21 @@ module ChangeRequests
 
     # nil, not a raise: every guard asks whether the declaration is still live, and §5.11 makes
     # that a refusal the guard words itself.
-    def [](key) = @operations[key.to_s]
+    def [](key)
+      @operations[key.to_s]
+    end
+
+    def keys
+      @operations.keys
+    end
 
-    def keys = @operations.keys
-    def each(&) = @operations.each_value(&)
-    def clear = @operations.clear
+    def each(&)
+      @operations.each_value(&)
+    end
+
+    def clear
+      @operations.clear
+    end
 
     private
 

data/lib/change_requests/translation.rb

@@ -15,6 +15,8 @@ module ChangeRequests
       I18n.translate(key, default: default)
     end
 
-    def available? = defined?(I18n) ? true : false
+    def available?
+      defined?(I18n) ? true : false
+    end
   end
 end

data/lib/change_requests/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChangeRequests
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/change_requests/workflow.rb

@@ -14,6 +14,8 @@ module ChangeRequests
       @stages = stages
     end
 
-    def empty? = stages.empty?
+    def empty?
+      stages.empty?
+    end
   end
 end

data/lib/change_requests.rb

@@ -19,13 +19,19 @@ module ChangeRequests
     # `unless mod.respond_to?(:table_name_prefix)`, and its version yields `change_requests_stages`.
     # `Request` is the one model that overrides its table name; it would derive
     # `change_request_requests`.
-    def table_name_prefix = "change_request_"
+    def table_name_prefix
+      "change_request_"
+    end
 
-    def config = @config ||= Configuration.new
+    def config
+      @config ||= Configuration.new
+    end
 
     # The declaration registry (§6.12). Memoised for the same reason as config: initializers
     # accumulate into it.
-    def operations = @operations ||= Operations.new
+    def operations
+      @operations ||= Operations.new
+    end
 
     # The (type, id, label) triple for a host record, with the label snapshotted through the
     # registered lambda. Raises before anything is constantized: the registry is the allowlist, and

data/lib/generators/change_requests/install/templates/migration.rb.tt

@@ -21,6 +21,7 @@ class CreateChangeRequests < ActiveRecord::Migration[<%= migration_version %>]
       t.string :requester_type, null: false
       t.string :requester_id, null: false
       t.string :requester_label, null: false
+      t.string :requester_identity
 
       t.string :executer_type
       t.string :executer_id
@@ -65,6 +66,10 @@ class CreateChangeRequests < ActiveRecord::Migration[<%= migration_version %>]
       t.string :status, null: false, default: "pending"
 
       t.datetime :satisfied_at, precision: 6
+      # The rejection's counterpart to satisfied_at: when the stage was stopped, and therefore when
+      # op.cooldown stops being able to give it back. Written from M9b; here from the first
+      # migration so no host needs a second one for it (PLAN §5.2, §7.1).
+      t.datetime :rejected_at, precision: 6
       t.datetime :closed_at, precision: 6
 
       t.timestamps precision: 6, null: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: change_requests
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andreas Finger
@@ -310,8 +310,32 @@ files:
 - Rakefile
 - config/routes.rb
 - docs/08_events_and_notifications.md
+- docs/adr/0001-headless-domain-core.md
+- docs/adr/0002-mountable-engine-with-isolated-namespace.md
+- docs/adr/0003-actor-references-as-triples.md
+- docs/adr/0004-uuid-primary-keys.md
+- docs/adr/0005-string-states-with-check-constraints.md
+- docs/adr/0006-creation-time-immutability.md
+- docs/adr/0007-append-only-audit-trail.md
+- docs/adr/0008-staged-multi-quorum-schema.md
+- docs/adr/0009-host-owned-schema.md
+- docs/adr/0010-operations-must-be-declared.md
+- docs/adr/0011-system-sentinel-actor.md
+- docs/adr/0012-declared-error-taxonomy.md
+- docs/adr/0013-json-runtime-pin.md
+- docs/adr/0014-executable-architecture-rules.md
+- docs/adr/README.md
 - lib/change_requests.rb
+- lib/change_requests/authorization/callable.rb
 - lib/change_requests/authorization/permissions.rb
+- lib/change_requests/commands/approve.rb
+- lib/change_requests/commands/base.rb
+- lib/change_requests/commands/cancel.rb
+- lib/change_requests/commands/comment.rb
+- lib/change_requests/commands/create.rb
+- lib/change_requests/commands/expire.rb
+- lib/change_requests/commands/reject.rb
+- lib/change_requests/commands/unapprove.rb
 - lib/change_requests/configuration.rb
 - lib/change_requests/configuration/actor_type.rb
 - lib/change_requests/configuration/registered_type.rb
@@ -319,6 +343,14 @@ files:
 - lib/change_requests/engine.rb
 - lib/change_requests/errors.rb
 - lib/change_requests/guards/.keep
+- lib/change_requests/guards/approve.rb
+- lib/change_requests/guards/base.rb
+- lib/change_requests/guards/cancel.rb
+- lib/change_requests/guards/comment.rb
+- lib/change_requests/guards/execute.rb
+- lib/change_requests/guards/expire.rb
+- lib/change_requests/guards/reject.rb
+- lib/change_requests/guards/unapprove.rb
 - lib/change_requests/models/.keep
 - lib/change_requests/models/approval.rb
 - lib/change_requests/models/approval_quorum.rb