Add `validation_errors_to` option - customize copying of errors #26

brendon · 2020-07-20T01:46:46Z

This is an old PR that I had for Paperclip. See: thoughtbot#2347 for discussion.

I'd love to see it receiving the love it deserves :D

A couple of recent updates came through from my inclusion of recent Paperclip updates (README) but these can be reversed out by you if you like :)

Implicitly, errors are added to both base and the attribute, but we can now use add_validation_errors_to and set it to either :attribute or :base.
If it's not set, then errors would be added to both as below:

When we set it to :base, it will add error to the base only as:

And when it's set to :attribute, it will add it to attribute as:

brendon · 2020-07-20T01:57:30Z

I've updated this to resolve the conflicts. The test suite may need some work as it looks like some stuff with testing was changed between now and when I wrote this. I'm planning to migrate away from Paperclip at some point so probably can't commit too much time to this, but feel free to take it further and merge it if you like it :)

ssinghi · 2020-07-30T15:00:25Z

Thanks @brendon for this PR. We will review and discuss it, and get back to you soon.

sbhawsingka

@brendon can you please rebase your branch with the master? Then it'll be easy for you to fix the tests.

Valid values for `add_validation_errors_to` are `:attribute`, `:base`, or `:both`. The option is globally set to `:both` that retains the existing behaviour of adding validation errors to both the attribute and the model base.

hound · 2020-08-01T02:00:24Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+  end
+
+  context "with add_validation_errors_to set to :base" do
+    it "only adds error to base not attribute" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:24Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :base" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:25Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+  end
+
+  context "with add_validation_errors_to set to :attribute" do
+    it "only adds error to attribute not base" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:25Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :attribute" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:25Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+        "Error not added to base attribute"
+
+      assert @dummy.errors[:avatar_file_size].blank?,
+        "Error added to attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:25Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar].present?,
+        "Error not added to base attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:25Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      Paperclip.options[:add_validation_errors_to] = :both
+    end
+
+    it "only adds error to base not attribute" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:26Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :base globally" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:26Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+        "Error not added to attribute"
+
+      assert @dummy.errors[:avatar].blank?,
+        "Error added to base attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-01T02:00:26Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar_file_size].present?,
+        "Error not added to attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

brendon · 2020-08-01T02:01:30Z

Thanks @shalinibhawsingka-kreeti. Let me know if I've done the rebase wrong :)

sbhawsingka · 2020-08-02T09:41:03Z

Thanks @brendon, can you please use rspec mocks? For instance, if you have @dummy.stubs(:avatar_file_size).returns(11.kilobytes), you can write allow(@dummy).to receive(:avatar_file_size).and_return(11.kilobytes).

hound · 2020-08-02T21:51:16Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      Paperclip.options[:add_validation_errors_to] = :both
+    end
+
+    it "only adds error to attribute not base" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:16Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :attribute globally" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:16Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+        "Error not added to attribute"
+
+      assert @dummy.errors[:avatar].present?,
+        "Error not added to base attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:16Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar_file_size].present?,
+        "Error not added to attribute"


Layout/AlignParameters: Align the parameters of a method call if they span more than one line.
Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:17Z

spec/paperclip/validators/attachment_size_validator_spec.rb

@@ -205,6 +205,94 @@ def self.should_not_allow_attachment_file_size(size, options = {})
    end
  end

+  context "with add_validation_errors_to not set (implicitly :both)" do
+    it "adds error to both attribute and base" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:17Z

spec/paperclip/validators/attachment_size_validator_spec.rb

@@ -205,6 +205,94 @@ def self.should_not_allow_attachment_file_size(size, options = {})
    end
  end

+  context "with add_validation_errors_to not set (implicitly :both)" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:17Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+    it "only adds error to base not attribute" do
+      build_validator matches: /.*\.png$/, allow_nil: false,
+        add_validation_errors_to: :base
+      allow(@dummy).to receive_messages(avatar_file_name: "data.txt")


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:18Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+  end
+
+  context "with add_validation_errors_to set to :base" do
+    it "only adds error to base not attribute" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:18Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :base" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-02T21:51:18Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+    it "only adds error to attribute not base" do
+      build_validator matches: /.*\.png$/, allow_nil: false,
+        add_validation_errors_to: :attribute
+      allow(@dummy).to receive_messages(avatar_file_name: "data.txt")


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

brendon · 2020-08-02T21:52:08Z

Thanks @shalinibhawsingka-kreeti, I've updated the tests. Not sure what you want to do about the hound messages. They're kind of annoying and they're requesting changes to strings that bring them out of line with the rest of the file :)

sbhawsingka · 2020-08-04T12:40:25Z

Thanks @brendon, please use 4 space indentation for indenting a condition in an if statement spanning multiple lines, this is in regard to your code - if record.errors.include?(attribute) && [:both, :base].include?(options[:add_validation_errors_to])
Also, please align the arguments in the specs.

brendon · 2020-08-04T21:06:52Z

Have a go now :)

hound · 2020-08-04T21:06:55Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+             "Error not added to base attribute"
+
+      assert @dummy.errors[:avatar_file_size].blank?,
+             "Error added to attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:55Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar].present?,
+             "Error not added to base attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:55Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+             "Error not added to attribute"
+
+      assert @dummy.errors[:avatar].blank?,
+             "Error added to base attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:55Z

spec/paperclip/validators/attachment_size_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar_file_size].present?,
+             "Error not added to attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:55Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+             "Error not added to base attribute"
+
+      assert @dummy.errors[:avatar_file_name].blank?,
+             "Error added to attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:57Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+      @validator.validate(@dummy)
+
+      assert @dummy.errors[:avatar].present?,
+             "Error not added to base attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:57Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+
+    it "only adds error to base not attribute" do
+      build_validator matches: /.*\.png$/, allow_nil: false
+      allow(@dummy).to receive_messages(avatar_file_name: "data.txt")


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:57Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+      Paperclip.options[:add_validation_errors_to] = :both
+    end
+
+    it "only adds error to base not attribute" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:57Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+    end
+  end
+
+  context "with add_validation_errors_to set to :base globally" do


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

hound · 2020-08-04T21:06:57Z

spec/paperclip/validators/attachment_file_name_validator_spec.rb

+             "Error not added to attribute"
+
+      assert @dummy.errors[:avatar].blank?,
+             "Error added to base attribute"


Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.

brendon · 2020-08-04T21:07:24Z

Maybe turn off the string literal rule given most of the strings in Paperclip are double-quoted?

sbhawsingka · 2020-08-05T04:21:45Z

Thanks @brendon, we are changing the string literal to use double-quotes.

brendon · 2020-08-05T21:03:12Z

Thanks @shalinibhawsingka-kreeti, great to see this finally merged! :D

brendon · 2020-08-07T05:29:18Z

Would it be possible to release a new gem version? Then I can finally get off my fork branch after all these years! :D

ssinghi · 2020-08-10T16:58:30Z

@brendon created release 6.3.0

https://github.com/kreeti/kt-paperclip/releases/tag/v6.3.0

brendon · 2020-08-10T21:28:43Z

Thank you so much @ssinghi :D

ssinghi requested a review from sbhawsingka July 30, 2020 14:56

sbhawsingka reviewed Jul 31, 2020

View reviewed changes

Introduce add_validation_errors_to option

255d555

Valid values for `add_validation_errors_to` are `:attribute`, `:base`, or `:both`. The option is globally set to `:both` that retains the existing behaviour of adding validation errors to both the attribute and the model base.

brendon force-pushed the add_validation_errors_to-option branch from 1348267 to 255d555 Compare August 1, 2020 02:00

hound bot reviewed Aug 1, 2020

View reviewed changes

Update stubbing

b03c98d

hound bot reviewed Aug 2, 2020

View reviewed changes

Formatting

b54a346

hound bot reviewed Aug 4, 2020

View reviewed changes

sbhawsingka approved these changes Aug 5, 2020

View reviewed changes

sbhawsingka assigned ssinghi Aug 5, 2020

ssinghi changed the title ~~Add validation errors to option~~ Add validation_errors_ to options - customize copying of errors Aug 5, 2020

ssinghi changed the title ~~Add validation_errors_ to options - customize copying of errors~~ Add validation_errors_to options - customize copying of errors Aug 5, 2020

ssinghi merged commit ce84dbf into kreeti:master Aug 5, 2020

ssinghi changed the title ~~Add validation_errors_to options - customize copying of errors~~ Add validation_errors_to option - customize copying of errors Aug 5, 2020

Add validation_errors_to option - customize copying of errors #26

Add validation_errors_to option - customize copying of errors #26

Conversation

brendon commented Jul 20, 2020 • edited by sbhawsingka

brendon commented Jul 20, 2020

ssinghi commented Jul 30, 2020

sbhawsingka left a comment

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

hound bot Aug 1, 2020

Choose a reason for hiding this comment

brendon commented Aug 1, 2020

sbhawsingka commented Aug 2, 2020

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

hound bot Aug 2, 2020

Choose a reason for hiding this comment

brendon commented Aug 2, 2020

sbhawsingka commented Aug 4, 2020

brendon commented Aug 4, 2020

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

hound bot Aug 4, 2020

Choose a reason for hiding this comment

brendon commented Aug 4, 2020

sbhawsingka commented Aug 5, 2020 • edited

brendon commented Aug 5, 2020

brendon commented Aug 7, 2020

ssinghi commented Aug 10, 2020

brendon commented Aug 10, 2020

Add `validation_errors_to` option - customize copying of errors #26

Add `validation_errors_to` option - customize copying of errors #26

brendon commented Jul 20, 2020 •

edited by sbhawsingka

sbhawsingka commented Aug 5, 2020 •

edited