convenient_service 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7655bb52a95f02a3f973c4f26e8e881ebf2dec66e056de3e085515b8e1c9b8f9
-  data.tar.gz: 440d3e574c167e88ca942e98eb022665faf918933d20789d4acc50f90bd0e9e8
+  metadata.gz: 7ec5188e0830cb8a97b589ff6985d4aa1e361bce486dba86a1a1f697924d0be7
+  data.tar.gz: ab763a1c604849509f5557938768bf019b5d962dd5d6fa62771b17e3c524025d
 SHA512:
-  metadata.gz: 2f76c7d18d8dbe51157e07c575718383148fc070cd85705450f9ea7d5bd4c3837d459b1da3125c4a1eb6188d14ce5e5d10c1b501104949f6c609e6a0f724e820
-  data.tar.gz: fb0f1e875261f71a01fefba836b45e6c8995ea94f9aa906050f9bebdf5b4690bafda699c624a9405cec65c14928ba1956d6c3a193f434ab471ceceb4635baef6
+  metadata.gz: 32cf7296bf8a5ff16d7bfed6c20a855831e27b0300edede75ba7c737f357ed6ddf462641d7cacc9c5f7a65c64c3a4e59b04a60cee0ad9793f173fca7e9c0ad24
+  data.tar.gz: 71aadf20b54f0f507eb6721999b2192630eb2265d660d40ecc461de311fb930376883d1546c9c030c03f15e90e0c02e172066adc2213cb61140cc3f8b45b5137

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.6.0](https://github.com/marian13/convenient_service/compare/v0.5.0...v0.6.0) (2023-01-22)
+
+
+### Features
+
+* **dependency_container:** assert valid scope ([5d75f59](https://github.com/marian13/convenient_service/commit/5d75f593c01baa695e75fe49af6b4c6b80d7d9b1))
+* **singleton_prepend_module:** introduce singleton_prepend_module custom RSpec matcher ([6636b8d](https://github.com/marian13/convenient_service/commit/6636b8d030329e4a6216a934748a70ef4bae6ff3))
+* **has_result_steps:** introduce reassign ([75855be](https://github.com/marian13/convenient_service/commit/75855be7fd9115d01d5cfad99d35319486332bd2))
+
 ## [0.5.0](https://github.com/marian13/convenient_service/compare/v0.4.0...v0.5.0) (2023-01-19)
 
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Marian Kostyk
+Copyright (c) 2022-2023 Marian Kostyk
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -60,5 +60,5 @@ This library is under heavy development. Public API may be subject to change. Th
 ---
 
 <!-- author:start -->
-Copyright (c) 2022 [Marian Kostyk](http://mariankostyk.com).
+Copyright (c) 2022-2023 [Marian Kostyk](http://mariankostyk.com).
 <!-- author:end -->

data/ROADMAP.md

@@ -44,14 +44,25 @@
 | High | 🚧 | `included_once` for `Support::Concern` |
 | Medium | 🚧 | Custom YARD type for service instance, service class as return values |
 | Medium | 🚧 | Heredoc for error messages |
-| Medium | 🚧 | Specs for `be_success`, `be_error`, `be_failure` matchers | | 
-| Low | 🚧 | [Receive Counts](https://relishapp.com/rspec/rspec-mocks/docs/setting-constraints/receive-counts) for `delegate_to` | | 
+| Medium | 🚧 | Specs for `be_success`, `be_error`, `be_failure` matchers | |
+| 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 |  |
+| Medium | 🚧 | Add `Ruby 3.2` support to `Docker` and `CI` |  |
+| Low | 🚧 | `overload do` | |
+| Low | 🚧 | Same spec example group organization | |
+| Medium | 🚧 | `Support::Arguments` | |
+| Low | 🚧 | Null object to Nil object? | |
+| High | 🚧 | Do not use Testing Toolkit in the Primitives layer | See [Components Diagram](https://marian13.github.io/static_content/convenient_service/diagrams/components_graph.html) + it should take the minimal amount of efforts to extract and reuse `Utils`, `Suppport` in the different projects |
+| Medium | 🚧 | Perfromance testing | [rspec-benchmark](https://github.com/piotrmurach/rspec-benchmark), [Testing object allocations](https://www.honeybadger.io/blog/testing-object-allocations/), [allocation_stats](https://github.com/srawlins/allocation_stats) |
+| Medium | 🚧 | Mutant testing | [mutant](https://github.com/mbj/mutant) |
+| Low | 🚧 | Add `JRuby` support | [jruby](https://www.jruby.org/) |
+| Medium | 🚧 | Add `shoulda-context` to test conditionals when `RSpec` is not loaded | [shoulda-context](https://github.com/thoughtbot/shoulda-context) |
+| High | 🚧 | Abstract factory for `CastMethod` | |
+| Medium | 🚧 | `delegate_to` - option to specify of how to compare blocks | |
 
 Search for `TODO`s in the codebase for more tasks.

data/Taskfile.yml

@@ -78,6 +78,16 @@ tasks:
 
   docker:build:ruby_2.7:
     cmds:
+      ##
+      # NOTE: Meaning of `|| 2> /dev/null`.
+      # https://stackoverflow.com/a/10250395/12201472
+      #
+      # NOTE: Meaning of `|| true`.
+      # https://superuser.com/a/887349/1180656
+      #
+      - rm Gemfile.2.7 2> /dev/null || true
+      - rm Gemfile.2.7.lock 2> /dev/null || true
+      - cp Gemfile Gemfile.2.7
       - docker build . -f docker/2.7/Dockerfile -t convenient_service:2.7
     preconditions:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
@@ -85,6 +95,16 @@ tasks:
 
   docker:build:ruby_3.0:
     cmds:
+      ##
+      # NOTE: Meaning of `|| 2> /dev/null`.
+      # https://stackoverflow.com/a/10250395/12201472
+      #
+      # NOTE: Meaning of `|| true`.
+      # https://superuser.com/a/887349/1180656
+      #
+      - rm Gemfile.3.0 2> /dev/null || true
+      - rm Gemfile.3.0.lock 2> /dev/null || true
+      - cp Gemfile Gemfile.3.0
       - docker build . -f docker/3.0/Dockerfile -t convenient_service:3.0
     preconditions:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
@@ -92,6 +112,16 @@ tasks:
 
   docker:build:ruby_3.1:
     cmds:
+      ##
+      # NOTE: Meaning of `|| 2> /dev/null`.
+      # https://stackoverflow.com/a/10250395/12201472
+      #
+      # NOTE: Meaning of `|| true`.
+      # https://superuser.com/a/887349/1180656
+      #
+      - rm Gemfile.3.1 2> /dev/null || true
+      - rm Gemfile.3.1.lock 2> /dev/null || true
+      - cp Gemfile Gemfile.3.1
       - docker build . -f docker/3.1/Dockerfile -t convenient_service:3.1
     preconditions:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'

data/convenient_service.gemspec

@@ -35,18 +35,20 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "commonmarker"
   spec.add_development_dependency "gem-release"
   spec.add_development_dependency "inch"
+  spec.add_development_dependency "json"
   spec.add_development_dependency "paint"
   spec.add_development_dependency "progressbar"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rerun"
   spec.add_development_dependency "rouge"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.11.0"
   spec.add_development_dependency "rubocop", "~> 1.40.0"
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "tty-prompt"
   spec.add_development_dependency "standard"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-lcov"
+  spec.add_development_dependency "webrick"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "yard-junk"
 end

data/lib/convenient_service/aliases.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module ConvenientService
+  Concern = ::ConvenientService::Support::Concern
   DependencyContainer = ::ConvenientService::Support::DependencyContainer
 end

data/lib/convenient_service/common/plugins/assigns_attributes_in_constructor/using_active_model_attribute_assignment/concern.rb

@@ -9,8 +9,6 @@ module ConvenientService
             include Support::Concern
 
             included do |service_class|
-              require "active_model"
-
               service_class.include ::ActiveModel::AttributeAssignment
             end
           end

data/lib/convenient_service/common/plugins/assigns_attributes_in_constructor/using_dry_initializer/concern.rb

@@ -9,8 +9,6 @@ module ConvenientService
             include Support::Concern
 
             included do |service_class|
-              require "dry-initializer"
-
               service_class.extend ::Dry::Initializer
             end
           end

data/lib/convenient_service/core/entities/config/entities/method_middlewares/entities/container/commands/resolve_methods_middlewares_callers.rb

@@ -35,30 +35,7 @@ module ConvenientService
                     # @return [Module]
                     #
                     def call
-                      get_methods_middlewares_callers || set_methods_middlewares_callers
-                    end
-
-                    private
-
-                    ##
-                    # @return [Module, nil]
-                    #
-                    def get_methods_middlewares_callers
-                      Utils::Module.get_own_const(klass, module_name)
-                    end
-
-                    ##
-                    # @return [Module]
-                    #
-                    def set_methods_middlewares_callers
-                      klass.const_set(module_name, ::Module.new)
-                    end
-
-                    ##
-                    # @return [Symbol]
-                    #
-                    def module_name
-                      @module_name ||= :MethodsMiddlewaresCallers
+                      Utils::Module.fetch_own_const(klass, :MethodsMiddlewaresCallers) { ::Module.new }
                     end
                   end
                 end

data/lib/convenient_service/dependencies.rb

@@ -113,9 +113,12 @@ module ConvenientService
       # @api private
       #
       def require_standard_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/standard/cowsay"
+        require_relative "examples/standard/request_params"
         require_relative "examples/standard/gemfile"
       end
 
@@ -126,7 +129,9 @@ module ConvenientService
       # @api private
       #
       def require_rails_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/rails/gemfile"
       end
@@ -138,7 +143,9 @@ module ConvenientService
       # @api private
       #
       def require_dry_examples
+        require "json"
         require "progressbar"
+        require "webrick"
 
         require_relative "examples/dry/gemfile"
       end

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

@@ -12,7 +12,9 @@ module ConvenientService
       module Gemfile
         class DryService
           module Config
-            def self.included(service_class)
+            include Support::Concern
+
+            included do |service_class|
               service_class.class_exec do
                 include Configs::Standard
 

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

@@ -12,7 +12,9 @@ module ConvenientService
       module Gemfile
         class RailsService
           module Config
-            def self.included(service_class)
+            include Support::Concern
+
+            included do |service_class|
               service_class.class_exec do
                 include Configs::Standard
 

data/lib/convenient_service/examples/standard/request_params/constants.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Constants
+          module Tags
+            EMPTY = ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/description.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Description
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/format.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Format
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/id.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          ##
+          # TODO: https://ruby-doc.org/3.1.3/stdlibs/yaml/YAML/DBM.html
+          #
+          class ID
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String, ::Integer
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_i
+              value.to_i
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Logger
+            class << self
+              def log(message, out: $stdout)
+                out.puts message
+
+                message
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Request
+            attr_reader :http_string
+
+            def initialize(http_string:)
+              @http_string = http_string
+            end
+
+            def to_s
+              http_string
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/source.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Source
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/tag.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Tag
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities/title.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Entities
+          class Title
+            def initialize(value:)
+              @value = value
+            end
+
+            class << self
+              def cast(value)
+                case value
+                when ::String
+                  new(value: value.to_s)
+                end
+              end
+            end
+
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              value == other.value
+            end
+
+            def to_s
+              value
+            end
+
+            protected
+
+            attr_reader :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/entities.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "entities/logger"
+require_relative "entities/request"
+
+require_relative "entities/description"
+require_relative "entities/format"
+require_relative "entities/id"
+require_relative "entities/source"
+require_relative "entities/tag"
+require_relative "entities/title"

data/lib/convenient_service/examples/standard/request_params/services/apply_default_param_values.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Services
+          class ApplyDefaultParamValues
+            include ConvenientService::Standard::Config
+
+            attr_reader :params, :defaults
+
+            def initialize(params:, defaults:)
+              @params = params
+              @defaults = defaults
+            end
+
+            def result
+              success(params: defaults.merge(params))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/request_params/services/cast_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Services
+          class CastParams
+            include ConvenientService::Standard::Config
+
+            attr_reader :params
+
+            def initialize(params:)
+              @params = params
+            end
+
+            def result
+              success(original_params: params, casted_params: casted_params)
+            end
+
+            private
+
+            def casted_params
+              {
+                id: Entities::ID.cast(params[:id]),
+                format: Entities::Format.cast(params[:format]),
+                title: Entities::Title.cast(params[:title]),
+                description: Entities::Description.cast(params[:description]),
+                tags: Utils::Array.wrap(params[:tags]).map { |tag| Entities::Tag.cast(tag) },
+                sources: Utils::Array.wrap(params[:sources]).map { |source| Entities::Source.cast(source) }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end