subroutine 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 359d2ea93dea5768e77277086229a0dd6e38c90c6f05866e443980a45afd98f9
-  data.tar.gz: a1282dec003600a234fd8e8a076570f91813681d4eb3afdd84c4193ad8b115bf
+  metadata.gz: 8695d158b7e6ab0464d8e7b4a6c9a641b5dde81f422ff139c29eab8bc8512e75
+  data.tar.gz: 61a393835d542a613f91335581c114fbd44764809ed78c2f4bd14f463b3c604d
 SHA512:
-  metadata.gz: e01d4ab80fce0047950af6511d5b626e740f1a7e1157e283f09a911dbeaab21af01ae5b173c750e7078f57c28f058000e428df4eca784e522496cc8053fb2617
-  data.tar.gz: 423ddf621546c4d74c1934f476aab6e0da728379490ac7b6d8f0b420b8dde3d101e8a1f0cdb8369908d87dd34fd21ef119627e10c78acd7d88aac8064b65216b
+  metadata.gz: '011484de567ba987afdc22abcd3aa198ae1cf62ecca93c42412cacab2ef14832d5eb343d64150cbed7f8fc06526709a05918a4a5e0cd8f655e4c6d903cc9c40f'
+  data.tar.gz: 40bda69b27c0ec4fd2ca152136918809da4a5b1793b9732bc8e0910714213a4696230a21fc3872e76294d75b6550ba106c52ec0a262d334b2b2da4c8b06bc132

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [2.7.5, 2.7.6]
+        experimental: [false]
+        include:
+          - ruby-version: 3.0
+            experimental: true
+          - ruby-version: 3.1
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs `bundle install` and caches installed gems automatically
+      - run: bundle exec rake test

data/CHANGELOG.MD

@@ -1,3 +1,7 @@
+## Subroutine 2.2
+
+Add `type` validation for Output.
+
 ## Subroutine 2.0
 
 The updates between 1.0 and 2.0 are relatively minor and are focused more on cleaning up the codebase and extending the use of the 0.9->1.0 refactor. There are, however, breaking changes to how associations are loaded. The association is no longer loaded via `find()` but rather `find_by!(id:)`. Given this, a major version was released.

data/README.md

@@ -21,7 +21,7 @@ class SignupOp < ::Subroutine::Op
   validates :company_name, presence: true
 
   outputs :user
-  outputs :business
+  outputs :business, type: Business # validate that output type is an instance of Business
 
   protected
 

data/lib/subroutine/auth.rb

@@ -56,7 +56,12 @@ module Subroutine
         unless_conditionals = Array(opts[:unless])
 
         meths.each do |meth|
-          normalized_meth = meth.to_s[0...-1] if meth.to_s.end_with?("?")
+          normalized_meth = if normalized_meth.to_s.end_with?("?")
+                              meth.to_s[0...-1]
+                            else
+                              meth
+                            end
+
           auth_method_name = :"authorize_#{policy_name}_#{normalized_meth}"
 
           define_method auth_method_name do

data/lib/subroutine/outputs/invalid_output_type_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Subroutine
+  module Outputs
+    class InvalidOutputTypeError < StandardError
+
+      def initialize(name:, expected_type:, actual_type:)
+        super("Invalid output type for '#{name}' expected #{expected_type} but got #{actual_type}")
+      end
+
+    end
+  end
+end

data/lib/subroutine/outputs.rb

@@ -4,6 +4,7 @@ require "active_support/concern"
 require "subroutine/outputs/configuration"
 require "subroutine/outputs/output_not_set_error"
 require "subroutine/outputs/unknown_output_error"
+require "subroutine/outputs/invalid_output_type_error"
 
 module Subroutine
   module Outputs
@@ -39,16 +40,6 @@ module Subroutine
       @outputs = {} # don't do with_indifferent_access because it will turn provided objects into with_indifferent_access objects, which may not be the desired behavior
     end
 
-    def output_provided?(name)
-      name = name.to_sym
-
-      unless output_configurations.key?(name)
-        raise ::Subroutine::Outputs::UnknownOutputError, name
-      end
-
-      outputs.key?(name)
-    end
-
     def output(name, value)
       name = name.to_sym
       unless output_configurations.key?(name)
@@ -70,8 +61,33 @@ module Subroutine
         if config.required? && !output_provided?(name)
           raise ::Subroutine::Outputs::OutputNotSetError, name
         end
+        unless valid_output_type?(name)
+          name = name.to_sym
+          raise ::Subroutine::Outputs::InvalidOutputTypeError.new(
+            name: name,
+            actual_type: outputs[name].class,
+            expected_type: output_configurations[name][:type]
+          )
+        end
       end
     end
 
+    def output_provided?(name)
+      name = name.to_sym
+
+      outputs.key?(name)
+    end
+
+    def valid_output_type?(name)
+      name = name.to_sym
+
+      return true unless output_configurations.key?(name)
+
+      output_configuration = output_configurations[name]
+      return true unless output_configuration[:type]
+      return true if !output_configuration.required? && outputs[name].nil?
+
+      outputs[name].is_a?(output_configuration[:type])
+    end
   end
 end

data/lib/subroutine/version.rb

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

data/test/subroutine/base_test.rb

@@ -264,30 +264,6 @@ module Subroutine
       assert_equal Hash, value.class
     end
 
-    def test_it_raises_an_error_if_an_output_is_not_defined_but_is_set
-      op = ::MissingOutputOp.new
-      assert_raises ::Subroutine::Outputs::UnknownOutputError do
-        op.submit
-      end
-    end
-
-    def test_it_raises_an_error_if_not_all_outputs_were_set
-      op = ::MissingOutputSetOp.new
-      assert_raises ::Subroutine::Outputs::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
-
     def test_it_does_not_omit_the_backtrace_from_the_original_error
       op = ::ErrorTraceOp.new
       begin

data/test/subroutine/outputs_test.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Subroutine
+  class OutputsTest < TestCase
+    class MissingOutputOp < ::Subroutine::Op
+      def perform
+        output :foo, 'bar'
+      end
+    end
+
+    class MissingOutputSetOp < ::Subroutine::Op
+      outputs :foo
+      def perform
+        true
+      end
+    end
+
+    class OutputNotRequiredOp < ::Subroutine::Op
+      outputs :foo, required: false
+      def perform
+        true
+      end
+    end
+
+    class NoOutputNoSuccessOp < ::Subroutine::Op
+      outputs :foo
+
+      def perform
+        errors.add(:foo, 'bar')
+      end
+    end
+
+    class OutputWithTypeValidationNotRequired < ::Subroutine::Op
+      outputs :value, type: String, required: false
+
+      def perform; end
+    end
+
+    class OutputWithTypeValidationRequired < ::Subroutine::Op
+      outputs :value, type: String, required: true
+
+      def perform; end
+    end
+
+    def test_it_raises_an_error_if_an_output_is_not_defined_but_is_set
+      op = MissingOutputOp.new
+      assert_raises ::Subroutine::Outputs::UnknownOutputError do
+        op.submit
+      end
+    end
+
+    def test_it_raises_an_error_if_not_all_outputs_were_set
+      op = MissingOutputSetOp.new
+      assert_raises ::Subroutine::Outputs::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
+
+    ###################
+    # type validation #
+    ###################
+
+    def test_it_does_not_raise_an_error_if_output_is_set_to_the_right_type
+      op = OutputWithTypeValidationNotRequired.new
+      op.send(:output, :value, 'foo')
+      assert op.submit
+    end
+
+    def test_it_raises_an_error_if_output_is_not_set_to_the_right_type
+      op = OutputWithTypeValidationNotRequired.new
+      op.send(:output, :value, 1)
+      assert_raises ::Subroutine::Outputs::InvalidOutputTypeError do
+        op.submit
+      end
+    end
+
+    def test_it_does_not_raise_an_error_if_output_is_set_to_nil_when_there_is_type_validation_and_not_required
+      op = OutputWithTypeValidationNotRequired.new
+      op.send(:output, :value, nil)
+      op.submit
+    end
+
+    def test_it_raises_an_error_if_output_is_set_to_nil_when_there_is_type_validation_and_is_required
+      op = OutputWithTypeValidationRequired.new
+      op.send(:output, :value, nil)
+      assert_raises ::Subroutine::Outputs::InvalidOutputTypeError do
+        op.submit
+      end
+    end
+  end
+end

data/test/support/ops.rb

@@ -228,13 +228,19 @@ class PolicyOp < OpWithAuth
   class FakePolicy
 
     def user_can_access?
+      true
+    end
+
+    def user_can_do_it
       false
     end
 
   end
 
   require_user!
+
   policy :user_can_access?
+  policy :user_can_do_it
 
   def policy
     @policy ||= FakePolicy.new
@@ -411,41 +417,6 @@ class FalsePerformOp < ::Subroutine::Op
 
 end
 
-class MissingOutputOp < ::Subroutine::Op
-
-  def perform
-    output :foo, "bar"
-  end
-
-end
-
-class MissingOutputSetOp < ::Subroutine::Op
-
-  outputs :foo
-  def perform
-    true
-  end
-
-end
-
-class OutputNotRequiredOp < ::Subroutine::Op
-
-  outputs :foo, required: false
-  def perform
-    true
-  end
-
-end
-
-class NoOutputNoSuccessOp < ::Subroutine::Op
-
-  outputs :foo
-  def perform
-    errors.add(:foo, "bar")
-  end
-
-end
-
 class ErrorTraceOp < ::Subroutine::Op
 
   class SomeObject

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Mike Nelson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -157,10 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.MD
 - Gemfile
 - LICENSE.txt
@@ -187,6 +187,7 @@ files:
 - lib/subroutine/op.rb
 - lib/subroutine/outputs.rb
 - lib/subroutine/outputs/configuration.rb
+- lib/subroutine/outputs/invalid_output_type_error.rb
 - lib/subroutine/outputs/output_not_set_error.rb
 - lib/subroutine/outputs/unknown_output_error.rb
 - lib/subroutine/type_caster.rb
@@ -196,6 +197,7 @@ files:
 - test/subroutine/auth_test.rb
 - test/subroutine/base_test.rb
 - test/subroutine/fields_test.rb
+- test/subroutine/outputs_test.rb
 - test/subroutine/type_caster_test.rb
 - test/support/ops.rb
 - test/test_helper.rb
@@ -203,7 +205,7 @@ homepage: https://github.com/mnelson/subroutine
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Feature-driven operation objects.
 test_files:
@@ -233,6 +235,7 @@ test_files:
 - test/subroutine/auth_test.rb
 - test/subroutine/base_test.rb
 - test/subroutine/fields_test.rb
+- test/subroutine/outputs_test.rb
 - test/subroutine/type_caster_test.rb
 - test/support/ops.rb
 - test/test_helper.rb

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-sudo: false
-
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-
-gemfile:
-  - gemfiles/am41.gemfile
-  - gemfiles/am42.gemfile
-  - gemfiles/am50.gemfile
-  - gemfiles/am51.gemfile
-  - gemfiles/am52.gemfile
-  - gemfiles/am60.gemfile
-
-matrix:
-  exclude:
-    - rvm: 2.4.6
-      gemfile: gemfiles/am60.gemfile