interaktor 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a783c3017cd4cb48ee61f7d68869a1b7b2e3a716657c3c1bc8ca230b8e7f483
-  data.tar.gz: d5966a7b86cbfe7af7892002e8eee10cc10872743717b7501fee850a30ebc9a5
+  metadata.gz: 99cf1e62638c0d275243c18799d225ec5f6e44eb6e75ac0cb12418775f8d2ebe
+  data.tar.gz: 8e53e5c94af31544e37222810b123bf7817db54a3667f94e01a10c64d9536ba3
 SHA512:
-  metadata.gz: 1f0df7c0eb75c1a3594c5f9e2c53fa7561fa8349c2cec2408f7d2a38be4e9c8ab80403fc63d6dee36f8f9e449c27fd9842912569bb80a30cf302ab398ccc5ddd
-  data.tar.gz: f6333614072980b7bee34734ba34f8ee0d1881dc6aa756eaaa42e2ba4058cfcc85580fe2d2c83188a060dd185b1b322c62be188ae137acb9b38adbebcc9b7762
+  metadata.gz: 7fcd8dfeabdbacd828471bac5d80e57582e98f02c9ecf31188c2300aa24e19e2dde04453aeb82b439b8f048a4c10bb00147f2b7e9927d028aa4adbcfa22ebcf0
+  data.tar.gz: 1ddb2a5b49de3269b02b1c1264991ae126385ed2c22fd7f9fb953361820d9f373620fee434be064310e3aaaabe394bf3cab2d2085a9c37ac43619b8f04f92313

data/interaktor.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "interaktor"
-  spec.version = "0.1.4"
+  spec.version = "0.1.5"
 
   spec.author = "Taylor Thurlow"
   spec.email = "taylorthurlow@me.com"

data/lib/interaktor.rb

@@ -33,6 +33,13 @@ module Interaktor
       @optional_attributes ||= []
     end
 
+    # A list of optional attributes and their default values.
+    #
+    # @return [Array<Symbol>]
+    def optional_defaults
+      @optional_defaults ||= {}
+    end
+
     # The list of attributes which are required to be passed in when calling
     # `#fail!` from within the interaktor.
     #
@@ -52,29 +59,39 @@ module Interaktor
     # A DSL method for documenting required interaktor attributes.
     #
     # @param attributes [Symbol, Array<Symbol>] the list of attribute names
+    # @param options [Hash]
     #
     # @return [void]
-    def required(*attributes)
+    def required(*attributes, **options)
       required_attributes.concat attributes
 
       attributes.each do |attribute|
+        # Define getter
         define_method(attribute) { @context.send(attribute) }
+
+        # Define setter
         define_method("#{attribute}=".to_sym) do |value|
           @context.send("#{attribute}=".to_sym, value)
         end
+
+        raise "Unknown option(s): #{options.keys.join(", ")}" if options.any?
       end
     end
 
     # A DSL method for documenting optional interaktor attributes.
     #
     # @param attributes [Symbol, Array<Symbol>] the list of attribute names
+    # @param options [Hash]
     #
     # @return [void]
-    def optional(*attributes)
+    def optional(*attributes, **options)
       optional_attributes.concat attributes
 
       attributes.each do |attribute|
+        # Define getter
         define_method(attribute) { @context.send(attribute) }
+
+        # Define setter
         define_method("#{attribute}=".to_sym) do |value|
           unless @context.to_h.key?(attribute)
             raise <<~ERROR
@@ -86,6 +103,12 @@ module Interaktor
 
           @context.send("#{attribute}=".to_sym, value)
         end
+
+        # Handle options
+        optional_defaults[attribute] = options[:default] if options[:default]
+        options.delete(:default)
+
+        raise "Unknown option(s): #{options.keys.join(", ")}" if options.any?
       end
     end
 
@@ -115,11 +138,10 @@ module Interaktor
     #
     # @return [Interaktor::Context] the context, following interaktor execution
     def call(context = {})
+      apply_default_optional_attributes(context)
       verify_attribute_presence(context)
 
-      catch(:early_return) do
-        new(context).tap(&:run).instance_variable_get(:@context)
-      end
+      new(context).tap(&:run).instance_variable_get(:@context)
     end
 
     # Invoke an Interaktor. This method behaves identically to `#call`, with
@@ -133,18 +155,18 @@ module Interaktor
     #
     # @return [Interaktor::Context] the context, following interaktor execution
     def call!(context = {})
+      apply_default_optional_attributes(context)
       verify_attribute_presence(context)
 
-      catch(:early_return) do
-        new(context).tap(&:run!).instance_variable_get(:@context)
-      end
+      new(context).tap(&:run!).instance_variable_get(:@context)
     end
 
     private
 
     # Check the provided context against the attributes defined with the DSL
     # methods, and determine if there are any attributes which are required and
-    # have not been provided.
+    # have not been provided, or if there are any attributes which have been
+    # provided but are not listed as either required or optional.
     #
     # @param context [Interaktor::Context] the context to check
     #
@@ -157,6 +179,26 @@ module Interaktor
         Required attribute(s) were not provided when initializing #{name} interaktor:
           #{missing_attrs.join("\n  ")}
       ERROR
+
+      allowed_attrs = required_attributes + optional_attributes
+      extra_attrs = context.to_h.keys.reject { |attr| allowed_attrs.include?(attr) }
+
+      raise <<~ERROR if extra_attrs.any?
+        One or more provided attributes were not recognized when initializing #{name} interaktor:
+          #{extra_attrs.join("\n  ")}
+      ERROR
+    end
+
+    # Given the list of optional default attribute values defined by the class,
+    # assign those default values to the context if they were omitted.
+    #
+    # @param context [Interaktor::Context]
+    #
+    # @return [void]
+    def apply_default_optional_attributes(context)
+      optional_defaults.each do |attribute, default|
+        context[attribute] ||= default
+      end
     end
   end
 
@@ -238,7 +280,10 @@ module Interaktor
   # @return [void]
   def run!
     with_hooks do
-      call
+      catch(:early_return) do
+        call
+      end
+
       @context.called!(self)
     end
   rescue StandardError

data/spec/integration_spec.rb

@@ -8,6 +8,8 @@ describe "Integration" do
     interaktor = Class.new.send(:include, Interaktor)
     interaktor.class_eval(&block) if block
     interaktor.class_eval do
+      optional :steps
+
       def unexpected_error!
         raise "foo"
       end
@@ -20,6 +22,8 @@ describe "Integration" do
     organizer.organize(options[:organize]) if options[:organize]
     organizer.class_eval(&block) if block
     organizer.class_eval do
+      optional :steps
+
       def unexpected_error!
         raise "foo"
       end

data/spec/support/lint.rb

@@ -1,5 +1,12 @@
 shared_examples "lint" do
-  let(:interaktor) { Class.new.include(described_class) }
+  let(:interaktor) do
+    klass = Class.new.include(described_class)
+    klass.class_eval do
+      optional :foo
+    end
+
+    klass
+  end
 
   describe ".call" do
     let(:context) { instance_double(Interaktor::Context) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interaktor
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Taylor Thurlow
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk