better_pluck 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a910349a333fa7833d93fc87015f91b11344588c3b6fc3c2635b89d9a85960
-  data.tar.gz: 3b88f50b8e75d588849954b9d27dd46f006cdb94ee70890e4f5ed87a69f14a5d
+  metadata.gz: 30cec08ad4a30c45757e0c5cc9043c5748f092b7657faae3610f17888404bb80
+  data.tar.gz: 9309acc55f803205de2fb2e0a2055df8d6b56e1d45f13ee2f0884265b67b17bd
 SHA512:
-  metadata.gz: 49329adec0a9d95bac2c321fb4dbe30b68c8c194c7bc57d4102e8ce177216ca2c9482dda07698ab90f04c5172483e8588fc81fdb13bc8d08a5b680500e67a2bb
-  data.tar.gz: 725142f9eaab1335c370d8da493463df52b473e155ef25c1428314b034e3b3126e39338b274d23e558b529f1ec745413179a3e9e19daf5c7de0eeb67ab59b318
+  metadata.gz: 524eaeb0e4f7d7c4677cf5a8fdb42a8fc5bfc6768a963c7212d6cc74aa1a61b86f144f45545d10cff6f74c61f3b12f17bd0acae7e939001b81ae7574b0c38537
+  data.tar.gz: d2c359630bfcbe6f1b71cc3115f7df5f72b2a29e72cc317bfa76753431aef46b6f001214dbca87afd82e8bf2341d88c9ef7c9eeffdab7b1fdec70b96aee16266

data/README.md

@@ -3,7 +3,7 @@
 
 Main purpose is to reduce loading into memory expensive ActiveRecord objects, where it is not needed (for read-only operations).
 
-`better_pluck` adds `pluck_with_methods`, `pluck_with_display_name` to ActiveRecord. These methods allow you to pluck not only database columns but also virtual methods and association data, returning lightweight `Struct` objects instead of heavy ActiveRecord instances.
+`better_pluck` adds `struct_pluck`, `struct_pluck_with_display_name` to ActiveRecord. These methods allow you to pluck not only database columns but also virtual methods and association data, returning lightweight `Struct` objects instead of heavy ActiveRecord instances.
 
 This approach can reduce memory usage by up to 3-20x compared to loading full ActiveRecord objects.
 
@@ -17,10 +17,6 @@ Add this line to your application's Gemfile:
 gem 'better_pluck'
 ```
 
-And then execute:
-
-    $ bundle install
-
 ## Usage
 
 ### Basic usage
@@ -29,7 +25,7 @@ You can pluck database columns and instance methods:
 
 ```ruby
 # Assuming Article has a method :name_on_site
-articles = Article.pluck_with_methods(:id, :name, :email, :name_on_site)
+articles = Article.struct_pluck(:id, :name, :email, :name_on_site)
 
 articles.first.id           # => 1
 articles.first.name_on_site  # => "My Article" (virtual method)
@@ -40,7 +36,7 @@ articles.first.name_on_site  # => "My Article" (virtual method)
 You can also pluck data from nested associations:
 
 ```ruby
-articles = Article.pluck_with_methods(
+articles = Article.struct_pluck(
   :id,
   :name,
   author: [:name, :email, :display_name]
@@ -56,24 +52,15 @@ A convenience method specifically for dropdown lists and collections:
 
 ```ruby
 # Automatically includes :display_name for the model and associations
-articles = Article.pluck_with_display_name(:id, :name, author: [:name, :email])
+articles = Article.struct_pluck_with_display_name(:id, :name, author: [:name, :email])
 
 articles.first.display_name         # => "Article Name"
 articles.first.author.display_name # => "Author Name <author@example.com>"
 ```
 
-## How it works
-
-1.  **Parsing**: It parses the requested fields to distinguish between database columns, methods, and associations.
-2.  **Joining**: It automatically applies `left_joins` for requested associations.
-3.  **Plucking**: It uses the standard ActiveRecord `pluck` to fetch only the required database columns.
-4.  **Struct Generation**: It creates a `Struct` class (cached for performance) and injects the source code of requested instance methods into it.
-5.  **Instantiation**: It maps the raw data into these `Struct` objects.
-
-
 ### select_with_joins method
 
-You can use the `select_with_joins` method which will create field aliases for associations instead of fully fetching activerecord objects for them. The main model can be selected with specific columns or fully fetched.
+You can use the `select_with_joins` method which will create field aliases for associations instead of fully fetching activerecord objects for them. The main model can be selected with specific columns or fully fetched. Main model is kept as ActiveRecord object.
 
 ```ruby
 # Example with positional arguments for base model

data/lib/better_pluck/{pluck_with_methods.rb → struct_pluck.rb}

@@ -1,12 +1,12 @@
 # this module is supposed to be included in ActiveRecord descendants
 # to reduce ram usage by converting arrays of AR objects to Struct objects
-# in particular for dropdown lists (in f.input collection: Article.pluck_with_display_name(:id,:name,:email), as: :select)
+# in particular for dropdown lists (in f.input collection: Article.struct_pluck(:id,:name,:email), as: :select)
 # also takes associations display_name from their ActiveRecord class
-# usage: zones = Zone.pluck_with_display_name(:id,:name, partner: [:имя,:email], location: [:name])
+# usage: zones = Zone.struct_pluck_with_display_name(:id,:name, partner: [:имя,:email], location: [:name])
 # zones.first.display_name, zones.first.partner.display_name
 
-#pluck_with_methods method also available where you can list any fields and methods
-#example: articles = Article.pluck_with_methods(:id, :name, :email, :name_on_site, author: [:name, :email,:display_name])
+#struct_pluck method also available where you can list any fields and methods
+#example: articles = Article.struct_pluck(:id, :name, :email, :name_on_site, author: [:name, :email,:display_name])
 #
 #in returned result you can use:
 #article.first.name_on_site, article.first.author.email, articles.first.author.display_name etc.
@@ -15,7 +15,7 @@
 
 #NK 2026-10-13, done with Gemini AI
 
-module BetterPluck::PluckWithMethods
+module BetterPluck::StructPluck
   extend ActiveSupport::Concern
 
   # Use Concurrent::Map for thread-safe caching across multiple Puma threads
@@ -23,33 +23,33 @@ module BetterPluck::PluckWithMethods
 
   class_methods do
 
-
-
-    # usage: zones = Zone.pluck_with_methods(:id, :name, :display_name, partner: [:имя, :email, :display_name], location: [:name, :display_name])
-    def pluck_with_methods(*fields_and_methods)
+    # usage: zones = Zone.struct_pluck(:id, :name, :display_name, partner: [:имя, :email, :display_name], location: [:name, :display_name])
+    def struct_pluck(*fields_and_methods)
       require "method_source" unless defined?(MethodSource)
 
-      metadata = _pluck_methods_parse_fields(self, fields_and_methods)
+      metadata = _struct_pluck_parse_fields(self, fields_and_methods)
       pluck_columns = []
-      _pluck_methods_build_columns(self, metadata, pluck_columns, self.table_name)
+      _struct_pluck_build_columns(self, metadata, pluck_columns, self.table_name)
 
-      joins_arg = _pluck_methods_build_joins(metadata)
+      joins_arg = _struct_pluck_build_joins(metadata)
 
       query = joins_arg.present? ? left_joins(joins_arg) : all
       raw_rows = query.pluck(*pluck_columns)
 
       # Root struct class
-      root_struct_klass = _pluck_methods_get_struct(metadata)
+      root_struct_klass = _struct_pluck_get_struct(metadata)
 
       raw_rows.map do |row|
         row_data = row.is_a?(Array) ? row.dup : [row]
-        _pluck_methods_instantiate(root_struct_klass, metadata, row_data)
+        _struct_pluck_instantiate(root_struct_klass, metadata, row_data)
       end
     end
 
-    # usage: zones = Zone.pluck_with_display_name(:id,:name, partner: [:имя,:email], location: [:name])
+    alias_method :pluck_with_methods, :struct_pluck
+
+    # usage: zones = Zone.struct_pluck_with_display_name(:id,:name, partner: [:имя,:email], location: [:name])
     # zones.first.display_name, zones.first.partner.display_name
-    def pluck_with_display_name(*fields_and_methods)
+    def struct_pluck_with_display_name(*fields_and_methods)
       fields_and_methods << :display_name unless fields_and_methods.include?(:display_name)
 
       processed_params = fields_and_methods.map do |arg|
@@ -64,12 +64,14 @@ module BetterPluck::PluckWithMethods
         end
       end
 
-      pluck_with_methods(*processed_params)
+      struct_pluck(*processed_params)
     end
 
+    alias_method :pluck_with_display_name, :struct_pluck_with_display_name
+
     private
 
-    def _pluck_methods_parse_fields(klass, fields)
+    def _struct_pluck_parse_fields(klass, fields)
       db_columns = []
       methods = {}
       associations = {}
@@ -88,7 +90,7 @@ module BetterPluck::PluckWithMethods
             assoc_fields = item[assoc_name]
             assoc_reflection = klass.reflect_on_association(assoc_name)
             if assoc_reflection
-              associations[assoc_name.to_sym] = _pluck_methods_parse_fields(assoc_reflection.klass, Array(assoc_fields))
+              associations[assoc_name.to_sym] = _struct_pluck_parse_fields(assoc_reflection.klass, Array(assoc_fields))
               all_fields << assoc_name.to_sym
             end
           end
@@ -119,7 +121,7 @@ module BetterPluck::PluckWithMethods
       }
     end
 
-    def _pluck_methods_build_columns(klass, metadata, list, table_alias)
+    def _struct_pluck_build_columns(klass, metadata, list, table_alias)
       metadata[:db_columns].each do |col|
         list << Arel.sql("#{klass.connection.quote_table_name(table_alias)}.#{col}")
       end
@@ -127,15 +129,15 @@ module BetterPluck::PluckWithMethods
       metadata[:associations].each do |assoc_name, sub_metadata|
         assoc_reflection = klass.reflect_on_association(assoc_name)
         # AR's left_joins usually uses the table name for the join alias unless there's a collision
-        _pluck_methods_build_columns(assoc_reflection.klass, sub_metadata, list, assoc_reflection.table_name)
+        _struct_pluck_build_columns(assoc_reflection.klass, sub_metadata, list, assoc_reflection.table_name)
       end
     end
 
-    def _pluck_methods_build_joins(metadata)
+    def _struct_pluck_build_joins(metadata)
       return nil if metadata[:associations].empty?
 
       joins = metadata[:associations].map do |assoc_name, sub_metadata|
-        sub_joins = _pluck_methods_build_joins(sub_metadata)
+        sub_joins = _struct_pluck_build_joins(sub_metadata)
         if sub_joins
           { assoc_name => sub_joins }
         else
@@ -146,7 +148,7 @@ module BetterPluck::PluckWithMethods
       joins.size == 1 ? joins.first : joins
     end
 
-    def _pluck_methods_get_struct(metadata)
+    def _struct_pluck_get_struct(metadata)
       metadata[:struct_klass] ||= begin
         # 1st list: database fields and associations
         # 2nd list: virtual methods (copied from ActiveRecord)
@@ -163,19 +165,19 @@ module BetterPluck::PluckWithMethods
       end
     end
 
-    def _pluck_methods_instantiate(struct_klass, metadata, row_data)
+    def _struct_pluck_instantiate(struct_klass, metadata, row_data)
       args = metadata[:all_fields].map do |field|
         if metadata[:db_columns].include?(field)
           row_data.shift
         elsif (sub_metadata = metadata[:associations][field])
-          sub_struct_klass = _pluck_methods_get_struct(sub_metadata)
+          sub_struct_klass = _struct_pluck_get_struct(sub_metadata)
           sub_col_count = sub_metadata[:total_db_columns]
 
           if row_data[0...sub_col_count].all?(&:nil?)
             row_data.shift(sub_col_count)
             nil
           else
-            _pluck_methods_instantiate(sub_struct_klass, sub_metadata, row_data)
+            _struct_pluck_instantiate(sub_struct_klass, sub_metadata, row_data)
           end
         else
           nil # Method field

data/lib/better_pluck/version.rb

@@ -1,3 +1,3 @@
 module BetterPluck
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/better_pluck.rb

@@ -1,11 +1,11 @@
 require "better_pluck/version"
-require "better_pluck/pluck_with_methods"
+require "better_pluck/struct_pluck"
 require "better_pluck/select_with_joins"
 
 module BetterPluck
 end
 
 ActiveSupport.on_load(:active_record) do
-  include BetterPluck::PluckWithMethods
+  include BetterPluck::StructPluck
   include BetterPluck::SelectWithJoins
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_pluck
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - NazarK
@@ -117,8 +117,8 @@ files:
 - README.md
 - better_pluck.gemspec
 - lib/better_pluck.rb
-- lib/better_pluck/pluck_with_methods.rb
 - lib/better_pluck/select_with_joins.rb
+- lib/better_pluck/struct_pluck.rb
 - lib/better_pluck/version.rb
 homepage: https://github.com/NazarK/better_pluck
 licenses: