[WIP] Bang Validations #10

davesims · 2017-04-19T15:35:59Z

🚧 Don't raise exceptions on validation failures by default 🚧

This PR adds bang methods for the three validation types to indicate that they will raise exceptions when they fail, and will convert the existing non-bang validation methods so that they accumulate errors in an errors array and then aggregate them on the context's message, rather than raise exceptions.

The new 'bang' validations will behave exactly like the former non-bang validations:

validates_before!
validates_after!
validates_around!

The existing validation methods will be converted so that they accumulate validation error messages rather than raise exceptions:

validates_before
validates_after
validates_around

The rationale here is to reduce coupling to exception classes and eliminate the need for callsites to control flow with exception handling. So for instance in a controller action that uses an ActionTask with any of the default validation methods:

class FooActionTask
  include ActionLogic::ActionTask
  validates_before foo_id: {}

  def call
    [...]
  end
end

...instead of a begin/rescue to trap for ActionLogic errors like this:

 def show
   begin
     result = FooActionTask.execute(model_id: 1)
     if result.success?
       flash[:notice] = result.message
       redirect_to happy_path
     else
       flash[:error] = result.message
       redirect_to sad_path
     end
   rescue ActionLogic::MissingAttributeError => ex #  ActionLogic::MissingAttributeError: context: Class message: foo_id attributes are missing
     flash[:error] = ex.message
     redirect_to sad_path
   end
 end

The validation error messages would be accumulated in the result/context object's message:

 def show
   result = FooActionTask.execute(model_id: 1)
   if result.success?
     flash[:notice] = result.message
     redirect_to happy_path
   else
     flash[:error] = result.message # "foo_id attributes are missing"
     redirect_to sad_path
   end
 end

If the callsite needs to trap for validation errors, the new bang methods can be used:

class FooActionTask
  include ActionLogic::ActionTask
  validates_before! foo_id: {}

  def call
    [...]
  end
end

...and any validation errors encountered during an execute call will result in an ActionLogic error.

davesims · 2017-04-19T15:38:25Z

lib/action_logic/action_validation.rb

@@ -6,27 +6,31 @@ module ActionLogic
  module ActionValidation
    module ClassMethods
      def validates_before(args)
-        @validates_before = args
+        @validates_before = args.merge(raise_action_logic_exception: true)


Will eventually eliminate this dupe, but for now I just wanted to see what it looked like to use the validations hash to signal to the validation classes whether to raise an exception or not.

codecov-io · 2017-04-19T15:38:26Z

Codecov Report

Merging #10 into master will increase coverage by 0.07%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master      #10      +/-   ##
==========================================
+ Coverage    99.1%   99.17%   +0.07%     
==========================================
  Files          22       22              
  Lines         668      729      +61     
==========================================
+ Hits          662      723      +61     
  Misses          6        6

Impacted Files	Coverage Δ
lib/action_logic/action_validation.rb	`100% <100%> (ø)`	⬆️
.../action_logic/action_validation/type_validation.rb	`100% <100%> (ø)`	⬆️
spec/action_logic/active_use_case_spec.rb	`100% <100%> (ø)`	⬆️
...on_logic/action_validation/attribute_validation.rb	`100% <100%> (ø)`	⬆️
spec/action_logic/action_task_spec.rb	`100% <100%> (ø)`	⬆️
...ion_logic/action_validation/presence_validation.rb	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d4599fc...4172fd4. Read the comment docs.

davesims · 2017-04-19T15:41:07Z

lib/action_logic/action_validation/presence_validation.rb

-        return unless validation_rules.values.find { |expected_validation| expected_validation[:presence] }
-        errors = presence_errors(validation_rules, context)
-        raise ActionLogic::PresenceError.new(errors) if errors.any?
+        tmp_rules = validation_rules.clone


we have to clone a copy of validation_rules here instead of deleting the :raise_action_logic_exception directly, since for 'around' validations, validation_rules will be accessed twice, once before and once after.

davesims · 2017-04-19T15:43:02Z

lib/action_logic/action_validation.rb

      end

      def validates_after(args)
-        @validates_after = args
+        @validates_after = args.merge(raise_action_logic_exception: true)


I don't know how I feel about using an extra attribute to signal the validation classes. This is just a rough draft. If this is the approach to take, it needs to be a very specific name to avoid potential collisions, hence "raise_action_logic_exception".

davesims · 2017-04-19T15:51:18Z

lib/action_logic/action_validation.rb

      end

      def validates_around(args)
-        @validates_around = args
+        @validates_around = args.merge(raise_action_logic_exception: true)


WIP: eventually these will be false on all of the non-bang validation methods.

davesims · 2017-04-19T15:56:48Z

lib/action_logic/action_validation.rb

      end

      def get_validates_before
-        @validates_before ||= {}
+        @validates_before ||= { raise_action_logic_exception: true }


TODO: fix dupe.

rewinfrey · 2018-12-18T05:18:37Z

@davesims friendly ping 😄 let me know if you'd like to keep pushing on this thread, and maybe we can 🍐 on this or talk through it again?

davesims added 2 commits April 18, 2017 08:25

Add bang support for validates_around

23e4048

WIP!! Experiment with extra attr on validations for raising

ba72c3c

davesims commented Apr 19, 2017

View reviewed changes

Default validates_around to not raise errors; update tests

b28da4c

rewinfrey mentioned this pull request Apr 20, 2017

WIP: Conditional exception validations #11

Closed

davesims added 7 commits April 20, 2017 07:47

Test for exceptions thrown with around validations for custom types

1e2018a

Added tests for ValidateAroundPresenceTestTaskWithBang

00578ba

Test for around validations with custom presence

dbd4f6d

Added test for ValidateAroundTestUseCaseWithBang required attributes

dcf12de

ActionUseCase test for around validations with custom types

0a90d51

ActiveUseCase around validation with presence test

995ba45

ActiveUseCase tests for around validation with custom presence

4172fd4

davesims added 3 commits December 15, 2021 07:13

update to ruby 3

a78b5d2

Convert current before methods to bang!

8b75a60

Adding tests for before validation, no bang

3625f2c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Bang Validations #10

[WIP] Bang Validations #10

davesims commented Apr 19, 2017 •

edited

Loading

davesims Apr 19, 2017

codecov-io commented Apr 19, 2017 •

edited

Loading

davesims Apr 19, 2017

davesims Apr 19, 2017

davesims Apr 19, 2017 •

edited

Loading

davesims Apr 19, 2017

rewinfrey commented Dec 18, 2018

[WIP] Bang Validations #10

Are you sure you want to change the base?

[WIP] Bang Validations #10

Conversation

davesims commented Apr 19, 2017 • edited Loading

🚧 Don't raise exceptions on validation failures by default 🚧

davesims Apr 19, 2017

Choose a reason for hiding this comment

codecov-io commented Apr 19, 2017 • edited Loading

Codecov Report

davesims Apr 19, 2017

Choose a reason for hiding this comment

davesims Apr 19, 2017

Choose a reason for hiding this comment

davesims Apr 19, 2017 • edited Loading

Choose a reason for hiding this comment

davesims Apr 19, 2017

Choose a reason for hiding this comment

rewinfrey commented Dec 18, 2018

davesims commented Apr 19, 2017 •

edited

Loading

codecov-io commented Apr 19, 2017 •

edited

Loading

davesims Apr 19, 2017 •

edited

Loading