redshift_simple_migrator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01923b9e53ca268191c749379cc7e8ba0f3ba2db
+  data.tar.gz: 355dc3153e7148fdee4d3e5858ccaae1ab00e131
+SHA512:
+  metadata.gz: 976fa156dd49aa6214ddaa7ee32b27406a7dc5b8699c8c86da9eab78413c2342cf3705acb3317e81a0d84c6c3e6720c0b2cdee96ae089879ac6bbc2f72339bb1
+  data.tar.gz: dba4b32033ef4f92d6a0f58e1eb3ca18e87b5eb78816842350d89da2ed0dea3e20bd4cae35ad2fe349e0c201ebc67398543b4a8f9ae6834a3b324677cebc5b2d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/database.yml
+/migrate

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+addons:
+  postgresql: "9.4"
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.3
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
+  - cp spec/config.travis.yml spec/config.yml
+env:
+  - REDSHIFT_ENV=test

data/Gemfile

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

data/README.md

@@ -0,0 +1,125 @@
+# RedshiftSimpleMigrator
+[![Build Status](https://travis-ci.org/joker1007/redshift_simple_migrator.svg?branch=master)](https://travis-ci.org/joker1007/redshift_simple_migrator)
+
+this gem is super simple migrator for AWS Redshift (and PostgreSQL).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redshift_simple_migrator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redshift_simple_migrator
+
+## Usage
+
+### Define migration
+
+Migration definition is like ActiveRecord::Migration,
+but this gem supports only `execute` method.
+It has no other migration dsl.
+
+#### Migration File
+
+```ruby
+class CreateKpiMiddleTable < RedshiftSimpleMigrator::Migration
+  def up
+    execute <<-SQL
+      CREATE TABLE company_users DISTKEY (id) AS
+      SELECT
+        a.id,
+        a.company_id
+      FROM
+        users a
+          INNER JOIN companies b ON a.company_id = b.id;
+    SQL
+  end
+
+  def down
+    execute <<-SQL
+      DROP TABLE company_users;
+    SQL
+  end
+end
+```
+
+#### File name convention
+
+File name convention is same with ActiveRecord::Migration.
+
+```
+% ls redshift/migrate/
+001_create_kpi_middle_table.rb
+```
+
+### Command
+
+```sh
+# Show current migration version
+$ redshift_simple_migrator version -c <config.yml>
+
+# List execute migrations
+$ redshift_simple_migrator list <TARGET_VERSION> -c <config.yml> -p <migrations_path>
+
+# Execute migration
+$ redshift_simple_migrator migrate <TARGET_VERSION> -c <config.yml> -p <migrations_path>
+```
+
+If you use with rails, config is autoloaded from `config/redshift_simple_migrator.yml`, and define Rake tasks.
+
+### Rake tasks
+
+```
+rake redshift:migrate                   # Migrate the AWS Redshift (options: VERSION=x)
+rake redshift:migrate:status            # Display status of AWS Redshift migration (options: VERSION=x)
+```
+
+### config.yml example
+
+```yml
+default: &default
+  host: hogehoge.redshift.amazonaws.com
+  port: 5439
+  dbname: sample
+  user: admin
+  password: password
+  connect_timeout: 30000
+  schema_migrations_table_name: redshift_schema_migrations
+
+development:
+  <<: *default
+```
+
+If `schema_migrations_table_name` table doesn't exist, this gem creates the table automatically.
+
+`schema_migrations` table schema is following.
+
+```sql
+CREATE TABLE <schema_migrations_table_name> (version text NOT NULL)
+```
+
+## TODO
+- Refine `migrations_path` config.
+- Write test codes.
+
+If you want to change target environment, set `REDSHIFT_ENV` environment variable.
+For example, `REDSHIFT_ENV=prouduction redshift_simple_migrator migrate -c config.yml -p db/migrate`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec redshift_simple_migrator` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joker1007/redshift_simple_migrator.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redshift_simple_migrator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/redshift_simple_migrator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redshift_simple_migrator"
+
+RedshiftSimpleMigrator::CLI.start(ARGV)

data/lib/redshift_simple_migrator/cli.rb

@@ -0,0 +1,61 @@
+require 'thor'
+
+module RedshiftSimpleMigrator
+  class CLI < Thor
+    desc "version", "Show migration version"
+    option :config, required: true, type: :string, aliases: :c
+    def version
+      with_migrator do |m|
+        current_version = m.current_version
+        puts "Current version is #{current_version}"
+      end
+    end
+
+    desc "list [VERSION]", "List migration definitions"
+    option :config, required: true, type: :string, aliases: :c
+    option :path, required: true, type: :string, aliases: :p
+    def list(version = nil)
+      with_migrator do |m|
+        direction, migrations = m.run_migrations(version)
+        migrations.each do |migration|
+          puts "#{direction} #{migration.version} #{migration.class.to_s}"
+        end
+      end
+    end
+
+    desc "migrate [VERSION]", "run migration"
+    option :config, required: true, type: :string, aliases: :c
+    option :path, required: true, type: :string, aliases: :p
+    def migrate(version = nil)
+      with_migrator do |m|
+        m.run(version)
+      end
+    end
+
+    private
+
+    def load_config
+      raise "Config file is not found" unless File.exist?(options[:config])
+      RedshiftSimpleMigrator.config.load(options[:config])
+    end
+
+    def set_migrations_path
+      raise "Migrations path is not found" unless File.exist?(options[:path])
+      RedshiftSimpleMigrator.config.migrations_path = options[:path]
+    end
+
+    def migrator
+      return @migrator if @migrator
+
+      load_config
+      set_migrations_path
+      @migrator = Migrator.new
+    end
+
+    def with_migrator
+      yield migrator
+    ensure
+      migrator.close if migrator
+    end
+  end
+end

data/lib/redshift_simple_migrator/configuration.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+require 'active_support/configurable'
+
+module RedshiftSimpleMigrator
+  class Configuration
+    include Singleton
+    include ActiveSupport::Configurable
+
+    config_accessor :schema_migrations_table_name do
+      "schema_migrations"
+    end
+
+    config_accessor :migrations_path
+
+    config_accessor :host, :port, :dbname, :user, :password, :connect_timeout
+
+    def load(config_file, default_env = "development")
+      env = ENV["REDSHIFT_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || default_env
+      config = YAML.load_file(config_file)[env]
+      config.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
+    def database_config
+      {
+        host: host,
+        port: port,
+        dbname: dbname,
+        user: user,
+        password: password,
+        connect_timeout: connect_timeout
+      }
+    end
+  end
+end

data/lib/redshift_simple_migrator/connection.rb

@@ -0,0 +1,34 @@
+require 'pg'
+require 'yaml'
+require 'active_support/core_ext/module'
+
+module RedshiftSimpleMigrator
+  class Connection
+    attr_reader :connection
+
+    delegate \
+      :close,
+      :exec,
+      :async_exec,
+      :exec_params,
+      :escape,
+      :escape_string,
+      :escape_identifier,
+      :escape_literal,
+      to: :connection
+
+    def initialize
+      @connection = PG.connect(RedshiftSimpleMigrator.config.database_config)
+      @connection.type_map_for_results = PG::BasicTypeMapForResults.new(@connection)
+    end
+
+    def with_transaction(&block)
+      connection.exec("BEGIN")
+      block.call(self)
+      connection.exec("COMMIT")
+    rescue => e
+      connection.exec("ROLLBACK") if connection
+      raise e
+    end
+  end
+end

data/lib/redshift_simple_migrator/migration.rb

@@ -0,0 +1,27 @@
+module RedshiftSimpleMigrator
+  class Migration
+    attr_reader :connection, :version
+
+    delegate \
+      :exec,
+      :escape,
+      :escape_string,
+      :escape_identifier,
+      :escape_literal,
+      to: :connection
+    alias :execute :exec
+
+    def initialize(connection, version)
+      @connection = connection
+      @version = version
+    end
+
+    def up
+      raise NotImplementedError
+    end
+
+    def down
+      raise NotImplementedError
+    end
+  end
+end

data/lib/redshift_simple_migrator/migrator.rb

@@ -0,0 +1,114 @@
+require 'active_support/inflector'
+
+module RedshiftSimpleMigrator
+  class Migrator
+    attr_reader :connection, :migrations_path, :schema_migrations_table_name
+
+    delegate :close, to: :connection
+
+    MIGRATION_FILE_PATTERN = /^(?<version>\d+)_(?<migration_name>.*)\.rb$/.freeze
+
+    def initialize
+      config = RedshiftSimpleMigrator.config
+      @connection = Connection.new
+      @migrations_path = config.migrations_path
+      @schema_migrations_table_name =
+        @connection.escape_identifier(config.schema_migrations_table_name)
+
+      @current_version_is_loaded = nil
+      @current_migrations = nil
+    end
+
+    def current_migrations
+      return @current_migrations if @current_migrations
+
+      migrations = Dir.entries(migrations_path).map do |name|
+        if match = MIGRATION_FILE_PATTERN.match(name)
+          load File.expand_path(File.join(migrations_path, name))
+          migration_class = match[:migration_name].camelcase.constantize
+          migration_class.new(connection, match[:version].to_i)
+        end
+      end
+      @current_migrations = migrations.compact
+    end
+
+    def run_migrations(target_version = nil)
+      direction = detect_direction(target_version)
+      if direction == :up
+        migrations = current_migrations.select do |m|
+          include_target = target_version ? target_version.to_i >= m.version : true
+          include_target && m.version > current_version.to_i
+        end
+        return direction, migrations.sort_by(&:version)
+      else
+        migrations = current_migrations.select do |m|
+          target_version.to_i < m.version &&
+            m.version <= current_version.to_i
+        end
+        return direction, migrations.sort_by {|m| -(m.version) }
+      end
+    end
+
+    def current_version
+      return @current_version if @current_version_is_loaded
+
+      connection.async_exec(get_version_query) do |result|
+        versions = result.map do |row|
+          row["version"].to_i
+        end
+        @current_version = versions.max
+        @current_version_is_loaded = true
+        @current_version
+      end
+    rescue PG::UndefinedTable
+      connection.exec(create_schema_migrations_table_query)
+      retry
+    end
+
+    def run(target_version = nil)
+      direction, migrations = run_migrations(target_version)
+      connection.with_transaction do
+        migrations.each do |m|
+          m.send(direction)
+          if direction == :up
+            insert_version(m.version)
+          else
+            remove_version(m.version)
+          end
+        end
+      end
+    end
+
+    private
+
+    def get_version_query
+      "SELECT version FROM #{schema_migrations_table_name}"
+    end
+
+    def create_schema_migrations_table_query
+      "CREATE TABLE IF NOT EXISTS #{schema_migrations_table_name} (version text NOT NULL)"
+    end
+
+    def detect_direction(target_version)
+      return :up unless target_version && current_version
+
+      if current_version.to_i <= target_version.to_i
+        :up
+      else
+        :down
+      end
+    end
+
+    def insert_version(version)
+      connection.exec_params(<<-SQL, [version.to_s])
+      INSERT INTO #{schema_migrations_table_name} (version) VALUES ($1)
+      SQL
+    end
+
+    def remove_version(version)
+      connection.exec_params(<<-SQL, [version.to_s])
+      DELETE FROM #{schema_migrations_table_name} WHERE version = $1
+      SQL
+    end
+  end
+end

data/lib/redshift_simple_migrator/railtie.rb

@@ -0,0 +1,18 @@
+module RedshiftSimpleMigrator
+  class Railtie < Rails::Railtie
+    initializer "redshift_simple_migrator.initialization" do
+      RedshiftSimpleMigrator.configure do |c|
+        c.migrations_path = Rails.root.join("redshift", "migrate").to_s
+      end
+    end
+
+    config.after_initialize do
+      config_yml = Rails.root.join("config", "redshift_simple_migrator.yml").to_s
+      RedshiftSimpleMigrator.config.load(config_yml) if File.exist?(config_yml)
+    end
+
+    rake_tasks do
+      load "redshift_simple_migrator/tasks/redshift.rake"
+    end
+  end
+end

data/lib/redshift_simple_migrator/tasks/redshift.rake

@@ -0,0 +1,26 @@
+namespace :redshift do
+  desc "Migrate the AWS Redshift (options: VERSION=x)"
+  task migrate: [:environment] do
+    begin
+      migrator = RedshiftSimpleMigrator::Migrator.new
+      migrator.run(ENV["VERSION"])
+    ensure
+      migrator.close
+    end
+  end
+
+  namespace :migrate do
+    desc "Display status of AWS Redshift migration (options: VERSION=x)"
+    task status: [:environment] do
+      begin
+        migrator = RedshiftSimpleMigrator::Migrator.new
+        direction, migrations = migrator.run_migrations(ENV["VERSION"])
+        migrations.each do |migration|
+          puts "#{direction} #{migration.version} #{migration.class.to_s}"
+        end
+      ensure
+        migrator.close
+      end
+    end
+  end
+end

data/lib/redshift_simple_migrator/version.rb

@@ -0,0 +1,3 @@
+module RedshiftSimpleMigrator
+  VERSION = "0.1.0"
+end

data/lib/redshift_simple_migrator.rb

@@ -0,0 +1,21 @@
+require "redshift_simple_migrator/version"
+
+module RedshiftSimpleMigrator
+  def self.config
+    RedshiftSimpleMigrator::Configuration.instance
+  end
+
+  def self.configure
+    yield self.config
+  end
+end
+
+require "redshift_simple_migrator/configuration"
+require "redshift_simple_migrator/connection"
+require "redshift_simple_migrator/migrator"
+require "redshift_simple_migrator/migration"
+require "redshift_simple_migrator/cli"
+
+if defined?(Rails)
+  require "redshift_simple_migrator/railtie"
+end

data/redshift_simple_migrator.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redshift_simple_migrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redshift_simple_migrator"
+  spec.version       = RedshiftSimpleMigrator::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Simple schema migrator for AWS Redshift (and PostgreSQL)}
+  spec.description   = %q{Simple schema migrator for AWS Redshift (and PostgreSQL)}
+  spec.homepage      = "https://github.com/joker1007/redshift_simple_migrator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pg", ">= 0.18"
+  spec.add_runtime_dependency "activesupport", ">= 4"
+  spec.add_runtime_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-power_assert"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "tapp"
+  spec.add_development_dependency "tapp-awesome_print"
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: redshift_simple_migrator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tapp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tapp-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple schema migrator for AWS Redshift (and PostgreSQL)
+email:
+- kakyoin.hierophant@gmail.com
+executables:
+- redshift_simple_migrator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/redshift_simple_migrator
+- lib/redshift_simple_migrator.rb
+- lib/redshift_simple_migrator/cli.rb
+- lib/redshift_simple_migrator/configuration.rb
+- lib/redshift_simple_migrator/connection.rb
+- lib/redshift_simple_migrator/migration.rb
+- lib/redshift_simple_migrator/migrator.rb
+- lib/redshift_simple_migrator/railtie.rb
+- lib/redshift_simple_migrator/tasks/redshift.rake
+- lib/redshift_simple_migrator/version.rb
+- redshift_simple_migrator.gemspec
+homepage: https://github.com/joker1007/redshift_simple_migrator
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Simple schema migrator for AWS Redshift (and PostgreSQL)
+test_files: []