luna_park 0.11.4 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25c15d875ee58d0d61589f2041e81c65eeccde628e8a07c584722fc69865741a
-  data.tar.gz: 27f13cbf3d1073f651a13c714092e1ebac28b4b9e3c8eb0dcfcc2fdec4b0009e
+  metadata.gz: 4db92d2cf17231ba0d96f4071b636b0bd91f98d7125b49268eeadd49cb712a76
+  data.tar.gz: ea8d7bdaf649dc04f2343296ec24f234bfd1e5cd9110b93bc33a3d405a53d1cc
 SHA512:
-  metadata.gz: e747fa427d30d6b64d3cd4300beb67d27b080b41de497f959caa05b719b94845178c8fa53944261a81fcedb9fb31950a5ba53d01ae87bf529b9eba16a4e92b9a
-  data.tar.gz: 0432dfffa7d6702f79fdfa2abdf68b4fee5d9d6fdd4f0864e01fd7829873db8c32a2656b72479f4735d0423256aecb5f97e55c03b5daa3b9c513036062be336f
+  metadata.gz: 63e880268e5a55561867f67f0a71b8804bbf36671c1fb2cc98cd3a17cdd84264e850fe739919864d3fc88e7f74056fabba73e89781a8766f4a239096e885278f
+  data.tar.gz: 41e777a88fb0e95517ea2a5644454ffeedcbd902879040baa2149f82e63f48ef77779aef95088fe15b29e89ae33daf5163b0bdb9530a345b02ed506bb926026f

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.6] - 2021-10-06
+Changed
+- in `UseCases::Scenario` now abstract method is `#perform` - not `call!`. It is backward-compatible change: `call!` still works as abstract, and public interface was not changed.
+
+Added
+- returned old aliases fail falure to scenarios
+- add short alias for exceptions (`i18n:` instead of `i18n_key:`)
+
+## [0.11.5] - 2022-09-27
+Changed
+- Added `.custom_error` method to `Extensions::HasError` to define errors with a custom superclass
+- Added `#inject` method to `Extensions::Injector` - dependencies setter that allows you to create method chains
+
 ## [0.11.4] - 2022-07-11
 Changed
 - allow require Notifiers::Sentry when sentry-ruby version >= 4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    luna_park (0.11.4)
+    luna_park (0.11.6)
 
 GEM
   remote: https://rubygems.org/
@@ -179,4 +179,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.2.30

data/lib/luna_park/errors/base.rb

@@ -17,7 +17,7 @@ module LunaPark
     # @example Fatalism class
     #   module Errors
     #     class Fatalism < LunaPark::Errors::Base
-    #       message  'You cannot change your destiny', i18n_key: 'errors.fatalism'
+    #       message  'You cannot change your destiny', i18n: 'errors.fatalism'
     #       notify: :info
     #     end
     #   end
@@ -50,7 +50,7 @@ module LunaPark
         # Proc, that receives details hash: { detail_key => detail_value }
         #
         # @private
-        attr_reader :default_message_block
+        attr_reader :__default_message_block__
 
         # Specifies the expected behavior of the error handler if an error
         # instance of this class is raised
@@ -67,17 +67,17 @@ module LunaPark
         # Specify default error message
         #
         # @param txt [String] - text of message
-        # @param i18n_key [String] - internationalization key
+        # @param i18n [String] - internationalization key
         # @return [NilClass]
-        def message(txt = nil, i18n_key: nil, &default_message_block)
-          @default_message_block = block_given? ? default_message_block : txt && ->(_) { txt }
-          @i18n_key = i18n_key
+        def message(txt = nil, i18n_key: nil, i18n: nil, &default_message_block)
+          @__default_message_block__ = block_given? ? default_message_block : txt && ->(_) { txt }
+          @i18n_key = i18n || i18n_key
           nil
         end
 
         def inherited(inheritor)
-          if default_message_block
-            inheritor.message(i18n_key: i18n_key, &default_message_block)
+          if __default_message_block__
+            inheritor.message(i18n_key: i18n_key, &__default_message_block__)
           elsif i18n_key
             inheritor.message(i18n_key: i18n_key)
           end
@@ -186,7 +186,7 @@ module LunaPark
       #   #     frost: Прости Кузьма, замерзли ноги!
       #
       #   class FrostError < LunaPark::Errors::Base
-      #     message 'Forgive Kuzma, my feet froze', i18n_key: 'errors.frost'
+      #     message 'Forgive Kuzma, my feet froze', i18n: 'errors.frost'
       #   end
       #
       #   error = FrostError.new
@@ -207,7 +207,7 @@ module LunaPark
       #   #     wrong_answer: Die richtige Antwort ist '%{correct}', nicht '%{wrong}'
       #
       #   class WrongAnswerError < LunaPark::Errors::Base
-      #     message i18n_key: 'errors.wrong_answer'
+      #     message i18n: 'errors.wrong_answer'
       #   end
       #
       #   error = WrongAnswerError.new(correct: 42, wrong: 420)
@@ -237,7 +237,7 @@ module LunaPark
 
       # @return [String] - Default message
       def build_default_message
-        self.class.default_message_block&.call(details)
+        self.class.__default_message_block__&.call(details)
       end
     end
   end

data/lib/luna_park/extensions/has_errors.rb

@@ -43,10 +43,10 @@ module LunaPark
         #   class Service
         #     include LunaPark::Extensions::HasErrors
         #
-        #     class CustomError < LunaPark::Errors::Business; end
+        #     class LogicError < LunaPark::Errors::Business; end
         #   end
         #
-        #   Service.new.error :custom_error # => raise CustomError
+        #   Service.new.error :logic_error # => raise LogicError
         #
         # @param title [Symbol|String] - Title of error
         # @param msg [String] - Message of error
@@ -65,17 +65,14 @@ module LunaPark
         #   class Service
         #     include LunaPark::Extensions::HasErrors
         #
-        #     business_error :logic_error, { (1 + 1).to_s }
+        #     business_error(:logic_error) { (1 + 1).to_s }
         #   end
         #
         #   logic_error = Service::LogicError.new
         #   logic_error.is_a? LunaPark::Errors::Business # => true
         #   logic_error.message # => '2'
-        def business_error(title, txt = nil, i18n_key: nil, notify: nil, &default_message_block)
-          error_class = Class.new(Errors::Business)
-          error_class.message(txt, i18n_key: i18n_key, &default_message_block)
-          error_class.notify(notify)
-          const_set(error_class_name(title), error_class)
+        def business_error(title, txt = nil, i18n_key: nil, i18n: nil, notify: nil, &default_message_block) # rubocop:disable Metrics/ParameterLists
+          custom_error title, Errors::Business, txt, i18n: i18n || i18n_key, notify: notify, &default_message_block
         end
 
         ##
@@ -89,18 +86,50 @@ module LunaPark
         #   class Service
         #     include LunaPark::Extensions::HasErrors
         #
-        #     system_error :tech_error, 'Custom message'
+        #     system_error :tech_error, 'Error message'
         #   end
         #
         #   tech_error = Service::TechError.new
         #   tech_error.is_a? LunaPark::Errors::System # => true
-        #   tech_error.message # => 'Custom message'
-        def system_error(title, txt = nil, i18n_key: nil, notify: nil, &default_message_block)
-          error_class = Class.new(Errors::System)
-          error_class.message(txt, i18n_key: i18n_key, &default_message_block)
-          error_class.notify(notify)
+        #   tech_error.message # => 'Error message'
+        def system_error(title, txt = nil, i18n_key: nil, i18n: nil, notify: nil, &default_message_block) # rubocop:disable Metrics/ParameterLists
+          custom_error title, Errors::System, txt, i18n: i18n || i18n_key, notify: notify, &default_message_block
+        end
+
+        ##
+        # Define error with a custom superclass.
+        # The superclass must be inherited from LunaPark::Errors::Base.
+        #
+        # @example
+        #   class BaseError < LunaPark::Errors::Business
+        #     alias description message
+        #   end
+        #
+        #   class Service
+        #     include LunaPark::Extensions::HasErrors
+        #
+        #     custom_error :custom_error, BaseError, 'Error message'
+        #   end
+        #
+        #   custom_error = Service::CustomError.new
+        #   custom_error.is_a? BaseError # => true
+        #   custom_error.description # => 'Error message'
+        # rubocop:disable Metrics/ParameterLists
+        def custom_error(title, inherit_from, txt = nil, i18n_key: nil, i18n: nil, notify: nil, &default_message_block)
+          unless inherit_from < Errors::Base
+            raise ArgumentError, 'inherit_from must be a superclass of LunaPark::Errors::Base'
+          end
+
+          error_class = Class.new(inherit_from)
+          error_class.inherited(inherit_from)
+          error_class.notify(notify) unless notify.nil?
+
+          message_present = ![txt, i18n || i18n_key, default_message_block].all?(&:nil?)
+          error_class.message(txt, i18n: i18n || i18n_key, &default_message_block) if message_present
+
           const_set(error_class_name(title), error_class)
         end
+        # rubocop:enable Metrics/ParameterLists
 
         ##
         # Get error class name

data/lib/luna_park/extensions/injector.rb

@@ -191,6 +191,19 @@ module LunaPark
         def dependencies=(value)
           @dependencies = Dependencies.wrap(value)
         end
+
+        ##
+        # Set dependencies, returns `self` to allow chaining
+        # Don't forget to override <b>all</b> dependencies.
+        #
+        #   use_case
+        #     .inject({ repo: -> { Fake::Repo.new }})
+        #     .call
+        #
+        def inject(value)
+          self.dependencies = value
+          self
+        end
       end
     end
   end

data/lib/luna_park/http/response.rb

@@ -371,6 +371,8 @@ module LunaPark
 
       # Two response should be equal, if their attributes (request, code, body, headers, cookies) match.
       def ==(other)
+        return false unless other.is_a? Response
+
         code      == other.code    &&
           body    == other.body    &&
           headers == other.headers &&

data/lib/luna_park/mappers/codirectional.rb

@@ -16,7 +16,7 @@ module LunaPark
     #     map attr: [:charge, :currency], row: :charge_currency # using aliased args
     #     map :comment
     #   end
-    # 
+    #
     #   mapper = Mappers::Transaction
     #
     #   attrs = { charge: { amount: 10, currency: 'USD' }, comment: 'Foobar' }

data/lib/luna_park/notifiers/log.rb

@@ -153,7 +153,7 @@ module LunaPark
         message = with
         return details unless message.respond_to?(:details)
 
-        message.details.merge(details) do |_, object_value, message_value|
+        (message.details || {}).merge(details || {}) do |_, object_value, message_value|
           { message: message_value, object: object_value }
         end
       end

data/lib/luna_park/use_cases/scenario.rb

@@ -28,7 +28,7 @@ module LunaPark
     #   class CreateUser < Scenario
     #     attr_accessor :email, :password
     #
-    #     def call!
+    #     def perform
     #       user          = Entities::User.new
     #       user.email    = email
     #       user.password = Service::Encode.call(password)
@@ -80,7 +80,7 @@ module LunaPark
       # @example on fail
       #   class Fail < Errors::Business; end
       #   class FailScenario < Scenario
-      #     def call!
+      #     def perform
       #       raise Fail
       #       :result
       #     end
@@ -108,7 +108,7 @@ module LunaPark
       #
       # @example on success
       #   class SuccessScenario < Scenario
-      #     def call!
+      #     def perform
       #       :result
       #     end
       #   end
@@ -131,7 +131,7 @@ module LunaPark
       #   class SayHello < Scenario
       #     attr_accessor :first_name, :last_name
       #
-      #     def call!
+      #     def perform
       #       t('hello_my_nme_is', first_name: first_name, last_name: last_name)
       #     end
       #   end
@@ -159,6 +159,10 @@ module LunaPark
         @state    = INIT
       end
 
+      def call!
+        perform
+      end
+
       # You must define this action and describe all business logic here.
       # When you run this method - it run as is, and does not change scenario instance.
       #
@@ -168,7 +172,7 @@ module LunaPark
       #   class Shot < Scenario
       #     attr_accessor :lucky_mode
       #
-      #     def call!
+      #     def perform
       #       raise YouDied, 'Always something went wrong' unless lucky_mode
       #       'All good'
       #     end
@@ -186,13 +190,13 @@ module LunaPark
       # @example Russian roulette
       #   # `.call!` usually use for "scenario in scenario"
       #   class RussianRoulette < Scenario
-      #     def call!
+      #     def perform
       #       [true, true, true, true, true, false].shuffle do |bullet|
       #         Shot.call! lucky_mode: bullet
       #       end
       #     end
       #   end
-      def call!
+      def perform
         raise Errors::AbstractMethod
       end
 
@@ -207,7 +211,7 @@ module LunaPark
       #   class Shot < Scenario
       #     attr_accessor :lucky_mode
       #
-      #     def call!
+      #     def perform
       #       raise YouDied, 'Always something went wrong' unless lucky_mode
       #       'All good'
       #     end
@@ -237,7 +241,7 @@ module LunaPark
       #     end
       #   end
       def call
-        catch { @data = call! }
+        rescue_exception { @data = call! }
         self
       end
 
@@ -278,7 +282,7 @@ module LunaPark
         #   class Foobar < Scenario
         #     notify_with Notifier::Bugsnag
         #
-        #     def call!
+        #     def perform
         #       true
         #     end
         #   end
@@ -292,7 +296,7 @@ module LunaPark
 
       private
 
-      def catch
+      def rescue_exception
         yield
       rescue Errors::Base => e
         @state = FAIL

data/lib/luna_park/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LunaPark
-  VERSION = '0.11.4'
+  VERSION = '0.11.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luna_park
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.6
 platform: ruby
 authors:
 - Alexander Kudrin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bugsnag