pg_random_id 0.2.0 → 1.0.0

data/README.md

@@ -7,6 +7,7 @@ or 6-character human-friendly-ish strings (eg. kn5xx1, qy2kp8, e5f67z...).
 
 Since surrogate IDs are often used in REST-ful URLs, this makes the addresses less revealing and harder to guess
 (while preserving the straightforward mapping from URLs to database IDs):
+
 - http://example.com/products/1 → http://example.com/products/134178313
 - http://example.com/products/2 → http://example.com/products/121521131
 - http://example.com/widgets/1 → http://example.com/widgets/2agc30
@@ -119,13 +120,40 @@ Sequel.migration do
 end
 ```
 
+## Upgrading
+
+If you want to upgrade a live database from before 1.0.0 version, you need to call 
+create_random_id_functions in a migration again, as key storage changed
+from being in the default value to a separate key table to allow prefetching values.
+
+Note that existing random ids will still use the old format and you won't be able
+to use `pri_nextval` on them, though they'll continue to work.
+
+If you don't have a live database to upgrade, you don't need to do anything.
+Migration methods haven't changed and will work using the new format;
+just make sure to recreate schema.sql if you're using it.
+
+## Prefetching values
+
+Installing pg_random_id in the database allows using `pri_nextval` and `pri_nextval_str`
+SQL functions in much the same manner as the standard `nextval` function, eg.:
+
+```ruby
+  next = DB["SELECT pri_nextval('foo_id_seq'::regclass)"].first.values[0]
+```
+
+Note that this feature is only available since version 1.0.0.
+
 ## Considerations
 
 No model modification is necessary, just use the table as usual and it will simply work.
 Each table will use its own unique sequence, chosen at random at migration time.
 
+### Foreign keys
+
 If you use `random_str_id` make sure to use a string type in 
 foreign key columns:
+
 ```ruby
 class CreateContraptions < ActiveRecord::Migration
   def up
@@ -135,6 +163,7 @@ class CreateContraptions < ActiveRecord::Migration
   end
 end
 ```
+
 ```ruby
 Sequel.migration do
   up do
@@ -145,6 +174,26 @@ Sequel.migration do
 end
 ```
 
+### Non-serial columns
+
+Both these functions are meant to replace standard serial columns, which means they expect a `#{table}_#{column}_seq`
+sequence to be present. It is automatically created by Postgres when you create a `serial` column (which is what AR 
+implicitly does on `create_table` unless you say `id: false`, and what Sequel does when you say `primary_key :id`),
+but if you're not doing this, make sure to create the sequence, like so:
+
+```ruby
+create_table :groups do
+  String :id, primary_key: true
+  String :name, null: false
+end
+
+execute "CREATE SEQUENCE groups_id_seq OWNED BY groups.id"
+random_str_id :groups # changes id type to char(6)
+
+# Change type back to varchar if you want to be able to use longer ids (ie. not autogenerated)
+execute "ALTER TABLE group ALTER COLUMN id SET DATA TYPE varchar"
+```
+
 ## Notes
 
 The `random_id` function changes the default value of the ID column to a scrambled next sequence value.

data/Rakefile

@@ -1,5 +1,9 @@
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
+
+task jenkins: ['ci:setup:rspec', :spec]

data/lib/pg_random_id/migrations.rb

@@ -18,7 +18,7 @@ module PgRandomId
     # The ids will be based on sequence "#{table}_#{column}_seq".
     # You need to make sure the table is empty; migrating existing records is not implemented.
     def random_id table, column = :id, key = nil
-      execute PgRandomId::Sql::apply(table, column, key)
+      execute PgRandomId::Sql::apply(table, column, key: key)
     end
 
     # Changes type of a column to int and restores sequence default on it.
@@ -38,7 +38,7 @@ module PgRandomId
     # scrambled and base32-encoded.
     # You need to make sure the table is empty; migrating existing records is not implemented.
     def random_str_id table, column = :id, key = nil
-      execute PgRandomId::Sql::apply_str(table, column, key)
+      execute PgRandomId::Sql::apply_str(table, column, key: key)
     end
     
     # Install the migration functions for ActiveRecord

data/lib/pg_random_id/sql/keytable.sql

@@ -0,0 +1,27 @@
+SET LOCAL client_min_messages = error; -- to avoid implicit index messages
+
+CREATE TABLE pri_keys (
+  sequence regclass PRIMARY KEY,
+  key integer NOT NULL);
+
+CREATE OR REPLACE FUNCTION
+pri_nextval(sequence regclass) RETURNS integer
+LANGUAGE sql
+VOLATILE
+STRICT
+AS $$
+  SELECT pri_scramble(key, nextval($1))
+    FROM pri_keys
+    WHERE sequence = $1;
+$$;
+
+CREATE OR REPLACE FUNCTION
+pri_nextval_str(sequence regclass) RETURNS char(6)
+LANGUAGE sql
+VOLATILE
+STRICT
+AS $$
+  SELECT lpad(crockford(pri_scramble(key, nextval($1))), 6, '0')
+    FROM pri_keys
+    WHERE sequence = $1;
+$$;

data/lib/pg_random_id/sql/uninstall.sql

@@ -0,0 +1,7 @@
+DROP FUNCTION pri_nextval(regclass);
+DROP FUNCTION pri_nextval_str(regclass);
+
+DROP TABLE pri_keys;
+
+DROP FUNCTION crockford(input bigint);
+DROP FUNCTION pri_scramble(key bigint, input bigint);

data/lib/pg_random_id/sql.rb

@@ -6,47 +6,46 @@ module PgRandomId
       end
       
       def uninstall
-        """
-          DROP FUNCTION crockford(input bigint);
-          DROP FUNCTION pri_scramble(key bigint, input bigint);
-        """
+        read_file 'uninstall.sql'
       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})"
+      def apply table, column, options = {}
+        key = options[:key] || rand(2**15)
+        sequence = options[:sequence] || "#{table}_#{column}_seq"
+        """
+          INSERT INTO pri_keys VALUES ('#{sequence}'::regclass, #{key});
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT pri_nextval('#{sequence}'::regclass);
+        """
       end
       
-      def unapply table, column, base = nil
-        base ||= sequence_nextval "#{table}_#{column}_seq"
+      def unapply table, column, options = {}
+        sequence = options[:sequence] || "#{table}_#{column}_seq"
         """
-          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT #{base};
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT nextval('#{sequence}'::regclass);
           ALTER TABLE #{table} ALTER COLUMN #{column} SET DATA TYPE integer USING 0;
+          DELETE FROM pri_keys WHERE sequence = '#{sequence}'::regclass;
         """
       end
       
-      def apply_str table, column, key = nil, base = nil
-        key ||= rand(2**15)
-        base ||= sequence_nextval "#{table}_#{column}_seq"
+      def apply_str table, column, options = {}
+        key = options[:key] || rand(2**15)
+        sequence = options[:sequence] || "#{table}_#{column}_seq"
+        type = options[:type] || "character(6)"
         """
-          ALTER TABLE #{table} ALTER COLUMN #{column} SET DATA TYPE character(6);
-          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT lpad(crockford(pri_scramble(#{key}, #{base})), 6, '0');
+          INSERT INTO pri_keys VALUES ('#{sequence}'::regclass, #{key});
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DATA TYPE #{type};
+          ALTER TABLE #{table} ALTER COLUMN #{column} SET DEFAULT pri_nextval_str('#{sequence}'::regclass);
         """
       end
       
       private
 
-      FILES = %w(scramble.sql crockford.sql)
+      FILES = %w(scramble.sql crockford.sql keytable.sql)
       BASEDIR = File.expand_path 'sql', File.dirname(__FILE__)
       
       def read_file filename
         File.read(File.expand_path(filename, BASEDIR))
       end
-      
-      def sequence_nextval sequence_name
-        "nextval('#{sequence_name}'::regclass)"
-      end
     end
   end
 end

data/lib/pg_random_id/version.rb

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

data/pg_random_id.gemspec

@@ -10,14 +10,17 @@ Gem::Specification.new do |gem|
   gem.email         = ["divided.mind@gmail.com"]
   gem.description   = %q{Easily use randomized keys instead of sequential values for your record surrogate ids.}
   gem.summary       = %q{Pseudo-random record ids in Postgres}
-  gem.homepage      = "https://github.com/dividedmind/pg_random_id"
+  gem.homepage      = "https://github.com/inscitiv/pg_random_id"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   
-  %w(activerecord rspec sequel pg).each do |g|
-    gem.add_development_dependency g
-  end
+  gem.add_development_dependency 'activerecord', '~>3.2'
+  gem.add_development_dependency 'rspec', '~>2.12'
+  gem.add_development_dependency 'sequel', '~>3.44'
+  gem.add_development_dependency 'pg', '~>0.14'
+  gem.add_development_dependency 'ci_reporter', '~>1.8'
+  gem.add_development_dependency 'rake', '~>10.0'
 end

data/spec/helpers/migration_spec_helper.rb

@@ -23,7 +23,7 @@ shared_context 'test_migration' do
       migration.create_random_id_functions
       create_table :foo
       migration.random_id :foo
-      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_scramble%'").should be
+      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_%'").should be
     end
 
     it "creates a few values without error" do
@@ -36,6 +36,7 @@ shared_context 'test_migration' do
         }.to_not raise_error
       end
       execute("SELECT COUNT(*) FROM foo").first[1].to_i.should == 10
+      execute("SELECT id FROM foo LIMIT 1").first[1].to_i.should_not == 1
     end
   end
   
@@ -45,7 +46,7 @@ shared_context 'test_migration' do
       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("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_%'").should_not be
       execute("INSERT INTO foo VALUES (DEFAULT) RETURNING id;").first[1].to_i.should == 1
     end
     
@@ -54,7 +55,7 @@ shared_context 'test_migration' do
       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("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_%'").should_not be
       execute("INSERT INTO foo VALUES (DEFAULT) RETURNING id;").first[1].to_i.should == 1
     end
   end
@@ -64,8 +65,7 @@ shared_context 'test_migration' do
       migration.create_random_id_functions
       create_table :foo
       migration.random_str_id :foo
-      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_scramble%'").should be
-      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%crockford%'").should be
+      execute("SELECT 1 FROM pg_attrdef WHERE adrelid = 'foo'::regclass AND adsrc LIKE '%pri_%'").should be
       execute("INSERT INTO foo VALUES (DEFAULT) RETURNING id;").first[1].should_not == '1'
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_random_id
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,72 +9,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.44'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Easily use randomized keys instead of sequential values for your record
   surrogate ids.
 email:
@@ -93,7 +125,9 @@ files:
 - lib/pg_random_id/sql.rb
 - lib/pg_random_id/sql/crockford-pure.sql
 - lib/pg_random_id/sql/crockford.sql
+- lib/pg_random_id/sql/keytable.sql
 - lib/pg_random_id/sql/scramble.sql
+- lib/pg_random_id/sql/uninstall.sql
 - lib/pg_random_id/version.rb
 - pg_random_id.gemspec
 - spec/helpers/active_record_helper.rb
@@ -103,7 +137,7 @@ files:
 - spec/spec_helper.rb
 - spec/sql/crockford_spec.rb
 - spec/sql/scramble_spec.rb
-homepage: https://github.com/dividedmind/pg_random_id
+homepage: https://github.com/inscitiv/pg_random_id
 licenses: []
 post_install_message: 
 rdoc_options: []