composite_primary_keys 0.8.6 → 0.9.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.9.0 2007-09-28
+
+* Added support for polymorphs [thx nerdrew]
+* init.rb file so gem can be installed as a plugin for Rails [thx nerdrew]
+* Added ibm_db support [thx K Venkatasubramaniyan]
+* Support for cleaning dependents [thx K Venkatasubramaniyan]
+* Rafactored db rake tasks into namespaces
+* Added namespaced tests (e.g. mysql:test for test_mysql)
+
 == 0.8.6 / 2007-6-12
 
 * 1 emergency fix due to Rails Core change

data/Manifest.txt

@@ -1,35 +1,70 @@
 History.txt
 Manifest.txt
 README.txt
+README_DB2.txt
 Rakefile
+init.rb
 install.rb
+lib/adapter_helper/base.rb
+lib/adapter_helper/mysql.rb
+lib/adapter_helper/oracle.rb
+lib/adapter_helper/postgresql.rb
+lib/adapter_helper/sqlite3.rb
 lib/composite_primary_keys.rb
 lib/composite_primary_keys/associations.rb
 lib/composite_primary_keys/base.rb
 lib/composite_primary_keys/calculations.rb
 lib/composite_primary_keys/composite_arrays.rb
+lib/composite_primary_keys/connection_adapters/ibm_db_adapter.rb
 lib/composite_primary_keys/connection_adapters/oracle_adapter.rb
 lib/composite_primary_keys/connection_adapters/postgresql_adapter.rb
 lib/composite_primary_keys/fixtures.rb
+lib/composite_primary_keys/migration.rb
 lib/composite_primary_keys/reflection.rb
 lib/composite_primary_keys/version.rb
+loader.rb
+local/database_connections.rb.sample
+local/paths.rb.sample
+local/tasks.rb.sample
+scripts/console.rb
 scripts/txt2html
 scripts/txt2js
+tasks/activerecord_selection.rake
+tasks/databases.rake
+tasks/databases/mysql.rake
+tasks/databases/oracle.rake
+tasks/databases/postgresql.rake
+tasks/databases/sqlite3.rake
+tasks/deployment.rake
+tasks/local_setup.rake
+tasks/website.rake
+test/README_tests.txt
 test/abstract_unit.rb
 test/composite_arrays_test.rb
+test/connections/native_ibm_db/connection.rb
 test/connections/native_mysql/connection.rb
 test/connections/native_oracle/connection.rb
 test/connections/native_postgresql/connection.rb
 test/connections/native_sqlite/connection.rb
 test/fixtures/article.rb
 test/fixtures/articles.yml
+test/fixtures/comment.rb
+test/fixtures/comments.yml
+test/fixtures/db_definitions/db2-create-tables.sql
+test/fixtures/db_definitions/db2-drop-tables.sql
 test/fixtures/db_definitions/mysql.sql
 test/fixtures/db_definitions/oracle.drop.sql
 test/fixtures/db_definitions/oracle.sql
 test/fixtures/db_definitions/postgresql.sql
 test/fixtures/db_definitions/sqlite.sql
+test/fixtures/department.rb
+test/fixtures/departments.yml
+test/fixtures/employee.rb
+test/fixtures/employees.yml
 test/fixtures/group.rb
 test/fixtures/groups.yml
+test/fixtures/hack.rb
+test/fixtures/hacks.yml
 test/fixtures/membership.rb
 test/fixtures/membership_status.rb
 test/fixtures/membership_statuses.yml
@@ -63,9 +98,11 @@ test/test_find.rb
 test/test_ids.rb
 test/test_miscellaneous.rb
 test/test_pagination.rb
+test/test_polymorphic.rb
 test/test_santiago.rb
 test/test_tutorial_examle.rb
 test/test_update.rb
+tmp/test.db
 website/index.html
 website/index.txt
 website/javascripts/rounded_corners_lite.inc.js

data/README.txt

@@ -1,16 +1,41 @@
+= Composite Primary Keys for ActiveRecords
+
+== Summary
 
-Composite Primary Keys for ActiveRecords
-Summary:
 ActiveRecords/Rails famously doesn't support composite primary keys. 
-For 2 years there has been no support for this aspect of legacy databases. 
-This project will be a fully-featured solution and I welcome use cases and 
-legacy DB schema samples to help make the project work with as many common 
-legacy environments as possible.
+This RubyGem extends the activerecord gem to provide CPK support.
+
+== Installation
+
+    gem install composite_primary_keys
+    
+== Usage
+  
+    require 'composite_primary_keys'
+    class ProductVariation
+      set_primary_keys :product_id, :variation_seq
+    end
+    
+    pv = ProductVariation.find(345, 12)
+    
+It even supports composite foreign keys for associations.
+
+See http://compositekeys.rubyforge.org for more.
+
+== Running Tests
+
+See test/README.tests.txt
+
+== Url
 
-Url:
 http://compositekeys.rubyforge.org
 
-Questions and Discussion:
+== Questions, Discussion and Contributions
+
 http://groups.google.com/compositekeys
 
-Written by Dr Nic Williams, drnicwilliams@gmail
+== Author
+
+Written by Dr Nic Williams, drnicwilliams@gmail
+Contributions by many!
+

data/README_DB2.txt

@@ -0,0 +1,33 @@
+Composite Primary key support for db2 
+
+== Driver Support ==
+
+DB2 support requires the IBM_DB driver provided by http://rubyforge.org/projects/rubyibm/
+project. Install using gem install ibm_db. Tested against version 0.60 of the driver.
+This rubyforge project appears to be permenant location for the IBM adapter.
+Older versions of the driver available from IBM Alphaworks will not work. 
+
+== Driver Bug and workaround provided as part of this plugin ==
+
+Unlike the basic quote routine available for Rails AR, the DB2 adapter's quote
+method doesn't return " column_name = 1 " when string values (integers in string type variable) 
+are passed for quoting numeric column. Rather it returns "column_name = '1'. 
+DB2 doesn't accept single quoting numeric columns in SQL. Currently, as part of 
+this plugin a fix is provided for the DB2 adapter since this plugin does 
+pass string values like this. Perhaps a patch should be sent to the DB2 adapter
+project for a permanant fix.
+
+== Database Setup ==
+
+Database must be manually created using a separate command. Read the rake task
+for creating tables and change the db name, user and passwords accordingly.
+
+== Tested Database Server version ==
+
+This is tested against DB2 v9.1 in Ubuntu Feisty Fawn (7.04)
+
+== Tested Database Client version ==
+
+This is tested against DB2 v9.1 in Ubuntu Feisty Fawn (7.04)
+
+

data/Rakefile

@@ -15,14 +15,17 @@ AUTHOR = "Dr Nic Williams"
 EMAIL = "drnicwilliams@gmail.com"
 DESCRIPTION = "Composite key support for ActiveRecords"
 GEM_NAME = "composite_primary_keys" # what ppl will type to install your gem
-config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-RUBYFORGE_USERNAME = config["username"]
+if File.exists?("~/.rubyforge/user-config.yml")
+  # TODO this should prob go in a local/ file
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  RUBYFORGE_USERNAME = config["username"]
+end
 RUBYFORGE_PROJECT = "compositekeys"
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 
 REV = nil #File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
 VERS = ENV['VERSION'] || (CompositePrimaryKeys::VERSION::STRING + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config','debug.log','*.db','logfile','.DS_Store', '.project']
+CLEAN.include ['**/.*.sw?', '*.gem', '.config','debug.log','*.db','logfile','log/**/*','**/.DS_Store', '.project']
 RDOC_OPTS = ['--quiet', '--title', "newgem documentation",
     "--opname", "index.html",
     "--line-numbers", 
@@ -57,120 +60,6 @@ CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
 PATH    = RUBYFORGE_PROJECT
 hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
 
+PROJECT_ROOT = File.expand_path(".")
 
-# UNTESTED - firebird sqlserver sqlserver_odbc db2 sybase openbase
-for adapter in %w( mysql sqlite oracle postgresql ) 
-  Rake::TestTask.new("test_#{adapter}") { |t|
-    t.libs << "test" << "test/connections/native_#{adapter}"
-    t.pattern = "test/test_*.rb"
-    t.verbose = true
-  }
-end
-
-SCHEMA_PATH = File.join(File.dirname(__FILE__), *%w(test fixtures db_definitions))
-
-desc 'Build the MySQL test databases'
-task :build_mysql_databases do 
-  puts File.join(SCHEMA_PATH, 'mysql.sql')
-  socket = '/Applications/MAMP/tmp/mysql/mysql.sock'
-  user   = 'root'
-  sh %{ mysqladmin -u #{user} -S #{socket} -p create "#{GEM_NAME}_unittest" }
-  sh %{ mysql -u #{user} -S #{socket} -p "#{GEM_NAME}_unittest" < #{File.join(SCHEMA_PATH, 'mysql.sql')} }
-end
-
-desc 'Drop the MySQL test databases'
-task :drop_mysql_databases do 
-  socket = '/Applications/MAMP/tmp/mysql/mysql.sock'
-  user   = 'root'
-  sh %{ mysqladmin -u #{user} -S #{socket} -p -f drop "#{GEM_NAME}_unittest" }
-end
-
-desc 'Rebuild the MySQL test databases'
-
-task :rebuild_mysql_databases => [:drop_mysql_databases, :build_mysql_databases]
-
-desc 'Build the sqlite test databases'
-task :build_sqlite_databases do 
-  file = File.join(SCHEMA_PATH, 'sqlite.sql')
-  cmd = "sqlite3 test.db < #{file}"
-  puts cmd
-  sh %{ #{cmd} }
-end
-
-desc 'Drop the sqlite test databases'
-task :drop_sqlite_databases do 
-  sh %{ rm -f test.db }
-end
-
-desc 'Rebuild the sqlite test databases'
-task :rebuild_sqlite_databases => [:drop_sqlite_databases, :build_sqlite_databases]
-
-desc 'Build the PostgreSQL test databases'
-task :build_postgresql_databases do 
-  sh %{ createdb "#{GEM_NAME}_unittest" }
-  sh %{ psql "#{GEM_NAME}_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
-end
-
-desc 'Drop the PostgreSQL test databases'
-task :drop_postgresql_databases do 
-  sh %{ dropdb "#{GEM_NAME}_unittest" }
-end
-
-desc 'Rebuild the PostgreSQL test databases'
-task :rebuild_postgresql_databases => [:drop_postgresql_databases, :build_postgresql_databases]
-
-desc 'Build the Oracle test databases'
-task :build_oracle_databases do 
-  puts File.join(SCHEMA_PATH, 'oracle.sql')
-  sh %( sqlplus holstdl/holstdl@test < #{File.join(SCHEMA_PATH, 'oracle.sql')} )
-end
-
-desc 'Drop the Oracle test databases'
-task :drop_oracle_databases do 
-  sh %( sqlplus holstdl/holstdl@test < #{File.join(SCHEMA_PATH, 'oracle.drop.sql')} )
-end
-
-desc 'Rebuild the Oracle test databases'
-task :rebuild_oracle_databases => [:drop_oracle_databases, :build_oracle_databases]
-
-desc 'Generate website files'
-task :website_generate do
-  sh %{ ruby scripts/txt2html website/index.txt > website/index.html }
-  sh %{ ruby scripts/txt2js website/version.txt > website/version.js }
-  sh %{ ruby scripts/txt2js website/version-raw.txt > website/version-raw.js }
-end
-
-desc 'Upload website files to rubyforge'
-task :website_upload do
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
-  local_dir = 'website'
-  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
-end
-
-desc 'Generate and upload website files'
-task :website => [:website_generate, :website_upload, :publish_docs]
-
-desc 'Release the website and new gem version'
-task :deploy => [:check_version, :website, :release] do
-  puts "Remember to create SVN tag:"
-  puts "svn copy svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/trunk " +
-    "svn+ssh://#{RUBYFORGE_USERNAME}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
-  puts "Suggested comment:"
-  puts "Tagging release #{CHANGES}"
-end
-
-desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
-task :local_deploy => [:website_generate, :install_gem]
-
-task :check_version do
-  unless ENV['VERSION']
-    puts 'Must pass a VERSION=x.y.z release version'
-    exit
-  end
-  unless ENV['VERSION'] == VERS
-    puts "Please update your version.rb to match the release version, currently #{VERS}"
-    exit
-  end
-end
+require 'loader'

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require_dependency 'composite_primary_keys'

data/lib/adapter_helper/base.rb

@@ -0,0 +1,63 @@
+module AdapterHelper
+  class Base
+    class << self
+      attr_accessor :adapter
+
+      def load_connection_from_env(adapter)
+        self.adapter = adapter
+        unless ENV['cpk_adapters']
+          puts error_msg_setup_helper
+          exit
+        end
+
+        all_specs = YAML.load(ENV['cpk_adapters'])
+        unless spec = all_specs[adapter]
+          puts error_msg_adapter_helper
+          exit
+        end
+        spec[:adapter] = adapter
+        spec
+      end
+    
+      def error_msg_setup_helper
+        <<-EOS
+Setup Helper:
+  CPK now has a place for your individual testing configuration.
+  That is, instead of hardcoding it in the Rakefile and test/connections files,
+  there is now a local/database_connections.rb file that is NOT in the
+  repository. Your personal DB information (username, password etc) can
+  be stored here without making it difficult to submit patches etc.
+
+Installation:
+  i)   cp locals/database_connections.rb.sample locals/database_connections.rb
+  ii)  For #{adapter} connection details see "Adapter Setup Helper" below.
+  iii) Rerun this task
+  
+#{error_msg_adapter_helper}
+  
+Current ENV:
+  #{ENV.inspect}
+        EOS
+      end
+        
+      def error_msg_adapter_helper
+        <<-EOS
+Adapter Setup Helper:
+  To run #{adapter} tests, you need to setup your #{adapter} connections.
+  In your local/database_connections.rb file, within the ENV['cpk_adapter'] hash, add:
+      "#{adapter}" => { adapter settings }
+
+  That is, it will look like:
+    ENV['cpk_adapters'] = {
+      "#{adapter}" => {
+        :adapter  => "#{adapter}",
+        :username => "root",
+        :password => "root",
+        # ...
+      }
+    }.to_yaml
+        EOS
+      end
+    end
+  end
+end

data/lib/adapter_helper/mysql.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'base')
+
+module AdapterHelper
+  class MySQL < Base
+    class << self
+      def load_connection_from_env
+        spec = super('mysql')
+        spec[:database] ||= 'composite_primary_keys_unittest'
+        spec
+      end
+    end
+  end
+end

data/lib/adapter_helper/oracle.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'base')
+
+module AdapterHelper
+  class Oracle < Base
+    class << self
+      def load_connection_from_env
+        spec = super('oracle')
+        spec[:database] ||= 'composite_primary_keys_unittest'
+        spec
+      end
+    end
+  end
+end

data/lib/adapter_helper/postgresql.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'base')
+
+module AdapterHelper
+  class Postgresql < Base
+    class << self
+      def load_connection_from_env
+        spec = super('postgresql')
+        spec[:database] ||= 'composite_primary_keys_unittest'
+        spec
+      end
+    end
+  end
+end

data/lib/adapter_helper/sqlite3.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'base')
+
+module AdapterHelper
+  class Sqlite3 < Base
+    class << self
+      def load_connection_from_env
+        spec = super('sqlite3')
+        spec[:dbfile] ||= "tmp/test.db"
+        spec
+      end
+    end
+  end
+end