nested_select 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295706af2c9d8f419f850ddcc81775e1ebb9708320fb6c06bd1d2fcc8f57405b
-  data.tar.gz: a9270172f9899183ca057294c5dbf358486ae7ca6cf97c2387ef3f009f4ca99c
+  metadata.gz: f7df4328a84a6701ef2081be1b647cd9f1c07442b6dfd48c580126daa369ef80
+  data.tar.gz: 17fd02a9b6f0bf767b55bae9243534030a4ccd7d524ff0c72cd3f62ab4e7b46c
 SHA512:
-  metadata.gz: 539b57d526b2d3d6a15f9bef1a8bfe104779e02c409aa64fd6765aaee0fc5b4c4a86d2a92fd44f559dbde686d5fb7713ee81e72df815aeada368fc28eeb9a480
-  data.tar.gz: e9bd63e18fd429b8e2443e3c20d34c5a37b9eb7dd9e408ded4bcee3d109c4617e15e006cec32f996aff299ac3bdbb7b0150b637a756e6d388980f8f07fcb7f58
+  metadata.gz: 413915e07ba1daa75689c3863f8b6084aaaacace89afe075aaf115a61b6c34245acee01c4eae87ec9509bf7ce0d0b38e9f4fa4a6e17d341177a71d1cb5e31d42
+  data.tar.gz: d955c8d791e58df7025998c69a43bf459c03897384c2c68658e03600ba63158678012c90fded55f35fb8acc64fa652d255381d7164077dbe9c01febddf23d1e8

data/.idea/nested_select.iml

@@ -77,21 +77,21 @@
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
         <subtasks>
-          <RakeTaskImpl description="Build nested_select-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build nested_select-0.2.0.gem into the pkg directory" fullCommand="build" id="build" />
           <RakeTaskImpl id="build">
             <subtasks>
-              <RakeTaskImpl description="Generate SHA512 checksum of nested_select-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+              <RakeTaskImpl description="Generate SHA512 checksum of nested_select-0.2.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
             </subtasks>
           </RakeTaskImpl>
           <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install nested_select-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl description="Build and install nested_select-0.2.0.gem into system gems" fullCommand="install" id="install" />
           <RakeTaskImpl id="install">
             <subtasks>
-              <RakeTaskImpl description="Build and install nested_select-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+              <RakeTaskImpl description="Build and install nested_select-0.2.0.gem into system gems without network access" fullCommand="install:local" id="local" />
             </subtasks>
           </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v0.1.0 and build and push nested_select-0.1.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Create tag v0.2.0 and build and push nested_select-0.2.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
           <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">
             <subtasks>

data/.rubocop.yml

@@ -6,3 +6,86 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Style/SingleLineMethods:
+  Description: 'Avoid single-line methods.'
+  StyleGuide: '#no-single-line-methods'
+  Enabled: false
+  VersionAdded: '0.9'
+  VersionChanged: '1.8'
+  AllowIfMethodIsEmpty: true
+
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  StyleGuide: '#english-comments'
+  Enabled: false
+  VersionAdded: '0.9'
+  VersionChanged: '1.21'
+  AllowedChars:
+    - ©
+
+Layout/LineLength:
+  Description: 'Checks that line length does not exceed the configured limit.'
+  StyleGuide: '#max-line-length'
+  Enabled: true
+  VersionAdded: '0.25'
+  VersionChanged: '1.4'
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: true
+  # The AllowedPatterns option is a list of !ruby/regexp and/or string
+  # elements. Strings will be converted to Regexp objects. A line that matches
+  # any regular expression listed in this option will be ignored by LineLength.
+  AllowedPatterns: []
+  IgnoredPatterns: [] # deprecated
+  Exclude:
+    - "./test/**/*"
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Enabled: false
+  VersionAdded: '0.25'
+  VersionChanged: '0.87'
+  CountComments: false  # count full line comments?
+  Max: 100
+  CountAsOne: []
+
+Lint/MissingCopEnableDirective:
+  Description: 'Checks for a `# rubocop:enable` after `# rubocop:disable`.'
+  Enabled: true
+  VersionAdded: '0.52'
+  # Maximum number of consecutive lines the cop can be disabled for.
+  # 0 allows only single-line disables
+  # 1 would mean the maximum allowed is the following:
+  #   # rubocop:disable SomeCop
+  #   a = 1
+  #   # rubocop:enable SomeCop
+  # .inf for any size
+  MaximumRangeSize: .inf
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods:
+    - require
+    - require_relative
+    - require_dependency
+    - yield
+    - raise
+    - puts
+  Exclude:
+    - "/**/Gemfile"
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - "./test/**/**/*"

data/ABOUT_NESTED_SELECT.md

@@ -52,7 +52,8 @@ Regardless of the major rails version and implementation, you will end up patchi
 So you just need to define a way to deliver select_values to instance of `ActiveRecord::Associations::Preloader::Association`
 
 ### How preloading happens in rails >= 7.0
-To be honest ( and opinionated :) ), current preloading implementation is a kinda mess, and we need to adapt to this mess without delivering some more.
+To be honest ( and opinionated :) ), current preloading implementation is messy, 
+and we need to adapt to this mess without delivering some more.
 
 Let's look at the scopes example from a specs:
 ```ruby
@@ -83,5 +84,5 @@ To be able to select limited attributes sets, we need to deliver them to `Associ
 
 **_Rem:_** Each `Preloader::ThroughAssociation` object creates it's own `Preloader` and starts additional 'isolated' preloading process.
 
-The implementation of nested_seelct adds a `nested_select_values` attributes into instances of `Preloader`, `Branch`, `Association` hierarchy 
+The implementation of nested_select adds a `nested_select_values` attributes into instances of `Preloader`, `Branch`, `Association` hierarchy 
 and some methods to populate corresponding select_values over the tree, trying to be as less invasive as it could be.

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.3.0] - 2025-01-25
+
+- nested_select belongs_to limitation now prevents accidental foreign_key absence 
+- primary keys are no longer need to be nested_selected
+- nested selects will combine all selections on multiple select invocations like the usual select values does 
+- tests restructured 
+- test/README added
+- removed biolerplates for basic selection ( you don't need to specify "table.*" in the root collection seletc )
+
 ## [0.2.0] - 2025-01-25
 
 - Tests are now a part of this repo 

data/README.md

@@ -1,11 +1,9 @@
 # WIP disclaimer
-The gem is under active development now. As of version 0.2.0 you are safe to try in your prod console 
-to uncover it's potential, and try in dev/test env. 
-
-Use in prod with caution only if you are properly covered by your CI.
+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 to select attributes of relations during preloading process, leading to less RAM and CPU usage.
+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.
 
 Given: 
@@ -79,18 +77,56 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 Assume you have a relation users <- profile, and you want to preview users in a paginated feed, 
-and you need only :photo attribute of a profile, with nested_select you can do it like this:  
+and you need only :photo_url attribute of a profile, with nested_select you can do it like this:  
 
 ```ruby
-# this will preload profile with exact attributes: :id, :user_id and :photo
-User.includes(:profile).select(profile: :photo).limit(10)
+class User
+  has_one :profile
+end
+
+class Profile
+  belongs_to :user
+end
+
+# this will preload profile with exact attributes: 
+# :id -- since its a primary key, 
+# :user_id -- since its a foreign_key
+# and the :photo_url as requested
+User.includes(:profile).select(profile: :photo_url).limit(10)
 ```
 
 ## Safety
 How safe is the partial model loading? Earlier version of rails and activerecord would return nil in the case, 
 when attribute wasn't selected from a DB, but rails 6 started to raise a ActiveModel::MissingAttributeError. 
 So the major problem is already solved -- your code will not operate based on falsy blank values, it will raise an exception. 
-Just cover your actions with proper tests and you are safe. 
+
+## belongs_to foreign keys limitations 
+Rails preloading happens from loaded record to their reflection step by step. 
+That's makes pretty easy to include foreign keys for has_* relations, and very hard for belongs_to, 
+to work this out you need to analyze includes based on the already loaded records, analyze and traverse their relations.
+This needs a lot of monkey patching, and for now I decided not to gow this way.
+That means in case when nesting selects based on belongs_to reflections, 
+you'll need to select their foreign keys **EXPLICITLY!** 
+
+```ruby
+class Avatar < ApplicationRecord
+  belongs_to user
+  has_one :image
+end
+
+class Image < ApplicationRecord
+  belongs_to :avatar
+end
+
+Image.includes(avatar: :user).select(avatar: [:id, :size, { user: [:email] }]).load # <--- will raise a Missing Attribute exception 
+
+#> ActiveModel::MissingAttributeError: Parent reflection avatar was missing foreign key user_id in nested selection
+#> while trying to preload belongs_to reflection named user.
+#> Hint: didn't you forgot to add user_id inside [:id, :size]?
+
+Image.includes(avatar: :user).select(avatar: [:id, :size, :user_id, { user: [:email] }]).load
+```
+
 
 ## Testing
 
@@ -98,15 +134,24 @@ Just cover your actions with proper tests and you are safe.
 docker compose run test 
 ```
 
-## Development
+## TODO
+- [ ] Cover all relation combinations and add missing functionality
+  - [x] Ensure relations foreign keys are present on the selection
+  - [x] Ensure primary key will be added
+  - [-] Ensure belongs_to will add a foreign_key column
+- [ ] Optimize through relations ( since they loading a whole set of attributes )
+- [ ] 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
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nested_select. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/nested_select/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/nested_select. This project is intended to be a safe, 
+welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/nested_select/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/nested_select/deep_merger.rb

@@ -0,0 +1,18 @@
+module NestedSelect
+  module DeepMerger
+
+    # {user_profile: [:zip_code]} + {user_profile: [:bio]} -> { user_profile: [:zip_code, :bio] }
+    refine Hash do
+      def deep_combine(other)
+        merge!(other.except(*keys))
+        merge!(other.slice(*keys).map{ |key, value| [key, [self[key], value].flatten.deep_combine_elements]}.to_h )
+      end
+    end
+
+    refine Array do
+      def deep_combine_elements
+        [*grep_v(Hash), grep(Hash).inject(&:deep_combine)].uniq.compact
+      end
+    end
+  end
+end

data/lib/nested_select/preloader/association.rb

@@ -4,14 +4,12 @@ module NestedSelect
       attr_reader :nested_select_values
 
       def build_scope
-        nested_select_values.blank? ? super
-          : super.select(*nested_select_values)
+        nested_select_values.blank? ? super : super.select(*nested_select_values)
       end
 
       def apply_nested_select_values(partial_select_values)
         foreign_key = reflection.foreign_key unless reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
-
-        @nested_select_values = [*partial_select_values, *foreign_key].uniq
+        @nested_select_values = [*partial_select_values, *foreign_key, *reflection.klass.primary_key].uniq
       end
     end
   end

data/lib/nested_select/preloader/branch.rb

@@ -4,11 +4,29 @@ module NestedSelect
     module Branch
       attr_accessor :nested_select_values
       def preloaders_for_reflection(reflection, reflection_records)
+        prevent_belongs_to_foreign_key_absence!(reflection)
+
         super.tap do |ldrs|
           ldrs.each{ _1.apply_nested_select_values(nested_select_values) } if nested_select_values.present?
         end
       end
 
+      private
+      def prevent_belongs_to_foreign_key_absence!(reflection)
+        return unless reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+
+        # ActiveRecord will not raise in case its missing, so we should prevent silent error here
+        if parent.nested_select_values.present? &&
+          !parent.nested_select_values.map(&:to_sym).include?( reflection.foreign_key.to_sym )
+
+          raise ActiveModel::MissingAttributeError, <<~ERR
+            Parent reflection #{parent.association} was missing foreign key #{reflection.foreign_key} in nested selection,
+            while trying to preload belongs_to reflection named #{reflection.name}. 
+            Hint: didn't you forgot to add #{reflection.foreign_key} inside #{parent.nested_select_values}?
+          ERR
+        end
+      end
+
     end
   end
 end

data/lib/nested_select/preloader.rb

@@ -9,8 +9,8 @@ module NestedSelect
 
     included do
       ActiveRecord::Associations::Preloader::Branch.prepend(Branch)
-      ActiveRecord::Associations::Preloader::ThroughAssociation.prepend( ThroughAssociation )
-      ActiveRecord::Associations::Preloader::Association.prepend( Association )
+      ActiveRecord::Associations::Preloader::ThroughAssociation.prepend(ThroughAssociation)
+      ActiveRecord::Associations::Preloader::Association.prepend(Association)
     end
     def apply_nested_select_values(nested_select_values)
       distribute_nested_select_over_loading_tree(@tree, nested_select_values)
@@ -26,8 +26,8 @@ module NestedSelect
       # it could be a case when selection tree is not that deep than Branch tree.
       return if sub_nested_select_values.blank?
 
-      sub_tree.children.each do
-        distribute_nested_select_over_loading_tree( _1, sub_nested_select_values[_1.association])
+      sub_tree.children.each do |chld_brnch|
+        distribute_nested_select_over_loading_tree(chld_brnch, sub_nested_select_values[chld_brnch.association])
       end
     end
   end

data/lib/nested_select/relation.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
+require_relative "deep_merger"
 
 module NestedSelect
   module Relation
+    using ::NestedSelect::DeepMerger
 
     attr_accessor :nested_select_values
     def select(*fields)
-      @nested_select_values = fields.grep(Hash)
-      super(*fields.grep_v(Hash))
+      # {user_profile: [:zip_code]} + {user_profile: [:bio]} -> { user_profile: [:zip_code, :bio] }
+      @nested_select_values = [*@nested_select_values, *fields.grep(Hash)].deep_combine_elements
+      fields.grep_v(Hash).present? ? super(*fields.grep_v(Hash)) : self
     end
 
     def preload_associations(records) # :nodoc:

data/lib/nested_select/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NestedSelect
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/nested_select.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 require_relative "nested_select/version"
 
 module NestedSelect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nested_select
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ActiveRecord improved select on nested models, allows partial instantiation
   on nested models, easy one step improvements on performance and memory
 email:
@@ -188,6 +202,7 @@ files:
 - Rakefile
 - docker-compose.yml
 - lib/nested_select.rb
+- lib/nested_select/deep_merger.rb
 - lib/nested_select/preloader.rb
 - lib/nested_select/preloader/association.rb
 - lib/nested_select/preloader/branch.rb