ancestry_joins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 202ddb44a51c5d2f85b2301f8ffdd308b8d9c275
+  data.tar.gz: 40957c6db4e124df74a9df71c0071345143a3461
+SHA512:
+  metadata.gz: c6b9d34c587a6c8f84fcaa31fecf3b83d4d527954b441a4a85ced4762abeafd47806b4ab9052e87b89d8b3f9716ff9a49abe4fa59ec3d91296f850d04cf9aec3
+  data.tar.gz: 47bd49c3c65251ad4b1134032bc3f30b82a8a14c2498359ea9ace055a53fa4c55b5c38616c037721a8f8f0ff361918154f00c9d89559e3983c495808b84a0b0f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Include:
+    - '**/*.rb'
+  Exclude:
+    - 'db/**/*'

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ancestry_joins.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pg'
+  gem 'table_print'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Pierce
+
+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,86 @@
+# AncestryJoins
+This gem provides additional ActiveRecord scopes to fetch ancestry records in
+bulk.
+
+## Problem
+The ancestry gem only provides instance scopes which when used in
+iteration causes N+1 query performance issues.
+For example:
+
+```ruby
+# if we have 100 interesting items, this will run 1 + 100 querys!
+Item.where(interesting: true).flat_map{|i| i.ancestors}
+```
+
+## Solution
+
+Using this gem will fetch identical results to the `flat_map` but in a single
+query.
+
+```ruby
+Item.where(interesting: true).with_ancestors_only
+```
+
+## Caveats
+
+Do to the querying method, only Postgres is supported at the moment.
+More databases can be supported in the future. Look at `lib/ancestry_joins.rb` 
+to implement scopes for another database.
+
+## Usage
+
+**IMPORTANT** Use the scope *last* in the chain for good performance, otherwise
+the ancestry grouping act on the entire table before applying the filter.
+If you have other models to join against the ancestry, those maybe added after
+including the ancestry joins.
+
+```ruby
+class Item < ActiveRecord::Base
+  has_ancestry
+  include AncestryJoins
+
+  has_many :widgets
+end
+
+# Get list of Items with red color, their parents regardless of color, and the
+# red items or red items ancestors' parents widgets are blue.
+Item
+  .where(color: 'red')
+  .with_ancestors
+  .joins(:widgets)
+  .merge(Widget.where(color: 'blue'))
+```
+
+Look to the specs for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ancestry_joins'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ancestry_joins
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/ddrscott/ancestry_joins.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ancestry_joins.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ancestry_joins/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ancestry_joins'
+  spec.version       = AncestryJoins::VERSION
+  spec.authors       = ['Scott Pierce']
+  spec.email         = ['scott.pierce@centro.net']
+
+  spec.summary       = 'Provides scopes to join ancestry records in bulk.'
+  spec.homepage      = "https://github.com/ddrscott/ancestry_joins"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'ancestry', '>= 2.1.0'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ancestry_joins"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+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/ancestry_joins/version.rb

@@ -0,0 +1,3 @@
+module AncestryJoins
+  VERSION = "0.1.0"
+end

data/lib/ancestry_joins.rb

@@ -0,0 +1,61 @@
+require 'ancestry_joins/version'
+require 'active_record'
+require 'pg'
+require 'ancestry'
+require 'active_support/concern'
+
+module AncestryJoins
+  extend ActiveSupport::Concern
+
+  included do
+    case connection.adapter_name.downcase.to_sym
+    when :postgresql
+      # Helper to add all selection fields. This is the default behavior until
+      # you add your own selections.
+      scope :with_star, -> { select("#{table_name}.*") }
+
+      # Helper to get the root_id from the ancestry string column.
+      scope :with_root_id, -> {
+        select("coalesce(nullif(trim(split_part(#{table_name}.#{ancestry_column}, '/', 1)), ''), #{table_name}.#{primary_key}::text) AS ancestry_root_id")
+      }
+
+      # Joins ancestors to the existing scope.
+      # It's important to make this the last scope for efficiency.
+      # @params [Boolean] include_self will keep the current record in the
+      # results. Otherwise, you'll only get the ancestors. `include_self`
+      # defaults to `true`
+      # @params [Integer] nth limit the results to just the nth child in the
+      # ancestry.
+      # @params [Integer] nth_reverse opposite of `nth`. Useful for getting the
+      # tips of the ancestry.
+      scope :with_ancestors, ->(include_self: true, nth: nil, nth_reverse: nil) {
+        primary_key_type = columns.detect { |d| d.name == primary_key }.sql_type
+
+        select_nth_ancestor_id = <<-SQL.squish
+                SELECT *, row_number() OVER ()
+                FROM unnest(string_to_array(nullif(#{table_name}.#{ancestry_column}, ''), '/')::#{primary_key_type}[] #{include_self ? " || ARRAY[#{table_name}.#{primary_key}]" : nil})
+        SQL
+
+        query = select('ancestors.*')
+                .select('rank() OVER (PARTITION BY ancestors.ancestry_root_id ORDER BY ancestor_ids.nth desc nulls last) AS ancestry_nth_reverse')
+                .select('ancestor_ids.nth AS ancestry_nth')
+                .joins("JOIN LATERAL (#{select_nth_ancestor_id}) AS ancestor_ids(id, nth) ON true")
+                .joins("JOIN (#{unscoped.with_star.with_root_id.to_sql}) AS ancestors ON ancestors.#{primary_key} = ancestor_ids.#{primary_key}")
+
+        query = unscoped.from("(#{query.to_sql}) AS #{table_name}")
+
+        query = query.where('ancestry_nth = ?', nth) if nth
+        query = query.where('ancestry_nth_reverse = ?', nth_reverse) if nth_reverse
+        query
+      }
+
+      # Helper to exclude current record from results.
+      scope :with_ancestors_only, ->(**options) { with_ancestors(include_self: false, **options) }
+
+      # Helper to build `nth_reverse: 1`
+      scope :with_ancestors_leafs_only, ->(**options) { with_ancestors(nth_reverse: 1, **options) }
+    else
+      raise NotImplementedError, "Unknown adapter type `#{adapter_type}`"
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ancestry_joins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Pierce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email:
+- scott.pierce@centro.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ancestry_joins.gemspec
+- bin/console
+- bin/setup
+- lib/ancestry_joins.rb
+- lib/ancestry_joins/version.rb
+homepage: https://github.com/ddrscott/ancestry_joins
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Provides scopes to join ancestry records in bulk.
+test_files: []