interactify 0.1.0.pre.alpha.1

data/lib/interactify/if_interactor.rb

@@ -0,0 +1,64 @@
+module Interactify
+  class IfInteractor
+    attr_reader :condition, :success_interactor, :failure_interactor, :evaluating_receiver
+
+    def self.attach_klass(evaluating_receiver, condition, succcess_interactor, failure_interactor)
+      ifable = new(evaluating_receiver, condition, succcess_interactor, failure_interactor)
+      ifable.attach_klass
+    end
+
+    def initialize(evaluating_receiver, condition, succcess_interactor, failure_interactor)
+      @evaluating_receiver = evaluating_receiver
+      @condition = condition
+      @success_interactor = succcess_interactor
+      @failure_interactor = failure_interactor
+    end
+
+    # allows us to dynamically create an interactor chain
+    # that iterates over the packages and
+    # uses the passed in each_loop_klasses
+    # rubocop:disable all
+    def klass
+      this = self
+
+      Class.new do                                                           
+        include Interactor                                                    
+        include Interactor::Contracts                                          
+
+        expects do                                                              
+          required(this.condition) unless this.condition.is_a?(Proc)
+        end                                                                       
+
+        define_singleton_method(:source_location) do                               
+          const_source_location this.evaluating_receiver.to_s                                     #     [file, line]
+        end                                                                          
+
+        define_method(:run!) do                                                       
+          result = this.condition.is_a?(Proc) ? this.condition.call(context) : context.send(this.condition)
+          interactor = result ? this.success_interactor : this.failure_interactor
+          interactor&.respond_to?(:call!) ? interactor.call!(context) : interactor&.call(context)
+        end
+
+        define_method(:inspect) do
+          "<#{this.namespace}::#{this.if_klass_name} #{this.condition} ? #{this.success_interactor} : #{this.failure_interactor}>"
+        end
+      end
+    end
+    # rubocop:enable all
+
+    def attach_klass
+      namespace.const_set(if_klass_name, klass)
+      namespace.const_get(if_klass_name)
+    end
+
+    def namespace
+      evaluating_receiver
+    end
+
+    def if_klass_name
+      name = condition.is_a?(Proc) ? 'Proc' : condition
+
+      "If#{name.to_s.camelize}".to_sym
+    end
+  end
+end

data/lib/interactify/interactor_wiring.rb

@@ -0,0 +1,305 @@
+require 'active_support/all'
+
+module Interactify
+  class InteractorWiring
+    attr_reader :root, :namespace, :ignore
+
+    def initialize(root: Rails.root, namespace: 'Object', ignore: [])
+      @root = root.to_s.gsub(%r{/$}, '')
+      @namespace = namespace
+      @ignore = ignore
+    end
+
+    concerning :Validation do
+      def validate_app
+        errors = organizers.each_with_object({}) do |organizer, all_errors|
+          next if ignore_klass?(ignore, organizer.klass)
+
+          errors = organizer.validate_callable
+          all_errors[organizer] = errors
+        end
+
+        format_errors(errors)
+      end
+
+      def format_errors(all_errors)
+        formatted_errors = []
+
+        all_errors.each do |organizer, error_context|
+          next if ignore_klass?(ignore, organizer.klass)
+
+          error_context.missing_keys.each do |interactor, missing|
+            next if ignore_klass?(ignore, interactor.klass)
+
+            formatted_errors << <<~ERROR
+              Missing keys: #{missing.to_a.map(&:to_sym).map(&:inspect).join(', ')}
+                        in: #{interactor.klass}
+                       for: #{organizer.klass}
+            ERROR
+          end
+        end
+
+        formatted_errors.join("\n\n")
+      end
+
+      def ignore_klass?(ignore, klass)
+        case ignore
+        when Array
+          ignore.any? { ignore_klass?(_1, klass) }
+        when Regexp
+          klass.to_s =~ ignore
+        when String
+          klass.to_s[ignore]
+        when Proc
+          ignore.call(klass)
+        when Class
+          klass <= ignore
+        end
+      end
+    end
+
+    class CallableRepresentation
+      attr_reader :filename, :klass, :wiring
+
+      delegate :interactor_lookup, to: :wiring
+
+      def initialize(filename:, klass:, wiring:, organizer: nil)
+        @filename = filename
+        @klass = klass
+        @wiring = wiring
+      end
+
+      def validate_callable(error_context: ErrorContext.new)
+        if organizer?
+          assign_previously_defined(error_context: error_context)
+          validate_children(error_context: error_context)
+        end
+
+        validate_self(error_context: error_context)
+      end
+
+      def promised_keys
+        Array(klass.contract.promises.instance_eval { @terms }.json&.rules&.keys)
+      end
+
+      def expected_keys
+        Array(klass.contract.expectations.instance_eval { @terms }.json&.rules&.keys)
+      end
+
+      def all_keys
+        expected_keys.concat(promised_keys)
+      end
+
+      def inspect
+        "#<#{self.class.name}#{object_id} @filename=#{filename}, @klass=#{klass.name}>"
+      end
+
+      def organizer?
+        klass.respond_to?(:organized)
+      end
+
+      def assign_previously_defined(error_context:)
+        return unless contract?
+
+        error_context.append_previously_defined_keys(all_keys)
+      end
+
+      def validate_children(error_context:)
+        klass.organized.each do |interactor|
+          nested_callable = interactor_lookup[interactor]
+          next if nested_callable.nil?
+
+          error_context = nested_callable.validate_callable(error_context: error_context)
+        end
+
+        error_context
+      end
+
+      private
+
+      def contract?
+        klass.ancestors.include? Interactor::Contracts
+      end
+
+      def validate_self(error_context:)
+        return error_context unless contract?
+
+        error_context.infer_missing_keys(self)
+        error_context.add_promised_keys(promised_keys)
+        error_context
+      end
+    end
+
+    class ErrorContext
+      def previously_defined_keys
+        @previously_defined_keys ||= Set.new
+      end
+
+      def append_previously_defined_keys(keys)
+        keys.each do |key|
+          previously_defined_keys << key
+        end
+      end
+
+      def missing_keys
+        @missing_keys ||= {}
+      end
+
+      def add_promised_keys(promised_keys)
+        promised_keys.each do |key|
+          previously_defined_keys << key
+        end
+      end
+
+      def infer_missing_keys(callable)
+        new_keys = callable.expected_keys
+        not_in_previous_keys = new_keys.reject { |key| previously_defined_keys.include?(key) }
+
+        add_missing_keys(callable, not_in_previous_keys)
+      end
+
+      def add_missing_keys(callable, not_in_previous_keys)
+        return if not_in_previous_keys.empty?
+
+        missing_keys[callable] ||= Set.new
+        missing_keys[callable] += not_in_previous_keys
+      end
+    end
+
+    concerning :Constants do
+      def organizers
+        @organizers ||= organizer_files.flat_map do |f|
+          next if f[/interactor_organizer_contracts/] || f[/interactor_contracts/]
+
+          callables_in_file(f)
+        end.compact.select(&:organizer?)
+      end
+
+      def interactors
+        @interactors ||= interactor_files.flat_map do |f|
+          callables_in_file(f)
+        end.compact.reject(&:organizer?)
+      end
+
+      def callables_in_file(f)
+        @callables_in_file ||= {}
+
+        @callables_in_file[f] ||= _callables_in_file(f)
+      end
+
+      def _callables_in_file(f)
+        constant = constant_for(f)
+        return if constant == Interactify
+
+        internal_klasses = internal_constants_for(constant)
+
+        ([constant] + internal_klasses).map { |k| new_callable(f, k, self) }
+      end
+
+      def internal_constants_for(constant)
+        constant
+          .constants
+          .map { |sym| constant_from_symbol(constant, sym) }
+          .select { |pk| interactor_klass?(pk) }
+      end
+
+      def constant_from_symbol(constant, symbol)
+        constant.module_eval do
+          symbol.to_s.constantize
+        rescue StandardError
+          "#{constant.name}::#{symbol}".constantize rescue nil
+        end
+      end
+
+      def interactor_klass?(object)
+        return unless object.is_a? Class
+
+        object.ancestors.include?(Interactor) || object.ancestors.include?(Interactor::Organizer)
+      end
+
+      def new_callable(filename, klass, wiring)
+        CallableRepresentation.new(filename: filename, klass: klass, wiring: wiring)
+      end
+
+      def interactor_lookup
+        @interactor_lookup ||= (interactors + organizers).index_by(&:klass)
+      end
+
+      private
+
+      def constant_for(filename)
+        require filename
+
+        underscored_klass_name = underscored_klass_name_without_outer_namespace(filename)
+        underscored_klass_name = trim_rails_folder underscored_klass_name
+
+        klass_name = underscored_klass_name.classify
+
+        should_pluralize = filename[underscored_klass_name.pluralize]
+        klass_name = klass_name.pluralize if should_pluralize
+
+        outer_namespace_constant.const_get(klass_name)
+      end
+
+      # Example:
+      # trim_rails_folder("interactors/namespace/sub_namespace/class_name.rb")
+      # => "namespace/sub_namespace/class_name.rb"
+      def trim_rails_folder(filename)
+        rails_folders = Dir.glob(Interactify.root / '*').map { |f| File.basename(f) }
+
+        rails_folders.each do |folder|
+          regexable_folder = Regexp.quote("#{folder}/")
+          regex = /^#{regexable_folder}/
+
+          return filename.gsub(regex, '') if filename.match?(regex)
+        end
+
+        filename
+      end
+
+      # Example:
+      # "/home/code/something/app/interactors/namespace/sub_namespace/class_name.rb"
+      # "/namespace/sub_namespace/class_name.rb"
+      #  ['', 'namespace', 'sub_namespace', 'class_name.rb']
+      #  ['namespace', 'sub_namespace', 'class_name.rb']
+      # remove outernamespace (SpecSupport)
+      def underscored_klass_name_without_outer_namespace(filename)
+        filename.to_s # "/home/code/something/app/interactors/namespace/sub_namespace/class_name.rb"
+          .gsub(root.to_s, '')   # "/namespace/sub_namespace/class_name.rb"
+          .gsub('/concerns', '') #  concerns directory is ignored by Zeitwerk
+          .split('/')            # "['', 'namespace', 'sub_namespace', 'class_name.rb']
+          .compact_blank         # "['namespace', 'sub_namespace', 'class_name.rb']
+          .reject.with_index { |segment, i| i.zero? && segment == namespace }
+          .join('/')             # 'namespace/sub_namespace/class_name.rb'
+          .gsub(/\.rb\z/, '')     # 'namespace/sub_namespace/class_name'
+      end
+
+      def outer_namespace_constant
+        @outer_namespace_constant ||= Object.const_get(namespace)
+      end
+    end
+
+    concerning :Files do
+      def organizer_files
+        possible_files.select { |_, contents| organizer_file?(contents) }.map(&:first).sort
+      end
+
+      def interactor_files
+        possible_files.select { |_, contents| interactor_file?(contents) }.map(&:first).sort
+      end
+
+      def organizer_file?(file_contents)
+        (file_contents['include Interactify'] || file_contents[/include Interactor::Organizer/]) &&
+          file_contents[/^\s+organize/]
+      end
+
+      def interactor_file?(file_contents)
+        file_contents['include Interactify'] || file_contents[/include Interactor$/]
+      end
+
+      def possible_files
+        @possible_files ||= Dir.glob("#{root}/**/*.rb").map { |f| [f, File.read(f)] }
+      end
+    end
+  end
+end

data/lib/interactify/job_maker.rb

@@ -0,0 +1,105 @@
+require 'sidekiq'
+require 'sidekiq/job'
+
+module Interactify
+  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_class
+        @job_class ||= define_job_class
+      end
+
+      private
+
+      def define_job_class
+        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?
+
+        job_class = Class.new do
+          include Sidekiq::Job
+
+          sidekiq_options(this.opts)
+
+          def perform(...)
+            self.class.module_parent.send(self.class::JOBABLE_METHOD_NAME, ...)
+          end
+        end
+
+        job_class.const_set(:JOBABLE_OPTS, opts)
+        job_class.const_set(:JOBABLE_METHOD_NAME, method_name)
+        job_class
+      end
+    end
+
+    concerning :AsyncJobClass do
+      def async_job_class
+        klass = Class.new do
+          include Interactor
+          include Interactor::Contracts
+        end
+
+        attach_call(klass)
+        attach_call!(klass)
+
+        klass
+      end
+
+      def args(context)
+        args = context.to_h.stringify_keys
+
+        return args unless container_klass.respond_to?(:contract)
+
+        restrict_to_optional_or_keys_from_contract(args)
+      end
+
+      private
+
+      def attach_call(async_job_class)
+        # e.g. SomeInteractor::AsyncWithSuffix.call(foo: 'bar')
+        async_job_class.send(:define_singleton_method, :call) do |context|
+          call!(context)
+        end
+      end
+
+      def attach_call!(async_job_class)
+        this = self
+
+        # e.g. SomeInteractor::AsyncWithSuffix.call!(foo: 'bar')
+        async_job_class.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 restrict_to_optional_or_keys_from_contract(args)
+        keys = container_klass
+               .contract
+               .expectations
+               .instance_eval { @terms }
+               .schema
+               .key_map
+               .to_dot_notation
+               .map(&:to_s)
+
+        optional = Array(container_klass.optional_attrs).map(&:to_s)
+        keys += optional
+
+        args.slice(*keys)
+      end
+    end
+  end
+end

data/lib/interactify/jobable.rb

@@ -0,0 +1,90 @@
+require 'interactify/job_maker'
+
+module Interactify
+  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|
+      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: 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_class)
+
+        # 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_class)
+      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_class)
+      end
+    end
+  end
+end

data/lib/interactify/organizer_call_monkey_patch.rb

@@ -0,0 +1,40 @@
+module Interactify
+  module OrganizerCallMonkeyPatch
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def organize(*interactors)
+        wrapped = wrap_lambdas_in_interactors(interactors)
+
+        super(*wrapped)
+      end
+
+      def wrap_lambdas_in_interactors(interactors)
+        Array(interactors).map do |interactor|
+          case interactor
+          when Proc
+            Class.new do
+              include Interactify
+
+              define_method(:call) do
+                interactor.call(context)
+              end
+            end
+          else
+            interactor
+          end
+        end
+      end
+    end
+
+    def call
+      self.class.organized.each do |interactor|
+        instance = interactor.new(context)
+        instance.instance_variable_set(:@_interactor_called_by_non_bang_method,
+                                       @_interactor_called_by_non_bang_method)
+
+        instance.tap(&:run!)
+      end
+    end
+  end
+end

data/lib/interactify/rspec/matchers.rb

@@ -0,0 +1,69 @@
+require 'interactify/interactor_wiring'
+
+# Custom matcher that implements expect_inputs
+# e.g.
+# expect(described_class).to expect_inputs(:connection, :order)
+
+RSpec::Matchers.define :expect_inputs do |*expected_inputs|
+  match do |actual|
+    actual_inputs = expected_keys(actual)
+    @missing_inputs = expected_inputs - actual_inputs
+    @extra_inputs = actual_inputs - expected_inputs
+
+    @missing_inputs.empty? && @extra_inputs.empty?
+  end
+
+  failure_message do |actual|
+    message = "expected #{actual} to expect inputs #{expected_inputs.inspect}"
+    message += "\n\tmissing inputs: #{@missing_inputs}" if @missing_inputs
+    message += "\n\textra inputs: #{@extra_inputs}" if @extra_inputs
+    message
+  end
+
+  def expected_keys(klass)
+    Array(klass.contract.expectations.instance_eval { @terms }.json&.rules&.keys)
+  end
+end
+
+# Custom matcher that implements promise_outputs
+# e.g. expect(described_class).to promise_outputs(:request_logger)
+RSpec::Matchers.define :promise_outputs do |*expected_outputs|
+  match do |actual|
+    actual_outputs = promised_keys(actual)
+    @missing_outputs = expected_outputs - actual_outputs
+    @extra_outputs = actual_outputs - expected_outputs
+
+    @missing_outputs.empty? && @extra_outputs.empty?
+  end
+
+  failure_message do |actual|
+    message = "expected #{actual} to promise outputs #{expected_outputs.inspect}"
+    message += "\n\tmissing outputs: #{@missing_outputs}" if @missing_outputs
+    message += "\n\textra outputs: #{@extra_outputs}" if @extra_outputs
+    message
+  end
+
+  def promised_keys(klass)
+    Array(klass.contract.promises.instance_eval { @terms }.json&.rules&.keys)
+  end
+end
+
+# Custom matcher that implements organize_interactors
+#
+# e.g. expect(described_class).to organize_interactors(SeparateIntoPackages, SendPackagesToSeko)
+RSpec::Matchers.define :organize_interactors do |*expected_interactors|
+  match do |actual|
+    actual_interactors = actual.organized
+    @missing_interactors = expected_interactors - actual_interactors
+    @extra_interactors = actual_interactors - expected_interactors
+
+    @missing_interactors.empty? && @extra_interactors.empty?
+  end
+
+  failure_message do |actual|
+    message = "expected #{actual} to organize interactors #{expected_interactors.inspect}"
+    message += "\n\tmissing interactors: #{@missing_interactors}" if @missing_interactors
+    message += "\n\textra interactors: #{@extra_interactors}" if @extra_interactors
+    message
+  end
+end

data/lib/interactify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Interactify
+  VERSION = '0.1.0-alpha.1'
+end