Errors can be indexed with nested attributes #19686

mprobber · 2015-04-07T14:49:01Z

accepts_nested_attributes_for can now take index_errors: true as an
option. When this is enabled, errors for nested models will be
returned alongside an index, as opposed to just the nested model name.
This option can also be enabled globally in a configuration file.

@tsun1215
#8638

tsun1215 · 2015-04-07T17:04:45Z

activerecord/test/cases/helper.rb

@@ -21,6 +21,9 @@
 # Show backtraces for deprecated behavior for quicker cleanup.
 ActiveSupport::Deprecation.debug = true

+# Don't add indeces to nested attribute errors


Will change, but isn't it indices?

mprobber · 2015-04-07T18:40:55Z

activerecord/CHANGELOG.md

+    now be indexed if :index_errors is specified when defining the nested
+    attributes, or if its set in the global config.
+
+    *Michael Probber and Terence Sun*


kaspth · 2015-04-08T19:27:50Z

activerecord/lib/active_record/autosave_association.rb

+              options = self.nested_attributes_options[reflection.name] 
+              if ActiveRecord::Base.index_nested_attribute_errors 
+                attribute = "#{reflection.name}[#{index}].#{attribute}"
+              elsif index.nil? or options.nil? or not options[:index_errors]


Let's use || and ! here to be in line with our style guide 😄

Done. We'll update once we figured out how we should break the conditional up (see above).

`has_many` can now take `index_errors: true` as an option. When this is enabled, errors for nested models will be returned alongside an index, as opposed to just the nested model name. This option can also be enabled (or disabled) globally through `ActiveRecord::Base.index_nested_attribute_errors` E.X. ```ruby class Guitar < ActiveRecord::Base has_many :tuning_pegs accepts_nested_attributes_for :tuning_pegs end class TuningPeg < ActiveRecord::Base belongs_to :guitar validates_numericality_of :pitch end ``` - Old style - `guitar.errors["tuning_pegs.pitch"] = ["is not a number"]` - New style (if defined globally, or set in has_many_relationship) - `guitar.errors["tuning_pegs[1].pitch"] = ["is not a number"]` [Michael Probber, Terence Sun]

Errors can be indexed with nested attributes Close #8638

s-aida · 2015-10-26T23:19:37Z

activerecord/CHANGELOG.md

+
+    For models which have nested attributes, errors within those models will
+    now be indexed if :index_errors is specified when defining a
+    has_many relationship, or if its set in the global config.


typo of it's?

No, that is the correct way to spell its here

On Mon, Oct 26, 2015, 5:20 PM Shunsuke Aida notifications@github.com
wrote:

In activerecord/CHANGELOG.md
#19686 (comment):

@@ -1,3 +1,31 @@
+* Add option to index errors in nested attributes
+

For models which have nested attributes, errors within those models will

now be indexed if :index_errors is specified when defining a

has_many relationship, or if its set in the global config.

typo of it's?

—
Reply to this email directly or view it on GitHub
https://github.com/rails/rails/pull/19686/files#r43067124.

It's best you check its meaning 🤓

Consider a user reading this. Where would you find "global config?"

its indicates possession.
it's is a contraction for it is.
The latter seems to be the case here. If so, it is would be even better.

bogdan · 2015-10-27T09:42:06Z

Excellent stuff guys!

rweng · 2015-10-31T09:35:45Z

pulled it in on top of 4.2.4 and it works like a charm. Would love to see this change being in 4.2.5 so I can discard my fork :)

kaspth · 2015-10-31T10:18:18Z

Sorry, we don't backport features to patch releases. This'll be in Rails 5.

uberllama · 2015-11-19T20:56:34Z

Long overdue. Thanks for your effort. 🏁

- Based on https://github.com/rails/rails/pull/19686/files#r43069872 and https://github.com/rails/rails/pull/19686/files#r43070016.

- rails#18721 - rails#11898 - rails#18194 - rails#18225 - rails#18244 - rails@edc2b77 - rails#19686

@order

* Using an instance variable allows JS populate operations to have access to the @order from within the rendered .js.erb files * Assign all line_item errors to the order's base * Allow to respond to JS requests for `#populate` and `#update` actions. It is left for the developer to actually implement the `js.erb` views To consider / TODO: - to avoid the whole rescue operation, and manually assigning line item errors to the order, we'd need to do to be doing `order.save` instead of `line_item.save!` in [`OrderContents`](https://github.com/solidusio/solidus/blob/master/core/app/models/spree/order_contents.rb#L151) -> That would have the effect to "automatically" assign the line item errors on the order in the form: `line_items.quantity` in Rails 4.x and "line_items[0].quantity" in Rails 5 More info: - rails/rails#8638 - rails/rails#19686

kdiogenes · 2017-02-08T23:09:49Z

I can't find a way to parse my errors messages:

errors = {
  "categories[0].listener_deadline_values[0].value": ["can't be blank"],
  "categories[0].listener_deadline_values[0].deadline": ["can't be blank"],
  "categories[0].name": ["can't be blank"],
  "categories[1].listener_deadline_values[0].value": ["can't be blank"],
  "categories[1].listener_deadline_values[0].deadline": ["can't be blank"],
  "categories[1].name": ["can't be blank"],
  "categories[2].listener_deadline_values[0].value": ["can't be blank"],
  "categories[2].listener_deadline_values[0].deadline": ["can't be blank"],
  "categories[2].name": ["can't be blank"]
}

I would expect to be able to access these errors like errors.categories[2].name

How do you parse it? I discovered how: https://medium.com/@kdiogenes/giving-super-powers-to-rails-nested-forms-with-vue-js-part-2-acee4a3ee43d

tommyalvarez · 2017-05-23T16:08:06Z

Is there a way to index by another criteria @mprobber ? Like the ID of the nested model if it's not a new record? This is because i can't figure a way when using rails 5 api to map errors into several nested children which some of them can have errors while others not, therefore indexes won't match one on one. Or is there another clever solution to handle this situation?

vidurangaw · 2017-08-28T18:29:21Z

@tommyalvarez
I'm having the exact issue you've faced. Were you able to find a solution?

tommyalvarez · 2017-08-28T19:49:42Z

@vidurangaw i ended up writing my own custom NestedErrorSerializer (i was using active model serializer with json-api adapter). This way i was able to return the errors the way i wanted, respeting json-api format. Thought it would take me a lot of time but it wasn't that hard at all. Here is the implementation i made:

module NestedErrorSerializer
  # object is the object to serialize, relationships an array of symbols with the relationships of the object
  def self.serialize(object, relationships)
    errors = object.errors.messages.map do |field, errors|
      errors.map do |error_message|
        {
          source: {pointer: "/data/attributes/#{field}"},
          detail: error_message
        }
      end
    end
    relationships.each do |relationship|
      object.send(relationship).each_with_index do |child, index|
        errors << child.errors.messages.map do |field, errors|
          errors.map do |error_message|
            {
              source: {pointer: "/data/attributes/#{child.model_name.plural}[#{index}].#{field}"},
              detail: error_message
            }
          end
        end
      end
    end if relationships.present?
    errors.flatten
  end
end

Then in the controller i used them like:

render json: {errors: NestedErrorSerializer.serialize(@product, [:consumables])}, status: :unprocessable_entity

vidurangaw · 2017-08-28T23:16:21Z

@tommyalvarez
Thanks for the quick response. I'll try this

aruprakshit · 2017-09-10T21:52:48Z

Why this option is not mentioned in the official doc ?

dhyegocalota · 2018-01-26T19:18:47Z

I've created a gem (active_record-nested_error_indexer) to monkey patch these changes to Rails 4 😄

tsun1215 reviewed Apr 7, 2015
View reviewed changes

mprobber force-pushed the index_errors branch from 0d39cc5 to 1976af5 Compare April 7, 2015 18:39

mprobber reviewed Apr 7, 2015
View reviewed changes

eileencodes added activerecord openacademy labels Apr 8, 2015

kaspth reviewed Apr 8, 2015
View reviewed changes

mprobber force-pushed the index_errors branch 5 times, most recently from 695b20b to b8cbac1 Compare April 8, 2015 22:06

mprobber force-pushed the index_errors branch from b8cbac1 to 21e448b Compare April 17, 2015 18:12

rails-bot assigned sgrif Oct 20, 2015

sgrif merged commit 21e448b into rails:master Oct 26, 2015

sgrif added a commit that referenced this pull request Oct 26, 2015

Merge pull request #19686 from tsun1215/index_errors

118232a

Errors can be indexed with nested attributes Close #8638

s-aida reviewed Oct 26, 2015
View reviewed changes

morgoth mentioned this pull request Mar 31, 2016

Nested model validation errors has useless format in json #24380

Closed

prathamesh-sonpatki mentioned this pull request Jun 7, 2016

Add missing things to release notes [ci skip] #25321

Merged

prathamesh-sonpatki added a commit to prathamesh-sonpatki/rails that referenced this pull request Jun 7, 2016

Improve CHANGELOG for rails#19686 [ci skip]

6f81d5c

- Based on https://github.com/rails/rails/pull/19686/files#r43069872 and https://github.com/rails/rails/pull/19686/files#r43070016.

prathamesh-sonpatki added a commit to prathamesh-sonpatki/rails that referenced this pull request Jun 7, 2016

Add missing things to release notes [ci skip]

ba57551

- rails#18721 - rails#11898 - rails#18194 - rails#18225 - rails#18244 - rails@edc2b77 - rails#19686

mtomov mentioned this pull request Sep 14, 2016

Improve JS handling for OrdersController solidusio/solidus#1440

Merged

kdiogenes added a commit to kdiogenes/active_type that referenced this pull request Feb 7, 2017

Mimics Rails 5 nested attributes errors index rails/rails#19686

67c4b7b

kdiogenes mentioned this pull request Feb 8, 2017

index_errors option to nests_many makandra/active_type#74

Merged

evanrolfe mentioned this pull request Oct 16, 2017

Kiwi Editor - Add understandable flash message openSUSE/open-build-service#3981

Merged

brendanthomas1 mentioned this pull request Apr 4, 2018

Add index_errors association matcher thoughtbot/shoulda-matchers#1089

Closed

fernandes mentioned this pull request Oct 18, 2018

Draft of indexed errors implementation trailblazer/reform#467

Open

Borzik mentioned this pull request Mar 5, 2019

Add a way to index nested models' validation errors by their attribute #35478

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Errors can be indexed with nested attributes #19686

Errors can be indexed with nested attributes #19686

mprobber commented Apr 7, 2015

tsun1215 Apr 7, 2015

mprobber Apr 7, 2015

kaspth Apr 8, 2015

tsun1215 Apr 8, 2015

s-aida Oct 26, 2015

sgrif Oct 26, 2015

jeremy Oct 26, 2015

jeremy Oct 26, 2015

jonatack Oct 31, 2015

bogdan commented Oct 27, 2015

rweng commented Oct 31, 2015

kaspth commented Oct 31, 2015

uberllama commented Nov 19, 2015

kdiogenes commented Feb 8, 2017 •

edited

Loading

tommyalvarez commented May 23, 2017

vidurangaw commented Aug 28, 2017

tommyalvarez commented Aug 28, 2017

vidurangaw commented Aug 28, 2017

aruprakshit commented Sep 10, 2017

dhyegocalota commented Jan 26, 2018

Errors can be indexed with nested attributes #19686

Errors can be indexed with nested attributes #19686

Conversation

mprobber commented Apr 7, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bogdan commented Oct 27, 2015

rweng commented Oct 31, 2015

kaspth commented Oct 31, 2015

uberllama commented Nov 19, 2015

kdiogenes commented Feb 8, 2017 • edited Loading

tommyalvarez commented May 23, 2017

vidurangaw commented Aug 28, 2017

tommyalvarez commented Aug 28, 2017

vidurangaw commented Aug 28, 2017

aruprakshit commented Sep 10, 2017

dhyegocalota commented Jan 26, 2018

kdiogenes commented Feb 8, 2017 •

edited

Loading