pg_random_id 0.1.0 → 0.2.0

data/README.md

@@ -40,6 +40,10 @@ class InstallRandomId < ActiveRecord::Migration
     # install the necessary SQL functions in the DB
     create_random_id_functions
   end
+
+  def down
+    drop_random_id_functions
+  end
 end
 
 class CreateProducts < ActiveRecord::Migration
@@ -51,6 +55,11 @@ class CreateProducts < ActiveRecord::Migration
     # make the table use random ids
     random_id :products
   end
+
+  def down
+    # the random id will be removed along with the table
+    drop_table :products
+  end
 end
 
 class RandomizeIdsOnWidgets < ActiveRecord::Migration
@@ -59,6 +68,10 @@ class RandomizeIdsOnWidgets < ActiveRecord::Migration
     # 'widgets' random (using string ids)
     random_str_id :widgets, :widget_id # you can specify id column name
   end
+  
+  def down
+    remove_random_id :widgets, :widget_id
+  end
 end
 ```
 
@@ -70,6 +83,10 @@ Sequel.migration do
     # install the necessary SQL functions in the DB
     create_random_id_functions
   end
+
+  down do
+    drop_random_id_functions
+  end
 end
 
 Sequel.migration do
@@ -82,6 +99,11 @@ Sequel.migration do
     # make the table use random ids
     random_id :products
   end
+
+  down do
+    # the random id will be removed along with the table
+    drop_table :products
+  end
 end
 
 Sequel.migration do
@@ -90,6 +112,10 @@ Sequel.migration do
     # 'widgets' random (using string ids)
     random_str_id :widgets, :widget_id # you can specify id column name
   end
+
+  down do
+    remove_random_id :widgets, :widget_id
+  end
 end
 ```
 

data/lib/pg_random_id/migrations.rb

@@ -8,6 +8,11 @@ module PgRandomId
       execute PgRandomId::Sql::install
     end
     
+    # Drop the functions installed by #create_random_id_functions
+    def drop_random_id_functions
+      execute PgRandomId::Sql::uninstall
+    end
+    
     # Apply a random id to a table.
     # If you don't give a key, a random one will be generated.
     # The ids will be based on sequence "#{table}_#{column}_seq".
@@ -16,6 +21,16 @@ module PgRandomId
       execute PgRandomId::Sql::apply(table, column, key)
     end
 
+    # Changes type of a column to int and restores sequence default on it.
+    #
+    # This is mainly useful for a down migration while developing the database and switching back and forth.
+    # Not needed in real use, as dropping a table will obliterate the default value anyway.
+    # 
+    # You need to make sure the table is empty; migrating existing records is not implemented.
+    def remove_random_id table, column = :id
+      execute PgRandomId::Sql::unapply(table, column)
+    end
+
     # Apply a random string id to a table. 
     # Also changes the type of the id column to char(6).
     # If you don't give a key, a random one will be generated.

data/lib/pg_random_id/sql.rb

@@ -5,12 +5,27 @@ module PgRandomId
         FILES.map {|f| read_file f}.join
       end
       
+      def uninstall
+        """
+          DROP FUNCTION crockford(input bigint);
+          DROP FUNCTION pri_scramble(key bigint, input bigint);
+        """
+      end
+      
       def apply table, column, key = nil, base = nil
         key ||= rand(2**15)
         base ||= sequence_nextval "#{table}_#{column}_seq"
         "ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT pri_scramble(#{key}, #{base})"
       end
       
+      def unapply table, column, base = nil
+        base ||= sequence_nextval "#{table}_#{column}_seq"
+        """
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT #{base};
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DATA TYPE integer USING 0;
+        """
+      end
+      
       def apply_str table, column, key = nil, base = nil
         key ||= rand(2**15)
         base ||= sequence_nextval "#{table}_#{column}_seq"

data/lib/pg_random_id/version.rb

@@ -1,3 +1,3 @@
 module PgRandomId
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pg_random_id.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   
-  %w(activerecord rspec sequel).each do |g|
+  %w(activerecord rspec sequel pg).each do |g|
     gem.add_development_dependency g
   end
 end

data/spec/helpers/migration_spec_helper.rb

@@ -8,6 +8,16 @@ shared_context 'test_migration' do
     end
   end
   
+  describe '#drop_random_id_functions' do
+    it "removes the functions" do
+      migration.create_random_id_functions
+      migration.drop_random_id_functions
+      
+      execute("SELECT 1 FROM pg_proc WHERE proname = 'crockford'").should_not be
+      execute("SELECT 1 FROM pg_proc WHERE proname = 'pri_scramble'").should_not be
+    end
+  end
+  
   describe '#random_id' do
     it "changes the default value" do
       migration.create_random_id_functions
@@ -28,6 +38,26 @@ shared_context 'test_migration' do
       execute("SELECT COUNT(*) FROM foo").first[1].to_i.should == 10
     end
   end
+  
+  describe '#remove_random_id' do
+    it "restores the default value" do
+      migration.create_random_id_functions
+      create_table :foo
+      migration.random_id :foo
+      migration.remove_random_id :foo
+      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_scramble%'").should_not be
+      execute("INSERT INTO foo VALUES (DEFAULT) RETURNING id;").first[1].to_i.should == 1
+    end
+    
+    it "also works with str id" do
+      migration.create_random_id_functions
+      create_table :foo
+      migration.random_str_id :foo
+      migration.remove_random_id :foo
+      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_scramble%'").should_not be
+      execute("INSERT INTO foo VALUES (DEFAULT) RETURNING id;").first[1].to_i.should == 1
+    end
+  end
 
   describe '#random_str_id' do
     it "changes the default value" do

data/spec/sql/crockford_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 require 'active_record'
-require 'pg_random_id/migrations/active_record'
 
 describe 'crockford(bigint)' do
   include_context 'active_record'

data/spec/sql/scramble_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 require 'active_record'
-require 'pg_random_id/migrations/active_record'
 
 describe "pri_scramble(bigint, bigint)" do
   include_context 'active_record'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_random_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easily use randomized keys instead of sequential values for your record
   surrogate ids.
 email: