db_schema 0.1

data/lib/db_schema/runner.rb

@@ -0,0 +1,220 @@
+module DbSchema
+  class Runner
+    attr_reader :changes
+
+    def initialize(changes)
+      @changes = preprocess_changes(changes)
+    end
+
+    def run!
+      DbSchema.connection.transaction do
+        changes.each do |change|
+          case change
+          when Changes::CreateTable
+            self.class.create_table(change)
+          when Changes::DropTable
+            self.class.drop_table(change)
+          when Changes::AlterTable
+            self.class.alter_table(change)
+          when Changes::CreateForeignKey
+            self.class.create_foreign_key(change)
+          when Changes::DropForeignKey
+            self.class.drop_foreign_key(change)
+          when Changes::CreateEnum
+            self.class.create_enum(change)
+          when Changes::DropEnum
+            self.class.drop_enum(change)
+          end
+        end
+      end
+
+      # Postgres doesn't allow modifying enums inside a transaction
+      Utils.filter_by_class(changes, Changes::AddValueToEnum).each do |change|
+        self.class.add_value_to_enum(change)
+      end
+    end
+
+  private
+    def preprocess_changes(changes)
+      Utils.sort_by_class(
+        changes,
+        [
+          Changes::AddValueToEnum,
+          Changes::DropForeignKey,
+          Changes::CreateEnum,
+          Changes::CreateTable,
+          Changes::AlterTable,
+          Changes::DropTable,
+          Changes::DropEnum,
+          Changes::CreateForeignKey
+        ]
+      )
+    end
+
+    class << self
+      def create_table(change)
+        DbSchema.connection.create_table(change.name) do
+          change.fields.each do |field|
+            if field.primary_key?
+              primary_key(field.name)
+            else
+              options = Runner.map_options(field.class.type, field.options)
+              column(field.name, field.type.capitalize, options)
+            end
+          end
+
+          change.indices.each do |index|
+            fields = if index.btree?
+              index.fields.map(&:to_sequel)
+            else
+              index.fields.map(&:name)
+            end
+
+            index(
+              fields,
+              name:   index.name,
+              unique: index.unique?,
+              type:   index.type,
+              where:  index.condition
+            )
+          end
+
+          change.checks.each do |check|
+            constraint(check.name, check.condition)
+          end
+        end
+      end
+
+      def drop_table(change)
+        DbSchema.connection.drop_table(change.name)
+      end
+
+      def alter_table(change)
+        DbSchema.connection.alter_table(change.name) do
+          Utils.sort_by_class(
+            change.fields + change.indices + change.checks,
+            [
+              DbSchema::Changes::DropPrimaryKey,
+              DbSchema::Changes::DropCheckConstraint,
+              DbSchema::Changes::DropIndex,
+              DbSchema::Changes::DropColumn,
+              DbSchema::Changes::RenameColumn,
+              DbSchema::Changes::AlterColumnType,
+              DbSchema::Changes::AllowNull,
+              DbSchema::Changes::DisallowNull,
+              DbSchema::Changes::AlterColumnDefault,
+              DbSchema::Changes::CreateColumn,
+              DbSchema::Changes::CreateIndex,
+              DbSchema::Changes::CreateCheckConstraint,
+              DbSchema::Changes::CreatePrimaryKey
+            ]
+          ).each do |element|
+            case element
+            when Changes::CreateColumn
+              if element.primary_key?
+                add_primary_key(element.name)
+              else
+                options = Runner.map_options(element.type, element.options)
+                add_column(element.name, element.type.capitalize, options)
+              end
+            when Changes::DropColumn
+              drop_column(element.name)
+            when Changes::RenameColumn
+              rename_column(element.old_name, element.new_name)
+            when Changes::AlterColumnType
+              attributes = Runner.map_options(element.new_type, element.new_attributes)
+              set_column_type(element.name, element.new_type.capitalize, attributes)
+            when Changes::CreatePrimaryKey
+              raise NotImplementedError, 'Converting an existing column to primary key is currently unsupported'
+            when Changes::DropPrimaryKey
+              raise NotImplementedError, 'Removing a primary key while leaving the column is currently unsupported'
+            when Changes::AllowNull
+              set_column_allow_null(element.name)
+            when Changes::DisallowNull
+              set_column_not_null(element.name)
+            when Changes::AlterColumnDefault
+              set_column_default(element.name, element.new_default)
+            when Changes::CreateIndex
+              fields = if element.btree?
+                element.fields.map(&:to_sequel)
+              else
+                element.fields.map(&:name)
+              end
+
+              add_index(
+                fields,
+                name:   element.name,
+                unique: element.unique?,
+                type:   element.type,
+                where:  element.condition
+              )
+            when Changes::DropIndex
+              drop_index([], name: element.name)
+            when Changes::CreateCheckConstraint
+              add_constraint(element.name, element.condition)
+            when Changes::DropCheckConstraint
+              drop_constraint(element.name)
+            end
+          end
+        end
+      end
+
+      def create_foreign_key(change)
+        DbSchema.connection.alter_table(change.table_name) do
+          add_foreign_key(change.foreign_key.fields, change.foreign_key.table, change.foreign_key.options)
+        end
+      end
+
+      def drop_foreign_key(change)
+        DbSchema.connection.alter_table(change.table_name) do
+          drop_foreign_key([], name: change.fkey_name)
+        end
+      end
+
+      def create_enum(change)
+        DbSchema.connection.create_enum(change.name, change.values)
+      end
+
+      def drop_enum(change)
+        DbSchema.connection.drop_enum(change.name)
+      end
+
+      def add_value_to_enum(change)
+        if change.add_to_the_end?
+          DbSchema.connection.add_enum_value(change.enum_name, change.new_value)
+        else
+          DbSchema.connection.add_enum_value(change.enum_name, change.new_value, before: change.before)
+        end
+      end
+
+      def map_options(type, options)
+        mapping = case type
+        when :char, :varchar, :bit, :varbit
+          Utils.rename_keys(options, length: :size)
+        when :numeric
+          Utils.rename_keys(options) do |new_options|
+            precision, scale = Utils.delete_at(new_options, :precision, :scale)
+
+            if precision
+              if scale
+                new_options[:size] = [precision, scale]
+              else
+                new_options[:size] = precision
+              end
+            end
+          end
+        when :interval
+          Utils.rename_keys(options, precision: :size) do |new_options|
+            new_options[:type] = "INTERVAL #{new_options.delete(:fields).upcase}"
+          end
+        when :array
+          Utils.rename_keys(options) do |new_options|
+            new_options[:type] = "#{new_options.delete(:element_type)}[]"
+          end
+        else
+          options
+        end
+      end
+    end
+  end
+end

data/lib/db_schema/utils.rb

@@ -0,0 +1,50 @@
+module DbSchema
+  module Utils
+    class << self
+      def rename_keys(hash, mapping = {})
+        hash.reduce({}) do |final_hash, (key, value)|
+          new_key = mapping.fetch(key, key)
+          final_hash.merge(new_key => value)
+        end.tap do |final_hash|
+          yield(final_hash) if block_given?
+        end
+      end
+
+      def filter_by_keys(hash, *needed_keys)
+        hash.reduce({}) do |final_hash, (key, value)|
+          if needed_keys.include?(key)
+            final_hash.merge(key => value)
+          else
+            final_hash
+          end
+        end
+      end
+
+      def delete_at(hash, *keys)
+        keys.map do |key|
+          hash.delete(key)
+        end
+      end
+
+      def symbolize_keys(hash)
+        return hash unless hash.is_a?(Hash)
+
+        hash.reduce({}) do |new_hash, (key, value)|
+          new_hash.merge(key.to_sym => symbolize_keys(value))
+        end
+      end
+
+      def sort_by_class(array, sorted_classes)
+        sorted_classes.flat_map do |klass|
+          array.select { |object| object.is_a?(klass) }
+        end
+      end
+
+      def filter_by_class(array, klass)
+        array.select do |element|
+          element.is_a?(klass)
+        end
+      end
+    end
+  end
+end

data/lib/db_schema/validator.rb

@@ -0,0 +1,89 @@
+module DbSchema
+  module Validator
+    class << self
+      def validate(schema)
+        tables = Utils.filter_by_class(schema, Definitions::Table)
+        enums  = Utils.filter_by_class(schema, Definitions::Enum)
+
+        table_errors = tables.each_with_object([]) do |table, errors|
+          primary_keys_count = table.fields.select(&:primary_key?).count
+          if primary_keys_count > 1
+            error_message = %(Table "#{table.name}" has #{primary_keys_count} primary keys)
+            errors << error_message
+          end
+
+          table.fields.each do |field|
+            if field.is_a?(Definitions::Field::Custom)
+              unless enums.map(&:name).include?(field.type_name)
+                error_message = %(Field "#{table.name}.#{field.name}" has unknown type "#{field.type_name}")
+                errors << error_message
+              end
+            end
+          end
+
+          field_names = table.fields.map(&:name)
+
+          table.indices.each do |index|
+            index.fields.map(&:name).each do |field_name|
+              unless field_names.include?(field_name)
+                error_message = %(Index "#{index.name}" refers to a missing field "#{table.name}.#{field_name}")
+                errors << error_message
+              end
+            end
+          end
+
+          table.foreign_keys.each do |fkey|
+            fkey.fields.each do |field_name|
+              unless field_names.include?(field_name)
+                error_message = %(Foreign key "#{fkey.name}" constrains a missing field "#{table.name}.#{field_name}")
+                errors << error_message
+              end
+            end
+
+            if referenced_table = schema.find { |table| table.name == fkey.table }
+              if fkey.references_primary_key?
+                unless referenced_table.fields.any?(&:primary_key?)
+                  error_message = %(Foreign key "#{fkey.name}" refers to primary key of table "#{fkey.table}" which does not have a primary key)
+                  errors << error_message
+                end
+              else
+                referenced_table_field_names = referenced_table.fields.map(&:name)
+
+                fkey.keys.each do |key|
+                  unless referenced_table_field_names.include?(key)
+                    error_message = %(Foreign key "#{fkey.name}" refers to a missing field "#{fkey.table}.#{key}")
+                    errors << error_message
+                  end
+                end
+              end
+            else
+              error_message = %(Foreign key "#{fkey.name}" refers to a missing table "#{fkey.table}")
+              errors << error_message
+            end
+          end
+        end
+
+        enum_errors = enums.each_with_object([]) do |enum, errors|
+          if enum.values.empty?
+            error_message = %(Enum "#{enum.name}" contains no values)
+            errors << error_message
+          end
+        end
+
+        Result.new(table_errors + enum_errors)
+      end
+    end
+
+    class Result
+      attr_reader :errors
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def valid?
+        errors.empty?
+      end
+    end
+  end
+end

data/lib/db_schema/version.rb

@@ -0,0 +1,3 @@
+module DbSchema
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: db_schema
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vsevolod Romashov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-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: terminal-notifier
+  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: terminal-notifier-guard
+  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: pg
+  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: A database schema management tool that reads a "single-source-of-truth"
+  schema definition from a ruby file and auto-migrates the database to conform to
+  it.
+email:
+- 7@7vn.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db_schema.gemspec
+- lib/db_schema.rb
+- lib/db_schema/awesome_print.rb
+- lib/db_schema/changes.rb
+- lib/db_schema/configuration.rb
+- lib/db_schema/definitions.rb
+- lib/db_schema/definitions/field.rb
+- lib/db_schema/definitions/field/array.rb
+- lib/db_schema/definitions/field/base.rb
+- lib/db_schema/definitions/field/binary.rb
+- lib/db_schema/definitions/field/bit_string.rb
+- lib/db_schema/definitions/field/boolean.rb
+- lib/db_schema/definitions/field/character.rb
+- lib/db_schema/definitions/field/custom.rb
+- lib/db_schema/definitions/field/datetime.rb
+- lib/db_schema/definitions/field/geometric.rb
+- lib/db_schema/definitions/field/json.rb
+- lib/db_schema/definitions/field/monetary.rb
+- lib/db_schema/definitions/field/network.rb
+- lib/db_schema/definitions/field/numeric.rb
+- lib/db_schema/definitions/field/range.rb
+- lib/db_schema/definitions/field/text_search.rb
+- lib/db_schema/definitions/field/uuid.rb
+- lib/db_schema/dsl.rb
+- lib/db_schema/reader.rb
+- lib/db_schema/runner.rb
+- lib/db_schema/utils.rb
+- lib/db_schema/validator.rb
+- lib/db_schema/version.rb
+homepage: https://github.com/7even/db_schema
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Declarative database schema definition.
+test_files: []