preload_pluck 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a3f1d75e72b1ac020ff2482bcd6ca4f6e6567ef
+  data.tar.gz: 6b6aa4f06b7d7cb0acd732829053e182751d35ae
+SHA512:
+  metadata.gz: a0716aafcb1a5bc1bd95dad6e07b7ec14004c1d38fd56126e6c6601da3b0609964525f0cb52be4a2714274b45ec9474d81ab718f5e74c7dedd3e3c2b99e49df2
+  data.tar.gz: 366240a3423b5a52bd4b6c60dd587a218a54e49f7b1999d5891a328268747026dc00abbfb8e629e14b469445bff834d82b07ef136f38618af7334dacbefe5102

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright Assetricity, LLC
+
+The MIT License (MIT)
+
+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,49 @@
+# Preload Pluck
+
+[![Build Status](https://travis-ci.org/assetricity/preload_pluck.png)](https://travis-ci.org/assetricity/preload_pluck)
+[![Dependency Status](https://gemnasium.com/assetricity/preload_pluck.png)](https://gemnasium.com/assetricity/preload_pluck)
+
+Adds a `preload_pluck` method to ActiveRecord that allows querying using Rails 4 eager loading-style for joined tables (`preload`), and returns a 2-dimensional array without ActiveRecord model creation overhead (`pluck`).
+
+Note: Preload Pluck may not always increase query performance - always benchmark with your own queries and production data.
+
+## Install
+
+Add to the preload_pluck gem to your Gemfile:
+
+```ruby
+gem 'preload_pluck'
+```
+
+## Usage
+
+Call `preload_pluck` after any SQL conditions (e.g. where clauses, scopes, orders, limits) have been applied and pass immediate attributes or traverse nested `belongs_to` associations.  
+
+```ruby
+Comment.order(:created_at).preload_pluck(:text, 'user.name')
+```
+
+See `spec/preload_pluck_spec.rb` for more examples.
+
+## Running Tests
+
+SQLite must be installed before running tests.
+
+To run tests:
+
+```
+bundle install
+rspec spec
+```
+
+By default, performance tests are disabled as it takes several minutes to insert data. To run performance tests:
+
+```
+rspec spec --tag performance
+```
+
+## License
+
+Copyright [Assetricity, LLC](http://assetricity.com)
+
+Preload Pluck is released under the MIT License. See [LICENSE](https://github.com/assetricity/preload_pluck/blob/master/LICENSE) for details.

data/lib/preload_pluck/version.rb

@@ -0,0 +1,3 @@
+module PreloadPluck
+  VERSION = '0.1.1'
+end

data/lib/preload_pluck.rb

@@ -0,0 +1,118 @@
+require 'preload_pluck/version'
+require 'active_record'
+
+module PreloadPluck
+  class Field < Struct.new(:base_class, :path)
+    def nested?(level)
+      level + 2 <= path.length
+    end
+
+    def level?(level)
+      !!path[level]
+    end
+
+    def path_upto(level)
+      path[0..level].join('.')
+    end
+
+    def assoc(level)
+      return nil if level >= path.length
+      current_class = base_class
+      assoc = nil
+      (level + 1).times do |l|
+        assoc = current_class.reflect_on_association(path[l])
+        raise 'preload_pluck only supports belongs_to associations' unless assoc.macro == :belongs_to
+        current_class = assoc.class_name.constantize
+      end
+      assoc
+    end
+  end
+
+  def preload_pluck(*args)
+    fields = args.map {|arg| Field.new(self, arg.to_s.split('.'))}
+
+    plucked_cols = fields.map do |field|
+      if field.nested?(0)
+        field.assoc(0).foreign_key
+      else
+        field.path.last
+      end
+    end.uniq
+    data = pluck(*plucked_cols)
+    if fields.length == 1
+      # Pluck returns a flat array if only one value, so use a consistent structure if there is one or multiple fields
+      data.map! {|val| [val]}
+    end
+    data = __preload_pluck_to_attrs(data, plucked_cols)
+
+    # A cache of records that we populate then join to later based on foreign keys
+    joined_data = {}
+
+    # Incrementally process nested fields by level
+    max_level = fields.map {|f| f.path.length - 1}.max
+    max_level.times do |level|
+      fields.select {|f| f.nested?(level)}
+            .group_by {|f| f.path_upto(level)}
+            .each do |current_path, group|
+        # Just use the first item - could use any item in the group
+        assoc = group.first.assoc(level)
+        klass = assoc.class_name.constantize
+
+        # List of ids that are related to the previous objects (the IN clause in SQL preload statement)
+        if level == 0 # Level 0 is different as data is stored in a different structure
+          collection = data
+        else
+          prev_path = group.first.path_upto(level - 1)
+          collection = joined_data[prev_path].values
+        end
+        ids = collection.map {|a| a[assoc.foreign_key]}.uniq
+
+        # Select id and other fields at the next level
+        cols = group.map do |f|
+          if f.nested?(level + 1)
+            f.assoc(level + 1).foreign_key
+          else
+            f.path[level + 1]
+          end
+        end.uniq
+        joined_plucked_cols = [klass.primary_key, *cols]
+        joined = klass.where(klass.primary_key => ids).pluck(*joined_plucked_cols)
+        attrs = __preload_pluck_to_attrs(joined, joined_plucked_cols)
+
+        # Index to quickly search on id
+        joined_data[current_path] = attrs.index_by {|a| a[klass.primary_key]}
+      end
+    end
+
+    data.map do |attr|
+      fields.map do |field|
+        if field.nested?(0)
+          assoc = field.assoc(0)
+          val = attr[assoc.foreign_key]
+          (field.path.length - 1).times do |level|
+            current_path = field.path_upto(level)
+            if field.nested?(level + 1)
+              col = field.assoc(level + 1).foreign_key
+            else
+              col = field.path.last
+            end
+            val = joined_data[current_path][val]
+            val = val[col] if val
+          end
+          val
+        else
+          attr[field.path.last]
+        end
+      end
+    end
+  end
+
+  def __preload_pluck_to_attrs(array, column_names)
+    array.map do |item|
+      pairs = item.map.with_index {|element, index| [column_names[index], element]}.flatten
+      Hash[*pairs]
+    end
+  end
+end
+
+ActiveRecord::Base.extend(PreloadPluck)

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: preload_pluck
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Assetricity
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Adds a preload_pluck method to ActiveRecord that allows querying using
+  Rails 4 preload-style eager loading, and return a 2-dimensional array without ActiveRecord
+  model creation overhead.
+email:
+- info@assetricity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/preload_pluck/version.rb
+- lib/preload_pluck.rb
+- LICENSE
+- README.md
+homepage: https://github.com/avinmathew/preload_pluck
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.15
+signing_key: 
+specification_version: 4
+summary: Efficiently load data into a 2-dimensional array without ActiveRecord model
+  creation overhead.
+test_files: []