is_unique 0.0.1

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "is_unique"
+    gemspec.summary = "ActiveRecord extension to prevent duplicate records"
+    gemspec.description = "Makes ActiveRecord return existing records instead of creating duplicates"
+    gemspec.email = "eugene.bolshakov@gmail.com"
+    gemspec.homepage = "http://github.com/loco2/is_unique"
+    gemspec.authors = ["Eugene Bolshakov"]
+    gemspec.add_dependency 'activerecord', '2.3.5'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/is_unique/is_unique_generator.rb

@@ -0,0 +1,16 @@
+class IsUniqueGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'is_unique_migration.rb', 'db/migrate', 
+        :assigns => {:unique_hash_column => actions.first || 'unique_hash' }
+    end
+  end
+
+  def banner
+    "Usage: #{$0} #{spec.name} ModelName [custom_unique_has_column_name] [options]"
+  end
+
+  def file_name
+    "add_unique_hash_column_to_#{@plural_name}"
+  end
+end

data/generators/is_unique/templates/is_unique_migration.rb

@@ -0,0 +1,10 @@
+class <%= file_name.camelcase %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :<%= unique_hash_column %>, :integer
+    add_index :<%= table_name %>, :<%= unique_hash_column %>
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :<%= unique_hash_column %>
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), 'lib', 'is_unique')

data/is_unique.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{is_unique}
+  s.version = "0.0.1"
+
+  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.description = %q{Makes ActiveRecord return existing records instead of creating duplicates}
+  s.email = %q{eugene.bolshakov@gmail.com}
+  s.files = [
+    "Rakefile",
+     "VERSION",
+     "generators/is_unique/is_unique_generator.rb",
+     "generators/is_unique/templates/is_unique_migration.rb",
+     "init.rb",
+     "is_unique.gemspec",
+     "lib/is_unique.rb",
+     "spec/spec_helper.rb",
+     "spec/support/db.rb",
+     "spec/unique_model_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/loco2/is_unique}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{ActiveRecord extension to prevent duplicate records}
+  s.test_files = [
+    "spec/unique_model_spec.rb",
+     "spec/support/db.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["= 2.3.5"])
+    else
+      s.add_dependency(%q<activerecord>, ["= 2.3.5"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["= 2.3.5"])
+  end
+end
+

data/lib/is_unique.rb

@@ -0,0 +1,61 @@
+module IsUnique
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def is_unique(options = {})
+
+      write_inheritable_attribute :is_unique_hash_column, options[:hash_column] || 'unique_hash'
+      class_inheritable_reader    :is_unique_hash_column
+
+      write_inheritable_attribute :is_unique_ignore, [
+        primary_key,
+        is_unique_hash_column.to_s,
+        'created_at',
+        'updated_at'
+      ].concat(Array(options[:ignore]).map(&:to_s))
+
+      self.class_eval do
+        include InstanceMethods
+
+        before_save :calculate_unique_hash
+      end
+    end
+  end
+
+  module InstanceMethods
+    private
+
+      def is_unique_hash
+        send(self.class.is_unique_hash_column)
+      end
+
+      def is_unique_hash=(value)
+        send("#{self.class.is_unique_hash_column}=", value)
+      end
+
+      def create
+        if existing = self.class.find(:first, :conditions => {self.class.is_unique_hash_column => is_unique_hash})
+          self.id = existing.id
+          @new_record = false
+          reload
+          id
+        else
+          super
+        end
+      end
+
+      def calculate_unique_hash
+        self.is_unique_hash = unique_attributes.hash
+      end
+
+      def unique_attributes
+        attributes.except(*self.class.read_inheritable_attribute(:is_unique_ignore))
+      end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include IsUnique
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/is_unique")
+require 'spec'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}

data/spec/support/db.rb

@@ -0,0 +1,31 @@
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def suppress_stdout
+  tmp = $stdout
+  $stdout = StringIO.new
+  yield
+  $stdout = tmp
+end
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :locations do |t|
+      t.string     :name
+      t.float      :lat, :lng
+      t.string     :alias
+      t.integer    :unique_hash
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.before(:all)   { suppress_stdout { setup_db } }
+  config.after(:all)    { suppress_stdout { teardown_db } }
+end

data/spec/unique_model_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+class Location < ActiveRecord::Base
+  # String name 
+  # Float lat
+  # Float lng
+  # String alias
+  # Integer unique_hash
+
+  is_unique :ignore => :alias
+end
+
+describe "A unique model" do
+  before(:each) do
+    @it = Location.create(
+      :name  => 'London',
+      :lat   => '51.5084152563931',
+      :lng   => '-0.125532746315002',
+      :alias => 'Londinium'
+    )
+  end
+
+  it "should not create a new record with the same attributes" do
+    new_record = @it.clone
+    lambda { new_record.save! }.
+      should_not change(Location, :count)
+  end
+
+  it "should not create a new record with a different ignored attribute" do
+    new_record = @it.clone
+    new_record.alias = 'Greater London'
+    lambda { new_record.save! }.
+      should_not change(Location, :count)
+  end
+
+  it "should return the existing record on creation" do
+    new_record = @it.clone
+    new_record.save!
+    new_record.should == @it
+  end
+
+  it "should allow to create a record with different attributes" do
+    new_record = @it.clone
+    new_record.name = 'Greater London'
+    lambda { new_record.save! }.
+      should change(Location, :count).by(1)
+    new_record.should_not == @it
+  end
+
+  it "should allow to create a record with original attributes when an existing record is updated" do
+    new_record = @it.clone
+    @it.update_attribute(:name, 'Greater London')
+    lambda { new_record.save! }.
+      should change(Location, :count).by(1)
+    new_record.should_not == @it
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: is_unique
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eugene Bolshakov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id001
+description: Makes ActiveRecord return existing records instead of creating duplicates
+email: eugene.bolshakov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION
+- generators/is_unique/is_unique_generator.rb
+- generators/is_unique/templates/is_unique_migration.rb
+- init.rb
+- is_unique.gemspec
+- lib/is_unique.rb
+- spec/spec_helper.rb
+- spec/support/db.rb
+- spec/unique_model_spec.rb
+has_rdoc: true
+homepage: http://github.com/loco2/is_unique
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActiveRecord extension to prevent duplicate records
+test_files: 
+- spec/unique_model_spec.rb
+- spec/support/db.rb
+- spec/spec_helper.rb