interactify 0.3.0.pre.RC1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 319dd56313d82aa987c8eaec40691e43c58e8b72513969e2a6a7a83de17ae311
-  data.tar.gz: 3f5e4ad0464157910bca7bfd1300fa8e23ab825068c84a4c5c0ef5ad0cdb29d6
+  metadata.gz: 0ec61ad4a3a73d2c36430e29d01ae754b670ebdaab812f3d946b61adff9bf8ae
+  data.tar.gz: b4441070a5178d6933f97adf465bce313e638fef6dc42901d4e6d84c7a8e73d2
 SHA512:
-  metadata.gz: fea0120a4456f108b41ccd48c994e365762bad8ff6424eba9d7ecd0c09c6858805e0456df0655eec86042ed7dc9fa589ffb8f3bdb49a14e79a7e05e30b6737ae
-  data.tar.gz: 64345da2e8b036ad65c639bddb9c0f90f93b1fdbc1415a5cb29f26596fa9169c6a9b0309d9d0ecbb515706251ff473f4ac98f7b41be7d89c089ce3b8537ade54
+  metadata.gz: b0552ea7eabc4a818888a255bb674c430babf57504b921e0cfd48949e9c0cee8bd3eb722b584e28c2a1aed7643f1b277f335b827a3af1cc6d2e121feb7c0856c
+  data.tar.gz: 73995415964151caf4f4b1977cecd558791ff14e4d475a26dda813b4403c29e2c4c59d06daf63e67800e29e44cbca558e26c970acdbef635d1a781fbfbdffada

data/.rubocop.yml

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

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise "railties-7-sidekiq" do
   gem "railties", "7"
   gem "sidekiq", "7"

data/CHANGELOG.md

@@ -20,3 +20,8 @@
 
 - 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,7 +1,6 @@
 # Interactify
 
 [![Gem Version](https://badge.fury.io/rb/interactify.svg)](https://badge.fury.io/rb/interactify)
-![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=markburns/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)
@@ -41,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)
 ```
@@ -233,6 +233,12 @@ class OuterThing
 
     # alternative hash syntax
     {if: :key_set_on_context, then: DoThingA, else: DoThingB},
+
+    # method call with hash syntax, plus implicit chaining
+    self.if(:key_set_on_context, then: [A, B, C], else: [B, C, D]),
+
+    # method call with lambda, hash syntax, and implicit chaining
+    self.if(->(ctx) { ctx.this }, then: [A, B, C], else: [B, C, D]),
     AfterDoThis
 end
 ```
@@ -313,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

data/gemfiles/no_railties_no_sidekiq.gemfile

@@ -5,12 +5,14 @@ source "https://rubygems.org"
 gem "rake", "~> 13.0"
 
 group :development do
+  gem "appraisal"
   gem "bundler", "~> 2.0"
 end
 
 group :test do
-  gem "simplecov", require: false
+  gem "debug"
   gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end
 
 gemspec path: "../"

data/gemfiles/no_railties_no_sidekiq.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    interactify (0.3.0.pre.alpha.2)
+    interactify (0.4.0)
       activesupport (>= 6.0.0)
       interactor
       interactor-contracts

data/gemfiles/railties_6_no_sidekiq.gemfile

@@ -6,12 +6,14 @@ gem "rake", "~> 13.0"
 gem "railties", "6"
 
 group :development do
+  gem "appraisal"
   gem "bundler", "~> 2.0"
 end
 
 group :test do
-  gem "simplecov", require: false
+  gem "debug"
   gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end
 
 gemspec path: "../"

data/gemfiles/railties_6_no_sidekiq.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    interactify (0.3.0.pre.alpha.2)
+    interactify (0.4.0)
+      activesupport (>= 6.0.0)
       interactor
       interactor-contracts
 

data/gemfiles/railties_6_sidekiq.gemfile

@@ -7,12 +7,14 @@ gem "railties", "6"
 gem "sidekiq", "7"
 
 group :development do
+  gem "appraisal"
   gem "bundler", "~> 2.0"
 end
 
 group :test do
-  gem "simplecov", require: false
+  gem "debug"
   gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end
 
 gemspec path: "../"

data/gemfiles/railties_6_sidekiq.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    interactify (0.3.0.pre.alpha.2)
+    interactify (0.4.0)
+      activesupport (>= 6.0.0)
       interactor
       interactor-contracts
 

data/gemfiles/railties_7_no_sidekiq.gemfile

@@ -6,12 +6,14 @@ gem "rake", "~> 13.0"
 gem "railties", "7"
 
 group :development do
+  gem "appraisal"
   gem "bundler", "~> 2.0"
 end
 
 group :test do
-  gem "simplecov", require: false
+  gem "debug"
   gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end
 
 gemspec path: "../"

data/gemfiles/railties_7_no_sidekiq.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    interactify (0.3.0.pre.alpha.2)
+    interactify (0.4.0)
+      activesupport (>= 6.0.0)
       interactor
       interactor-contracts
 

data/gemfiles/railties_7_sidekiq.gemfile

@@ -7,12 +7,14 @@ gem "railties", "7"
 gem "sidekiq", "7"
 
 group :development do
+  gem "appraisal"
   gem "bundler", "~> 2.0"
 end
 
 group :test do
-  gem "simplecov", require: false
+  gem "debug"
   gem "rspec", "~> 3.0"
+  gem "simplecov", require: false
 end
 
 gemspec path: "../"

data/gemfiles/railties_7_sidekiq.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    interactify (0.3.0.pre.alpha.2)
+    interactify (0.4.0)
+      activesupport (>= 6.0.0)
       interactor
       interactor-contracts
 

data/lib/interactify/async/job_klass.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Interactify
+  module Async
+    class JobKlass
+      attr_reader :container_klass, :klass_suffix
+
+      def initialize(container_klass:, klass_suffix:)
+        @container_klass = container_klass
+        @klass_suffix = klass_suffix
+      end
+
+      def async_job_klass
+        klass = Class.new do
+          include Interactor
+          include Interactor::Contracts
+        end
+
+        attach_call(klass)
+        attach_call!(klass)
+
+        klass
+      end
+
+      def attach_call(async_job_klass)
+        # e.g. SomeInteractor::AsyncWithSuffix.call(foo: 'bar')
+        async_job_klass.send(:define_singleton_method, :call) do |context|
+          call!(context)
+        end
+      end
+
+      def attach_call!(async_job_klass)
+        this = self
+
+        # e.g. SomeInteractor::AsyncWithSuffix.call!(foo: 'bar')
+        async_job_klass.send(:define_singleton_method, :call!) do |context|
+          # e.g. SomeInteractor::JobWithSuffix
+          job_klass = this.container_klass.const_get("Job#{this.klass_suffix}")
+
+          # e.g. SomeInteractor::JobWithSuffix.perform_async({foo: 'bar'})
+          job_klass.perform_async(this.args(context))
+        end
+      end
+
+      def args(context)
+        args = context.to_h.stringify_keys
+
+        return args unless container_klass.respond_to?(:expected_keys)
+
+        restrict_to_optional_or_keys_from_contract(args)
+      end
+
+      def restrict_to_optional_or_keys_from_contract(args)
+        keys = container_klass.expected_keys.map(&:to_s)
+
+        optional = Array(container_klass.optional_attrs).map(&:to_s)
+        keys += optional
+
+        args.slice(*keys)
+      end
+    end
+  end
+end

data/lib/interactify/async/job_maker.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "interactify/async/job_klass"
+require "interactify/async/null_job"
+
+module Interactify
+  module Async
+    class JobMaker
+      attr_reader :opts, :method_name, :container_klass, :klass_suffix
+
+      def initialize(container_klass:, opts:, klass_suffix:, method_name: :call!)
+        @container_klass = container_klass
+        @opts = opts
+        @method_name = method_name
+        @klass_suffix = klass_suffix
+      end
+
+      concerning :JobClass do
+        def job_klass
+          @job_klass ||= define_job_klass
+        end
+
+        private
+
+        def define_job_klass
+          return NullJob if Interactify.sidekiq_missing?
+
+          this = self
+
+          invalid_keys = this.opts.symbolize_keys.keys - %i[queue retry dead backtrace pool tags]
+
+          raise ArgumentError, "Invalid keys: #{invalid_keys}" if invalid_keys.any?
+
+          build_job_klass(opts).tap do |klass|
+            klass.const_set(:JOBABLE_OPTS, opts)
+            klass.const_set(:JOBABLE_METHOD_NAME, method_name)
+          end
+        end
+
+        def build_job_klass(opts)
+          Class.new do
+            include Sidekiq::Job
+
+            sidekiq_options(opts)
+
+            def perform(...)
+              self.class.module_parent.send(self.class::JOBABLE_METHOD_NAME, ...)
+            end
+          end
+        end
+      end
+
+      def async_job_klass
+        JobKlass.new(container_klass:, klass_suffix:).async_job_klass
+      end
+    end
+  end
+end

data/lib/interactify/async/jobable.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "interactify/async/job_maker"
+
+module Interactify
+  module Async
+    module Jobable
+      extend ActiveSupport::Concern
+
+      # e.g. if Klass < Base
+      # and Base has a Base::Job class
+      #
+      # then let's make sure to define Klass::Job separately
+      included do |base|
+        next if Interactify.sidekiq_missing?
+
+        def base.inherited(klass)
+          super_klass = klass.superclass
+          super_job = super_klass::Job # really spiffing
+
+          opts = super_job::JOBABLE_OPTS
+          jobable_method_name = super_job::JOBABLE_METHOD_NAME
+
+          to_call = defined?(super_klass::Async) ? :interactor_job : :job_calling
+
+          klass.send(to_call, opts:, method_name: jobable_method_name)
+          super(klass)
+        end
+      end
+
+      class_methods do
+        # create a Job class and an Async class
+        # see job_calling for details on the Job 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
+        #
+        #   include Jobable
+        #   interactor_job
+        # end
+        #
+        # doing the following will immediately enqueue a job
+        # that calls the interactor ExampleInteractor with (foo: 'bar')
+        # ExampleInteractor::Async.call(foo: 'bar')
+        #
+        # it will also ensure to pluck only the expects from the context
+        # so that you can have other non primitive values in the context
+        # but the job will only have the expects passed to it
+        #
+        # obviously you will need to be aware that later interactors
+        # in an interactor chain cannot depend on the result of the async
+        # interactor
+        def interactor_job(method_name: :call!, opts: {}, klass_suffix: "")
+          job_maker = JobMaker.new(container_klass: self, opts:, method_name:, klass_suffix:)
+          # with WhateverInteractor::Job you can perform the interactor as a job
+          # from sidekiq
+          # e.g. WhateverInteractor::Job.perform_async(...)
+          const_set("Job#{klass_suffix}", job_maker.job_klass)
+
+          # with WhateverInteractor::Async you can call WhateverInteractor::Job
+          # in an organizer oro on its oen using normal interactor call call! semantics
+          # e.g. WhateverInteractor::Async.call(...)
+          #      WhateverInteractor::Async.call!(...)
+          const_set("Async#{klass_suffix}", job_maker.async_job_klass)
+        end
+
+        # if this was defined in ExampleClass this creates the following class
+        # ExampleClass::Job
+        # this class ia added as a convenience so you can easily turn a
+        # class method into a job
+        #
+        # Example:
+        #
+        # class ExampleClass
+        #   include Jobable
+        #   job_calling method_name: :some_method
+        # end
+        #
+        # # the following class is created that you can use to enqueue a job
+        # in the sidekiq yaml file
+        # ExampleClass::Job.some_method
+        def job_calling(method_name:, opts: {}, klass_suffix: "")
+          job_maker = JobMaker.new(container_klass: self, opts:, method_name:, klass_suffix:)
+
+          const_set("Job#{klass_suffix}", job_maker.job_klass)
+        end
+      end
+    end
+  end
+end

data/lib/interactify/async/null_job.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Interactify
+  module Async
+    class NullJob
+      def method_missing(...)
+        self
+      end
+
+      def self.method_missing(...)
+        self
+      end
+
+      def respond_to_missing?(...)
+        true
+      end
+
+      def self.respond_to_missing?(...)
+        true
+      end
+    end
+  end
+end

data/lib/interactify/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Interactify
+  class Configuration
+    attr_writer :root
+
+    def root
+      @root ||= fallback
+    end
+
+    def fallback
+      Rails.root / "app" if Interactify.railties?
+    end
+  end
+end

data/lib/interactify/contracts/call_wrapper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Interactify
+  module Contracts
+    module CallWrapper
+      # https://github.com/collectiveidea/interactor/blob/57b2af9a5a5afeb2c01059c40b792485cc21b052/lib/interactor.rb#L114
+      # Interactor#run calls Interactor#run!
+      # https://github.com/collectiveidea/interactor/blob/57b2af9a5a5afeb2c01059c40b792485cc21b052/lib/interactor.rb#L49
+      # Interactor.call calls Interactor.run
+      #
+      # The non bang methods call the bang methods and rescue
+      def run
+        @_interactor_called_by_non_bang_method = true
+
+        super
+      end
+    end
+  end
+end

data/lib/interactify/contracts/failure.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Interactify
+  module Contracts
+    class Failure < ::Interactor::Failure
+    end
+  end
+end

data/lib/interactify/contracts/helpers.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "interactify/async/jobable"
+require "interactify/contracts/call_wrapper"
+require "interactify/contracts/failure"
+require "interactify/contracts/setup"
+require "interactify/dsl/organizer"
+
+module Interactify
+  module Contracts
+    module Helpers
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def expect(*attrs, filled: true)
+          Setup.expects(context: self, attrs:, filled:)
+        end
+
+        def promise(*attrs, filled: true, should_delegate: true)
+          Setup.promises(context: self, attrs:, filled:, should_delegate:)
+        end
+
+        def promising(*args)
+          Promising.validate(self, *args)
+        end
+
+        def promised_keys
+          _interactify_extract_keys(contract.promises)
+        end
+
+        def expected_keys
+          _interactify_extract_keys(contract.expectations)
+        end
+
+        def optional(*attrs)
+          @optional_attrs ||= []
+          @optional_attrs += attrs
+
+          delegate(*attrs, to: :context)
+        end
+
+        attr_reader :optional_attrs
+
+        private
+
+        # this is the most brittle part of the code, relying on
+        # interactor-contracts internals
+        # so extracted it to here so change is isolated
+        def _interactify_extract_keys(clauses)
+          clauses.instance_eval { @terms }.json&.rules&.keys
+        end
+      end
+
+      included do
+        c = Class.new(Contracts::Failure)
+        # example self is Whatever::SomeInteractor
+        # failure class:  Whatever::SomeInteractor::InteractorContractFailure
+        const_set "InteractorContractFailure", c
+        prepend Contracts::CallWrapper
+        include Dsl::Organizer
+
+        on_breach do |breaches|
+          breaches = breaches.map { |b| { b.property => b.messages } }.inject(&:merge)
+
+          Interactify.trigger_contract_breach_hook(context, breaches)
+
+          if @_interactor_called_by_non_bang_method == true
+            context.fail! contract_failures: breaches
+          else
+            # e.g. raises
+            # SomeNamespace::SomeClass::ContractFailure, {whatever: 'is missing'}
+            # but also sending the context into Sentry
+            exception = c.new(breaches.to_json)
+            Interactify.trigger_before_raise_hook(exception)
+            raise exception
+          end
+        end
+      end
+    end
+  end
+end

data/lib/interactify/contracts/mismatching_promise_error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "interactify/contracts/failure"
+
+module Interactify
+  module Contracts
+    class MismatchingPromiseError < Contracts::Failure
+      def initialize(interactor, promising, promised_keys)
+        super <<~MESSAGE.chomp
+          #{interactor} does not promise:
+          #{promising.inspect}
+
+          Actual promises are:
+          #{promised_keys.inspect}
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/interactify/contracts/promising.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "interactify/contracts/mismatching_promise_error"
+
+module Interactify
+  module Contracts
+    class Promising
+      attr_reader :interactor, :promising
+
+      def self.validate(interactor, *promising)
+        new(interactor, *promising).validate
+
+        interactor
+      end
+
+      def initialize(interactor, *promising)
+        @interactor = interactor
+        @promising = format_keys promising
+      end
+
+      def validate
+        return if promising == promised_keys
+
+        raise MismatchingPromiseError.new(interactor, promising, promised_keys)
+      end
+
+      def promised_keys
+        format_keys interactor.promised_keys
+      end
+
+      def format_keys(keys)
+        Array(keys).compact.map(&:to_sym).sort
+      end
+    end
+  end
+end