convenient_service 0.17.0 → 0.19.0

data/lib/convenient_service/dependencies.rb

@@ -2,6 +2,7 @@
 
 require_relative "dependencies/built_in"
 require_relative "dependencies/extractions"
+require_relative "dependencies/queries"
 
 ##
 # `ConvenientService::Dependencies` can dynamically require plugins/extensions that have external dependencies.
@@ -11,435 +12,6 @@ require_relative "dependencies/extractions"
 #
 module ConvenientService
   module Dependencies
-    class << self
-      ##
-      # @api private
-      #
-      # @return [Boolean]
-      # @see ConvenientService.Dependencies.require_has_j_send_result_params_validations_using_active_model_validations
-      #
-      def support_has_j_send_result_params_validations_using_active_model_validations?
-        return false unless active_model.loaded?
-        return false if ruby.version >= 3.0 && active_model.version < 6.0
-
-        true
-      end
-
-      ##
-      # @api private
-      #
-      # @return [Boolean]
-      #
-      # @see https://github.com/ruby/logger/commit/74690b87b15244e19dd91cd06ae295251e1e5781
-      #
-      def support_logger_non_integer_levels?
-        logger.version >= "1.3.0"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_alias
-        require_relative "alias"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_assigns_attributes_in_constructor_using_active_model_attribute_assignment
-        ##
-        # - https://edgeguides.rubyonrails.org/active_model_basics.html
-        # - https://api.rubyonrails.org/classes/ActiveModel.html
-        # - https://github.com/rails/rails/tree/main/activemodel
-        #
-        require "active_model"
-
-        require_relative "common/plugins/assigns_attributes_in_constructor/using_active_model_attribute_assignment"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_assigns_attributes_in_constructor_using_dry_initializer
-        ##
-        # - https://dry-rb.org/gems/dry-initializer/main
-        # - https://github.com/dry-rb/dry-initializer
-        #
-        require "dry-initializer"
-
-        require_relative "common/plugins/assigns_attributes_in_constructor/using_dry_initializer"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_can_utilize_finite_loop
-        require_relative "common/plugins/can_utilize_finite_loop"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_has_attributes_using_active_model_attributes
-        ##
-        # - https://edgeguides.rubyonrails.org/active_model_basics.html
-        # - https://api.rubyonrails.org/classes/ActiveModel.html
-        # - https://github.com/rails/rails/tree/main/activemodel
-        #
-        require "active_model"
-
-        require_relative "common/plugins/has_attributes/using_active_model_attributes"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_awesome_print_inspect
-        ##
-        # - https://github.com/awesome-print/awesome_print
-        #
-        require "awesome_print"
-
-        require_relative "service/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/code/plugins/has_awesome_print_inspect"
-        require_relative "service/plugins/can_have_steps/entities/step/plugins/has_awesome_print_inspect"
-        require_relative "service/configs/awesome_print_inspect"
-        require_relative "service/configs/awesome_print_inspect/aliases"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      # @see https://userdocs.convenientservice.org/troubleshooting/i18n_translate_wrong_number_of_arguments
-      #
-      def require_has_j_send_result_params_validations_using_active_model_validations
-        ##
-        # - https://edgeguides.rubyonrails.org/active_model_basics.html
-        # - https://api.rubyonrails.org/classes/ActiveModel.html
-        # - https://github.com/rails/rails/tree/main/activemodel
-        #
-        require "active_model"
-
-        require_relative "service/plugins/has_j_send_result_params_validations/using_active_model_validations"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_has_j_send_result_params_validations_using_dry_validation
-        ##
-        # - https://dry-rb.org/gems/dry-validation/main/
-        # - https://github.com/dry-rb/dry-validation
-        #
-        require "dry-validation"
-
-        require_relative "service/plugins/has_j_send_result_params_validations/using_dry_validation"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_rescues_result_unhandled_exceptions
-        require_relative "service/plugins/rescues_result_unhandled_exceptions"
-      end
-
-      ##
-      # @api public
-      #
-      # @return [Boolean]
-      # @note Expected to be called from app entry points like `initializers` in Rails.
-      #
-      def require_cleans_exception_backtrace
-        require_relative "dependencies/extractions/active_support_backtrace_cleaner"
-      end
-
-      ##
-      # @api private
-      #
-      # @return [Boolean]
-      # @note Expected to be called from `irb`, `pry`, `spec_helper.rb`, etc.
-      #
-      # @internal
-      #   NOTE: `byebug` has C extensions, that is why it is NOT supported in JRuby.
-      #   - https://github.com/deivid-rodriguez/byebug/tree/master/ext/byebug
-      #   - https://github.com/deivid-rodriguez/byebug/issues/179#issuecomment-152727003
-      #
-      def require_development_tools
-        ##
-        # - https://github.com/awesome-print/awesome_print
-        #
-        require "awesome_print"
-
-        ##
-        # - https://github.com/gsamokovarov/break
-        #
-        require "break"
-
-        ##
-        # - https://github.com/deivid-rodriguez/byebug
-        #
-        require "byebug" unless ruby.jruby?
-
-        ##
-        # - https://github.com/ruby/debug
-        #
-        require "debug" unless ruby.jruby?
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/ostruct/rdoc/OpenStruct.html
-        # - https://github.com/ruby/ostruct
-        #
-        require "ostruct"
-
-        ##
-        # - https://github.com/janlelis/paint
-        #
-        require "paint"
-
-        ##
-        # - https://github.com/rouge-ruby/rouge
-        #
-        require "rouge"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html
-        # - https://github.com/ruby/tempfile
-        #
-        require "tempfile"
-
-        ##
-        # - https://gist.github.com/marian13/5dade20a431d7254db30e543167058ce
-        #
-        require_relative "dependencies/extractions/byebug_syntax_highlighting" unless ruby.jruby?
-
-        require_relative "dependencies/extractions/b" unless ruby.jruby?
-
-        ##
-        #
-        #
-        require_relative "dependencies/extractions/ce"
-      end
-
-      ##
-      # @api private
-      #
-      # @return [Boolean]
-      # @note Expected to be called from `spec_helper.rb`.
-      #
-      def require_test_tools
-        ##
-        # - https://github.com/faker-ruby/faker
-        #
-        require "faker"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/ostruct/rdoc/OpenStruct.html
-        # - https://github.com/ruby/ostruct
-        #
-        require "ostruct"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/tempfile/rdoc/Tempfile.html
-        # - https://github.com/ruby/tempfile
-        #
-        require "tempfile"
-      end
-
-      ##
-      # @api public
-      #
-      # Loads RSpec extensions like `be_success` matcher, `stub_service` helper, etc.
-      #
-      # @return [Boolean]
-      # @note Expected to be called from `spec_helper.rb`.
-      #
-      def require_rspec_extentions
-        require "rspec/expectations"
-        require "rspec/matchers"
-        require "rspec/mocks"
-
-        require_relative "rspec"
-      end
-
-      ##
-      # @api private
-      #
-      # Loads standard config examples.
-      #
-      # @param version [String]
-      # @return [Boolean]
-      #
-      def require_standard_examples(version: "")
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/date/rdoc/Date.html
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/date/rdoc/DateTime.html
-        # - https://github.com/ruby/date
-        #
-        require "date"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
-        # - https://github.com/flori/json
-        #
-        require "json"
-
-        ##
-        # - https://github.com/jfelchner/ruby-progressbar
-        #
-        require "progressbar"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
-        # - https://github.com/ruby/webrick
-        #
-        require "webrick"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/uri/rdoc/URI.html
-        # - https://github.com/ruby/uri
-        #
-        require "uri"
-
-        require_relative ::File.join("examples", "standard", version, "cowsay")
-        require_relative ::File.join("examples", "standard", version, "date_time")
-        require_relative ::File.join("examples", "standard", version, "factorial")
-        require_relative ::File.join("examples", "standard", version, "gemfile")
-        require_relative ::File.join("examples", "standard", version, "request_params")
-      end
-
-      ##
-      # @api private
-      #
-      # Loads rails config examples.
-      #
-      # @param version [String]
-      # @return [Boolean]
-      #
-      def require_rails_examples(version: "")
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
-        # - https://github.com/flori/json
-        #
-        require "json"
-
-        ##
-        # - https://github.com/jfelchner/ruby-progressbar
-        #
-        require "progressbar"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
-        # - https://github.com/ruby/webrick
-        #
-        require "webrick"
-
-        require_relative ::File.join("examples", "rails", version, "gemfile")
-      end
-
-      ##
-      # @api private
-      #
-      # Loads dry config examples.
-      #
-      # @param version [String]
-      # @return [Boolean]
-      #
-      def require_dry_examples(version: "")
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/json/rdoc/JSON.html
-        # - https://github.com/flori/json
-        #
-        require "json"
-
-        ##
-        # - https://github.com/jfelchner/ruby-progressbar
-        #
-        require "progressbar"
-
-        ##
-        # - https://ruby-doc.org/stdlib-2.7.0/libdoc/webrick/rdoc/WEBrick.html
-        # - https://github.com/ruby/webrick
-        #
-        require "webrick"
-
-        require_relative ::File.join("examples", "dry", version, "gemfile")
-      end
-
-      ##
-      # @api private
-      #
-      # @return [ConvenientService::Support::Ruby]
-      #
-      def ruby
-        Support::Ruby
-      end
-
-      ##
-      # @api private
-      #
-      # @return [ConvenientService::Support::RSpec]
-      #
-      def rspec
-        Support::Gems::RSpec
-      end
-
-      ##
-      # @api private
-      #
-      # @return [ConvenientService::Support::Gems::ActiveModel]
-      #
-      def active_model
-        Support::Gems::ActiveModel
-      end
-
-      ##
-      # @api private
-      #
-      # @return [ConvenientService::Support::Gems::Logger]
-      #
-      def logger
-        Support::Gems::Logger
-      end
-
-      ##
-      # @api private
-      #
-      # @return [ConvenientService::Support::Gems::Paint]
-      #
-      def paint
-        Support::Gems::Paint
-      end
-    end
+    extend Queries
   end
 end

data/lib/convenient_service/feature/configs/standard.rb

@@ -19,8 +19,6 @@ module ConvenientService
           end
 
           middlewares :new, scope: :class do
-            use ConvenientService::Plugins::Common::NormalizesEnv::Middleware
-
             use ConvenientService::Plugins::Common::HasInstanceProxy::Middleware
           end
         end

data/lib/convenient_service/logger.rb

@@ -36,11 +36,19 @@ module ConvenientService
       #   - https://github.com/ruby/logger/blob/v1.5.3/lib/logger.rb#L397
       #
       #   TODO: Specs for `super(::STDOUT)`.
+      #   TODO: Warning and fallback when `CONVENIENT_SERVICE_LOGGER_LEVEL` is NOT valid.
       #
       # rubocop:disable Style/GlobalStdStream
       def new
         super(::STDOUT).tap do |logger|
-          logger.level = ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"] || ::Logger::INFO
+          logger.level =
+            if ::ENV["CONVENIENT_SERVICE_DEBUG"] == "true"
+              ::Logger::DEBUG
+            elsif ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"]
+              ::ENV["CONVENIENT_SERVICE_LOGGER_LEVEL"]
+            else
+              ::Logger::INFO
+            end
 
           logger.formatter = (::ENV["CONVENIENT_SERVICE_LOGGER_ENABLE_COLORS"] == "true") ? colored_formatter : original_formatter
         end

data/lib/convenient_service/rspec/matchers/classes/call_chain_next.rb

@@ -11,6 +11,13 @@ module ConvenientService
         #     .with_arguments(*args, **kwargs, &block)
         #     .and_return_its_value
         #
+        # @internal
+        #   TODO:
+        #     expect { method.call }
+        #       .to call_chain_next.on(method)
+        #       .with_arguments(*args, **kwargs, &block)
+        #       .and_return { |chain_value| chain_value.copy(kwargs: {overrides: {foo: :bar}})}
+        #
         class CallChainNext
           include ::RSpec::Expectations
           include ::RSpec::Matchers
@@ -45,6 +52,10 @@ module ConvenientService
               expect(value).to eq(method.chain_value)
             end
 
+            if used_and_return?
+              expect(value).to eq(return_block.call(method.chain_value))
+            end
+
             true
           end
 
@@ -88,6 +99,10 @@ module ConvenientService
               expect(value).not_to eq(method.chain_value)
             end
 
+            if used_and_return?
+              expect(value).not_to eq(return_block.call(method.chain_value))
+            end
+
             true
           end
 
@@ -170,6 +185,18 @@ module ConvenientService
             self
           end
 
+          ##
+          # @param args [Array<Object>]
+          # @param block [Proc, nil]
+          #
+          # @return [ConvenientService::RSpec::Matchers::Classes::CallChainNext]
+          #
+          def and_return(*args, &block)
+            chain[:and_return] = args.any? ? proc { args.first } : block
+
+            self
+          end
+
           private
 
           ##
@@ -192,6 +219,13 @@ module ConvenientService
             chain.key?(:and_return_its_value)
           end
 
+          ##
+          # @return [Boolean]
+          #
+          def used_and_return?
+            chain.key?(:and_return)
+          end
+
           ##
           # @return [Hash{Symbol => Object}]
           #
@@ -242,6 +276,13 @@ module ConvenientService
             @block = chain.dig(:with_arguments, :block)
           end
 
+          ##
+          # @return [Proc]
+          #
+          def return_block
+            @return_block ||= chain[:and_return]
+          end
+
           ##
           # @return [Proc, nil]
           #

data/lib/convenient_service/rspec/primitive_matchers/classes/delegate_to/commands/generate_printable_method.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module PrimitiveMatchers
+      module Classes
+        class DelegateTo
+          module Commands
+            class GeneratePrintableMethod < Support::Command
+              ##
+              # @!attribute [r] object
+              #   @return [Object] Can be any type.
+              #
+              attr_reader :object
+
+              ##
+              # @!attribute [r] method
+              #   @return [Symbol, String]
+              #
+              attr_reader :method
+
+              ##
+              # @param object [Object] Can by any type.
+              # @param method [Symbol, String]
+              # @return [void]
+              #
+              def initialize(object:, method:)
+                @object = object
+                @method = method
+              end
+
+              def call
+                case Utils::Object.resolve_type(object)
+                when "class", "module"
+                  "#{object}.#{method}"
+                when "instance"
+                  "#{object.class}##{method}"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/rspec/primitive_matchers/classes/delegate_to/entities/delegation.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module PrimitiveMatchers
+      module Classes
+        class DelegateTo
+          module Entities
+            class Delegation
+              ##
+              # @api private
+              #
+              # @!attribute [r] arguments
+              #   @return [ConvenientService::RSpec::PrimitiveMatchers::Classes::DelegateTo::Entities::Delegation]
+              #
+              attr_reader :arguments
+
+              ##
+              # @api private
+              #
+              # @!attribute [r] method
+              #   @return [Symbol]
+              #
+              attr_reader :method
+
+              ##
+              # @api private
+              #
+              # @!attribute [r] object
+              #   @return [Object] Can be any type.
+              #
+              attr_reader :object
+
+              ##
+              # @api private
+              #
+              # @param object [Object] Can be any type.
+              # @param method [Symbol]
+              # @param args [Array<Object>]
+              # @param kwargs [Hash{Symbol => Object}]
+              # @param block [Proc, nil]
+              # @return [void]
+              #
+              def initialize(object:, method:, args:, kwargs:, block:)
+                @object = object
+                @method = method
+                @arguments = Support::Arguments.new(*args, **kwargs, &block)
+              end
+
+              ##
+              # @api private
+              #
+              # @return [Booleam]
+              #
+              def with_arguments?
+                arguments.any?
+              end
+
+              ##
+              # @api private
+              #
+              # @return [Boolean]
+              #
+              def without_arguments?
+                !with_arguments?
+              end
+
+              ##
+              # @api private
+              #
+              # @param other [Object]
+              # @return [Boolean]
+              #
+              def ==(other)
+                return unless other.instance_of?(self.class)
+
+                return false if object != other.object
+                return false if method != other.method
+                return false if arguments != other.arguments
+
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end