nested_select 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4307dec9a6ddcdc24842d6c3f155b2c2d9e64cc6a1f66049134ad80ef2cde41
+  data.tar.gz: 7c8fca2b94e90e6361d54c4dfe51d444a42fb60d0be48c487978a98ddf1eb1a0
+SHA512:
+  metadata.gz: 40421aa19cf4f21d42326e9e350f83282fa51d82f49945367265864e2761af9d4c72499cabf82be93cdb2d80486c2593f5df3dd6d218b49c3868b72b8f13a701
+  data.tar.gz: 4133532cf6a4884b0195212cb2f1eb36a0b326bda5defd5d2498def327d89692d9df86487df40e59c7becfceddde3124ca02db0babd930c5b4f19314a8c6f09e

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,5 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="PROJECT_PROFILE" />
+  </settings>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="NodePackageJsonFileManager">
+    <packageJsonPaths />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 alekseyl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+## Nested Select patch
+
+### How preloading happens in rails and when is the best time to interfere
+
+**Preloading** is a part of activerecord which tends to change pretty often.
+Practically all major releases interfere preloader code, the current implementation was introduced starting rails 7.0 version.
+But if you get the idea of current implementation, you can traverse the earlier state and get the idea how to make them work with nested select:
+Regardless of the major rails version and implementation, you will end up patching the `build_scope` method of
+`ActiveRecord::Associations::Preloader::Association`!
+
+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.
+
+Let's look at the scopes example:
+```ruby
+# user <-habtm-> bought_items
+# user -> has_one -> user_profile -> has_many -> avatars
+User.includes( :bought_items, user_profile: :avatars)
+```
+
+Preloading will create instances `Preloader` objects for:
+- each isolated preloading `Branch` which started from the root, in this case: `:bought_items` and `user_profile: :avatars`
+- each trough relation inside preloading tree, including hidden ones like habtm relation does.
+
+Each `Preloader` object building it's own preloader tree from a set of `Branch` objects.
+In a given case it might roughly look like this:
+```
+Preloader(:bought_items) -> Branch(:root) 
+                              \__ Branch(:bought_items) -> Preloader::ThroughAssociation(:bought_items)
+                              
+Preloader(user_profile: :avatars) -> Branch(:root) 
+                                        \__ Branch(:user_profile) -> Preloader::Association(:user_profile)
+                                              \__Branch(:avatars) -> Preloader::Association(:avatars)                          
+```
+
+Each `Branch` will create a set of loaders objects of `Preloader::Association` or `Preloader::ThroughAssociation`
+Then running all of them will preload nested records and establish a connections between records.
+
+To be able to select limited attributes sets, we need to deliver them to `Association` level objects, and patch `build_scope` method with it.
+
+**_Rem:_** Each `Preloader::ThroughAssociation` object creates it's own `Preloader` and starts additional 'isolated' preloading process.
+
+So implementation adds a `nested_select_values` attributes into instances of `Preloader`, `Branch`, `Association` hierarchy and some methods to populate corresponding select_values over the tree.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. 
+Please do not do it earlier due to security reasons. 
+Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nested_select
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NestedSelect project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nested_select/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/nested_select/preloader/association.rb

@@ -0,0 +1,17 @@
+module NestedSelect
+  module Preloader
+    module Association
+      attr_reader :nested_select_values
+
+      def build_scope
+        nested_select_values.blank? ? super
+          : super.select(*nested_select_values)
+      end
+
+      def apply_nested_select_values( partial_select_values )
+        @nested_select_values = [*partial_select_values, reflection.foreign_key].uniq
+      end
+    end
+  end
+end
+

data/lib/nested_select/preloader/branch.rb

@@ -0,0 +1,14 @@
+# TODO describe Branch dedications
+module NestedSelect
+  module Preloader
+    module Branch
+      attr_accessor :nested_select_values
+      def preloaders_for_reflection(reflection, reflection_records)
+        super.tap do |ldrs|
+          ldrs.each{ _1.apply_nested_select_values(nested_select_values) } if nested_select_values.present?
+        end
+      end
+
+    end
+  end
+end

data/lib/nested_select/preloader/through_association.rb

@@ -0,0 +1,23 @@
+module NestedSelect
+  module Preloader
+    module ThroughAssociation
+      def through_preloaders
+        @through_preloaders ||= ActiveRecord::Associations::Preloader.new(
+          records: owners,
+          associations: through_reflection.name,
+          scope: through_scope,
+          associate_by_default: false,
+          ).tap { _1.apply_nested_select_values(nested_select_values) }.loaders
+      end
+
+      def apply_nested_select_values( partial_select_values )
+        return super unless reflection.parent_reflection.is_a?( ActiveRecord::Reflection::HasAndBelongsToManyReflection )
+
+        # when parent reflection is a HasAndBelongsToManyReflection,
+        # then we don't need foreign_key to be included, as it does in super
+        @nested_select_values = partial_select_values
+      end
+    end
+  end
+end
+

data/lib/nested_select/preloader.rb

@@ -0,0 +1,34 @@
+module NestedSelect
+  module Preloader
+    extend ActiveSupport::Autoload
+    extend ActiveSupport::Concern
+
+    autoload :Branch, "brest/nested_select/preloader/branch"
+    autoload :ThroughAssociation, "brest/nested_select/preloader/through_association"
+    autoload :Association, "brest/nested_select/preloader/association"
+
+    included do
+      ActiveRecord::Associations::Preloader::Branch.prepend(Branch)
+      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)
+    end
+
+    def distribute_nested_select_over_loading_tree(sub_tree, nested_select_values)
+      #  nested_select_values = [:id, :title, comments: [:id, :body], cover: [:id, img: [:url]]]
+      return if nested_select_values.blank?
+
+      sub_tree.nested_select_values = nested_select_values.grep_v(Hash)
+      # sub_nested_select_values = { comments: [:id, :body], cover: [:id, img: [:url]] }
+      sub_nested_select_values = nested_select_values.grep(Hash).inject(&:merge)&.symbolize_keys
+      # 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])
+      end
+    end
+  end
+end

data/lib/nested_select/relation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NestedSelect
+  module Relation
+
+    attr_accessor :nested_select_values
+    def select(*fields)
+      @nested_select_values = fields.grep(Hash)
+      super(*fields.grep_v(Hash))
+    end
+
+    def preload_associations(records) # :nodoc:
+      preload = preload_values
+      preload += includes_values unless eager_loading?
+      scope = strict_loading_value ? StrictLoadingScope : nil
+      preload.each do |associations|
+        ActiveRecord::Associations::Preloader.new(records:, associations:, scope:)
+                                             .tap{ _1.apply_nested_select_values(nested_select_values) } # <-- Patching code
+                                             .call
+      end
+    end
+  end
+
+end

data/lib/nested_select/version.rb

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

data/lib/nested_select.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "nested_select/version"
+
+module NestedSelect
+  extend ActiveSupport::Autoload
+
+  autoload :Relation, "nested_select/relation"
+  autoload :Preloader, "nested_select/preloader"
+
+  ActiveRecord::Relation.prepend(Relation)
+  ActiveRecord::Associations::Preloader.include(Preloader)
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/nested_select.rbs

@@ -0,0 +1,4 @@
+module NestedSelect
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: nested_select
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alekseyl
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+description: ActiveRecord improved select on nested models, allows partial instantiation
+  on nested models, easy one step improvements on performance and memory
+email:
+- leshchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/inspectionProfiles/profiles_settings.xml"
+- ".idea/misc.xml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nested_select.rb
+- lib/nested_select/preloader.rb
+- lib/nested_select/preloader/association.rb
+- lib/nested_select/preloader/branch.rb
+- lib/nested_select/preloader/through_association.rb
+- lib/nested_select/relation.rb
+- lib/nested_select/version.rb
+- sig/nested_select.rbs
+homepage: https://github.com/alekseyl/nested_select
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/alekseyl/nested_select
+  source_code_uri: https://github.com/alekseyl/nested_select
+  changelog_uri: https://github.com/alekseyl/nested_select/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActiveRecord improved select on nested models, allows partial instantiation
+  on nested models, easy one step improvements on performance and memory
+test_files: []