rails-bigint-primarykey 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 383a175ca8be5682b1eb3b6f0ae07bb8bf4949d8
+  data.tar.gz: f42d08c2a3a3516fe20eeebd6648a674bdfdbe2a
+SHA512:
+  metadata.gz: 48dc303d99340c51e1225d09de971da7e1331f00b9ac1ca2074b1e532c5ced6177c0fbe1d322e2e267c8ef4e29b4e9e10971659fc6b30ed71bee3a2c9fee9956
+  data.tar.gz: 33e79be5a75bae39be7e021ca35f940c66c716f7a318b6ec23d78290147000abc4804f90eee027516f43d9c3d79a456653dd7009c54c024f3d9c36c2e965edeb

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2017 Shopify Inc.
+
+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.
+
+Copyright (c) 2012 VerticalResponse Inc.
+
+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,34 @@
+## rails-bigint-primarykey [![Build Status](https://secure.travis-ci.org/Shopify/rails-bigint-primarykey.png?branch=master)](https://travis-ci.org/Shopify/rails-bigint-primarykey)
+
+### Overview
+
+rails-bigint-primarykey aims to be a simple, transparent way to use 64bit primary keys
+in MySQL and PostgreSQL.
+
+This gem was initially a fork of the [rails-bigint-pk](https://github.com/caboteria/rails-bigint-pk) gem but it was
+significantly rewritten to support Rails 5.
+
+### Installation & Usage
+
+Add the following to your `Gemfile`:
+
+```
+gem 'rails-bigint-primarykey'
+```
+
+### Gotchas
+
+When adding foreign key columns, be sure to use `references` and not
+`add_column`.
+
+```ruby
+change_table :my_table do |t|
+  t.references :other_table
+end
+
+# Doing this will not use 64bit ints
+add_column :my_table, :other_table_id, :int
+```
+
+When upgrading to Rails 5.1 you still need this gem if your were using it before and your migrations still use the
+version 5.0 or previous.

data/lib/bigint_primarykey.rb

@@ -0,0 +1,100 @@
+require 'bigint_primarykey/version'
+require 'bigint_primarykey/railtie'
+require 'active_record'
+
+module BigintPrimarykey
+  extend self
+
+  def enable!(adapter)
+    install_patches!(adapter)
+  end
+
+  private
+
+  module PostgresBigintPrimaryKey
+    def primary_key(name, type = :primary_key, **options)
+      if type == :primary_key
+        super(name, :bigserial, **options)
+      else
+        super
+      end
+    end
+  end
+
+  module MysqlBigintPrimaryKey
+    def primary_key(name, type = :primary_key, **options)
+      if type == :primary_key
+        options[:auto_increment] = true unless options.key?(:default)
+        super(name, ActiveRecord::VERSION::MAJOR < 5 ? :primary_key : :bigint, **options)
+      else
+        super
+      end
+    end
+  end
+
+  module DefaultBigintForeignKeyReferences
+    def references(*args)
+      options = args.extract_options!
+      options.reverse_merge! limit: 8
+      # Limit shouldn't affect "#{col}_type" column in polymorphic reference.
+      # But don't change value if it isn't simple 'true'.
+      # Examples:
+      #   t.references :subject, null: false, polymorphic: true ==> t.integer :subject_id, limit: 8, null: false
+      #                                                             t.string  :subject_type, null: false
+      #   t.references :subject, polymorphic: { limit: 120 }    ==> t.integer :subject_id, limit: 8
+      #                                                             t.string  :subject_type, limit: 120
+      options[:polymorphic] = options.except(:polymorphic, :limit) if options[:polymorphic] == true
+      super(*args, options)
+    end
+  end
+
+  module CompatibilityWithBigint
+    def self.included(base)
+      base.remove_possible_method :create_table
+    end
+
+    def create_table(table_name, options = {})
+      if adapter_name == "PostgreSQL"
+        if options[:id] == :uuid && !options.key?(:default)
+          options[:default] = "uuid_generate_v4()"
+        end
+      end
+
+      unless adapter_name == "Mysql2" && options[:id] == :bigint
+        if [:integer, :bigint].include?(options[:id]) && !options.key?(:default)
+          options[:default] = nil
+        end
+      end
+
+      super
+    end
+  end
+
+  def install_patches!(adapter)
+    if ActiveRecord.gem_version >= Gem::Version.new("5.1")
+      ActiveRecord::Migration::Compatibility::V5_0.include CompatibilityWithBigint
+    else
+      ca = ActiveRecord::ConnectionAdapters
+
+      case adapter
+      when 'postgresql'
+        primarykey_module = PostgresBigintPrimaryKey
+        require 'active_record/connection_adapters/postgresql_adapter'
+        ca::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:primary_key] = 'bigserial primary key'
+      when /mysql\d+/
+        primarykey_module = MysqlBigintPrimaryKey
+        require 'active_record/connection_adapters/abstract_mysql_adapter'
+        ca::AbstractMysqlAdapter::NATIVE_DATABASE_TYPES[:primary_key] = 'bigint(20) auto_increment PRIMARY KEY'
+        ca::AbstractMysqlAdapter::NATIVE_DATABASE_TYPES[:integer] = { name: "bigint", limit: 6 }
+      else
+        raise "Only MySQL and PostgreSQL adapters are supported now. Tried to patch #{adapter}."
+      end
+
+      [ca::TableDefinition,
+       ca::Table].each do |abstract_table_type|
+        abstract_table_type.prepend(primarykey_module)
+        abstract_table_type.prepend(DefaultBigintForeignKeyReferences)
+      end
+    end
+  end
+end

data/lib/bigint_primarykey/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails/railtie'
+
+module BigintPrimarykey
+  class Railtie < Rails::Railtie
+    initializer 'bigint_primarykey.install' do
+      ActiveSupport.on_load(:active_record) do
+        config = configurations[Rails.env]
+        BigintPrimarykey.enable!(config['adapter'])
+      end
+    end
+  end
+end

data/lib/bigint_primarykey/version.rb

@@ -0,0 +1,3 @@
+module BigintPrimarykey
+  VERSION = "2.0.0"
+end

data/lib/rails-bigint-primarykey.rb

@@ -0,0 +1 @@
+require 'bigint_primarykey'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rails-bigint-primarykey
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Rafael Mendonça França
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: pg
+  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: Easily use 64-bit primary keys in Rails
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Readme.md
+- lib/bigint_primarykey.rb
+- lib/bigint_primarykey/railtie.rb
+- lib/bigint_primarykey/version.rb
+- lib/rails-bigint-primarykey.rb
+homepage: https://github.com/Shopify/rails-bigint-primarykey
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Easily use 64-bit primary keys in Rails
+test_files: []