Add composite primary key support #430

divagueame · 2024-05-12T19:51:47Z

This PR adds support for Composite primary key which is supported from Rails 7.1
This was requested in this issue
#417

Locally I had to run bundle exec appraisal install to generate rails_7_1.gemfile to run the tests. I didn't include it in the PR since I am not sure if it' s needed/left out for any particular reason/be dependent on my local environment.
Any feedback is welcome.

lib/acts_as_list/active_record/acts/list.rb

brendon · 2024-05-14T22:06:01Z

lib/acts_as_list/active_record/acts/list.rb


-        def composite_primary_key?
-          self.class.respond_to?(:composite_primary_key?) && self.class.composite_primary_key?
+          id = id ? Array.wrap(id) : Array.wrap(primary_keys.map { |k| send(k) })


Thanks for the update. Did you try slice(*primary_keys)? With Active Record objects it returns a hash with keys that you provide and the values as they are on the object.

https://api.rubyonrails.org/classes/ActiveRecord/Core.html#method-i-slice

This line could then read:

id ? primary_keys.zip(Array.wrap(id)) : slice(*primary_keys)

Thanks for the advice. That works indeed. I didn't know that and I thought about the default ruby slice method. No wonder how it didn't work for me : D
I changed it now and it seems to work.

I am still refactoring the tests to include scope, but not sure if I'm just complicating it too much in order to reuse test/shared_list.rb I'll try to clean it up a bit before commiting it.

Thanks @divagueame. Yea I didn't write these tests and they've kind of grown into a mess over time. I think it's ok to just repeat some scope change tests in your seperate file for sanity. Single ID primary keys are used directly in the tests which make things brittle. I suppose that test suite could be configured to use a single id and a composite in two seperate runs via some kind of configuration.

I refactored Shared::List so that the Mixin used can be overwritten. I had to add a helper method to be able to create records with composite primary key. Not sure if it's better than having a separate file with some duplicated tests. Let me know what you think.

divagueame · 2024-05-15T12:03:14Z

gemfiles/rails_7_1.gemfile

+end
+
+group :postgresql do
+  gem "pg", "~> 1.2.0"


I am not sure about this one. I run bundle exec appraisal install while using ruby 3.1.5p252 (2024-04-23 revision 1945f8dc0e) [x86_64-linux] and I get gem "pg", "~> 1.2.0"

However, on rails_7_0.gemfile, it uses
gem "pg", "~> 1.3.0"

Tried running it with other higher versions of ruby but always get this error:

Installing pg 1.2.3 with native extensions Gem::Ext::BuildError: ERROR: Failed to build gem native extension.

I've found that you can use this line to help with that installation:

bundle config build.pg --with-cflags="-Wno-error=implicit-function-declaration"

However, the whole appraisal testing thing is a real pain. I was able to do it a different way with my other gem:

https://github.com/brendon/positioning/blob/main/.github/workflows/main.yml
https://github.com/brendon/positioning/blob/main/Gemfile

It's then easy to set up a matrix of tests across Rails, Ruby, and database libraries and only pick the compatible ones.

The downside is that this doesn't run well locally. If you want to try this way, by all means, but I realise it's quite an extra job in and of itself :) If the compile line above gets things working for you then just carry on I think :)

Hi,
I have tried a bit of everything but without much success. I have also tried testing the gem from a clear Dockerfile and also got the same error about installing 'pg' gem. The only solution I can think of is bumping 'pg' version to "~> 1.3.0" but I guess that make the gem not compatible anymore with older versions of Ruby, so that might not be an option in this case.

I think it might be time to drop support for older rails/ruby versions. Did you first want me to have a go at getting rid of the appraisals gem?

I think that would be great. I tried that too but I failed, since I don't know very well how that should be set up.

That's all good. It's fairly complicated. I've done those changes on master not and the tests pass. It just tests Rails 6.1+ and Ruby 3.0+:

https://github.com/brendon/acts_as_list/actions/runs/9310848684

Feel free to update from master and then try out the tests. You can control the Rails, Ruby and DB versions via the command line:

RAILS_VERSION=7.1 (for example)
DB=sqlite | mysql | postgresql
Ruby: You just need to use rbenv or something like that and change your .ruby-version file.

Appraisals was good but a lot of work to maintain and people also used to not understand it and just edit the automatically generated bundler files :D

You'll need to run bundle for each rails version you want to use:

RAILS_VERSION=7.1 bundle
RAILS_VERSION=7.1 DB=postgresql bundle exec rake (to run the tests)

Perfect! That worked well. I was able to successfully run the tests both locally and through the CI on my fork.

brendon

This is all looking really good. Are you able to give me a quick overview of the tests? I've tried to quickly understand them but there's quite a lot of change there. Here's what I think you've done:

You've modified the SharedList tests to be able to cope with an iteration where the keys are composite. It looks like you just set both keys to be the same integer each time for convenience?
You've kept the second dedicated suite of tests from the original PR.

Let me know if I got it wrong :)

divagueame · 2024-05-31T22:37:34Z

This is all looking really good. Are you able to give me a quick overview of the tests? I've tried to quickly understand them but there's quite a lot of change there. Here's what I think you've done:

You've modified the SharedList tests to be able to cope with an iteration where the keys are composite. It looks like you just set both keys to be the same integer each time for convenience?

You've kept the second dedicated suite of tests from the original PR.

Let me know if I got it wrong :)

I think you got quite right.
I adjusted shared_list, so that it can be reused with a model different than ListMixin,

test/shared_list.rb

def setup(mixin = ListMixin, mixinError = ListMixinError, id = :id)
...

It can be now used overriding the default Model (ListMixin) used for those test runs, like this:

test/test_list.rb

    def setup
      setup_db

      super(CompositePrimaryKeyListScoped, CompositePrimaryKeyListScopedError, :first_id)
    end

On those iterations, :first_id and :second_id will be the same for the sake of simplicity.

I left the tests of the original PR in which the model does not use scoped lists. I guess it could be possible to refactor Shared::List to account for those cases, however it would need to be further refactored adding more abstraction. I tried to test the main documented APIs from the Readme, so now I'm thinking that maybe it could be improved. Not sure. Let me know what you think about it.

brendon · 2024-06-01T05:50:52Z

I think as long as you're running the shared tests with composite keys and have covered off anything unique to composite key tests in the other suite then we're good to go. Let me know if you're happy with that decision and I'll merge :)

Do you need an immediate new version released?

divagueame · 2024-06-01T08:16:04Z

I think it's good like it is. I would say let's merge it like that.
I don't personally need a version released immediately. Just do it as usual. Not really sure how that works : )

brendon · 2024-06-01T21:47:26Z

All good. The project only seldom received updates so I'll release a new version. Are you able to add a changelog entry for me in the Unreleased section?

divagueame · 2024-06-02T15:38:07Z

Sure, just added it to the changelog.

brendon · 2024-06-02T23:14:21Z

Thanks @divagueame, this is released as 1.2.0. Looking forward to working with you on this project again in the future.

brendon · 2024-08-02T04:58:57Z

Hi @divagueame, just a heads up, in the process of adding this feature to my positioning gem I realised that Rails handles a lot of the overhead of composite primary keys for us so the implementation here can be simplified. I've committed some changes to master if you're interested :)

divagueame · 2024-08-02T08:52:20Z

Sweet! That looks neat. Thanks for the update. : )

divagueame added 3 commits May 12, 2024 16:03

Add tests for CompositePrimaryKeyList

f282b8f

Adjust query when instance has a composite primary index

8971888

Fix version tested for composite primary key

39c3e0a

brendon requested changes May 12, 2024

View reviewed changes

lib/acts_as_list/active_record/acts/list.rb Show resolved Hide resolved

divagueame added 2 commits May 14, 2024 17:09

Update primary_key_condition and use like where.not()

3a6c180

Add rails_7_1.gemfile + GH Actions Matrix

ebdeb62

brendon reviewed May 14, 2024

View reviewed changes

divagueame added 2 commits May 15, 2024 00:45

Update primary_key_condition

544d855

Refactor shared_list module

9aed3f5

divagueame commented May 15, 2024

View reviewed changes

divagueame requested a review from brendon May 15, 2024 12:04

divagueame added 3 commits May 31, 2024 12:53

Merge branch 'master' into Add-composite-primary-key-support

1fe83bb

Remove ci.yml

115ab4b

Clean previously create rails_7_1.gemfile

4645acf

divagueame force-pushed the Add-composite-primary-key-support branch from 685340b to 4645acf Compare May 31, 2024 13:32

Only create with id if it's composite primary key

8ecc8b0

divagueame force-pushed the Add-composite-primary-key-support branch from 0201a24 to 8ecc8b0 Compare May 31, 2024 14:32

brendon reviewed May 31, 2024

View reviewed changes

divagueame closed this May 31, 2024

divagueame reopened this May 31, 2024

Add Changelog entry

0d3a71b

brendon approved these changes Jun 2, 2024

View reviewed changes

brendon merged commit 58a4972 into brendon:master Jun 2, 2024
27 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add composite primary key support #430

Add composite primary key support #430

divagueame commented May 12, 2024

brendon May 14, 2024

divagueame May 14, 2024 •

edited

Loading

brendon May 15, 2024

divagueame May 15, 2024

divagueame May 15, 2024 •

edited

Loading

brendon May 15, 2024

divagueame May 30, 2024

brendon May 30, 2024

divagueame May 30, 2024

brendon May 31, 2024

brendon May 31, 2024

divagueame May 31, 2024

brendon left a comment

divagueame commented May 31, 2024 •

edited

Loading

brendon commented Jun 1, 2024

divagueame commented Jun 1, 2024

brendon commented Jun 1, 2024

divagueame commented Jun 2, 2024

brendon commented Jun 2, 2024

brendon commented Aug 2, 2024

divagueame commented Aug 2, 2024

Add composite primary key support #430

Add composite primary key support #430

Conversation

divagueame commented May 12, 2024

Choose a reason for hiding this comment

divagueame May 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

divagueame May 15, 2024 • edited Loading

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

brendon left a comment

Choose a reason for hiding this comment

divagueame commented May 31, 2024 • edited Loading

test/shared_list.rb

test/test_list.rb

brendon commented Jun 1, 2024

divagueame commented Jun 1, 2024

brendon commented Jun 1, 2024

divagueame commented Jun 2, 2024

brendon commented Jun 2, 2024

brendon commented Aug 2, 2024

divagueame commented Aug 2, 2024

divagueame May 14, 2024 •

edited

Loading

divagueame May 15, 2024 •

edited

Loading

divagueame commented May 31, 2024 •

edited

Loading