Extract modules (#32)

* add specs
* extract modules to make code structure more apparent
* fix coverage recording

Author: markburns

.github/workflows/main.yml

@@ -35,9 +35,18 @@ jobs:
     - name: Install Appraisal Gems
       run: bundle exec appraisal install
     - name: Run the specs for Appraisal
+      env:
+        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:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
         files: ./coverage/${{ matrix.ruby }}-${{ matrix.appraisal }}/coverage.json
         token: ${{ secrets.CODECOV_TOKEN }}
+
+    - name: List coverage directory
+      run: ls -R ./coverage
+

Gemfile

@@ -16,4 +16,5 @@ group :test do
   gem "debug"
   gem "rspec", "~> 3.0"
   gem "simplecov", require: false
+  gem "simplecov-json", require: false
 end

Gemfile.lock

@@ -76,6 +76,7 @@ GEM
     irb (1.10.1)
       rdoc
       reline (>= 0.3.8)
+    json (2.7.1)
     minitest (5.20.0)
     mutex_m (0.2.0)
     psych (5.1.1.1)
@@ -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.3)
     stringio (3.1.0)
     thor (1.2.2)
@@ -122,6 +126,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov
+  simplecov-json
 
 BUNDLED WITH
    2.4.22

lib/interactify.rb

@@ -11,100 +11,16 @@
 require "interactify/wiring"
 require "interactify/configuration"
 require "interactify/interactify_callable"
-
-module Interactify
-  class << self
-    delegate :on_definition_error, :trigger_definition_error, to: :configuration
-
-    def railties_missing?
-      @railties_missing
-    end
-
-    def railties_missing!
-      @railties_missing = true
-    end
-
-    def railties
-      railties?
-    end
-
-    def railties?
-      !railties_missing?
-    end
-
-    def sidekiq_missing?
-      @sidekiq_missing
-    end
-
-    def sidekiq_missing!
-      @sidekiq_missing = true
-    end
-
-    def sidekiq
-      sidekiq?
-    end
-
-    def sidekiq?
-      !sidekiq_missing?
-    end
-  end
-end
-
-Interactify.instance_eval do
-  @sidekiq_missing = nil
-  @railties_missing = nil
-end
-
-begin
-  require "sidekiq"
-rescue LoadError
-  Interactify.sidekiq_missing!
-end
-
-begin
-  require "rails/railtie"
-rescue LoadError
-  Interactify.railties_missing!
-end
+require "interactify/dependency_inference"
+require "interactify/hooks"
+require "interactify/configure"
 
 module Interactify
   extend ActiveSupport::Concern
+  extend Hooks
+  extend Configure
 
   class << self
-    def validate_app(ignore: [])
-      Interactify::Wiring.new(root: Interactify.configuration.root, ignore:).validate_app
-    end
-
-    def reset
-      @on_contract_breach = nil
-      @before_raise_hook = nil
-      @configuration = nil
-    end
-
-    def trigger_contract_breach_hook(...)
-      @on_contract_breach&.call(...)
-    end
-
-    def on_contract_breach(&block)
-      @on_contract_breach = block
-    end
-
-    def trigger_before_raise_hook(...)
-      @before_raise_hook&.call(...)
-    end
-
-    def before_raise(&block)
-      @before_raise_hook = block
-    end
-
-    def configure
-      yield configuration
-    end
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
     delegate :root, to: :configuration
   end
 

lib/interactify/configure.rb

@@ -0,0 +1,15 @@
+module Interactify
+  module Configure
+    def validate_app(ignore: [])
+      Interactify::Wiring.new(root: Interactify.configuration.root, ignore:).validate_app
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

lib/interactify/contracts/breaches.rb

@@ -0,0 +1,26 @@
+module Interactify
+  module Breaches
+    def self.handle_with_failure(context, breaches)
+      breaches = preamble(context, breaches)
+      context.fail! contract_failures: breaches
+    end
+
+    def self.handle_with_exception(context, failure_klass, breaches)
+      breaches = preamble(context, breaches)
+
+      # e.g. raises
+      # SomeNamespace::SomeClass::ContractFailure, {whatever: 'is missing'}
+      # but also sending the context into Sentry
+      exception = failure_klass.new(breaches.to_json)
+      Interactify.trigger_before_raise_hook(exception)
+      raise exception
+    end
+
+    def self.preamble(context, breaches)
+      breaches = breaches.map { |b| { b.property => b.messages } }.inject(&:merge)
+
+      Interactify.trigger_contract_breach_hook(context, breaches)
+      breaches
+    end
+  end
+end

lib/interactify/contracts/helpers.rb

@@ -6,6 +6,7 @@
 require "interactify/contracts/setup"
 require "interactify/contracts/promising"
 require "interactify/contracts/organizing"
+require "interactify/contracts/breaches"
 require "interactify/dsl/organizer"
 
 module Interactify
@@ -60,27 +61,18 @@ def _interactify_extract_keys(clauses)
       # rubocop: enable Metrics/BlockLength
 
       included do
-        c = Class.new(Contracts::Failure)
+        failure_klass = Class.new(Contracts::Failure)
         # example self is Whatever::SomeInteractor
         # failure class:  Whatever::SomeInteractor::InteractorContractFailure
-        const_set "InteractorContractFailure", c
+        const_set "InteractorContractFailure", failure_klass
         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
+            Breaches.handle_with_failure(context, 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
+            Breaches.handle_with_exception(context, failure_klass, breaches)
           end
         end
       end

lib/interactify/dependency_inference.rb

@@ -0,0 +1,56 @@
+module Interactify
+  class << self
+    delegate :on_definition_error, :trigger_definition_error, to: :configuration
+
+    def railties_missing?
+      @railties_missing
+    end
+
+    def railties_missing!
+      @railties_missing = true
+    end
+
+    def railties
+      railties?
+    end
+
+    def railties?
+      !railties_missing?
+    end
+
+    def sidekiq_missing?
+      @sidekiq_missing
+    end
+
+    def sidekiq_missing!
+      @sidekiq_missing = true
+    end
+
+    def sidekiq
+      sidekiq?
+    end
+
+    def sidekiq?
+      !sidekiq_missing?
+    end
+  end
+end
+
+Interactify.instance_eval do
+  @sidekiq_missing = nil
+  @railties_missing = nil
+end
+
+begin
+  require "sidekiq"
+rescue LoadError
+  Interactify.sidekiq_missing!
+end
+
+begin
+  require "rails/railtie"
+rescue LoadError
+  Interactify.railties_missing!
+end
+
+

lib/interactify/hooks.rb

@@ -0,0 +1,25 @@
+module Interactify
+  module Hooks
+    def reset
+      @on_contract_breach = nil
+      @before_raise_hook = nil
+      @configuration = nil
+    end
+
+    def trigger_contract_breach_hook(...)
+      @on_contract_breach&.call(...)
+    end
+
+    def on_contract_breach(&block)
+      @on_contract_breach = block
+    end
+
+    def trigger_before_raise_hook(...)
+      @before_raise_hook&.call(...)
+    end
+
+    def before_raise(&block)
+      @before_raise_hook = block
+    end
+  end
+end

spec/fixtures/asdf

@@ -31,7 +31,10 @@
 # Note: The conditional structures (`if`, `each`) here are not executed at runtime in the usual
 # sense. They are evaluated when defining the organizer, leading to the creation of discrete
 # classes that handle the respective logic.
-#
+
+require_relative './organizing/organized1'
+require_relative './organizing/organized2'
+
 class AllTheThings
   include Interactify
 
@@ -46,6 +49,21 @@ class AllTheThings
       else: [If::C, If::D]
     ),
 
+    # test nested promises
+    chain(
+      :nested_promises, 
+      Organizing::Organized1.promising(
+        :organized1_called
+      ), 
+      Organizing::Organized2.organizing(
+        Organizing::DeeplyNestedInteractor,
+        Organizing::DeeplyNestedPromisingInteractor.promising(
+          :deeply_nested_promising_interactor_called
+        ),
+        Organizing::Organized2::Organized2Called
+      )
+    ),
+
     # test each with lambda
     self.if(
       -> (c) { c.things },

spec/fixtures/integration_app/app/interactors/all_the_things.rb

@@ -6,13 +6,13 @@ class Organized2
     include Interactify
 
     organize(
-        DeeplyNestedInteractor,
-        DeeplyNestedPromisingInteractor.promising(
-          :deeply_nested_promising_interactor_called
-        ),
-        Organized2Called = Interactify do |context|
-          context.organized2_called = true
-        end
-      )
+      DeeplyNestedInteractor,
+      DeeplyNestedPromisingInteractor.promising(
+        :deeply_nested_promising_interactor_called
+      ),
+      Organized2Called = Interactify do |context|
+        context.organized2_called = true
+      end
+    )
   end
 end