is_unique 0.0.2 → 0.0.3

data/README

@@ -0,0 +1,65 @@
+Is Unique
+=========
+
+This is a simple ActiveRecord extension that makes sure that no duplicate records are added to the database. When you create a new model instance that already exists, it won't create a new record, but return the existing one instead. The extension generates a hash off the model attributes and use it to check for existing records. Of course, it ignores primary key, created_at, updated_at and other columns that you ask it to.
+
+Here's an example. Say you have a Location model and you want all your locations to be unique. When you add a new location you'd like to check whether it already exists and if it does, you don't want to create a new record.
+
+$ ./script/generate model Location name:string lat:float lng:float alias:string
+
+IsUnique will take care of that. You need to install the gem:
+
+$ sudo gem install is_unique
+
+Then you need to add a column to your table to store a unique hash that would be used to check for existing records. The gem includes a generator for that:
+
+$ ./script/generate is_unique Location
+
+In the model you need to specify that it's supposed to be unique:
+
+class Location < ActiveRecord::Base
+  is_unique
+end
+
+Then fire up console and try it:
+
+>> l = Location.create(:name => 'London', :lat => '51.5', :lng => '-0.13', :alias => 'Londinium')
+  Location Load (0.4ms)   SELECT * FROM "locations" WHERE ("locations"."unique_hash" = 189338025) LIMIT 1
+  Location Create (0.6ms)   INSERT INTO "locations" ...
+=> #<Location id: ...>
+>> l.clone.save
+  Location Load (0.7ms)   SELECT * FROM "locations" WHERE ("locations"."unique_hash" = 189338025) LIMIT 1
+  Location Load (0.6ms)   SELECT * FROM "locations" WHERE ("locations"."id" = 1)
+=> true
+
+Now there's a couple of customization options. First, you can ignore certain attributes when calculating the hash. Say there may be different aliases for a location, but you still want just one record in the database. The is_unique method accepts an ignore parameter for that purpose:
+
+class Location < ActiveRecord::Base
+  is_unique :ignore => :alias
+end
+
+>> l = Location.last
+  Location Load (0.7ms)   SELECT * FROM "locations" ORDER BY locations.id DESC LIMIT 1
+=> #<Location ...>
+>> n = l.clone
+=> #<Location ...>
+>> n.alias = 'Something different'
+=> "Something different"
+>> n.save
+  Location Load (0.7ms)   SELECT * FROM "locations" WHERE ("locations"."unique_hash" = 189338025) LIMIT 1
+  Location Load (0.6ms)   SELECT * FROM "locations" WHERE ("locations"."id" = 2) 
+=> true
+>> n == l
+=> true
+
+If you'd like to name the unique hash column differently (it's "unique_hash" by default), you need to provide the name to the generator:
+
+$ ./script/generate is_unique Location my_unique_hash_column_name
+
+and specify it in the model:
+
+class Location < ActiveRecord::Base
+  is_unique :hash_column => :my_unique_has_column_name
+end
+
+Copyright (c) 2010 Loco2, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/generators/is_unique/templates/is_unique_migration.rb

@@ -3,7 +3,7 @@ class <%= file_name.camelcase %> < ActiveRecord::Migration
     add_column :<%= table_name %>, :<%= unique_hash_column %>, :integer
     add_index :<%= table_name %>, :<%= unique_hash_column %>
     # Generate hashes for existing records
-    <%= class_name %>.all.collect { |r| r.save(false) }
+    <%= class_name %>.find_each { |r| r.save(false) }
   end
 
   def self.down

data/is_unique.gemspec

@@ -5,15 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{is_unique}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eugene Bolshakov"]
-  s.date = %q{2010-03-22}
+  s.date = %q{2010-03-24}
   s.description = %q{Makes ActiveRecord return existing records instead of creating duplicates}
   s.email = %q{eugene.bolshakov@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
   s.files = [
     ".gitignore",
+     "README",
      "Rakefile",
      "VERSION",
      "generators/is_unique/is_unique_generator.rb",

data/lib/is_unique.rb

@@ -47,7 +47,7 @@ module IsUnique
       end
 
       def calculate_unique_hash
-        self.is_unique_hash = unique_attributes.hash
+        self.is_unique_hash = unique_attributes.sort_by{ |pair| pair.hash }.hash
       end
 
       def unique_attributes

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Eugene Bolshakov
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-22 00:00:00 +03:00
+date: 2010-03-24 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,10 +37,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - .gitignore
+- README
 - Rakefile
 - VERSION
 - generators/is_unique/is_unique_generator.rb