convenient_service 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a88c73bc0e44152c9d0655a5135f2f32251d285e62e605e865f55fabca3d90c
-  data.tar.gz: 9bef951c44bba900eb78324944f80a5d7f37b066ac7b9760aa243e016b9c11a0
+  metadata.gz: 481cc240efe2b9443d13ea66fc70dc2cd1b477c291be24b1b9e66af9e9e26e65
+  data.tar.gz: 07caed3e04809cd78e96818e69c99f9337a9882f689c05709ff57d38e6c5940f
 SHA512:
-  metadata.gz: d00b17feb539b7c54e970eedefff69ff840ae1a9811d927309e01bf19869a058f67a3c7e76e9feb9a825bc466c04cc52d5cd9f52ce607ed865d803fd847182ac
-  data.tar.gz: 1200ca17ea22193c8f1fef2b36d7a81bbdbf759348191180e2808c03ba66a0b7d2219cfb3062874833f80c4a677ff07b49f6e19e2a888e38e3c4a2c33d0b7010
+  metadata.gz: 35b346de371b82d3d8775a68783e1fdce3c42709bfb7aaa5a864f5bbb9c4ba494eb2f6a7f7ead303f5dcde1a079256c1cc881006cff5bc600b3c0e48a6810f6e
+  data.tar.gz: dac03d20c0c10765f4c1e5530d0f9d92a1ee0723f98a94f0a0804d13e2f7e3c8d28d2052a0037c08d6f5b49726038d55069a89bf3143d01b298a58e4a223c32b

data/.dev/.tmuxinator.yml

@@ -0,0 +1,17 @@
+name: convenient_service
+root: .
+
+on_project_start:
+  - task editor:open
+  - task docker:start
+  - task github:open
+
+windows:
+  - main:
+      layout: even-vertical
+      root: .
+      panes:
+        - task docker:bash:ruby_2.7
+        - task docker:bash:ruby_3.0
+        - task docker:bash:ruby_3.1
+        - git status

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.4.0](https://github.com/marian13/convenient_service/compare/v0.3.1...v0.4.0) (2023-01-03)
+
+
+### Features
+
+* **has_jsend_status_and_attributes:** introduce data.has_attribute? ([04e4583](https://github.com/marian13/convenient_service/commit/04e45830fcb4aabc7d6473394e7d4b99e31a11d6))
+* **has_result_steps:** add more contextual error message when step result data has no attribute ([5844d94](https://github.com/marian13/convenient_service/commit/5844d942a9bca4b9d4f65403c6c432e9e2b810ad))
+* **results_matchers:** introduce be_not_success, be_not_failure, be_not_error ([9bb4454](https://github.com/marian13/convenient_service/commit/9bb4454fa6025bba8200a9280c25ec20cafb4c03))
+
+
+### Bug Fixes
+
+* **has_result_steps:** print step actual service, not internal wrapper ([c0761be](https://github.com/marian13/convenient_service/commit/c0761be89b8a6dacb318460ed5c55b15fdd2de0b))
+* **rspec:** return nil for current example in partially loaded rspec envs ([ea10cc0](https://github.com/marian13/convenient_service/commit/ea10cc0e06dd22022f816f6760af926fb119bdf5))
+
 ## [0.3.1](https://github.com/marian13/convenient_service/compare/v0.3.0...v0.3.1) (2022-12-19)
 
 

data/README.md

@@ -38,23 +38,23 @@ This library is under heavy development. Public API may be subject to change. Th
 <!-- features:end -->
 <!-- warning:end -->
 
-<!-- documentation:start -->
-## Documentation
+<!-- links:start -->
+## Quick Links
 
 - Check out [Convenient Service Official User Docs](https://marian13.github.io/convenient_service_docs/) for installation, requirements, and usage guides.
 
-- Have a look at [Convenient Service Development Wiki](https://github.com/marian13/convenient_service/wiki) if you consider making a contribution.
+- Read [the API docs](https://marian13.github.io/convenient_service) to get familiar with the newest functionality that are not documented yet.
 
-- [API docs](https://marian13.github.io/convenient_service/).
+- Create [an issue](https://github.com/marian13/convenient_service/issues) if you are going to report a bug.
 
-<!-- documentation:end -->
+- Start [a discussion](https://github.com/marian13/convenient_service/discussions) when you would like to request a new feature.
 
-## Links
+- Open a PR to [convenient_service_docs](https://github.com/marian13/convenient_service_docs) to add/update user docs.
 
-<!-- links:start -->
 - [RubyGems](https://rubygems.org/gems/convenient_service).
 
-- [Official User Docs Source](https://github.com/marian13/convenient_service_docs).
+- Have a look at [Convenient Service Development Wiki](https://github.com/marian13/convenient_service/wiki) for the contribution tutorials.
+
 <!-- links:end -->
 
 ---

data/Taskfile.yml

@@ -97,6 +97,21 @@ tasks:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
         msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
 
+  ##
+  # NOTE: Dev only command.
+  # NOTE: macOS specific command.
+  #
+  docker:start:
+    cmds:
+      - open -a Docker
+
+  ##
+  # NOTE: Dev only command.
+  #
+  editor:open:
+    cmds:
+      - code .
+
   ##
   # NOTE: `sdoc` (wrapper for `rdoc`) is replaced by `yard`, since you have a feeling like every time is a first time with `rdoc`.
   # - https://kapeli.com/cheat_sheets/Yard.docset/Contents/Resources/Documents/index
@@ -149,6 +164,14 @@ tasks:
     cmds:
       - git diff --cached --name-only --diff-filter=d "spec/**"
 
+  ##
+  # NOTE: Dev only command.
+  # NOTE: macOS specific command.
+  #
+  github:open:
+    cmds:
+      - open -na "Google Chrome" --args --new-window --incognito "https://github.com/marian13/convenient_service"
+
   lint:
     cmds:
       - task: rubocop
@@ -306,3 +329,10 @@ tasks:
   rubocop:format:
     cmds:
       - bundle exec rubocop --config .rubocop.yml -A {{.CLI_ARGS}}
+
+  ##
+  # NOTE: Dev only command.
+  #
+  tmuxinator:start:
+    cmds:
+      - tmuxinator start convenient_service --project-config=.dev/.tmuxinator.yml

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

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class Base
+            include Support::AbstractMethod
+
+            ##
+            # @return [String, Symbol]
+            #
+            abstract_method :statuses
+
+            ##
+            # @param result [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            # @return [Boolean]
+            #
+            def matches?(result)
+              @result = result
+
+              rules = []
+
+              rules << ->(result) { result.class.include?(Service::Plugins::HasResult::Entities::Result::Concern) }
+              rules << ->(result) { result.status.in?(statuses) }
+              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
+              rules << ->(result) { result.unsafe_data == data } if used_data?
+              rules << ->(result) { result.unsafe_message == message } if used_message?
+              rules << ->(result) { result.unsafe_code == code } if used_code?
+
+              condition = Utils::Proc.conjunct(rules)
+
+              condition.call(result)
+            end
+
+            ##
+            # @return [String]
+            #
+            def description
+              default_text
+            end
+
+            ##
+            # @return [String]
+            #
+            def failure_message
+              "expected that `#{result}` would #{default_text}"
+            end
+
+            ##
+            # @return [String]
+            #
+            # @internal
+            #   https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
+            #
+            def failure_message_when_negated
+              "expected that #{result} would NOT #{default_text}"
+            end
+
+            ##
+            # @param data [Hash]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def with_data(data)
+              chain[:data] = data
+
+              self
+            end
+
+            ##
+            # @param data [Hash]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def and_data(data)
+              chain[:data] = data
+
+              self
+            end
+
+            ##
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def without_data
+              chain[:data] = {}
+
+              self
+            end
+
+            ##
+            # @param message [String]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def with_message(message)
+              chain[:message] = message
+
+              self
+            end
+
+            ##
+            # @param message [String]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def and_message(message)
+              chain[:message] = message
+
+              self
+            end
+
+            ##
+            # @return [String, Symbol]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def with_code(code)
+              chain[:code] = code
+
+              self
+            end
+
+            ##
+            # @return [String, Symbol]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def and_code(code)
+              chain[:code] = code
+
+              self
+            end
+
+            ##
+            # @param service_class [Class]
+            # @return [ConvenientService::RSpec::Matchers::Custom::Results::Base]
+            #
+            def of(service_class)
+              chain[:service_class] = service_class
+
+              self
+            end
+
+            private
+
+            ##
+            # @!attribute [r] result
+            #   @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+            #
+            attr_reader :result
+
+            ##
+            # @return [String]
+            #
+            def default_text
+              parts = []
+
+              parts << "be #{printable_statuses}"
+              parts << "of `#{service_class}`" if used_of?
+              parts << "with data `#{data}`" if used_data?
+              parts << "with message `#{message}`" if used_message?
+              parts << "with code `#{code}`" if used_code?
+
+              parts << "\n\n"
+
+              parts << "got `#{result.status}`"
+              parts << "of `#{result.service.class}`" if used_of?
+              parts << "with data `#{result.data}`" if used_data?
+              parts << "with message `#{result.message}`" if used_message?
+              parts << "with code `#{result.code}`" if used_code?
+
+              parts.join(" ")
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def used_data?
+              chain.key?(:data)
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def used_message?
+              chain.key?(:message)
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def used_code?
+              chain.key?(:code)
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def used_of?
+              chain.key?(:service_class)
+            end
+
+            ##
+            # @return [Hash]
+            #
+            def data
+              @data ||= chain[:data] || {}
+            end
+
+            ##
+            # @return [String]
+            #
+            def message
+              @message ||= chain[:message] || ""
+            end
+
+            ##
+            # @return [String, Symbol]
+            #
+            def code
+              @code ||= chain[:code] || ""
+            end
+
+            ##
+            # @return [Class]
+            #
+            def service_class
+              Utils::Object.instance_variable_fetch(self, :@service_class) { chain[:service_class] }
+            end
+
+            ##
+            # @return [Hash]
+            #
+            def chain
+              @chain ||= {}
+            end
+
+            ##
+            # @return [String]
+            #
+            def printable_statuses
+              statuses.map { |status| "`#{status}`" }.join(" or ")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,145 +5,9 @@ module ConvenientService
     module Matchers
       module Custom
         module Results
-          class BeError
-            def matches?(result)
-              @result = result
-
-              rules = []
-
-              rules << ->(result) { result.class.include?(ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern) }
-              rules << ->(result) { result.error? }
-              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
-              rules << ->(result) { result.message == message } if used_message?
-              rules << ->(result) { result.code == code } if used_code?
-
-              condition = ConvenientService::Utils::Proc.conjunct(rules)
-
-              condition.call(result)
-            end
-
-            def with_message(message)
-              chain[:message] = message
-
-              self
-            end
-
-            def and_message(message)
-              chain[:message] = message
-
-              self
-            end
-
-            def with_code(code)
-              chain[:code] = code
-
-              self
-            end
-
-            def and_code(code)
-              chain[:code] = code
-
-              self
-            end
-
-            def of(service_class)
-              chain[:service_class] = service_class
-
-              self
-            end
-
-            def description
-              ##
-              # TODO: of
-              #
-              parts = []
-
-              parts << "be an `error`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with message `#{message}`" if used_message?
-              parts << "with code `#{code}`" if used_code?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with message `#{result.message}`" if used_message?
-              parts << "with code `#{result.code}`" if used_code?
-
-              parts.join(" ")
-            end
-
-            def failure_message
-              ##
-              # TODO: got text after expect text.
-              #
-              parts = []
-
-              parts << "expected that `#{result}` would be an `error`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with message `#{message}`" if used_message?
-              parts << "with code `#{code}`" if used_code?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with message `#{result.message}`" if used_message?
-              parts << "with code `#{result.code}`" if used_code?
-
-              parts.join(" ")
-            end
-
-            ##
-            # https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
-            #
-            def failure_message_when_negated
-              ##
-              # TODO: got text after expect text.
-              #
-              parts = []
-
-              parts << "expected that #{result} would NOT be an `error`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with message `#{message}`" if used_message?
-              parts << "with code `#{code}`" if used_code?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with message `#{result.message}`" if used_message?
-              parts << "with code `#{result.code}`" if used_code?
-
-              parts.join(" ")
-            end
-
-            private
-
-            attr_reader :result
-
-            def used_message?
-              chain.key?(:message)
-            end
-
-            def used_code?
-              chain.key?(:code)
-            end
-
-            def used_of?
-              chain.key?(:service_class)
-            end
-
-            def chain
-              @chain ||= {}
-            end
-
-            def message
-              @message ||= chain[:message] || ""
-            end
-
-            def code
-              @code ||= chain[:code] || ""
-            end
-
-            def service_class
-              return @service_class if defined? @service_class
-
-              @service_class = chain[:service_class]
+          class BeError < Results::Base
+            def statuses
+              [Service::Plugins::HasResult::Constants::ERROR_STATUS]
             end
           end
         end

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

@@ -5,112 +5,9 @@ module ConvenientService
     module Matchers
       module Custom
         module Results
-          class BeFailure
-            def matches?(result)
-              @result = result
-
-              rules = []
-
-              rules << ->(result) { result.class.include?(ConvenientService::Service::Plugins::HasResult::Entities::Result::Concern) }
-              rules << ->(result) { result.failure? }
-              rules << ->(result) { result.service.instance_of?(service_class) } if used_of?
-              rules << ->(result) { result.data == data } if used_data?
-
-              condition = ConvenientService::Utils::Proc.conjunct(rules)
-
-              condition.call(result)
-            end
-
-            def with_data(data)
-              chain[:data] = data
-
-              self
-            end
-
-            def of(service_class)
-              chain[:service_class] = service_class
-
-              self
-            end
-
-            def description
-              ##
-              # TODO: of
-              #
-              parts = []
-
-              parts << "be a `failure`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with data `#{data}`" if used_data?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with data `#{result.data.to_h}`" if used_data?
-
-              parts.join(" ")
-            end
-
-            def failure_message
-              ##
-              # TODO: got text after expect text.
-              #
-              parts = []
-
-              parts << "expected that `#{result}` would be a `failure`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with data `#{data}`" if used_data?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with data `#{result.data.to_h}`" if used_data?
-
-              parts.join(" ")
-            end
-
-            ##
-            # https://relishapp.com/rspec/rspec-expectations/v/3-11/docs/custom-matchers/define-a-custom-matcher#overriding-the-failure-message-when-negated
-            #
-            def failure_message_when_negated
-              ##
-              # TODO: got text after expect text.
-              #
-              parts = []
-
-              parts << "expected that #{result} would NOT be a `failure`"
-              parts << "of `#{service_class}`" if used_of?
-              parts << "with data `#{data}`" if used_data?
-              parts << "\n\n"
-              parts << "got `#{result.status}`"
-              parts << "of `#{result.service.class}`" if used_of?
-              parts << "with data `#{result.data.to_h}`" if used_data?
-
-              parts.join(" ")
-            end
-
-            private
-
-            attr_reader :result
-
-            def used_data?
-              chain.key?(:data)
-            end
-
-            def used_of?
-              chain.key?(:service_class)
-            end
-
-            def chain
-              @chain ||= {}
-            end
-
-            def data
-              @data ||= chain[:data] || {}
-            end
-
-            def service_class
-              return @service_class if defined? @service_class
-
-              @service_class = chain[:service_class]
+          class BeFailure < Results::Base
+            def statuses
+              [Service::Plugins::HasResult::Constants::FAILURE_STATUS]
             end
           end
         end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class BeNotError < Results::Base
+            def statuses
+              [
+                Service::Plugins::HasResult::Constants::FAILURE_STATUS,
+                Service::Plugins::HasResult::Constants::SUCCESS_STATUS
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module Matchers
+      module Custom
+        module Results
+          class BeNotFailure < Results::Base
+            def statuses
+              [
+                Service::Plugins::HasResult::Constants::ERROR_STATUS,
+                Service::Plugins::HasResult::Constants::SUCCESS_STATUS
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end