convenient_service 0.19.1 → 0.20.0

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

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+##
+# @author Rails Team <https://rubyonrails.org>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/rails/rails/blob/main/activesupport/lib/active_support/backtrace_cleaner.rb
+##
+
 module ConvenientService
   module Dependencies
     module Extractions
@@ -7,11 +14,11 @@ module ConvenientService
       # @internal
       #   NOTE:
       #     Copied from `rails/rails` without any logic modification.
-      #     Version: v7.1.2.
+      #     Version: v8.0.2.
       #     Wrapped in a namespace `ConvenientService::Dependencies::Extractions::ActiveSupportBacktraceCleaner`.
       #
-      #   - 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://api.rubyonrails.org/v8.0.2/classes/ActiveSupport/BacktraceCleaner.html
+      #   - https://github.com/rails/rails/blob/v8.0.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
       #
@@ -32,7 +39,8 @@ module ConvenientService
         # can focus on the rest.
         #
         #   bc = ActiveSupport::BacktraceCleaner.new
-        #   bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
+        #   root = Rails.root} + "/"
+        #   bc.add_filter   { |line| line.delete_prefix(root) } # strip the Rails.root prefix
         #   bc.add_silencer { |line| /puma|rubygems/.match?(line) } # skip any lines from puma or rubygems
         #   bc.clean(exception.backtrace) # perform the cleanup
         #
@@ -48,6 +56,7 @@ module ConvenientService
         class BacktraceCleaner
           def initialize
             @filters, @silencers = [], []
+            add_core_silencer
             add_gem_filter
             add_gem_silencer
             add_stdlib_silencer
@@ -90,8 +99,9 @@ module ConvenientService
           # 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.to_s, '') }
+          #   # Will turn "/my/rails/root/app/models/person.rb" into "app/models/person.rb"
+          #   root = Rails.root} + "/"
+          #   backtrace_cleaner.add_filter { |line| line.delete_prefix(root) }
           def add_filter(&block)
             @filters << block
           end
@@ -122,6 +132,16 @@ module ConvenientService
           private
             FORMATTED_GEMS_PATTERN = /\A[^\/]+ \([\w.]+\) /
 
+            def initialize_copy(_other)
+              @filters = @filters.dup
+              @silencers = @silencers.dup
+            end
+
+            ##
+            # @internal
+            #   NOTE: `gems_paths` can NOT be empty, even theoretically.
+            #   TODO: Contribute.
+            #
             def add_gem_filter
               gems_paths = (Gem.path | [Gem.default_dir]).map { |p| Regexp.escape(p) }
               return if gems_paths.empty?
@@ -131,6 +151,10 @@ module ConvenientService
               add_filter { |line| line.sub(gems_regexp, gems_result) }
             end
 
+            def add_core_silencer
+              add_silencer { |line| line.include?("<internal:") }
+            end
+
             def add_gem_silencer
               add_silencer { |line| FORMATTED_GEMS_PATTERN.match?(line) }
             end

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # @internal
 #   NOTE:

data/lib/convenient_service/dependencies/extractions/active_support_concern/concern.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+##
+# @author Rails Team <https://rubyonrails.org>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/rails/rails/blob/main/activesupport/lib/active_support/concern.rb
+##
+
 module ConvenientService
   module Dependencies
     module Extractions
@@ -10,7 +17,10 @@ module ConvenientService
       #     Version: v7.0.4.3.
       #     Wrapped in a namespace `ConvenientService::Dependencies::Extractions::ActiveSupportConcern`.
       #     Added `instance_methods` that works in a similar way as `class_methods`.
+      #     Added `singleton_class_methods` that works in a similar way as `class_methods`.
       #     Also `ClassMethods` (and `InstanceMethods`) are loaded after `included` block, not as in the original implementation.
+      #     Added `eval_included_block` to have a template method.
+      #     Added `eval_prepended_block` to have a template method.
       #
       #   - https://api.rubyonrails.org/v7.0.4.3/classes/ActiveSupport/Concern.html
       #   - https://github.com/rails/rails/blob/v7.0.4.3/activesupport/lib/active_support/concern.rb
@@ -156,7 +166,7 @@ module ConvenientService
               @_dependencies.each { |dep| base.include(dep) }
               super
 
-              base.class_eval(&@_included_block) if instance_variable_defined?(:@_included_block)
+              eval_included_block(base)
 
               ##
               # NOTE: Customization compared to original `Concern` implementation.
@@ -166,6 +176,8 @@ module ConvenientService
               base.include const_get(:InstanceMethods) if const_defined?(:InstanceMethods)
 
               base.extend const_get(:ClassMethods) if const_defined?(:ClassMethods)
+
+              base.singleton_class.extend const_get(:SingletonClassMethods) if const_defined?(:SingletonClassMethods)
             end
           end
 
@@ -178,7 +190,7 @@ module ConvenientService
               @_dependencies.each { |dep| base.prepend(dep) }
               super
 
-              base.class_eval(&@_prepended_block) if instance_variable_defined?(:@_prepended_block)
+              eval_prepended_block(base)
 
               ##
               # NOTE: Customization compared to original `Concern` implementation.
@@ -268,6 +280,52 @@ module ConvenientService
 
             mod.module_eval(&class_methods_module_definition)
           end
+
+          # Define singleton class methods from given block.
+          # You can define private class methods as well.
+          #
+          #   module Example
+          #     extend ActiveSupport::Concern
+          #
+          #     singleton_class_methods do
+          #       def foo; puts 'foo'; end
+          #
+          #       private
+          #         def bar; puts 'bar'; end
+          #     end
+          #   end
+          #
+          #   class Buzz
+          #     include Example
+          #   end
+          #
+          #   Buzz.singleton_class.foo # => "foo"
+          #   Buzz.singleton_class.bar # => private method 'bar' called for Buzz:Class(NoMethodError)
+          def singleton_class_methods(&singleton_class_methods_module_definition)
+            mod = const_defined?(:SingletonClassMethods, false) ?
+              const_get(:SingletonClassMethods) :
+              const_set(:SingletonClassMethods, Module.new)
+
+            mod.module_eval(&singleton_class_methods_module_definition)
+          end
+
+          private
+
+          ##
+          # @param base [Class]
+          # @return [void]
+          #
+          def eval_included_block(base)
+            base.class_eval(&@_included_block) if instance_variable_defined?(:@_included_block)
+          end
+
+          ##
+          # @param base [Class]
+          # @return [void]
+          #
+          def eval_prepended_block(base)
+            base.class_eval(&@_prepended_block) if instance_variable_defined?(:@_prepended_block)
+          end
         end
       end
     end

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # @internal
 #   NOTE:
@@ -7,7 +12,8 @@
 #     Version: v7.0.4.3.
 #     Wrapped in a namespace `ConvenientService::Dependencies::Extractions::ActiveSupportConcern`.
 #     Added `instance_methods` that works in a similar way as `class_methods`.
-#     Also `ClassMethods` (and `InstanceMethods`) are loaded after `included` block, not as in the original implementation.
+#     Added `signleton_class_methods` that works in a similar way as `class_methods`.
+#     Also `ClassMethods` (`InstanceMethods` and `SingletonClassMethods`) are loaded after `included` block, not as in the original implementation.
 #
 #   - https://github.com/rails/rails/blob/v7.0.4.3/activesupport/lib/active_support/concern.rb
 #   - https://github.com/marian13/rails/blob/v7.0.4.3/activesupport/lib/active_support/concern.rb

data/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/builder.rb

@@ -1,3 +1,13 @@
+##
+# @author Ruby Middleware Team <https://github.com/Ibsciss/ruby-middleware>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/Ibsciss/ruby-middleware
+##
+
+##
+# @!visibility private
+#
 require_relative 'logger'
 
 module ConvenientService

data/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/logger.rb

@@ -1,5 +1,9 @@
-require 'logger'
-require 'pp'
+##
+# @author Ruby Middleware Team <https://github.com/Ibsciss/ruby-middleware>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/Ibsciss/ruby-middleware
+##
 
 module ConvenientService
   module Dependencies
@@ -11,6 +15,7 @@ module ConvenientService
         #     Copied from `Ibsciss/ruby-middleware` without any logic modification.
         #     Version: v0.4.2.
         #     - Wrapped in a namespace `ConvenientService::Dependencies::Extractions::RubyMiddleware`.
+        #     - Removed `require 'logger'` and `require 'pp'`.
         #
         #   - https://github.com/marian13/ruby-middleware/blob/v0.4.2/lib/middleware/logger.rb
         #

data/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware/runner.rb

@@ -1,3 +1,10 @@
+##
+# @author Ruby Middleware Team <https://github.com/Ibsciss/ruby-middleware>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/Ibsciss/ruby-middleware
+##
+
 module ConvenientService
   module Dependencies
     module Extractions
@@ -5,7 +12,7 @@ module ConvenientService
         ##
         # @internal
         #   NOTE:
-        #     Copied from `Ibsciss/ruby-middleware` without any logic modification.
+        #     Copied from `Ibsciss/ruby-middleware` with one logic modification.
         #     Version: v0.4.2.
         #     - Wrapped in a namespace `ConvenientService::Dependencies::Extractions::RubyMiddleware`.
         #     - Added support of middleware creators.

data/lib/convenient_service/dependencies/extractions/ruby_middleware/middleware.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+##
+# @author Ruby Middleware Team <https://github.com/Ibsciss/ruby-middleware>
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+# @see https://github.com/Ibsciss/ruby-middleware
+##
+
 ##
 # @internal
 #   NOTE:

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # @internal
 #   NOTE:

data/lib/convenient_service/dependencies/extractions.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # This file load extracted dependencies.
 #

data/lib/convenient_service/dependencies/only_development_tools.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
+##
+# @!visibility private
+#
+require_relative "only_queries"
+
+ConvenientService::Dependencies.require_development_tools(amazing_print: false, awesome_print: true)

data/lib/convenient_service/dependencies/only_queries.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 ##
 # @internal
 #   - https://ruby-doc.org/stdlib-2.7.0/libdoc/rubygems/rdoc/Gem/Version.html
 #   - https://github.com/rubygems/rubygems
 #   - https://github.com/rubygems/rubygems/blob/master/lib/rubygems/version.rb
 #
+# @!visibility private
+#
 require "rubygems"
 
 ##
@@ -14,6 +21,8 @@ require "rubygems"
 # @internal
 #   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
 #
+# @!visibility private
+#
 require_relative "queries"
 
 ##

data/lib/convenient_service/dependencies/queries/gems/active_model.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries

data/lib/convenient_service/dependencies/queries/gems/logger.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries

data/lib/convenient_service/dependencies/queries/gems/paint.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries

data/lib/convenient_service/dependencies/queries/gems/rspec.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries
@@ -39,6 +44,7 @@ module ConvenientService
             #
             #   `::RSpec.current_example` docs:
             #   - https://www.rubydoc.info/github/rspec/rspec-core/RSpec.current_example
+            #   - https://github.com/rspec/rspec-core/blob/v3.0.0/lib/rspec/core.rb#L103
             #   - https://github.com/rspec/rspec-core/blob/v3.12.0/lib/rspec/core.rb#L122
             #   - https://relishapp.com/rspec/rspec-core/docs/metadata/current-example
             #

data/lib/convenient_service/dependencies/queries/gems.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "gems/active_model"
 require_relative "gems/logger"
 require_relative "gems/paint"

data/lib/convenient_service/dependencies/queries/ruby.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries
@@ -29,6 +34,11 @@ module ConvenientService
             ::RUBY_ENGINE.to_s
           end
 
+          ##
+          # @return [String]
+          #
+          alias_method :engine_name, :engine
+
           ##
           # @return [ConvenientService::Dependencies::Queries::Version]
           #
@@ -60,9 +70,12 @@ module ConvenientService
           #   - https://github.com/janlelis/ruby_engine/blob/v2.0.0/lib/ruby_engine.rb#L19
           #
           def mri?
-            ::RUBY_ENGINE.to_s == "ruby"
+            engine == "ruby"
           end
 
+          ##
+          # @return [Boolean]
+          #
           alias_method :ruby?, :mri?
 
           ##
@@ -72,15 +85,8 @@ module ConvenientService
           #
           # @see https://github.com/rdp/os
           #
-          # @internal
-          #   NOTE: Gratefully copied from the `os` gem. Version `1.1.4`.
-          #   - https://github.com/rdp/os/blob/v1.1.4/lib/os.rb#L101
-          #
-          #   NOTE: Modified original implementation in order to return a boolean.
-          #   NOTE: Consider to use `RUBY_ENGINE` as for others?
-          #
           def jruby?
-            ::RUBY_PLATFORM.to_s.match?(/java/)
+            engine.match?(/jruby/)
           end
 
           ##
@@ -88,13 +94,23 @@ module ConvenientService
           #
           # @return [Boolean]
           #
-          # @internal
-          #   NOTE: Taken from irb testing. May NOT be stable.
+          def truffleruby?
+            engine.match?(/truffleruby/)
+          end
+
+          ##
+          # Returns `true` when TruffleRuby, `false` otherwise.
           #
-          #   TODO: Find a confirmation of stability.
+          # @param pattern [String]
+          # @return [Boolean]
           #
-          def truffleruby?
-            ::RUBY_ENGINE.to_s.match?(/truffleruby/)
+          def match?(pattern)
+            engine_name, operator, engine_version = pattern.split(" ")
+
+            return false unless public_send("#{engine_name}?")
+            return false unless self.engine_version.public_send(operator, engine_version)
+
+            true
           end
         end
       end

data/lib/convenient_service/dependencies/queries/version/null_version.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Dependencies
     module Queries

data/lib/convenient_service/dependencies/queries/version.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "version/null_version"
 
 module ConvenientService