acts_as_uuid 0.0.3 → 0.1.1

data/README.md

@@ -10,7 +10,7 @@ Add this to your `Gemfile`:
 
 `gem "acts_as_uuid"`
 
-You can now set the type `uuid` for any attribute in your models.
+You can now set the type `uuid` for an attribute in your models.
 
 ## Example: Adding a UUID primary key to your models
 
@@ -27,6 +27,8 @@ class AddUUIDPrimaryKeyToEmail < ActiveRecord::Migration
 end
 ```
 
+*Don't forget:* You will also need to change any foreign keys to the `uuid` type.
+
 ### Step 1b: Migrating existing models
 
 For existing models just add:
@@ -40,16 +42,48 @@ class AddUUIDPrimaryKeyToEmail < ActiveRecord::Migration
   end
 end
 ```
-Keep in mind that after this all your UUIDs will be set to nil.
 
-### Step 2: Extend your model
+*Keep in mind:*  after this all your UUIDs will be set to nil.
+
+### Step 2: Extend your model to auto generate UUIDs for a field
 
 ```ruby
 class Email < ActiveRecord::Base
   include ActsAsUUID
+  uuid_on :id, :as => :primary_key
+end
+```
+
+## Example: Adding a UUID as a separate field
+
+### Step 1: Migrate a model
+
+```ruby
+class AddUUIDPrimaryKeyToEmail < ActiveRecord::Migration
+  def self.change
+    add_column :emails, :guid, :uuid
+    add_index :emails, :guid, :unique => true
+  end
 end
 ```
 
-### License
+*Keep in mind:*  after this all your UUIDs will be set to nil.
+
+### Step 2: Extend your model to auto generate UUIDs for a field
+
+```ruby
+class Email < ActiveRecord::Base
+  include ActsAsUUID
+  uuid_on :guid
+end
+```
+
+## Important notes
+
+* Currently only supports 1 field to be set to auto generate a UUID
+* Integers can't be migrated to UUIDs without losing data
+* If you use a UUID as a primary key you will lose some ActiveRecord features like: `.first`, `.find_each` and `.find_in_batches`. Basically any method that requires the ID to be sorted as an integer.
+
+## License
 
 See LICENSE

data/lib/acts_as_uuid/acts_as_uuid.rb

@@ -1,11 +1,23 @@
 module ActsAsUUID
   def self.included klass
     klass.before_validation :generate_uuid
-    klass.validates :id, :uniqueness => true
-    klass.primary_key = :id
+    klass.extend ClassMethods
   end
 
   def generate_uuid
-    self.id ||= UUID.generate
+    self[self.class.acts_as_uuid_field] ||= UUID.generate
   end
+
+  module ClassMethods
+
+    def uuid_on field, options = {}
+      self.acts_as_uuid_field = field
+      self.validates field, :uniqueness => true
+      self.primary_key = field if options[:as] == :primary_key
+    end
+
+    attr_accessor :acts_as_uuid_field
+    protected :acts_as_uuid_field=
+  end
+
 end

data/lib/acts_as_uuid/version.rb

@@ -1,3 +1,3 @@
 module ActsAsUuid
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 0
-  - 3
-  version: 0.0.3
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Cristiano Betta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-30 00:00:00 Z
+date: 2012-02-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec