scheman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c96927177dfbde154defcf9c902c953c60a580a
+  data.tar.gz: 51e98f13cdf9ea43eec4a515be4b883ab855b880
+SHA512:
+  metadata.gz: 09fb8220340760be61f9a6ad057313604657dc4425fb97bc0ac10bf41c05295e7800da6a2ae0bfb8857dc407393a3edd5c6892b5af81ffb783a8c69acdf14ffe
+  data.tar.gz: a1a90f9957eec8d37e83a367d5d3417016a1032143702c3e6c26834cbf3b678797f289b855c757faf05d0fc14923a986ff6606ea7c5b262454e7e686faee5d3b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+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,56 @@
+# Scheman
+Manage database schema based on schema definition file.
+
+## Usage
+Creates Diff with 2 schema files and logs out their diff.
+
+```ruby
+before = <<-SQL
+CREATE TABLE `table1` (
+  `column1` INTEGER NOT NULL AUTO INCREMENT,
+  PRIMARY KEY (`column1`)
+);
+
+CREATE TABLE `table2` (
+  `column1` INTEGER NOT NULL AUTO INCREMENT,
+  PRIMARY KEY (`column1`)
+);
+SQL
+
+after = <<-SQL
+CREATE TABLE `table1` (
+  `column2` VARCHAR(255) NOT NULL,
+  PRIMARY KEY (`column1`)
+);
+
+CREATE TABLE `table3` (
+  `column1` INTEGER NOT NULL AUTO INCREMENT,
+  PRIMARY KEY (`column1`)
+);
+SQL
+
+puts Scheman::Diff.new(before: before, after: after, type: "mysql")
+```
+
+The result would be the following:
+
+```sql
+BEGIN;
+
+SET foreign_key_checks=0;
+
+CREATE TABLE `table3` (
+  `column1` INTEGER NOT NULL AUTO INCREMENT,
+  PRIMARY KEY (`column1`)
+);
+
+ALTER TABLE `table1` ADD COLUMN `column2` VARCHAR(255) NOT NULL;
+
+ALTER TABLE `table1` DROP COLUMN `column1`;
+
+DROP TABLE `table2`;
+
+SET foreign_key_checks=1;
+
+COMMIT;
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/scheman/diff.rb

@@ -0,0 +1,143 @@
+module Scheman
+  class Diff
+    # @param before [String] The previous schema
+    # @param after [String] The next schema
+    # @param type [String] The type of schema syntax, default types of the both schemata (e.g. "mysql")
+    # @param before_type [String] Specify the type of the previous schema if needed
+    # @param after_type [String] Specify the type of the next schema if needed
+    # @param output_type [String] Specify the type of the output schema if needed
+    # @raise [Scheman::Errors::ParserNotFound]
+    def initialize(before: nil, after: nil, type: nil, before_type: nil, after_type: nil, output_type: nil)
+      @before = before
+      @after = after
+      @type = type
+      @before_type = before_type
+      @after_type = after_type
+      @output_type = output_type
+      validate!
+    end
+
+    # @return [String] A string representation of this diff
+    def to_s
+      view_class.new(to_hash).to_s
+    end
+
+    # @note Passed to Parslet::Transform to convert into SQL string
+    # @return [Hash] A hash representation of this diff
+    def to_hash
+      {
+        alter_tables: alter_tables,
+        create_tables: create_tables,
+        drop_tables: drop_tables,
+      }
+    end
+
+    private
+
+    # TODO
+    # @return [Array<Hash>] ALTER TABLE statements we need to apply
+    def alter_tables
+      after_schema.tables.inject([]) do |result, after_table|
+        if before_table = before_schema.tables_indexed_by_name[after_table.name]
+          after_table.fields.each do |after_field|
+            unless before_table.fields_indexed_by_name[after_field.name]
+              result << {
+                add_field: after_field.to_hash.merge(table_name: after_table.name),
+              }
+            end
+          end
+
+          before_table.fields.each do |before_field|
+            unless after_table.fields_indexed_by_name[before_field.name]
+              result << {
+                drop_field: before_field.to_hash.merge(table_name: after_table.name),
+              }
+            end
+          end
+        end
+        result
+      end
+    end
+
+    # @return [Array<Hash>] DROP TABLE statements we need to apply
+    def drop_tables
+      table_names_to_drop.map do |name|
+        {
+          drop_table: {
+            name: name,
+          },
+        }
+      end
+    end
+
+    # @return [Array<Hash>] CREATE TABLE statements we need to apply
+    def create_tables
+      after_schema.create_tables.select do |statement|
+        table_names_to_create.include?(statement[:create_table][:name])
+      end
+    end
+
+    # @return [Array<String>]
+    def table_names_to_create
+      @table_names_to_create ||= after_schema.table_names - before_schema.table_names
+    end
+
+    # @return [Array<String>]
+    def table_names_to_drop
+      @table_names_to_drop ||= before_schema.table_names - after_schema.table_names
+    end
+
+    # @return [Scheman::Schema]
+    def before_schema
+      @before_schema ||= before_parser.parse(@before)
+    end
+
+    # @return [Scheman::Schema]
+    def after_schema
+      @after_schema ||= after_parser.parse(@after)
+    end
+
+    # @return [Scheman::Parsers::Base]
+    # @raise [Scheman::Errors::ParserNotFound]
+    def before_parser
+      @before_parser ||= ParserBuilder.build(before_type)
+    end
+
+    # @return [Scheman::Parsers::Base]
+    # @raise [Scheman::Errors::ParserNotFound]
+    def after_parser
+      @after_parser ||= ParserBuilder.build(after_type)
+    end
+
+    # @raise [Scheman::Errors::ParserNotFound]
+    def validate!
+      before_parser
+      after_parser
+    end
+
+    # @return [String]
+    def before_type
+      @before_type || @type
+    end
+
+    # @return [String]
+    def after_type
+      @after_type || @type
+    end
+
+    # @return [String]
+    def output_type
+      @output_type || @type
+    end
+
+    # @return [Class]
+    def view_class
+      case output_type
+      when "mysql"
+        Views::Mysql
+      else
+        raise Errors::ViewNotFound
+      end
+    end
+  end
+end

data/lib/scheman/errors.rb

@@ -0,0 +1,12 @@
+module Scheman
+  module Errors
+    class Base < StandardError
+    end
+
+    class ParserNotFound < Base
+    end
+
+    class ViewNotFound < Base
+    end
+  end
+end

data/lib/scheman/parser_builder.rb

@@ -0,0 +1,29 @@
+module Scheman
+  class ParserBuilder
+    # @param type [String] A type of parser (e.g. "mysql")
+    # @return [Scheman::Parsers::Base]
+    def self.build(type)
+      new(type).build
+    end
+
+    # @param type [String]
+    def initialize(type)
+      @type = type
+    end
+
+    def build
+      parser_class.new
+    end
+
+    private
+
+    def parser_class
+      case @type
+      when "mysql"
+        Parsers::Mysql
+      else
+        raise Errors::ParserNotFound
+      end
+    end
+  end
+end

data/lib/scheman/parsers/base.rb

@@ -0,0 +1,9 @@
+module Scheman
+  module Parsers
+    class Base
+      def initialize(options = {})
+        @options = options
+      end
+    end
+  end
+end