pg_party 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25658551c69b0e57019a97f4e2e5fe71abc7768a
+  data.tar.gz: ee1b84c479f68ba16272825512365637e2b39a1c
+SHA512:
+  metadata.gz: 6f6601857aee8c04fd9824ee121502f9ef04b8fd35f67a751ddfd9dd04008e459968b636768a957e35a3bcc6a39ec84a75ce90292141b1149cf52247901c3ef5
+  data.tar.gz: 32cbf53c8e2db08651e5007a05b2eaaa3dc5cdb3c1a1d2d579e9a04817ec6841a84098392cfb8f1ef32f29887c9b426f49b41fc632c82a576e9397bee4614683

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Krage
+
+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,45 @@
+# PgParty
+
+[![Gem Version](https://badge.fury.io/rb/pg_party.svg)][rubygems]
+[![Build Status](https://circleci.com/gh/rkrage/pg_party.svg?&style=shield)][circle]
+
+[rubygems]: https://rubygems.org/gems/pg_party
+[circle]:   https://circleci.com/gh/rkrage/pg_party
+
+Active Record migrations and model helpers for creating and managing PostgreSQL 10 partitions!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_party'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_party
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write development instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rkrage/pg_party. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgParty project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rkrage/pg_party/blob/master/CODE_OF_CONDUCT.md).

data/lib/pg_party.rb

@@ -0,0 +1,16 @@
+require "pg_party/version"
+require "active_support"
+
+ActiveSupport.on_load(:active_record) do
+  require "pg_party/connection_handling"
+  require "pg_party/model_methods"
+
+  extend PgParty::ConnectionHandling
+  extend PgParty::ModelMethods
+
+  require "pg_party/connection_adapters/abstract_adapter"
+
+  ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+    include PgParty::ConnectionAdapters::AbstractAdapter
+  end
+end

data/lib/pg_party/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,33 @@
+module PgParty
+  module ConnectionAdapters
+    module AbstractAdapter
+      def create_range_partition(*args)
+        raise NotImplementedError, "#create_range_partition is not implemented"
+      end
+
+      def create_list_partition(*args)
+        raise NotImplementedError, "#create_list_partition is not implemented"
+      end
+
+      def create_range_partition_of(*args)
+        raise NotImplementedError, "#create_range_partition_of is not implemented"
+      end
+
+      def create_list_partition_of(*args)
+        raise NotImplementedError, "#create_list_partition_of is not implemented"
+      end
+
+      def attach_range_partition(*args)
+        raise NotImplementedError, "#attach_range_partition is not implemented"
+      end
+
+      def attach_list_partition(*args)
+        raise NotImplementedError, "#attach_list_partition is not implemented"
+      end
+
+      def detach_partition(*args)
+        raise NotImplementedError, "#detach_partition is not implemented"
+      end
+    end
+  end
+end

data/lib/pg_party/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,125 @@
+require "digest"
+
+module PgParty
+  module ConnectionAdapters
+    module PostgreSQLAdapter
+      def create_range_partition(table_name, partition_key:, **options, &blk)
+        create_partition(table_name, :range, partition_key, **options, &blk)
+      end
+
+      def create_list_partition(table_name, partition_key:, **options, &blk)
+        create_partition(table_name, :list, partition_key, **options, &blk)
+      end
+
+      def create_range_partition_of(table_name, start_range:, end_range:, **options)
+        if options[:name]
+          child_table_name = options[:name]
+        else
+          child_table_name = hashed_table_name(table_name, "#{start_range}#{end_range}")
+        end
+
+        constraint_clause = "FROM (#{quote(start_range)}) TO (#{quote(end_range)})"
+
+        create_partition_of(table_name, child_table_name, constraint_clause, **options)
+      end
+
+      def create_list_partition_of(table_name, values:, **options)
+        if options[:name]
+          child_table_name = options[:name]
+        else
+          child_table_name = hashed_table_name(table_name, values.to_s)
+        end
+
+        constraint_clause = "IN (#{Array.wrap(values).map(&method(:quote)).join(",")})"
+
+        create_partition_of(table_name, child_table_name, constraint_clause, **options)
+      end
+
+      def attach_range_partition(parent_table_name, child_table_name, start_range:, end_range:)
+        execute(<<-SQL)
+          ALTER TABLE #{quote_table_name(parent_table_name)}
+          ATTACH PARTITION #{quote_table_name(child_table_name)}
+          FOR VALUES FROM (#{quote(start_range)}) TO (#{quote(end_range)})
+        SQL
+      end
+
+      def attach_list_partition(parent_table_name, child_table_name, values:)
+        execute(<<-SQL)
+          ALTER TABLE #{quote_table_name(parent_table_name)}
+          ATTACH PARTITION #{quote_table_name(child_table_name)}
+          FOR VALUES IN (#{Array.wrap(values).map(&method(:quote)).join(",")})
+        SQL
+      end
+
+      def detach_partition(parent_table_name, child_table_name)
+        execute(<<-SQL)
+          ALTER TABLE #{quote_table_name(parent_table_name)}
+          DETACH PARTITION #{quote_table_name(child_table_name)}
+        SQL
+      end
+
+      private
+
+      def create_partition(table_name, type, partition_key, **options)
+        modified_options = options.except(:id, :primary_key)
+        id               = options.fetch(:id, :bigserial)
+        primary_key      = options.fetch(:primary_key, :id)
+
+        raise ArgumentError, "composite primary key not supported" if primary_key.is_a?(Array)
+
+        modified_options[:id]      = false
+        modified_options[:options] = "PARTITION BY #{type.to_s.upcase} ((#{quote_partition_key(partition_key)}))"
+
+        create_table(table_name, modified_options) do |td|
+          if id == :uuid
+            td.send(id, primary_key, null: false, default: uuid_function)
+          elsif id
+            td.send(id, primary_key, null: false)
+          end
+
+          yield td if block_given?
+        end
+      end
+
+      def create_partition_of(table_name, child_table_name, constraint_clause, **options)
+        primary_key   = options.fetch(:primary_key, :id)
+        index         = options.fetch(:index, true)
+        partition_key = options[:partition_key]
+
+        raise ArgumentError, "composite primary key not supported" if primary_key.is_a?(Array)
+
+        partition_clause = <<-SQL
+          PARTITION OF #{quote_table_name(table_name)}
+          FOR VALUES #{constraint_clause}
+        SQL
+
+        create_table(child_table_name, id: false, options: partition_clause)
+
+        if primary_key
+          execute(<<-SQL)
+            ALTER TABLE #{quote_table_name(child_table_name)}
+            ADD PRIMARY KEY (#{quote_column_name(primary_key)})
+          SQL
+        end
+
+        if index && partition_key && primary_key != partition_key
+          add_index(child_table_name, "((#{quote_partition_key(partition_key)}))")
+        end
+
+        child_table_name
+      end
+
+      def quote_partition_key(key)
+        key.to_s.split("::").map(&method(:quote_column_name)).join("::")
+      end
+
+      def uuid_function
+        try(:supports_pgcrypto_uuid?) ? "gen_random_uuid()" : "uuid_generate_v4()"
+      end
+
+      def hashed_table_name(table_name, key)
+        "#{table_name}_#{Digest::MD5.hexdigest(key)[0..6]}"
+      end
+    end
+  end
+end

data/lib/pg_party/connection_handling.rb

@@ -0,0 +1,15 @@
+module PgParty
+  module ConnectionHandling
+    def establish_connection(*args)
+      super.tap do
+        if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+          require "pg_party/connection_adapters/postgresql_adapter"
+
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+            include PgParty::ConnectionAdapters::PostgreSQLAdapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pg_party/injected_list_model_methods.rb

@@ -0,0 +1,21 @@
+require "pg_party/injected_model_methods"
+
+module PgParty
+  module InjectedListModelMethods
+    include InjectedModelMethods
+
+    def create_partition(values:, **options)
+      modified_options = options.merge(
+        values: values,
+        primary_key: primary_key,
+        partition_key: partition_key
+      )
+
+      connection.create_list_partition_of(table_name, **modified_options)
+    end
+
+    def partition_key_in(*values)
+      where(partition_key_as_arel.in(values.flatten))
+    end
+  end
+end

data/lib/pg_party/injected_model_methods.rb

@@ -0,0 +1,23 @@
+module PgParty
+  module InjectedModelMethods
+    attr_reader :partition_key, :partition_column, :partition_cast
+
+    def partition_key_matching(value)
+      where(partition_key_as_arel.eq(value))
+    end
+
+    private
+
+    def partition_key_as_arel
+      arel_column = arel_table[partition_column]
+
+      if partition_cast
+        quoted_cast = connection.quote_column_name(partition_cast)
+
+        Arel::Nodes::NamedFunction.new("CAST", [arel_column.as(quoted_cast)])
+      else
+        arel_column
+      end
+    end
+  end
+end

data/lib/pg_party/injected_range_model_methods.rb

@@ -0,0 +1,24 @@
+require "pg_party/injected_model_methods"
+
+module PgParty
+  module InjectedRangeModelMethods
+    include InjectedModelMethods
+
+    def create_partition(start_range:, end_range:, **options)
+      modified_options = options.merge(
+        start_range: start_range,
+        end_range: end_range,
+        primary_key: primary_key,
+        partition_key: partition_key
+      )
+
+      connection.create_range_partition_of(table_name, **modified_options)
+    end
+
+    def partition_key_in(start_range, end_range)
+      node = partition_key_as_arel
+
+      where(node.gteq(start_range).and(node.lt(end_range)))
+    end
+  end
+end

data/lib/pg_party/model_methods.rb

@@ -0,0 +1,23 @@
+module PgParty
+  module ModelMethods
+    def range_partition_by(key)
+      @partition_key = key
+      @partition_column, @partition_cast = key.to_s.split("::")
+
+      require "pg_party/injected_range_model_methods"
+      extend InjectedRangeModelMethods
+    end
+
+    def list_partition_by(key)
+      @partition_key = key
+      @partition_column, @partition_cast = key.to_s.split("::")
+
+      require "pg_party/injected_list_model_methods"
+      extend InjectedListModelMethods
+    end
+
+    def partitioned?
+      @partition_key.present?
+    end
+  end
+end

data/lib/pg_party/version.rb

@@ -0,0 +1,3 @@
+module PgParty
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: pg_party
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ryan Krage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Migrations and model helpers for creating and managing PostgreSQL 10
+  partitions
+email:
+- krage.ryan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/pg_party.rb
+- lib/pg_party/connection_adapters/abstract_adapter.rb
+- lib/pg_party/connection_adapters/postgresql_adapter.rb
+- lib/pg_party/connection_handling.rb
+- lib/pg_party/injected_list_model_methods.rb
+- lib/pg_party/injected_model_methods.rb
+- lib/pg_party/injected_range_model_methods.rb
+- lib/pg_party/model_methods.rb
+- lib/pg_party/version.rb
+homepage: https://github.com/rkrage/pg_party
+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.6.11
+signing_key: 
+specification_version: 4
+summary: ActiveRecord PostgreSQL Partitioning
+test_files: []