sql_migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a7af01aa26b454dce549effa9f5f7bbdefeaa41
+  data.tar.gz: f0e181d2405b79d2422d71642f5f3ddeed771af9
+SHA512:
+  metadata.gz: 22a9502d97115601a346f6880f797cd2a673a9f34e1fe6087fca4b6b641629d0387e3d6e2ef54d31ba8463f31dab150cf6b42442c3d592043fef0c14679b39a8
+  data.tar.gz: 033d9346b11d1c0b7479d29a18aec46b2cbc454fa0a9e247d00d1edf47c5f31549e89d8708ede401f4cdc8475dbd628a99fb3bf3fc6e44102bafb54493cb2f52

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.*.sw?

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sql_migrations.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Grzegorz Bizon <grzegorz.bizon@ntsn.pl>
+
+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/README.md

@@ -0,0 +1,182 @@
+# sql-migrations
+
+Simple standalone migrations gem you can use with plain SQL.
+
+You can execute migrations, seed datebase on production and on test environment with fixtures in non-Ruby pojects.
+`sql-migrations` can work with multiple different databases.
+
+## Why ?
+
+This is particularly useful in old projects that doesn't have migrations support, and you really want to use Continues Delivery strategy. 
+Without migrations you wouldn't be able to setup your test environment for automated testing (functional tests, unit tests, integration tests).
+
+For example, if you work in old Zend1 project, and you want to take benefit from using Continues Deployment/Continues Integration mechanisms - you may find this project useful.
+
+## Install
+
+`sql-migrations` are created using Ruby. 
+
+1. First - install Ruby environment, with `rbenv` or `rvm`.
+2. If your project is not created using Ruby, create your Gemfile:
+
+  ```ruby
+  source 'https://rubygems.org'
+  gem 'mysql2'
+  gem 'sql_migrations'
+  ```
+
+  You can use all database adapters, that are supported by `Sequel`. 
+  Adapters supported by `Sequel`, by now, are:
+    
+      ADO, Amalgalite, CUBRID, DataObjects, DB2, DBI, Firebird, 
+      FoundationDB SQL Layer, IBM_DB, Informix, JDBC, MySQL, Mysql2, 
+      ODBC, OpenBase, Oracle, PostgreSQL, SQLAnywhere, SQLite3, 
+      Swift, and TinyTDS
+
+  If you are using PostgreSQL use
+
+  ```ruby
+  gem 'pg'
+  ```
+
+3. Run `bundle install`
+
+4. Create database config file, for example in `config/databases.yml`
+
+    ```yaml
+    default:
+      development:
+        adapter: mysql2
+        encoding: utf8
+        database: test_db_dev
+        username: test_user
+        password: test_pass
+        host: 192.168.1.1
+        test:
+        adapter: mysql2
+        encoding: utf8
+        database: test_db_test
+        username: test_user
+        password: test_pass
+        host: 192.168.1.1
+      
+      production:
+        adapter: mysql2
+        encoding: utf8
+        database: test_db_prod
+        username: test_user
+        password: test_pass
+        host: 192.168.1.100
+      second_db:
+      development:
+        adapter: mysql2
+        encoding: utf8
+        database: second_db_dev
+        username: test_user
+        password: test_pass
+        host: 127.0.0.1
+        test:
+        adapter: mysql2
+        encoding: utf8
+        database: second_db_test
+        username: test_user
+        password: test_pass
+        host: 127.0.0.1
+    ```
+
+  Note that you need to define `default` database set.
+
+4. Migrations/seed/fixtures are executed using rake tasks. So you will need to create `Rakefile`. Example `Rakefile`:
+
+  ```ruby
+  require 'bundler'
+  Bundler.require
+
+  SqlMigrations.load!('db/config/databases.yml')
+  SqlMigrations.load_tasks
+  ```
+
+5. It's ready !
+  
+
+## Usage
+
+1. Valid migration/seed/fixture file names match agains regexp `/(\d{8})_(\d{6})_(.*)?\.sql/`. So valid filenames would be:
+
+
+  ```
+  20150303_180100_test_migration.sql
+  20150303_180100_whatever_description_of_seed.sql
+  20150303_180100_fixture1.sql
+  ```
+
+  You can put plain SQL into that files.
+
+2. You can create migrations files, seed files and fixtures in directories like this:
+
+  ```
+  db/
+    migrations/
+    fixtures/
+    seed/
+  ```
+
+  If you want to use multiple databases, create database directories:
+
+      db/
+        migrations/
+          default/
+          second_db/
+        fixtures/
+          default/
+          second_db/
+        seed/
+          default/
+          second_db/
+
+  `default/` directory is mandatory, you can put migrations/seed data/fixtures for default database in base directories:
+
+      db/
+        migrations/
+          20150303_180100_test_migration.sql
+          second_db/
+            20150303_180101_test_migration_for_second_db.sql
+
+3. In every database that is specified in YAML config, `sql-migrations` will create table `sqlmigrations_schema`
+4. If everything is set up properly, you should see `sqlmigrations` tasks after typing
+
+
+        rake -T
+
+5. Run tasks:
+
+
+        rake sqlmigrations:db:migrate   # this will execute migrations
+        rake sqlmigrations:db:seed      # this will seed database with initial data
+        rake sqlmigration:files:list    # this will list all migrations/seed files/fixtures that where found
+
+6. Enviroment variables
+
+  If you want to run migration on different database (for example test) specify ENV:
+
+  ```bash
+  ENV=test rake sqlmigrations:db:migrate
+  ENV=test rake sqlmigrations:db:test:seed
+  ```
+
+  or in production:
+
+  ```bash
+  ENV=production rake sqlmigrations:db:migrate
+  ENV=production rake sqlmigrations:db:seed
+  ```
+
+## TODO
+
+1. Tests
+2. Generator for `databases.yml`
+3. Generator for migrations
+
+## License
+
+This is free sofware licensed under MIT license, see LICENSE file

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sql_migrations/database.rb

@@ -0,0 +1,62 @@
+module SqlMigrations
+  class Database
+
+    SCHEMA_TABLE = :sqlmigrations_schema
+    attr_reader :db
+
+    def initialize(options)
+      @name = options[:name] || :default
+      begin
+        @db = Sequel.connect(adapter:  options['adapter'],
+                             host:     options['host'],
+                             database: options['database'],
+                             user:     options['username'],
+                             password: options['password'],
+                             test:     true)
+      rescue
+        puts "[-] Could not connect to database using #{options['adapter']} adapter"
+        raise
+      else
+        puts "[+] Connected to database using #{options['adapter']} adapter"
+      end
+      install_table
+    end
+
+    def execute_migrations
+      puts "[i] Executing migrations"
+      Migration.find(@name).each { |migration| migration.execute(self) }
+    end
+
+    def seed_database
+      puts "[i] Seeding database"
+      Seed.find(@name).each { |seed| seed.execute(self) }
+    end
+
+    def seed_with_fixtures
+      puts "[i] Seeding test database with fixtures"
+      Fixture.find(@name).each { |fixture| fixture.execute(self) }
+    end
+
+    def schema_dataset
+      @db[SCHEMA_TABLE]
+    end
+
+    private
+    def install_table
+      # Check if we have migrations_schema table present
+      unless @db.table_exists?(SCHEMA_TABLE)
+        puts "[!] Installing `#{SCHEMA_TABLE}`"
+        @db.create_table(SCHEMA_TABLE) do
+          primary_key :id
+          Bignum   :time
+          DateTime :executed
+          String   :name
+          String   :type
+          index [ :time, :type ]
+        end
+      end
+    end
+
+
+  end
+end

data/lib/sql_migrations/fixture.rb

@@ -0,0 +1,13 @@
+module SqlMigrations
+  class Fixture < SqlScript
+
+    def self.find(db_name)
+      super(db_name, :fixture)
+    end
+
+    def to_s
+      "Fixture #{@name}, datetime: #{@date + @time}"
+    end
+
+  end
+end

data/lib/sql_migrations/migration.rb

@@ -0,0 +1,13 @@
+module SqlMigrations
+  class Migration < SqlScript
+
+    def self.find(db_name)
+      super(db_name, :migrations)
+    end
+
+    def to_s
+      "Migration #{@name} for db: #{@db_name}, datetime: #{@date + @time}"
+    end
+
+  end
+end

data/lib/sql_migrations/seed.rb

@@ -0,0 +1,13 @@
+module SqlMigrations
+  class Seed < SqlScript
+
+    def self.find(db_name)
+      super(db_name, :seed)
+    end
+
+    def to_s
+      "Seed data #{@name}, datetime: #{@date + @time}"
+    end
+
+  end
+end

data/lib/sql_migrations/sql_script.rb

@@ -0,0 +1,92 @@
+module SqlMigrations
+  class SqlScript
+
+    attr_reader :date, :time, :name
+
+    def initialize(path, opts)
+      @date     = opts[:date]
+      @time     = opts[:time]
+      @name     = opts[:name]
+      @path     = opts[:path]
+      @db_name  = opts[:db_name]
+      @content  = IO.read(path)
+      @type     = self.class.name.downcase.split('::').last
+      @datetime = (@date + @time).to_i
+    end
+
+    def execute(db)
+      @database = db
+      return unless is_new?
+      begin
+        @database.db.transaction do
+          @benchmark = Benchmark.measure do
+            @database.db.run @content
+          end
+        end
+      rescue
+        puts "[-] Error while executing #{@type} #{@name} !"
+        raise
+      else
+        on_success
+      end
+    end
+
+    def self.find(db_name, type)
+      scripts = []
+      Find.find(Dir.pwd) do |path|
+        if !db_name.is_a? Array then db_name = [ db_name ] end
+        file_date, file_time, file_name, file_db = self.file_options(db_name, type, path)
+        next unless file_name
+        scripts << self.new(path, date: file_date, time: file_time, name: file_name, db_name: file_db)
+      end
+      scripts.sort_by { |file| (file.date + file.time).to_i }
+    end
+
+    private
+    def self.file_options(db_names, type, path)
+
+      up_dir, dir, filename = path.split(File::SEPARATOR)[-3, 3]
+
+      # Only files that match agains this regexp
+      file_opts = File.basename(path).match(/(\d{8})_(\d{6})_(.*)?\.sql/)
+      return nil unless file_opts
+
+      file_in_type_dir   = (dir    == type.to_s)
+      file_in_type_updir = (up_dir == type.to_s)
+      file_in_db_dir     = db_names.include?(dir.to_sym)
+                          
+      # There is exception when we are looking for files for more than one database
+      # or we are checking default database only
+      if db_names == [ :default ] || db_names.count > 1
+        return nil unless (file_in_type_dir || (file_in_db_dir && file_in_type_updir))
+      else
+        # Only files for specific type (migration/fixture/seed)
+        # Only files for specific database
+        return nil unless (file_in_db_dir && file_in_type_updir)
+      end
+
+      file_database = db_names.include?(dir.to_sym) ? dir : :default
+      return file_opts[1], file_opts[2], file_opts[3], file_database
+    end
+
+    def is_new?
+      schema = @database.schema_dataset
+      last = schema.order(Sequel.asc(:time)).where(type: @type).last
+      is_new = schema.where(time: @datetime, type: @type).count == 0
+      if is_new && !last.nil?
+        if last[:time] > @datetime
+          raise "#{@type.capitalize} #{@name} has time BEFORE last one recorded !"
+        end
+      end
+      is_new
+    end
+
+    def on_success
+      puts "[+] Successfully executed #{@type}, name: #{@name}"
+      puts "    Benchmark: #{@benchmark}"
+      schema = @database.schema_dataset
+      schema.insert(time: @datetime, name: @name, type: @type, executed: DateTime.now)
+    end
+
+  end
+end

data/lib/sql_migrations/supervisor.rb

@@ -0,0 +1,50 @@
+module SqlMigrations
+  class Supervisor
+
+    def initialize
+      @env = (ENV['ENV'] ||= "development").to_sym
+      @options = SqlMigrations.options
+      @databases = get_databases_from_config
+    end
+
+    def migrate
+      databases_run { |db| db.execute_migrations }
+    end
+
+    def seed
+      databases_run { |db| db.seed_database      }
+    end
+
+    def seed_test
+      databases_run { |db| db.seed_with_fixtures }
+    end
+
+    def list_files
+      Migration.find(@databases).each { |migration| puts migration }
+      Seed.find(@databases).each      { |seed|      puts seed      }
+      Fixture.find(@databases).each   { |fixture|   puts fixture   }
+    end
+
+    private
+    def get_databases_from_config
+      databases = @options.map { |k, v| k.to_sym }
+      unless databases.include?(:default)
+        raise "Default database configuration not found !"
+      end
+      databases
+    end
+
+    def databases_run
+      @databases.each do |db|
+        db_options = @options[db.to_s][@env.to_s]
+        db_options.merge!(name: db)
+        if db_options
+          yield Database.new(db_options)
+        else
+          raise "Configuration for #{db} in environment #{@env} not found !"
+        end
+      end
+    end
+
+  end
+end

data/lib/sql_migrations/tasks/list.rake

@@ -0,0 +1,8 @@
+namespace :sqlmigrations do
+  namespace :files do
+    desc "List found migration and seed files"
+    task :list do
+      SqlMigrations::Supervisor.new.list_files
+    end
+  end
+end

data/lib/sql_migrations/tasks/migrate.rake

@@ -0,0 +1,8 @@
+namespace :sqlmigrations do
+  namespace :db do
+    desc "Run migrations"
+    task :migrate do
+      SqlMigrations::Supervisor.new.migrate
+    end
+  end
+end

data/lib/sql_migrations/tasks/seed.rake

@@ -0,0 +1,8 @@
+namespace :sqlmigrations do
+  namespace :db do
+    desc "Seed database"
+    task :seed do
+      SqlMigrations::Supervisor.new.seed
+    end
+  end
+end

data/lib/sql_migrations/tasks/seed_test.rake

@@ -0,0 +1,10 @@
+namespace :sqlmigrations do
+  namespace :db do
+    namespace :test do
+      desc "Seed test database with fixtures"
+      task :seed do
+        SqlMigrations::Supervisor.new.seed_test
+      end
+    end
+  end
+end

data/lib/sql_migrations/version.rb

@@ -0,0 +1,3 @@
+module SqlMigrations
+  VERSION = "1.0.0"
+end

data/lib/sql_migrations.rb

@@ -0,0 +1,30 @@
+require 'sequel'
+require 'yaml'
+require 'find'
+require 'benchmark'
+require 'time'
+
+require 'sql_migrations/version'
+require 'sql_migrations/database'
+require 'sql_migrations/supervisor'
+require 'sql_migrations/sql_script'
+require 'sql_migrations/migration'
+require 'sql_migrations/seed'
+require 'sql_migrations/fixture'
+
+module SqlMigrations
+  class << self
+    attr_reader :options
+
+    def load_tasks
+      load "sql_migrations/tasks/migrate.rake"
+      load "sql_migrations/tasks/seed.rake"
+      load "sql_migrations/tasks/seed_test.rake"
+      load "sql_migrations/tasks/list.rake"
+    end
+
+    def load!(config_file)
+      @options = YAML::load_file(config_file)
+    end
+  end
+end

data/sql_migrations.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sql_migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sql_migrations"
+  spec.version       = SqlMigrations::VERSION
+  spec.authors       = ["Grzegorz Bizon"]
+  spec.email         = ["grzegorz.bizon@ntsn.pl"]
+  spec.summary       = %q{Simple standalone migrations you can use with plain SQL}
+  spec.homepage      = "http://github.com/grzesiek/sql-migrations"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_dependency             'rake', '~> 10.0'
+  spec.add_dependency             'sequel', '~> 4.19.0'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: sql_migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Grzegorz Bizon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.19.0
+description: 
+email:
+- grzegorz.bizon@ntsn.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sql_migrations.rb
+- lib/sql_migrations/database.rb
+- lib/sql_migrations/fixture.rb
+- lib/sql_migrations/migration.rb
+- lib/sql_migrations/seed.rb
+- lib/sql_migrations/sql_script.rb
+- lib/sql_migrations/supervisor.rb
+- lib/sql_migrations/tasks/list.rake
+- lib/sql_migrations/tasks/migrate.rake
+- lib/sql_migrations/tasks/seed.rake
+- lib/sql_migrations/tasks/seed_test.rake
+- lib/sql_migrations/version.rb
+- sql_migrations.gemspec
+homepage: http://github.com/grzesiek/sql-migrations
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple standalone migrations you can use with plain SQL
+test_files: []
+has_rdoc: