granite 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f01fbcec194a3031c22582899a7ff0210d2b621aa149a5ccf7814a3a70540ea
-  data.tar.gz: c763544b18d4feb43a5502df2e661dce313c304f47543978be095e4e72afc863
+  metadata.gz: d0524a0055b0ea48aeab0691a1063cf332455b87094e2a78dbb6b66cc24b168e
+  data.tar.gz: e07a9c6a636eed28916860e213beea548aa92943da442b7d39019b346079e3fc
 SHA512:
-  metadata.gz: '099c76956322fe11a1118dc25a1fffbc0553018d1abf660d7c6270256f40505a3d93be01e57df0d7502c767c09d961fcf3361a7281315296e6abb9c512a38a9f'
-  data.tar.gz: 9b1b66eca75f4ff623319d1828cbec2b987c36050fb70598a8a14ea7edd760da38eb61c89f0a4de3b706875b68a16dccefe22333c3ac8edbe5b80864e04f4aca
+  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/exceptions_handling.rb

@@ -7,7 +7,7 @@ module Granite
         class_attribute :_exception_handlers, instance_writer: false
         self._exception_handlers = {}
 
-        protected :_exception_handlers # rubocop:disable Style/AccessModifierDeclarations
+        protected :_exception_handlers
       end
 
       module ClassMethods

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/preconditions.rb

@@ -98,8 +98,8 @@ module Granite
       end
 
       # Adds passed error message and options to `errors` object
-      def decline_with(*args)
-        errors.add(:base, *args)
+      def decline_with(*args, **kwargs)
+        errors.add(:base, *args, **kwargs)
         failed_preconditions << args.first
       end
 

data/lib/granite/action/projectors.rb

@@ -85,13 +85,13 @@ module Granite
           _projectors.store(name, options, &block)
 
           class_eval <<-METHOD, __FILE__, __LINE__ + 1
-            def self.#{name}
-              _projectors.fetch(:#{name})
-            end
-
-            def #{name}
-              @#{name} ||= self.class._projectors.fetch(:#{name}).new(self)
-            end
+            def self.#{name}                                                # def self.foo
+              _projectors.fetch(:#{name})                                   #   _projectors.fetch(:foo)
+            end                                                             # end
+                                                                            #
+            def #{name}                                                     # def foo
+              @#{name} ||= self.class._projectors.fetch(:#{name}).new(self) #   @foo ||= self.class._projectors.fetch(:foo).new(self)
+            end                                                             # end
           METHOD
         end
       end

data/lib/granite/action/transaction_manager.rb

@@ -62,16 +62,14 @@ module Granite
           collected_errors = []
 
           callbacks.reverse_each do |callback|
-            begin
-              callback.respond_to?(:run_callbacks) ? callback.run_callbacks(:commit) : callback.call
-            rescue StandardError => e
-              collected_errors << e
-            end
+            callback.respond_to?(:run_callbacks) ? callback.run_callbacks(:commit) : callback.call
+          rescue StandardError => e
+            collected_errors << e
           end
 
           return unless collected_errors.any?
 
-          log_errors(collected_errors[1..-1])
+          log_errors(collected_errors[1..])
           fail collected_errors.first
         end
 

data/lib/granite/action/translations.rb

@@ -17,7 +17,7 @@ module Granite
 
       def translate(*args, **options)
         key, options = Granite::Translations.scope_translation_args(self.class.i18n_scopes, *args, **options)
-        I18n.translate(key, **options)
+        I18n.t(key, **options)
       end
       alias t translate
     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/assign_data.rb

@@ -1,6 +1,6 @@
 module Granite
   module AssignData
-    DataAssignment = Struct.new(:method, :options)
+    DataAssignment = Struct.new(:method, :options) # rubocop:disable Lint/StructNewOverride
 
     extend ActiveSupport::Concern
 
@@ -9,7 +9,7 @@ module Granite
       self.data_assignments = []
 
       alias_method :only_run_validations!, :run_validations!
-      protected :only_run_validations! # rubocop:disable Style/AccessModifierDeclarations
+      protected :only_run_validations!
     end
 
     module ClassMethods

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,21 +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
-      def initialize(klass, performer)
+      extend Granite::Ruby3Compatibility
+
+      def initialize(klass, context)
         @klass = klass
-        @performer = performer
+        @context = context
       end
 
       def inspect
-        "<#{@klass}PerformerProxy #{@performer}>"
+        "<#{@klass}ContextProxy #{@context}>"
       end
 
-      def method_missing(method, *args, &block)
+      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/controller_actions.rb

@@ -22,13 +22,13 @@ module Granite
             self.controller_actions = controller_actions.merge(name.to_sym => options)
             controller_class.__send__(:define_method, name, &block)
             class_eval <<-METHOD, __FILE__, __LINE__ + 1
-              def #{name}_url(options = {})
-                action_url(:#{name}, **options.symbolize_keys)
-              end
-
-              def #{name}_path(options = {})
-                action_path(:#{name}, **options.symbolize_keys)
-              end
+              def #{name}_url(options = {})                     # def foo_url(options = {}
+                action_url(:#{name}, **options.symbolize_keys)  #   action_url(:foo, **options.symbolize_keys)
+              end                                               # end
+                                                                #
+              def #{name}_path(options = {})                    # def foo_path(options = {})
+                action_path(:#{name}, **options.symbolize_keys) #   action_path(:foo, **options.symbolize_keys)
+              end                                               # end
             METHOD
           else
             controller_actions[name.to_sym]

data/lib/granite/projector/helpers.rb

@@ -35,8 +35,7 @@ Do you have #{projector.action_class.name.underscore}##{projector.projector_name
 
       def required_params
         corresponding_route.required_parts
-          .map { |name| [name, action.public_send(name)] }
-          .to_h
+          .to_h { |name| [name, action.public_send(name)] }
       end
 
       def corresponding_route

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/represents/attribute.rb

@@ -15,7 +15,7 @@ module Granite
       end
 
       def typecast(value)
-        return value if value.class == type
+        return value if value.class == type # rubocop:disable Style/ClassEqualityComparison
 
         typecaster.call(value, self) unless value.nil?
       end
@@ -28,9 +28,9 @@ module Granite
 
       def typecaster
         @typecaster ||= begin
-                          type_class = type.instance_of?(Class) ? type : type.class
-                          @typecaster = ActiveData.typecaster(type_class.ancestors.grep(Class))
-                        end
+          type_class = type.instance_of?(Class) ? type : type.class
+          @typecaster = ActiveData.typecaster(type_class.ancestors.grep(Class))
+        end
       end
 
       def changed?

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/projector_helpers.rb

@@ -30,16 +30,10 @@ module Granite::ProjectorHelpers
 
     private
 
-    def setup_controller
-      singleton_class.class_eval do
-        def controller_class
-        end
-      end
-
-      before do
-        @controller = yield.controller_class.new
-        @controller.class.instance_variable_set(:@controller_path, yield.projector_path)
-        @controller.request = @request
+    def setup_controller(&block)
+      define_method :setup_controller_request_and_response do
+        @controller ||= instance_eval(&block).controller_class.new
+        super()
       end
     end
 

data/lib/granite/rspec/raise_validation_error.rb

@@ -23,14 +23,12 @@ RSpec::Matchers.define :raise_validation_error do
   end
 
   match do |block|
-    begin
-      block.call
-      false
-    rescue Granite::Action::ValidationError => e
-      @details = e.errors.details
-      @details_being_checked = @details[@attribute || :base]
-      @result = @details_being_checked&.any? { |x| x[:error] == @error_type }
-    end
+    block.call
+    false
+  rescue Granite::Action::ValidationError => e
+    @details = e.errors.details
+    @details_being_checked = @details[@attribute || :base]
+    @result = @details_being_checked&.any? { |x| x[:error] == @error_type }
   end
 
   description do

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/ruby3_compatibility.rb

@@ -0,0 +1,15 @@
+module Granite
+  module Ruby3Compatibility
+    # Method definition aimed to provide compatibility between Ruby 2.6 and 3.0
+    # It's being recommended in this article
+    # https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/
+    #
+    # Example:
+    #
+    # ruby2_keywords def a_method(argument, *args, &block)
+    #   delegating_to_method(argument, *args, &block)
+    # end
+    def ruby2_keywords(*)
+    end
+  end
+end

data/lib/granite/version.rb

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

data/lib/granite.rb

@@ -5,6 +5,7 @@ require 'granite/version'
 require 'granite/config'
 require 'granite/context'
 require 'granite/util'
+require 'granite/ruby3_compatibility'
 
 module Granite
   def self.config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granite
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Toptal Engineering
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -252,42 +252,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.0
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.37.0
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -302,8 +302,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
-description:
-email:
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -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,9 +371,11 @@ 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
+- lib/granite/ruby3_compatibility.rb
 - lib/granite/translations.rb
 - lib/granite/typecasters.rb
 - lib/granite/util.rb
@@ -383,7 +387,7 @@ homepage: https://github.com/toptal/granite
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -391,15 +395,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
-signing_key:
+rubygems_version: 3.3.9
+signing_key: 
 specification_version: 4
 summary: Another business actions architecture for Rails apps
 test_files: []

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