pg-schema-migration 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6c40b5c1a5b55b983ddd433ba4ac78c6d9ba0f3a55f06a7472a6657dee28f98
+  data.tar.gz: 7d5d7d07dbc818d29e0a81ebd46cb041ac10e14af9f11cc699a397bea75f17ef
+SHA512:
+  metadata.gz: ab53c65ef78c33f718ba5ce0d749bfafe8a24e113758e6b8295f244ed567f486c380c25c32b0213b6c4fe3aa77eb59e9e9cc500942e64af0a17947fff0ce87d1
+  data.tar.gz: 4385a5096b0d7db59f5011dce601a62d7e7706e20e933e13d8c9b6ba72204a40713a482036c75eb52dff538f262aa2941be368acb6c55f305d9b1ccdf318ea35

data/.gems

@@ -0,0 +1,2 @@
+pg -v 1.0.0
+pry -v 0.11.3

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.4.1-slim
+
+MAINTAINER Alfredo Ramírez <alfredormz@gmail.com>
+
+ENV PAGER="more"
+
+RUN \
+  apt-get update && \
+  apt-get -y install build-essential libpq-dev
+
+ENV HOME /root
+
+WORKDIR /app
+
+COPY .gems /tmp/
+
+RUN \
+  gem install dep:1.1.0 && \
+  cd /tmp/ && \
+  dep -f .gems install && dep -f .gems && rm .gems
+
+COPY . /app/

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2018 Alfredo Ramírez.
+
+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,100 @@
+# PG Schema Migration
+
+Simple schema migrations for PostgreSQL, which runs pure SQL. Inspired by [Sequel](https://github.com/jeremyevans/sequel) and [Cassandra Schema](https://github.com/tarolandia/cassandra-schema).
+
+## Installation
+
+```
+gem install pg-schema-migration
+```
+
+## Usage
+
+PG::Schema uses a DSL via the `PG::Schema.migration` method, a migration must have an `up` block with the changes you want to apply to the schema, and a `down` block reversing the change made by `up`.
+
+### A basic Migration
+
+Use `execute` inside `up` and `down` blocks to run the queries that will modify the schema. Here is a fairly basic `PG::Schema` migration. 
+
+```ruby
+PG:Schema.migration do
+  up do
+    execute <<~SQL
+      CREATE TABLE products (
+        name VARCHAR(30),
+        price NUMERIC
+      )
+    SQL
+    
+    execute "CREATE TRIGGER..."
+  end
+  
+  down do
+    execute "DROP TABLE products"
+    execute "DROP TRIGGER..."
+  end
+end
+```
+If there is an error while running a migration, it will rollback the previous schema changes made by the migration.
+
+### Running migrations
+
+```ruby
+require 'pg/schema-migration'
+require 'pg'
+
+@db = PG.connect(ENV.fetch("DATABASE_URL"))
+
+PG::Schema.migration {...}
+PG::Schema.migration {...}
+
+migrator = PG::Schema::Migrator.new(
+  db:        @db,                   # a PG connection
+  directory: 'path/to/migrations',  # default: nil
+  log:       Logger.new('/dev/nul') # default: Logger.new(STDOUT)
+)
+```
+Migrate to the latest version
+
+```ruby
+migrator.run!
+```
+Migrate to an specific version
+
+```ruby
+migrator.run!(version: 1)
+```
+### Migration files
+
+`PG::Schemas::Migrator` expects that each migration file will be in a specific directory. For example:
+
+```ruby
+PG::Schema::Migrator.new(db: @conn, directory: 'db/migrations').run!
+```
+
+`PG::Schema::Migrator` will look in the `db/migrations` folder relative to the current directory, and run unapplied migrations on the database.
+
+The migration files must be specified as follows:
+
+```bash
+version_name.rb
+```
+
+where `version` is an integer and `name` is a string which should be a very brief description of what the migration does. Examples:
+```bash
+001_create_films.rb
+002_add_director_to_films.rb
+...
+015_foo.rb
+016_bar.rb
+```
+This guide is based on https://github.com/jeremyevans/sequel/blob/master/doc/migration.rdoc
+
+# License
+Copyright (c) 2018 Alfredo Ramírez.
+
+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/docker-compose.yml

@@ -0,0 +1,22 @@
+---
+version: '2'
+
+services:
+  pg:
+    image: postgres
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: pg-schema-migration-test
+  test:
+    command: tail -f /dev/null
+    image: pg-schema-migration:test
+    working_dir: /opt/test
+    volumes:
+      - ${PWD}:/opt/test
+    links:
+      - pg
+    environment:
+      DATABASE_URL: "postgresql://postgres:postgres@pg:5432/pg-schema-migration-test"

data/lib/pg/schema-migration.rb

@@ -0,0 +1,164 @@
+require 'pg'
+require 'logger'
+
+module PG
+  module Schema
+    @@migrations = []
+
+    MigrationNotFoundError = Class.new(Exception)
+
+    def self.migrations
+      @@migrations
+    end
+
+    def self.migration(&block)
+      MigrationDSL.new(&block).migration.tap do |migration|
+        @@migrations << migration
+      end
+    end
+
+    def self.get_migration_by_version(version)
+      migration_position = version - 1
+
+      raise MigrationNotFoundError, "can't find migration with version #{version}" unless @@migrations[migration_position]
+
+      @@migrations[migration_position]
+    end
+
+    class Migration
+      attr_accessor :up, :down
+
+      def initialize
+        @up   = []
+        @down = []
+      end
+    end
+
+    class MigrationDSL < BasicObject
+      attr_reader :migration
+
+      def initialize(&block)
+        @migration = Migration.new
+        instance_eval(&block)
+      end
+
+      def up(&block)
+        @commands     = []
+        @migration.up = block.call
+      end
+
+      def down(&block)
+        @commands       = []
+        @migration.down = block.call
+      end
+
+      def execute(command)
+        @commands << command
+      end
+    end
+
+    class Migrator
+      attr_accessor :connection, :directory
+
+      MIGRATION_FILE_REGEX = /^(\d+)_.+\.rb/i
+
+      def initialize(db:, directory: nil, log: Logger.new(STDOUT))
+        @db        = db
+        @directory = directory
+        @log       = log
+
+        load_migration_files
+        generate_schema_migration_table!
+      end
+
+      def run!(version: nil)
+        migrations       = PG::Schema.migrations
+        _current_version = current_version
+
+        version||= migrations.count
+
+        if version == _current_version || migrations.empty?
+          @log.info "Nothing to do."
+          return
+        end
+
+        t = Time.now
+        @log.info "Migrationg from #{_current_version} to version #{version}"
+        if version > _current_version
+          (_current_version + 1).upto(version) do |target|
+            apply(target, :up)
+          end
+        else
+          (_current_version).downto(version + 1) do |target|
+            apply(target, :down)
+          end
+        end
+
+        @log.info "Finished applying migration #{version}, took #{sprintf('%0.6f', Time.now - t)} seconds"
+        @log.info "Done!"
+      end
+
+      def apply(version, direction)
+        migration = PG::Schema.get_migration_by_version(version)
+        commands  = migration.public_send(direction)
+
+        commands.reverse! if direction == :down
+
+        @db.transaction do
+          commands.each do |command|
+            @db.exec(command)
+          end
+        end
+
+        update_version(direction == :up ? version : version - 1)
+      rescue => error
+        @log.error error.message
+        @log.info  "The migration failed. Current version #{current_version}"
+        raise
+      end
+
+      def load_migration_files
+        files = []
+
+        if directory
+          Dir.new(directory).sort.each do |file|
+            next unless file.match(MIGRATION_FILE_REGEX)
+            file = File.join(directory, file)
+            files << file
+            load(file)
+          end
+        end
+
+        files
+      end
+
+      def generate_schema_migration_table!
+        @db.exec <<~SQL
+          CREATE TABLE IF NOT EXISTS schema_information (
+            version INTEGER DEFAULT 0 NOT NULL
+          )
+        SQL
+
+        if @db.exec("SELECT * FROM schema_information").ntuples.zero?
+          @db.exec <<~SQL
+            INSERT INTO schema_information DEFAULT VALUES
+          SQL
+        end
+      end
+
+      def update_version(version)
+        @db.exec("UPDATE schema_information SET version = $1", [version])
+      end
+
+      def current_version
+        res = @db.exec <<~SQL
+          SELECT version FROM schema_information
+        SQL
+
+        raise "Schema information has multiple values" if res.ntuples > 1
+
+        res.field_values("version").first.to_i
+      end
+    end
+  end
+end

data/pg-schema-migration.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name          = "pg-schema-migration"
+  s.version       = "0.0.1"
+  s.summary       = "PG Schema Migration"
+  s.description   = "Simple schema migrations for PostgreSQL, which runs pure SQL."
+  s.authors       = ["Alfredo Ramírez"]
+  s.email         = ["alfredormz@gmail.com"]
+  s.homepage      = "http://github.com/alfredormz/pg-schema-migration"
+  s.license       = "MIT"
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency "pg"
+end

data/test/db/migrations/001_create_table_users.rb

@@ -0,0 +1,17 @@
+PG::Schema.migration do
+  up do
+    execute <<~SQL
+      CREATE TABLE users (
+        id         integer,
+        name       varchar(30),
+        created_at timestamp
+      )
+    SQL
+  end
+
+  down do
+    execute <<~SQL
+      DROP TABLE users
+    SQL
+  end
+end

data/test/db/migrations/002_create_table_films.rb

@@ -0,0 +1,19 @@
+PG::Schema.migration do
+  up do
+    execute <<~SQL
+      CREATE TABLE films (
+        code  varchar(5),
+        title varchar(30)
+      )
+    SQL
+
+    execute <<~SQL
+      ALTER TABLE users ADD COLUMN email varchar(40)
+    SQL
+  end
+
+  down do
+    execute "DROP TABLE films"
+    execute "ALTER TABLE users DROP COLUMN email"
+  end
+end

data/test/pg/schema_migration_spec.rb

@@ -0,0 +1,190 @@
+require 'minitest/autorun'
+require_relative '../../lib/pg/schema-migration'
+
+describe "PG::Schema" do
+  before do
+    PG::Schema.migrations.clear
+  end
+
+  describe "PG::Schema.migrations" do
+    it "returns an empty migrations array" do
+      assert_equal [], PG::Schema.migrations
+    end
+
+    it "should include migration instances created by migration DSL" do
+      migration = PG::Schema.migration {}
+
+      assert_equal PG::Schema::Migration, migration.class
+      assert_equal [migration],           PG::Schema.migrations
+    end
+
+    it "should return migrations in order of creation" do
+      i1 = PG::Schema.migration {}
+      i2 = PG::Schema.migration {}
+      i3 = PG::Schema.migration {}
+
+      assert_equal [i1, i2, i3], PG::Schema.migrations
+    end
+
+    it "should get a singular migration by the version number" do
+      i1 = PG::Schema.migration {}
+      i2 = PG::Schema.migration {}
+      i3 = PG::Schema.migration {}
+
+      assert_equal i1, PG::Schema.get_migration_by_version(1)
+      assert_equal i2, PG::Schema.get_migration_by_version(2)
+      assert_equal i3, PG::Schema.get_migration_by_version(3)
+
+      assert_raises PG::Schema::MigrationNotFoundError do
+        PG::Schema.get_migration_by_version(4)
+      end
+    end
+  end
+
+  describe "DSL" do
+    it "should have default up and down that do nothing" do
+      m = PG::Schema.migration {}
+
+      assert_equal [], m.up
+      assert_equal [], m.down
+    end
+
+    it "should create migration with up and down commands" do
+      PG::Schema.migration do
+        up do
+          execute "SQL sentence #1"
+          execute "SQL sentence #2"
+        end
+
+        down do
+          execute "Revert SQL sentence #1"
+          execute "Revert SQL sentence #2"
+        end
+      end
+
+      migration = PG::Schema.migrations.first
+
+      assert_equal(
+        [
+          "SQL sentence #1",
+          "SQL sentence #2",
+        ],
+        migration.up,
+      )
+
+      assert_equal(
+        [
+          "Revert SQL sentence #1",
+          "Revert SQL sentence #2",
+        ],
+        migration.down,
+      )
+    end
+  end
+
+  describe "PG::Schema::Migrator" do
+    before do
+      @conn = PG.connect(ENV['DATABASE_URL'])
+
+      # Disable PostgreSQL notice messages
+      @conn.set_notice_receiver {}
+
+      @conn.exec("DROP TABLE IF EXISTS schema_information")
+      @conn.exec("DROP TABLE IF EXISTS users")
+      @conn.exec("DROP TABLE IF EXISTS films")
+
+      @migrator = PG::Schema::Migrator.new(
+        db:        @conn,
+        directory: 'test/db/migrations',
+        log:       Logger.new('/dev/null'),
+      )
+    end
+
+    it "should find and sort the migration files" do
+      assert_equal(
+        [
+          "test/db/migrations/001_create_table_users.rb",
+          "test/db/migrations/002_create_table_films.rb",
+          "test/db/migrations/015_empty_migration.rb",
+        ],
+        @migrator.load_migration_files,
+      )
+    end
+
+    it "should have '0' as current version" do
+      assert_equal 0, @migrator.current_version
+    end
+
+    it "should load the migration files as migrations" do
+      assert_equal 2, PG::Schema.migrations.size
+
+      # Add a new empty migration
+      PG::Schema.migration {}
+
+      assert_equal 3, PG::Schema.migrations.size
+    end
+
+    describe "migrating up" do
+      it "should migrates to the last version " do
+        @migrator.run!
+        assert_equal 2, @migrator.current_version
+      end
+
+      it "should executes the first migration" do
+        @migrator.run!(version: 1)
+        assert_equal 1, @migrator.current_version
+      end
+
+      it "should executes the 2nd migration" do
+        @migrator.run!(version: 2)
+        assert_equal 2, @migrator.current_version
+      end
+
+      it "should raise an exception if the version doen't exist" do
+        assert_raises PG::Schema::MigrationNotFoundError do
+          @migrator.run!(version: 4)
+        end
+      end
+
+      it "should not raise an exception with multiple runs " do
+        @migrator.run!
+        @migrator.run!
+        @migrator.run!
+
+        assert_equal 2, @migrator.current_version
+      end
+
+      it "should rollback the migration if a command failed" do
+        PG::Schema.migration do
+          up do
+            execute "CREATE TABLE test_users AS TABLE users"
+            execute "SOME FAULTY SQL"
+          end
+        end
+
+        assert_raises PG::SyntaxError do
+          @migrator.run!
+        end
+
+        assert_equal 3, PG::Schema.migrations.count
+        assert_equal 2, @migrator.current_version
+      end
+    end
+
+    describe "migrating down" do
+      before do
+        @migrator.run!
+      end
+
+      it "should migrates to the first version " do
+        @migrator.run!(version: 1)
+        assert_equal 1, @migrator.current_version
+      end
+
+      it "should reset the schema when the version is 0" do
+        @migrator.run!(version: 0)
+        assert_equal 0, @migrator.current_version
+      end
+    end
+  end
+end

data/test/run

@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+
+cd "$(dirname "$0")"/..
+
+docker build -t pg-schema-migration:test -f Dockerfile .
+
+docker-compose -p pg-schema-migration \
+               -f docker-compose.yml run test \
+               sh -c "ruby test/pg/schema_migration_spec.rb"

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: pg-schema-migration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alfredo Ramírez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Simple schema migrations for PostgreSQL, which runs pure SQL.
+email:
+- alfredormz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- Dockerfile
+- LICENSE
+- README.md
+- docker-compose.yml
+- lib/pg/schema-migration.rb
+- pg-schema-migration.gemspec
+- test/db/migrations/001_create_table_users.rb
+- test/db/migrations/002_create_table_films.rb
+- test/db/migrations/015_empty_migration.rb
+- test/pg/schema_migration_spec.rb
+- test/run
+homepage: http://github.com/alfredormz/pg-schema-migration
+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.7.4
+signing_key: 
+specification_version: 4
+summary: PG Schema Migration
+test_files: []