top_n_loader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd29e09d74f26981a3772f7ac8871d7fe00bbaa736588f2de733acea20ad7bc5
+  data.tar.gz: 19a89bc3aaf851949e203fd0c29402f0c99fa6d3b3ce40227b4c7faa39c95370
+SHA512:
+  metadata.gz: 42e80f413a55f32365bcc68425ae2d070f56a708387db2b91f867018604b1b20076e303ce07212369cb04cc86eb66632aa70fde0f932608199c6bfc31c363c8f
+  data.tar.gz: bbbbe954a980640ad53014604198fed10ff1047e09e1850ae18b7cb304e38240029ce9e583cdbb634923ac2f99819789cc9eec7a06680a1e32f2bcf861e42402

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sqlite3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in top_n_loader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    top_n_loader (1.0.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    docile (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  pry
+  rake
+  simplecov
+  sqlite3
+  top_n_loader!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 tompng
+
+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,61 @@
+# TopNLoader
+
+When you need top 5 sub-records for each record
+```ruby
+posts = Post.limit(10).to_a
+```
+
+Without TopNLoader: N+1 queries
+```ruby
+posts = Post.limit(10)
+render json: posts.map do |post|
+  {
+    title: post.title,
+    comments: post.comments.order(id: :desc).limit(5)
+  }
+end
+```
+
+With TopNLoader: Only 2 queries
+```ruby
+# One query here
+posts = Post.limit(10).to_a
+post_ids = posts.map(&:id)
+# ANd just one query to load each comments(limit:5) for all posts
+top5s = TopNLoader.load_associations Post, posts_ids, :comments, order: :desc, limit: 5
+render json: posts.map do |post|
+  {
+    title: post.title,
+    comments: top5s[post.id]
+  }
+end
+```
+
+# Usage
+
+```ruby
+# Gemfile
+gem 'top_n_loader', github: 'tompng/top_n_loader'
+```
+
+```ruby
+TopNLoader.load_associations(ParentModel, ids, relation_name, limit:, order: nil)
+# limit: >=0
+# order: :asc, :desc, {order_column: (:asc or :desc)}
+
+# will return the results below with a single query
+records = ParentModel.find(ids).map do |record|
+  [record.id, record.send(relation_name).order(order).take(limit)]
+end.to_h
+```
+
+```ruby
+TopNLoader.load_groups(YourModel, group_column, group_values, limit:, order: nil, condition: nil)
+# limit: >=0
+# order: :asc, :desc, {order_column: (:asc or :desc)}
+# condition: 'name is null', ['name = ?', 'jack'], { age: (1..10), name: { not: 'jack' }}
+
+# will return the results below with a single query
+records = YourModel.where(condition).where(group_column => group_values).order(order)
+records.group_by(&group_column).transform_values { |list| list.take(limit) }
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'top_n_loader'
+require 'pry'
+require_relative '../test/db'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/top_n_loader.rb

@@ -0,0 +1,84 @@
+require 'top_n_loader/version'
+require 'active_record'
+require 'top_n_loader/sql_builder'
+
+module TopNLoader
+  class << self
+    def load_associations(base_klass, ids, relation, limit:, order: nil)
+      validate_ar_class! :base_klass, base_klass
+      validate_limit! limit
+      return Hash.new { [] } if ids.empty? || limit.zero?
+      klass = base_klass.reflect_on_association(relation.to_sym).klass
+      order_option = { limit: limit, **parse_order(klass, order) }
+      sql = SQLBuilder.top_n_association_sql base_klass, klass, relation, order_option
+      records = klass.find_by_sql([sql, ids])
+      format_result(records, klass: klass, **order_option)
+    end
+
+    def load_groups(klass, column, keys, limit:, order: nil, condition: nil)
+      validate_ar_class! :klass, klass
+      validate_limit! limit
+      return Hash.new { [] } if keys.empty? || limit.zero?
+      options = {
+        klass: klass,
+        group_column: column,
+        limit: limit,
+        **parse_order(klass, order)
+      }
+      records = klass.find_by_sql(
+        SQLBuilder.top_n_group_sql(
+          group_keys: keys,
+          condition: condition,
+          **options
+        )
+      )
+      format_result records, options
+    end
+
+    private
+
+    def validate_ar_class!(var_name, klass)
+      return if klass.is_a?(Class) && klass < ActiveRecord::Base
+      raise ArgumentError, "#{var_name} should be a subclass of ActiveRecord::Base"
+    end
+
+    def validate_limit!(limit)
+      raise ArgumentError, 'negative limit' if limit < 0
+    end
+
+    def parse_order(klass, order)
+      key, mode = begin
+        case order
+        when Hash
+          raise ArgumentError, 'invalid order' unless order.size == 1
+          order.first
+        when Symbol
+          [klass.primary_key, order]
+        when NilClass
+          [klass.primary_key, :asc]
+        end
+      end
+      raise ArgumentError, "invalid order key: #{key}" unless klass.has_attribute? key
+      raise ArgumentError, "invalid order mode: #{mode.inspect}" unless %i[asc desc].include? mode
+      { order_key: key, order_mode: mode }
+    end
+
+    def format_result(records, klass:, group_column: nil, limit:, order_mode:, order_key:)
+      primary_key = klass.primary_key
+      type = klass.attribute_types[group_column.to_s] if group_column
+      result = records.group_by do |record|
+        key = record.top_n_group_key
+        type ? type.cast(key) : key unless key.nil?
+      end
+      result.transform_values! do |grouped_records|
+        existings, blanks = grouped_records.partition { |o| o[order_key] }
+        existings.sort_by! { |o| [o[order_key], o[primary_key]] }
+        blanks.sort_by! { |o| o[primary_key] }
+        ordered = blanks + existings
+        ordered.reverse! if order_mode == :desc
+        ordered.take limit
+      end
+      Hash.new { [] }.update result
+    end
+  end
+end

data/lib/top_n_loader/sql_builder.rb

@@ -0,0 +1,152 @@
+module TopNLoader::SQLBuilder
+  def self.condition_sql(klass, condition)
+    condition_sql = where_condition_to_sql condition
+    inheritance_column = klass.inheritance_column
+    return condition_sql unless klass.has_attribute?(inheritance_column) && klass.base_class != klass
+    sti_names = [klass, *klass.descendants].map(&:sti_name).compact
+    sti_sql = where_condition_to_sql inheritance_column => sti_names
+    [condition_sql, sti_sql].compact.join ' AND '
+  end
+
+  def self.top_n_association_sql(klass, target_klass, relation, limit:, order_mode:, order_key:)
+    parent_table = klass.table_name
+    joins = klass.joins relation.to_sym
+    target_table = target_klass.table_name
+    if target_table == klass.table_name
+      target_table = "#{joins.joins_values.first.to_s.pluralize}_#{target_table}"
+    end
+    join_sql = joins.to_sql.match(/FROM.+/)[0]
+    %(
+      SELECT #{qt target_table}.*, top_n_group_key
+      #{join_sql}
+      INNER JOIN
+      (
+        SELECT T.#{q klass.primary_key} as top_n_group_key,
+        (
+          SELECT #{qt target_table}.#{q order_key}
+          #{join_sql}
+          WHERE #{qt parent_table}.#{q klass.primary_key} = T.#{q klass.primary_key}
+          ORDER BY #{qt target_table}.#{q order_key} #{order_mode.upcase}
+          LIMIT 1 OFFSET #{limit.to_i - 1}
+        ) AS last_value
+        FROM #{qt parent_table} as T where T.#{q klass.primary_key} in (?)
+      ) T
+      ON #{qt parent_table}.#{q klass.primary_key} = T.top_n_group_key
+      AND (
+        T.last_value IS NULL
+        OR #{qt target_table}.#{q order_key} #{{ asc: :<=, desc: :>= }[order_mode]} T.last_value
+        OR #{qt target_table}.#{q order_key} is NULL
+      )
+    )
+  end
+
+
+  def self.top_n_group_sql(klass:, group_column:, group_keys:, condition:, limit:, order_mode:, order_key:)
+    order_op = order_mode == :asc ? :<= : :>=
+    group_key_table = value_table(:T, :top_n_group_key, group_keys)
+    table_name = klass.table_name
+    sql = condition_sql klass, condition
+    join_cond = %(#{qt table_name}.#{q group_column} = T.top_n_group_key)
+    if group_keys.include? nil
+      nil_join_cond = %((#{qt table_name}.#{q group_column} IS NULL AND T.top_n_group_key IS NULL))
+      join_cond = %((#{join_cond} OR #{nil_join_cond}))
+    end
+    %(
+      SELECT #{qt table_name}.*, top_n_group_key
+      FROM #{qt table_name}
+      INNER JOIN
+      (
+        SELECT top_n_group_key,
+        (
+          SELECT #{qt table_name}.#{q order_key} FROM #{qt table_name}
+          WHERE #{join_cond}
+          #{"AND #{sql}" if sql}
+          ORDER BY #{qt table_name}.#{q order_key} #{order_mode.to_s.upcase}
+          LIMIT 1 OFFSET #{limit.to_i - 1}
+        ) AS last_value
+        FROM #{group_key_table}
+      ) T
+      ON #{join_cond}
+      AND (
+        T.last_value IS NULL
+        OR #{qt table_name}.#{q order_key} #{order_op} T.last_value
+        OR #{qt table_name}.#{q order_key} is NULL
+      )
+      #{"WHERE #{sql}" if sql}
+    )
+  end
+
+  def self.q(name)
+    ActiveRecord::Base.connection.quote_column_name name
+  end
+
+  def self.qt(name)
+    ActiveRecord::Base.connection.quote_table_name name
+  end
+
+  def self.value_table(table, column, values)
+    if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      values_value_table(table, column, values)
+    else
+      union_value_table(table, column, values)
+    end
+  end
+
+  def self.union_value_table(table, column, values)
+    sanitize_sql_array [
+      "(SELECT ? AS #{column}#{' UNION SELECT ?' * (values.size - 1)}) AS #{table}",
+      *values
+    ]
+  end
+
+  def self.values_value_table(table, column, values)
+    sanitize_sql_array [
+      "(VALUES #{(['(?)'] * values.size).join(',')}) AS #{table} (#{column})",
+      *values
+    ]
+  end
+
+  def self.where_condition_to_sql(condition)
+    case condition
+    when String
+      condition
+    when Array
+      sanitize_sql_array condition
+    when Hash
+      condition.map { |k, v| kv_condition_to_sql k, v }.join ' AND '
+    end
+  end
+
+  def self.kv_condition_to_sql(key, value)
+    return "NOT (#{where_condition_to_sql(value)})" if key == :not
+    sql_binds = begin
+      case value
+      when NilClass
+        %(#{q key} IS NULL)
+      when Range
+        if value.exclude_end?
+          [%(#{q key} >= ? AND #{q key} < ?), value.begin, value.end]
+        else
+          [%(#{q key} BETWEEN ? AND ?), value.begin, value.end]
+        end
+      when Hash
+        raise ArgumentError, '' unless value.keys == [:not]
+        "NOT (#{kv_condition_to_sql(key, value[:not])})"
+      when Enumerable
+        array = value.to_a
+        if array.include? nil
+          [%((#{q key} IS NULL OR #{q key} IN (?))), array.reject(&:nil?)]
+        else
+          [%(#{q key} IN (?)), array]
+        end
+      else
+        [%(#{q key} = ?), value]
+      end
+    end
+    sanitize_sql_array sql_binds
+  end
+
+  def self.sanitize_sql_array(array)
+    ActiveRecord::Base.send :sanitize_sql_array, array
+  end
+end

data/lib/top_n_loader/version.rb

@@ -0,0 +1,3 @@
+module TopNLoader
+  VERSION = '1.0.0'
+end

data/top_n_loader.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "top_n_loader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "top_n_loader"
+  spec.version       = TopNLoader::VERSION
+  spec.authors       = ["tompng"]
+  spec.email         = ["tomoyapenguin@gmail.com"]
+
+  spec.summary       = %q{load top n records for each group}
+  spec.description   = %q{load top n records for each group}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+
+  %w[bundler rake minitest sqlite3 pry simplecov].each do |gem_name|
+    spec.add_development_dependency gem_name
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: top_n_loader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- tompng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: load top n records for each group
+email:
+- tomoyapenguin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/top_n_loader.rb
+- lib/top_n_loader/sql_builder.rb
+- lib/top_n_loader/version.rb
+- top_n_loader.gemspec
+homepage: 
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: load top n records for each group
+test_files: []