convenient_service 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03335557e59a7d6c469fe20e478efb1d7f9563d7651b5e0761e61d820e7515e6
-  data.tar.gz: 055c3cfaa2b176689bf8cc105d649a40779788279c89bd1f5a6bdfde8d7994c1
+  metadata.gz: 70d36eabeb3ea9598979a7158d06e0bfc627398066abc5180411f13fce9142e8
+  data.tar.gz: 6c6ea0ce690bb915c32f2e810afe70f87e74961f7a3c01b4e3a6389b8f98b1dc
 SHA512:
-  metadata.gz: f9f55f6baab2736bcbb8661a55bb494bdfb1f7e000a87b3c7c78f326b417e44bcd69cccb992b54435ec10ce919afc2e3a7cd73695858025fa241aff609b9882c
-  data.tar.gz: 72778dcdb0df0003b3c9b13a266af24a9c8de4150ed7d048887bd5007b223c88ce34c9494c186c5ac49ba0102ca5bd31858e37d55698fe1cfb49fe22dd6ed6e7
+  metadata.gz: aa610f3ac041e97849914d6bf15e626cceef9d8abd9aed0e5244b112595c89c9ac1eb91438bf67a84065bc8b90e91ebd8fff19cbcfb3c4a77e9b1246100b25fd
+  data.tar.gz: d704307543e1a14efa13f2701a109ee2748af75ed2260bbf9e4e64bc06b5bbe2a23ac208eabea1ec2d536578c9b9ec97c76541fa79181b9e896f4f844594d743

data/.github/workflows/ci.yml

@@ -128,14 +128,14 @@ jobs:
         run: task rspec:standard
       - name: Install dependencies for appraisals
         run: task deps:install
-      - name: Run RSpec with Rails 5.2
-        run: task rspec:rails_5.2
-      - name: Run RSpec with Rails 6.0
-        run: task rspec:rails_6.0
-      - name: Run RSpec with Rails 6.1
-        run: task rspec:rails_6.1
       - name: Run RSpec with Rails 7.0
         run: task rspec:rails_7.0
+      - name: Run RSpec with Rails 6.1
+        run: task rspec:rails_6.1
+      - name: Run RSpec with Rails 6.0
+        run: task rspec:rails_6.0
+      - name: Run RSpec with Rails 5.2
+        run: task rspec:rails_5.2
       - name: Run RSpec with Dry
         run: task rspec:dry
       ##

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.2.1](https://github.com/marian13/convenient_service/compare/v0.2.0...v0.2.1) (2022-12-14)
+
+
+### Bug Fixes
+
+* **has_result_steps:** return step copy to have fresh state ([55cc368](https://github.com/marian13/convenient_service/commit/55cc368484641040c0c76ecb38872cc9a268397c), [fc7cebb](https://github.com/marian13/convenient_service/commit/fc7cebb4e159af7b35eac3cf8c25c7009e14c9d1))
+* **standard:** place UsingActiveModelValidations before HasResultSteps ([4c43205](https://github.com/marian13/convenient_service/commit/4c43205382da2e7ae395fea6639c2bcc43d1eec2))
+* **standard:** place UsingDryValidation before HasResultSteps ([63c31c0](https://github.com/marian13/convenient_service/commit/63c31c04ac7c2581defd3557aad13db3188806ba))
+
 ## [0.2.0](https://github.com/marian13/convenient_service/compare/v0.1.0...v0.2.0) (2022-11-26)
 
 

data/ROADMAP.md

@@ -48,5 +48,8 @@
 | Low | 🚧 | [Receive Counts](https://relishapp.com/rspec/rspec-mocks/docs/setting-constraints/receive-counts) for `delegate_to` | | 
 | Low | 🚧 | Prefer versioning instead of modification plugin | |
 | Low | 🚧 | Consider to move `__steps__` and `__callbacks__` to `internals_class` | Benefit? |
+| Medium | 🚧 | User friendly `raise` that removes lib backtrace from caller | Should have a `debug` mode. Should work well with examples. Check RSpec `CallerFilter.first_non_rspec_line` |
+| High | 🚧 | A plugin that catches `StandardError` and returns `failure` | Should be the lowest in the stack |
+| High | 🚧 | `Support::Command` alias | Should be visible to the end user |
 
 Search for `TODO`s in the codebase for more tasks.

data/Taskfile.yml

@@ -201,10 +201,10 @@ tasks:
   rspec:
     cmds:
       - task: rspec:standard
-      - task: rspec:rails_5.2
-      - task: rspec:rails_6.0
-      - task: rspec:rails_6.1
       - task: rspec:rails_7.0
+      - task: rspec:rails_6.1
+      - task: rspec:rails_6.0
+      - task: rspec:rails_5.2
       - task: rspec:dry
 
   ##

data/env.rb

@@ -12,8 +12,12 @@
 #
 ENV["APPRAISAL_NAME"] ||= ENV["BUNDLE_GEMFILE"].to_s.then(&File.method(:basename)).then { |name| name.end_with?(".gemfile") ? name.delete_suffix(".gemfile") : "" }
 
+puts "ENV[\"APPRAISAL_NAME\"] -> `#{ENV["APPRAISAL_NAME"]}`"
+
 ##
 # NOTE: Ruby version may be set by docker.
 # https://github.com/docker-library/ruby/blob/master/3.1/alpine3.16/Dockerfile#L30
 #
 ENV["RUBY_VERSION"] ||= ::RUBY_VERSION
+
+puts "ENV[\"RUBY_VERSION\"] -> `#{ENV["RUBY_VERSION"]}`"

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

@@ -31,7 +31,9 @@ module ConvenientService
                 end
 
                 middlewares :result do
-                  use Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
+                  insert_before \
+                    Plugins::Service::HasResultSteps::Middleware,
+                    Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
                 end
               end
             end

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

@@ -12,7 +12,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:path).value(:string)
+                required(:path).filled(:string)
               end
             end
 

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

@@ -12,7 +12,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:path).value(:string)
+                required(:path).filled(:string)
               end
             end
 

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

@@ -17,7 +17,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:name).value(:string)
+                required(:name).filled(:string)
               end
             end
 

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

@@ -44,7 +44,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:content).value(:string)
+                required(:content).filled(:string)
               end
             end
 

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

@@ -18,7 +18,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:text).value(:string)
+                required(:text).filled(:string)
               end
             end
 

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

@@ -12,7 +12,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:path).value(:string)
+                required(:path).filled(:string)
               end
             end
 

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

@@ -13,7 +13,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:command).value(:string)
+                required(:command).filled(:string)
                 optional(:debug).value(:bool)
               end
             end

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

@@ -17,7 +17,7 @@ module ConvenientService
 
             contract do
               schema do
-                required(:content).value(:string)
+                required(:content).filled(:string)
               end
             end
 

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

@@ -42,7 +42,9 @@ module ConvenientService
                 end
 
                 middlewares :result do
-                  use Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
+                  insert_before \
+                    Plugins::Service::HasResultSteps::Middleware,
+                    Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
                 end
               end
             end

data/lib/convenient_service/rspec/matchers/custom/cache_its_value.rb

@@ -23,26 +23,26 @@ module ConvenientService
           end
 
           def failure_message
-            "expected #{printable_block} to cache its value"
+            "expected #{printable_block_expectation} to cache its value"
           end
 
           def failure_message_when_negated
-            "expected #{printable_block} NOT to cache its value"
+            "expected #{printable_block_expectation} NOT to cache its value"
           end
 
           ##
           # NOTE: An example of how RSpec extracts block source, but they marked it as private.
           # https://github.com/rspec/rspec-expectations/blob/311aaf245f2c5493572bf683b8c441cb5f7e44c8/lib/rspec/matchers/built_in/change.rb#L437
           #
-          # TODO: `printable_block` when `method_source` is available.
+          # TODO: `printable_block_expectation` when `method_source` is available.
           # https://github.com/banister/method_source
           #
-          # def printable_block
-          #   @printable_block ||= block_expectation.source
+          # def printable_block_expectation
+          #   @printable_block_expectation ||= block_expectation.source
           # end
           #
-          def printable_block
-            @printable_block ||= "{ ... }"
+          def printable_block_expectation
+            @printable_block_expectation ||= "{ ... }"
           end
 
           private

data/lib/convenient_service/rspec/matchers/custom/delegate_to.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
 
+##
+# IMPORTANT: This matcher has a dedicated end-user doc. Do NOT forget to update it when needed.
+# https://github.com/marian13/convenient_service_docs/blob/main/docs/api/tests/rspec/matchers/delegate_to.mdx
+#
+# TODO: Refactor into composition:
+#   - Ability to compose when `delegate_to` is used `without_arguments`.
+#   - Ability to compose when `delegate_to` is used `with_arguments`.
+#   - Ability to compose when `delegate_to` is used `and_return_its_value`.
+#
+# TODO: Refactor to NOT use `expect` inside this matcher.
+# This way the matcher will return true or false, but never raise exceptions (descendant of Exception, not StandardError).
+# Then it will be easier to developer a fully comprehensive spec suite for `delegate_to`.
+#
 module ConvenientService
   module RSpec
     module Matchers
@@ -81,15 +94,7 @@ module ConvenientService
               # https://relishapp.com/rspec/rspec-mocks/docs/configuring-responses/wrapping-the-original-implementation
               #
               allow(object).to receive(method).and_wrap_original do |original, *actual_args, **actual_kwargs, &actual_block|
-                ##
-                # TODO: Provide customized error messages?
-                # https://relishapp.com/rspec/rspec-expectations/docs/customized-message
-                #
-                # NOTE: `delegate_to` expects that delegation is executed only once during `block_expectation`.
-                #
-                expect(actual_args).to eq(expected_args)
-                expect(actual_kwargs).to eq(expected_kwargs)
-                expect(actual_block).to eq(expected_block)
+                actual_arguments_collection << [actual_args, actual_kwargs, actual_block]
 
                 ##
                 # NOTE: Imitates `and_call_original`.
@@ -108,7 +113,7 @@ module ConvenientService
             ##
             # NOTE: If this expectation fails, it means `delegate_to` is NOT met.
             #
-            expect(object).to have_received(method)
+            expect(object).to have_received(method).at_least(1) unless used_with_arguments?
 
             ##
             # IMPORTANT: `and_return_its_value` works only when `delegate_to` checks a pure function.
@@ -166,7 +171,13 @@ module ConvenientService
             # NOTE: RSpec raises exception when any `expect` is NOT satisfied.
             # So, this `true` is returned only when all `expect` are successful.
             #
-            true
+            if used_with_arguments?
+              actual_arguments_collection.any? do |(actual_args, actual_kwargs, actual_block)|
+                actual_args == expected_args && actual_kwargs == expected_kwargs && actual_block == expected_block
+              end
+            else
+              true
+            end
           end
 
           ##
@@ -184,8 +195,16 @@ module ConvenientService
             "delegate to `#{printable_method}`"
           end
 
+          def failure_message
+            if used_with_arguments?
+              "expected `#{printable_block_expectation}` to delegate to `#{printable_method}` with expected arguments at least once, but it didn't."
+            else
+              "expected `#{printable_block_expectation}` to delegate to `#{printable_method}` at least once, but it didn't."
+            end
+          end
+
           ##
-          # IMPORTANT: `failure_message`, `failure_message_when_negated` are NOT implemented, since they are never called (since `matches?` always returns `true`).
+          # IMPORTANT: `failure_message_when_negated` is NOT supported yet.
           #
 
           def with_arguments(*args, **kwargs, &block)
@@ -248,6 +267,25 @@ module ConvenientService
           end
 
           alias_method :expected_block, :block
+
+          def actual_arguments_collection
+            @actual_arguments_collection ||= []
+          end
+
+          ##
+          # NOTE: An example of how RSpec extracts block source, but they marked it as private.
+          # https://github.com/rspec/rspec-expectations/blob/311aaf245f2c5493572bf683b8c441cb5f7e44c8/lib/rspec/matchers/built_in/change.rb#L437
+          #
+          # TODO: `printable_block_expectation` when `method_source` is available.
+          # https://github.com/banister/method_source
+          #
+          # def printable_block_expectation
+          #   @printable_block_expectation ||= block_expectation.source
+          # end
+          #
+          def printable_block_expectation
+            @printable_block_expectation ||= "{ ... }"
+          end
         end
       end
     end

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

@@ -49,36 +49,48 @@ module ConvenientService
                     ##
                     # @return [Class]
                     #
-                    def service
-                      internals.cache[:jsend_attributes].service
-                    end
+                    delegate :service, to: :jsend_attributes
 
                     ##
                     # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Status]
                     #
-                    def status
-                      internals.cache[:jsend_attributes].status
-                    end
+                    delegate :status, to: :jsend_attributes
 
                     ##
                     # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
                     #
-                    def data
-                      internals.cache[:jsend_attributes].data
-                    end
+                    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]
                     #
-                    def message
-                      internals.cache[:jsend_attributes].message
-                    end
+                    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]
                     #
-                    def code
-                      internals.cache[:jsend_attributes].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
 
                     ##
@@ -90,9 +102,9 @@ module ConvenientService
 
                       return false if service.class != other.service.class
                       return false if status != other.status
-                      return false if data != other.data
-                      return false if message != other.message
-                      return false if code != other.code
+                      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

data/lib/convenient_service/service/plugins/has_result_params_validations/using_dry_validation/middleware.rb

@@ -21,15 +21,25 @@ module ConvenientService
             # TODO: Return one or all errors?
             #
             def errors
-              @errors ||=
-                entity
-                  .class
-                  .contract
-                  .new
-                  .call(**entity.constructor_params.kwargs)
-                  .errors
-                  .to_h
-                  .transform_values(&:first)
+              @errors ||= resolve_errors
+            end
+
+            def constructor_kwargs
+              @constructor_kwargs ||= entity.constructor_params.kwargs
+            end
+
+            def contract
+              @contract ||= entity.class.contract
+            end
+
+            def resolve_errors
+              return {} unless contract.schema
+
+              contract.new
+                .call(constructor_kwargs)
+                .errors
+                .to_h
+                .transform_values(&:first)
             end
           end
         end

data/lib/convenient_service/service/plugins/has_result_steps/middleware.rb

@@ -8,7 +8,7 @@ module ConvenientService
           def next(...)
             return chain.next(...) if entity.steps.none?
 
-            last_step.result
+            last_step.result.copy
           end
 
           private

data/lib/convenient_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvenientService
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marian Kostyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal