subroutine 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28f248f1e76c10fb53fcbf1fc376a7f2c6800cd
-  data.tar.gz: b81a6050e1c2245e545b39dd99d396f80925a92e
+  metadata.gz: 3ce8addef08d4ac3a2acc33ebd1336e1acbeadf4
+  data.tar.gz: 461466c26f1da36c13d468c2cdf7d7251b8ef7f6
 SHA512:
-  metadata.gz: 27f2215a662339b46a5bd7a73a1822915d95a9144fc28f09dac0bd632020629d2ca6ec6aab6497a5c7b3452946b816dd8cdb5fbe99e96a359ac11e9f205915c6
-  data.tar.gz: 260a8d6f175d715175376c8072d25318b0db4c467cff433c95458ede1788bd985c9ef0619e0ad3db4d707ef3978820a259e0af5c22b58edc51a60014533c18d2
+  metadata.gz: 3562274bd7a30c17d62530fd4ae8e7031326e44a2d2c6ac94fd329200bac3e9b20f3c13e4fa7aee9b50597b1fd3377fbf04a2f5fbc23978ccbb599ab3b2f30b1
+  data.tar.gz: 0ac228d98a9cd17ff9b9dc33649eaaf434579e96c641b2e0560d45c602a98bfad6d04debe89cdf99b2c77aed9217d3657036dbfeb96921b09309888acedefbab

data/lib/subroutine/op.rb

@@ -4,6 +4,8 @@ require 'active_model'
 require "subroutine/failure"
 require "subroutine/type_caster"
 require "subroutine/filtered_errors"
+require "subroutine/output_not_set_error"
+require "subroutine/unknown_output_error"
 
 module Subroutine
 
@@ -12,6 +14,10 @@ module Subroutine
     include ::ActiveModel::Model
     include ::ActiveModel::Validations::Callbacks
 
+    DEFAULT_OUTPUT_OPTIONS = {
+      required: true
+    }.freeze
+
     class << self
 
       ::Subroutine::TypeCaster::TYPES.values.flatten.each do |caster|
@@ -41,6 +47,18 @@ module Subroutine
 
       alias_method :fields, :field
 
+      def output(name, options = {})
+        self._outputs = self._outputs.merge({
+          name.to_sym => DEFAULT_OUTPUT_OPTIONS.merge(options)
+        })
+
+        class_eval <<-EV, __FILE__, __LINE__ + 1
+          def #{name}
+            @outputs[:#{name}]
+          end
+        EV
+      end
+
       def ignore_error(*field_names)
         field_names.each do |f|
           _ignore_errors(f)
@@ -124,6 +142,9 @@ module Subroutine
     end
 
 
+    class_attribute :_outputs
+    self._outputs = {}
+
     class_attribute :_fields
     self._fields = {}
 
@@ -141,12 +162,20 @@ module Subroutine
       @original_params  = inputs.with_indifferent_access
       @params = sanitize_params(@original_params)
       @defaults = sanitize_defaults
+      @outputs = {}
     end
 
     def errors
       @filtered_errors ||= Subroutine::FilteredErrors.new(super)
     end
 
+    def output(name, value)
+      unless _outputs.key?(name.to_sym)
+        raise ::Subroutine::UnknownOutputError.new(name)
+      end
+      @outputs[name.to_sym] = value
+    end
+
     def submit!
       unless submit
         raise ::Subroutine::Failure.new(self)
@@ -156,10 +185,20 @@ module Subroutine
 
     # the action which should be invoked upon form submission (from the controller)
     def submit
-      observe_submission do
+      result = observe_submission do
         validate_and_perform
       end
 
+      if result
+        _outputs.each_pair do |name, config|
+          if config[:required] && !@outputs.key?(name)
+            raise ::Subroutine::OutputNotSetError.new(name)
+          end
+        end
+      end
+
+      result
+
     rescue Exception => e
 
       if e.respond_to?(:record)

data/lib/subroutine/output_not_set_error.rb

@@ -0,0 +1,8 @@
+module Subroutine
+  class OutputNotSetError < StandardError
+    def initialize(name)
+      super("Expected output '#{name}' to be set upon completion of perform but was not.")
+    end
+  end
+
+end

data/lib/subroutine/unknown_output_error.rb

@@ -0,0 +1,8 @@
+module Subroutine
+  class UnknownOutputError < StandardError
+    def initialize(name)
+      super("Unknown output '#{name}'")
+    end
+  end
+
+end

data/lib/subroutine/version.rb

@@ -1,8 +1,8 @@
 module Subroutine
 
   MAJOR = 0
-  MINOR = 3
-  PATCH = 4
+  MINOR = 4
+  PATCH = 0
   PRE   = nil
 
   VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

data/test/subroutine/base_test.rb

@@ -195,5 +195,36 @@ module Subroutine
       assert_equal(BigDecimal("25.3"), op.params_with_defaults["decimal_input"])
     end
 
+    def test_it_allow_retrival_of_outputs
+      op = ::SignupOp.submit!(:email => 'foo@bar.com', :password => 'password123')
+      u = op.created_user
+
+      assert_equal "foo@bar.com", u.email_address
+    end
+
+    def test_it_raises_an_error_if_an_output_is_not_defined_but_is_set
+      op = ::MissingOutputOp.new
+      assert_raises ::Subroutine::UnknownOutputError do
+        op.submit
+      end
+    end
+
+    def test_it_raises_an_error_if_not_all_outputs_were_set
+      op = ::MissingOutputSetOp.new
+      assert_raises ::Subroutine::OutputNotSetError do
+        op.submit
+      end
+    end
+
+    def test_it_does_not_raise_an_error_if_output_is_not_set_and_is_not_required
+      op = ::OutputNotRequiredOp.new
+      op.submit
+    end
+
+    def test_it_does_not_raise_an_error_if_the_perform_is_not_a_success
+      op = ::NoOutputNoSuccessOp.new
+      refute op.submit
+    end
+
   end
 end

data/test/subroutine/type_caster_test.rb

@@ -164,6 +164,9 @@ module Subroutine
       assert_equal 2020, op.date_input.year
       assert_equal 5, op.date_input.month
       assert_equal 3, op.date_input.day
+
+      op.date_input = false
+      assert_nil op.date_input
     end
 
 

data/test/support/ops.rb

@@ -28,15 +28,15 @@ class SignupOp < ::Subroutine::Op
   validates :email, :presence => true
   validates :password, :presence => true
 
-  attr_reader :perform_called
-  attr_reader :perform_finished
+  output :perform_called
+  output :perform_finished
 
-  attr_reader :created_user
+  output :created_user
 
   protected
 
   def perform
-    @perform_called = true
+    output :perform_called, true
     u = build_user
 
     unless u.valid?
@@ -44,9 +44,8 @@ class SignupOp < ::Subroutine::Op
       return false
     end
 
-    @perform_finished = true
-    @created_user = u
-
+    output :perform_finished, true
+    output :created_user, u
     true
   end
 
@@ -201,3 +200,30 @@ end
 class InheritedPolymorphicAssociationOp < ::Subroutine::Op
   inputs_from PolymorphicAssociationOp
 end
+
+class MissingOutputOp < ::Subroutine::Op
+  def perform
+    output :foo, "bar"
+  end
+end
+
+class MissingOutputSetOp < ::Subroutine::Op
+  output :foo
+  def perform
+    true
+  end
+end
+
+class OutputNotRequiredOp < ::Subroutine::Op
+  output :foo, required: false
+  def perform
+    true
+  end
+end
+
+class NoOutputNoSuccessOp < ::Subroutine::Op
+  output :foo
+  def perform
+    false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -119,7 +119,9 @@ files:
 - lib/subroutine/failure.rb
 - lib/subroutine/filtered_errors.rb
 - lib/subroutine/op.rb
+- lib/subroutine/output_not_set_error.rb
 - lib/subroutine/type_caster.rb
+- lib/subroutine/unknown_output_error.rb
 - lib/subroutine/version.rb
 - subroutine.gemspec
 - test/subroutine/association_test.rb