Merge branch 'main' into dependabot/bundler/rdoc-6.6.3.1

Author: markburns

.github/workflows/main.yml

@@ -15,9 +15,9 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.3.0'
-          - '3.2.2'
-          - '3.1.4'
+          - '3.3.3'
+          - '3.2.4'
+          - '3.1.6'
         appraisal:
           - 'railties-7-sidekiq'
           - 'railties-6-sidekiq'
@@ -36,12 +36,14 @@ jobs:
       run: bundle exec appraisal install
     - name: Run the specs for Appraisal
       env:
+        COVERAGE: true
         APPRAISAL: ${{ matrix.appraisal }}
         RUBY_VERSION: ${{ matrix.ruby }}
       run: bundle exec appraisal ${{ matrix.appraisal }} rake spec
     - name: Upload coverage reports to Codecov
       uses: codecov/codecov-action@v3
       env:
+        COVERAGE: true
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
         files: ./coverage/${{ matrix.ruby }}-${{ matrix.appraisal }}/coverage.json

CHANGELOG.md

@@ -1,37 +1,33 @@
 ## [Unreleased]
+- Add support for `Interactify.with(queue: 'within_30_seconds', retry: 3)`
 
-## [0.1.0-alpha.1] - 2023-12-16
-
-- Initial release
-
-## [0.2.0-alpha.1] - 2023-12-27
+## [0.5.0] - 2024-01-01
+- Add support for `SetA = Interactify { _1.a = 'a' }`, lambda and block class creation syntax
+- Add support for organizing `organize A.organizing(B, C, D), E, F` contract syntax
+- make definition errors raise optionally
+- raise an error with unexpected keys in Interactify.if clause
+- propagate caller_info through chains
 
-- Added support for Interactify.promising syntax in organizers
+## [0.4.1] - 2023-12-29
+- Fix bug triggered when nesting each and if
 
-## [0.3.0-alpha.1] - 2023-12-29
+## [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'`
 
-- Added support for `{if: :condition, then: A, else: B}` in organizers
+## [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.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'`
+## [0.3.0-alpha.1] - 2023-12-29
+- Added support for `{if: :condition, then: A, else: B}` in organizers
 
-## [0.4.1] - 2023-12-29
-- Fix bug triggered when nesting each and if
+## [0.2.0-alpha.1] - 2023-12-27
+- Added support for Interactify.promising syntax in organizers
 
-## [0.5.0] - 2024-01-01
-- Add support for `SetA = Interactify { _1.a = 'a' }`, lambda and block class creation syntax
-- Add support for organizing `organize A.organizing(B, C, D), E, F` contract syntax
-- make definition errors raise optionally
-- raise an error with unexpected keys in Interactify.if clause
-- propagate caller_info through chains
+## [0.1.0-alpha.1] - 2023-12-16
+- Initial release

README.md

@@ -108,6 +108,26 @@ class LoadOrder
 end
 ```
 
+#### filled: false
+Both expect and promise can take the optional parameter `filled: false`
+This means that whilst the key is expected to be passed, it doesn't have to have a truthy or present value.
+Use this where valid values include, `[]`, `""`, `nil` or `false` etc.
+
+
+#### optional
+
+```ruby
+class LoadOrder
+  include Interactify
+
+  optional :some_key, :another_key
+end
+```
+
+Optional can be used to denote that the key is not required to be passed.
+This is effectively equivalent to `delegate :key, to: :context`, but does not require the key to be present in the context.
+This is not recommended as the keys will not be validated by the contract or the interactor wiring specs.
+
 
 ### Lambdas
 
@@ -467,6 +487,39 @@ By using it's internal Async class.
 > [!CAUTION]
 > As your class is now executing asynchronously you can no longer rely on its promises later on in the chain.
 
+
+### Sidekiq options
+```ruby
+class SomeInteractor
+  include Interactify.with(queue: 'within_30_seconds')
+end
+```
+
+This allows you to set the sidekiq options for the asyncified interactor.
+It will autogenerate a class name that has the options set.
+
+`SomeInteractor::Job__Queue_Within30Seconds` or with a random number suffix
+if there is a naming clash.
+
+`SomeInteractor::Job__Queue_Within30Seconds_5342`
+
+This is also aliased as `SomeInteractor::Job` for convenience.
+
+An almost equivalent to the above without the `.with` method is:
+
+```ruby
+class SomeInteractor
+  include Interactify
+
+  class JobWithin30Seconds < Job
+    sidekiq_options queue: 'within_30_seconds'
+  end
+end
+```
+
+Here the JobWithin30Seconds class is manually set up and subclasses the one
+automatically created by `include Interactify`.
+
 ## FAQs
 - This is ugly isn't it?
 

gemfiles/no_railties_no_sidekiq.gemfile

@@ -13,6 +13,7 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end
 
 gemspec path: "../"

gemfiles/no_railties_no_sidekiq.gemfile.lock

@@ -76,6 +76,7 @@ GEM
     irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     minitest (5.20.0)
     mutex_m (0.2.0)
     psych (5.1.2)
@@ -104,6 +105,9 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.3.0)
@@ -122,6 +126,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

gemfiles/railties_6_no_sidekiq.gemfile

@@ -14,6 +14,7 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end
 
 gemspec path: "../"

gemfiles/railties_6_no_sidekiq.gemfile.lock

@@ -83,6 +83,7 @@ GEM
     irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -134,6 +135,9 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.3.0)
@@ -154,6 +158,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

gemfiles/railties_6_sidekiq.gemfile

@@ -15,6 +15,7 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end
 
 gemspec path: "../"

gemfiles/railties_6_sidekiq.gemfile.lock

@@ -84,6 +84,7 @@ GEM
     irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -142,6 +143,9 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.3.0)
@@ -163,6 +167,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   sidekiq (= 7)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

gemfiles/railties_7_no_sidekiq.gemfile

@@ -14,6 +14,7 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end
 
 gemspec path: "../"

gemfiles/railties_7_no_sidekiq.gemfile.lock

@@ -82,6 +82,7 @@ GEM
     irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -134,6 +135,9 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.3.0)
@@ -153,6 +157,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

gemfiles/railties_7_sidekiq.gemfile

@@ -15,6 +15,7 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end
 
 gemspec path: "../"

gemfiles/railties_7_sidekiq.gemfile.lock

@@ -83,6 +83,7 @@ GEM
     irb (1.11.0)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -142,6 +143,9 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-json (0.2.3)
+      json
+      simplecov
     simplecov_json_formatter (0.1.4)
     stringio (3.1.0)
     thor (1.3.0)
@@ -162,6 +166,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   sidekiq (= 7)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

lib/interactify.rb

@@ -14,6 +14,7 @@
 require "interactify/dependency_inference"
 require "interactify/hooks"
 require "interactify/configure"
+require "interactify/with_options"
 
 module Interactify
   extend ActiveSupport::Concern
@@ -22,39 +23,18 @@ module Interactify
 
   class << self
     delegate :root, to: :configuration
-  end
-
-  included do |base|
-    base.extend Interactify::Dsl
-
-    base.include Interactor::Organizer
-    base.include Interactor::Contracts
-    base.include Interactify::Contracts::Helpers
-
-    # defines two classes on the receiver class
-    # the first is the job class
-    # the second is the async class
-    # the async class is a wrapper around the job class
-    # that allows it to be used in an interactor chain
-    #
-    # E.g.
-    #
-    # class ExampleInteractor
-    #  include Interactify
-    #  expect :foo
-    # end
-    #
-    # ExampleInteractor::Job is a class availabe to be used in a sidekiq yaml file
-    #
-    # doing the following will immediately enqueue a job
-    # that calls the interactor ExampleInteractor with (foo: 'bar')
-    #
-    # ExampleInteractor::Async.call(foo: 'bar')
-    include Interactify::Async::Jobable
-    interactor_job
-  end
 
-  def called_klass_list
-    context._called.map(&:class)
+    def included(base)
+      # call `with` without arguments to get default Job and Async classes
+      base.include(with)
+    end
+
+    def with(sidekiq_opts = {})
+      Module.new do
+        define_singleton_method :included do |receiver|
+          WithOptions.new(receiver, sidekiq_opts).setup
+        end
+      end
+    end
   end
 end

lib/interactify/async/job_klass.rb

@@ -51,7 +51,7 @@ def args(context)
       end
 
       def restrict_to_optional_or_keys_from_contract(args)
-        keys = container_klass.expected_keys.map(&:to_s)
+        keys = Array(container_klass.expected_keys).map(&:to_s)
 
         optional = Array(container_klass.optional_attrs).map(&:to_s)
         keys += optional