webdack-uuid_migration 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25ef14eb1022b074c75b7ade13dd9c8e7082ba2b09eb3eeca117af57e531791e
-  data.tar.gz: 6b496e37a98d3efd7d8f3d6654a024e21e810786c10f7298a713e4de770dde8e
+  metadata.gz: 9826dc874d0b0545b500caa8d1ddaac9f2d13905730e0d1a32271df4624266e9
+  data.tar.gz: 1b372945e222bca7777cfdf67908745be2032df93de044e6c11617b03e61309c
 SHA512:
-  metadata.gz: 439f373570a94d237cd92f86e980fc8d8f21cf1939110be0827915030bd8fc84307b0a9774b85e0a33d474bca12d72b303e3893417fad793e17b8859327d72fa
-  data.tar.gz: 1dcb80f724a2d9b2aefa3b88b1e201dbab2ff89b2ba10c3d852d9d9ccbd3e6efa390fa58c227e546dd3de773e07c3631636ec2378889d4f440b66c7a7fdc384d
+  metadata.gz: a44d513dd4cb66befcd8b697ebb8fa3d750f1da464e62d49e787a7063a96588e2c237fa48e159ee556920175d04ce58266afd3293a20a4255b0ce7a6906a3263
+  data.tar.gz: fbd07db878a5560566dfc5dba04dc9e2808949429059c45db9666a140eb2cd0dd5696e88427fb035d97a9cb3e38af0d8bd68e9698cf880f662612d324282cb5c

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "23:30"
+  open-pull-requests-limit: 10
+  target-branch: develop

data/README.md

@@ -49,6 +49,7 @@ this gem can safely be removed from your applications Gemfile.
 
 - Put `require 'webdack/uuid_migration/helpers'` in your migration file.
 - Enable `'pgcrypto'` directly in Postgres database or by adding `enable_extension 'pgcrypto'` to your migration.
+  If you want to generate random UUIDs, enable `uuid-ossp` as well.
 - Use methods from {Webdack::UUIDMigration::Helpers} as appropriate.
 
 Example:
@@ -80,8 +81,9 @@ Example:
     end
 ```
 
-Integer values are converted to UUID by padding 0's to the left. This makes it possible to
-retrieve old id in future.
+By default, integer values are converted to UUID by padding 0's to the left. 
+This makes it possible to retrieve old id in future. See **Generating random UUIDs** below to
+convert integer into random UUIDs using a seed.
 
 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.
@@ -153,6 +155,31 @@ Example:
     # See the rspec test case in spec folder for full example
 ```
 
+## Generating random UUIDs
+
+You can provide a `seed` parameter with a valid UUID, which will be used to convert integers into random 
+UUIDs using [uuid_generate_v5](https://www.postgresql.org/docs/current/uuid-ossp.html). You will only be 
+able to recover the old IDs in the future if you use the seed you used during the migration to generate a 
+rainbow table.
+
+Examples:
+
+```ruby
+seed = SecureRandom.uuid
+
+primary_key_to_uuid :colleges, seed: seed
+columns_to_uuid :students, :institution_id, seed: seed
+polymorphic_column_data_for_uuid :students, :institution, 'College', seed: seed
+primary_key_and_all_references_to_uuid :cities: seed: seed
+
+```
+
+**Note:** Given a set of IDs (which are used, for example, as primary key in one table and foreign
+key in multiple tables), you will need to use the same seed in all method calls. Otherwise, the 
+conversion will happen differently in each one of the tables, and the relations will be effectively 
+lost. In general, it is adviced to use a different seed per ID set (primary key) to maintain data 
+consistency and guarantee uniqueness across tables.
+
 ## Compatibility
 
 Works with Rails 4.2+, 5 & 6. It uses Rails 4's out-of-the-box UUID support for PostgreSQL.
@@ -174,6 +201,7 @@ To run the test suite:
 - [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 
+- [Manuel Bustillo Alonso](https://github.com/bustikiller) Random UUID support
 
 ## Contributing
 

data/lib/webdack/uuid_migration/helpers.rb

@@ -5,7 +5,6 @@ module Webdack
     module Helpers
       include SchemaHelpers
 
-
       # Converts primary key from Serial Integer to UUID, migrates all data by left padding with 0's
       #   sets gen_random_uuid() as default for the column
       #
@@ -14,15 +13,17 @@ module Webdack
       # @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 gen_random_uuid(),
       #           which is Rails 4.0.0 default as well
+      # @option options [String] :seed used as namespace to generate UUIDv5 from the existing ID
       # @return [none]
-      def primary_key_to_uuid(table, options={})
-        default= options[:default] || 'gen_random_uuid()'
+      def primary_key_to_uuid(table, options = {})
+        default = options[:default] || 'gen_random_uuid()'
+        seed = options[:seed]
 
-        column= connection.primary_key(table)
+        column = connection.primary_key(table)
 
         execute %Q{ALTER TABLE #{table}
                  ALTER COLUMN #{column} DROP DEFAULT,
-                 ALTER COLUMN #{column} SET DATA TYPE UUID USING (#{to_uuid_pg(column)}),
+                 ALTER COLUMN #{column} SET DATA TYPE UUID USING (#{to_uuid_pg(column, seed)}),
                  ALTER COLUMN #{column} SET DEFAULT #{default}}
 
         execute %Q{DROP SEQUENCE IF EXISTS #{table}_#{column}_seq} rescue nil
@@ -32,22 +33,24 @@ module Webdack
       #
       # @param table [Symbol]
       # @param column [Symbol]
+      # @param seed [String]
       #
       # @return [none]
-      def column_to_uuid(table, column)
+      def column_to_uuid(table, column, seed: nil)
         execute %Q{ALTER TABLE #{table}
-                 ALTER COLUMN #{column} SET DATA TYPE UUID USING (#{to_uuid_pg(column)})}
+                 ALTER COLUMN #{column} SET DATA TYPE UUID USING (#{to_uuid_pg(column, seed)})}
       end
 
       # Converts columns to UUID, migrates all data by left padding with 0's
       #
       # @param table [Symbol]
       # @param columns
+      # @param seed [String]
       #
       # @return [none]
-      def columns_to_uuid(table, *columns)
+      def columns_to_uuid(table, *columns, seed: nil)
         columns.each do |column|
-          column_to_uuid(table, column)
+          column_to_uuid(table, column, seed: seed)
         end
       end
 
@@ -68,10 +71,12 @@ module Webdack
       # @param table[Symbol]
       # @param column [Symbol] it will change data in corresponding <column>_id
       # @param entities [String] data referring these entities will be converted
-      def polymorphic_column_data_for_uuid(table, column, *entities)
-        list_of_entities= entities.map{|e| "'#{e}'"}.join(', ')
+      # @param seed [String]
+
+      def polymorphic_column_data_for_uuid(table, column, *entities, seed: nil)
+        list_of_entities = entities.map { |e| "'#{e}'" }.join(', ')
         execute %Q{
-                  UPDATE #{table} SET #{column}_id= #{to_uuid_pg("#{column}_id")}
+                  UPDATE #{table} SET #{column}_id= #{to_uuid_pg("#{column}_id", seed)}
                     WHERE #{column}_type in (#{list_of_entities})
                 }
       end
@@ -88,29 +93,38 @@ module Webdack
       # - Restore all foreign keys
       #
       # @param table[Symbol]
+      # @param seed [String]
+
       # @note Works only with Rails 4.2 or newer
-      def primary_key_and_all_references_to_uuid(table)
+      def primary_key_and_all_references_to_uuid(table, seed: nil)
         fk_specs = foreign_keys_into(table)
 
         drop_foreign_keys(fk_specs)
 
-        primary_key_to_uuid(table)
+        primary_key_to_uuid(table, seed: seed)
 
         fk_specs.each do |fk_spec|
-          columns_to_uuid fk_spec[:from_table], fk_spec[:column]
+          columns_to_uuid fk_spec[:from_table], fk_spec[:column], seed: seed
         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
       #
       # @param column [Symbol]
+      # @param seed [String]
+
       # @return [String]
-      def to_uuid_pg(column)
-        "uuid(lpad(replace(text(#{column}),'-',''), 32, '0'))"
+      def to_uuid_pg(column, seed)
+        if seed
+          "uuid_generate_v5('#{seed}'::uuid, #{column}::text)"
+        else
+          "uuid(lpad(replace(text(#{column}),'-',''), 32, '0'))"
+        end
       end
     end
   end

data/lib/webdack/uuid_migration/version.rb

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

data/spec/uuid_migrate_helper_spec.rb

@@ -1,13 +1,25 @@
 require_relative 'spec_helper'
 
+class ActiveRecordMigration
+  def self.seed_with(seed)
+    @@seed = seed
+    self
+  end
+
+  def seed
+    @@seed
+  end
+end
+
 class BasicMigration < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
         enable_extension 'pgcrypto'
+        enable_extension 'uuid-ossp'
 
-        primary_key_to_uuid :students
-        columns_to_uuid :students, :city_id, :institution_id
+        primary_key_to_uuid :students, seed: seed
+        columns_to_uuid :students, :city_id, :institution_id, seed: seed
       end
 
       dir.down do
@@ -22,13 +34,14 @@ class MigrateAllOneGo < ActiveRecordMigration
     reversible do |dir|
       dir.up do
         enable_extension 'pgcrypto'
+        enable_extension 'uuid-ossp'
 
-        primary_key_to_uuid :cities
-        primary_key_to_uuid :colleges
-        primary_key_to_uuid :schools
+        primary_key_to_uuid :cities, seed: seed
+        primary_key_to_uuid :colleges, seed: seed
+        primary_key_to_uuid :schools, seed: seed
 
-        primary_key_to_uuid :students
-        columns_to_uuid :students, :city_id, :institution_id
+        primary_key_to_uuid :students, seed: seed
+        columns_to_uuid :students, :city_id, :institution_id, seed: seed
       end
 
       dir.down do
@@ -43,8 +56,9 @@ class MigrateWithFk < ActiveRecordMigration
     reversible do |dir|
       dir.up do
         enable_extension 'pgcrypto'
+        enable_extension 'uuid-ossp'
 
-        primary_key_and_all_references_to_uuid :cities
+        primary_key_and_all_references_to_uuid :cities, seed: seed
       end
 
       dir.down do
@@ -59,15 +73,16 @@ class MigrateStep01 < ActiveRecordMigration
     reversible do |dir|
       dir.up do
         enable_extension 'pgcrypto'
+        enable_extension 'uuid-ossp'
 
-        primary_key_to_uuid :cities
-        primary_key_to_uuid :colleges
+        primary_key_to_uuid :cities, seed: seed
+        primary_key_to_uuid :colleges, seed: seed
 
-        primary_key_to_uuid :students
-        columns_to_uuid :students, :city_id
+        primary_key_to_uuid :students, seed: seed
+        columns_to_uuid :students, :city_id, seed: seed
 
         change_column :students, :institution_id, :string
-        polymorphic_column_data_for_uuid :students, :institution, 'College'
+        polymorphic_column_data_for_uuid :students, :institution, 'College', seed: seed
       end
 
       dir.down do
@@ -81,8 +96,8 @@ class MigrateStep02 < ActiveRecordMigration
   def change
     reversible do |dir|
       dir.up do
-        primary_key_to_uuid :schools
-        columns_to_uuid :students, :institution_id
+        primary_key_to_uuid :schools, seed: seed
+        polymorphic_column_data_for_uuid :students, :institution, 'School', seed: seed
       end
 
       dir.down do
@@ -117,152 +132,161 @@ describe Webdack::UUIDMigration::Helpers do
     initial_setup
   end
 
-  describe 'Basic Test' do
-    it 'should migrate keys correctly' do
-      # Select a random student
-      student = Student.all.to_a.sample
-
-      # Store these values to check against later
-      original_name= student.name
-      original_ids= [student.id, student.city_id, student.institution_id].map{|i| i.to_i}
-
-      # Migrate and verify that all indexes and primary keys are intact
-      expect {
-        BasicMigration.migrate(:up)
-        reset_columns_data
-      }.to_not change {
-        indexes= Student.connection.indexes(:students).sort_by { |i| i.name }.map do |i|
-          [i.table, i.name, i.unique, i.columns, i.lengths, i.orders, i.where]
+  [nil, SecureRandom.uuid].each do |seed|
+    context "when the seed is #{seed}" do
+      let(:seed_value) { seed }
+
+      describe 'Basic Test' do
+        it 'should migrate keys correctly' do
+          # Select a random student
+          student = Student.all.to_a.sample
+
+          # Store these values to check against later
+          original_name= student.name
+          original_ids= [student.id, student.city_id, student.institution_id].map{|i| i.to_i}
+
+          # Migrate and verify that all indexes and primary keys are intact
+          expect {
+            BasicMigration.seed_with(seed_value).migrate(:up)
+            reset_columns_data
+          }.to_not change {
+            indexes= Student.connection.indexes(:students).sort_by { |i| i.name }.map do |i|
+              [i.table, i.name, i.unique, i.columns, i.lengths, i.orders, i.where]
+            end
+
+            [indexes, Student.connection.primary_key(:students)]
+          }
+
+          # Verify that our data is still there
+          student= Student.where(name: original_name).first
+
+          # Verify that data in id columns have been migrated to UUID by verifying the format
+          [student.id, student.city_id, student.institution_id].each do |id|
+            expect(id).to match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/)
+          end
+
+          unless seed_value
+            # Verify that it is possible to retirve original id values (only without seed!)
+            ids= [student.id, student.city_id, student.institution_id].map{|i| i.gsub('-','').to_i}
+            expect(ids).to eq(original_ids)
+          end
+
+          # Verify that schema reprts the migrated columns to be uuid type
+          columns= Student.connection.columns(:students)
+          [:id, :city_id, :institution_id].each do |column|
+            expect(columns.find{|c| c.name == column.to_s}.type).to eq :uuid
+          end
+
+          # Verify that primary key has correct default
+          expect(columns.find{|c| c.name == 'id'}.default_function).to eq 'gen_random_uuid()'
         end
-
-        [indexes, Student.connection.primary_key(:students)]
-      }
-
-      # Verify that our data is still there
-      student= Student.where(name: original_name).first
-
-      # Verify that data in id columns have been migrated to UUID by verifying the format
-      [student.id, student.city_id, student.institution_id].each do |id|
-        expect(id).to match(/^0{8}-0{4}-0{4}-0{4}-\d{12}$/)
       end
 
-      # Verify that it is possible to retirve original id values
-      ids= [student.id, student.city_id, student.institution_id].map{|i| i.gsub('-','').to_i}
-      expect(ids).to eq(original_ids)
-
-      # Verify that schema reprts the migrated columns to be uuid type
-      columns= Student.connection.columns(:students)
-      [:id, :city_id, :institution_id].each do |column|
-        expect(columns.find{|c| c.name == column.to_s}.type).to eq :uuid
+      it 'should migrate entire database in one go' do
+        expect {
+          MigrateAllOneGo.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
       end
 
-      # Verify that primary key has correct default
-      expect(columns.find{|c| c.name == 'id'}.default_function).to eq 'gen_random_uuid()'
-    end
-  end
-
-  it 'should migrate entire database in one go' do
-    expect {
-      MigrateAllOneGo.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-  end
-
-  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
+      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
 
-    # Add Foreign key for this reference as well
-    ActiveRecord::Base.connection.add_foreign_key :students, :cities
+        # 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
+        expect {
+          MigrateWithFk.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
+      end
 
-  it 'should handle nulls' do
-    Student.create(name: 'Student without city or institution')
+      it 'should handle nulls' do
+        Student.create(name: 'Student without city or institution')
 
-    expect {
-      MigrateAllOneGo.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-  end
+        expect {
+          MigrateAllOneGo.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
+      end
 
-  it 'should migrate in steps for polymorphic association' do
-    expect {
-      MigrateStep01.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-
-    expect {
-      MigrateStep02.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-  end
+      it 'should migrate in steps for polymorphic association' do
+        expect {
+          MigrateStep01.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
+
+        expect {
+          MigrateStep02.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+
+        }.to_not change {
+          key_relationships
+        }
+      end
 
-  it 'should allow running same migration data even if it was already migrated' do
-    expect {
-      MigrateStep01.migrate(:up)
-      # Run again
-      MigrateStep01.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-
-    expect {
-      MigrateStep02.migrate(:up)
-      # Run again
-      MigrateStep02.migrate(:up)
-      reset_columns_data
-    }.to_not change {
-      key_relationships
-    }
-  end
+      it 'should allow running same migration data even if it was already migrated' do
+        expect {
+          MigrateStep01.seed_with(seed_value).migrate(:up)
+          # Run again
+          MigrateStep01.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
+
+        expect {
+          MigrateStep02.seed_with(seed_value).migrate(:up)
+          # Run again
+          MigrateStep02.seed_with(seed_value).migrate(:up)
+          reset_columns_data
+        }.to_not change {
+          key_relationships
+        }
+      end
 
-  it 'should allow updation, deletion, and new entity creation' do
-    MigrateAllOneGo.migrate(:up)
-    reset_columns_data
+      it 'should allow updation, deletion, and new entity creation' do
+        MigrateAllOneGo.seed_with(seed_value).migrate(:up)
+        reset_columns_data
 
-    # Select a random student
-    student = Student.all.to_a.sample
+        # Select a random student
+        student = Student.all.to_a.sample
 
-    id= student.id
-    student.name= 'New student 01'
-    student.save
-    student = Student.find(id)
+        id= student.id
+        student.name= 'New student 01'
+        student.save
+        student = Student.find(id)
 
-    expect(student.name).to eq 'New student 01'
+        expect(student.name).to eq 'New student 01'
 
-    expect { student.destroy }.to change { Student.count }.by(-1)
+        expect { student.destroy }.to change { Student.count }.by(-1)
 
-    expect {Student.find(id)}.to raise_exception(ActiveRecord::RecordNotFound)
+        expect {Student.find(id)}.to raise_exception(ActiveRecord::RecordNotFound)
 
-    student= Student.create(
-        name: 'New student 02',
-        city: City.where(name: 'City 2').first,
-        institution: School.where(name: 'School 1').first
-    )
+        student= Student.create(
+            name: 'New student 02',
+            city: City.where(name: 'City 2').first,
+            institution: School.where(name: 'School 1').first
+        )
 
-    expect(City.where(name: 'City 2').first.students.where(name: 'New student 02').first.name).to eq 'New student 02'
-    expect(School.where(name: 'School 1').first.students.where(name: 'New student 02').first.name).to eq 'New student 02'
+        expect(City.where(name: 'City 2').first.students.where(name: 'New student 02').first.name).to eq 'New student 02'
+        expect(School.where(name: 'School 1').first.students.where(name: 'New student 02').first.name).to eq 'New student 02'
 
-    College.where(name: 'College 3').first.students << student
+        College.where(name: 'College 3').first.students << student
 
-    student.reload
+        student.reload
 
-    expect(student.institution.name).to eq 'College 3'
+        expect(student.institution.name).to eq 'College 3'
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdack-uuid_migration
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Useful helpers to migrate Integer id columns to UUID in PostgreSql.