nested_select 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b07e539c2e4dd0ab26ae3991c3af0cf5943601dae0c538774cff62ac9709db21
-  data.tar.gz: af8cdda70c7dfff3b6fe1feba72d39b5c8bcf372c285ef6110d4f45fa471fbee
+  metadata.gz: 90b648bcd4371a277e27841b52d173fa0951c49a8fa89e1e3894ce1e2c4a0a02
+  data.tar.gz: effb7e1afb4b609ff812ca1aaf7803eb6e65b2729650399656335fc1adee35a9
 SHA512:
-  metadata.gz: ebbc597b3ecf57cb80da6cff33852a7dff935cb8b8fcd30d2d5223dcfb54b31c415b80df0c05bb48a46ea6bd4f54d158e1a68c3516d3014622b3fc3ebaf81744
-  data.tar.gz: 0aebc50d2cb3dcd2363dd6167f30dc479f0c415e6b5cc1786e623c0cb8be3544df9c4aae2426f77ed5c5fe335b1c2986a8587d5910ba7d8e30fe6cbb516ceb5d
+  metadata.gz: 2d21c76feffd32cfb7950edd49027e0082a91a6473ad6713eb109fdf2285f42091f8bbbf034ab1c4b5a37c5119ae27ce678fd983a73dc99002cb8c832203ef83
+  data.tar.gz: cac45499b8c4748a80bf91210538216764400ede85f84fcf9afc3f1308f73822edfa0c3cfb5a9dbbc1b45fc48b8bb7a8ea7f720a34a7731a0e19f2b5cb1c16ff

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0.0"
+end
+
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.3"
+end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+end
+
+appraise "rails-8" do
+  gem "rails", ">= 8"
+end

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.4.4] - 2025-05-09
+- fixed appraisals and local docker compose
+- 
+
+## [0.4.3] - 2025-05-09
+- fixed regression on through scopes whenever nested_select_values are blank
+
+## [0.4.2] - 2025-03-01
+- Refactoring
+- Removed all commented out code
+
+## [0.4.1] - 2025-03-01
+- Appraisal added as a development dependency
+- added github CI 
+
+## [0.4.0] - 2025-02-09
+- through relations are now also supported and allowed to partial selection via reverse nested_selection tree
+- README updated with more examples and corner cases
+- nested_select will prevent multiple partial instantiation with different attributes
+
 ## [0.3.0] - 2025-01-25
 
 - nested_select belongs_to limitation now prevents accidental foreign_key absence 

data/Dockerfile_apprsl

@@ -0,0 +1,25 @@
+FROM ruby:3.2-bullseye
+
+WORKDIR /app
+RUN  apt-get update && apt-get -y install lsb-release
+#
+RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    apt-get update && apt-get -y install postgresql postgresql-client-14
+
+RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/$(ls /etc/postgresql)/main/pg_hba.conf' && \
+    service postgresql start && \
+    psql -U postgres -c 'CREATE DATABASE "niceql-test"'
+
+RUN gem install bundler
+
+COPY lib/nested_select/version.rb /app/lib/nested_select/version.rb
+COPY nested_select.gemspec /app/
+COPY Gemfil* /app/
+
+#
+RUN bundle install
+
+COPY gemfiles /app/
+COPY Appraisals /app/
+RUN appraisal install

data/README.md

@@ -1,18 +1,15 @@
-# WIP disclaimer
-The gem is under active development now. 
-Use in prod with caution only if you are properly covered by your CI. 
-Read **Safety** and **Limitations** sections before.
-
 # Nested select -- 7 times faster and 33 times less RAM on preloading relations with heavy columns!
-nested_select allows the partial selection of the relations attributes during preloading process, leading to less RAM and CPU usage.
-Here is a benchmark output for a [gist I've created](https://gist.github.com/alekseyl/5d08782808a29df6813f16965f70228a) to emulate real-life example: displaying a course with its structure.
+nested_select allows the partial selection of the relations attributes during preloading process, 
+leading to less RAM and CPU usage.
+Here is a benchmark output for a [gist I've created](https://gist.github.com/alekseyl/5d08782808a29df6813f16965f70228a) to run real-life example: 
+displaying a course with its structure.
 
 Given: 
-- Models are Course, Topic, Lesson. 
+- Models are: Course, Topic, Lesson. 
 - Their relations has a following structure: course has_many topics, each topic has_many lessons. 
 - To display a single course you need its structure, minimum data needed: topic and lessons titles and ordering.
 
-**Single course**, a real prod set of data used by current UI (~ x33 times less RAM):
+**Single course**, a real example against production data and a real flow (~ x33 times less RAM):
 
 ```
 irb(main):216:0>compare_nested_select(ids, 1, silence_ar_logger_for_memory_profiling: false)
@@ -26,7 +23,7 @@ simple includes  0.209188   0.058340   0.267528 (  0.903893)
 # partial selection
 D, [2025-01-12T19:08:36.163282 #503] DEBUG -- :   Topic Load (4.1ms)  SELECT "topics"."id", "topics"."position", "topics"."title", "topics"."course_id" FROM "topics" WHERE "topics"."deleted_at" IS NULL AND "topics"."course_id" = $1  [["course_id", 1624]]                                                                 
 D, [2025-01-12T19:08:36.168803 #503] DEBUG -- :   Lesson Load (3.9ms)  SELECT "lessons"."id", "lessons"."title", "lessons"."topic_id", "lessons"."position", "lessons"."topic_id" FROM "lessons" WHERE "lessons"."deleted_at" IS NULL AND "lessons"."topic_id" = $1  [["topic_id", 7297]]                                      
-# includes in full 
+# selects in full 
 D, [2025-01-12T19:08:37.220379 #503] DEBUG -- :   Topic Load (4.2ms)  SELECT "topics"."id", "topics"."position", "topics"."title", "topics"."course_id" FROM "topics" WHERE "topics"."deleted_at" IS NULL AND "topics"."course_id" = $1  [["course_id", 1624]]                                                                 
 D, [2025-01-12T19:08:37.247484 #503] DEBUG -- :   Lesson Load (25.7ms)  SELECT "lessons".* FROM "lessons" WHERE "lessons"."deleted_at" IS NULL AND "lessons"."topic_id" = $1  [["topic_id", 7297]]
 
@@ -41,8 +38,8 @@ RAM ratio improvements x33.54678126442086 on retain objects
 RAM ratio improvements x15.002820281285949 on total_allocated objects
 ```
 
-**100 courses**, this is kinda a synthetic example (there is no UI for multiple courses display with their structure) 
-on the real prod data, but the bigger than needed collection (x7 faster):
+**100 courses**, this is kinda a synthetic example since there is no UI for multiple courses
+display together with their structures. It executed against the real production data. (nested select serves x7 faster):
 
 ```
 irb(main):280:0> compare_nested_select(ids, 100)
@@ -66,9 +63,8 @@ RAM ratio improvements x15.57707431190517 on retain objects
 RAM ratio improvements x11.836000856510193 on total_allocated objects
 ```
 
-Despite this little click bait it's pretty obvious that it might not be even the biggest numbers, 
-if you have heavy relations instantiation for heavy views or reports generation, 
-and you want it to be less demanding in RAM and CPU -- you should try nested_select
+**Summary:** if you have CPU/RAM bottlenecks, heavy relations instantiation for heavy views or reports generation, 
+and you want it to be less demanding in RAM and CPU -- you should try nested_select. 
 
 ## Installation
 
@@ -102,10 +98,11 @@ end
 User.includes(:profile).select(profile: :photo_url).limit(10)
 ```
 
-### Partial through relations preloading
-Whenever you are using through relations between models rails will fully load all intermediate objects under the hood,
-that is definitely wastes lots of RAM, CPU including those on the DB side. 
-You can limit through objects only to relation columns. 
+### Partial preloading of through relations 
+Whenever you are using `through` relations between models and running preload, 
+then rails will fully load all intermediate objects under the hood!
+That is definitely wastes lots of RAM, CPU including those on the DB side. 
+With nested_select you can apply selections to `through` relations. 
 Ex:
 
 ```ruby
@@ -115,11 +112,11 @@ class User
 end
 
   # pay attention user_profile relation, wasn't included explicitly, 
-  # but still rails needed to be preloaded to match and preload avatars here
+  # but still rails needed them to be preloaded to be able to match and preload avatars
   user = User.includes(:avatars)
              .select(avatars: [:img_url, { user_profile: [:zip_code] }]).first
   
-  # Now user - loaded fully
+  # user - loaded fully
   # avatars - foreign and primary keys needed to establish relations + img_url
   # user_profile - foreign and primary keys + zip_code
 ```
@@ -135,15 +132,24 @@ class User
   has_many :through_avatar_images, through: :avatars, class_name: :Image, source: :images
 end
 
-  # only through_avatar_images is matter here, and we want everything 
+  # only through_avatar_images is matter here, and we want everything else to be as small as possible
   user = User.includes(:through_avatar_images)
-             .select(through_avatar_images: ["images.*", avatars: [user_profile: [:id]]]).first
+             .select(through_avatar_images: [avatars: [:id, user_profile: [:id]]]).first
   
   # through_avatar_images -- loaded in full
   # avatars, user_profile -- only relations columns id, user_profile_id e.t.c
 ```
-**REM** As for version 0.4.0 for the earliest relation in a through chain you need to select something, 
-otherwise nested_select will select everything ))
+
+**REM** There was an idea for through relations use a skinny approach: no nested attributes means, 
+only relation keys should be loaded:
+
+```ruby
+  user = User.includes(:through_avatar_images)
+             .select(through_avatar_images: [avatars: :user_profile]).first
+```
+but that could be easily confused with normal flow behaviour, so I stick to basic default: no nested attributes,
+means default behaviour, i.e. all attributes. 
+
 
 # Safety
 How safe is the partial model loading? Earlier version of rails and activerecord would return nil in the case, 
@@ -177,10 +183,6 @@ This needs a lot of monkey patching, and for now I decided not to go this way.
 That means in case when nesting selects based on belongs_to reflections, 
 you'll need to select their foreign keys **EXPLICITLY!** 
 
-## will not work with ar_lazy_preload
-Right now it will not work with ar_lazy_preload gem. nested_select relies on the includes_values definition 
-of a relation. If you are doing it in a lazy way, there weren't any explicit includes, that means it will not extract any nested selection.
-
 ```ruby
 class Avatar < ApplicationRecord
   belongs_to user
@@ -200,6 +202,10 @@ Image.includes(avatar: :user).select(avatar: [:size, { user: [:email] }]).load #
 Image.includes(avatar: :user).select(avatar: [:size, :user_id, { user: [:email] }]).load
 ```
 
+## will not work with ar_lazy_preload
+Right now it will not work with ar_lazy_preload gem. nested_select relies on the includes_values definition
+of a relation. If you are doing it in a lazy way, there weren't any explicit includes, that means it will not extract any nested selection.
+
 ## Testing
 
 ```bash
@@ -212,7 +218,7 @@ docker compose run test
   - [x] Ensure primary key will be added
   - [-] Ensure belongs_to will add a foreign_key column (Too hard to manage :(, its definitely not a low hanging fruit)
 - [x] Optimize through relations ( since they loading a whole set of attributes )
-- [ ] Separated rails version testing
+- [x] Separated rails version testing
 - [x] Merge multiple nested selections 
 - [x] Don't apply any selection if blank ( allows to limit only part of subselection tree)
 - [x] Allows to use custom attributes

data/docker-compose.yml

@@ -10,4 +10,13 @@ services:
       - './test:/app/test'
       - './Gemfile:/app/Gemfile'
       - './Gemfile.lock:/app/Gemfile.lock'
+      - './gemfiles:/app/gemfiles'
 
+  appraisal:
+    build:
+      context: .
+      dockerfile: Dockerfile_apprsl
+    image: nested_select_appraisal
+    command: /bin/bash -c 'appraisal install && appraisal rake test'
+    volumes:
+      - '.:/app'

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.16"
+gem "rubocop", "~> 1.21"
+gem "rails", "~> 7.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile.lock

@@ -0,0 +1,219 @@
+PATH
+  remote: ..
+  specs:
+    nested_select (0.4.4)
+      activerecord (>= 7)
+      activesupport (>= 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      actionview (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.8.7)
+      actionview (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.8.7)
+      activesupport (= 7.0.8.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.8.7)
+      activesupport (= 7.0.8.7)
+      globalid (>= 0.3.6)
+    activemodel (7.0.8.7)
+      activesupport (= 7.0.8.7)
+    activerecord (7.0.8.7)
+      activemodel (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+    activestorage (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.8.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    amazing_print (1.7.2)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.2.0)
+    builder (3.3.0)
+    byebug (12.0.0)
+    concurrent-ruby (1.3.5)
+    crass (1.0.6)
+    date (3.4.1)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    net-imap (0.5.8)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    niceql (0.6.1)
+    nio4r (2.7.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rack (2.2.13)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails (7.0.8.7)
+      actioncable (= 7.0.8.7)
+      actionmailbox (= 7.0.8.7)
+      actionmailer (= 7.0.8.7)
+      actionpack (= 7.0.8.7)
+      actiontext (= 7.0.8.7)
+      actionview (= 7.0.8.7)
+      activejob (= 7.0.8.7)
+      activemodel (= 7.0.8.7)
+      activerecord (= 7.0.8.7)
+      activestorage (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      bundler (>= 1.15.0)
+      railties (= 7.0.8.7)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    rails-i18n (7.0.10)
+      i18n (>= 0.7, < 2)
+      railties (>= 6.0.0, < 8)
+    rails_sql_prettifier (7.0.7)
+      activerecord (>= 7)
+      niceql (~> 0.6)
+    railties (7.0.8.7)
+      actionpack (= 7.0.8.7)
+      activesupport (= 7.0.8.7)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.75.4)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-shopify (2.17.0)
+      rubocop (~> 1.62)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3-x86_64-linux)
+    stubberry (0.3.0)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  x86_64-linux-gnu
+
+DEPENDENCIES
+  amazing_print
+  appraisal
+  bundler (>= 1.11)
+  byebug
+  minitest (~> 5.16)
+  nested_select!
+  rails (~> 7.0.0)
+  rails-i18n (>= 4)
+  rails_sql_prettifier
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-shopify
+  sqlite3
+  stubberry
+
+BUNDLED WITH
+   2.6.8

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.16"
+gem "rubocop", "~> 1.21"
+gem "rails", "~> 7.1.3"
+
+gemspec path: "../"