mylescarrick-pg_migrations 0.0.3

data/History.txt

@@ -0,0 +1,9 @@
+== 0.0.1 2009-07-15
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2009-07-21
+
+* Actually works now
+  * Some passing tests and stubs

data/Manifest.txt

@@ -0,0 +1,19 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/pg_migrations.rb
+lib/pg_migrations/migrations_helper.rb
+pg_migrations.gemspec
+script/console
+script/destroy
+script/generate
+spec/fixtures/blueprints.rb
+spec/fixtures/blueprints_helper.rb
+spec/fixtures/migration_scaffold.rb
+spec/fixtures/models.rb
+spec/pg_migrations_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,5 @@
+
+For more information on pg_migration, see http://github.com/mylescarrick/pg_migrations
+
+
+

data/README.rdoc

@@ -0,0 +1,54 @@
+= pg_migrations
+
+* http://github.com/mylescarick/pg_migrations
+
+== DESCRIPTION:
+
+Adds migration helpers to allow for postgres-specific stuff like real constraints
+
+== FEATURES/PROBLEMS:
+
+* Add and remove foreign keys (with optional CASCADE DELETE)
+* Add and remove unique constraints
+* Set / unset mandatory columns
+
+== SYNOPSIS:
+
+ActiveRecord migrations are fine when we're just using features supported across MySQL, SQLite, Postgres, etc... but
+if you're after the added security of 'real' referential integrity, etc then you're going to be using Postgres.
+
+These helpers provide a simple way to keep your migrations free from hand-written SQL, and make it easy to use the
+postgres coolness that will help keep your data reliable.
+
+== REQUIREMENTS:
+
+* Use Postgres >= 8.1
+
+== INSTALL:
+
+* sudo gem install mylescarrick-pg_migrations
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Myles Carrick
+
+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,23 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require 'activerecord'
+require './lib/pg_migrations'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'pg_migrations' do
+  self.developer 'Myles Carrick', 'mylescarrick@gmail.com'
+  self.post_install_message = 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.version = PgMigrations::GEM_VERSION
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/lib/pg_migrations.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__),'pg_migrations/migrations_helper')
+
+class PgMigrations
+  GEM_VERSION = '0.0.3'
+end

data/lib/pg_migrations/migrations_helper.rb

@@ -0,0 +1,52 @@
+module PostgresMigrationHelper
+  def add_foreign_key(from_table, from_column, to_table, options = {})
+    constraint_name = "fk_#{from_table}_#{from_column}"
+
+    sql= %{ALTER TABLE #{from_table}
+              ADD CONSTRAINT #{constraint_name}
+              FOREIGN KEY (#{from_column})
+              REFERENCES #{to_table}(id)
+              ON UPDATE RESTRICT}
+    sql << " ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED" if options[:cascade_delete]
+    execute sql
+  end
+
+  def remove_foreign_key(from_table, from_column, to_table)
+    constraint_name = "fk_#{from_table}_#{from_column}"
+
+    execute %{ALTER TABLE #{from_table}
+              DROP CONSTRAINT #{constraint_name}}
+  end
+
+  #Adds a UNIQUE CONSTRAINT on a number of fields
+  # eg. add_unique_constraint(users, table1_id, table2_id, table3_id)
+  def add_unique_constraint(from_table, *fields)
+    constraint_name = "#{from_table}_unique_on_#{fields.join('_')}"
+    constraint_name = "#{from_table}_unique_on_#{fields.join('_')}" if constraint_name.length > 60
+
+    sql = %{ALTER TABLE #{from_table}
+              ADD CONSTRAINT #{constraint_name}
+                UNIQUE (#{fields.join(',')})
+              }
+    execute sql
+  end
+
+  def remove_unique_constraint(from_table, *fields)
+    constraint_name = "#{from_table}_unique_on_#{fields.join('_')}"
+    constraint_name = "#{from_table}_unique_on_#{fields.join('_')}" if constraint_name.length > 60
+
+    execute %{ALTER TABLE #{from_table}
+              DROP CONSTRAINT #{constraint_name}}
+  end
+
+  def set_mandatory_column(table, column)
+    execute %{ALTER TABLE #{table}
+               ALTER COLUMN #{column} SET NOT NULL}
+  end
+
+  def unset_mandatory_column(table, column)
+    execute %{ALTER TABLE #{table}
+               ALTER COLUMN #{column} DROP NOT NULL}
+  end
+end
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send :include, PostgresMigrationHelper

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/pg_migrations.rb'}"
+puts "Loading pg_migrations gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/fixtures/blueprints.rb

@@ -0,0 +1,9 @@
+Sham.title { Faker::Lorem.sentence }
+Sham.body { Faker::Lorem.paragraph }
+
+Post.blueprint do
+end
+
+Comment.blueprint do
+  post { Post.make }
+end

data/spec/fixtures/blueprints_helper.rb

@@ -0,0 +1,7 @@
+def create_post_and_comments
+  post = Post.make
+  5.times do
+    Comment.make(:post => post)
+  end
+  post
+end

data/spec/fixtures/migration_scaffold.rb

@@ -0,0 +1,30 @@
+# Get an AR connection setup - create a DB and set this to something that's gonna work
+# createuser tester -P
+# createdb -O tester -E UTF8 pg_migrations_test
+# Kinda sucks requiring you to set this up manually for tests... but we're testing a real database
+# and of course this isn't gonna work in sqlite
+ActiveRecord::Base.establish_connection(
+  :adapter => "postgresql",
+  :host => "localhost",
+  :database => "pg_migrations_test",
+  :username => "tester",
+  :password => "tester"
+)
+
+# and now the basic migrations - plain vanilla AR
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :comments, :force => true do |t|
+    t.text :body
+    t.integer :post_id, :null => false
+
+    t.timestamps
+  end
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+
+    t.timestamps
+  end
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,3 @@
+# (very) basic class definition
+class Comment < ActiveRecord::Base ; belongs_to :post ; end
+class Post < ActiveRecord::Base ; has_many :comments ; end

data/spec/pg_migrations_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+def reload
+  load(File.join(File.dirname(__FILE__),'fixtures/migration_scaffold.rb'))
+end
+
+describe "setting up for business" do
+  it "should have a working Postgres connection" do
+    ActiveRecord::Base.connection.should be_an_instance_of(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+  end
+end
+
+
+describe "should properly when using the connection" do
+  
+  it "should have its methods available when using AR" do
+    ActiveRecord::Base.connection.methods.should include("add_foreign_key")
+  end
+
+end
+
+describe "playing with foreign keys" do
+
+  before(:each) do
+    reload
+    @post = create_post_and_comments
+  end
+
+  it "should prevent deletion of kids if parents exist" do
+    ActiveRecord::Base.connection.add_foreign_key(:comments, :post_id, :posts)
+    lambda { @post.destroy }.should raise_error(ActiveRecord::StatementInvalid, /violates foreign key constraint/)  
+  end
+
+  it "should should cascade delete when supposed to" do
+    ActiveRecord::Base.connection.add_foreign_key(:comments, :post_id, :posts, :cascade_delete => true)
+    #lambda { @post.destroy }.should raise_error(ActiveRecord::StatementInvalid, /violates foreign key constraint/)
+    post_id = @post.id
+    #Need to find_by_post_id for consistency - Post won't exist in a minute
+    Comment.find_all_by_post_id(post_id).size.should eql(5)
+    @post.destroy
+    Comment.find_all_by_post_id(post_id).size.should eql(0)
+  end
+
+  it "should add a unique constraint"
+
+  it "should make a field mandatory"
+
+  it "should remove the mandatory condition for a field"
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'activerecord'
+require 'spec'
+require 'machinist'
+require 'machinist/active_record'
+require 'faker'
+require 'spec/fixtures/models'
+require 'spec/fixtures/migration_scaffold'
+require 'spec/fixtures/blueprints'
+require 'spec/fixtures/blueprints_helper'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'pg_migrations'
+
+Spec::Runner.configure do |config|
+  config.before(:each) { Sham.reset }
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: mylescarrick-pg_migrations
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Myles Carrick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Adds migration helpers to allow for postgres-specific stuff like real constraints
+email: 
+- mylescarrick@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/pg_migrations.rb
+- lib/pg_migrations/migrations_helper.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/fixtures/blueprints.rb
+- spec/fixtures/blueprints_helper.rb
+- spec/fixtures/migration_scaffold.rb
+- spec/fixtures/models.rb
+- spec/pg_migrations_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: false
+homepage: http://github.com/mylescarick/pg_migrations
+licenses: 
+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: pg_migrations
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds migration helpers to allow for postgres-specific stuff like real constraints
+test_files: []
+