subroutine 2.0.0.beta → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ade77ec5abb9601e1dce7bc53e34baac35c978a41aef3268b57ee5b9def6e5
-  data.tar.gz: c450947886efc34b26b202b52202909f44735a2d5f26a3c1af51fdf93be509c6
+  metadata.gz: be1eef70ae231ae5b344cf1400ed9ea17a60df49fd1243eb744c13e4aca5904e
+  data.tar.gz: 21f60843110c2b5f6c70281dc1999ed84923848f805cbd08472cb7a863a00a59
 SHA512:
-  metadata.gz: c171a9bb82076ed4f5e407375d19e423a5e6bba0211192109d300e3b7372d537a0bac3d67ef5c480ef9af34ddd2a849a07fef79459f5597ea97e195cad239fe7
-  data.tar.gz: 52502e8dd504de2d59faa4665ab7c755c9ff6ba8b951e79acaa264c4d257f09a20da58977f1565e8d121023d6a2f5291cd4528eca143d697252b2f6a27d4197b
+  metadata.gz: 3cb5596227a06ddfdcca54205bb0c599919ffae5f29ef30ab25d437e7cf8cb03462c99015c957fdfce8d2a7a3ed910b013da7e84f6516a9f37a34a44fa44734b
+  data.tar.gz: 141e1f223f7da3dc7d080cbc891cd9533a905833ceb8a85e0941b06b6455cf83dea42aabe9f3eeaf977966ea227ead94446462c86ad28261b37436b389152c45

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.5

data/CHANGELOG.MD

@@ -1,3 +1,9 @@
+## 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.
+
+**Note:** 2.0.0 was released with a bug and subsequently yanked. 2.0.1 is the first available 2.x version.
+
 ## Subroutine 1.0
 
 A massive refactor took place between 0.9 and 1.0, including breaking changes. The goal was to reduce complexity, simplify backtraces, and increase the overall safety and reliability of the library.
@@ -81,7 +87,7 @@ class AccountUpdateOp < ::Op
 end
 ```
 
-ActionController::Parameters from Rails 5+ are now transformed to as hash in `Subroutine::Fields` by default. This means strong parameters are essentially unused when passing `Subroutine::Fields`.
+ActionController::Parameters from Rails 5+ are now transformed to a hash in `Subroutine::Fields` by default. This means strong parameters are essentially unused when passing `Subroutine::Fields`.
 
 Read more about field management and access in https://github.com/guideline-tech/subroutine/wiki/Param-Usage
 

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)
+        build_child_field(foreign_key_method, type: :foreign_key, foreign_key_type: config[:foreign_key_type])
       end
 
       def build_foreign_type_field
@@ -78,7 +78,10 @@ module Subroutine
       protected
 
       def build_child_field(name, opts = {})
-        ComponentConfiguration.new(name, inheritable_options.merge(opts).merge(association_name: as))
+        child_opts = inheritable_options
+        child_opts.merge!(opts)
+        child_opts[:association_name] = as
+        ComponentConfiguration.new(name, child_opts)
       end
 
     end

data/lib/subroutine/auth.rb

@@ -9,11 +9,13 @@ module Subroutine
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :authorization_declared, instance_writer: false
-      self.authorization_declared = false
+      class_attribute :authorization_checks
+      self.authorization_checks = []
 
       class_attribute :user_class_name, instance_writer: false
       self.user_class_name = "User"
+
+      validate :validate_authorization_checks, unless: :skip_auth_checks?
     end
 
     module ClassMethods
@@ -22,28 +24,24 @@ module Subroutine
         [user_class_name, "Integer", "NilClass"].compact
       end
 
-      def authorize(validation_name)
-        validate validation_name, unless: :skip_auth_checks?
+      def authorization_declared?
+        authorization_checks.any?
+      end
+
+      def authorize(check_name)
+        self.authorization_checks += [check_name.to_sym]
       end
 
       def no_user_requirements!
-        self.authorization_declared = true
+        authorize :authorize_user_not_required
       end
 
       def require_user!
-        self.authorization_declared = true
-
-        validate unless: :skip_auth_checks? do
-          unauthorized! unless current_user.present?
-        end
+        authorize :authorize_user_required
       end
 
       def require_no_user!
-        self.authorization_declared = true
-
-        validate unless: :skip_auth_checks? do
-          unauthorized! :empty_unauthorized if current_user.present?
-        end
+        authorize :authorize_no_user_required
       end
 
       # policy :can_update_user
@@ -57,33 +55,45 @@ module Subroutine
         if_conditionals = Array(opts[:if])
         unless_conditionals = Array(opts[:unless])
 
-        validate unless: :skip_auth_checks? do
-          run_it = true
-          # http://guides.rubyonrails.org/active_record_validations.html#combining-validation-conditions
+        meths.each do |meth|
+          normalized_meth = meth.to_s[0...-1] if meth.to_s.end_with?("?")
+          auth_method_name = :"authorize_#{policy_name}_#{normalized_meth}"
 
-          # The validation only runs when all the :if conditions
-          if if_conditionals.present?
-            run_it &&= if_conditionals.all? { |i| send(i) }
-          end
+          define_method auth_method_name do
+            run_it = true
+            # http://guides.rubyonrails.org/active_record_validations.html#combining-validation-conditions
 
-          # and none of the :unless conditions are evaluated to true.
-          if unless_conditionals.present?
-            run_it &&= unless_conditionals.none? { |u| send(u) }
-          end
+            # The validation only runs when all the :if conditions evaluate to true
+            if if_conditionals.present?
+              run_it &&= if_conditionals.all? { |i| send(i) }
+            end
+
+            # and none of the :unless conditions are evaluated to true.
+            if unless_conditionals.present?
+              run_it &&= unless_conditionals.none? { |u| send(u) }
+            end
+
+            return unless run_it
+
+            p = send(policy_name)
+            unauthorized! unless p
 
-          next unless run_it
+            result = if p.respond_to?("#{normalized_meth}?")
+                       p.send("#{normalized_meth}?")
+                     else
+                       p.send(normalized_meth)
+                     end
 
-          p = send(policy_name)
-          if !p || meths.any? { |m| !(p.respond_to?("#{m}?") ? p.send("#{m}?") : p.send(m)) }
-            unauthorized! opts[:error]
+            unauthorized! opts[:error] unless result
           end
+
+          authorize auth_method_name
         end
       end
-
     end
 
     def initialize(*args, &block)
-      raise Subroutine::Auth::AuthorizationNotDeclaredError unless self.class.authorization_declared
+      raise Subroutine::Auth::AuthorizationNotDeclaredError unless self.class.authorization_declared?
 
       @skip_auth_checks = false
 
@@ -124,5 +134,23 @@ module Subroutine
       raise ::Subroutine::Auth::NotAuthorizedError, reason
     end
 
+    def validate_authorization_checks
+      authorization_checks.each do |check|
+        send(check)
+      end
+    end
+
+    def authorize_user_not_required
+      true
+    end
+
+    def authorize_user_required
+      unauthorized! unless current_user.present?
+    end
+
+    def authorize_no_user_required
+      unauthorized! :empty_unauthorized if current_user.present?
+    end
+
   end
 end

data/lib/subroutine/fields/configuration.rb

@@ -101,6 +101,7 @@ module Subroutine
         opts[:groups] = Array(groups).map(&:to_sym).presence
         opts.delete(:group)
         opts[:aka] = opts[:aka].to_sym if opts[:aka]
+        opts[:name] = field_name
         opts
       end
 

data/lib/subroutine/type_caster.rb

@@ -63,6 +63,15 @@ end
   String(value)
 end
 
+::Subroutine::TypeCaster.register :foreign_key do |value, options = {}|
+  next nil if value.blank?
+
+  next ::Subroutine::TypeCaster.cast(value, type: options[:foreign_key_type]) if options[:foreign_key_type]
+  next ::Subroutine::TypeCaster.cast(value, type: :integer) if options[:name] && options[:name].to_s.end_with?("_id")
+
+  value
+end
+
 ::Subroutine::TypeCaster.register :boolean, :bool do |value, _options = {}|
   !!(String(value) =~ /^(yes|true|1|ok)$/)
 end

data/lib/subroutine/version.rb

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

data/test/subroutine/association_test.rb

@@ -83,20 +83,32 @@ module Subroutine
     def test_it_allows_foreign_key_to_be_set
       all_mock = mock
       ::User.expects(:all).returns(all_mock)
-      all_mock.expects(:find_by!).with(id: "foobarbaz").returns(doug)
+      all_mock.expects(:find_by!).with(id: 10).returns(doug)
 
-      op = ::AssociationWithForeignKeyOp.new(user_identifier: "foobarbaz")
+      op = ::AssociationWithForeignKeyOp.new(owner_id: 10)
       assert_equal doug, op.user
-      assert_equal "user_identifier", op.field_configurations[:user][:foreign_key]
+      assert_equal "owner_id", op.field_configurations[:user][:foreign_key]
+    end
+
+    def test_the_foreign_key_is_cast
+      all_mock = mock
+      ::User.expects(:all).returns(all_mock)
+      all_mock.expects(:find_by!).with(id: 10).returns(doug)
+
+      op = ::AssociationWithForeignKeyOp.new(owner_id: "10")
+      assert_equal doug, op.user
+      assert_equal 10, op.owner_id
+      assert_equal "owner_id", op.field_configurations[:user][:foreign_key]
     end
 
     def test_it_allows_a_foreign_key_and_find_by_to_be_set
       all_mock = mock
       ::User.expects(:all).returns(all_mock)
-      all_mock.expects(:find_by!).with(email_address: doug.email_address).returns(doug)
+      all_mock.expects(:find_by!).with(email_address: "foo@bar.com").returns(doug)
 
-      op = ::AssociationWithFindByAndForeignKeyOp.new(email_address: doug.email_address)
+      op = ::AssociationWithFindByAndForeignKeyOp.new(email_address: "foo@bar.com")
       assert_equal doug, op.user
+      assert_equal "foo@bar.com", op.email_address
       assert_equal "email_address", op.field_configurations[:user][:find_by]
     end
 
@@ -119,7 +131,7 @@ module Subroutine
     def test_values_are_correct_for_foreign_key_usage
       op = ::AssociationWithForeignKeyOp.new(user: doug)
       assert_equal doug, op.user
-      assert_equal doug.id, op.user_identifier
+      assert_equal doug.id, op.owner_id
     end
 
     def test_values_are_correct_for_both_foreign_key_and_find_by_usage

data/test/subroutine/auth_test.rb

@@ -57,6 +57,16 @@ module Subroutine
       end
     end
 
+    def test_authorization_checks_are_registered_on_the_class
+      assert_equal false, MissingAuthOp.authorization_declared?
+
+      assert_equal true, CustomAuthorizeOp.authorization_declared?
+      assert_equal [:authorize_user_required, :authorize_user_is_correct], CustomAuthorizeOp.authorization_checks
+
+      assert_equal true, NoUserRequirementsOp.authorization_declared?
+      assert_equal [:authorize_user_not_required], NoUserRequirementsOp.authorization_checks
+    end
+
     def test_the_current_user_can_be_defined_by_an_id
       user = CustomAuthorizeOp.new(1).current_user
       assert_equal 1, user.id
@@ -92,6 +102,10 @@ module Subroutine
       op.submit!
     end
 
+    def policy_invocations_are_registered_as_authorization_methods
+      assert PolicyOp.authorization_checks.include?(:authorize_policy_user_can_access)
+    end
+
     def test_it_runs_policies_with_conditionals
       # if: false
       op = IfConditionalPolicyOp.new(user, check_policy: false)

data/test/subroutine/type_caster_test.rb

@@ -261,5 +261,28 @@ module Subroutine
         op.date_input = "2015-13-01"
       end
     end
+
+    def test_foreign_key_inputs
+      op.fk_input_owner_id = nil
+      assert_nil op.fk_input_owner_id
+
+      op.fk_input_owner_id = ""
+      assert_nil op.fk_input_owner_id
+
+      op.fk_input_owner_id = "19402"
+      assert_equal 19402, op.fk_input_owner_id
+
+      op.fk_input_owner_id = "19402.0"
+      assert_equal 19402, op.fk_input_owner_id
+
+      op.fk_input_email_address = nil
+      assert_nil op.fk_input_email_address
+
+      op.fk_input_email_address = ""
+      assert_nil op.fk_input_email_address
+
+      op.fk_input_email_address = "foo@bar.com"
+      assert_equal "foo@bar.com", op.fk_input_email_address
+    end
   end
 end

data/test/support/ops.rb

@@ -166,6 +166,8 @@ class TypeCastOp < ::Subroutine::Op
   array :array_input, default: "foo"
   array :type_array_input, of: :integer
   file :file_input
+  foreign_key :fk_input_owner_id
+  foreign_key :fk_input_email_address, foreign_key_type: :string
 
 end
 
@@ -314,13 +316,13 @@ end
 
 class AssociationWithForeignKeyOp < ::OpWithAssociation
 
-  association :user, foreign_key: "user_identifier"
+  association :user, foreign_key: "owner_id"
 
 end
 
 class AssociationWithFindByKeyOp < ::OpWithAssociation
 
-  association :user, find_by: "email_address"
+  association :user, find_by: "email_address", foreign_key_type: :string
 
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta
+  version: 2.1.0
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -214,11 +214,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Feature-driven operation objects.