convenient_service 0.1.0 → 0.2.1

data/lib/convenient_service/rspec/matchers/custom/results/be_success.rb

@@ -27,6 +27,12 @@ module ConvenientService
               self
             end
 
+            def without_data
+              chain[:data] = {}
+
+              self
+            end
+
             def of(service_class)
               chain[:service_class] = service_class
 

data/lib/convenient_service/service/plugins/aliases.rb

@@ -4,5 +4,6 @@ module ConvenientService
   module Plugins
     Result = ::ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins
     Service = ::ConvenientService::Service::Plugins
+    Step = ::ConvenientService::Service::Plugins::HasResultSteps::Entities::Step::Plugins
   end
 end

data/lib/convenient_service/service/plugins/has_inspect/concern.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasInspect
+        module Concern
+          include Support::Concern
+
+          instance_methods do
+            ##
+            # @return [String]
+            # @since 0.2.0
+            #
+            def inspect
+              "<#{self.class.name}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_inspect.rb

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

data/lib/convenient_service/service/plugins/has_result/commands/create_result_class.rb

@@ -8,10 +8,17 @@ module ConvenientService
           class CreateResultClass < Support::Command
             attr_reader :service_class
 
+            ##
+            # @param service_class [Class]
+            # @return [void]
+            #
             def initialize(service_class:)
               @service_class = service_class
             end
 
+            ##
+            # @return [void]
+            #
             def call
               result_class.include Entities::Result::Concern
 
@@ -45,6 +52,9 @@ module ConvenientService
 
             private
 
+            ##
+            # @return [Class]
+            #
             def result_class
               @result_class ||= Utils::Module.get_own_const(service_class, :Result) || ::Class.new(Entities::Result)
             end

data/lib/convenient_service/service/plugins/has_result/concern/class_methods.rb

@@ -7,28 +7,25 @@ module ConvenientService
         module Concern
           module ClassMethods
             ##
-            #
+            # @api public
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
             #
             def result(...)
               new(...).result
             end
 
             ##
-            # https://ruby-doc.org/core-2.5.0/Class.html#method-i-allocate
-            # https://frontdeveloper.pl/2018/11/ruby-allocate-method/
+            # @api private
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
             #
-            def new_without_initialize
-              allocate
-            end
-
-            ##
-            # NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
+            # @internal
+            #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def success(
               service: Constants::DEFAULT_SERVICE_INSTANCE,
               data: Constants::DEFAULT_SUCCESS_DATA
             )
-              result_class.new(
+              result_class.create(
                 service: service,
                 status: Constants::SUCCESS_STATUS,
                 data: data,
@@ -38,14 +35,18 @@ module ConvenientService
             end
 
             ##
-            # NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
+            # @api private
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            #
+            # @internal
+            #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def failure(
               service: Constants::DEFAULT_SERVICE_INSTANCE,
               data: Constants::DEFAULT_FAILURE_DATA,
               message: data.any? ? data.first.join(" ") : Constants::DEFAULT_FAILURE_MESSAGE
             )
-              result_class.new(
+              result_class.create(
                 service: service,
                 status: Constants::FAILURE_STATUS,
                 data: data,
@@ -55,14 +56,18 @@ module ConvenientService
             end
 
             ##
-            # NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
+            # @api private
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            #
+            # @internal
+            #   NOTE: This method is internally used by custom RSpec helper `stub_service`. It should NOT be used in the client code.
             #
             def error(
               service: Constants::DEFAULT_SERVICE_INSTANCE,
               message: Constants::DEFAULT_ERROR_MESSAGE,
               code: Constants::DEFAULT_ERROR_CODE
             )
-              result_class.new(
+              result_class.create(
                 service: service,
                 status: Constants::ERROR_STATUS,
                 data: Constants::ERROR_DATA,
@@ -71,6 +76,10 @@ module ConvenientService
               )
             end
 
+            ##
+            # @api private
+            # @return [Class]
+            #
             def result_class
               @result_class ||= Commands::CreateResultClass.call(service_class: self)
             end

data/lib/convenient_service/service/plugins/has_result/concern/instance_methods.rb

@@ -6,21 +6,37 @@ module ConvenientService
       module HasResult
         module Concern
           module InstanceMethods
+            ##
+            # @api public
+            # @raise [ConvenientService::Service::Plugins::HasResult::Errors::ResultIsNotOverridden]
+            #
             def result
               raise Errors::ResultIsNotOverridden.new(service: self)
             end
 
             ##
-            # TODO: Specs.
+            # @api public
+            # @param kwargs [Hash]
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
             #
             def success(**kwargs)
               self.class.success(**kwargs.merge(service: self))
             end
 
+            ##
+            # @api public
+            # @param kwargs [Hash]
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            #
             def failure(**kwargs)
               self.class.failure(**kwargs.merge(service: self))
             end
 
+            ##
+            # @api public
+            # @param kwargs [Hash]
+            # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            #
             def error(**kwargs)
               self.class.error(**kwargs.merge(service: self))
             end

data/lib/convenient_service/service/plugins/has_result/entities/result/concern.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require_relative "concern/instance_methods"
-
 module ConvenientService
   module Service
     module Plugins
       module HasResult
         module Entities
           class Result
+            ##
+            # @internal
+            #   This concern is needed for `CastResultClass` and `be_success`, `be_error`, `be_failure` matchers.
+            #
             module Concern
-              include Support::Concern
             end
           end
         end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasInspect
+                module Concern
+                  include Support::Concern
+
+                  instance_methods do
+                    ##
+                    # @return [String]
+                    # @since 0.2.0
+                    #
+                    def inspect
+                      "<#{service.class.name}::Result status: :#{status}>"
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_inspect.rb

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

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands/cast_jsend_attributes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Commands
+                  class CastJSendAttributes < Support::Command
+                    attr_reader :attributes
+
+                    def initialize(attributes:)
+                      @attributes = attributes
+                    end
+
+                    def call
+                      Structs::JSendAttributes.new(
+                        service: attributes[:service],
+                        status: Entities::Status.cast!(attributes[:status]),
+                        data: Entities::Data.cast!(attributes[:data]),
+                        message: Entities::Message.cast!(attributes[:message]),
+                        code: Entities::Code.cast!(attributes[:code])
+                      )
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/commands.rb

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

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern/instance_methods.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Concern
+                  ##
+                  # TODO: How to use concern outside?
+                  #
+                  module InstanceMethods
+                    include Support::Delegate
+                    include Support::Copyable
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :success?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :failure?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :error?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_success?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_failure?, to: :status
+
+                    ##
+                    # @return [Boolean]
+                    #
+                    delegate :not_error?, to: :status
+
+                    ##
+                    # @return [Class]
+                    #
+                    delegate :service, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Status]
+                    #
+                    delegate :status, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    #
+                    delegate :data, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    #
+                    alias_method :unsafe_data, :data
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    #
+                    delegate :message, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    #
+                    alias_method :unsafe_message, :message
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    #
+                    delegate :code, to: :jsend_attributes
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    #
+                    alias_method :unsafe_code, :code
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Structs::JSendAttributes]
+                    #
+                    def jsend_attributes
+                      internals.cache[:jsend_attributes]
+                    end
+
+                    ##
+                    # @param other [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+                    # @return [Boolean, nil]
+                    #
+                    def ==(other)
+                      return unless other.instance_of?(self.class)
+
+                      return false if service.class != other.service.class
+                      return false if status != other.status
+                      return false if unsafe_data != other.unsafe_data
+                      return false if unsafe_message != other.unsafe_message
+                      return false if unsafe_code != other.unsafe_code
+
+                      true
+                    end
+
+                    ##
+                    # @return [Hash]
+                    #
+                    def to_kwargs
+                      {service: service, status: status, data: data, message: message, code: code}
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/concern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "concern/instance_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Concern
+                  include Support::Concern
+
+                  included do |result_class|
+                    result_class.include InstanceMethods
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code/class_methods.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Code
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::String
+                          new(value: other.to_sym)
+                        when ::Symbol
+                          new(value: other)
+                        when Code
+                          new(value: other.value)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/code.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "code/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Code
+                    include Support::Castable
+
+                    extend ClassMethods
+
+                    attr_reader :value
+
+                    def initialize(value:)
+                      @value = value
+                    end
+
+                    def ==(other)
+                      casted = cast(other)
+
+                      return unless casted
+
+                      value == casted.value
+                    end
+
+                    def to_s
+                      @to_s ||= value.to_s
+                    end
+
+                    def to_sym
+                      @to_sym ||= value.to_sym
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data/class_methods.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Data
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::Hash
+                          new(value: other.transform_keys(&:to_sym))
+                        when Data
+                          new(value: other.value)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/data.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "data/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Data
+                    include Support::Castable
+
+                    extend ClassMethods
+
+                    attr_reader :value
+
+                    def initialize(value:)
+                      @value = value
+                    end
+
+                    def ==(other)
+                      casted = cast(other)
+
+                      return unless casted
+
+                      value == casted.value
+                    end
+
+                    def [](key)
+                      value.fetch(key.to_sym) { raise Errors::NotExistingAttribute.new(attribute: key) }
+                    end
+
+                    def to_h
+                      @to_h ||= value.to_h
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/entities/message/class_methods.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module HasResult
+        module Entities
+          class Result
+            module Plugins
+              module HasJsendStatusAndAttributes
+                module Entities
+                  class Message
+                    module ClassMethods
+                      def cast(other)
+                        case other
+                        when ::String
+                          new(value: other)
+                        when ::Symbol
+                          new(value: other.to_s)
+                        when Message
+                          new(value: other.value)
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end