Add Rails 6 Support #124

danielricecodes · 2019-08-13T15:57:38Z

This pull requests offers Support for Rails 6.0, which was released on August 15th, 2019.

…as well as newer

This reverts commit bd13b83.

Create a V6 class, in case there are differences that need to be coded later.

the association_scope method was made private in Rails public API.

…oject from Github

RomainAlexandre · 2019-08-19T16:58:18Z

Hi @danielricecodes !
I loved the work you started. @jbryant92 and I are bumping our app to rails 6 and will need this gem to be on rails 6.

We have spent some time investigating the last failing specs on your branch. @jbryant92 was able to fix test/test_associations.rb:235:in test_mass_assignment_of_paranoid_column_enabled'`

We think we understand the reason why the last two are failing. The reason is, named scopes are no longer leaking to class level in rails 6 (See associated Rails PR: rails/rails#32380)

In our case, this line

association.klass.with_deleted.scoping { #{target}_without_unscoped(*args) }

is the culprit.(https://github.com/ActsAsParanoid/acts_as_paranoid/blob/master/lib/acts_as_paranoid/associations.rb#L34)

#{target}_without_unscoped(*args) belongs_to does not get the scope with_deleted when being called.

Few ideas that don't seem quite correct.
The closest we got was this:

association.klass.with_deleted { association.klass.unscoped { #{target}_without_unscoped(*args) } }

Since it is possible to use unscoped with a block, we can remove the default scope coming with act_as_paranoid. But it also remove any other default scope define by a user of this gem where we would only like to call with_deleted on the belongs_to.

We also tried to prepend with_deleted to the scope when creating the belongs_to relationship.
But concatenating two scopes is a bit trickier than plan.

I hope this can help. If you have any ideas or comments, let us know !
We will continue investigating it !

jbryant92 · 2019-08-19T16:58:56Z

Here are the changes I made to get it going with Rails 6.0.0, also the small fix for the spec: railsagency#1

Let the rails-6-support branch run with 6.0.0

danielricecodes · 2019-08-19T18:14:00Z

@jbryant92 @RomainAlexandre thank you so much for helping with the build!

danielricecodes · 2019-08-19T18:16:11Z

lib/acts_as_paranoid/validations.rb

    end

    module ClassMethods
      def validates_uniqueness_of_without_deleted(*attr_names)
-        validates_with UniquenessWithoutDeletedValidator[ActiveRecord::VERSION::MAJOR], _merge_attributes(attr_names)
+        if ActiveRecord::VERSION::MAJOR == '6'
+


Looks like unique validations tests should fail here since the code for AR v6 is missing.

Looks like ActiveRecord::VERSION::MAJOR is an Int so the condition is returning false and then running the old code and passing the tests 🎉

What was the reason this condition was added?

You're right. This can be reverted. I had it in here before when I was trying to figure out why I kept getting "6" is not a valid validator, must be "V5" or "V4". I understand the code a lot better now than I did when I made that commit :)

danielricecodes · 2019-08-19T18:36:18Z

Almost there but not quite:

# Running:
......F.S....F..............................................................
Finished in 3.188223s, 23.8377 runs/s, 115.7385 assertions/s.
  1) Failure:
AssociationsTest#test_belongs_to_with_deleted [/home/travis/build/ActsAsParanoid/acts_as_paranoid/test/test_associations.rb:56]:
--- expected
+++ actual
@@ -1 +1 @@
-#<ParanoidTime id: 1, name: "paranoid", deleted_at: "2019-08-19 18:18:48", paranoid_belongs_dependant_id: nil, not_paranoid_id: nil, created_at: "2019-08-19 18:18:48", updated_at: "2019-08-19 18:18:48">
+nil
  2) Failure:
AssociationsTest#test_belongs_to_polymorphic_with_deleted [/home/travis/build/ActsAsParanoid/acts_as_paranoid/test/test_associations.rb:69]:
--- expected
+++ actual
@@ -1 +1 @@
-#<ParanoidTime id: 1, name: "paranoid", deleted_at: "2019-08-19 18:18:49", paranoid_belongs_dependant_id: nil, not_paranoid_id: nil, created_at: "2019-08-19 18:18:49", updated_at: "2019-08-19 18:18:49">
+nil
76 runs, 369 assertions, 2 failures, 0 errors, 1 skips

…d to avoid using the default scope

RomainAlexandre · 2019-08-20T08:00:51Z

Morning @danielricecodes
So here is the solution that I believe seem right: railsagency#2

Let me know what you think !

Using unscoped when retrieving the belongs_to association with deleted

RomainAlexandre · 2019-08-20T11:59:17Z

Crushing it @danielricecodes !

🙌
I think it's ready for review from the maintainers of acts_as_paranoid !

danielricecodes · 2019-08-20T13:16:30Z

@RomainAlexandre @jbryant92 thanks for your help. With a passing build I'd say its safe to merge!

RomainAlexandre · 2019-08-21T08:35:00Z

Do you know who we should ping to get this PR reviewed and merged ?
Maybe @mvz, I noticed he has been the last one to merge the most recent PRs in the repo.

mvz · 2019-08-21T08:49:00Z

Yes! I'll take a look soon.

mvz

Thanks for this, @danielricecodes and everyone who helped. I have just a few nits and something I need to check.

mvz · 2019-08-21T12:36:45Z

.travis.yml

+  - bundler
+  - directories:
+    - vendor/bundle
+language: ruby


This key is duplicated.

mvz · 2019-08-21T12:37:07Z

.gitignore

@@ -4,3 +4,5 @@ pkg
 Gemfile.lock
 gemfiles/*.lock
 .idea/
+
+\.ruby-version


I think the \ can go?

mvz · 2019-08-21T12:59:23Z

lib/acts_as_paranoid/validations.rb

@@ -38,8 +37,11 @@ def validate_each(record, attribute, value)
        protected

        def build_relation(klass, attribute, value)
-          return super(klass, klass.arel_table, attribute, value) if ActiveRecord::VERSION::MINOR == 0
-          super
+          if ActiveRecord::VERSION::MINOR == 0 && ActiveRecord::VERSION::MAJOR == 5


This looks a bit odd because you would think this class would only be used with Rails 5 (except it isn't because it's subclassed to V6). I'm not sure how to resolve this without duplicating all of V5 (except build_relation) to V6, so 🤷‍♂️.

Agreed. I wasn't sure what the best way to code this would be since most options seemed to involve just copying and pasting, so I opted for the fewest lines of code: simply making V6 an empty subclass of V5.

mvz · 2019-08-21T13:00:11Z

lib/acts_as_paranoid/associations.rb

@@ -31,7 +31,7 @@ def #{target}_with_unscoped(*args)
                association = association(:#{target})
                return nil if association.options[:polymorphic] && association.klass.nil?
                return #{target}_without_unscoped(*args) unless association.klass.paranoid?
-                association.klass.with_deleted.scoping { #{target}_without_unscoped(*args) }
+                association.klass.with_deleted.scoping { association.klass.unscoped { #{target}_without_unscoped(*args) } }


I'm going to check if this doesn't have any unwanted side effects.

I tried to explain here why I made that change, if it helps railsagency#2

Ok, I created some explicit tests for this and it looks like everything is fine 👍. I'll merge this in and then create another PR to add those tests.

danielricecodes · 2019-08-21T13:16:19Z

test/test_associations.rb

@@ -228,7 +228,7 @@ def test_double_belongs_to_with_deleted
  end

  def test_mass_assignment_of_paranoid_column_enabled
-    if ActiveRecord::VERSION::MAJOR > 4 && ActiveRecord::VERSION::MINOR > 1
+    if Gem.loaded_specs['activerecord'].version >= Gem::Version.new('5.2.0')


@mvz - there are several places in the code that check the current ActiveRecord version. Since Rails 6 is out now, it might be worthwhile to release a new major version of this gem where old versions of Rails/Ruby are no longer supported. A new gem version that supports only Rails 5.2+ w/ Ruby 2.5+ only would be nice clean slate.

Yes, that's definitely a good idea!

I don't mind working on that after we get this PR merged.

danielricecodes · 2019-08-24T13:42:53Z

Thanks @mvz I’ll work on a Rails 5.2+ only gem and offer a PR for that as well.

danielricecodes and others added 19 commits August 13, 2019 11:55

Add Rails 6 to Travis Config

e0ee1ad

Test against MRI 2.6.3

1fcf62e

Ignore unsupported Rails 6 Rubies

d70375f

Add bundler setup for Travis, supports older rails/ruby combinations …

90ba8fc

…as well as newer

Map Rails 6 to "V5" validator class

bd13b83

Try new Travis Config

8cbe82b

Revert "Map Rails 6 to "V5" validator class"

add128a

This reverts commit bd13b83.

Ignore ruby version dot file

00089f4

Use released gem's, not a github branch

d10791d

Add Rails 6 test task

53eef30

Create explicit V6 class

2ab706b

Create a V6 class, in case there are differences that need to be coded later.

Read Association scope directly from ActiveRecord

63905dd

the association_scope method was made private in Rails public API.

Fix AssociationScope public API change

f5d4fba

Whoops

363c230

Speed up build by using gem's instead of fetching the entire Rails pr…

03de215

…oject from Github

Remove constraints on gems to work with 6.0.0

f167583

Allow ActiveRecord and ActiveSupport 6.0

7b95093

Better comparison of gems

3230adb

Open to 7.0

3845921

Merge pull request #1 from jbryant92/rails-6-support

dbedde4

Let the rails-6-support branch run with 6.0.0

danielricecodes commented Aug 19, 2019

View reviewed changes

Using unscoped when retrieving the belongs_to association with delete…

610cb85

…d to avoid using the default scope

Merge pull request #2 from RomainAlexandre/rails-6-support

97c060e

Using unscoped when retrieving the belongs_to association with deleted

Undo change from 2ab706b

04e7af2

danielricecodes added 2 commits August 20, 2019 09:11

Remove unnecessary variable

980fce2

Add Rails 6 Contributors to Acknowledgements

97fc483

danielricecodes added 2 commits August 20, 2019 09:20

Clarify Rails version support

dc333e3

Ensure we test against new Rails 6.0 patches also.

0c9b243

mvz reviewed Aug 21, 2019

View reviewed changes

danielricecodes added 3 commits August 21, 2019 09:07

Infer test versions from the files in the gemfiles directory

8d8c98f

Remove duplicate key

7d857f2

Remove unneeded escape character, clean whitespace

c8f333e

danielricecodes commented Aug 21, 2019

View reviewed changes

mvz merged commit 9e240b9 into ActsAsParanoid:master Aug 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Rails 6 Support #124

Add Rails 6 Support #124

danielricecodes commented Aug 13, 2019 •

edited

Loading

RomainAlexandre commented Aug 19, 2019

jbryant92 commented Aug 19, 2019

danielricecodes commented Aug 19, 2019

danielricecodes Aug 19, 2019 •

edited

Loading

jbryant92 Aug 19, 2019 •

edited

Loading

danielricecodes Aug 19, 2019

danielricecodes commented Aug 19, 2019

RomainAlexandre commented Aug 20, 2019 •

edited

Loading

RomainAlexandre commented Aug 20, 2019

danielricecodes commented Aug 20, 2019

RomainAlexandre commented Aug 21, 2019

mvz commented Aug 21, 2019

mvz left a comment

mvz Aug 21, 2019

mvz Aug 21, 2019

mvz Aug 21, 2019

danielricecodes Aug 21, 2019

mvz Aug 21, 2019

RomainAlexandre Aug 21, 2019

mvz Aug 24, 2019

danielricecodes Aug 21, 2019

mvz Aug 21, 2019

danielricecodes Aug 22, 2019

danielricecodes commented Aug 24, 2019

Add Rails 6 Support #124

Add Rails 6 Support #124

Conversation

danielricecodes commented Aug 13, 2019 • edited Loading

RomainAlexandre commented Aug 19, 2019

jbryant92 commented Aug 19, 2019

danielricecodes commented Aug 19, 2019

danielricecodes Aug 19, 2019 • edited Loading

Choose a reason for hiding this comment

jbryant92 Aug 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielricecodes commented Aug 19, 2019

RomainAlexandre commented Aug 20, 2019 • edited Loading

RomainAlexandre commented Aug 20, 2019

danielricecodes commented Aug 20, 2019

RomainAlexandre commented Aug 21, 2019

mvz commented Aug 21, 2019

mvz left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danielricecodes commented Aug 24, 2019

danielricecodes commented Aug 13, 2019 •

edited

Loading

danielricecodes Aug 19, 2019 •

edited

Loading

jbryant92 Aug 19, 2019 •

edited

Loading

RomainAlexandre commented Aug 20, 2019 •

edited

Loading