interaktor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 750eeac422a483d0c47ed00a3e457e97c43a134e611962f3a2316335d5c1a942
-  data.tar.gz: 6fb7f28d30d78c6dcca2ea25383bdb85576e83600d7de3cad58a13ffa5e14b94
+  metadata.gz: d187b41c956972596b434b05aa5e4b3f8558457953327e305c5d76165f7c195b
+  data.tar.gz: e123fbeb3e8c1db843cb41b54023ca71d077a6947f0a3a50e0ec5bd78dfd4ddb
 SHA512:
-  metadata.gz: 239222c9b5d7633b6c011d9e14ff1ec65f9612a3e1f13709ce8326c35bef28455b84f749a063927bb97e5387b8fd561019b3ead8ce681c7efc23c523736c777c
-  data.tar.gz: aaf8d1f62d5e86fbfa079ad2c3222d920eb3119999c7a4dc3809cb32799abe7bc8102db7bb431d3cf07f27cc06f9ef38abce9e22955396464440ccb61b9d6634
+  metadata.gz: 5549218310ebd0e3d0505eac4d43302f83c9508a0bee463f3a8c0f2042de5bfd25954aec67beae050a140606b14e75ce1e7ff8f0866726e5a24a09dd8071b4e6
+  data.tar.gz: a7eabf0b930c9efd51ec3407e119234d6a1d29aa3d88494bacde287cc0e3d67ae9882707d8636ddba7289c6889f536bcdbad22eebc47a8344b659828a0718f4b

data/.github/workflows/publish.yml

@@ -1,6 +1,8 @@
 name: Publish
 
 on:
+  # Manually publish
+  workflow_dispatch:
   push:
     tags:
       - v*
@@ -11,11 +13,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5.x
+          ruby-version: 3.2
 
       - name: Publish to RubyGems
         run: |

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+3.1.3

data/interaktor.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "interaktor"
-  spec.version = "0.3.0"
+  spec.version = "0.4.0"
 
   spec.author = "Taylor Thurlow"
   spec.email = "thurlow@hey.com"

data/lib/interaktor/hooks.rb

@@ -126,6 +126,11 @@ module Interaktor::Hooks
       hooks.each { |hook| after_hooks.unshift(hook) }
     end
 
+    def ensure_hook(*hooks, &block)
+      hooks << block if block
+      hooks.each { |hook| ensure_hooks.push(hook) }
+    end
+
     # Internal: An Array of declared hooks to run around Interaktor
     # invocation. The hooks appear in the order in which they will be run.
     #
@@ -182,6 +187,10 @@ module Interaktor::Hooks
     def after_hooks
       @after_hooks ||= []
     end
+
+    def ensure_hooks
+      @ensure_hooks ||= []
+    end
   end
 
   private
@@ -212,6 +221,8 @@ module Interaktor::Hooks
       yield
       run_after_hooks
     end
+  ensure
+    run_ensure_hooks
   end
 
   # Internal: Run around hooks.
@@ -237,6 +248,11 @@ module Interaktor::Hooks
     run_hooks(self.class.after_hooks)
   end
 
+
+  def run_ensure_hooks
+    run_hooks(self.class.ensure_hooks)
+  end
+
   # Internal: Run a colection of hooks. The "run_hooks" method is the common
   # interface by which collections of either before or after hooks are run.
   #

data/spec/interaktor/hooks_spec.rb

@@ -308,7 +308,95 @@ module Interaktor
         end
       end
 
-      context "with around, before and after hooks" do
+      context "with an ensure_hook method" do
+        let(:hooked) {
+          build_hooked do
+            ensure_hook :add_ensure
+
+            private
+
+            def add_ensure
+              steps << :ensure
+            end
+          end
+        }
+
+        it "runs the after hook method" do
+          expect(hooked.process).to eq([
+            :process,
+            :ensure,
+          ])
+        end
+      end
+
+      context "with an ensure_hook block" do
+        let(:hooked) {
+          build_hooked do
+            ensure_hook do
+              steps << :ensure
+            end
+          end
+        }
+
+        it "runs the after hook block" do
+          expect(hooked.process).to eq([
+            :process,
+            :ensure,
+          ])
+        end
+      end
+
+      context "with an ensure_hook method and block in one call" do
+        let(:hooked) {
+          build_hooked do
+            ensure_hook :add_ensure1 do
+              steps << :ensure2
+            end
+
+            private
+
+            def add_ensure1
+              steps << :ensure1
+            end
+          end
+        }
+
+        it "runs the ensure_hook method and block in order" do
+          expect(hooked.process).to eq([
+            :process,
+            :ensure1,
+            :ensure2,
+          ])
+        end
+      end
+
+      context "with an ensure_hook method and block in multiple calls" do
+        let(:hooked) {
+          build_hooked do
+            ensure_hook do
+              steps << :ensure1
+            end
+
+            ensure_hook :add_ensure2
+
+            private
+
+            def add_ensure2
+              steps << :ensure2
+            end
+          end
+        }
+
+        it "runs the ensure_hook block and method in order" do
+          expect(hooked.process).to eq([
+            :process,
+            :ensure1,
+            :ensure2,
+          ])
+        end
+      end
+
+      context "with around, before, after and ensure_hook hooks" do
         let(:hooked) {
           build_hooked do
             around do |hooked|
@@ -338,6 +426,14 @@ module Interaktor
             after do
               steps << :after2
             end
+
+            ensure_hook do
+              steps << :ensure1
+            end
+
+            ensure_hook do
+              steps << :ensure2
+            end
           end
         }
 
@@ -352,6 +448,8 @@ module Interaktor
             :after1,
             :around_after2,
             :around_after1,
+            :ensure1,
+            :ensure2,
           ])
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interaktor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Taylor Thurlow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -76,13 +76,9 @@ files:
 - lib/interaktor/error/attribute_error.rb
 - lib/interaktor/error/attribute_schema_validation_error.rb
 - lib/interaktor/error/base.rb
-- lib/interaktor/error/disallowed_attribute_assignment_error.rb
 - lib/interaktor/error/missing_explicit_success_error.rb
-- lib/interaktor/error/option_error.rb
 - lib/interaktor/error/organizer_missing_passed_attribute_error.rb
 - lib/interaktor/error/organizer_success_attribute_missing_error.rb
-- lib/interaktor/error/unknown_attribute_error.rb
-- lib/interaktor/error/unknown_option_error.rb
 - lib/interaktor/failure.rb
 - lib/interaktor/hooks.rb
 - lib/interaktor/organizer.rb
@@ -113,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.3
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Simple service object implementation

data/lib/interaktor/error/disallowed_attribute_assignment_error.rb

@@ -1,9 +0,0 @@
-class Interaktor::Error::DisallowedAttributeAssignmentError < Interaktor::Error::AttributeError
-  def message
-    <<~MESSAGE.strip.tr("\n", "")
-      Attempted a disallowed assignment to the '#{attributes.first}'
-      attribute which was not included when the #{interaktor} interaktor was
-      originally called.
-    MESSAGE
-  end
-end

data/lib/interaktor/error/option_error.rb

@@ -1,18 +0,0 @@
-class Interaktor::Error::OptionError < Interaktor::Error::Base
-  # @return [Hash{Symbol=>Object}]
-  attr_reader :options
-
-  # @param interaktor [Class]
-  # @param options [Hash{Symbol=>Object}]
-  def initialize(interaktor, options)
-    super(interaktor)
-
-    @options = options
-  end
-
-  # @return [String]
-  # @abstract
-  def message
-    raise NoMethodError
-  end
-end

data/lib/interaktor/error/unknown_attribute_error.rb

@@ -1,5 +0,0 @@
-class Interaktor::Error::UnknownAttributeError < Interaktor::Error::AttributeError
-  def message
-    "Unknown attribute(s) in call to #{interaktor}: #{attributes.join(", ")}"
-  end
-end

data/lib/interaktor/error/unknown_option_error.rb

@@ -1,5 +0,0 @@
-class Interaktor::Error::UnknownOptionError < Interaktor::Error::OptionError
-  def message
-    "Unknown option(s) in #{interaktor} interaktor: #{options.keys.join(", ")}"
-  end
-end