granite 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17fb5bd6029503d159cdb3e5dd88d0f58961a30e81e1752327bc261733c62df9
-  data.tar.gz: cf15fd7b77203667a28c57ede076ee17a1df1014eca1cf97f15cc6efc2a3755a
+  metadata.gz: d0524a0055b0ea48aeab0691a1063cf332455b87094e2a78dbb6b66cc24b168e
+  data.tar.gz: e07a9c6a636eed28916860e213beea548aa92943da442b7d39019b346079e3fc
 SHA512:
-  metadata.gz: 3540905bc5f0198b002bfd0be1c7a2dca41b594c6a21538c4cfa0763d85fe770fafb45227fb6f28b73e206b63dfe302a3cbe04af97cfe1e1f055f9adaa48f4dc
-  data.tar.gz: f8837fc5c591f9c4169bcf60f6c6c9de8a3158e66c52d961b871f8bfe753f63ee353d7e560fa7fd3cb8667656fb30da01acf2065377ea50d6162f74ce8757202
+  metadata.gz: 217ac1d410c18e838f648af770c610b24ad4a28fc70e37514060509b5ac0a9303907912da5a2e7151162df2d842c78cdf3dd4c03e64ae464427bea9707923410
+  data.tar.gz: 2824f499e042ce4df4565d450367ccf3c33b711586c496c752fde675c4a1bd4d2a5810b92c84916603436981ef61c100583d89865e7f5c758c5033fbc3d97e20

data/app/controllers/granite/controller.rb

@@ -14,11 +14,12 @@ module Granite
     before_action :authorize_action!
 
     def projector
-      @projector ||= begin
-        action_projector_class = action_class.public_send(projector_name)
-        action_projector_class = action_projector_class.as(projector_performer) if respond_to?(:projector_performer, true)
-        action_projector_class.new(projector_params)
-      end
+      @projector ||=
+        begin
+          projector_class = action_class.public_send(projector_name)
+          projector_class = projector_class.with(projector_context) if respond_to?(:projector_context, true)
+          projector_class.new(projector_params)
+        end
     end
     helper_method :projector
 

data/lib/granite/action/instrumentation.rb

@@ -0,0 +1,23 @@
+module Granite
+  class Action
+    module Instrumentation
+      def perform!(*, **)
+        instrument_perform(:perform!) { super }
+      end
+
+      def perform(*, **)
+        instrument_perform(:perform) { super }
+      end
+
+      def try_perform!(*, **)
+        instrument_perform(:try_perform!) { super }
+      end
+
+      private
+
+      def instrument_perform(using, &block)
+        ActiveSupport::Notifications.instrument('granite.perform_action', action: self, using: using, &block)
+      end
+    end
+  end
+end

data/lib/granite/action/performer.rb

@@ -1,4 +1,4 @@
-require 'granite/performer_proxy'
+require 'granite/context_proxy'
 
 module Granite
   class Action
@@ -8,15 +8,16 @@ module Granite
       extend ActiveSupport::Concern
 
       included do
-        include PerformerProxy
-        attr_reader :performer
+        include ContextProxy
+        attr_reader :ctx
       end
 
       def initialize(*args)
-        @performer = self.class.proxy_performer
+        @ctx = self.class.proxy_context
         super
       end
 
+      delegate :performer, to: :ctx, allow_nil: true
       delegate :id, to: :performer, prefix: true, allow_nil: true
     end
   end

data/lib/granite/action.rb

@@ -5,6 +5,7 @@ require 'active_support/callbacks'
 
 require 'granite/action/types'
 require 'granite/action/error'
+require 'granite/action/instrumentation'
 require 'granite/action/performing'
 require 'granite/action/performer'
 require 'granite/action/precondition'
@@ -48,6 +49,7 @@ module Granite
     include Policies
     include Projectors
     prepend AssignAttributes
+    prepend Instrumentation
 
     handle_exception ActiveRecord::RecordInvalid do |e|
       merge_errors(e.record.errors)

data/lib/granite/context_proxy/data.rb

@@ -0,0 +1,20 @@
+module Granite
+  module ContextProxy
+    # Contains all the arbitrary data that is passed to BA with `with`
+    class Data
+      attr_reader :performer
+
+      def self.wrap(data)
+        if data.is_a?(self)
+          data
+        else
+          new(**data || {})
+        end
+      end
+
+      def initialize(performer: nil)
+        @performer = performer
+      end
+    end
+  end
+end

data/lib/granite/{performer_proxy → context_proxy}/proxy.rb

@@ -1,23 +1,22 @@
 module Granite
-  module PerformerProxy
-    # Proxy helps to wrap the following method call with
-    # performer-enabled context.
+  module ContextProxy
+    # Proxy which wraps the following method calls with BA context.
     #
     class Proxy
       extend Granite::Ruby3Compatibility
 
-      def initialize(klass, performer)
+      def initialize(klass, context)
         @klass = klass
-        @performer = performer
+        @context = context
       end
 
       def inspect
-        "<#{@klass}PerformerProxy #{@performer}>"
+        "<#{@klass}ContextProxy #{@context}>"
       end
 
       ruby2_keywords def method_missing(method, *args, &block)
         if @klass.respond_to?(method)
-          @klass.with_proxy_performer(@performer) do
+          @klass.with_context(@context) do
             @klass.public_send(method, *args, &block)
           end
         else

data/lib/granite/context_proxy.rb

@@ -0,0 +1,34 @@
+require 'granite/context_proxy/data'
+require 'granite/context_proxy/proxy'
+
+module Granite
+  # This concern contains class methods used for actions and projectors
+  #
+  module ContextProxy
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      PROXY_CONTEXT_KEY = :granite_proxy_context
+
+      def with(data)
+        Proxy.new(self, Data.wrap(data))
+      end
+
+      def as(performer)
+        with(performer: performer)
+      end
+
+      def with_context(context)
+        old_context = proxy_context
+        Thread.current[PROXY_CONTEXT_KEY] = context
+        yield
+      ensure
+        Thread.current[PROXY_CONTEXT_KEY] = old_context
+      end
+
+      def proxy_context
+        Thread.current[PROXY_CONTEXT_KEY]
+      end
+    end
+  end
+end

data/lib/granite/projector.rb

@@ -2,11 +2,11 @@ require 'granite/projector/controller_actions'
 require 'granite/projector/error'
 require 'granite/projector/helpers'
 require 'granite/projector/translations'
-require 'granite/performer_proxy'
+require 'granite/context_proxy'
 
 module Granite
   class Projector
-    include PerformerProxy
+    include ContextProxy
     include ControllerActions
     include Helpers
     include Translations
@@ -42,7 +42,7 @@ module Granite
     private
 
     def build_action(*args)
-      action_class.as(self.class.proxy_performer).new(*args)
+      action_class.with(self.class.proxy_context).new(*args)
     end
   end
 end

data/lib/granite/rspec/perform_action.rb

@@ -0,0 +1,89 @@
+RSpec::Matchers.define :perform_action do |klass|
+  chain :using do |using|
+    @using = using
+  end
+
+  chain :as do |performer|
+    @performer = performer
+  end
+
+  chain :with do |attributes|
+    @attributes = attributes
+  end
+
+  match do |block|
+    @klass = klass
+    @using ||= :perform!
+
+    @payloads = []
+    subscriber = ActiveSupport::Notifications.subscribe('granite.perform_action') do |_, _, _, _, payload|
+      @payloads << payload
+    end
+
+    block.call
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    @payloads.detect { |payload| action_matches?(payload[:action]) && payload[:using] == @using }
+  end
+
+  failure_message do
+    output = "expected to call #{performed_entity}"
+    add_performer_message(output, @performer) if defined?(@performer)
+    add_attributes_message(output, @attributes) if defined?(@attributes)
+
+    similar_payloads = @payloads.select { |payload| class_matches?(payload[:action]) && payload[:using] == @using }
+    if similar_payloads.present?
+      output << "\nreceived calls to #{performed_entity}:"
+      similar_payloads.each { |payload| add_message_from_payload(output, payload) }
+    end
+
+    output
+  end
+
+  failure_message_when_negated do
+    "expected not to call #{performed_entity}"
+  end
+
+  supports_block_expectations
+
+  private
+
+  def add_message_from_payload(output, payload)
+    action = payload[:action]
+    add_performer_message(output, action.performer) if defined?(@performer)
+    add_attributes_message(output, actual_attributes(action)) if defined?(@attributes)
+  end
+
+  def add_performer_message(output, performer)
+    output << "\n    AS #{performer.inspect}"
+  end
+
+  def add_attributes_message(output, attributes)
+    output << "\n    WITH #{attributes.inspect}"
+  end
+
+  def performed_entity
+    "#{@klass}##{@using}"
+  end
+
+  def actual_attributes(action)
+    @attributes.keys.to_h { |attr| [attr, action.public_send(attr)] }
+  end
+
+  def action_matches?(action)
+    class_matches?(action) && performer_matches?(action) && attributes_match?(action)
+  end
+
+  def class_matches?(action)
+    action.is_a?(@klass)
+  end
+
+  def performer_matches?(action)
+    !defined?(@performer) || action.performer == @performer
+  end
+
+  def attributes_match?(action)
+    !defined?(@attributes) || match(@attributes).matches?(actual_attributes(action))
+  end
+end

data/lib/granite/rspec.rb

@@ -1,5 +1,6 @@
 require 'granite/rspec/action_helpers'
 require 'granite/rspec/have_projector'
+require 'granite/rspec/perform_action'
 require 'granite/rspec/projector_helpers'
 require 'granite/rspec/raise_validation_error'
 require 'granite/rspec/satisfy_preconditions'

data/lib/granite/version.rb

@@ -1,3 +1,3 @@
 module Granite
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Toptal Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -323,6 +323,7 @@ files:
 - lib/granite/action.rb
 - lib/granite/action/error.rb
 - lib/granite/action/exceptions_handling.rb
+- lib/granite/action/instrumentation.rb
 - lib/granite/action/performer.rb
 - lib/granite/action/performing.rb
 - lib/granite/action/policies.rb
@@ -346,10 +347,11 @@ files:
 - lib/granite/base.rb
 - lib/granite/config.rb
 - lib/granite/context.rb
+- lib/granite/context_proxy.rb
+- lib/granite/context_proxy/data.rb
+- lib/granite/context_proxy/proxy.rb
 - lib/granite/dispatcher.rb
 - lib/granite/error.rb
-- lib/granite/performer_proxy.rb
-- lib/granite/performer_proxy/proxy.rb
 - lib/granite/projector.rb
 - lib/granite/projector/controller_actions.rb
 - lib/granite/projector/error.rb
@@ -369,6 +371,7 @@ files:
 - lib/granite/rspec.rb
 - lib/granite/rspec/action_helpers.rb
 - lib/granite/rspec/have_projector.rb
+- lib/granite/rspec/perform_action.rb
 - lib/granite/rspec/projector_helpers.rb
 - lib/granite/rspec/raise_validation_error.rb
 - lib/granite/rspec/satisfy_preconditions.rb
@@ -399,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.3.9
 signing_key: 
 specification_version: 4
 summary: Another business actions architecture for Rails apps

data/lib/granite/performer_proxy.rb

@@ -1,34 +0,0 @@
-require 'granite/performer_proxy/proxy'
-
-module Granite
-  # This concern contains class methods used for actions and projectors
-  #
-  module PerformerProxy
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def as(performer)
-        Proxy.new(self, performer)
-      end
-
-      def with_proxy_performer(performer)
-        key = proxy_performer_key
-        old_performer = Thread.current[key]
-        Thread.current[key] = performer
-        yield
-      ensure
-        Thread.current[key] = old_performer
-      end
-
-      def proxy_performer
-        Thread.current[proxy_performer_key]
-      end
-
-      private
-
-      def proxy_performer_key
-        :"granite_proxy_performer_#{hash}"
-      end
-    end
-  end
-end