sql_migrations 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7af01aa26b454dce549effa9f5f7bbdefeaa41
-  data.tar.gz: f0e181d2405b79d2422d71642f5f3ddeed771af9
+  metadata.gz: 5c161cf11a737f57288204c4743855bb7ea87d47
+  data.tar.gz: 1d0760c754c81ee792c2dd6630182d6f20e82f24
 SHA512:
-  metadata.gz: 22a9502d97115601a346f6880f797cd2a673a9f34e1fe6087fca4b6b641629d0387e3d6e2ef54d31ba8463f31dab150cf6b42442c3d592043fef0c14679b39a8
-  data.tar.gz: 033d9346b11d1c0b7479d29a18aec46b2cbc454fa0a9e247d00d1edf47c5f31549e89d8708ede401f4cdc8475dbd628a99fb3bf3fc6e44102bafb54493cb2f52
+  metadata.gz: dad9f6a31134633ac2f14aa74e208dd96292358f34f7214a7ae1230d416ce991b1df78c27691d58a366ff6af67e336d9970f924688bd7d02f0d4d4866de06e32
+  data.tar.gz: d8ec3f6f6c0bfb69ea0bff00176bb0f24cb33fc8f61e7bad4b9bfe8b560d5fd623e6a40a028aa9673ea5865c9ceedf6e23026851682342dda5819d0fdd93e470

data/.rspec

@@ -0,0 +1,3 @@
+--require 'spec_helper'
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/README.md

@@ -1,181 +1,184 @@
 # sql-migrations
 
-Simple standalone migrations gem you can use with plain SQL.
+[![Gem Version](https://badge.fury.io/rb/sql_migrations.svg)](http://badge.fury.io/rb/sql_migrations)
+[![Build Status](https://travis-ci.org/grzesiek/sql-migrations.svg?branch=master)](https://travis-ci.org/grzesiek/sql-migrations)
 
-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.
+Simple standalone migrations you can use with plain SQL.
+
+This gives you possibility to execute migrations, seed datebase (on production and in test environment with fixtures) in non-Ruby pojects.
+`sql-migrations` can work with multiple different databases, and support many db adapters.
 
 ## Why ?
 
-This is particularly useful in old projects that doesn't have migrations support, and you really want to use Continues Delivery strategy. 
+This is particularly useful in old projects that don't have migration 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.
+For example, if you work on old Zend 1 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. 
+`sql-migrations` are created using Ruby, but you can use this software with non-Ruby projects, like PHP or Java. This is standalone mechanism.
 
-1. First - install Ruby environment, with `rbenv` or `rvm`.
-2. If your project is not created using Ruby, create your Gemfile:
+1.  First - install Ruby environment, with `rbenv` or `rvm`.
+2.  If your project is not using ruby, create your Gemfile:
 
-  ```ruby
-  source 'https://rubygems.org'
-  gem 'mysql2'
-  gem 'sql_migrations'
-  ```
+        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:
+    It is possible to 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 !
+    > 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
+
+        gem 'pg'
+
+3.  Run `bundle install`
+
+4.  Create database config file in `db/config/databases.yml`
+
+        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` databases set.
+
+4.  Migrations/seed/fixtures are executed using rake tasks. So you will need to create `Rakefile`:
+
+        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:
+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
-  ```
+        20150303_180100_test_migration.sql
+        20150303_180100_whatever_description_of_seed.sql
+        20150303_180100_fixture1.sql
 
-  You can put plain SQL into that files.
+    You can put plain SQL into that files.
 
-2. You can create migrations files, seed files and fixtures in directories like this:
+2.  It is possible to create migration files, seed files and fixtures inside followig directory structure:
 
-  ```
-  db/
-    migrations/
-    fixtures/
-    seed/
-  ```
+        db/
+          migrations/
+            20150303_180100_test_migration.sql
+          fixtures/
+            20150303_180100_fixture1.sql
+          seed/
+            20150303_180100_whatever_description_of_seed.sql
 
-  If you want to use multiple databases, create database directories:
+    If you want to use multiple databases, create also database directories:
 
-      db/
-        migrations/
-          default/
-          second_db/
-        fixtures/
-          default/
-          second_db/
-        seed/
-          default/
-          second_db/
+        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:
+    `default/` directory is optional, 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
+        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
+3.  `sql-migrations` will create table `sqlmigrations_schema` for each database specified in YAML config.
 
+4.  If everything is set up properly, you should see new rake tasks:
 
         rake -T
 
-5. Run tasks:
+    This should give output
+
+        rake sqlmigrations:db:migrate    # Run migrations
+        rake sqlmigrations:db:seed       # Seed database
+        rake sqlmigrations:db:test:seed  # Seed test database with fixtures
+        rake sqlmigrations:files:list    # List found migration and seed files
+
+
+5.  Then, run tasks:
+
+
+        # this will execute migrations
+        rake sqlmigrations:db:migrate   
 
+        # this will seed database with initial data
+        rake sqlmigrations:db:seed 
 
-        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
+        # this will list all migrations/seed files/fixtures that where found
+        rake sqlmigration:files:list    
 
-6. Enviroment variables
+6.  Enviroment variables
 
-  If you want to run migration on different database (for example test) specify ENV:
+    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
-  ```
+        ENV=test rake sqlmigrations:db:migrate
+        ENV=test rake sqlmigrations:db:test:seed
 
-  or in production:
+    or in production:
 
-  ```bash
-  ENV=production rake sqlmigrations:db:migrate
-  ENV=production rake sqlmigrations:db:seed
-  ```
+        ENV=production rake sqlmigrations:db:migrate
+        ENV=production rake sqlmigrations:db:seed
 
 ## TODO
 
-1. Tests
-2. Generator for `databases.yml`
-3. Generator for migrations
+1.  Tests
+2.  Generator for `databases.yml`
+3.  Generator for migrations
 
 ## License
 

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
 

data/lib/sql_migrations/database.rb

@@ -7,12 +7,7 @@ module SqlMigrations
     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)
+        @db = self.class.connect(options)
       rescue
         puts "[-] Could not connect to database using #{options['adapter']} adapter"
         raise
@@ -42,6 +37,16 @@ module SqlMigrations
     end
 
     private
+
+    def self.connect(options)
+      Sequel.connect(adapter:  options['adapter'],
+                     host:     options['host'],
+                     database: options['database'],
+                     user:     options['username'],
+                     password: options['password'],
+                     test:     true)
+    end
+
     def install_table
       # Check if we have migrations_schema table present
       unless @db.table_exists?(SCHEMA_TABLE)
@@ -57,6 +62,5 @@ module SqlMigrations
       end
     end
 
-
   end
 end

data/lib/sql_migrations/sql_script.rb

@@ -9,7 +9,7 @@ module SqlMigrations
       @name     = opts[:name]
       @path     = opts[:path]
       @db_name  = opts[:db_name]
-      @content  = IO.read(path)
+      @content  = File.read(path)
       @type     = self.class.name.downcase.split('::').last
       @datetime = (@date + @time).to_i
     end

data/lib/sql_migrations/version.rb

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

data/spec/features/migration_spec.rb

@@ -0,0 +1,34 @@
+describe 'migration' do
+  before do
+    Dir.mkdir('/migrations')
+    File.open('/migrations/20150305_154010_test_migration.sql', 'w') do |f|
+      f.puts "CREATE TABLE test_table(col_int INTEGER, col_str STRING)"
+    end
+    @migration = SqlMigrations::Migration.find([ :default ]).first
+  end
+
+  it 'should be found and initialized' do
+    expect(@migration).to be_a(SqlMigrations::Migration)
+  end
+
+  it 'should have proper date' do
+    expect(@migration.date).to eql('20150305')
+  end
+
+  it 'should have proper time' do
+    expect(@migration.time).to eql('154010')
+  end
+
+  it 'should have proper name' do
+    expect(@migration.name).to eql('test_migration')
+  end
+
+  it 'should be properly executed' do
+    $stdout = StringIO.new
+    database = SqlMigrations::Database.new(name: :default, 'adapter' => :sqlite)
+    @migration.execute(database)
+    expect(@sqlite_db.table_exists?(:test_table)).to be true
+    expect(@sqlite_db[:test_table].columns).to include(:col_int)
+    expect(@sqlite_db[:test_table].columns).to include(:col_str)
+  end
+end

data/spec/features/schema_table_spec.rb

@@ -0,0 +1,26 @@
+describe 'schema table in database' do
+
+  it 'should be created if it does not exist' do
+    expect do
+      @database = SqlMigrations::Database.new(name: :default, 'adapter' => :sqlite)
+    end.to output("[+] Connected to database using sqlite adapter\n" +
+                  "[!] Installing `sqlmigrations_schema`\n").to_stdout
+    expect(@database.db.table_exists?(:sqlmigrations_schema)).to be true
+  end
+
+  it 'should not be create if it exists' do
+    @sqlite_db.create_table(:sqlmigrations_schema) do
+      primary_key :id
+      Bignum   :time
+      DateTime :executed
+      String   :name
+      String   :type
+      index [ :time, :type ]
+    end
+    expect do
+      @database = SqlMigrations::Database.new(name: :default, 'adapter' => :sqlite)
+    end.to output("[+] Connected to database using sqlite adapter\n").to_stdout
+    expect(@database.db.table_exists?(:sqlmigrations_schema)).to be true
+  end
+
+end

data/spec/features/sql_scripts_spec.rb

@@ -0,0 +1,30 @@
+describe 'sql scripts' do
+  before do
+    Dir.mkdir('/migrations')
+    Dir.mkdir('/seed')
+    Dir.mkdir('/fixtures')
+
+    File.open('/migrations/20150305_154010_first_test_migration.sql', 'w') do |f|
+      f.puts "CREATE TABLE first_test_table(col_int1 INTEGER, col_str1 STRING)"
+    end
+    File.open('/migrations/20150305_154011_second_test_migration.sql', 'w') do |f|
+      f.puts "CREATE TABLE second_test_table(col_int2 INTEGER, col_str2 STRING)"
+    end
+    File.open('/seed/20150305_154010_test_seed.sql', 'w') do |f|
+      f.puts "INSERT INTO first_test_table(col_int1, col_str1) VALUES(123, 'test_string1')"
+      f.puts "INSERT INTO second_test_table(col_int2, col_str2) VALUES(456, 'test_string2')"
+    end
+    File.open('/fixtures/20150305_154010_test_test_seed', 'w') do |f|
+      f.puts "INSERT INTO first_test_table(col_int1, col_str1) VALUES(2123, '2test_string1')"
+      f.puts "INSERT INTO second_test_table(col_int2, col_str2) VALUES(2456, '2test_string2')"
+    end
+  end
+
+  it 'should be found' do
+    expect { SqlMigrations::Supervisor.new.list_files }.to \
+      output("Migration first_test_migration for db: default, datetime: 20150305154010\n" +
+             "Migration second_test_migration for db: default, datetime: 20150305154011\n" +
+             "Seed data test_seed, datetime: 20150305154010\n").to_stdout
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'memfs'
+Bundler.require
+
+RSpec.configure do |config|
+  config.before do
+    @sqlite_db = Sequel.sqlite
+    allow(SqlMigrations::Database).to receive(:connect) { @sqlite_db }
+    allow(SqlMigrations).to receive(:options) { { default: { development: {}}} }
+    MemFs.activate!
+  end
+
+  config.after do
+    MemFs.deactivate!
+  end
+end

data/sql_migrations.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_development_dependency 'rspec',   '~> 3.2.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.10'
+  spec.add_development_dependency 'memfs',   '~> 0.4.3'
+  spec.add_dependency             'bundler', '~> 1.7'
+  spec.add_dependency             'rake',    '~> 10.0'
+  spec.add_dependency             'sequel',  '~> 4.19.0'
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: sql_migrations
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: memfs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -17,7 +59,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -60,6 +102,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -76,6 +120,10 @@ files:
 - lib/sql_migrations/tasks/seed.rake
 - lib/sql_migrations/tasks/seed_test.rake
 - lib/sql_migrations/version.rb
+- spec/features/migration_spec.rb
+- spec/features/schema_table_spec.rb
+- spec/features/sql_scripts_spec.rb
+- spec/spec_helper.rb
 - sql_migrations.gemspec
 homepage: http://github.com/grzesiek/sql-migrations
 licenses:
@@ -97,9 +145,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple standalone migrations you can use with plain SQL
-test_files: []
-has_rdoc: 
+test_files:
+- spec/features/migration_spec.rb
+- spec/features/schema_table_spec.rb
+- spec/features/sql_scripts_spec.rb
+- spec/spec_helper.rb