subroutine 2.0.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fbd9c97951c8e07f3f84fe1f9826d4fff45a7f0fe99045d375e34d530fb0934
-  data.tar.gz: db76eef88d0afd766a7a906d0cf5a202286d90da3f6ec113e798b6709f3c96e4
+  metadata.gz: 63080af90148b6faaff42be6f9753d6f5ef36f3f8ebe650a1372905836f5e208
+  data.tar.gz: 9522cbaf937f5bdfa85fbb629ad8a1f3f014dce6ea42784ef68b39c4ecebad49
 SHA512:
-  metadata.gz: 2310334da4ebf40292d6868c1ab59b028d790fd01db3ef55825d4f680810e157ffd35c9d6a19e6b1e58816aad8eb87f01b1ae9e9395914350d23b80a84b4874b
-  data.tar.gz: 4b426d21e7e91f27405daf3a7438f4a049f4a5a7ee13002488259e5599989a867d2fbf9c31f56cff7c8be452708175ba786700729ab88b2f186c4ed4159fcecb
+  metadata.gz: a76f25b779fd8a9ccc3958febe5b68906d7260f052b5200d6b080680f9f80f79debebe2bf35ee199f6996cccd827f0844e3710d30f0ee367dd248c6900f45c74
+  data.tar.gz: c3e50c34de7e4f656168cec625bccb1bede1fcd4dbbdd5bef7d9d0dabf9a2695a470dd749b2ec5785448b6cd45c0c3454b469d49a157e9d19fffc2ada78b75ce

data/.ruby-version

@@ -1 +1 @@
-2.5.7
+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.

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,50 @@ 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 = if normalized_meth.to_s.end_with?("?")
+                              meth.to_s[0...-1]
+                            else
+                              meth
+                            end
 
-          # The validation only runs when all the :if conditions
-          if if_conditionals.present?
-            run_it &&= if_conditionals.all? { |i| send(i) }
-          end
+          auth_method_name = :"authorize_#{policy_name}_#{normalized_meth}"
 
-          # and none of the :unless conditions are evaluated to true.
-          if unless_conditionals.present?
-            run_it &&= unless_conditionals.none? { |u| send(u) }
-          end
+          define_method auth_method_name do
+            run_it = true
+            # http://guides.rubyonrails.org/active_record_validations.html#combining-validation-conditions
+
+            # 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
 
-          next unless run_it
+            p = send(policy_name)
+            unauthorized! unless p
 
-          p = send(policy_name)
-          if !p || meths.any? { |m| !(p.respond_to?("#{m}?") ? p.send("#{m}?") : p.send(m)) }
-            unauthorized! opts[:error]
+            result = if p.respond_to?("#{normalized_meth}?")
+                       p.send("#{normalized_meth}?")
+                     else
+                       p.send(normalized_meth)
+                     end
+
+            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 +139,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.rb

@@ -216,9 +216,9 @@ module Subroutine
       field_provided?(name) ? all_params[name] : all_default_params[name]
     end
 
-    def set_field(name, value, track_provided: true)
+    def set_field(name, value, opts = {})
       config = get_field_config(name)
-      @provided_fields[name] = true if track_provided
+      @provided_fields[name] = true unless opts[:track_provided] == false
       value = attempt_cast(value, config) do |e|
         "Error during assignment of field `#{name}`: #{e}"
       end

data/lib/subroutine/version.rb

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

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/fields_test.rb

@@ -136,5 +136,12 @@ module Subroutine
       assert_equal({}.with_indifferent_access, op.without_inherited_params)
     end
 
+    def test_fields_are_inherited_to_subclasses
+      assert_equal(%i[amount_cents], ParentInheritanceOp.field_configurations.keys.sort)
+      assert_equal(%i[debit_cents], ParentInheritanceOp::EarlyInheritanceOp.field_configurations.keys.sort)
+      assert_equal(%i[amount_cents debit_cents], ParentInheritanceOp::LateInheritanceOp.field_configurations.keys.sort)
+      assert_equal(%i[amount_cents credit_cents], OuterInheritanceOp.field_configurations.keys.sort)
+    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
@@ -284,10 +290,33 @@ class UnlessConditionalPolicyOp < OpWithAuth
 
 end
 
+class ParentInheritanceOp < ::Subroutine::Op
+  class EarlyInheritanceOp < ParentInheritanceOp
+    integer :debit_cents
+  end
+
+  integer :amount_cents
+
+  class LateInheritanceOp < ParentInheritanceOp
+    integer :debit_cents
+  end
+
+end
+
+class OuterInheritanceOp < ParentInheritanceOp
+
+  integer :credit_cents
+
+end
+
 class OpWithAssociation < ::Subroutine::Op
 
   include ::Subroutine::AssociationFields
 
+  def perform
+    false
+  end
+
 end
 
 class SimpleAssociationOp < ::OpWithAssociation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Feature-driven operation objects.