scheman 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a488256dda03bd9e7c75477ab532b805ba3491
-  data.tar.gz: c4f69982678f0427156d0d127f7fcdc0eaa9f5d6
+  metadata.gz: 456bdbc451ec84ddb6f377404e7654d2be2a9b8e
+  data.tar.gz: a3c758811636f4466abcc3fc82332931de0e8f69
 SHA512:
-  metadata.gz: 7c2b41f51bf2f871e20e045c4f4828f292cdf288e4c5f2c8f4697b7a34950d16f05c9529d2f72ba8808f2afca3c3949c5b4b92fa254c4ddb3fb9da2d68d5f9cf
-  data.tar.gz: 474496316452b1eb06fd78ff64cdd445dac31c75138d8beb9683c3b107cabfd4849d3a35052959575f51571e7138786c9b87d0ed228f62b24a29cd0c3b02e574
+  metadata.gz: 6da8d574d687da3d0394e4944032daecdc47eb15421412f1f26e798c7db22b6426a2cf3655549acf7ee8a21e712f6d0519349f5e8c0c337df6c2bb47d7d9e54d
+  data.tar.gz: 88bf79baf57946a03352ec156882243ed3cfb05753cce7660a70e60057ab3beb27d41c5503f2da1eb68512611a2a2bde26611fc6736370f96cd72826575143d9

data/CHANGELOG.md

@@ -1,10 +1,14 @@
+## 0.0.4
+* Add `schema diff` command
+* Improve MySQL parser logic
+
 ## 0.0.3
-* Support DEFAULT field qualifier
+* Support DEFAULT column qualifier
 
 ## 0.0.2
 * Support ADD INDEX
 * Support DROP INDEX
-* Detects altered column
+* Detect altered column
 
 ## 0.0.1
 * 1st Release

data/bin/scheman

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "scheman"
+
+Scheman::CommandBuilder.call(ARGV).call

data/lib/scheman.rb

@@ -5,7 +5,11 @@ require "active_support/core_ext/object/blank"
 require "active_support/core_ext/object/try"
 require "active_support/core_ext/string/indent"
 require "parslet"
+require "slop"
 
+require "scheman/command_builder"
+require "scheman/commands/base"
+require "scheman/commands/diff"
 require "scheman/diff"
 require "scheman/errors"
 require "scheman/parser_builder"

data/lib/scheman/command_builder.rb

@@ -0,0 +1,44 @@
+module Scheman
+  class CommandBuilder
+    def self.call(*args)
+      new(*args).call
+    end
+
+    # @param argv [Array] ARGV
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # @return [Scheman::Commands::Base]
+    def call
+      command_class.new(@argv)
+    rescue Errors::CommandNotFound
+      terminate
+    end
+
+    private
+
+    def command_class
+      case command_name
+      when "diff"
+        Commands::Diff
+      else
+        raise Errors::CommandNotFound
+      end
+    end
+
+    # @note You must pass a command name like "scheman diff"
+    def command_name
+      @argv[0]
+    end
+
+    def usage
+      "Usage: #{$0} <command> [options]"
+    end
+
+    def terminate
+      warn usage
+      exit(1)
+    end
+  end
+end

data/lib/scheman/commands/base.rb

@@ -0,0 +1,6 @@
+module Scheman
+  module Commands
+    class Base
+    end
+  end
+end

data/lib/scheman/commands/diff.rb

@@ -0,0 +1,103 @@
+module Scheman
+  module Commands
+    class Diff < Base
+      DEFAULT_AFTER_SCHEMA_PATH = "schema.sql"
+
+      DEFAULT_TYPE = "mysql"
+
+      # @param argv [Array] ARGV
+      def initialize(argv)
+        @argv = argv
+      end
+
+      # Outputs a schema diff
+      def call
+        print diff
+      end
+
+      private
+
+      def before
+        case
+        when has_input_from_stdin?
+          STDIN.read
+        when before_schema_path
+          File.read(before_schema_path)
+        else
+          raise Errors::NoBeforeSchema
+        end
+      end
+
+      def after
+        case
+        when after_schema_path
+          File.read(after_schema_path)
+        when has_default_schema_file?
+          default_schema
+        else
+          "CREATE DATABASE database_name;"
+        end
+      end
+
+      # @return [String]
+      # @example
+      #   "mysql"
+      def type
+        options[:type] || DEFAULT_TYPE
+      end
+
+      # @return [Schema::Diff]
+      def diff
+        @diff ||= Scheman::Diff.new(
+          before: before,
+          after: after,
+          type: type,
+        )
+      end
+
+      # @return [true, false] True if any input given via STDIN
+      def has_input_from_stdin?
+        has_pipe_input? || has_redirect_input?
+      end
+
+      # @return [true, false] True if any input given from redirection
+      def has_pipe_input?
+        File.pipe?(STDIN)
+      end
+
+      # @return [true, false] True if any input given from redirection
+      def has_redirect_input?
+        File.select([STDIN], [], [], 0) != nil
+      end
+
+      # @return [String, nil] Path to a previous schema
+      def before_schema_path
+        options[:before]
+      end
+
+      # @return [String, nil] Path to a next schema
+      def after_schema_path
+        options[:after]
+      end
+
+      # @return [String, nil] True if a schema file exists in the default schema file path
+      def has_default_schema_file?
+        File.exist?(DEFAULT_AFTER_SCHEMA_PATH)
+      end
+
+      # @return [String, nil]
+      def default_schema
+        File.read(DEFAULT_AFTER_SCHEMA_PATH)
+      end
+
+      def options
+        @options ||= Slop.parse!(@argv, help: true) do
+          banner "Usage: #{$0} diff [options]"
+          on "type=", "SQL type (e.g. mysql)"
+          on "before=", "Path to the previous schema file"
+          on "after=", "Path to the next schema file"
+        end
+      end
+    end
+  end
+end

data/lib/scheman/errors.rb

@@ -8,5 +8,11 @@ module Scheman
 
     class ViewNotFound < Base
     end
+
+    class CommandNotFound < Base
+    end
+
+    class NoBeforeSchema < Base
+    end
   end
 end

data/lib/scheman/parsers/mysql.rb

@@ -67,7 +67,7 @@ module Scheman
         root(:statements)
 
         rule(:statements) do
-          statement.repeat(1).as(:statements)
+          statement.repeat.as(:statements)
         end
 
         rule(:statement) do
@@ -80,7 +80,8 @@ module Scheman
           alter |
           insert |
           delimiter_statement |
-          empty_statement
+          empty_statement |
+          spaces
         end
 
         rule(:newline) do
@@ -91,6 +92,10 @@ module Scheman
           match('\s')
         end
 
+        rule(:space?) do
+          space.maybe
+        end
+
         rule(:spaces) do
           space.repeat(1)
         end
@@ -138,8 +143,17 @@ module Scheman
           delimiter >> spaces?
         end
 
+        rule(:word) do
+          match('\w').repeat(1)
+        end
+
         rule(:comment) do
-          (str("#") | str("--")) >> non(newline) >> newline >> spaces?
+          (
+            (str("#") | str("--")) >> non(newline) >> newline
+          ) | (
+            str("/") >> space? >> str("*") >>
+              ((str("*") >> space? >> str("/")).absent? >> any).repeat >> (str("*") >> space? >> str("/"))
+          )
         end
 
         rule(:use) do
@@ -172,7 +186,26 @@ module Scheman
 
         rule(:create_table) do
           create_table_beginning >> spaces >> table_name >>
-            spaces? >> table_components >> eol
+            spaces? >> table_components >> (spaces? >> create_table_options >> spaces?).maybe >> eol
+        end
+
+        rule(:create_table_options) do
+          (comment_table_option | charset_table_option | other_table_option) >>
+            (spaces >> (comment_table_option | charset_table_option | other_table_option)).repeat
+        end
+
+        rule(:comment_table_option) do
+          case_insensitive_str("comment") >> spaces? >> str("=") >> spaces? >> single_quoted(match("[^']").repeat(1))
+        end
+
+        rule(:charset_table_option) do
+          case_insensitive_str("default ").maybe >>
+            (case_insensitive_str("charset") | case_insensitive_str("character set")) >>
+            spaces? >> str("=") >> spaces? >> word
+        end
+
+        rule(:other_table_option) do
+          word >> spaces? >> str("=") >> spaces? >> (word | single_quoted(word) | double_quoted(word))
         end
 
         rule(:table_components) do
@@ -336,11 +369,11 @@ module Scheman
         end
 
         rule(:auto_increment_qualifier) do
-          case_insensitive_str("auto increment").as(:auto_increment_qualifier)
+          case_insensitive_str("auto_increment").as(:auto_increment_qualifier)
         end
 
         rule(:field_comment) do
-          case_insensitive_str("comment") >> spaces >> single_quoted(match("[^']"))
+          case_insensitive_str("comment") >> spaces >> single_quoted(match("[^']").repeat(1))
         end
 
         rule(:on_update) do

data/lib/scheman/schema.rb

@@ -45,7 +45,7 @@ module Scheman
       # @return [Array<Field>]
       def fields
         @table[:fields].map do |field|
-          Field.new(field: field[:field], table: self)
+          Field.new(field[:field])
         end
       end
 
@@ -74,9 +74,8 @@ module Scheman
     end
 
     class Field
-      def initialize(field: nil, table: nil)
+      def initialize(field)
         @field = field
-        @table = table
       end
 
       # @note Overridden

data/lib/scheman/version.rb

@@ -1,3 +1,3 @@
 module Scheman
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/scheman/views/mysql.rb

@@ -19,13 +19,17 @@ module Scheman
 
       class Transform < Parslet::Transform
         rule(root: subtree(:root)) do
-          [
-            "BEGIN;",
-            "SET foreign_key_checks=0;",
-            root,
-            "SET foreign_key_checks=1;",
-            "COMMIT;",
-          ].join("\n\n") + "\n"
+          if root.to_s.present?
+            [
+              "BEGIN;",
+              "SET foreign_key_checks=0;",
+              root,
+              "SET foreign_key_checks=1;",
+              "COMMIT;",
+            ].join("\n\n") + "\n"
+          else
+            ""
+          end
         end
 
         rule(
@@ -296,7 +300,12 @@ module Scheman
         # @example
         #   "NOT NULL"
         def type
-          @element[:type].upcase.gsub("_", " ")
+          case @element[:type]
+          when "auto_increment"
+            @element[:type].upcase
+          else
+            @element[:type].upcase.gsub("_", " ")
+          end
         end
 
         # @example

data/scheman.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "parslet"
+  spec.add_dependency "slop"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"

data/spec/fixtures/example1.sql

@@ -0,0 +1,9 @@
+CREATE TABLE `table1` (
+  `column1` INTEGER(11) PRIMARY KEY NOT NULL AUTO INCREMENT,
+  `column2` DATETIME DEFAULT NOW()
+);
+
+CREATE TABLE `table2` (
+  `column1` INTEGER(11) NOT NULL AUTO INCREMENT,
+  PRIMARY KEY (`column1`)
+);

data/spec/scheman/diff_spec.rb

@@ -20,12 +20,12 @@ describe Scheman::Diff do
   let(:before_schema) do
     <<-EOS.strip_heredoc
       CREATE TABLE `table1` (
-        `column1` INTEGER(11) PRIMARY KEY NOT NULL AUTO INCREMENT,
+        `column1` INTEGER(11) PRIMARY KEY NOT NULL AUTO_INCREMENT,
         `column2` DATETIME DEFAULT NOW()
       );
 
       CREATE TABLE `table2` (
-        `column1` INTEGER(11) NOT NULL AUTO INCREMENT,
+        `column1` INTEGER(11) NOT NULL AUTO_INCREMENT,
         PRIMARY KEY (`column1`)
       );
     EOS
@@ -34,14 +34,14 @@ describe Scheman::Diff do
   let(:after_schema) do
     <<-EOS.strip_heredoc
       CREATE TABLE `table1` (
-        `column1` CHAR(11) NOT NULL AUTO INCREMENT,
+        `column1` CHAR(11) NOT NULL AUTO_INCREMENT,
         `column2` DATETIME DEFAULT CURRENT_TIMESTAMP(),
         `column3` VARCHAR(255) NOT NULL DEFAULT "a",
         PRIMARY KEY (`column2`)
       );
 
       CREATE TABLE `table3` (
-        `column1` INTEGER(11) NOT NULL AUTO INCREMENT,
+        `column1` INTEGER(11) NOT NULL AUTO_INCREMENT,
         PRIMARY KEY (`column1`)
       );
     EOS
@@ -59,12 +59,12 @@ describe Scheman::Diff do
         SET foreign_key_checks=0;
 
         CREATE TABLE `table3` (
-          `column1` INTEGER(11) NOT NULL AUTO INCREMENT,
+          `column1` INTEGER(11) NOT NULL AUTO_INCREMENT,
           PRIMARY KEY (`column1`)
         );
 
         ALTER TABLE `table1` ADD COLUMN `column3` VARCHAR(255) NOT NULL DEFAULT "a",
-          CHANGE COLUMN `column1` CHAR(11) NOT NULL AUTO INCREMENT,
+          CHANGE COLUMN `column1` CHAR(11) NOT NULL AUTO_INCREMENT,
           DROP PRIMARY KEY,
           ADD PRIMARY KEY `column2`;
 

data/spec/scheman/parsers/mysql_spec.rb

@@ -29,7 +29,7 @@ describe Scheman::Parsers::Mysql do
           CREATE DATABASE database_name;
 
           CREATE TABLE `table1` (
-            `column1` INTEGER(11) NOT NULL AUTO INCREMENT,
+            `column1` INTEGER(11) NOT NULL AUTO_INCREMENT,
             `column2` VARCHAR(255) NOT NULL,
             PRIMARY KEY (`column1`)
           );
@@ -141,9 +141,9 @@ describe Scheman::Parsers::Mysql do
       end
     end
 
-    context "with AUTO INCREMENT field qualifier" do
+    context "with AUTO_INCREMENT field qualifier" do
       let(:str) do
-        "CREATE TABLE `table1` (`column1` INTEGER AUTO INCREMENT);"
+        "CREATE TABLE `table1` (`column1` INTEGER AUTO_INCREMENT);"
       end
 
       it "succeeds in parse" do
@@ -494,5 +494,65 @@ describe Scheman::Parsers::Mysql do
         }
       end
     end
+
+    context "with empty string" do
+      let(:str) do
+        ""
+      end
+
+      it "succeeds in parse" do
+        should == []
+      end
+    end
+
+    context "with multi-line comment" do
+      let(:str) do
+        "/ * xy * /"
+      end
+
+      it "succeeds in parse" do
+        should == []
+      end
+    end
+
+    context "with comment table option" do
+      let(:str) do
+        "CREATE TABLE `table1` (`column1` INTEGER) COMMENT='test';"
+      end
+
+      it "succeeds in parse" do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    context "with charset table option" do
+      let(:str) do
+        "CREATE TABLE `table1` (`column1` INTEGER) DEFAULT CHARSET=latin1;"
+      end
+
+      it "succeeds in parse" do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    context "with another charset table option" do
+      let(:str) do
+        "CREATE TABLE `table1` (`column1` INTEGER) CHARACTER SET=latin1;"
+      end
+
+      it "succeeds in parse" do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    context "with engine table option" do
+      let(:str) do
+        "CREATE TABLE `table1` (`column1` INTEGER) ENGINE=MyISAM AUTO_INCREMENT=1;"
+      end
+
+      it "succeeds in parse" do
+        expect { subject }.not_to raise_error
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheman
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,8 @@ dependencies:
 description: 
 email:
 - r7kamura@gmail.com
-executables: []
+executables:
+- scheman
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,7 +122,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/scheman
 - lib/scheman.rb
+- lib/scheman/command_builder.rb
+- lib/scheman/commands/base.rb
+- lib/scheman/commands/diff.rb
 - lib/scheman/diff.rb
 - lib/scheman/errors.rb
 - lib/scheman/parser_builder.rb
@@ -118,6 +137,7 @@ files:
 - lib/scheman/views/base.rb
 - lib/scheman/views/mysql.rb
 - scheman.gemspec
+- spec/fixtures/example1.sql
 - spec/scheman/diff_spec.rb
 - spec/scheman/parsers/mysql_spec.rb
 - spec/spec_helper.rb
@@ -146,6 +166,7 @@ signing_key:
 specification_version: 4
 summary: SQL schema parser.
 test_files:
+- spec/fixtures/example1.sql
 - spec/scheman/diff_spec.rb
 - spec/scheman/parsers/mysql_spec.rb
 - spec/spec_helper.rb