db-migrate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d20012ab53ae15b7b98fec15bb8eae3abd9914e
+  data.tar.gz: e02941b8c31643efaa71774d67b22aba0c4f2bc8
+SHA512:
+  metadata.gz: 6d316f5e858dcdfad7e16449cd78abf3a8a44e51111cb26411467d89bdbaf2cf8900728abebe1f697d05b6553e1dd8839400957ba310d9bb4e4b6066625c13ce
+  data.tar.gz: 8538758ab5dc8d23e9b1923b777187cbb7321d58e7efbe97bd26aa3fca37f32a033bfe795bb6d56f2830e46d9141fc3ee85572cf1a42ade898fe19dd5cc822a6

data/.gitignore

@@ -0,0 +1,3 @@
+*.conf
+*.config
+spec/lib/fixtures/v*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    migrate (0.0.1)
+      colorize (= 0.7.7)
+      highline (= 1.7.8)
+      json (= 1.8.3)
+      mysql2 (= 0.4.2)
+      parseconfig (= 1.0.6)
+      pg (= 0.18.4)
+      thor (= 0.19.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.7.7)
+    diff-lcs (1.2.5)
+    highline (1.7.8)
+    json (1.8.3)
+    mysql2 (0.4.2)
+    parseconfig (1.0.6)
+    pg (0.18.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  migrate!
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ivan Pusic
+
+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,60 @@
+# migrate
+
+Tool for managing and executing your database migrations.
+
+### How it works?
+It saves metadata about your migrations to database. It uses that metadata for executing and creating new migrations.
+
+It supports multiple databases and multiple languages for executing migrations.
+
+#### Supported databases
+- PostgreSQL
+- MySQL
+
+#### Supported languages
+- SQL
+- Ruby
+- Python
+- Javascript (Node.js)
+- Go
+
+### What I can do with it?
+```
+Commands:
+  migrate init               # make configuration file
+  migrate new [DESCRIPTION]  # generate files for new migration
+  migrate up                 # Upgrade database schema
+  migrate down               # Downgrade database schema
+  migrate list               # Show list of all migrations
+  migrate delete [VERSION]   # Will delete migration data
+  migrate version            # Show current version
+  migrate help [COMMAND]     # Describe available commands or one specific
+Options:
+  -r, [--root=ROOT]      # Sepcify migration root directory, where config file is located
+                         # Default: .
+  -c, [--config=CONFIG]  # Specify custom configuration file name
+                         # Default: migrate.conf
+```
+
+### How to use it?
+
+First thing you have to do is to make initial configuration with **migrate init** command.
+After that you can start generating migrations by using **migrate new** command. This will generate migration script for you based on your prefered language.
+
+When you are done with writing your `up` and `down` migration script, you can execute **migrate up** to run up migration script for new version. You can also execute multiple migrations in single call by providing `--to n` argument, where `n` is highest version where you want to navigate.
+
+You can also use **migrate down** to go one version back. `down` comand also accepts `--to n` argument, but in this case `n` is lowest version where you want to navigate.
+
+If you are asking yourself about current version, use **migrate version** to find out current version.
+
+If you don't need some migration, use **migrate delete n** to remove version `n`.
+
+You can see list of your migrations by running **migrate list**. This command also provides some additional options for filtering results.
+
+## Contributing
+- do ruby magic
+- write tests!
+- send pull request
+
+## License
+*MIT*

data/bin/migrate

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "json"
+require "highline"
+require_relative "../lib/migrate"
+
+include Migrate
+$asker = HighLine.new
+
+class CLI < Thor
+  method_option :root, {
+    :aliases => "-r",
+    :default => ".",
+    :desc => "Sepcify migration root directory, where config file is located"
+  }
+  method_option :config, {
+    :aliases => "-c",
+    :default => "migrate.conf",
+    :desc => "Specify custom configuration file name"
+  }
+  def initialize(*args)
+    super
+    @config = Config.new(options["root"], options["config"])
+
+    init_invoked = ARGV.length > 0 && ARGV[0] == "init"
+    if not init_invoked and @config.exists?
+      @config.load!
+      @migrator = Migrator.new(@config)
+    elsif not init_invoked
+      Log.error("Configuration not found in `#{Pathname.new(@config.root).expand_path}`. " \
+                "Make sure you are in right directory or " \
+                "run `migrate init` to create configuration.")
+      exit
+    end
+  end
+
+  desc "init", "make configuration file"
+  def init
+    Log.info("Creating configuration...")
+
+    storage = nil
+    $asker.choose do |menu|
+      menu.prompt = "Which database do you prefer?"
+
+      menu.choice(:mysql) { storage = "mysql" }
+      menu.choices(:pg) { storage = "pg" }
+    end
+
+    db_defaults = case storage
+    when "mysql"
+      { :port => "3306", :user => "root" }
+    when "pg"
+      { :port => "5432", :user => "postgres" }
+    end
+
+    lang = nil
+    $asker.choose do |menu|
+      menu.prompt = "What language would you like use for your migration scripts?"
+      
+      menu.choice(:sql) { lang = "sql" }
+      menu.choices(:ruby) { lang = "ruby" }
+      menu.choice(:javascript) { lang = "javascript" }
+      menu.choice(:go) { lang = "go" }
+      menu.choice(:python) { lang = "python" }
+    end
+
+    config = {
+      storage: storage,
+      lang: lang,
+      host: $asker.ask("Host: ") {|q| q.default = "localhost"},
+      port: ($asker.ask("Port: ") {|q| q.default = db_defaults[:port]}).to_i,
+      database: $asker.ask("Database Name: ") {|q| q.default = "mydb"},
+      user: $asker.ask("User: ") {|q| q.default = db_defaults[:user]},
+      password: $asker.ask("Password: ") {|q| q.default = nil},
+      version_info: $asker.ask("Version info table: ") {|q| q.default = "version_info"},
+      version_number: $asker.ask("Version number table: ") {|q| q.default = "version_number"}
+    }
+
+    @config.init(config)
+    @config.load!
+    Migrator.new(@config).init
+  rescue Exception => e
+    Log.error("Error while initialization.", e)
+    @config.remove
+    exit
+  end
+
+  desc "new [DESCRIPTION]", "generate files for new migration"
+  def new(description="")
+    @migrator.new(description)
+  end
+
+  desc "up", "Upgrade database schema"
+  option :to, :aliases => "-t", :desc => "Upgrade to the version"
+  def up
+    @migrator.up(options[:to])
+  rescue VersionNotFound => e
+    Log.error("Next version not found.")
+  rescue Exception => e
+    Log.error("Error while migrating up.", e)
+  end
+
+  desc "down [TO_VERSION]", "Downgrade database schema"
+  option :to, :aliases => "-t", :desc => "Downgrade back to the version"
+  def down
+    @migrator.down(options[:to])
+  rescue VersionNotFound => e
+    Log.error("Previous version not found.")
+  rescue Exception => e
+    Log.error("Error while migrating down.", e)
+  end
+
+  desc "list", "Show list of all migrations"
+  option :limit, :aliases => "-l", :desc => "Limit results"
+  option :select, :aliases => "-s", :desc => "Columns to select"
+  def list()
+    @migrator.list(options[:select], options[:limit])
+  end
+
+  desc "delete [VERSION]", "Will delete migration data"
+  def delete(version)
+    @migrator.delete(version.to_i)
+  rescue VersionNotFound
+    Log.error("Version not found.")
+  rescue Exception => e
+    Log.error("Error while removing migration.", e)
+  end
+
+  desc "version", "Show current version"
+  def version()
+    Log.version(@migrator.current_version())
+  end
+end
+
+CLI.start

data/lib/migrate.rb

@@ -0,0 +1,9 @@
+require_relative "./migrate/logger"
+require_relative "./migrate/config"
+require_relative "./migrate/storage"
+require_relative "./migrate/lang"
+require_relative "./migrate/migrator"
+require_relative "./migrate/errors"
+
+module Migrate
+end

data/lib/migrate/config.rb

@@ -0,0 +1,104 @@
+require "parseconfig"
+
+module Migrate
+  class Config
+    attr_reader :root
+
+    def initialize(root, file)
+      @root = root
+      @file=file
+      @file_path = "#{root}/#{file}"
+      @loaded = false
+    end
+
+    def exists?
+      File.exist? @file_path
+    end
+
+    def init(config)
+      if not Dir.exist? @root
+        Dir.mkdir @root
+      end
+
+      File.open(@file_path, "w") do |f|
+        config.map do |key, value|
+          f.puts "#{key}=#{value}\n"
+        end
+      end
+
+      Log.success("Configuration file created. Location: `#{@file_path}`")
+    end
+
+    def load!
+      Log.info("Loading configuration...")
+      config = ParseConfig.new(@file_path)
+  
+      config.get_params.map do |param|
+        self.class.send(:attr_reader, param)
+        instance_variable_set("@#{param}", config[param])
+      end
+
+      @loaded = true
+      Log.success("Configuration loaded.")
+    end
+
+    def delete
+      File.delete @file_path
+    rescue Exception => e
+      Log.error("Error while removing configuration file.", e)
+      exit
+    end
+
+    def get_db
+      case @storage
+      when "pg"
+        if @pg == nil
+          @pg = Storage::Postgres.new(self)
+        end
+
+        @pg
+      when "mysql"
+        if @mysql == nil
+          @mysql = Storage::Mysql.new(self)
+        end
+
+        @mysql
+      end
+    end
+
+    def get_lang
+      case @lang
+      when "sql"
+        if @sql == nil
+          @sql = Lang::Sql.new(get_db)
+        end
+
+        @sql
+      when "javascript"
+        if @javascript == nil
+          @javascript = Lang::Javascript.new
+        end
+
+        @javascript
+      when "ruby"
+        if @ruby == nil
+          @ruby = Lang::Ruby.new
+        end
+
+        @ruby
+      when "go"
+        if @go == nil
+          @go = Lang::Go.new
+        end
+
+        @go
+      when "python"
+        if @python == nil
+          @python = Lang::Python.new
+        end
+
+        @python
+      end
+    end
+  end
+end

data/lib/migrate/errors.rb

@@ -0,0 +1,4 @@
+module Migrate
+  class VersionNotFound < StandardError
+  end
+end

data/lib/migrate/lang.rb

@@ -0,0 +1,10 @@
+module Migrate
+  module Lang
+    require_relative "./lang/lang"
+    require_relative "./lang/sql"
+    require_relative "./lang/javascript"
+    require_relative "./lang/ruby"
+    require_relative "./lang/go"
+    require_relative "./lang/python"
+  end
+end

data/lib/migrate/lang/go.rb

@@ -0,0 +1,37 @@
+module Migrate
+  module Lang
+    class Go < Lang
+      def initialize
+        @ext = "go"
+      end
+
+      def create_migration(dir)
+        File.open("#{dir}/up.#{@ext}", "w") do |f|
+          f.puts <<-eot
+package main
+
+func main() {
+    // Here goes your Go migration forward
+}
+          eot
+        end
+
+        File.open("#{dir}/down.#{@ext}", "w") do |f|
+          f.puts <<-eot
+package main
+
+func main() {
+    // Here goes your Go migration backward
+}
+          eot
+        end
+      end
+
+      def exec_migration(dir, is_up)
+        script = "#{dir}/#{is_up ? "up" : "down"}.#{@ext}"
+        Log.info("Executing #{script}...")
+        `go run #{script}`
+      end
+    end
+  end
+end