standalone_migrations 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+schema.rb

data/README.markdown

@@ -0,0 +1,65 @@
+Rails migrations in non-Rails (and non Ruby) projects.  
+For this code to work you need Ruby, Gems, ActiveRecord, Rake and a suitable database driver installed.
+
+USAGE
+=====
+Install Ruby, RubyGems then:
+    sudo gem install standalone_migrations
+
+Add to `Rakefile` in your projects base directory:
+    begin
+      require 'standalone_migrations'
+      StandaloneMigrations.tasks
+    rescue LoadError
+      puts 'gem install standalone_migrations to get db:migrate:* tasks!'
+    end
+
+Add database configuration to `config/database.yml` in your projects base directory e.g.:
+    development:
+      adapter: mysql
+      encoding: utf8
+      reconnect: false
+      database: somedatabase_dev
+      pool: 5
+      username: root
+      password:
+      socket: /var/run/mysqld/mysqld.sock
+
+    test:
+      ...something similar...
+
+To create a new database migration run:
+
+    rake db:new_migration name=FooBarMigration
+    edit migrations/20081220234130_foo_bar_migration.rb
+
+and fill in the up and down migrations. To apply your newest migration
+
+    rake db:migrate
+
+To migrate to a specific version (for example to rollback)
+
+    rake db:migrate VERSION=20081220234130
+
+To migrate a specific database (for example your "testing" database)
+
+    rake db:migrate RAILS_ENV=test
+
+CREDIT
+======
+This work is based on Lincoln Stoll's blog post: http://lstoll.net/2008/04/stand-alone-activerecord-migrations/  
+and David Welton's post http://journal.dedasys.com/2007/01/28/using-migrations-outside-of-rails
+
+FURTHER HELP
+============
+A good source to learn how to use migrations is:  
+http://dizzy.co.uk/ruby_on_rails/cheatsheets/rails-migrations
+or if you're lazy and want to just execute raw SQL  
+
+    def self.up
+      execute "insert into foo values (123,'something');"
+    end
+
+    def self.down
+      execute "delete from foo where field='something';"
+    end

data/Rakefile

@@ -0,0 +1,18 @@
+# rake install -> install gem locally (for tests)
+# rake release -> push to github and release to gemcutter
+# rake version:bump:patch -> increase version and add a git-tag
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'standalone_migrations'
+    gem.summary = "A thin wrapper to use Rails Migrations in non Rails projects"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/thuss/standalone-migrations"
+    gem.authors = ["Michael Grosser"]
+    %w[rake activerecord].each{|d| gem.add_dependency d}
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/database.yml

@@ -0,0 +1,29 @@
+development:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: somedatabase_dev
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+test:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: somedatabase_test
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+production:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: somedatabase
+  pool: 5
+  username: root
+  password: 
+  socket: /var/run/mysqld/mysqld.sock

data/lib/standalone_migrations.rb

@@ -0,0 +1,5 @@
+class StandaloneMigrations
+  def self.tasks
+    load "#{File.dirname(__FILE__)}/../tasks/standalone_migrations.rake"
+  end
+end

data/standalone_migrations.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{standalone_migrations}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2010-03-15}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "database.yml",
+     "lib/standalone_migrations.rb",
+     "standalone_migrations.gemspec",
+     "tasks/standalone_migrations.rake",
+     "vendor/migration_helpers/MIT-LICENSE",
+     "vendor/migration_helpers/README.markdown",
+     "vendor/migration_helpers/init.rb",
+     "vendor/migration_helpers/lib/migration_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/thuss/standalone-migrations}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A thin wrapper to use Rails Migrations in non Rails projects}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/tasks/standalone_migrations.rake

@@ -0,0 +1,75 @@
+APP_BASE = File.expand_path('.') unless defined? APP_BASE
+
+# Add to load_path every "lib/" directory in vendor
+Dir["#{File.dirname(__FILE__)}/../vendor/**/lib"].each { |p| $LOAD_PATH << p }
+
+namespace :db do
+  task :ar_init do
+    require 'active_record'
+    ENV['RAILS_ENV'] ||= 'development'
+    config = YAML.load_file(APP_BASE + '/config/database.yml')[ENV['RAILS_ENV']]
+    ActiveRecord::Base.establish_connection(config)
+    logger = Logger.new $stderr
+    logger.level = Logger::INFO
+    ActiveRecord::Base.logger = logger
+  end
+
+  desc "Migrate the database using the scripts in the migrate directory. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+  task :migrate => :ar_init  do
+    require 'migration_helpers/init'
+    ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    ActiveRecord::Migrator.migrate(APP_BASE + "/migrations/", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    Rake::Task[ "db:schema:dump" ].execute
+  end
+
+  namespace :schema do
+    desc "Create schema.rb file that can be portably used against any DB supported by AR"
+    task :dump => :ar_init do
+      require 'active_record/schema_dumper'
+      File.open(ENV['SCHEMA'] || APP_BASE + "/schema.rb", "w") do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+    desc "Load a ar_schema.rb file into the database"
+    task :load => :ar_init do
+      file = ENV['SCHEMA'] || APP_BASE + "/schema.rb"
+      load(file)
+    end
+  end
+
+  desc "Create a new migration"
+  task :new_migration do |t|
+    unless ENV['name']
+      puts "Error: must provide name of migration to generate."
+      puts "For example: rake #{t.name} name=add_field_to_form"
+      exit 1
+    end
+
+    underscore = lambda { |camel_cased_word|
+      camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    }
+
+    migration  = underscore.call( ENV['name'] )
+    file_name  = "migrations/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_#{migration}.rb"
+    class_name = migration.split('_').map { |s| s.capitalize }.join
+
+    file_contents = <<eof
+class #{class_name} < ActiveRecord::Migration
+  def self.up
+  end
+
+  def self.down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end
+eof
+    File.open(file_name, 'w') { |f| f.write file_contents }
+
+    puts "Created migration #{file_name}"
+  end
+end

data/vendor/migration_helpers/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jesús García Sáez
+
+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/vendor/migration_helpers/README.markdown

@@ -0,0 +1,92 @@
+
+DESCRIPTION
+===========
+
+Helpers for migrations of ActiveRecord for dealing with foreign keys and primary keys.
+
+FEATURES
+========
+
+ * **foreign keys**
+    * foreign_key(table, field, referenced_table, referenced_field, on_cascade)
+    * drop_foreign_key(table, field)
+ * **primary keys**
+    * primary_key(table, field)
+
+Examples
+========
+
+Typical use:
+
+    def self.up
+      create_table :profiles do |t|
+        t.string  :first_name
+        t.string  :last_name
+        t.string  :email
+        t.boolean :is_disabled
+      end
+      create_table :users do |t|
+        t.string  :login
+        t.string  :crypted_password
+        t.string  :salt
+        t.integer :profile_id
+      end
+
+      foreign_key :users, :profile_id, :profiles
+    end
+
+    def self.down
+      drop_foreign_key :users, :profile_id
+      drop_table       :users
+      drop_table       :profiles
+    end
+
+
+Also, if we don't defined a common :id (exactly it's rails who define it), we should create a primary key:
+
+    def self.up
+      create_table :foo, :id => false do |t|
+         t.string :foo, :bar
+      end
+
+      primary_key :foo, [ :foo, :bar ]
+    end
+
+In the parameter where a field is required (like the second parameter in *primary_key*) you can specified and symbol (or string) or an array of symbols (or strings).
+
+
+REQUIREMENTS
+============
+
+ * It's been tested with Mysql adapter and Jdbcmysql adapter
+
+INSTALL
+=======
+
+ * script/plugin install git://github.com/blaxter/migration_helpers.git
+
+LICENSE
+=======
+
+(The MIT License)
+
+Copyright (c) 2008 Jesús García Sáez <jgarcia@warp.es>
+
+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/vendor/migration_helpers/init.rb

@@ -0,0 +1,4 @@
+require 'migration_helper'
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.
+  send :include, MigrationConstraintHelpers

data/vendor/migration_helpers/lib/migration_helper.rb

@@ -0,0 +1,51 @@
+module MigrationConstraintHelpers
+
+   # Creates a foreign key from +table+.+field+ against referenced_table.referenced_field
+   #
+   # table: The tablename
+   # field: A field of the table
+   # referenced_table: The table which contains the field referenced
+   # referenced_field: The field (which should be part of the primary key) of the referenced table
+   # cascade: delete & update on cascade?
+   def foreign_key(table, field, referenced_table, referenced_field = :id, cascade = true)
+      execute "ALTER TABLE #{table} ADD CONSTRAINT #{constraint_name(table, field)}
+               FOREIGN KEY #{constraint_name(table, field)} (#{field_list(field)})
+               REFERENCES #{referenced_table}(#{field_list(referenced_field)})
+               #{(cascade ? 'ON DELETE CASCADE ON UPDATE CASCADE' : '')}"
+   end
+
+   # Drops a foreign key from +table+.+field+ that has been created before with
+   # foreign_key method
+   #
+   # table: The table name
+   # field: A field (or array of fields) of the table
+   def drop_foreign_key(table, field)
+      execute "ALTER TABLE #{table} DROP FOREIGN KEY #{constraint_name(table, field)}"
+   end
+
+   # Creates a primary key for +table+, which right now HAS NOT primary key defined
+   #
+   # table: The table name
+   # field: A field (or array of fields) of the table that will be part of the primary key
+   def primary_key(table, field)
+      execute "ALTER TABLE #{table} ADD PRIMARY KEY(#{field_list(field)})"
+   end
+
+   private
+
+   # Creates a constraint name for table and field given as parameters
+   #
+   # table: The table name
+   # field: A field of the table
+   def constraint_name(table, field)
+      "fk_#{table}_#{field_list_name(field)}"
+   end
+
+   def field_list(fields)
+      fields.is_a?(Array) ? fields.join(',') : fields
+   end
+
+   def field_list_name(fields)
+      fields.is_a?(Array) ? fields.join('_') : fields
+   end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: standalone_migrations
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- Rakefile
+- VERSION
+- database.yml
+- lib/standalone_migrations.rb
+- standalone_migrations.gemspec
+- tasks/standalone_migrations.rake
+- vendor/migration_helpers/MIT-LICENSE
+- vendor/migration_helpers/README.markdown
+- vendor/migration_helpers/init.rb
+- vendor/migration_helpers/lib/migration_helper.rb
+has_rdoc: true
+homepage: http://github.com/thuss/standalone-migrations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A thin wrapper to use Rails Migrations in non Rails projects
+test_files: []
+