subroutine 2.1.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63080af90148b6faaff42be6f9753d6f5ef36f3f8ebe650a1372905836f5e208
-  data.tar.gz: 9522cbaf937f5bdfa85fbb629ad8a1f3f014dce6ea42784ef68b39c4ecebad49
+  metadata.gz: a130a9c00d47631ee67621f3772ff5d050c348af94c9ec99a3ef4d90f0164079
+  data.tar.gz: d7c099c1c586bfaf516955b1f94aa86188fbbe0194e42021d0f0191341efb482
 SHA512:
-  metadata.gz: a76f25b779fd8a9ccc3958febe5b68906d7260f052b5200d6b080680f9f80f79debebe2bf35ee199f6996cccd827f0844e3710d30f0ee367dd248c6900f45c74
-  data.tar.gz: c3e50c34de7e4f656168cec625bccb1bede1fcd4dbbdd5bef7d9d0dabf9a2695a470dd749b2ec5785448b6cd45c0c3454b469d49a157e9d19fffc2ada78b75ce
+  metadata.gz: ffa8be2183e84ad07c523251c499673a169f7b9968d79164f7662082ffc9497027f4344cb12fda6b602aaf2b6884a8be17690a58448f50138f4fb547f9d6e0cf
+  data.tar.gz: c6130d737e8860e05d529e679e4a2f2be2de3f7114da5e97c5f8d3844463f3fc6f9e3a2f23da50891282989adcbd08759be9f243ff3aaf25adc978255cd18d43

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/association_fields/configuration.rb

@@ -60,7 +60,7 @@ module Subroutine
       end
 
       def build_foreign_key_field
-        build_child_field(foreign_key_method, type: :foreign_key, foreign_key_type: config[:foreign_key_type])
+        build_child_field(foreign_key_method, type: :foreign_key, foreign_key_type: determine_foreign_key_type)
       end
 
       def build_foreign_type_field
@@ -84,6 +84,23 @@ module Subroutine
         ComponentConfiguration.new(name, child_opts)
       end
 
+      def determine_foreign_key_type
+        return config[:foreign_key_type] if config[:foreign_key_type]
+
+        # TODO: Make this logic work for polymorphic associations.
+        return if polymorphic?
+
+        klass = inferred_foreign_type&.constantize
+        if klass && klass.respond_to?(:type_for_attribute)
+          case klass.type_for_attribute(find_by)&.type&.to_sym
+          when :string
+            :string
+          else
+            :integer
+          end
+        end
+      end
+
     end
   end
 end

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 = 2
+  MINOR = 3
+  PATCH = 0
   PRE   = nil
 
   VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join(".")

data/test/subroutine/association_test.rb

@@ -13,6 +13,10 @@ module Subroutine
       @fred ||= ::User.new(id: 2, email_address: "fred@example.com")
     end
 
+    def murphy
+      @murphy ||= ::StringIdUser.new(id: "ABACABADABACABA", email_address: "murphy@example.com")
+    end
+
     def account
       @account ||= ::Account.new(id: 1)
     end
@@ -43,6 +47,16 @@ module Subroutine
       assert_equal doug, op.user
     end
 
+    def test_it_looks_up_an_association_with_string_ids
+      all_mock = mock
+
+      ::StringIdUser.expects(:all).returns(all_mock)
+      all_mock.expects(:find_by!).with(id: "ABACABADABACABA").returns(murphy)
+
+      op = ::SimpleAssociationWithStringIdOp.new(string_id_user_id: murphy.id)
+      assert_equal murphy, op.string_id_user
+    end
+
     def test_it_sanitizes_types
       all_mock = mock
 
@@ -122,6 +136,16 @@ module Subroutine
       assert_equal "email_address", op.field_configurations[:user][:find_by]
     end
 
+    def test_it_allows_a_find_by_to_be_set_with_implicit_string
+      all_mock = mock
+      ::User.expects(:all).returns(all_mock)
+      all_mock.expects(:find_by!).with(email_address: doug.email_address).returns(doug)
+
+      op = ::AssociationWithImplicitStringFindByOp.new(user_id: doug.email_address)
+      assert_equal doug, op.user
+      assert_equal "email_address", op.field_configurations[:user][:find_by]
+    end
+
     def test_values_are_correct_for_find_by_usage
       op = ::AssociationWithFindByKeyOp.new(user: doug)
       assert_equal doug, op.user

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

@@ -31,6 +31,23 @@ class User
     find_by(params) || raise
   end
 
+  def self.type_for_attribute(attribute)
+    case attribute
+    when :id
+      Struct.new(:type).new(:integer)
+    else
+      Struct.new(:type).new(:string)
+    end
+  end
+
+end
+
+class StringIdUser < ::User
+
+  def self.type_for_attribute(attribute)
+    Struct.new(:type).new(:string)
+  end
+
 end
 
 class AdminUser < ::User
@@ -325,6 +342,12 @@ class SimpleAssociationOp < ::OpWithAssociation
 
 end
 
+class SimpleAssociationWithStringIdOp < ::OpWithAssociation
+
+  association :string_id_user
+
+end
+
 class UnscopedSimpleAssociationOp < ::OpWithAssociation
 
   association :user, unscoped: true, allow_overwrite: true
@@ -355,6 +378,12 @@ class AssociationWithFindByKeyOp < ::OpWithAssociation
 
 end
 
+class AssociationWithImplicitStringFindByOp < ::OpWithAssociation
+
+  association :user, find_by: "email_address"
+
+end
+
 class AssociationWithFindByAndForeignKeyOp < ::OpWithAssociation
 
   association :user, foreign_key: "email_address", find_by: "email_address"
@@ -417,41 +446,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.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-07 00:00:00.000000000 Z
+date: 2023-03-07 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
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.23
 signing_key: 
 specification_version: 4
 summary: Feature-driven operation objects.
@@ -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