sjain-natural_key 0.0.1 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+== 0.1.0 2009-01-07
+* fixed to accept hash with string keys in addition to symbols
+* cleaned up unnecessary files
+* using Echoe instead of newgem for gem generation
+* github updated
+
+== 0.0.1 2009-01-07
+* initial release

data/{Manifest.txt → Manifest}

@@ -1,14 +1,13 @@
-.gitignore
-History.txt
-lib/natural_key/natural_key.rb
-lib/natural_key.rb
-Manifest.txt
-PostInstall.txt
+CHANGELOG
 Rakefile
 README.rdoc
-test/database.yml
+Manifest
+lib/natural_key/base.rb
+lib/natural_key.rb
 test/fixtures/schema.rb
-test/lib/activerecord_test_case.rb
-test/lib/activerecord_test_connector.rb
 test/test_helper.rb
+test/database.yml
 test/test_natural_key.rb
+test/lib/activerecord_test_connector.rb
+test/lib/activerecord_test_case.rb
+VERSION.yml

data/README.rdoc

@@ -6,34 +6,31 @@
 
 This gem adds create_or_update functionality to ActiveRecord based on a user-defined natural-key.
 
-== FEATURES/PROBLEMS:
-
-* TODO
-
 == SYNOPSIS:
 
-#
-# Table users(first_name varchar, last_name varchar, age integer, address string, salary integer)
-#
-class User < ActiveRecord::Base
-  natural_key :first_name, :last_name
-end
+Define natural key for your model as follows:
 
-User.create_or_update_by_natural_key(:first_name => 'John', :last_name => "Smith", :age => 25, :address => "New York")
+  #
+  # Table users(first_name varchar, last_name varchar, age integer, address string, salary integer)
+  #
+  class User < ActiveRecord::Base
+    natural_key :first_name, :last_name
+  end
 
-== REQUIREMENTS:
+With this in place, a method 'create_or_update_by_natural_key' can be used to invoke create/update.
 
-* TODO
+  User.create_or_update_by_natural_key(:first_name => 'John', :last_name => "Smith", :age => 25, :address => "New York")
 
 == INSTALL:
 
-* gem install natural_key; rake gems:unpack GEM=natural_key
+  gem sources -a http://gems.github.com
+  gem install sjain-natural_key
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2009 Pathfinder Associates, LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,28 +1,15 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/natural_key'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'lib/natural_key'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('natural_key', NaturalKey::VERSION) do |p|
-  p.developer('Pathfinder Associates', 'info@pathf.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+Echoe.new('natural_key', NaturalKey::VERSION) do |p|
+  p.description = "ActiveRecord.create_or_update based on a user-defined natural-key"
+  p.url = "http://github.com/sjain/natural_key"
+  p.author = "Sharad Jain"
+  p.email = "shaanjain@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*", "nbproject/**/*"]
+  p.development_dependencies = []
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 0

data/lib/natural_key.rb

@@ -1,8 +1,9 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'natural_key/natural_key'
-
 module NaturalKey
-  VERSION = '0.0.1'
+  version = YAML.load_file(File.dirname(__FILE__) + "/../VERSION.yml")
+  VERSION = "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
 end
+
+require 'natural_key/base'

data/lib/natural_key/base.rb

@@ -0,0 +1,38 @@
+require 'activerecord'
+
+module NaturalKey
+  module Base
+    def natural_key(*key_attributes)
+      # TODO validate the supplied key_attributes are subset of all attributes
+      # TODO key_attributes should default to primary_key/surrogate_key (:id)
+      # TODO if natural_key is composed of non-primary-key, then it should not contain primary_key
+      raise "natural key attributes cannot be empty" if key_attributes.empty?
+      @@key_attributes = key_attributes
+    end
+
+    # can't use method "create_or_update" since there is already a private method with that name
+    # in ActiveRecord::Base
+    # 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) }
+      record = find(:first, :conditions => key_options)
+      if(record.nil?)
+        record = create(options)
+      else
+        record.update_attributes!(options)
+      end
+      record
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+    class << self
+      include NaturalKey::Base
+    end
+  end
+end

data/natural_key.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{natural_key}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sharad Jain"]
+  s.date = %q{2009-08-08}
+  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/base.rb", "lib/natural_key.rb"]
+  s.files = ["CHANGELOG", "Rakefile", "README.rdoc", "Manifest", "lib/natural_key/base.rb", "lib/natural_key.rb", "test/fixtures/schema.rb", "test/test_helper.rb", "test/database.yml", "test/test_natural_key.rb", "test/lib/activerecord_test_connector.rb", "test/lib/activerecord_test_case.rb", "VERSION.yml", "natural_key.gemspec"]
+  s.has_rdoc = true
+  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.1}
+  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 = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/lib/activerecord_test_case.rb

@@ -1,6 +1,8 @@
 require 'lib/activerecord_test_connector'
 
-class ActiveRecordTestCase < Test::Unit::TestCase
+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')
@@ -15,22 +17,18 @@ class ActiveRecordTestCase < Test::Unit::TestCase
     super if ActiveRecordTestConnector.connected
   end
 
-  # Default so Test::Unit::TestCase doesn't complain
-  def test_truth
-  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_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
+  def assert_no_queries(&block)
+    assert_queries(0, &block)
+  end
 end
 
 ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'active_record'
 require 'active_record/version'
 require 'active_record/fixtures'
@@ -32,7 +33,7 @@ class ActiveRecordTestConnector
   end
 
   def self.setup_connection
-    db = ENV['DB'].blank?? 'mysql' : ENV['DB']
+    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

data/test/test_helper.rb

@@ -4,7 +4,7 @@ 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
+#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)

data/test/test_natural_key.rb

@@ -5,6 +5,13 @@ class User < ActiveRecord::Base
 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")
@@ -12,10 +19,14 @@ class TestNaturalKey < ActiveRecordTestCase
     assert_equal(25, updated_record.age)
     assert_equal("New York", updated_record.address)
   end
-  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)
+  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

metadata

@@ -1,66 +1,53 @@
 --- !ruby/object:Gem::Specification 
 name: sjain-natural_key
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
-- Pathfinder Associates
+- Sharad Jain
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 -08:00
+date: 2009-08-08 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.3
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.0
-    version: 
-description: This gem adds create_or_update functionality to ActiveRecord based on a user-defined natural-key.
-email: 
-- info@pathf.com
+dependencies: []
+
+description: ActiveRecord.create_or_update based on a user-defined natural-key
+email: shaanjain@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- CHANGELOG
 - README.rdoc
-files: 
-- .gitignore
-- History.txt
-- lib/natural_key/natural_key.rb
+- lib/natural_key/base.rb
 - lib/natural_key.rb
-- Manifest.txt
-- PostInstall.txt
+files: 
+- CHANGELOG
 - Rakefile
 - README.rdoc
-- test/database.yml
+- Manifest
+- lib/natural_key/base.rb
+- lib/natural_key.rb
 - test/fixtures/schema.rb
-- test/lib/activerecord_test_case.rb
-- test/lib/activerecord_test_connector.rb
 - test/test_helper.rb
+- test/database.yml
 - test/test_natural_key.rb
+- test/lib/activerecord_test_connector.rb
+- test/lib/activerecord_test_case.rb
+- VERSION.yml
+- natural_key.gemspec
 has_rdoc: true
-homepage: http://www.pathf.com
-post_install_message: PostInstall.txt
+homepage: http://github.com/sjain/natural_key
+licenses: 
+post_install_message: 
 rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Natural_key
 - --main
 - README.rdoc
 require_paths: 
@@ -75,15 +62,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: "1.2"
   version: 
 requirements: []
 
 rubyforge_project: natural_key
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: This gem adds create_or_update functionality to ActiveRecord based on a user-defined natural-key.
+summary: ActiveRecord.create_or_update based on a user-defined natural-key
 test_files: 
 - test/test_helper.rb
 - test/test_natural_key.rb

data/.gitignore

@@ -1 +0,0 @@
-pkg/*

data/History.txt

@@ -1,4 +0,0 @@
-== 0.0.1 2009-01-07
-
-* 1 major enhancement:
-  * Initial release

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-For more information on ar_natural_key_utils, see http://ar_natural_key_utils.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-

data/lib/natural_key/natural_key.rb

@@ -1,37 +0,0 @@
-module ActiveRecord
-  class Base
-    class << self
-      def natural_key(*key_attributes)
-        # TODO validate the supplied key_attributes are subset of all attributes
-        # TODO key_attributes should default to primary_key/surrogate_key (:id)
-        # TODO if natural_key is composed of non-primary-key, then it should not contain primary_key
-        raise "natural key attributes cannot be empty" if key_attributes.empty?
-        @@key_attributes = key_attributes
-      end
-
-      # can't use method "create_or_update" since there is already a private method with that name
-      # in ActiveRecord::Base
-      # 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)
-        #TODO options should contain all key_attributes, and their values should be non-nil
-        key_options = options.reject { |k,v| !@@key_attributes.include?(k) }
-        record = find(:first, :conditions => key_options)
-        if(record.nil?)
-          record = create(options)
-        else
-          record.update_attributes!(options)
-        end
-        record
-      end
-    end
-  end
-end
-
-#module NaturalKey
-#  def self.included other
-#    other.extend self
-#  end
-#end
-#
-#ActiveRecord::Base.send :include, NaturalKey