interactify 0.3.0.pre.alpha.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 918f4f6ae335bb5b8a748603af6a2e9d91dc11ad3d887803bbb2c7b2ba41730e
-  data.tar.gz: fe6506fe246a82d48f5a614d5c576cf74e49f38953c1d4ae98d52f1649f03aaf
+  metadata.gz: 0ec61ad4a3a73d2c36430e29d01ae754b670ebdaab812f3d946b61adff9bf8ae
+  data.tar.gz: b4441070a5178d6933f97adf465bce313e638fef6dc42901d4e6d84c7a8e73d2
 SHA512:
-  metadata.gz: ce377154a79b527f6eaebe3258d76aadd327521abbe86847b8c9d87b5710e1782bdb02b20b3ef3661ac6dc4ee1d0c6843fdd819ccf6dda8f701e9d95063d5a9c
-  data.tar.gz: 553271645575873bc2a95968c2ff7f01a556dd24527974b6a7bb958a8eeb9f8bb66504bdace2c3736e6faac82c1a438f07d27afa85c3fdc8ac5b051cac4e20c5
+  metadata.gz: b0552ea7eabc4a818888a255bb674c430babf57504b921e0cfd48949e9c0cee8bd3eb722b584e28c2a1aed7643f1b277f335b827a3af1cc6d2e121feb7c0856c
+  data.tar.gz: 73995415964151caf4f4b1977cecd558791ff14e4d475a26dda813b4403c29e2c4c59d06daf63e67800e29e44cbca558e26c970acdbef635d1a781fbfbdffada

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   NewCops: enable
   Exclude:
+    - 'gemfiles/**/*'
     - 'spec/fixtures/**/*'
     - 'tmp/**/*'
     - '.git/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/Appraisals

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+appraise "railties-7-sidekiq" do
+  gem "railties", "7"
+  gem "sidekiq", "7"
+end
+
+appraise "railties-7-no-sidekiq" do
+  gem "railties", "7"
+end
+
+appraise "railties-6-sidekiq" do
+  gem "railties", "6"
+  gem "sidekiq", "7"
+end
+
+appraise "railties-6-no-sidekiq" do
+  gem "railties", "6"
+end
+
+appraise "no-railties-no-sidekiq" do
+  # nothing extra
+end

data/CHANGELOG.md

@@ -11,3 +11,17 @@
 ## [0.3.0-alpha.1] - 2023-12-29
 
 - Added support for `{if: :condition, then: A, else: B}` in organizers
+
+## [0.3.0-alpha.2] - 2023-12-29
+
+- Remove deep_matching development dependency
+
+## [0.3.0-RC1] - 2023-12-29
+
+- Fixed to work with and make optional dependencies for sidekiq and railties. Confirmed as working with ruby >= 3.1.4
+
+## [0.4.0] - 2023-12-29
+
+- All internal restructuring/refactoring into domains. 
+- Add support for organize `self.if(:condition, then: A, else: B)` syntax
+- change location of matchers to `require 'interactify/rspec_matchers/matchers'`

data/README.md

@@ -1,6 +1,17 @@
 # Interactify
 
-Interactify enhances Rails applications by simplifying complex interactor chains. This gem builds on [interactors](https://github.com/collectiveidea/interactor) and [interactor-contracts](https://github.com/michaelherold/interactor-contracts) to improve readability and maintainability of business logic. It's optimized for Rails projects using Sidekiq, offering advanced features for chain management and debugging. Interactify is about making interactor usage in Rails more efficient and less error-prone, reducing the overhead of traditional interactor orchestration.
+[![Gem Version](https://badge.fury.io/rb/interactify.svg)](https://badge.fury.io/rb/interactify)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+![Ruby 3.3.0](https://img.shields.io/badge/ruby-3.3.0-green.svg)
+![Ruby 3.2.2](https://img.shields.io/badge/ruby-3.2.2-green.svg)
+![Ruby 3.1.4](https://img.shields.io/badge/ruby-3.1.4-green.svg)
+[![Code Climate](https://codeclimate.com/github/markburns/interactify/badges/gpa.svg)](https://codeclimate.com/github/markburns/interactify)
+
+Interactify enhances Rails applications by simplifying complex interactor chains. 
+This gem builds on [interactors](https://github.com/collectiveidea/interactor) and [interactor-contracts](https://github.com/michaelherold/interactor-contracts) to improve readability and maintainability of business logic. 
+We depend on activesupport, and optionally on railties and sidekiq. So it's a good fit for Rails projects using Sidekiq, offering advanced features for chain management and debugging. 
+Interactify is about making interactor usage in Rails more efficient and less error-prone, reducing the overhead of traditional interactor orchestration.
+
 ## Installation
 
 ```ruby
@@ -10,6 +21,7 @@ gem 'interactify'
 ## Usage
 
 ### Initializer
+
 ```ruby
 # in config/initializers/interactify.rb
 Interactify.configure do |config|
@@ -28,9 +40,10 @@ end
 
 ### Using the RSpec matchers
 ```ruby
-# e.g. in spec/supoort/interactify.rb
-require 'interactify/rspec/matchers'
+# e.g. in spec/support/interactify.rb
+require 'interactify/rspec_matchers/matchers'
 
+# in specs
 expect(described_class).to expect_inputs(:foo, :bar, :baz)
 expect(described_class).to promise_outputs(:fee, :fi, :fo, :fum)
 ```
@@ -211,26 +224,22 @@ class OuterThing
   # ... boilerplate ...
   organize \
     SetupStep,
+
+    # lambda conditional
     self.if(->(c){ c.thing == 'a' }, DoThingA, DoThingB),
-end
 
-# or hash syntax
-class OuterThing
-  # ... boilerplate ...
-  organize \
+    # context conditional
+    self.if(:some_key_on_context, DoThingA, DoThingB),
+
+    # alternative hash syntax
     {if: :key_set_on_context, then: DoThingA, else: DoThingB},
-    AfterBothCases
-end
-```
 
-### Conditionals with a key from the context 
+    # method call with hash syntax, plus implicit chaining
+    self.if(:key_set_on_context, then: [A, B, C], else: [B, C, D]),
 
-```ruby
-class OuterThing
-  # ... boilerplate ...
-  organize \
-    self.if(:key_set_on_context, DoThingA, DoThingB),
-    AfterBothCases
+    # method call with lambda, hash syntax, and implicit chaining
+    self.if(->(ctx) { ctx.this }, then: [A, B, C], else: [B, C, D]),
+    AfterDoThis
 end
 ```
 
@@ -250,6 +259,7 @@ class SomeOrganizer
 end
 
 ```
+
 ### Contract validation failures
 Sometimes contract validation fails at runtime as an exception. It's something unexpected and you'll have an `Interactor::Failure` sent to rollbar/sentry/honeybadger.
 If the context is large it's often hard to spot what the actual problem is or where it occurred.
@@ -298,7 +308,6 @@ Actual promises are:
 step1
 ```
 
-
 ### Interactor wiring specs
 Sometimes you have an interactor chain that fails because something is expected deeper down the chain and not provided further up the chain. 
 The existing way to solve this is with enough integration specs to catch them, hunting and sticking a `byebug`, `debugger` or `binding.pry` in at suspected locations and inferring where in the chain the wiring went awry.
@@ -310,7 +319,7 @@ In order to detect these wiring issues, stick a spec in your test suite like thi
 ```ruby
 RSpec.describe 'InteractorWiring' do
   it 'validates the interactors in the whole app', :aggregate_failures do
-    errors = Interactify.validate_app(ignore: [/Priam/])
+    errors = Interactify.validate_app(ignore: [/SomeClassName/, AnotherClass, 'SomeClassNameString'])
 
     expect(errors).to eq ''
   end
@@ -338,17 +347,7 @@ expect(described_class).to promise_outputs(:order)
 ### Sidekiq Jobs
 Sometimes you want to asyncify an interactor.
 
-```ruby
-# before
-class SomeInteractor
-  include Interactify
-
-  def call
-    # ...
-  end
-end
-```
-
+#### before
 ```diff
 - SomeInteractor.call(*args)
 + class SomeInteractorJob
@@ -362,24 +361,14 @@ end
 + SomeInteractorJob.perform_async(*args)
 ```
 
-```ruby
-# after
-class SomeInteractor
-  include Interactify
-
-  def call
-    # ...
-  end
-end
-```
-
-No need to manually create a job class or handle the perform/call impedance mismatch
-
+#### after
 ```diff
 - SomeInteractor.call!(*args)
 + SomeInteractor::Async.call!(*args)
 ```
 
+No need to manually create a job class or handle the perform/call impedance mismatch
+
 This also makes it easy to add cron jobs to run interactors. As any interactor can be asyncified.
 By using it's internal Async class.
 

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/no_railties_no_sidekiq.gemfile

@@ -0,0 +1,18 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+
+group :development do
+  gem "appraisal"
+  gem "bundler", "~> 2.0"
+end
+
+group :test do
+  gem "debug"
+  gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"

data/gemfiles/no_railties_no_sidekiq.gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: ..
+  specs:
+    interactify (0.4.0)
+      activesupport (>= 6.0.0)
+      interactor
+      interactor-contracts
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    drb (2.2.0)
+      ruby2_keywords
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    interactor (3.1.2)
+    interactor-contracts (0.3.0)
+      dry-validation (~> 1.0)
+      interactor (~> 3)
+    io-console (0.7.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    psych (5.1.2)
+      stringio
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.1.0)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 2.0)
+  debug
+  interactify!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   2.4.22

data/gemfiles/railties_6.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "simplecov", require: false
+gem "rake", "~> 13.0"
+gem "railties", "6"
+gem "sidekiq", "7"
+
+group :test do
+  gem "rspec", "~> 3.0"
+end
+
+gemspec path: "../"

data/gemfiles/railties_6.gemfile.lock

@@ -0,0 +1,253 @@
+PATH
+  remote: ..
+  specs:
+    interactify (0.3.0.pre.alpha.2)
+      interactor
+      interactor-contracts
+      rails (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-configurable (1.1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    interactor (3.1.2)
+    interactor-contracts (0.3.0)
+      dry-validation (~> 1.0)
+      interactor (~> 3)
+    io-console (0.7.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
+    net-imap (0.4.9)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    redis-client (0.19.1)
+      connection_pool
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    sidekiq (7.0.0)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.9.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    stringio (3.1.0)
+    thor (1.3.0)
+    thread_safe (0.3.6)
+    timeout (0.4.1)
+    tzinfo (1.2.11)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  debug
+  interactify!
+  railties (= 6)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sidekiq (= 7)
+  simplecov
+
+BUNDLED WITH
+   2.4.19

data/gemfiles/railties_6_no_sidekiq.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "railties", "6"
+
+group :development do
+  gem "appraisal"
+  gem "bundler", "~> 2.0"
+end
+
+group :test do
+  gem "debug"
+  gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
+end
+
+gemspec path: "../"