convenient_service 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03335557e59a7d6c469fe20e478efb1d7f9563d7651b5e0761e61d820e7515e6
-  data.tar.gz: 055c3cfaa2b176689bf8cc105d649a40779788279c89bd1f5a6bdfde8d7994c1
+  metadata.gz: b6eab7876ae6995ff2a0f2f4322a972ad05aae9b4ef3beea93daee900779dc39
+  data.tar.gz: 11d7e604831dda483449dc2b2513c0fc5817fd6172740836e5e3929b7d6fbcd4
 SHA512:
-  metadata.gz: f9f55f6baab2736bcbb8661a55bb494bdfb1f7e000a87b3c7c78f326b417e44bcd69cccb992b54435ec10ce919afc2e3a7cd73695858025fa241aff609b9882c
-  data.tar.gz: 72778dcdb0df0003b3c9b13a266af24a9c8de4150ed7d048887bd5007b223c88ce34c9494c186c5ac49ba0102ca5bd31858e37d55698fe1cfb49fe22dd6ed6e7
+  metadata.gz: b422032aa3b32d20579fdcc7e540a5d48e6dd18b3b69182b4b7bc456bbd8a381dd1cdab5654662e1074e095a124d15751aa001d15a36c21518dba0a1683f7130
+  data.tar.gz: bc8142c8d9df3971efb3476131608aae89477a46ecbe2efe42e31555f52e2425930c122ff93f8d941f4b44aa1c81b291079b5e11ea0249cfea0d0dd47a0846b7

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,21 @@
 # Changelog
 
+## [0.3.0](https://github.com/marian13/convenient_service/compare/v0.2.1...v0.3.0) (2022-12-17)
+
+
+### Features
+
+* **stub_service:** stub_service supports stubbing with different arguments ([766eb5a](https://github.com/marian13/convenient_service/commit/766eb5a25cfbd49b699ca5c0c0ffa5524dc46548))
+
+## [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,10 @@
 | 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 |
+| Low | 🚧 | Parallel steps | A killer feature |
+| Medium | 🚧 | Add Ruby 3.2 support to Docker and CI |  |
 
 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/configs/standard.rb

@@ -81,6 +81,10 @@ module ConvenientService
           use Plugins::Service::HasResultShortSyntax::Error::Middleware
         end
 
+        middlewares :result, scope: :class do
+          use Plugins::Common::NormalizesEnv::Middleware
+        end
+
         middlewares :step, scope: :class do
           use Plugins::Common::NormalizesEnv::Middleware
 
@@ -202,6 +206,18 @@ module ConvenientService
             end
           end
         end
+
+        if Dependencies.rspec.loaded?
+          concerns do
+            insert_before 0, Plugins::Service::CanHaveStubbedResult::Concern
+          end
+
+          middlewares :result, scope: :class do
+            insert_after \
+              Plugins::Common::NormalizesEnv::Middleware,
+              Plugins::Service::CanHaveStubbedResult::Middleware
+          end
+        end
       end
       # rubocop:enable Lint/ConstantDefinitionInBlock
     end

data/lib/convenient_service/dependencies/built_in.rb

@@ -28,6 +28,14 @@ require "logger"
 #
 require "ostruct"
 
+##
+# @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
+#
+require "rubygems"
+
 ##
 # @internal
 #   - https://ruby-doc.org/stdlib-2.7.0/libdoc/singleton/rdoc/Singleton.html

data/lib/convenient_service/dependencies.rb

@@ -42,10 +42,23 @@ module ConvenientService
         require_relative "common/plugins/has_attributes/using_active_model_attributes"
       end
 
+      ##
+      # @return [Boolean]
+      # @api private
+      #
+      def support_has_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
+
       ##
       # @return [Boolean]
       # @note Expected to be called from app entry points like `initializers` in Rails.
       #
+      # @see https://marian13.github.io/convenient_service_docs/troubleshooting/i18n_translate_wrong_number_of_arguments
+      #
       def require_has_result_params_validations_using_active_model_validations
         require "active_model"
 
@@ -129,6 +142,30 @@ module ConvenientService
 
         require_relative "examples/dry/gemfile"
       end
+
+      ##
+      # @return [ConvenientService::Support::Ruby]
+      # @api private
+      #
+      def ruby
+        Support::Ruby
+      end
+
+      ##
+      # @return [ConvenientService::Support::RSpec]
+      # @api private
+      #
+      def rspec
+        Support::Gems::RSpec
+      end
+
+      ##
+      # @return [ConvenientService::Support::Gems::ActiveModel]
+      # @api private
+      #
+      def active_model
+        Support::Gems::ActiveModel
+      end
     end
   end
 end

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/examples/rails/gemfile/services/assert_file_exists.rb

@@ -10,7 +10,7 @@ module ConvenientService
 
             attribute :path, :string
 
-            validates :path, presence: true
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             def result
               return error("File with path `#{path}` does NOT exist") unless ::File.exist?(path)

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

@@ -10,7 +10,7 @@ module ConvenientService
 
             attribute :path, :string
 
-            validates :path, presence: true
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             def result
               return error(message: "File with path `#{path}` is empty") if ::File.zero?(path)

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

@@ -15,7 +15,7 @@ module ConvenientService
 
             attribute :name, :string
 
-            validates :name, presence: true
+            validates :name, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             step Services::AssertNodeAvailable
 

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

@@ -42,7 +42,7 @@ module ConvenientService
 
             attribute :content, :string
 
-            validates :content, presence: true
+            validates :content, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             step Services::AssertValidRubySyntax, in: :content
             step :result, in: :content, out: :parsed_content

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

@@ -16,7 +16,7 @@ module ConvenientService
             attribute :text, :string
             attribute :out, default: $stdout
 
-            validates :text, presence: true
+            validates :text, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             def result
               out.puts

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

@@ -10,7 +10,7 @@ module ConvenientService
 
             attribute :path, :string
 
-            validates :path, presence: true
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             step Services::AssertFileExists, in: :path
             step Services::AssertFileNotEmpty, in: :path

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

@@ -11,7 +11,7 @@ module ConvenientService
             attribute :command, :string
             attribute :debug, :boolean, default: false
 
-            validates :command, presence: true
+            validates :command, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             def result
               Services::PrintShellCommand.result(text: command) if debug

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

@@ -15,7 +15,7 @@ module ConvenientService
 
             attribute :content, :string
 
-            validates :content, presence: true
+            validates :content, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
 
             alias_method :content_with_comments, :content
 

data/lib/convenient_service/rspec/helpers/custom/stub_service/entities/result_spec.rb

@@ -109,7 +109,21 @@ module ConvenientService
                 service_class.__send__(status, **kwargs)
               end
 
-              private
+              ##
+              # @param other [Object] Can be any type.
+              # @return [Boolean, nil]
+              #
+              def ==(other)
+                return unless other.instance_of?(self.class)
+
+                return false if status != other.status
+                return false if service_class != other.service_class
+                return false if chain != other.chain
+
+                true
+              end
+
+              protected
 
               ##
               # @!attribute [r] status
@@ -129,6 +143,8 @@ module ConvenientService
               #
               attr_reader :chain
 
+              private
+
               ##
               # @return [Hash]
               #

data/lib/convenient_service/rspec/helpers/custom/stub_service/entities/stubbed_service.rb

@@ -6,90 +6,84 @@ module ConvenientService
       module Custom
         class StubService < Support::Command
           module Entities
-            ##
-            # TODO: Specs.
-            #
             class StubbedService < Support::Command
               ##
-              # NOTE: `include ::RSpec::Matchers`.
-              # - https://github.com/rspec/rspec-expectations/blob/v3.11.0/lib/rspec/matchers.rb
-              # - https://github.com/rspec/rspec-expectations/blob/main/lib/rspec/matchers.rb
+              # @param service_class [Class]
+              # @return [void]
               #
-              include ::RSpec::Matchers
+              def initialize(service_class:)
+                @service_class = service_class
+                @arguments = {args: [], kwargs: {}, block: nil}
+              end
 
               ##
-              # NOTE: `include ::RSpec::Mocks::ExampleMethods`.
-              # - https://github.com/rspec/rspec-mocks/blob/v3.11.1/lib/rspec/mocks/example_methods.rb
-              # - https://github.com/rspec/rspec-mocks/blob/main/lib/rspec/mocks/example_methods.rb
+              # @param args [Array]
+              # @param kwargs [Hash]
+              # @param block [Block]
+              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
               #
-              include ::RSpec::Mocks::ExampleMethods
+              def with_arguments(*args, **kwargs, &block)
+                @arguments = {args: args, kwargs: kwargs, block: block}
 
-              def initialize(service_class:)
-                @service_class = service_class
+                self
               end
 
-              def with_arguments(*args, **kwargs, &block)
-                chain[:with_arguments] = {args: args, kwargs: kwargs, block: block}
+              ##
+              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              #
+              def without_arguments
+                @arguments = {args: [], kwargs: {}, block: nil}
 
                 self
               end
 
+              ##
+              # @param result_spec [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              # @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::StubService]
+              #
               def to(result_spec)
                 @result_spec = result_spec
 
                 service_class.commit_config!
 
-                if used_with_arguments?
-                  allow(service_class).to receive(:result).and_wrap_original do |original, *actual_args, **actual_kwargs, &actual_block|
-                    expect(actual_args).to eq(expected_args)
-                    expect(actual_kwargs).to eq(expected_kwargs)
-                    expect(actual_block).to eq(expected_block)
+                service_class.stubbed_results[key] = result_value
 
-                    result_value
-                  end
-                else
-                  allow(service_class).to receive(:result).and_return(result_value)
-                end
+                self
               end
 
               private
 
-              attr_reader :service_class, :result_spec
-
-              def result_value
-                @result_value ||= result_spec.for(service_class).calculate_value
-              end
-
-              def used_with_arguments?
-                chain.key?(:with_arguments)
-              end
-
-              def chain
-                @chain ||= {}
-              end
+              ##
+              # @!attribute [r] service_class
+              #   @return [Class]
+              #
+              attr_reader :service_class
 
-              def args
-                @args ||= chain.dig(:with_arguments, :args) || []
-              end
+              ##
+              # @!attribute [r] arguments
+              #   @return [Hash]
+              #
+              attr_reader :arguments
 
-              alias_method :expected_args, :args
+              ##
+              # @!attribute [r] result_spec
+              #   @return [ConvenientService::RSpec::Helpers::Custom::StubService::Entities::ResultSpec]
+              #
+              attr_reader :result_spec
 
-              def kwargs
-                @kwargs ||= chain.dig(:with_arguments, :kwargs) || {}
+              ##
+              # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+              #
+              def result_value
+                @result_value ||= result_spec.for(service_class).calculate_value
               end
 
-              alias_method :expected_kwargs, :kwargs
-
               ##
-              # NOTE: `if defined?` is used in order to cache `nil` if needed.
+              # @return [ConvenientService::Support::Cache::Key]
               #
-              def block
-                return @block if defined? @block
-
-                @block = chain.dig(:with_arguments, :block)
+              def key
+                @key ||= service_class.stubbed_results.keygen(*arguments[:args], **arguments[:kwargs], &arguments[:block])
               end
-
-              alias_method :expected_block, :block
             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