convenient_service 0.17.0 → 0.19.0

data/ROADMAP.md

@@ -1,92 +0,0 @@
-# Roadmap
-
-| Priority | Status | Goal | Notes |
-| - | - | - | - |
-| High | ✅ | 100% coverage of `Core` | |
-| Medium | 🚧 | Type signatures for the whole codebase ([Yard @param, @overload, @return](https://rubydoc.info/gems/yard/file/docs/Tags.md#taglist)) | |
-| Medium | ✅ | `Service.success?` shortcut for `Service.result.success?` | |
-| Medium | ✅ | Release `v0.1.0` with a warning that lib is still under heavy development | |
-| Medium | 🚧 | [Active Record transaction](https://api.rubyonrails.org/classes/ActiveRecord/Transactions/ClassMethods.html) examples | |
-| Medium | 🚧 | [Rails Current Attributes integration](https://api.rubyonrails.org/classes/ActiveSupport/CurrentAttributes.html) to cache repeated results | |
-| Low | 🚧 | [Capybara](https://github.com/teamcapybara/capybara) examples | |
-| Medium | 🚧 | Inline step sequence | |
-| High | 🚧 | Move callbacks to internals | In order to NOT pollute the public interface of users services |
-| Low | 🚧 | Create an example of `id_or_record` [attribute](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html) |
-| Low | 🚧 | GitHub Wiki/Gists for Support | |
-| Low | 🚧 | Contribute to Shoulda Matchers | |
-| High | ✅ | `respond_to_missing?` | [ConvenientService::Core::ClassMethods#respond_to_missing?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/core/class_methods.rb#L105), [ConvenientService::Core::InstanceMethods#respond_to_missing?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/core/instance_methods.rb#L30) |
-| High | ⏳ | Custom matcher to track `ConvenientService::Logger` messages | |
-| Medium | ✅ | Remove `respond_to?` from `Copyable` | [7d2a676c171d201301f1c35d498c3b1caf8579b1](https://github.com/marian13/convenient_service/commit/7d2a676c171d201301f1c35d498c3b1caf8579b1) |
-| High | 🚧 | Unified `inspect` | Remove `internals` from inspect, ivars wrapperd by double underscore |
-| High | ✅ | Remove race condition for `method_missing` | https://github.com/marian13/convenient_service/pull/5 |
-| High | ✅ | Remove incompatiility of [Module#include](https://gist.github.com/marian13/9c25041f835564e945d978839097d419) | https://github.com/marian13/convenient_service/pull/3 |
-| Medium | ✅ | Split `Utils` specs into separate files | [convenient_service/spec/lib/convenient_service/utils](https://github.com/marian13/convenient_service/tree/main/spec/lib/convenient_service/utils) |
-| Medium | 🚧 | How to test thread-safety? | |
-| Medium | ✅ | Rename `Utils::Module.find_own_const` to `Utils::Module.get_own_const` | [ConvenientService::Utils::Module::GetOwnConst](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/utils/module/get_own_const.rb) |
-| Medium | 🚧 | Mark `@api private` methods, classes | [YARD Tags](https://www.rubydoc.info/gems/yard/file/docs/Tags.md) |
-| Medium | ✅ | A way to check if block has one required positional argument | [#proc_has_one_positional_argument?](https://github.com/marian13/convenient_service/blob/main/lib/convenient_service/utils/proc/exec_config.rb#L96) |
-| Low | 🚧 | Define method middleware caller with visibility | |
-| Low | 🚧 | Dependency containers to remove high coupling | |
-| Low | 🚧 | Measure performance | See [benchmark](https://github.com/marian13/convenient_service/tree/main/benchmark) |
-| Low | 🚧 | Write [Convenient Service](https://github.com/marian13/convenient_service) specific middleware backend | |
-| High | 🚧 | Optimize `stack.dup` in `MethodMiddlewares#call` | Core v3 |
-| Medium | 🚧 | Make a decision of what to do with `printable_block` in custom RSpec matchers | |
-| Medium | 🚧 | User-friendly exception messages | |
-| High | ❌ | Factory for POROs in specs ❗❗❗ | Proxy config antipattern |
-| High | 🚧 | Resolve warning during specs | |
-| Medium | 🚧 | Consider to change/rewrite `delegate` backend to minify its interface | |
-| Medium | 🚧 | Same order of attr macros, delegators, initialize, class methods, attr methods, queries, actions, `to_*`, comparison, inspect | |
-| Medium | ✅ | Move `Cache` to `Support` | |
-| Medium | 🚧 | Statically specify plugin dependencies | |
-| Medium | 🚧 | Statically specify plugin entity types | |
-| Medium | 🚧 | Consider to create `ComparableProc` descendant from `Proc` | To abstract away `block&.source_location != other.block&.source_location` |
-| Medium | 🚧 | Consider to use `Struct` as key in `Support::Cache` | To hide overriden [eql?](https://github.com/marian13/convenient_service/blob/v0.1.0/lib/convenient_service/common/plugins/caches_return_value/entities/key.rb#L60) |
-| 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` | |
-| 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` |  |
-| 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 | |
-| High | 🚧 | Add specs for [Reassignment::Commands::DefineMethodInContainer](https://github.com/marian13/convenient_service/blob/v0.6.0/lib/convenient_service/service/plugins/has_result_steps/entities/method/entities/callers/reassignment/commands/define_method_in_container.rb#L13) | |
-| High | 🚧 | Example for dependency containers | |
-| Low | 🚧 | `delegate_to.and_return_value` | |
-| Medium | 🚧 | Support two Cache implementations, array-based and hash-based | |
-| Low | 🚧 | `delegate_to_service` | |
-| High | 🚧 | Intentionally disable plugins to document dependencies | |
-| Low | 🚧 | `.and_return_value_should be_instance_of(expected)` | |
-| Low | 🚧 | `ConvenientService::Config.delegate_to_diff_argorithm = :diffy` | |
-| Low | 🚧 | Rubocop cop that complains when a service name does NOT start with a verb | |
-| Low | 🚧 | Generator to create a spec default structure | |
-| Low | 🚧 | Rubocop cop that complains when a service does NOT have its own suite of specs | |
-| High | 🚧 | Add specs for `WrappedMethod#call` | |
-| High | 🚧 | Check whether ignoring the error was used properly | |
-| High | 🚧 | Steps are great for `and` logic, but what to do with `or` logic? | Create the third service | |
-| High | 🚧 | Steps are great for `and` logic, but what to do with `case when` logic? | Create the third service | |
-| High | 🚧 | Cacing of services | It is relatively simple to add caching for steps, but not for all services, since steps are managed by framework | |
-| High | 🚧 | Fallback should return result with already checked status |  |
-| Medium | 🚧 | Licence: Commercial Support docs | See [Sidekiq Commercial Support](https://github.com/sidekiq/sidekiq/wiki/Commercial-Support) |
-| Meduim | 🚧 | Licence: Acknowledgements - Government End Users | See [GraphQL Ruby Commercial Licence](https://graphql.pro/COMM-LICENSE.html) |
-| Medium | 🚧 | Licence: Applicable Law and Jurisdiction (Miscellaneous - Governing Law) | See [Kiba Applicable Law and Jurisdiction](https://github.com/thbar/kiba/blob/master/COMM-LICENSE.md) |
-| Medium | 🚧 | Licence: Contact email `info@convenientservice.org` | |
-| Medium | 🚧 | Contributing Guide | See [Sidekiq Contributing](https://github.com/sidekiq/sidekiq/blob/main/.github/contributing.md) |
-| High | 🚧 | `comparing_by` for `delegate_to` | |
-| High | 🚧 | Remove extra files from bundled gem version | |
-
-Search for `TODO`s in the codebase or check [discussions](https://github.com/marian13/convenient_service/discussions) for more tasks.

data/Rakefile

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-##
-# NOTE: Why not `bin` folder? It has a different purpose. It should contain "binaries/executables" that can be used by the end user.
-# Search for `bin` in the following links for more info.
-# - https://guides.rubygems.org/what-is-a-gem/
-# - https://guides.rubygems.org/faqs/
-#
-task :confirm do
-  require "tty-prompt"
-
-  ##
-  # NOTE: `ARGV[0]` contains `confirm` (this task name).
-  #
-  message = ARGV[1] || "Are you sure?"
-
-  ##
-  # NOTE: Why "tty-prompt"? No time to write, maintain complex, cross-platform bash scripts if you are a full-time application developer.
-  #
-  prompt = TTY::Prompt.new
-
-  ##
-  # NOTE: `prompt.yes?` docs.
-  # https://github.com/piotrmurach/tty-prompt#25-yesno
-  #
-  yes = prompt.yes?(message)
-
-  ##
-  # NOTE: Use `echo $?` to debug exit code (0 means ok, 1 - error).
-  #
-  yes ? exit(0) : exit(1)
-end
-
-task :playground do
-  require "irb"
-
-  require_relative "env"
-
-  require "convenient_service"
-
-  require_relative "spec/support/convenient_service"
-  require_relative "spec/support/convenient_service/rails" if ENV["APPRAISAL_NAME"] == "all" || ENV["APPRAISAL_NAME"].include?("rails")
-  require_relative "spec/support/convenient_service/dry" if ENV["APPRAISAL_NAME"] == "all" || ENV["APPRAISAL_NAME"].include?("dry")
-
-  ##
-  # NOTE: Clears `ARGV` since both `rake` and `irb` uses it.
-  # https://stackoverflow.com/a/2876645/12201472
-  #
-  ARGV.clear
-
-  IRB.start(__FILE__)
-end