pg_closure_tree_rebuild 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c64dc28a4a9b38273e37a80b71159be54beae34d
+  data.tar.gz: 487daa0b155d4bc97d6f801a6244910b7fb87618
+SHA512:
+  metadata.gz: a21ad70e898627c19b5e5bd9e5d37a989c39c1cfb8795feb729fc90a78107a5986e856195b5b80890e5e5e11efd5ff7ba8c5bf7910aa1979f475deca32385d2a
+  data.tar.gz: a51a1d60ea86e451a1aa7d790677ffdb9ba2d715c8627eb321beef68ab489f49b0073b0a57d68698e40c8f3b27e0cac0311eda5f6ef356b532c9ebbd1e77293e

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,7 @@
+AllCops:
+  Include:
+    - ./Gemfile
+  Exclude:
+    - config/**/*
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1
+  - jruby-19mode
+cache: bundler
+sudo: false
+
+addons:
+  code_climate:
+    repo_token: a9262eaad8d352b2cd87a3f67408aac43094fde50bb58b9af94362886874a92c

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_closure_tree_rebuild.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Viktor Sokolov
+
+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,42 @@
+# PgClosureTreeRebuild
+
+[![Build Status](https://travis-ci.org/gzigzigzeo/pg_closure_tree_rebuild.svg)](http://travis-ci.org/gzigzigzeo/pg_closure_tree_rebuild)
+[![Code Climate](https://codeclimate.com/github/gzigzigzeo/pg_closure_tree_rebuild/badges/gpa.svg)](https://codeclimate.com/github/gzigzigzeo/pg_closure_tree_rebuild)
+[![Test Coverage](https://codeclimate.com/github/gzigzigzeo/pg_closure_tree_rebuild/badges/coverage.svg)](https://codeclimate.com/github/gzigzigzeo/pg_closure_tree_rebuild)
+
+
+Quick `#rebuild!` method implementation for [closure_tree](https://github.com/mceachen/closure_tree) on PostgreSQL.
+
+Say you have a table with 1M+ hierarchical records and you want to migrate it to closure_tree. Initial rebuild of hierarchies table using the standard #rebuild! method will take a dramatically long time. This library speeds up the process. It makes all the calculations using pure in-memory array and writes the result using COPY FROM STDIN BINARY.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_closure_tree_rebuild'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_closure_tree_rebuild
+
+## Usage
+
+    $ bundle exec rake closure_tree:rebuild DATABASE_URL=postgres://localhost/tags TABLE=tags HIERARCHIES=tag_hierarchies PARENT_ID=parent_id ID=id
+
+You can bypass all params except database URL and table name.
+
+Rebuilding hierarchy for 1162537 records with 4 generations in average takes 2 minutes 58 seconds on my MacBook Pro i7 2.3GHz, while the rebuilding with the standard method takes hours.
+
+## Contributing
+
+1. Fork it ( https://github.com/gzigzigzeo/pg_closure_tree_rebuild/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+load 'tasks/closure_tree.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pg_closure_tree_rebuild'
+
+# 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
+
+require 'irb'
+IRB.start

data/bin/setup

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

data/lib/pg_closure_tree_rebuild/builder.rb

@@ -0,0 +1,98 @@
+module PgClosureTreeRebuild
+  class Builder
+    def initialize(table, hierarchies_table_name, options = {})
+      @table = table
+      @hierarchies_table_name = hierarchies_table_name.to_sym
+      @id = options.delete(:id) || :id
+      @parent_id = options.delete(:parent_id) || :parent_id
+    end
+
+    def rebuild(db)
+      io = StringIO.new
+      write_header(io)
+      chains.each do |row|
+        io.write([row.size].pack('n'))
+        row.each { |v| write_integer(v, io) }
+        yield if block_given?
+      end
+      write_close(io)
+      copy(db, io)
+    end
+
+    def tuples
+      @tuples ||= @table.order(@parent_id).select_map([@id, @parent_id])
+    end
+
+    def chains
+      @chains ||= build_chains
+    end
+
+    private
+
+    def build_chains
+      [].tap do |c|
+        tuples.each { |tuple| c.concat(chains_for(tuple[0])) }
+      end
+    end
+
+    def chains_for(id)
+      [].tap do |c|
+        c << [id, id, 0]
+
+        walk_up(id).each.with_index do |parent_id, index|
+          c << [parent_id, id, index + 1]
+        end
+      end
+    end
+
+    def walk_up(id, cref = [])
+      parent_id = tuples_hash[id]
+      return [] unless parent_id
+
+      if cref.include?(parent_id)
+        fail "Cycle reference detected: #{id} <=> #{parent_id}"
+      end
+
+      [parent_id] + walk_up(parent_id, cref + [parent_id])
+    end
+
+    def tuples_hash
+      @tuples_hash ||= index_tuples_by_id
+    end
+
+    def index_tuples_by_id
+      {}.tap do |c|
+        tuples.each do |(id, parent_id)|
+          c[id] = parent_id
+        end
+      end
+    end
+
+    def write_integer(value, io)
+      buf = [value].pack('N')
+      io.write([buf.bytesize].pack('N'))
+      io.write(buf)
+    end
+
+    def write_header(io)
+      io.write("PGCOPY\n\377\r\n\0")
+      io.write([0, 0].pack('NN'))
+    end
+
+    def write_close(io)
+      io.write([-1].pack('n'))
+      io.rewind
+    end
+
+    def copy(db, io)
+      db[@hierarchies_table_name].truncate
+      db.run('SET client_min_messages TO warning;')
+      db.copy_into(
+        @hierarchies_table_name,
+        columns: COLUMNS, format: :binary, data: io.read
+      )
+    end
+
+    COLUMNS = [:ancestor_id, :descendant_id, :generations]
+  end
+end

data/lib/pg_closure_tree_rebuild/railtie.rb

@@ -0,0 +1,7 @@
+module PgClosureTreeRebuild
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), '../../tasks/closure_tree.rake')
+    end
+  end
+end

data/lib/pg_closure_tree_rebuild/version.rb

@@ -0,0 +1,3 @@
+module PgClosureTreeRebuild
+  VERSION = '0.1.0'
+end

data/lib/pg_closure_tree_rebuild.rb

@@ -0,0 +1,7 @@
+require 'pg_closure_tree_rebuild/version'
+require 'pg_closure_tree_rebuild/builder'
+require 'pg_closure_tree_rebuild/railtie' if defined?(Rails)
+
+module PgClosureTreeRebuild
+  # Your code goes here...
+end

data/pg_closure_tree_rebuild.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_closure_tree_rebuild/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_closure_tree_rebuild'
+  spec.version       = PgClosureTreeRebuild::VERSION
+  spec.authors       = ['Viktor Sokolov']
+  spec.email         = ['gzigzigzeo@evilmartians.com']
+
+  spec.summary       = %q{Quick #rebuild! method implementation for closure_tree on PostgreSQL.}
+  spec.description   = %q{Quick #rebuild! method implementation for closure_tree on PostgreSQL.}
+  spec.homepage      = "http://github.com/gzigzigzeo/pg_closure_tree_rebuild"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sequel'
+  spec.add_dependency 'pg'
+  spec.add_dependency 'ruby-progressbar'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/tasks/closure_tree.rake

@@ -0,0 +1,37 @@
+require 'pg_closure_tree_rebuild'
+require 'ruby-progressbar'
+require 'sequel'
+require 'active_support/core_ext/string/inflections'
+require 'benchmark'
+
+namespace :closure_tree do
+  desc 'Rebuild hierarchy (TABLE, HIERARCHIES, DATABASE_URL, PARENT_ID, ID)'
+  task :rebuild do
+    puts Benchmark.measure {
+      DB = Sequel.connect(ENV['DATABASE_URL'])
+
+      table = ENV['TABLE']
+      hierarchies = ENV['HIERARCHIES'] || "#{table.singularize}_hierarchies"
+      parent_id = ENV['PARENT_ID'] || 'parent_id'
+      id = ENV['ID'] || 'id'
+
+      scope = DB[table.to_sym]
+      hierarchies = hierarchies.to_sym
+
+      builder = PgClosureTreeRebuild::Builder.new(
+        scope,
+        hierarchies.to_sym,
+        id: id.to_sym,
+        parent_id: parent_id.to_sym
+      )
+
+      puts 'Calculating chains...'
+      bar = ProgressBar.create(total: builder.chains.size)
+
+      puts "Records: #{scope.count}"
+
+      puts 'Importing...'
+      builder.rebuild(DB) { bar.increment }
+    }
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: pg_closure_tree_rebuild
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: pg
+  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: ruby-progressbar
+  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: activesupport
+  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: '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: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: rspec
+  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'
+description: 'Quick #rebuild! method implementation for closure_tree on PostgreSQL.'
+email:
+- gzigzigzeo@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_closure_tree_rebuild.rb
+- lib/pg_closure_tree_rebuild/builder.rb
+- lib/pg_closure_tree_rebuild/railtie.rb
+- lib/pg_closure_tree_rebuild/version.rb
+- pg_closure_tree_rebuild.gemspec
+- tasks/closure_tree.rake
+homepage: http://github.com/gzigzigzeo/pg_closure_tree_rebuild
+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.2.2
+signing_key: 
+specification_version: 4
+summary: 'Quick #rebuild! method implementation for closure_tree on PostgreSQL.'
+test_files: []