association_selection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fb7c7317ba8cf62a11d85ff6774f3ae5880069cfe57982d1b2acc2b091bce28
+  data.tar.gz: aba4e0ec50f24443a17f4a2a06a78722e29da8c2dad11f840a0297ff73184177
+SHA512:
+  metadata.gz: 47c5217acea4a685025595c0a8181b3f877a0c842ae06e342132390cb2a3e3131c2dcb86ba52ba7c4a929dbf9b35d6250d0cfd2ee11931da840a31731b98f587
+  data.tar.gz: ea5017c30fcd1faee3a680f390f01b755a066d74a4875ddf0409a6646434d68de6e797d99c8eeec1f8324993e38c1ba95e89bf28665d89f9f9b0fe93409a16a5

data/README.md

@@ -0,0 +1,100 @@
+# AssociationSelection
+
+`AssociationSelection` is a gem that allows you to specify which fields to select when preloading associations. It offers finer control over database queries, optimizing memory usage and enhancing performance by fetching only the necessary fields.
+
+Features
+---
+
+- Select specific fields for associated records when using `includes` or `preload`.
+- Seamlessly integrates with ActiveRecord.
+- Reduces memory overhead and improves query efficiency.
+
+Installation
+---
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'association_selection'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+
+```
+gem install association_selection
+```
+
+Usage
+===
+
+
+Quick Start
+---
+
+1. Include the gem in your Rails application.
+2. Use the `assoc_select` method to specify the fields to fetch for associated records.
+
+Example
+---
+#### Schema
+```ruby
+ActiveRecord::Schema.define do
+  create_table :departments do |t|
+    t.string :name
+  end
+
+  create_table :employees do |t|
+    t.integer :department_id
+    t.string :name
+    t.string :email
+    t.integer :gender
+  end
+end
+```
+
+#### Models
+```ruby
+class Department < ActiveRecord::Base
+  has_many :employees
+end
+
+class Employee < ActiveRecord::Base
+  belongs_to :department
+end
+```
+
+
+#### Query
+```ruby
+# Preload employees with only selected fields
+departments = Department.assoc_select(:employees, :id, :name).includes(:employees)
+
+departments.each do |department|
+  department.employees.each do |employee|
+    puts employee.name # Only `id` and `name` are fetched from the database.
+  end
+end
+```
+
+How It Works
+---
+The assoc_select method modifies the query to include only the specified fields for the given association. It works seamlessly with ActiveRecord's includes, preload, and eager_load methods.
+
+Compatibility
+---
+This gem is tested with ActiveRecord versions 5, 6, 7, and newer
+
+Bug reports & suggested improvements
+---
+If you have found a bug or want to suggest an improvement, please use our issue tracked at:
+
+https://github.com/vuong-khai-ha/association_selection
+
+If you want to contribute, fork the project, code your improvements and make a pull request on Github. Please don't forget to add tests.
+If your contribution is fixing a bug it would be better if you could submit a failing test, illustrating the issue.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'appraisal'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :appraisal if !ENV['APPRAISAL_INITIALIZED'] && !ENV['TRAVIS']

data/lib/association_selection/querying.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AssociationSelection
+  module Querying
+    attr_accessor :assoc_select_fields
+
+    def assoc_select(**fields)
+      spawn.tap { |s| s.assoc_select_fields = fields }
+    end
+  end
+
+  module Delegations
+    delegate :assoc_select, to: :all
+  end
+end

data/lib/association_selection/v5/preloader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module AssociationSelection
+  module V5
+    module Preloader
+      attr_accessor :relation_klass, :assoc_select_fields
+
+      NULL_RELATION = Struct.new(:values, :where_clause, :joins_values)
+                            .new({}, ::ActiveRecord::Relation::WhereClause.empty, [])
+
+      def preload(records, associations, preload_scope = nil)
+        records       = Array.wrap(records).compact.uniq
+        associations  = Array.wrap(associations)
+        preload_scope ||= nil
+
+        return [] if records.empty?
+
+        any_specified_fields = relation_klass.present? && assoc_select_fields.is_a?(Hash)
+        indexed_reflections = relation_klass.reflections.map { |k, r| [k, r.class_name] }.to_h if any_specified_fields
+        associations.flat_map do |association|
+          if any_specified_fields && indexed_reflections.key?(association.to_s)
+            preloaders_on(
+              association,
+              records,
+              indexed_reflections[association.to_s].constantize.select(assoc_select_fields[association])
+            )
+          else
+            preloaders_on association, records, preload_scope
+          end
+        end
+      end
+    end
+  end
+end

data/lib/association_selection/v5/relation.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AssociationSelection
+  module V5
+    module Relation
+      def build_preloader
+        ActiveRecord::Associations::Preloader.new.tap do |new_preloader|
+          new_preloader.assoc_select_fields = assoc_select_fields
+          new_preloader.relation_klass = model
+        end
+      end
+    end
+  end
+end

data/lib/association_selection/v6/relation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AssociationSelection
+  module V6
+    module Relation
+      def preload_associations(records) # :nodoc:
+        preload = preload_values
+        preload += includes_values unless eager_loading?
+        preloader = nil
+
+        any_specified_fields = assoc_select_fields.is_a?(Hash)
+        indexed_reflections = model.reflections.map { |k, r| [k, r.class_name] }.to_h if any_specified_fields
+        preload.each do |associations|
+          preloader ||= build_preloader
+          if any_specified_fields && indexed_reflections.key?(associations.to_s)
+            preloader.preload(
+              records,
+              associations,
+              indexed_reflections[associations.to_s].constantize.select(assoc_select_fields[associations])
+            )
+          else
+            preloader.preload records, associations
+          end
+        end
+      end
+    end
+  end
+end

data/lib/association_selection/v7/relation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module AssociationSelection
+  module V7
+    module Relation
+      def preload_associations(records) # :nodoc:
+        preload = preload_values
+        preload += includes_values unless eager_loading?
+        scope = strict_loading_value ? StrictLoadingScope : nil
+        any_specified_fields = scope.nil? && assoc_select_fields.is_a?(Hash)
+        indexed_reflections = model.reflections.map { |k, r| [k, r.class_name] }.to_h if any_specified_fields
+        preload.each do |associations|
+          if any_specified_fields && indexed_reflections.key?(associations.to_s)
+            scope = indexed_reflections[associations.to_s].constantize.select(assoc_select_fields[associations])
+          end
+          ActiveRecord::Associations::Preloader.new(records: records, associations: associations, scope: scope).call
+        end
+      end
+    end
+  end
+end

data/lib/association_selection/version.rb

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

data/lib/association_selection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'association_selection/version'
+require_relative 'association_selection/querying'
+
+module AssociationSelection
+  def self.setup
+    ActiveSupport.on_load(:active_record) do |base|
+      base.extend AssociationSelection::Delegations
+      ActiveRecord::Relation.include AssociationSelection::Querying
+
+      if ActiveRecord.version >= Gem::Version.new('7.0')
+        require_relative 'association_selection/v7/relation'
+        ActiveRecord::Relation.prepend AssociationSelection::V7::Relation
+      elsif ActiveRecord.version >= Gem::Version.new('6.0')
+        require_relative 'association_selection/v6/relation'
+        ActiveRecord::Relation.prepend AssociationSelection::V6::Relation
+      else
+        require_relative 'association_selection/v5/relation'
+        require_relative 'association_selection/v5/preloader'
+        ActiveRecord::Associations::Preloader.prepend AssociationSelection::V5::Preloader
+        ActiveRecord::Relation.prepend AssociationSelection::V5::Relation
+      end
+    end
+  end
+end
+
+AssociationSelection.setup

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: association_selection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vương Khải Hà
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-21 00:00:00.000000000 Z
+dependencies: []
+description: Provides functionality to specify fields to preload for ActiveRecord
+  associations.
+email:
+- inki.personal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/association_selection.rb
+- lib/association_selection/querying.rb
+- lib/association_selection/v5/preloader.rb
+- lib/association_selection/v5/relation.rb
+- lib/association_selection/v6/relation.rb
+- lib/association_selection/v7/relation.rb
+- lib/association_selection/version.rb
+homepage: https://github.com/vuong-khai-ha/association_selection
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: Select fields for ActiveRecord associations
+test_files: []