convenient_service 0.15.0 → 0.17.0

data/lib/convenient_service/common/plugins/has_instance_proxy/concern.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module HasInstanceProxy
+        module Concern
+          include Support::Concern
+
+          class_methods do
+            ##
+            # @return [Class] Can be any type.
+            #
+            def instance_proxy_class
+              @instance_proxy_class ||= Commands::CreateInstanceProxyClass[target_class: self]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/has_instance_proxy/entities/instance_proxy.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module HasInstanceProxy
+        module Entities
+          class InstanceProxy
+            ##
+            # @api private
+            #
+            # @param target [Object] Can be any type.
+            # @return [void]
+            #
+            def initialize(target:)
+              @__convenient_service_instance_proxy_target__ = target
+            end
+
+            ##
+            # @api public
+            #
+            # @return [Object] Can be any type.
+            #
+            def instance_proxy_target
+              @__convenient_service_instance_proxy_target__
+            end
+
+            ##
+            # @api public
+            #
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            # @internal
+            #   TODO: Direct Specs.
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if instance_proxy_target != other.instance_proxy_target
+
+              true
+            end
+
+            private
+
+            ##
+            # @see https://thoughtbot.com/blog/always-define-respond-to-missing-when-overriding
+            # @see https://blog.marc-andre.ca/2010/11/15/methodmissing-politely
+            # @see https://stackoverflow.com/a/3304683/12201472
+            #
+            # @param method_name [Symbol, String]
+            # @param include_private [Boolean]
+            # @return [Boolean]
+            #
+            # @internal
+            #   IMPORTANT: `respond_to_missing?` is like `initialize`. It is always `private`.
+            #   - https://ruby-doc.org/core-2.7.0/Object.html#method-i-respond_to_missing-3F
+            #   - https://github.com/ruby/spec/blob/master/language/def_spec.rb#L65
+            #
+            def respond_to_missing?(method_name, include_private = false)
+              instance_proxy_target.respond_to?(method_name, include_private)
+            end
+
+            ##
+            # @return [Object] Can be any type.
+            #
+            def method_missing(...)
+              instance_proxy_target.public_send(...)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/has_instance_proxy/entities.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "entities/instance_proxy"

data/lib/convenient_service/common/plugins/has_instance_proxy/middleware.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Common
+    module Plugins
+      module HasInstanceProxy
+        class Middleware < MethodChainMiddleware
+          intended_for :new, scope: :class, entity: any_entity
+
+          ##
+          # @return [ConvenientService::Common::Plugins::HasInstanceProxy::Entities::InstanceProxy]
+          #
+          def next(...)
+            entity.instance_proxy_class.new(target: chain.next(...))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/common/plugins/has_instance_proxy.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "has_instance_proxy/commands"
+require_relative "has_instance_proxy/concern"
+require_relative "has_instance_proxy/entities"
+require_relative "has_instance_proxy/middleware"

data/lib/convenient_service/common/plugins.rb

@@ -14,6 +14,7 @@ require_relative "plugins/has_around_callbacks"
 require_relative "plugins/has_constructor"
 require_relative "plugins/has_constructor_without_initialize"
 require_relative "plugins/has_internals"
+require_relative "plugins/has_instance_proxy"
 require_relative "plugins/has_j_send_result_duck_short_syntax"
 
 require_relative "plugins/aliases"

data/lib/convenient_service/core/concern/class_methods.rb

@@ -70,6 +70,7 @@ module ConvenientService
 
         ##
         # @see https://thoughtbot.com/blog/always-define-respond-to-missing-when-overriding
+        # @see https://blog.marc-andre.ca/2010/11/15/methodmissing-politely
         # @see https://stackoverflow.com/a/3304683/12201472
         #
         # @param method_name [Symbol, String]
@@ -112,12 +113,16 @@ module ConvenientService
         #
         #   TODO: Include `method` into trigger metadata.
         #
+        #   IMPORTANT: Ruby 2.7 and Ruby 3.0+ invoke this `method_missing` differently, check the following files/links:
+        #   - `lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_middlewares_caller.rb`
+        #   - https://gist.github.com/marian13/9c25041f835564e945d978839097d419
+        #
         def method_missing(method, *args, **kwargs, &block)
           commit_config!(trigger: Constants::Triggers::CLASS_METHOD_MISSING)
 
-          return super unless Utils::Module.class_method_defined?(self, method, public: true, protected: false, private: false)
+          return ::ConvenientService.reraise { super } unless Utils::Module.class_method_defined?(self, method, public: true, protected: false, private: false)
 
-          return super if middlewares(method, scope: :class).defined_without_super_method?
+          return ::ConvenientService.reraise { super } if middlewares(method, scope: :class).defined_without_super_method?
 
           ConvenientService.logger.debug { "[Core] Committed config for `#{self}` | Triggered by `method_missing` | Method: `.#{method}`" }
 

data/lib/convenient_service/core/concern/instance_methods.rb

@@ -17,6 +17,7 @@ module ConvenientService
 
         ##
         # @see https://thoughtbot.com/blog/always-define-respond-to-missing-when-overriding
+        # @see https://blog.marc-andre.ca/2010/11/15/methodmissing-politely
         # @see https://stackoverflow.com/a/3304683/12201472
         #
         # @param method_name [Symbol, String]
@@ -59,12 +60,16 @@ module ConvenientService
         #
         #   TODO: Include `method` into trigger metadata.
         #
+        #   IMPORTANT: Ruby 2.7 and Ruby 3.0+ invoke this `method_missing` differently, check the following files/links:
+        #   - `lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_middlewares_caller.rb`
+        #   - https://gist.github.com/marian13/9c25041f835564e945d978839097d419
+        #
         def method_missing(method, *args, **kwargs, &block)
           self.class.commit_config!(trigger: Constants::Triggers::INSTANCE_METHOD_MISSING)
 
-          return super unless Utils::Module.instance_method_defined?(self.class, method, public: true, protected: false, private: false)
+          return ::ConvenientService.reraise { super } unless Utils::Module.instance_method_defined?(self.class, method, public: true, protected: false, private: false)
 
-          return super if self.class.middlewares(method, scope: :instance).defined_without_super_method?
+          return ::ConvenientService.reraise { super } if self.class.middlewares(method, scope: :instance).defined_without_super_method?
 
           ConvenientService.logger.debug { "[Core] Committed config for `#{self.class}` | Triggered by `method_missing` | Method: `##{method}`" }
 

data/lib/convenient_service/core/entities/config/commands/track_method_missing_commit_trigger.rb

@@ -35,7 +35,7 @@ module ConvenientService
               return unless method_missing_trigger_valid?
               return if method_missing_commits_counter_incremented?
 
-              raise Exceptions::TooManyCommitsFromMethodMissing.new(config: config)
+              ::ConvenientService.raise Exceptions::TooManyCommitsFromMethodMissing.new(config: config)
             end
 
             ##

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/caller/commands/define_method_middlewares_caller.rb

@@ -90,9 +90,9 @@ module ConvenientService
                     #     prefix = "#{prefix}"
                     #
                     #   NOTE: Check the following link in order to get an idea why two versions of `define_method_middlewares_caller` exist.
-                    #   https://gist.github.com/marian13/9c25041f835564e945d978839097d419
+                    #   - https://gist.github.com/marian13/9c25041f835564e945d978839097d419
                     #
-                    if ::RUBY_VERSION >= "3.0"
+                    if Dependencies.ruby.version >= 3.0
                       def define_method_middlewares_caller
                         <<~RUBY.tap { |code| methods_middlewares_callers.module_eval(code, __FILE__, __LINE__ + 1) }
                           def #{method}(*args, **kwargs, &block)

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/middlewares/base/commands/create_observable_middleware.rb

@@ -39,6 +39,9 @@ module ConvenientService
                           # @param other [Object] Can be any type.
                           # @return [Boolean, nil]
                           #
+                          # @internal
+                          #   TODO: Try `self.middleware == other.middleware if self < ::ConvenientService::Core::Entities::Config::Entities::MethodMiddlewares::Entities::Middlewares::Base`.
+                          #
                           define_singleton_method(:==) { |other| self.middleware == other.middleware if other.respond_to?(:middleware) }
 
                           ##

data/lib/convenient_service/core/entities/config/exceptions.rb

@@ -10,14 +10,14 @@ module ConvenientService
             # @param config [ConvenientService::Core::Entities::Config]
             # @return [void]
             #
-            def initialize(config:)
+            def initialize_with_kwargs(config:)
               message = <<~TEXT
                 Config for `#{config.klass}` is already committed. Only uncommitted configs can be modified.
 
                 Did you accidentally call `concerns(&configuration_block)` or `middlewares(method, scope: scope, &configuration_block)` after using any plugin, after calling `commit_config!`?
               TEXT
 
-              super(message)
+              initialize(message)
             end
           end
 
@@ -30,7 +30,7 @@ module ConvenientService
             #   TODO: Create a troubleshooting page with possible reasons (preliminary RSpec mocks etc).
             #   Append a link to it to the error message.
             #
-            def initialize(config:)
+            def initialize_with_kwargs(config:)
               message = <<~TEXT
                 `#{config.klass}` config is committed too many times from `method_missing`.
 
@@ -54,7 +54,7 @@ module ConvenientService
                   end
               TEXT
 
-              super(message)
+              initialize(message)
             end
           end
         end

data/lib/convenient_service/core/entities/config.rb

@@ -162,7 +162,7 @@ module ConvenientService
         def assert_not_committed!
           return unless committed?
 
-          raise Exceptions::ConfigIsCommitted.new(config: self)
+          ::ConvenientService.raise Exceptions::ConfigIsCommitted.new(config: self)
         end
       end
     end

data/lib/convenient_service/dependencies/extractions/active_support_backtrace_cleaner/backtrace_cleaner.rb

@@ -7,15 +7,17 @@ module ConvenientService
       # @internal
       #   NOTE:
       #     Copied from `rails/rails` without any logic modification.
-      #     Version: v7.0.4.3.
+      #     Version: v7.1.2.
       #     Wrapped in a namespace `ConvenientService::Dependencies::Extractions::ActiveSupportBacktraceCleaner`.
       #
-      #   - https://api.rubyonrails.org/v7.0.4.3/classes/ActiveSupport/BacktraceCleaner.html
-      #   - https://github.com/rails/rails/blob/v7.0.4.3/activesupport/lib/active_support/backtrace_cleaner.rb
+      #   - https://api.rubyonrails.org/v7.1.2/classes/ActiveSupport/BacktraceCleaner.html
+      #   - https://github.com/rails/rails/blob/v7.1.2/activesupport/lib/active_support/backtrace_cleaner.rb
       #   - https://github.com/marian13/rails/blob/main/activesupport/lib/active_support/backtrace_cleaner.rb
       #   - https://github.com/rails/rails
       #
       module ActiveSupportBacktraceCleaner
+        # = Backtrace Cleaner
+        #
         # Backtraces often include many lines that are not relevant for the context
         # under review. This makes it hard to find the signal amongst the backtrace
         # noise, and adds debugging time. With a BacktraceCleaner, filters and
@@ -34,7 +36,7 @@ module ConvenientService
         #   bc.add_silencer { |line| /puma|rubygems/.match?(line) } # skip any lines from puma or rubygems
         #   bc.clean(exception.backtrace) # perform the cleanup
         #
-        # To reconfigure an existing BacktraceCleaner (like the default one in Rails)
+        # To reconfigure an existing BacktraceCleaner (like the default one in \Rails)
         # and show as much data as possible, you can always call
         # BacktraceCleaner#remove_silencers!, which will restore the
         # backtrace to a pristine state. If you need to reconfigure an existing
@@ -67,11 +69,29 @@ module ConvenientService
           end
           alias :filter :clean
 
+          # Returns the frame with all filters applied.
+          # returns +nil+ if the frame was silenced.
+          def clean_frame(frame, kind = :silent)
+            frame = frame.to_s
+            @filters.each do |f|
+              frame = f.call(frame.to_s)
+            end
+
+            case kind
+            when :silent
+              frame unless @silencers.any? { |s| s.call(frame) }
+            when :noise
+              frame if @silencers.any? { |s| s.call(frame) }
+            else
+              frame
+            end
+          end
+
           # Adds a filter from the block provided. Each line in the backtrace will be
           # mapped against this filter.
           #
           #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
-          #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+          #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root.to_s, '') }
           def add_filter(&block)
             @filters << block
           end
@@ -121,7 +141,7 @@ module ConvenientService
 
             def filter_backtrace(backtrace)
               @filters.each do |f|
-                backtrace = backtrace.map { |line| f.call(line) }
+                backtrace = backtrace.map { |line| f.call(line.to_s) }
               end
 
               backtrace
@@ -129,7 +149,7 @@ module ConvenientService
 
             def silence(backtrace)
               @silencers.each do |s|
-                backtrace = backtrace.reject { |line| s.call(line) }
+                backtrace = backtrace.reject { |line| s.call(line.to_s) }
               end
 
               backtrace
@@ -138,7 +158,7 @@ module ConvenientService
             def noise(backtrace)
               backtrace.select do |line|
                 @silencers.any? do |s|
-                  s.call(line)
+                  s.call(line.to_s)
                 end
               end
             end

data/lib/convenient_service/dependencies/extractions/active_support_backtrace_cleaner.rb

@@ -4,11 +4,11 @@
 # @internal
 #   NOTE:
 #     Copied from `rails/rails` without any logic modification.
-#     Version: v7.0.4.3.
+#     Version: v7.1.2.
 #     Wrapped in a namespace `ConvenientService::Dependencies::Extractions::ActiveSupportBacktraceCleaner`.
 #
-#   - https://api.rubyonrails.org/v7.0.4.3/classes/ActiveSupport/BacktraceCleaner.html
-#   - https://github.com/rails/rails/blob/v7.0.4.3/activesupport/lib/active_support/backtrace_cleaner.rb
+#   - https://api.rubyonrails.org/v7.1.2/classes/ActiveSupport/BacktraceCleaner.html
+#   - https://github.com/rails/rails/blob/v7.1.2/activesupport/lib/active_support/backtrace_cleaner.rb
 #   - https://github.com/marian13/rails/blob/main/activesupport/lib/active_support/backtrace_cleaner.rb
 #   - https://github.com/rails/rails
 #

data/lib/convenient_service/dependencies/extractions/b.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Works in a similar way as `p`, but for `byebug`.
 # @see https://ruby-doc.org/core-2.7.0/Kernel.html#method-i-p

data/lib/convenient_service/dependencies/extractions/ce.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+##
+# @note `ce` is short for `catch_exception`.
+#
+# @example
+#   ce { some_code }
+#   e = ce { some_code }
+#
+def ce
+  yield
+
+  nil
+rescue => exception
+  exception
+end

data/lib/convenient_service/dependencies/extractions.rb

@@ -7,4 +7,5 @@
 #   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
 #
 require_relative "extractions/active_support_concern"
+require_relative "extractions/active_support_backtrace_cleaner"
 require_relative "extractions/ruby_middleware"

data/lib/convenient_service/dependencies.rb

@@ -135,7 +135,7 @@ module ConvenientService
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
-      # @see https://marian13.github.io/convenient_service_docs/troubleshooting/i18n_translate_wrong_number_of_arguments
+      # @see https://userdocs.convenientservice.org/troubleshooting/i18n_translate_wrong_number_of_arguments
       #
       def require_has_j_send_result_params_validations_using_active_model_validations
         ##
@@ -244,6 +244,11 @@ module ConvenientService
         require_relative "dependencies/extractions/byebug_syntax_highlighting" unless ruby.jruby?
 
         require_relative "dependencies/extractions/b" unless ruby.jruby?
+
+        ##
+        #
+        #
+        require_relative "dependencies/extractions/ce"
       end
 
       ##

data/lib/convenient_service/examples/dry/gemfile.rb

@@ -16,7 +16,9 @@ module ConvenientService
       class Gemfile
         include ConvenientService::Feature::Standard::Config
 
-        entry :format do |path|
+        entry :format
+
+        def format(path)
           Services::Format[path: path]
         end
       end

data/lib/convenient_service/examples/dry/v1/gemfile.rb

@@ -17,7 +17,9 @@ module ConvenientService
         class Gemfile
           include ConvenientService::Feature::Standard::Config
 
-          entry :format do |path|
+          entry :format
+
+          def format(path)
             Services::Format[path: path]
           end
         end

data/lib/convenient_service/examples/rails/gemfile.rb

@@ -16,7 +16,9 @@ module ConvenientService
       class Gemfile
         include ConvenientService::Feature::Standard::Config
 
-        entry :format do |path|
+        entry :format
+
+        def format(path)
           Services::Format[path: path]
         end
       end

data/lib/convenient_service/examples/rails/v1/gemfile.rb

@@ -17,7 +17,9 @@ module ConvenientService
         class Gemfile
           include ConvenientService::Feature::Standard::Config
 
-          entry :format do |path|
+          entry :format
+
+          def format(path)
             Services::Format[path: path]
           end
         end

data/lib/convenient_service/examples/standard/cowsay.rb

@@ -15,7 +15,9 @@ module ConvenientService
       class Cowsay
         include ConvenientService::Feature::Standard::Config
 
-        entry :print do |text = "Hello World!", out: $stdout|
+        entry :print
+
+        def print(text = "Hello World!", out: $stdout)
           Services::Print[text: text, out: out]
         end
       end

data/lib/convenient_service/examples/standard/date_time.rb

@@ -14,7 +14,9 @@ module ConvenientService
       class DateTime
         include ConvenientService::Feature::Standard::Config
 
-        entry :safe_parse do |string, format|
+        entry :safe_parse
+
+        def safe_parse(string, format)
           Services::SafeParse[string: string, format: format]
         end
       end

data/lib/convenient_service/examples/standard/factorial.rb

@@ -15,7 +15,9 @@ module ConvenientService
       class Factorial
         include ConvenientService::Feature::Standard::Config
 
-        entry :calculate do |number|
+        entry :calculate
+
+        def calculate(number)
           Services::Calculate[number: number]
         end
       end

data/lib/convenient_service/examples/standard/gemfile.rb

@@ -15,7 +15,9 @@ module ConvenientService
       class Gemfile
         include ConvenientService::Feature::Standard::Config
 
-        entry :format do |path|
+        entry :format
+
+        def format(path)
           Services::Format[path: path]
         end
       end

data/lib/convenient_service/examples/standard/request_params.rb

@@ -6,7 +6,6 @@ require_relative "request_params/services"
 require_relative "request_params/utils"
 
 ##
-# @since 0.3.0
 #
 # @internal
 #   Usage example:
@@ -39,7 +38,9 @@ module ConvenientService
       class RequestParams
         include ConvenientService::Feature::Standard::Config
 
-        entry :prepare do |request|
+        entry :prepare
+
+        def prepare(request)
           Services::Prepare[request: request]
         end
       end

data/lib/convenient_service/examples/standard/v1/request_params.rb

@@ -6,7 +6,6 @@ require_relative "request_params/services"
 require_relative "request_params/utils"
 
 ##
-# @since 0.3.0
 #
 # @internal
 #   Usage example: