dr_nic_magic_models 0.8.1 → 0.9.0

data/History.txt

@@ -0,0 +1,10 @@
+*** 0.9.0 / 2007-4-9
+
++ 1 major enhancement:
+        + Support for dynamic loading of classes again
++ 2 new DB supported:
+        + Tests run on sqlite (no fk support)
+				+ Tests run on postgresql (fk support)
++ Many fixes that I've lost track of
++ History.txt to keep track of changes like these
++ Using Hoe for Rakefile

data/Manifest.txt

@@ -0,0 +1,55 @@
+CHANGELOG
+History.txt
+Manifest.txt
+README
+Rakefile
+install.rb
+lib/base.rb
+lib/connection_adapters/abstract/schema_statements.rb
+lib/connection_adapters/abstract_adapter.rb
+lib/connection_adapters/mysql_adapter.rb
+lib/connection_adapters/postgresql_adapter.rb
+lib/dr_nic_magic_models.rb
+lib/dr_nic_magic_models/inflector.rb
+lib/dr_nic_magic_models/magic_model.rb
+lib/dr_nic_magic_models/schema.rb
+lib/dr_nic_magic_models/validations.rb
+lib/dr_nic_magic_models/version.rb
+lib/module.rb
+lib/rails.rb
+scripts/txt2html
+scripts/txt2js
+test.db
+test/abstract_unit.rb
+test/connections/native_mysql/connection.rb
+test/connections/native_postgresql/connection.rb
+test/connections/native_sqlite/connection.rb
+test/dummy_test.rb
+test/env_test.rb
+test/fixtures/.DS_Store
+test/fixtures/adjectives.yml
+test/fixtures/adjectives_fun_users.yml
+test/fixtures/db_definitions/mysql.drop.sql
+test/fixtures/db_definitions/mysql.sql
+test/fixtures/db_definitions/postgresql.sql
+test/fixtures/db_definitions/sqlite.sql
+test/fixtures/fun_users.yml
+test/fixtures/group_memberships.yml
+test/fixtures/group_tag.yml
+test/fixtures/groups.yml
+test/foreign_keys_test.rb
+test/fun_user_plus.rb
+test/invisible_model_access_test.rb
+test/invisible_model_assoc_test.rb
+test/invisible_model_classes_test.rb
+test/magic_module_test.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.js
+website/template.rhtml
+website/version-raw.js
+website/version-raw.txt
+website/version.js
+website/version.txt

data/README

@@ -0,0 +1,268 @@
+See http://magicmodels.rubyforge.org/dr_nic_magic_models for pretty README
+
+Ugly README (from website/index.txt in Textile format):
+
+h1. Dr Nic's Magic Models
+
+If you've used Ruby on Rails you'll have written at least one model class like this:
+
+<pre syntax='ruby'>
+class Person < ActiveRecord::Base
+  has_many :memberships
+  has_many :groups, :through => :memberships
+  belongs_to :family
+  validates_presence_of :firstname, :lastname, :email
+end
+</pre>
+
+A few minutes later you'll have wondered to yourself,
+
+<blockquote>
+Why do I have write my own <code>has_many</code>, <code>belongs_to</code>, and <code>validates_presence_of</code> 
+commands if all the data is in the database schema?
+</blockquote>
+
+Now, for the very first time, your classes can look like this:
+
+<pre syntax='ruby'>
+class Person < ActiveRecord::Base
+end
+</pre>
+
+or, if you are lazy...
+
+<pre syntax='ruby'>
+class Person < ActiveRecord::Base; end
+</pre>
+
+or, if you read right to the end of this page, this...
+
+<pre syntax='ruby'>
+# Go fish.
+</pre>
+
+Magic and mystery abound. All for you. Impress your friends, amaze your mother.
+
+NOTE: The gratuitous use of *Dr Nic's* in the name should only enhance the mystical magikery,
+for magic needs a magician; and I love magic. I always wanted to create my own magic trick.
+So I shall be the magician for the sake of magic itself. I look a bit like Harry Potter too,
+if Harry were 32 and better dressed.
+
+h2. Installation
+
+To install the Dr Nic's Magic Models gem you can run the following command to 
+fetch the gem remotely from RubyForge:
+<pre>
+gem install dr_nic_magic_models
+</pre>
+
+or "download the gem manually":http://rubyforge.org/projects/magicmodels and 
+run the above command in the download directory.
+
+Now you need to <code>require</code> the gem into your Ruby/Rails app. Insert the following
+line into your script (use <code>config/environment.rb</code> for your Rails apps):
+
+<pre>
+require 'dr_nic_magic_models'
+</pre>
+
+Your application is now blessed with magical mystery.
+
+h2. David Copperfield eat your Ruby-crusted heart out
+
+Let's demonstrate the magical mystery in all its full-stage glory. Create a Ruby on Rails app:
+
+<pre syntax="ruby">
+rails magic_show
+cd magic_show
+ruby script/generate model Person
+ruby script/generate model Group
+ruby script/generate model Membership
+</pre>
+
+Update the migration <code>001_create_people.rb</code> with:
+<pre syntax="ruby">
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.column :firstname, :string, :null => false
+      t.column :lastname, :string, :null => false
+      t.column :email, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :people
+  end
+end
+</pre>
+
+Similarly, update the <code>def self.up</code> method of <code>002_create_groups.rb</code>
+with:
+<pre syntax="ruby">
+    create_table :groups do |t|
+      t.column :name, :string, :null => false
+      t.column :description, :string
+    end
+</pre>
+
+and <code>003_create_memberships.rb</code> with:
+<pre syntax="ruby">
+    create_table :memberships do |t|
+      t.column :person_id, :integer, :null => false
+      t.column :group_id, :integer, :null => false
+    end
+</pre>
+
+Now create your database. For MySql:
+<pre>
+mysqladmin -u root create magic_show_development
+mysqladmin -u root create magic_show_test
+</pre>
+
+And run your migrations to create the three tables:
+<pre>
+rake migrate
+</pre>
+
+h2. And now for some "woofle dust":http://en.wikipedia.org/wiki/List_of_conjuring_terms ...
+
+At the end of <code>config/environment.rb</code> add the following line:
+
+<pre>
+require 'dr_nic_magic_models'
+</pre>
+
+Now, let's do a magic trick. First, let's check our model classes (<code>app/models/person.rb</code> etc):
+
+<pre syntax="ruby">
+class Person < ActiveRecord::Base
+end
+class Group < ActiveRecord::Base
+end
+class Membership < ActiveRecord::Base
+end
+</pre>
+
+Nothing suspicious here. We have no validations and no associations. Just some plain old model classes.
+
+For this trick, we'll need an ordinary console session. Any old one lying around the house will do.
+
+<pre>
+ruby script/console
+</pre>
+
+Now a normal model class is valid until you explicitly add <code>validates_xxx</code> commands.
+With Dr Nic's Magic Models:
+
+<pre syntax="ruby">
+>> person = Person.new
+=> #<Person:0x393e0f8 @attributes={"lastname"=>"", "firstname"=>"", "email"=>""}, @new_record=true>
+>> person.valid?
+=> false
+>> person.errors
+=> <ActiveRecord::Errors:0x3938b18 @errors={"firstname"=>["can't be blank"], 
+"lastname"=>["can't be blank"], "email"=>["can't be blank"]}, 
+@base=<Person:0x393e0f8 @errors=<ActiveRecord::Errors:0x3938b18 ...>, 
+@attributes={"lastname"=>"", "firstname"=>"", "email"=>""}, @new_record=true>>
+</pre>
+
+*Kapoow!* Instant validation!
+
+Because you specified the three columns as <code>:null => false</code>,
+your ActiveRecord models will now automatically generated <code>validates_presence_of</code>
+for each non-null field.
+
+Ok, we're just warming up.
+
+Your models normally require association commands (<code>has_many</code>, <code>belongs_to</code>, etc, as 
+demonstrated above) to have the brilliantly simple support that Rails/ActiveRecords are known for.
+
+Let's just watch what Dr Nic's Magic Models can do without any effort at all...
+
+<pre syntax="ruby">
+>> person = Person.create(:firstname => "Nic", :lastname => "Williams", :email => "drnicwilliams@gmail.com")
+>> group = Group.create(:name => "Magic Models Forum", :description => "http://groups.google.com/magicmodels")
+>> membership = Membership.create(:person_id => person, :group_id => group)
+>> person.memberships.length
+=> 1
+>> membership.person
+=> <Person:0x38898e8 @attributes={"lastname"=>"Williams", "firstname"=>"Nic", 
+"id"=>"1", "email"=>"drnicwilliams@gmail.com"}>
+>> group.memberships
+=> [<Membership:0x3c8cd70 @attributes={"group_id"=>"1", "id"=>"1", "person_id"=>"1"}>]
+</pre>
+
+
+The final association trick is a ripper. Automatic generation of <code>has_many :through</code> associations...
+
+<pre syntax="ruby">
+>> person.groups
+=> [<Group:0x39047e0 @attributes={"name"=>"Magic Models Forum", "id"=>"1", "description"=>nil}>]
+>> group.people
+=> [<Person:0x3c33580 @attributes={"lastname"=>"Williams", "firstname"=>"Nic", 
+"id"=>"1", "email"=>"drnicwilliams@gmail.com"}>]
+</pre>
+
+h2. Drum roll...
+
+Ladies and gentlemen. For my final feat of magical mastery, I'll ask you to do
+something you've never done before. This illusion is akin to the "floating lady":http://www.toytent.com/Posters/985.html
+illusion that has been passed down through generations of magicians.
+
+Exit your console session.
+
+DELETE your three model classes: <code>person.rb, group.rb, and membership.rb</code> from the 
+<code>app/models</code> folder. (You can always get them back via the model generator... be fearless!)
+
+Re-launch your console.
+
+*drums are still rolling...*
+
+Be prepared to applaud loudly...
+
+<pre syntax="ruby">
+>> Person
+=> Person
+</pre>
+
+You applaud loudly, but watch for more...
+
+<pre syntax="ruby">
+>> person = Person.find(1)
+=> <Person:0x3958930 @attributes={"lastname"=>"Williams", "firstname"=>"Nic", 
+"id"=>"1", "email"=>"drnicwilliams@gmail.com"}>
+>> person.memberships
+=> [<Membership:0x393a000 @attributes={"group_id"=>"1", "id"=>"1", "person_id"=>"1"}>]
+>> person.groups
+=> [<Group:0x390df60 @attributes={"name"=>"Magic Models Forum", "id"=>"1", "description"=>nil}>]
+</pre>
+
+h2. Tada!
+
+The end.
+
+h2. Dr Nic's Blog
+
+"http://www.drnicwilliams.com":http://www.drnicwilliams.com - for future announcements and
+other stories and things.
+
+h2. Articles about Magic Models
+
+* "Announcement":http://drnicwilliams.com/2006/08/07/ann-dr-nics-magic-models/
+* "BTS - Class creation":http://drnicwilliams.com/2006/08/10/bts-magic-models-class-creation/
+
+
+h2. Forum
+
+"http://groups.google.com/group/magicmodels":http://groups.google.com/group/magicmodels
+
+h2. Licence
+
+This code is free to use under the terms of the MIT licence. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "Dr Nic Williams":mailto:drnicwilliams@gmail.com
+or via his blog at "http://www.drnicwilliams.com":http://www.drnicwilliams.com
+

data/Rakefile

@@ -1,34 +1,60 @@
 require 'rubygems'
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
+require 'hoe'
 require File.join(File.dirname(__FILE__), 'lib', 'dr_nic_magic_models', 'version')
 
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-PKG_NAME      = 'dr_nic_magic_models'
-PKG_VERSION   = DrNicMagicModels::VERSION::STRING + PKG_BUILD
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-RELEASE_NAME  = "REL #{PKG_VERSION}"
-
-RUBY_FORGE_PROJECT = "magicmodels"
-RUBY_FORGE_USER    = "nicwilliams"
-
-PKG_FILES = FileList[
-    "lib/**/*", "test/**/*", "examples/**/*", "doc/**/*", "website/**/*", "scripts/**/*", "[A-Z]*", "install.rb", "Rakefile"
-].exclude(/\bCVS\b|~$/)
-
+AUTHOR = "nicwilliams"  # can also be an array of Authors
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = "Dr Nic's Magic Models - Invisible validations, assocations and Active Record models themselves!"
+GEM_NAME = "dr_nic_magic_models" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "magicmodels" # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "magic_multi_connections"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (DrNicMagicModels::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "dr_nic_magic_models documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
 
-desc "Default Task"
-task :default => [ :test_mysql ] # UNTESTED =, :test_sqlite, :test_postgresql ]
-task :test    => [ :test_mysql ]
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  
+  #p.extra_deps     - An array of rubygem dependencies.
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end
 
 # Run the unit tests
 
-for adapter in %w( mysql postgresql ) # UNTESTED - postgresql sqlite sqlite3 firebird sqlserver sqlserver_odbc db2 oracle sybase openbase )
+for adapter in %w( sqlite mysql postgresql ) # UNTESTED - postgresql sqlite sqlite3 firebird sqlserver sqlserver_odbc db2 oracle sybase openbase )
   Rake::TestTask.new("test_#{adapter}") { |t|
     t.libs << "test" << "test/connections/native_#{adapter}"
     t.pattern = "test/*_test{,_#{adapter}}.rb"
@@ -41,119 +67,68 @@ 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')
-  %x( mysqladmin -u root create "#{PKG_NAME}_unittest" )
-  cmd = "mysql -u root #{PKG_NAME}_unittest < \"#{File.join(SCHEMA_PATH, 'mysql.sql')}\""
+  %x( mysqladmin -u root create "#{GEM_NAME}_unittest" )
+  cmd = "mysql -u root #{GEM_NAME}_unittest < \"#{File.join(SCHEMA_PATH, 'mysql.sql')}\""
   puts "#{cmd}\n"
   %x( #{cmd} )
 end
 
 desc 'Drop the MySQL test databases'
 task :drop_mysql_databases do 
-  %x( mysqladmin -u root -f drop "#{PKG_NAME}_unittest" )
+  %x( mysqladmin -u root -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 
+  # puts File.join(SCHEMA_PATH, 'sqlite.sql')
+  # %x( sqlite3 test.db < test/fixtures/db_definitions/sqlite.sql )
+  file = File.join(SCHEMA_PATH, 'sqlite.sql')
+  cmd = "sqlite3 test.db < #{file}"
+  puts cmd
+  %x( #{cmd} )
+end
+
+desc 'Drop the sqlite test databases'
+task :drop_sqlite_databases do 
+  %x( 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 
-  %x( createdb -U postgres "#{PKG_NAME}_unittest" )
-  %x( psql "#{PKG_NAME}_unittest" postgres -f "#{File.join(SCHEMA_PATH, 'postgresql.sql')}" )
+  %x( createdb "#{GEM_NAME}_unittest" )
+  %x( psql "#{GEM_NAME}_unittest" -f "#{File.join(SCHEMA_PATH, 'postgresql.sql')}" )
 end
 
 desc 'Drop the PostgreSQL test databases'
 task :drop_postgresql_databases do 
-  %x( dropdb -U postgres "#{PKG_NAME}_unittest" )
+  %x( dropdb "#{GEM_NAME}_unittest" )
 end
 
 desc 'Rebuild the PostgreSQL test databases'
 task :rebuild_postgresql_databases => [:drop_postgresql_databases, :build_postgresql_databases]
 
-# Generate the RDoc documentation
-
-Rake::RDocTask.new { |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "Dr Nic's Magic Models - Invisible validations, assocations and Active Record models themselves!"
-  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
-  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
-  rdoc.rdoc_files.include('README', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-}
 
-# Enhance rdoc task to copy referenced images also
-task :rdoc do
-  FileUtils.mkdir_p "doc/files/examples/"
+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
 
-
-# Create compressed packages
-
-dist_dirs = [ "lib", "test", "examples", "website", "scripts"]
-
-spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = "Invisible validations, assocations and Active Record models themselves!"
-  s.description = %q{Associations and validations are automagically available to your ActiveRecord models. Model classes themselves are automagically generated if you haven't defined them already!}
-
-  s.files = [ "Rakefile", "install.rb", "README", "CHANGELOG" ]
-  dist_dirs.each do |dir|
-    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
-  end
-
-  s.require_path = 'lib'
-  s.autorequire = 'dr_nic_magic_models'
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = %w( README )
-  s.rdoc_options.concat ['--main',  'README']
-  
-  s.author = "Dr Nic Williams"
-  s.email = "drnicwilliams@gmail.com"
-  s.homepage = "http://magicmodels.rubyforge.org"
-  s.rubyforge_project = "magicmodels"
+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}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
 end
-  
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = false
-  p.need_zip = false
-end
-
-task :lines do
-  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
-  for file_name in FileList["lib/**/*.rb"]
-    next if file_name =~ /vendor/
-    f = File.open(file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-    
-    total_lines     += lines
-    total_codelines += codelines
-    
-    lines, codelines = 0, 0
-  end
-
-  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
-end
-
 
-# Publishing ------------------------------------------------------
-
-desc "Publish the release files to RubyForge."
-task :release => [ :package ] do
-  `ruby scripts/rubyforge login`
-
-  for ext in %w( gem tgz zip )
-    release_command = "ruby scripts/rubyforge add_release #{PKG_NAME} #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
-    puts release_command
-    system(release_command)
-  end
-end
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]