random_unique_id 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a7b92c76f522b3336630120ac9d9b882eaef76c
-  data.tar.gz: b5664b1d2c1bbb5942c5a94fbc89e66b8eb7c61d
+  metadata.gz: 5f1c4b031d065a8bec8f97393e82ad781fc33aee
+  data.tar.gz: 1e0fc4defa8a5dc2d6bef5f04739b23372ace1a0
 SHA512:
-  metadata.gz: f7ccd53a8efdbc946946a1be8180bae4b5b62c1325591a129d5b1d1a9d636d2e8e2fffc5044230edb540cd05bd7b61deae7b5fc047663b9346cc42da3cc42647
-  data.tar.gz: 5115455385496f828995823603bc4a5caa92d14e7688c65a8e28173579d1805e3836aab7d77936453b03eea96ad02377cb53e41f898493906202e2043e10de8d
+  metadata.gz: 76166e35364c68b99a623c9018efc28da9af99026d4a7f69a4886fcf61e1ce82604c59322f969c6d0c657a543bd2994afa004471dc720b43bd4391658a3c08e7
+  data.tar.gz: e32b66eebcec4dc4649153f2fb6be5235b8868a5dd3613426969feb29b7a8e7e484735cef743a3a465a6dedd7257bdda19cef60eda0e4c43d6d90b29a46ec643

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
+  - "2.1.1"
 gemfile:
   - gemfiles/rails_3_2.Gemfile
   - gemfiles/rails_4_0.Gemfile

data/Gemfile

@@ -1,16 +1,16 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 source "https://rubygems.org"
 
 gem "bundler", "~> 1.3"
 gem "coveralls", require: false
-gem "minitest"
+gem "minitest", "~> 4.7.5"
 gem "minitest-reporters"
 gem "mocha"
 gem "rake"
 gem "simplecov"
 gem "shoulda"
 gem "sqlite3"
-gem "activesupport", "~> 4.0.0"
-gem "activerecord", "~> 4.0.0"
+gem "activesupport", "~> 3.2.0"
+gem "activerecord", "~> 3.2.0"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright © 2013, Watu
+Copyright © 2013, 2014, Watu
 
 MIT License
 

data/README.md

@@ -2,11 +2,16 @@
 
 [![Build Status](https://travis-ci.org/watu/random_unique_id.png?branch=master)](https://travis-ci.org/watu/random_unique_id)
 [![Coverage Status](https://coveralls.io/repos/watu/random_unique_id/badge.png?branch=master)](https://coveralls.io/r/watu/random_unique_id?branch=master)
+[![Code Climate](https://codeclimate.com/github/watu/random_unique_id.png)](https://codeclimate.com/github/watu/random_unique_id)
+[![Gem Version](https://badge.fury.io/rb/random_unique_id.png)](http://badge.fury.io/rb/random_unique_id)
 
 This gem will generate a random unique id for your active record records that you can use instead of their actual ID for
 all external interactions with users. The goal is for you to be able to hide how many records you have, for business
 purposes, but also to make IDs non-predictable.
 
+This gem is built to work with Ruby 1.9, 2.0, 2.1 as well as with Rails 3.2 and 4.0. All of these cases are
+[continuously tested for](https://travis-ci.org/watu/random_unique_id.png?branch=master).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -34,10 +39,43 @@ For example:
       has_random_unique_id
     end
 
-You need to also add a column, called `rid` of type string/varchar. It is recommended that you also add an index on that
-column.
+You need to also add a column, called `rid` of type string/varchar. It is recommended that you also add a unique index
+on that column, for example:
+
+    def up
+      add_column :posts, :rid, :string
+      add_index :posts, :rid, :unique
+    end
+
+The method `to_param` will be overridden to return the `rid` instead of the `id`. The method `belongs_to` gets extended
+to define `_rid` methods similar to the `_id` method, like: `blog_rid` and `blog_rid=`. If you don't want to define
+those pass `define_rid_method` as false, for example:
+
+    class Post
+      belongs_to :blog, define_rid_method: false
+    end
+
+Classes that have rids also get a method called `populate_random_unique_ids` to help you populate the rid of existing
+records. For example:
+
+    def up
+      add_column :posts, :rid, :string
+      add_index :posts, :rid, :unique
+      say_with_time "Post.populate_random_unique_ids" do
+        Post.reset_column_information
+        Post.populate_random_unique_ids { print "."}
+      end
+    end
+
+## Changelog
+
+### Version 0.2.0
+- Added method populate_random_unique_ids.
+- Improved documentation
+- Started testing with Ruby 2.1.
 
-The method to_param will be overridden to return the rid instead of the id.
+### Version 0.1.0
+- Initial release of the code extracted from [Watu](http://github.com/watu).
 
 ## Contributing
 

data/Rakefile

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 require "bundler/gem_tasks"
 

data/gemfiles/rails_3_2.Gemfile

@@ -1,11 +1,11 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 source "https://rubygems.org"
 
 gem "bundler", "~> 1.3"
 gem "coveralls", require: false
-gem "minitest", "~> 2.5.1"
+gem "minitest", "~> 4.7.5"
 gem "minitest-reporters"
 gem "mocha"
 gem "rake"

data/gemfiles/rails_4_0.Gemfile

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 source "https://rubygems.org"
 

data/lib/random_unique_id.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2011, 2012, 2013, Watu
+# Copyright © 2011, 2012, 2013, 2014, Watu
 
 require "random_unique_id/version"
 require "securerandom"
@@ -10,6 +10,18 @@ module RandomUniqueId
   extend ActiveSupport::Concern
 
   module ClassMethods
+    # Mark a model as containing a random unique id. A field called rid of type string is required. It's recommended
+    # that it's indexed and unique. For example, you could add it to a migration like this:
+    #   def up
+    #     add_column :posts, :rid, :string
+    #     add_index :posts, :rid, :unique
+    #   end
+    #
+    # and then to the model like this:
+    #   class Post
+    #     has_random_unique_id
+    #     # ... other stuff
+    #   end
     def has_random_unique_id
       validates :rid, presence: true, uniqueness: true
       before_validation :generate_random_unique_id, if: Proc.new { |r| r.rid.blank? }
@@ -42,6 +54,32 @@ module RandomUniqueId
         end
       end
     end
+
+    # Populate all the blank rids in a table. This is useful when adding rids to a table that already has data in it.
+    # For example:
+    #   def up
+    #     add_column :posts, :rid, :string
+    #     add_index :posts, :rid, :unique
+    #     say_with_time "Post.populate_random_unique_ids" do
+    #       Post.reset_column_information
+    #       Post.populate_random_unique_ids { print "."}
+    #     end
+    #   end
+    #
+    # This method uses update_column to avoid running validations and callbacks. It will not change existing rids, so
+    # it's safe to call several times and a failure (even without a transaction) is not catastrophic.
+    def populate_random_unique_ids
+      find_each do |record|
+        rid_just_populated = false
+        if record.rid.blank?
+          record.generate_random_unique_id
+          record.update_column(:rid, record.rid)
+          rid_just_populated = true
+        end
+        yield(record, rid_just_populated) if block_given?
+      end
+    end
+
   end
 
   def generate_random_unique_id(n=5, field="rid")

data/lib/random_unique_id/version.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 module RandomUniqueId
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/random_unique_id.gemspec

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/test/random_unique_id_test.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-# Copyright © 2011, 2012, 2013, Watu
+# Copyright © 2011, 2012, 2013, 2014, Watu
 
 require_relative "test_helper"
 
@@ -8,6 +8,7 @@ require "random_unique_id"
 ActiveRecord::Schema.define(version: 0) do
   create_table :blogs do |t|
     t.string :rid
+    t.string :name
   end
   add_index :blogs, :rid, unique: true
 
@@ -77,5 +78,20 @@ class RandomUniqueIdTest < MiniTest::Unit::TestCase
       assert_equal blog, @text_post.blog
       assert_equal blog.rid, @text_post.blog_rid
     end
+
+    should "populate a table with rids" do
+      # Create a bunch of blogs without rid by manually inserting them into the talbe.
+      rid_less_records = 10
+      5.times { Blog.create! }
+      existing_rids = Blog.all.map(&:rid).compact
+      rid_less_records.times { Blog.connection.execute("INSERT INTO blogs (name) VALUES ('Blag')") }
+      assert_equal rid_less_records, Blog.where(:rid => nil).count # Just to be sure this test is being effective.
+
+      rids_populated = 0
+      Blog.populate_random_unique_ids { |_, rid_just_populated| rids_populated += 1 if rid_just_populated }
+      assert_equal rid_less_records, rids_populated
+      assert_equal 0, Blog.where(:rid => nil).count
+      assert_equal existing_rids.count, Blog.where(:rid => existing_rids).count # Make sure the existing rids where not touched.
+    end
   end
 end

data/test/test_helper.rb

@@ -1,12 +1,15 @@
 # encoding: UTF-8
-# Copyright © 2013, Watu
+# Copyright © 2013, 2014, Watu
 
 require "rubygems"
 
+# Test coverage
 require "simplecov"
+require "coveralls"
 SimpleCov.start do
   add_filter "/test/"
 end
+Coveralls.wear! # Comment out this line to have the local coverage generated.
 
 require "minitest/autorun"
 require "minitest/reporters"
@@ -23,14 +26,14 @@ require "shoulda-matchers"
 
 require "mocha/setup"
 
+# Database setup
 require "active_record"
+require "logger"
 ActiveRecord::Base.logger = Logger.new(STDERR)
 ActiveRecord::Base.logger.level = Logger::WARN
 ActiveRecord::Base.configurations = {"sqlite3" => {adapter: "sqlite3", database: ":memory:"}}
 ActiveRecord::Base.establish_connection("sqlite3")
 
-require "coveralls"
-Coveralls.wear!
-
+# Make the code to be tested easy to load.
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: random_unique_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - J. Pablo Fernández
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.2.0
 description: Generate random but unique ids for your active record records.
@@ -45,8 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,20 +68,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generate random but unique ids for your active record records.
 test_files:
 - test/random_unique_id_test.rb
 - test/test_helper.rb
+has_rdoc: