pg_migrator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36d84444aad6de2cdd270d988eed37ef801345b1
+  data.tar.gz: 620a5c79de147d72ac8f5f457154d67849168fe8
+SHA512:
+  metadata.gz: 6efb9334f109eaa4897c456483c83f43245af196c9bd7d6d31e1aeb5f8030d831b85621d76983eec6a14d8c96b4a0d313cb3046eb00f4de2c2e60b0d89a6f60b
+  data.tar.gz: a68e4ec38d826b20502bb44fb200c2faafbd90776238882e18ba61ee21c01cab3d37bfe797c7de6fe4a9da48b93d9175365b15c264d4d3202f9e4d25f38cf049

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pierre BAZONNARD
+
+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,92 @@
+PG Migrator
+===========
+
+* This tool provides a set of Rake tasks to apply changes on different Postgres environments.
+* Every change, upgrade or rollback, is versionned.
+* Each environment is described by a configuration file.
+* Host, user, database name and migration SQL scripts location are defined in the configuration file.
+* For example, 'config/uat' is a 'User Aceptance Testing' environment.
+* 'config/dev' is the default environment used for development.
+
+
+Installation
+------------
+
+* gem install pg_migrator
+
+
+Getting started
+---------------
+
+* Create a minimal Rakefile as below, in an empty directory
+* 'rake -T' displays the available tasks
+* 'rake config' displays current configuration and creates minimal 'config' file if none
+* Fill in correct values in 'config/dev' file
+* Add other 'config' files as you need
+
+
+Minimal Rakefile
+----------------
+
+        require 'pg_migrator'
+        PGMigrator.new
+
+
+Configuration
+-------------
+
+* See 'config/dev' file.
+* Every environment configuration file is built on the same template.
+* The name of each environment is its configuration file name.
+* Environment is select by the option 'env=name'. See examples below.
+
+
+Migrations script files
+-----------------------
+
+Migration SQL scripts are stored in a directory compliant with the pattern configuration parameter.
+Default directory is 'migrations'.
+Each file initialize two variables '@up' and '@down' used to upgrade and rollback the database.
+Version number is the first 3 digits of the script file name.
+Script file names must be compliant with the pattern parameter and the 'xyz_comment.rb' format where xyz is the version number from '001' to '999'.
+An empty newly created database is in version '000'.
+Several files can have the same version number.
+
+Example: 'migrations/002_add_id_3_in_tablename.rb'
+
+    @up   = "INSERT INTO tablename (id, caption) VALUES (3,'something');"
+    @down = "DELETE FROM tablename WHERE id = 3;"
+
+
+Database requirements
+---------------------
+
+* For now, database engine MUST BE Postgres.
+* The database MUST NOT have a table called 'migrations'.
+* Database version is the version of the last database upgrade, stored in the 'migrations' table.
+* An empty database is in version '000'.
+
+Options
+-------
+
+* '-s' or '-q' Rake options also suppresse pg_migrator messages.
+* '-v' verbose is default mode
+
+
+Usage examples
+--------------
+
+Show configuration of the 'uat' environment
+```
+rake config env=uat
+```
+
+Migrate the 'uat' environment in silent mode
+```
+rake db:migrate env=uat -s
+```
+
+Show the list of migrations of the 'dev' environment
+```
+rake migrations
+```

data/Rakefile

@@ -0,0 +1,39 @@
+# coding: utf-8
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rubygems'
+require 'rubygems/package'
+require 'rubygems/installer'
+
+spec = Gem::Specification.load('pg_migrator.gemspec')
+target = "#{spec.name}-#{spec.version}.gem"
+
+CLEAN.include "#{spec.name}*.gem"
+
+Rake::TestTask.new do |t|
+  # Beware: Rake.verbose can be undefined (class Object but not nil)
+  if Rake.verbose == true
+    t.verbose = true
+    ENV['verbose'] = 'true'
+  else
+    t.verbose = false
+    ENV['verbose'] = 'false'
+  end
+end
+
+desc 'Build gem'
+task build: 'clean' do
+  Gem::Package.build spec, true
+end
+
+desc 'Install gem'
+task install: 'build' do
+  gi = Gem::Installer.new target
+  gi.install
+end
+
+rakefiles = Rake::FileList['tasks/*.rake']
+rakefiles.each do |file|
+  load "#{file}"
+end

data/lib/config.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+require 'pyer/properties'
+
+# Read configuration file
+class Config
+  attr_reader :env, :host, :port, :username, :password, :database, :version0, :upgrade, :downgrade, :verbose
+
+  def initialize
+    @env = ENV['env']
+    @env = 'dev' if @env.nil?
+    config = Pyer::Properties.new("config/#{@env}")
+    @host      = config.host
+    @port      = config.port
+    @username  = config.username
+    @password  = config.password
+    @database  = config.database
+    @version0  = config.version0
+    @upgrade   = config.upgrade
+    @downgrade = config.downgrade
+    @verbose   = ENV['verbose'] == 'true'
+  end
+
+  def create
+    Dir.mkdir 'config' unless File.exist?('config')
+    File.open("config/#{@env}", 'w') do |f|
+      f.write("database  = \n")
+      f.write("host      = localhost\n")
+      f.write("port      = 5432\n")
+      f.write("username  = \n")
+      f.write("password  = \n")
+      f.write("encoding  = utf8\n")
+      f.write("version0  = 0.00\n")
+      f.write("upgrade   = migrations/*_up_*.sql\n")
+      f.write("downgrade = migrations/*_down_*.sql\n")
+    end unless File.exist?("config/#{@env}")
+  end
+
+  # Extract version number from the SQL script path name
+  # Version is text between last '/' and '_'
+  # File path must end with '.sql'
+  def version(path)
+    path.gsub(%r{.*/}, '').gsub(/_.*\.sql/, '')
+  end
+end

data/lib/db.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+require 'config'
+require 'postgres'
+
+# Database managment
+class DB
+  def self.create(config)
+    pg = Postgres.new(config, 'postgres')
+    pg.execute("CREATE DATABASE #{config.database} OWNER #{config.username};")
+    pg.finish
+    DB.version(config) # create migrations table
+    pg.ok?
+  end
+
+  def self.drop(config)
+    pg = Postgres.new(config, 'postgres')
+    pg.execute("DROP DATABASE #{config.database};")
+    pg.finish
+    pg.ok?
+  end
+
+  def self.version(config)
+    pg = Postgres.new(config)
+    ver = pg.value('SELECT version FROM migrations ORDER BY updated_on DESC LIMIT 1;')
+    if ver.empty? && pg.connected?
+      ver = config.version0
+      pg.execute("CREATE TABLE migrations (
+                    version character varying NOT NULL,
+                    updated_on timestamp without time zone);")
+      pg.execute("INSERT INTO migrations VALUES('#{ver}', now());")
+    end
+    pg.finish
+    ver
+  end
+
+  def self.migrations(config)
+    mig = []
+    pg = Postgres.new(config)
+    mig = pg.execute('SELECT * FROM migrations ORDER BY updated_on;') if pg.ok?
+    pg.finish
+    mig
+  end
+
+  def self.databases(config)
+    dbs = []
+    pg = Postgres.new(config, 'postgres')
+    dbs = pg.execute('SELECT * FROM pg_database ORDER BY datname;') if pg_ok?
+    pg.finish
+    dbs
+  end
+
+  def self.migrate(config)
+    db_version = DB.version(config)
+    return nil if db_version.empty?
+    Dir[config.upgrade].sort.each do |file|
+      next unless config.version(file) > db_version
+      pg = Postgres.new(config)
+      pg.update(file)
+      pg.finish
+    end
+  end
+
+  def self.forward(config)
+    db_version = DB.version(config)
+    return nil if db_version.empty?
+    db_version.next!
+    Dir[config.upgrade].sort.each do |file|
+      next unless config.version(file) == db_version
+      pg = Postgres.new(config)
+      pg.update(file)
+      pg.finish
+    end
+  end
+
+  def self.rollback(config)
+    db_version = DB.version(config)
+    return nil if db_version.empty?
+    Dir[config.downgrade].sort.each do |file|
+      next unless config.version(file) == db_version
+      pg = Postgres.new(config)
+      pg.update(file)
+      pg.execute("DELETE FROM migrations WHERE version='#{db_version}';")
+      pg.finish
+    end
+  end
+end

data/lib/pg_migrator.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+#
+# Load rake tasks
+class PGMigrator
+  def initialize
+    $LOAD_PATH.each do |p|
+      Dir["#{p}/*"].each do |d|
+        load d if %r{pg_migrator.*/tasks/.*\.rake$}.match(d)
+      end
+    end
+  end
+end

data/lib/postgres.rb

@@ -0,0 +1,101 @@
+# coding: utf-8
+require 'pg'
+
+# Postgres database API
+class Postgres
+  attr_reader :config, :connection, :status
+
+  def initialize(conf, user = nil)
+    @status = true
+    @config = conf
+    begin
+      if user.nil?
+        @connection = PG::Connection.new(dbname: @config.database, user: @config.username, password: @config.password,
+                                         host: @config.host, port: @config.port)
+      else
+        # assuming user is postgres, dbname is also postgres
+        @connection = PG::Connection.new(dbname: user, user: user,
+                                         host: config.host, port: config.port)
+      end
+    rescue PG::Error => e
+      trace e.message
+      @connection = nil
+      @status = false
+    end
+  end
+
+  def connected?
+    ! @connection.nil?
+  end
+
+  def ok?
+    @status
+  end
+
+  def finish
+    @connection.finish unless @connection.nil?
+    @status
+  end
+
+  def trace(message)
+    puts message if @config.verbose
+  end
+
+  def execute(query)
+    begin
+      trace query
+      result = @connection.query(query)
+    rescue PG::Error => e
+      trace e.message
+      # puts "ERROR: failed query [#{query}]" if @config.verbose
+      @status = false
+      result = nil
+    end
+    result
+  end
+
+  def value(query)
+    return '' unless @status
+    begin
+      result = @connection.query(query)
+      return result.getvalue(0, 0).to_s
+    rescue PG::Error => e
+      trace e.message
+      @status = false
+      return ''
+    end
+  end
+
+  def script(file)
+    query = ''
+    file.each_line do |line|
+      trace line
+      query = query + ' ' + line
+      if query.end_with?(';')
+        @connection.query(query)
+        query = ''
+      end
+    end
+  end
+
+  def update(file_name)
+    puts "Executing #{file_name}" if @config.verbose
+    ver = @config.version(file_name)
+    begin
+      trace 'BEGIN;'
+      @connection.query('BEGIN;')
+      file = File.open(file_name, 'r')
+      script(file)
+      file.close
+      @connection.query("INSERT INTO migrations VALUES('#{ver}', now());")
+      trace 'COMMIT;'
+      @connection.query('COMMIT;')
+    rescue SystemCallError => e
+      trace e.message
+      @connection.query('ROLLBACK;')
+    rescue PG::Error => e
+      trace e.message
+      @connection.query('ROLLBACK;')
+    end
+  end
+end

data/pg_migrator.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'pg_migrator'
+  s.version       = '1.0.1'
+  s.author        = 'Pierre BAZONNARD'
+  s.email         = ['pierre.bazonnard@gmail.com']
+  s.homepage      = 'https://github.com/pyer/pg_migrator'
+  s.summary       = 'Migrate Postgres databases'
+  s.description   = 'This tool provides a set of Rake tasks to apply changes on different Postgres environments.'
+  s.license       = 'MIT'
+  s.files         = Dir['lib/*.rb'] + Dir['tasks/*.rake'] + ['Rakefile', 'LICENSE', 'README.md', __FILE__]
+  s.require_paths = %w(lib tasks)
+  s.required_ruby_version = '~> 2'
+
+  s.add_dependency 'rake', '~> 10'
+  s.add_dependency 'pg', '~> 0'
+  s.add_dependency 'pyer-properties', '~> 1'
+  s.add_development_dependency 'minitest', '~> 5'
+
+  s.requirements  = 'Postgres'
+end

data/tasks/config.rake

@@ -0,0 +1,35 @@
+# coding: utf-8
+require 'rake'
+require 'config'
+
+@config  = nil
+
+task :load_config do
+  @config = Config.new
+end
+
+desc 'Show configuration'
+task config: :load_config do
+  puts "Environment : #{@config.env}"
+  if @config.database.nil?
+    @config.create
+    puts 'ERROR: empty config file'
+  else
+    puts "Host        : #{@config.host}"
+    puts "Port        : #{@config.port}"
+    puts "User        : #{@config.username}"
+    puts "Database    : #{@config.database}"
+  end
+end
+
+# Environment is defined by the ENV variable
+# For example:
+#   rake migrate env=dev
+desc 'Show environments'
+task environments: :load_config do
+  Rake::FileList['config/*'].each do |file|
+    puts file.split('/')[1]
+  end
+end
+
+task default: :config

data/tasks/db.rake

@@ -0,0 +1,51 @@
+# coding: utf-8
+require 'db'
+
+desc 'Show the current database version'
+task version: [:load_config] do
+  puts "Environment  : #{@config.env}"
+  puts "Database     : #{@config.database}"
+  puts "Version      : #{DB.version(@config)}"
+  puts "Next version : #{DB.version(@config).next}"
+end
+
+desc 'List the current database migrations'
+task migrations: [:load_config] do
+  DB.migrations(@config).each do |row|
+    puts row['version'] + '  ' + row['updated_on']
+  end
+end
+
+desc 'List the databases'
+task databases: [:load_config] do
+  DB.databases(@config).each do |row|
+    puts row['datname']
+  end
+end
+
+namespace :db do
+  desc 'Create the current database'
+  task create: [:load_config] do
+    DB.create(@config)
+  end
+
+  desc 'Drop the current database'
+  task drop: [:load_config] do
+    DB.drop(@config)
+  end
+
+  desc 'Migrate the current database to the last version'
+  task migrate: [:load_config] do
+    DB.migrate(@config)
+  end
+
+  desc 'Roll the current database back to the previous version'
+  task rollback: [:environment, :load_config] do
+    DB.rollback(@config)
+  end
+
+  desc 'Push the current database to the next version'
+  task forward: [:environment, :load_config] do
+    DB.forward(@config)
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: pg_migrator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Pierre BAZONNARD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: pyer-properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This tool provides a set of Rake tasks to apply changes on different
+  Postgres environments.
+email:
+- pierre.bazonnard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/config.rb
+- lib/db.rb
+- lib/pg_migrator.rb
+- lib/postgres.rb
+- tasks/config.rake
+- tasks/db.rake
+- Rakefile
+- LICENSE
+- README.md
+- pg_migrator.gemspec
+homepage: https://github.com/pyer/pg_migrator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- tasks
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Postgres
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Migrate Postgres databases
+test_files: []