webdack-uuid_migration 1.0.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e73ae10fca41d84505cb6f9237f9b45f2da850c
-  data.tar.gz: 5abb88d0a9bc06de553e2e7b1e6fcae13fc85d88
+SHA256:
+  metadata.gz: 25ef14eb1022b074c75b7ade13dd9c8e7082ba2b09eb3eeca117af57e531791e
+  data.tar.gz: 6b496e37a98d3efd7d8f3d6654a024e21e810786c10f7298a713e4de770dde8e
 SHA512:
-  metadata.gz: d3005d3ba1bde0da93c33714b05cc7d831ede40dc91a977c836442c5b7be10f0a08e2d7a58fcf878e21fb1fafef26cc9b8d86ece4978270b1c49034a3824e8a9
-  data.tar.gz: 1631e47e420df4926c7ce6ab4775925cf7a3f53389c7369a4d473cda7e63febdb0fb6782995da3ff786b4947ed0092123835b5d1851309c7f46e2a52ec1d531a
+  metadata.gz: 439f373570a94d237cd92f86e980fc8d8f21cf1939110be0827915030bd8fc84307b0a9774b85e0a33d474bca12d72b303e3893417fad793e17b8859327d72fa
+  data.tar.gz: 1dcb80f724a2d9b2aefa3b88b1e201dbab2ff89b2ba10c3d852d9d9ccbd3e6efa390fa58c227e546dd3de773e07c3631636ec2378889d4f440b66c7a7fdc384d

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc
 .idea
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -1,15 +1,24 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.2.0
-  - 2.3.1
-  - rbx-2
-  - jruby
-  - ruby-head
+  - 3.0.0
+  - 2.7.2
+  - 2.5.8
 
-script: bundle exec rspec spec
+gemfile:
+  - gemfiles/rails61.gemfile
+  - gemfiles/rails60.gemfile
+  - gemfiles/rails52.gemfile
+  - gemfiles/rails42.gemfile
 
 matrix:
-  allow_failures:
-    - rvm: jruby
+  exclude:
+    - rvm: 3.0.0
+      gemfile: gemfiles/rails52.gemfile
+    - rvm: 3.0.0
+      gemfile: gemfiles/rails42.gemfile
+    - rvm: 2.7.2
+      gemfile: gemfiles/rails42.gemfile
+
+script: bundle exec rspec spec
+
+addons:
+  postgresql: "9.4"

data/README.md

@@ -2,35 +2,58 @@
 
 [![Build Status](https://travis-ci.org/kreatio-sw/webdack-uuid_migration.svg?branch=master)](https://travis-ci.org/kreatio-sw/webdack-uuid_migration)
 
-Helper methods to migrate Integer columns to UUID columns during migrations in PostgreSQL.
-It supports migrating primary key columns as well.
+**This project is actively maintained. Please report issues and/or create
+pull requests if you face any issues.**
+
+There are plenty of tutorials around the web on how to use UUIDs with Rails.
+However, there is no reliable tutorial to help convert an in-production Rails application
+from Integer ids to UUIDs.
+
+This gem has helper methods to convert Integer columns to UUIDs during migrations.
+It supports migrating primary key columns, relations, and polymorphic relations.
+
+It is designed to be fast and is suitable for in-place migration of schema and data.
+It has been used in production since 2014.
+
+This only supports PostgreSQL.
+
+## Documentation
+
+http://www.rubydoc.info/gems/webdack-uuid_migration (The link may occasionally not work).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+```ruby
     gem 'webdack-uuid_migration'
+```
 
 And then execute:
 
+```bash
     $ bundle
+```
 
 Or install it yourself as:
 
+```bash
     $ gem install webdack-uuid_migration
-    
-This gem is needed only during database migrations. 
-Once the database has been migrated in all environments, 
+```
+
+This gem is needed only during database migrations.
+Once the database has been migrated in all environments,
 this gem can safely be removed from your applications Gemfile.
 
 ## Usage
 
 - Put `require 'webdack/uuid_migration/helpers'` in your migration file.
-- Enable `'uuid-ossp'` directly in Postgres database or by adding `enable_extension 'uuid-ossp'` to your migration.
+- Enable `'pgcrypto'` directly in Postgres database or by adding `enable_extension 'pgcrypto'` to your migration.
 - Use methods from {Webdack::UUIDMigration::Helpers} as appropriate.
 
 Example:
 
+```ruby
     # You must explicitly require it in your migration file
     require 'webdack/uuid_migration/helpers'
 
@@ -40,7 +63,7 @@ Example:
           dir.up do
             # Good idea to do the following, needs superuser rights in the database
             # Alternatively the extension needs to be manually enabled in the RDBMS
-            enable_extension 'uuid-ossp'
+            enable_extension 'pgcrypto'
 
             primary_key_to_uuid :students
 
@@ -55,6 +78,7 @@ Example:
         end
       end
     end
+```
 
 Integer values are converted to UUID by padding 0's to the left. This makes it possible to
 retrieve old id in future.
@@ -66,15 +90,17 @@ into {ActiveRecord::Migration}, so that all methods can directly be used within
 
 Please see [https://github.com/kreatio-sw/webdack-uuid_migration/issues/4]
 
+This function will only work with Rails 4.2 or newer.
+
 To update a primary key and all columns referencing it please use
 {Webdack::UUIDMigration::Helpers#primary_key_and_all_references_to_uuid}. For example:
 
-```
+```ruby
 class MigrateWithFk < ActiveRecord::Migration
   def change
     reversible do |dir|
       dir.up do
-        enable_extension 'uuid-ossp'
+        enable_extension 'pgcrypto'
 
         primary_key_and_all_references_to_uuid :cities
       end
@@ -109,6 +135,7 @@ following steps:
 
 Example:
 
+```ruby
     # Student -- belongs_to :institution, :polymorphic => true
     # An institution is either a School or a College
     # College is migrated to use UUID as primary key
@@ -124,14 +151,15 @@ Example:
         columns_to_uuid :students, :institution_id
 
     # See the rspec test case in spec folder for full example
-
+```
 
 ## Compatibility
 
-Works only with Rails 4 & Rails 5. It uses Rails4's out-of-the-box UUID support for PostgreSQL. Works with Ruby 1.9.3,
- 2.0.0, 2.1.1, and 2.3.0.
- 
-Tested with Rails 5.0.0.
+Works with Rails 4.2+, 5 & 6. It uses Rails 4's out-of-the-box UUID support for PostgreSQL.
+
+Update to latest version (>=1.4.0) for using it with Ruby 3.
+
+See https://travis-ci.org/kreatio-sw/webdack-uuid_migration for current build matrix.
 
 To run the test suite:
 
@@ -143,6 +171,9 @@ To run the test suite:
 
 - Users of the Gem
 - [Felix Bünemann](https://github.com/felixbuenemann) for checking compatibility with Rails 4.1
+- [Nick Schwaderer](https://github.com/Schwad) Rails 5.2.x compatibility
+- [Kelsey Hannan](https://github.com/KelseyDH) Upgrading to `pgcrypto`
+- [Sébastien Dubois](https://github.com/sedubois) Ruby 3.0 compatibility 
 
 ## Contributing
 

data/gemfiles/rails42.gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~>4.2.0"
+
+# This version of ActiveRecrod does not support higher
+gem "pg", '< 1.0'
+
+gemspec :path=>"../"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~>5.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~>5.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~>5.2.0'
+
+gemspec :path=>"../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~>6.0.0'
+
+gemspec :path=>"../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activerecord', '~>6.1.0'
+
+gemspec :path=>"../"

data/lib/webdack/uuid_migration/helpers.rb

@@ -7,16 +7,16 @@ module Webdack
 
 
       # Converts primary key from Serial Integer to UUID, migrates all data by left padding with 0's
-      #   sets uuid_generate_v4() as default for the column
+      #   sets gen_random_uuid() as default for the column
       #
       # @param table [Symbol]
       # @param options [hash]
       # @option options [Symbol] :primary_key if not supplied queries the schema (should work most of the times)
-      # @option options [String] :default mechanism to generate UUID for new records, default uuid_generate_v4(),
+      # @option options [String] :default mechanism to generate UUID for new records, default gen_random_uuid(),
       #           which is Rails 4.0.0 default as well
       # @return [none]
       def primary_key_to_uuid(table, options={})
-        default= options[:default] || 'uuid_generate_v4()'
+        default= options[:default] || 'gen_random_uuid()'
 
         column= connection.primary_key(table)
 
@@ -88,8 +88,9 @@ module Webdack
       # - Restore all foreign keys
       #
       # @param table[Symbol]
+      # @note Works only with Rails 4.2 or newer
       def primary_key_and_all_references_to_uuid(table)
-        fk_specs = foreign_keys_into(:cities)
+        fk_specs = foreign_keys_into(table)
 
         drop_foreign_keys(fk_specs)
 

data/lib/webdack/uuid_migration/schema_helpers.rb

@@ -5,13 +5,14 @@ module Webdack
         to_primary_key = primary_key(to_table_name)
 
 
-        fk_info = select_all <<-SQL.strip_heredoc
-        SELECT t2.oid::regclass::text AS to_table, a2.attname AS primary_key, t1.relname as from_table, a1.attname AS column, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete            FROM pg_constraint c
-        JOIN pg_class t1 ON c.conrelid = t1.oid
-        JOIN pg_class t2 ON c.confrelid = t2.oid
-        JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
-        JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
-        JOIN pg_namespace t3 ON c.connamespace = t3.oid
+        fk_info = select_all <<-SQL
+        SELECT t2.oid::regclass::text AS to_table, a2.attname AS primary_key, t1.relname as from_table, a1.attname AS column, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
+            FROM pg_constraint c
+              JOIN pg_class t1 ON c.conrelid = t1.oid
+              JOIN pg_class t2 ON c.confrelid = t2.oid
+              JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
+              JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
+              JOIN pg_namespace t3 ON c.connamespace = t3.oid
         WHERE c.contype = 'f'
           AND t2.oid::regclass::text = #{quote(to_table_name)}
           AND a2.attname = #{quote(to_primary_key)}
@@ -33,6 +34,14 @@ module Webdack
           options
         end
       end
+      
+      def extract_foreign_key_action(specifier)
+        case specifier
+        when "c"; :cascade
+        when "n"; :nullify
+        when "r"; :restrict
+        end
+      end
 
       def drop_foreign_keys(foreign_keys)
         foreign_keys.each do |fk_key_spec|
@@ -47,7 +56,7 @@ module Webdack
           foreign_key_spec = fk_key_spec.dup
           from_table = foreign_key_spec.delete(:from_table)
           to_table = foreign_key_spec.delete(:to_table)
-          add_foreign_key from_table, to_table, foreign_key_spec
+          add_foreign_key from_table, to_table, **foreign_key_spec
         end
       end
     end

data/lib/webdack/uuid_migration/version.rb

@@ -2,6 +2,6 @@
 module Webdack
   #
   module UUIDMigration
-    VERSION = "1.0.2"
+    VERSION = "1.4.0"
   end
 end

data/spec/schema_helper_spec.rb

@@ -4,7 +4,7 @@ ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
   include Webdack::UUIDMigration::SchemaHelpers
 end
 
-describe Webdack::UUIDMigration::SchemaHelpers do
+describe Webdack::UUIDMigration::SchemaHelpers, rails_4_2_or_newer: true do
   def initial_setup
     init_database
     create_initial_schema
@@ -25,25 +25,25 @@ describe Webdack::UUIDMigration::SchemaHelpers do
   it 'should get all foreign keys into a table' do
     foreign_keys_into = @connection.foreign_keys_into(:cities)
 
+    # Remove column :name from the FK info
+    foreign_keys_into = foreign_keys_into.map { |i| i.delete(:name); i }
+
     expect(foreign_keys_into).to eq([{:to_table => "cities",
                                       :primary_key => "id",
                                       :from_table => "dummy01",
                                       :column => "city_id",
-                                      :name => "fk_rails_d0b87897d5",
                                       :on_delete => :nullify,
                                       :on_update => :cascade},
                                      {:to_table => "cities",
                                       :primary_key => "id",
                                       :from_table => "dummy02",
                                       :column => "city_id",
-                                      :name => "fk_rails_bc0a81611b",
                                       :on_delete => :restrict,
                                       :on_update => :restrict},
                                      {:to_table => "cities",
                                       :primary_key => "id",
                                       :from_table => "students",
                                       :column => "city_id",
-                                      :name => "fk_rails_c4b8171c0a",
                                       :on_delete => nil,
                                       :on_update => nil}])
   end

data/spec/spec_helper.rb

@@ -6,3 +6,15 @@ require 'pg'
 require 'webdack/uuid_migration/helpers'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |c|
+  if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.2')
+    c.filter_run_excluding rails_4_2_or_newer: true
+  end
+end
+
+ActiveRecordMigration = if ActiveRecord.version >= Gem::Version.new('5.0.0')
+                          ActiveRecord::Migration[5.0]
+                        else
+                          ActiveRecord::Migration
+                        end

data/spec/uuid_custom_pk_spec.rb

@@ -1,16 +1,16 @@
 require_relative 'spec_helper'
 
-class MigrationBase < ActiveRecord::Migration
+class MigrationBase < ActiveRecordMigration
   def change
     create_table :states, primary_key: :stateid do |t|
       t.string :name
     end
 
-    enable_extension 'uuid-ossp'
+    enable_extension 'pgcrypto'
   end
 end
 
-class Migration01 < ActiveRecord::Migration
+class Migration01 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
@@ -24,7 +24,7 @@ class Migration01 < ActiveRecord::Migration
   end
 end
 
-class Migration02 < ActiveRecord::Migration
+class Migration02 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
@@ -38,11 +38,11 @@ class Migration02 < ActiveRecord::Migration
   end
 end
 
-class Migration03 < ActiveRecord::Migration
+class Migration03 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        primary_key_to_uuid :states, default: 'uuid_generate_v1()'
+        primary_key_to_uuid :states, default: 'gen_random_uuid()'
       end
 
       dir.down do
@@ -111,7 +111,7 @@ describe Webdack::UUIDMigration::Helpers do
     }
 
     default_function = State.connection.columns(:states).find { |c| c.name == 'stateid' }.default_function
-    expect(default_function).to eq 'uuid_generate_v1()'
+    expect(default_function).to eq 'gen_random_uuid()'
   end
 
 end

data/spec/uuid_migrate_helper_spec.rb

@@ -1,10 +1,10 @@
 require_relative 'spec_helper'
 
-class BasicMigration < ActiveRecord::Migration
+class BasicMigration < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        enable_extension 'uuid-ossp'
+        enable_extension 'pgcrypto'
 
         primary_key_to_uuid :students
         columns_to_uuid :students, :city_id, :institution_id
@@ -17,11 +17,11 @@ class BasicMigration < ActiveRecord::Migration
   end
 end
 
-class MigrateAllOneGo < ActiveRecord::Migration
+class MigrateAllOneGo < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        enable_extension 'uuid-ossp'
+        enable_extension 'pgcrypto'
 
         primary_key_to_uuid :cities
         primary_key_to_uuid :colleges
@@ -38,11 +38,11 @@ class MigrateAllOneGo < ActiveRecord::Migration
   end
 end
 
-class MigrateWithFk < ActiveRecord::Migration
+class MigrateWithFk < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        enable_extension 'uuid-ossp'
+        enable_extension 'pgcrypto'
 
         primary_key_and_all_references_to_uuid :cities
       end
@@ -54,11 +54,11 @@ class MigrateWithFk < ActiveRecord::Migration
   end
 end
 
-class MigrateStep01 < ActiveRecord::Migration
+class MigrateStep01 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        enable_extension 'uuid-ossp'
+        enable_extension 'pgcrypto'
 
         primary_key_to_uuid :cities
         primary_key_to_uuid :colleges
@@ -77,7 +77,7 @@ class MigrateStep01 < ActiveRecord::Migration
   end
 end
 
-class MigrateStep02 < ActiveRecord::Migration
+class MigrateStep02 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
@@ -157,7 +157,7 @@ describe Webdack::UUIDMigration::Helpers do
       end
 
       # Verify that primary key has correct default
-      expect(columns.find{|c| c.name == 'id'}.default_function).to eq 'uuid_generate_v4()'
+      expect(columns.find{|c| c.name == 'id'}.default_function).to eq 'gen_random_uuid()'
     end
   end
 
@@ -170,7 +170,7 @@ describe Webdack::UUIDMigration::Helpers do
     }
   end
 
-  it 'should migrate a primary key and all columns referencing it using foreign keys' do
+  it 'should migrate a primary key and all columns referencing it using foreign keys', rails_4_2_or_newer: true do
     # Create 2 more tables similar to the way new version of Rails will do
     create_tables_with_fk
 

data/webdack-uuid_migration.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Deepak Kumar"]
   spec.email         = ["deepak@kreatio.com"]
   spec.summary       = %q{Useful helpers to migrate Integer id columns to UUID in PostgreSql.}
-  spec.description   = %q{Useful helpers to migrate Integer id columns to UUID in PostgreSql. Special support for primary keys.}
+  spec.description   = %q{Useful helpers to consistently migrate Integer id columns to UUID in PostgreSql. Special support for primary keys and references.}
   spec.homepage      = "https://github.com/kreatio-sw/webdack-uuid_migration"
   spec.license       = 'MIT'
 
@@ -22,10 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pg", '< 2.0'
   spec.add_development_dependency 'gem-release'
 
   spec.add_dependency 'activerecord', '>= 4.0'
-
-  spec.has_rdoc= 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdack-uuid_migration
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Useful helpers to migrate Integer id columns to UUID in PostgreSql. Special
-  support for primary keys.
+description: Useful helpers to consistently migrate Integer id columns to UUID in
+  PostgreSql. Special support for primary keys and references.
 email:
 - deepak@kreatio.com
 executables: []
@@ -122,6 +122,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails42.gemfile
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
 - lib/webdack/uuid_migration.rb
 - lib/webdack/uuid_migration/helpers.rb
 - lib/webdack/uuid_migration/schema_helpers.rb
@@ -157,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Useful helpers to migrate Integer id columns to UUID in PostgreSql.