sjain-natural_key 0.0.1

data/.gitignore

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

data/History.txt

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

data/Manifest.txt

@@ -0,0 +1,14 @@
+.gitignore
+History.txt
+lib/natural_key/natural_key.rb
+lib/natural_key.rb
+Manifest.txt
+PostInstall.txt
+Rakefile
+README.rdoc
+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

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+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/README.rdoc

@@ -0,0 +1,55 @@
+= natural_key
+
+* http://www.pathf.com
+
+== DESCRIPTION:
+
+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
+
+User.create_or_update_by_natural_key(:first_name => 'John', :last_name => "Smith", :age => 25, :address => "New York")
+
+== REQUIREMENTS:
+
+* TODO
+
+== INSTALL:
+
+* gem install natural_key; rake gems:unpack GEM=natural_key
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/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'
+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]

data/lib/natural_key/natural_key.rb

@@ -0,0 +1,37 @@
+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

data/lib/natural_key.rb

@@ -0,0 +1,8 @@
+$:.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'
+end

data/test/database.yml

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,36 @@
+require 'lib/activerecord_test_connector'
+
+class ActiveRecordTestCase < Test::Unit::TestCase
+  # 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
+
+  # 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_no_queries(&block)
+      assert_queries(0, &block)
+    end
+end
+
+ActiveRecordTestConnector.setup

data/test/lib/activerecord_test_connector.rb

@@ -0,0 +1,75 @@
+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?? 'mysql' : 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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class User < ActiveRecord::Base
+  natural_key :first_name, :last_name
+end
+
+class TestNaturalKey < ActiveRecordTestCase
+  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_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
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: sjain-natural_key
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pathfinder Associates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-09 00:00:00 -08: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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- lib/natural_key/natural_key.rb
+- lib/natural_key.rb
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- README.rdoc
+- 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
+has_rdoc: true
+homepage: http://www.pathf.com
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: natural_key
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This gem adds create_or_update functionality to ActiveRecord based on a user-defined natural-key.
+test_files: 
+- test/test_helper.rb
+- test/test_natural_key.rb