webdack-uuid_migration 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6368bae7ea813a00d4a532174f0f1ebd704b2cef
-  data.tar.gz: d9e59fe6d56546514c5eca167ef2e8b53bd6b622
+  metadata.gz: 7e73ae10fca41d84505cb6f9237f9b45f2da850c
+  data.tar.gz: 5abb88d0a9bc06de553e2e7b1e6fcae13fc85d88
 SHA512:
-  metadata.gz: 4840bb9c3a7da55bc2c9fe9b0712163181a86f9060f2aeba6eefeb2c862621953b8fd53e97d13b433d7260a96af9a0a5addabbba88a0f2c201766c6f3d61fd3b
-  data.tar.gz: 64dd4f6a8271522d79870c6628c524c5258ebc45937e66c91afe5ed41ca8d17a316ff30a661c96e6b70bf854131f01fa8ad8d2228530b4748caf85cd90727b7b
+  metadata.gz: d3005d3ba1bde0da93c33714b05cc7d831ede40dc91a977c836442c5b7be10f0a08e2d7a58fcf878e21fb1fafef26cc9b8d86ece4978270b1c49034a3824e8a9
+  data.tar.gz: 1631e47e420df4926c7ce6ab4775925cf7a3f53389c7369a4d473cda7e63febdb0fb6782995da3ff786b4947ed0092123835b5d1851309c7f46e2a52ec1d531a

data/.travis.yml

@@ -0,0 +1,15 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.2.0
+  - 2.3.1
+  - rbx-2
+  - jruby
+  - ruby-head
+
+script: bundle exec rspec spec
+
+matrix:
+  allow_failures:
+    - rvm: jruby

data/README.md

@@ -1,5 +1,7 @@
 # Webdack::UuidMigration
 
+[![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.
 
@@ -60,6 +62,39 @@ retrieve old id in future.
 See {Webdack::UUIDMigration::Helpers} for more details. {Webdack::UUIDMigration::Helpers} is mixed
 into {ActiveRecord::Migration}, so that all methods can directly be used within migrations.
 
+### Schema with Foreign Key References
+
+Please see [https://github.com/kreatio-sw/webdack-uuid_migration/issues/4]
+
+To update a primary key and all columns referencing it please use
+{Webdack::UUIDMigration::Helpers#primary_key_and_all_references_to_uuid}. For example:
+
+```
+class MigrateWithFk < ActiveRecord::Migration
+  def change
+    reversible do |dir|
+      dir.up do
+        enable_extension 'uuid-ossp'
+
+        primary_key_and_all_references_to_uuid :cities
+      end
+
+      dir.down do
+        raise ActiveRecord::IrreversibleMigration
+      end
+    end
+  end
+end
+```
+
+Internally it will query the database to find all tables & columns referring to this primary key as foreign keys
+and do the following:
+
+- Drop all foreign key constraints referring to this primary key
+- Convert the primary key to UUID
+- Convert all referring columns to UUID
+- Restore all foreign keys
+
 ### Polymorphic references
 
 Migrating Polymorphic references may get tricky if not all the participating entities are getting migrated to
@@ -93,10 +128,10 @@ Example:
 
 ## Compatibility
 
-Works only with Rails 4. It uses Rails4's out-of-the-box UUID support for PostgreSQL. Works with Ruby 1.9.3,
+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.beta1.
+Tested with Rails 5.0.0.
 
 To run the test suite:
 

data/lib/webdack/uuid_migration/helpers.rb

@@ -1,6 +1,10 @@
+require_relative 'schema_helpers'
+
 module Webdack
   module UUIDMigration
     module Helpers
+      include SchemaHelpers
+
 
       # 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
@@ -72,6 +76,32 @@ module Webdack
                 }
       end
 
+      # Convert primary key of a table and all referring columns to UUID. Useful if migrations were generated
+      # with newer version of Rails that automatically creates foreign key constraints in the database.
+      #
+      # Internally it will query the database to find all tables & columns referring to this primary key as foreign keys
+      # and do the following:
+      #
+      # - Drop all foreign key constraints referring to this primary key
+      # - Convert the primary key to UUID
+      # - Convert all referring columns to UUID
+      # - Restore all foreign keys
+      #
+      # @param table[Symbol]
+      def primary_key_and_all_references_to_uuid(table)
+        fk_specs = foreign_keys_into(:cities)
+
+        drop_foreign_keys(fk_specs)
+
+        primary_key_to_uuid(table)
+
+        fk_specs.each do |fk_spec|
+          columns_to_uuid fk_spec[:from_table], fk_spec[:column]
+        end
+
+        create_foreign_keys(fk_specs.deep_dup)
+      end
+
       private
       # Prepare a fragment that can be used in SQL statements that converts teh data value
       # from integer, string, or UUID to valid UUID string as per Postgres guidelines

data/lib/webdack/uuid_migration/schema_helpers.rb

@@ -0,0 +1,55 @@
+module Webdack
+  module UUIDMigration
+    module SchemaHelpers
+      def foreign_keys_into(to_table_name)
+        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
+        WHERE c.contype = 'f'
+          AND t2.oid::regclass::text = #{quote(to_table_name)}
+          AND a2.attname = #{quote(to_primary_key)}
+        ORDER BY t1.relname, a1.attname
+        SQL
+
+        fk_info.map do |row|
+          options = {
+              to_table: row['to_table'],
+              primary_key: row['primary_key'],
+              from_table: row['from_table'],
+              column: row['column'],
+              name: row['name']
+          }
+
+          options[:on_delete] = extract_foreign_key_action(row['on_delete'])
+          options[:on_update] = extract_foreign_key_action(row['on_update'])
+
+          options
+        end
+      end
+
+      def drop_foreign_keys(foreign_keys)
+        foreign_keys.each do |fk_key_spec|
+          foreign_key_spec = fk_key_spec.dup
+          from_table = foreign_key_spec.delete(:from_table)
+          remove_foreign_key from_table, name: foreign_key_spec[:name]
+        end
+      end
+
+      def create_foreign_keys(foreign_keys)
+        foreign_keys.each do |fk_key_spec|
+          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
+        end
+      end
+    end
+  end
+end

data/lib/webdack/uuid_migration/version.rb

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

data/spec/schema_helper_spec.rb

@@ -0,0 +1,68 @@
+require_relative 'spec_helper'
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+  include Webdack::UUIDMigration::SchemaHelpers
+end
+
+describe Webdack::UUIDMigration::SchemaHelpers do
+  def initial_setup
+    init_database
+    create_initial_schema
+
+    # Create 2 more tables similar to the way new version of Rails will do
+    create_tables_with_fk
+  end
+
+  before(:each) do
+    initial_setup
+
+    @connection = ActiveRecord::Base.connection
+
+    # Create one more foreign key constraints
+    @connection.add_foreign_key :students, :cities
+  end
+
+  it 'should get all foreign keys into a table' do
+    foreign_keys_into = @connection.foreign_keys_into(:cities)
+
+    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
+
+  it 'should drop all foreign keys into a table' do
+    fk_specs = @connection.foreign_keys_into(:cities)
+
+    @connection.drop_foreign_keys(fk_specs)
+
+    expect(@connection.foreign_keys_into(:cities)).to eq([])
+  end
+
+  it 'should drop all recreate all foreign keys into a table' do
+    fk_specs = @connection.foreign_keys_into(:cities)
+
+    @connection.drop_foreign_keys(fk_specs)
+    @connection.create_foreign_keys(fk_specs)
+
+    expect(@connection.foreign_keys_into(:cities)).to eq(fk_specs)
+  end
+
+end

data/spec/support/initial_schema.rb

@@ -38,3 +38,17 @@ def create_initial_schema
 
   end
 end
+
+def create_tables_with_fk
+  connection = ActiveRecord::Base.connection
+
+  connection.create_table "dummy01", force: true do |t|
+    t.string "name"
+    t.references "city", index: true, foreign_key: {on_update: :cascade, on_delete: :nullify}
+  end
+
+  connection.create_table "dummy02", force: true do |t|
+    t.string "name"
+    t.references "city", index: true, foreign_key: {on_update: :restrict, on_delete: :restrict}
+  end
+end

data/spec/support/pg_database_helper.rb

@@ -2,11 +2,9 @@
 
 PG_SPEC = {
     :adapter  => 'postgresql',
-    :host     => 'localhost',
     :database => 'webdack_uuid_migration_helper_test',
-    :username => 'kdeepak',
-    :encoding => 'utf8',
-    :password => 'kreatio'
+    :username => 'postgres',
+    :encoding => 'utf8'
 }
 
 def init_database

data/spec/uuid_migrate_helper_spec.rb

@@ -38,6 +38,22 @@ class MigrateAllOneGo < ActiveRecord::Migration
   end
 end
 
+class MigrateWithFk < ActiveRecord::Migration
+  def change
+    reversible do |dir|
+      dir.up do
+        enable_extension 'uuid-ossp'
+
+        primary_key_and_all_references_to_uuid :cities
+      end
+
+      dir.down do
+        raise ActiveRecord::IrreversibleMigration
+      end
+    end
+  end
+end
+
 class MigrateStep01 < ActiveRecord::Migration
   def change
     reversible do |dir|
@@ -154,6 +170,21 @@ describe Webdack::UUIDMigration::Helpers do
     }
   end
 
+  it 'should migrate a primary key and all columns referencing it using foreign keys' do
+    # Create 2 more tables similar to the way new version of Rails will do
+    create_tables_with_fk
+
+    # Add Foreign key for this reference as well
+    ActiveRecord::Base.connection.add_foreign_key :students, :cities
+
+    expect {
+      MigrateWithFk.migrate(:up)
+      reset_columns_data
+    }.to_not change {
+      key_relationships
+    }
+  end
+
   it 'should handle nulls' do
     Student.create(name: 'Student without city or institution')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdack-uuid_migration
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,13 +117,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/webdack/uuid_migration.rb
 - lib/webdack/uuid_migration/helpers.rb
+- lib/webdack/uuid_migration/schema_helpers.rb
 - lib/webdack/uuid_migration/version.rb
+- spec/schema_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/initial_data.rb
 - spec/support/initial_schema.rb
@@ -160,6 +163,7 @@ signing_key:
 specification_version: 4
 summary: Useful helpers to migrate Integer id columns to UUID in PostgreSql.
 test_files:
+- spec/schema_helper_spec.rb
 - spec/spec_helper.rb
 - spec/support/initial_data.rb
 - spec/support/initial_schema.rb
@@ -170,4 +174,3 @@ test_files:
 - spec/support/pg_database_helper.rb
 - spec/uuid_custom_pk_spec.rb
 - spec/uuid_migrate_helper_spec.rb
-has_rdoc: yard