natural_key 0.2.2 → 1.0.0

data/README.rdoc

@@ -24,7 +24,7 @@ With this in place, a method 'create_or_update_by_natural_key' can be used to in
 == INSTALL:
 
   gem sources -a http://gems.github.com
-  gem install sjain-natural_key
+  gem install natural_key
 
 == LICENSE:
 

data/Rakefile

@@ -1,3 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-#require "test/unit"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/lib/natural_key.rb

@@ -1,7 +1,6 @@
 require 'natural_key/version'
+require 'natural_key/base'
 
 module NaturalKey
   # Your code goes here...
 end
-
-require 'natural_key/base'

data/lib/natural_key/base.rb

@@ -16,18 +16,35 @@ module ActiveRecord
       # TODO The following method should only be made available when natural_key is called with proper
       # attributes. (hint: use class_eval?)
       def create_or_update_by_natural_key(options)
-        options.symbolize_keys!
-        #TODO options should contain all key_attributes, and their values should be non-nil
-        key_options = options.reject { |k,v| !key_attributes.include?(k) }
-        raise "key_options cannot be empty" if key_options.empty?
-        record = find(:first, :conditions => key_options)
+        record = locate_record(options)
         if(record.nil?)
           record = create(options)
+        else
+          record.update_attributes(options)
+        end
+        record
+      end
+
+      def create_or_update_by_natural_key!(options)
+        record = locate_record(options)
+        if(record.nil?)
+          record = create!(options)
         else
           record.update_attributes!(options)
         end
         record
       end
+
+      private
+
+      def locate_record(options)
+        options.symbolize_keys!
+        #TODO options should contain all key_attributes, and their values should be non-nil
+        key_options = options.reject { |k,v| !key_attributes.include?(k) }
+        raise "key_options cannot be empty" if key_options.empty?
+        find(:first, :conditions => key_options)
+      end
+
     end
   end
 end

data/lib/natural_key/version.rb

@@ -1,3 +1,3 @@
 module NaturalKey
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/natural_key.gemspec

@@ -13,40 +13,11 @@ Gem::Specification.new do |gem|
   gem.name          = "natural_key"
   gem.require_paths = ["lib"]
   gem.version       = NaturalKey::VERSION
+
   gem.add_dependency "activerecord", "~> 3.2.0"
+
   gem.add_development_dependency "rake", "~> 0.9.2.2"
-  gem.add_development_dependency "minitest", "~> 3.0.0"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+  #gem.add_development_dependency "mocha"
 end
-
-
-# -*- encoding: utf-8 -*-
-
-#Gem::Specification.new do |s|
-  #s.name = %q{natural_key}
-  #s.version = NaturalKey::VERSION
-
-  #s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  #s.authors = ["Sharad Jain"]
-  #s.date = %q{2010-02-26}
-  #s.description = %q{ActiveRecord.create_or_update based on a user-defined natural-key}
-  #s.email = %q{shaanjain@gmail.com}
-  #s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/natural_key.rb", "lib/natural_key/base.rb"]
-  #s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "VERSION.yml", "lib/natural_key.rb", "lib/natural_key/base.rb", "natural_key.gemspec", "test/database.yml", "test/fixtures/schema.rb", "test/lib/activerecord_test_case.rb", "test/lib/activerecord_test_connector.rb", "test/test_helper.rb", "test/test_natural_key.rb"]
-  #s.homepage = %q{http://github.com/sjain/natural_key}
-  #s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Natural_key", "--main", "README.rdoc"]
-  #s.require_paths = ["lib"]
-  #s.rubyforge_project = %q{natural_key}
-  #s.rubygems_version = %q{1.3.5}
-  #s.summary = %q{ActiveRecord.create_or_update based on a user-defined natural-key}
-  #s.test_files = ["test/test_helper.rb", "test/test_natural_key.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
-  #  else
-  #  end
-  #else
-  #end
-#end

data/spec/natural_key/base_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+class User < ActiveRecord::Base
+  #include NaturalKey
+  natural_key :first_name, :last_name
+
+  attr_accessor :age_required
+
+  validates :first_name, :presence => true
+  validates :age, :presence => true, :if => 'age_required == true'
+end
+
+describe NaturalKey do
+
+  before do
+    User.destroy_all
+  end
+
+  it "should create by natural key" do
+    created_record = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
+    updated_record = User.create_or_update_by_natural_key(:first_name => 'Different', :last_name => "Smith", :age => 25, :address => "New York")
+    updated_record.id.should_not == created_record.id
+    updated_record.age.should == 25
+    updated_record.address.should == "New York"
+  end
+
+  it "should update by natural key" do
+    created_record = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
+    updated_record = User.create_or_update_by_natural_key(:first_name => 'John', :last_name => "Smith", :age => 25, :address => "New York")
+    updated_record.id.should == created_record.id
+    updated_record.age.should == 25
+    updated_record.address.should == "New York"
+  end
+
+  it "should update by natural key when keys are strings instead of symbols" do
+    User.create(:first_name => 'Mary', :last_name => "Beth", :age => 21, :address => "Chicago")
+    john_smith = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
+    updated_record = User.create_or_update_by_natural_key(
+      'first_name' => 'John',
+      'last_name' => "Smith",
+      'age' => 25,
+      'address' => "New York"
+    )
+    updated_record.id.should == john_smith.id
+    updated_record.age.should == 25
+    updated_record.address.should == "New York"
+  end
+
+  context 'returning invalid record on validation failure' do
+    it "should return invalid record with creation fails validation" do
+      record = User.create_or_update_by_natural_key(
+        :first_name => nil, # validation failure
+      )
+      record.should_not be_valid
+      record.errors.get(:first_name).should == ["can't be blank"]
+    end
+
+    it "should return invalid record with update fails validation" do
+      User.create(
+        :first_name => 'John',
+        :last_name => "Smith",
+        :age => 21,
+        :address => "Chicago"
+      )
+      updated_record = User.create_or_update_by_natural_key(
+        :first_name => 'John',
+        :last_name => "Smith",
+        :age_required => true,
+        :age => nil
+      )
+      updated_record.should_not be_valid
+      updated_record.errors.get(:age).should == ["can't be blank"]
+    end
+  end
+
+  context 'raise error on validation failure' do
+    it "should raise error on creation when validation fails" do
+      begin
+        User.create_or_update_by_natural_key!(
+          :first_name => nil, # validation failure
+        )
+        fail("Expected ActiveRecord exception, found none.")
+      rescue ActiveRecord::RecordInvalid => e
+        # expected
+      end
+    end
+    it "should raise error on update validation fails" do
+      User.create(
+        :first_name => 'John',
+        :last_name => "Smith",
+        :age => 21,
+        :address => "Chicago"
+      )
+      begin
+        User.create_or_update_by_natural_key!(
+          :first_name => 'John',
+          :last_name => "Smith",
+          :age_required => true,
+          :age => nil
+        )
+      rescue ActiveRecord::RecordInvalid
+        # expected
+      end
+    end
+  end
+
+
+end

data/spec/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+ActiveRecord::Base.connection.create_table(:users) do |t|
+    t.string :first_name
+    t.string :last_name
+    t.integer :age
+    t.string :address
+    t.integer :salary, :default => 70000
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'natural_key'
+#require 'mocha'
+require 'schema'
+
+RSpec.configure do |config|
+  # nothing yet
+end

metadata

@@ -1,81 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: natural_key
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Sharad Jain
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-06-05 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2157335700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.2.0
-  prerelease: false
-  requirement: *id001
   type: :runtime
-  name: activerecord
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *2157335700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157334880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 9
-        - 2
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
-  prerelease: false
-  requirement: *id002
   type: :development
-  name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *2157334880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157334200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: *id003
+  version_requirements: *2157334200
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2157332480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: minitest
+  prerelease: false
+  version_requirements: *2157332480
 description: ActiveRecord.create_or_update based on a user-defined natural-key
-email: 
+email:
 - shaanjain@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.rdoc
@@ -86,49 +73,41 @@ files:
 - natural_key.gemspec
 - script/console
 - script/console.cmd
-- test/database.yml
-- test/fixtures/schema.rb
-- test/lib/activerecord_test_case.rb
-- test/lib/activerecord_test_connector.rb
-- test/test_helper.rb
-- test/test_natural_key.rb
+- spec/natural_key/base_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/sjain/natural_key
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 743010638410990413
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 743010638410990413
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: ActiveRecord.create_or_update based on a user-defined natural-key
-test_files: 
-- test/database.yml
-- test/fixtures/schema.rb
-- test/lib/activerecord_test_case.rb
-- test/lib/activerecord_test_connector.rb
-- test/test_helper.rb
-- test/test_natural_key.rb
+test_files:
+- spec/natural_key/base_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb

data/test/database.yml

@@ -1,23 +0,0 @@
-mysql:
-  adapter: mysql
-  username: arnk
-  password: arnk
-  encoding: utf8
-  database: ar_natural_key_test
-  host: 127.0.0.1
-
-sqlite3:
-  database: ":memory:"
-  adapter: sqlite3
-  timeout: 500
-
-sqlite2:
-  database: ":memory:"
-  adapter: sqlite2
-
-postgres:
-  adapter: postgresql
-  username: postgres
-  password: postgres
-  database: arnk_test
-  min_messages: warning

data/test/fixtures/schema.rb

@@ -1,9 +0,0 @@
-ActiveRecord::Schema.define do
-  create_table :users, :force => true do |t|
-    t.string :first_name
-    t.string :last_name
-    t.integer :age
-    t.string :address
-    t.integer :salary, :default => 70000
-  end
-end

data/test/lib/activerecord_test_case.rb

@@ -1,34 +0,0 @@
-require 'lib/activerecord_test_connector'
-
-class ActiveRecordTestCase < ActiveRecord::TestCase
-  include ActiveRecord::TestFixtures
-
-  # Set our fixture path
-  if ActiveRecordTestConnector.able_to_connect
-    self.fixture_path = File.join(File.dirname(__FILE__), '..', 'fixtures')
-    self.use_transactional_fixtures = true
-  end
-
-  def self.fixtures(*args)
-    super if ActiveRecordTestConnector.connected
-  end
-
-  def run(*args)
-    super if ActiveRecordTestConnector.connected
-  end
-
-  protected
-
-  def assert_queries(num = 1)
-    $query_count = 0
-    yield
-  ensure
-    assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
-  end
-
-  def assert_no_queries(&block)
-    assert_queries(0, &block)
-  end
-end
-
-ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -1,76 +0,0 @@
-require 'rubygems'
-require 'active_record'
-require 'active_record/version'
-require 'active_record/fixtures'
-
-class ActiveRecordTestConnector
-  cattr_accessor :able_to_connect
-  cattr_accessor :connected
-
-  FIXTURES_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
-
-  # Set our defaults
-  self.connected = false
-  self.able_to_connect = true
-
-  def self.setup
-    unless self.connected || !self.able_to_connect
-      setup_connection
-      load_schema
-      add_load_path FIXTURES_PATH
-      self.connected = true
-    end
-  rescue Exception => e  # errors from ActiveRecord setup
-    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
-    self.able_to_connect = false
-  end
-
-  private
-  
-  def self.add_load_path(path)
-    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
-    dep.load_paths.unshift path
-  end
-
-  def self.setup_connection
-    db = ENV['DB'].blank?? 'sqlite3' : ENV['DB']
-    
-    configurations = YAML.load_file(File.join(File.dirname(__FILE__), '..', 'database.yml'))
-    raise "no configuration for '#{db}'" unless configurations.key? db
-    configuration = configurations[db]
-    
-    ActiveRecord::Base.logger = Logger.new(STDOUT) if $0 == 'irb'
-    puts "using #{configuration['adapter']} adapter" unless ENV['DB'].blank?
-    
-    gem 'sqlite3-ruby' if 'sqlite3' == db
-    
-    ActiveRecord::Base.establish_connection(configuration)
-    ActiveRecord::Base.configurations = { db => configuration }
-    prepare ActiveRecord::Base.connection
-
-    unless Object.const_defined?(:QUOTED_TYPE)
-      Object.send :const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')
-    end
-  end
-
-  def self.load_schema
-    ActiveRecord::Base.silence do
-      ActiveRecord::Migration.verbose = false
-      load File.join(FIXTURES_PATH, 'schema.rb')
-    end
-  end
-
-  def self.prepare(conn)
-    class << conn
-      IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SHOW FIELDS /]
-
-      def execute_with_counting(sql, name = nil, &block)
-        $query_count ||= 0
-        $query_count  += 1 unless IGNORED_SQL.any? { |r| sql =~ r }
-        execute_without_counting(sql, name, &block)
-      end
-
-      alias_method_chain :execute, :counting
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,16 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
-
-require 'stringio'
-#require 'test/unit'
-require 'lib/activerecord_test_case'
-#require File.dirname(__FILE__) + '/../lib/natural_key'
-
-# gem install redgreen for colored test output
-#begin require 'redgreen'; rescue LoadError; end
-
-# The following is not required since we use active-record gem installed on the system
-#require 'boot' unless defined?(ActiveRecord)
-
-class Test::Unit::TestCase
-# any test helper methods can go here
-end

data/test/test_natural_key.rb

@@ -1,33 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class User < ActiveRecord::Base
-  natural_key :first_name, :last_name
-end
-
-class TestNaturalKey < ActiveRecordTestCase
-  def test_create_by_natural_key
-    created_record = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
-    updated_record = User.create_or_update_by_natural_key(:first_name => 'Different', :last_name => "Smith", :age => 25, :address => "New York")
-    assert_not_equal(created_record.id, updated_record.id)
-    assert_equal(25, updated_record.age)
-    assert_equal("New York", updated_record.address)
-  end
-  def test_update_by_natural_key
-    created_record = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
-    updated_record = User.create_or_update_by_natural_key(:first_name => 'John', :last_name => "Smith", :age => 25, :address => "New York")
-    assert_equal(created_record.id, updated_record.id)
-    assert_equal(25, updated_record.age)
-    assert_equal("New York", updated_record.address)
-  end
-  def test_update_by_natural_key_when_keys_are_strings_instead_of_symbols
-    User.create(:first_name => 'Mary', :last_name => "Beth", :age => 21, :address => "Chicago")
-    john_smith = User.create(:first_name => 'John', :last_name => "Smith", :age => 21, :address => "Chicago")
-    updated_record = User.create_or_update_by_natural_key('first_name' => 'John',
-      'last_name' => "Smith",
-      'age' => 25,
-      'address' => "New York")
-    assert_equal(john_smith.id, updated_record.id)
-    assert_equal(25, updated_record.age)
-    assert_equal("New York", updated_record.address)
-  end
-end