convenient_service 0.12.0 → 0.14.0

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_inspect/commands/generate_inspect_output.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    module Plugins
+                      module HasInspect
+                        module Commands
+                          class GenerateInspectOutput < Support::Command
+                            ##
+                            # @!attribute [r] data
+                            #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                            #
+                            attr_reader :data
+
+                            ##
+                            # @param data [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Data]
+                            # @return [void]
+                            #
+                            def initialize(data:)
+                              @data = data
+                            end
+
+                            ##
+                            # @return [String]
+                            #
+                            def call
+                              "<#{[printable_class, printable_values].reject(&:empty?).join(" ")}>"
+                            end
+
+                            private
+
+                            ##
+                            # @return [String]
+                            #
+                            def printable_class
+                              "#{data.result.class.name}::Data"
+                            end
+
+                            ##
+                            # @return [String]
+                            #
+                            def printable_values
+                              data
+                                .to_h
+                                .map { |key, value| "#{key}: #{truncate(value.inspect)}" }
+                                .join(" ")
+                            end
+
+                            ##
+                            # @param value [String]
+                            # @return [String]
+                            #
+                            def truncate(value)
+                              Utils::String.truncate(value, 15, omission: "...")
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_inspect/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/generate_inspect_output"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_inspect/concern.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Data
+                    module Plugins
+                      module HasInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            # @internal
+                            #   TODO: Specs.
+                            #
+                            def inspect
+                              Commands::GenerateInspectOutput.call(data: self)
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins/has_inspect.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "has_inspect/commands"
+require_relative "has_inspect/concern"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/data/plugins.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "plugins/has_inspect"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/data.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "data/commands"
 require_relative "data/concern"
+require_relative "data/plugins"
 
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/commands/is_message.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Commands
+                      ##
+                      # Check whether `message` can be considered as `Message` instance.
+                      #
+                      class IsMessage < Support::Command
+                        ##
+                        # @!attribute [r] message
+                        #   @return [Object] Can be any type.
+                        #
+                        attr_reader :message
+
+                        ##
+                        # @param message [Object] Can be any type.
+                        # @return [void]
+                        #
+                        def initialize(message:)
+                          @message = message
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def call
+                          message.class.include?(Entities::Message::Concern)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/is_message"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/message/concern/class_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -14,7 +14,7 @@ module ConvenientService
                       module ClassMethods
                         ##
                         # @param other [Object] Can be any type.
-                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message, nil]
+                        # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message, nil]
                         #
                         def cast(other)
                           case other
@@ -26,6 +26,18 @@ module ConvenientService
                             new(value: other.value)
                           end
                         end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        # @internal
+                        #   NOTE: Check `Module.===` in order to get an idea of how `super` works.
+                        #   - https://ruby-doc.org/core-2.7.0/Module.html#method-i-3D-3D-3D
+                        #
+                        def ===(other)
+                          Commands::IsMessage.call(message: other) || super
+                        end
                       end
                     end
                   end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/concern/instance_methods.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Concern
+                      module InstanceMethods
+                        include Support::Copyable
+
+                        ##
+                        # @!attribute [r] value
+                        #   @return [String]
+                        #
+                        attr_reader :value
+
+                        ##
+                        # @!attribute [r] result
+                        #   @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                        #
+                        attr_reader :result
+
+                        ##
+                        # @param value [String]
+                        # @param result [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                        # @return [void]
+                        #
+                        def initialize(value:, result: nil)
+                          @value = value
+                          @result = result
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def empty?
+                          value.empty?
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        def ==(other)
+                          return unless other.instance_of?(self.class)
+
+                          return false if result.class != other.result.class
+                          return false if value != other.value
+
+                          true
+                        end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        # @note `Message#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
+                        #
+                        # @example RSpec expectation matchers.
+                        #   expect(result).to be_failure.with_message(match(/foo/))
+                        #
+                        # @see https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
+                        # @see https://rspec.info/documentation/3.12/rspec-expectations/RSpec/Matchers/BuiltIn.html
+                        # @see https://github.com/rspec/rspec-expectations/blob/v3.12.3/lib/rspec/matchers/composable.rb#L45
+                        #
+                        # @example RSpec mocks arguments matchers.
+                        #   expect(result).to be_failure.with_message(instance_of(String))
+                        #
+                        # @see https://rspec.info/features/3-12/rspec-mocks/setting-constraints/matching-arguments
+                        # @see https://rspec.info/documentation/3.12/rspec-mocks/RSpec/Mocks/ArgumentMatchers.html
+                        # @see https://github.com/rspec/rspec-mocks/blob/v3.12.3/lib/rspec/mocks/argument_matchers.rb#L282
+                        #
+                        # @internal
+                        #   IMPORTANT: Must be kept in sync with `#==`.
+                        #   NOTE: Ruby does NOT have `!==` operator.
+                        #
+                        def ===(other)
+                          return unless other.instance_of?(self.class)
+
+                          return false if result.class != other.result.class
+                          return false unless value === other.value
+
+                          true
+                        end
+
+                        ##
+                        # @return [Hash{Symbol => Object}]
+                        #
+                        def to_kwargs
+                          to_arguments.kwargs
+                        end
+
+                        ##
+                        # @return [ConveninentService::Support::Arguments]
+                        #
+                        def to_arguments
+                          @to_arguments ||= Support::Arguments.new(value: value, result: result)
+                        end
+
+                        ##
+                        # @return [String]
+                        #
+                        def to_s
+                          @to_s ||= value.to_s
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/message/concern.rb

@@ -6,7 +6,7 @@ require_relative "concern/instance_methods"
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Message = ::ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Message::Plugins
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_awesome_print_inspect/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Plugins
+                      module HasAwesomePrintInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              metadata = {
+                                ConvenientService: {
+                                  entity: "Message",
+                                  result: result.class.name,
+                                  text: to_s
+                                }
+                              }
+
+                              metadata.ai
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_awesome_print_inspect.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_awesome_print_inspect/concern"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_inspect/concern.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Message
+                    module Plugins
+                      module HasInspect
+                        module Concern
+                          include Support::Concern
+
+                          instance_methods do
+                            ##
+                            # @return [String]
+                            #
+                            def inspect
+                              "<#{self.class} text: \"#{value}\">"
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins/has_inspect.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "has_inspect/concern"

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/message/plugins.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "plugins/has_inspect"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/message.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "message/commands"
 require_relative "message/concern"
+require_relative "message/plugins"
 
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/commands/is_status.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasJSendResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJSendStatusAndAttributes
+                module Entities
+                  class Status
+                    module Commands
+                      ##
+                      # Check whether `status` can be considered as `Status` instance.
+                      #
+                      class IsStatus < Support::Command
+                        ##
+                        # @!attribute [r] status
+                        #   @return [Object] Can be any type.
+                        #
+                        attr_reader :status
+
+                        ##
+                        # @param status [Object] Can be any type.
+                        # @return [void]
+                        #
+                        def initialize(status:)
+                          @status = status
+                        end
+
+                        ##
+                        # @return [Boolean]
+                        #
+                        def call
+                          status.class.include?(Entities::Status::Concern)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_j_send_result/entities/result/plugins/has_j_send_status_and_attributes/entities/status/commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "commands/is_status"

data/lib/convenient_service/service/plugins/{has_result → has_j_send_result}/entities/result/plugins/has_j_send_status_and_attributes/entities/status/concern/class_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResult
+      module HasJSendResult
         module Entities
           class Result
             module Plugins
@@ -14,7 +14,7 @@ module ConvenientService
                       module ClassMethods
                         ##
                         # @param other [Object] Can be any type.
-                        # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status, nil]
+                        # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status, nil]
                         #
                         def cast(other)
                           case other
@@ -26,6 +26,18 @@ module ConvenientService
                             new(value: other.value)
                           end
                         end
+
+                        ##
+                        # @param other [Object] Can be any type.
+                        # @return [Boolean, nil]
+                        #
+                        # @internal
+                        #   NOTE: Check `Module.===` in order to get an idea of how `super` works.
+                        #   - https://ruby-doc.org/core-2.7.0/Module.html#method-i-3D-3D-3D
+                        #
+                        def ===(other)
+                          Commands::IsStatus.call(status: other) || super
+                        end
                       end
                     end
                   end