mysql-inspector 0.0.6 → 0.1.0

data/lib/mysql_inspector/table.rb

@@ -0,0 +1,147 @@
+module MysqlInspector
+  class Table
+
+    BACKTICK_WORD = /`([^`]+)`/
+    BACKTICK_CSV = /\(([^\)]+)\)/
+    REFERENCE_OPTION = /RESTRICT|CASCADE|SET NULL|NO ACTION/
+
+    def initialize(schema)
+      @schema = schema
+      @lines = schema.split("\n")
+      @lines.delete_if { |line| line =~ /(\/\*|--)/ or line.strip.empty? }
+    end
+
+    # Public: Get then name of the table.
+    #
+    # Returns a String.
+    def table_name
+      @table_name ||= begin
+        line = @lines.find { |line| line =~ /CREATE TABLE #{BACKTICK_WORD}/}
+        $1 if line
+      end
+    end
+
+    # Public: Get all of the columns defined in the table.
+    #
+    # Returns an Array of MysqlInspector::Column.
+    def columns
+      @columns ||= @lines.map { |line|
+        if line.strip =~ /^#{BACKTICK_WORD} ([\w\(\)\d]+)/
+          name = $1
+          sql_type = $2
+          nullable = !!(line !~ /NOT NULL/)
+          default = line[/DEFAULT ('?[^']+'?)/, 1]
+          default = nil if default =~ /NULL/
+          auto_increment = !!(line =~ /AUTO_INCREMENT/)
+          table_part line, MysqlInspector::Column.new(name, sql_type, nullable, default, auto_increment)
+        end
+      }.compact.sort
+    end
+
+    # Public: Get all of the indices defined in the table
+    #
+    # Returns an Array of MysqlInspector::Index.
+    def indices
+      @indices ||= @lines.map { |line|
+        if line.strip =~ /^(UNIQUE )?KEY #{BACKTICK_WORD} #{BACKTICK_CSV}/
+          unique = !!$1
+          name = $2
+          column_names = backtick_names_in_csv($3)
+          table_part line, MysqlInspector::Index.new(name, column_names, unique)
+        elsif line.strip =~ /^PRIMARY KEY #{BACKTICK_CSV}/
+          unique = true
+          name = "PRIMARY KEY"
+          column_names = backtick_names_in_csv($1)
+          table_part line, MysqlInspector::Index.new(name, column_names, unique)
+        end
+      }.compact.sort
+    end
+
+    # Public: Get all of the constraints defined in the table
+    #
+    # Returns an Array of MysqlInspector::Constraint.
+    def constraints
+      @constraints ||= @lines.map { |line|
+        if line.strip =~ /^CONSTRAINT #{BACKTICK_WORD} FOREIGN KEY #{BACKTICK_CSV} REFERENCES #{BACKTICK_WORD} #{BACKTICK_CSV} ON DELETE (#{REFERENCE_OPTION}) ON UPDATE (#{REFERENCE_OPTION})$/
+          name = $1
+          column_names = backtick_names_in_csv($2)
+          foreign_name = $3
+          foreign_column_names = backtick_names_in_csv($4)
+          on_delete = $5
+          on_update = $6
+          table_part line, MysqlInspector::Constraint.new(name, column_names, foreign_name, foreign_column_names, on_update, on_delete)
+        end
+      }.compact.sort
+    end
+
+    def options
+      @options ||= begin
+        if line = @lines.find { |line| line =~ /ENGINE=/}
+          # AUTO_INCREMENT is not useful.
+          line.sub!(/AUTO_INCREMENT=\d+/, '')
+          # Compact multiple spaces.
+          line.gsub!(/\s+/, ' ')
+          # Remove paren at the beginning.
+          line.sub!(/^\)\s*/, '')
+          # Remove semicolon at the end.
+          line.chomp!(';')
+          line
+        end
+      end
+    end
+
+    def eql?(other)
+      table_name == other.table_name &&
+          columns == other.columns &&
+          indices == other.indices &&
+          constraints == other.constraints &&
+          options = other.options
+    end
+
+    alias == eql?
+
+    def <=>(other)
+      table_name <=> other.table_name
+    end
+
+    def to_simple_schema
+      lines = []
+
+      lines << "CREATE TABLE `#{table_name}`"
+      lines << nil
+      simple_schema_items(lines, columns)
+      simple_schema_items(lines, indices)
+      simple_schema_items(lines, constraints)
+      lines << options
+
+      lines.join("\n")
+    end
+
+    def to_sql
+      lines = []
+
+      lines << "CREATE TABLE `#{table_name}` ("
+      lines << (columns + indices + constraints).map { |x| "  #{x.to_sql}" }.join(",\n")
+      lines << ") #{options}"
+
+      lines.join("\n")
+    end
+
+  protected
+
+    def simple_schema_items(lines, items)
+      lines.concat items.map { |item| item.to_sql }
+      lines << nil if items.any?
+    end
+
+    def table_part(line, part)
+      part.table = self
+      part
+    end
+
+    def backtick_names_in_csv(string)
+      string.split(',').map { |x| x[BACKTICK_WORD, 1] }
+    end
+
+  end
+end

data/lib/mysql_inspector/table_part.rb

@@ -0,0 +1,21 @@
+module MysqlInspector
+  module TablePart
+
+    attr_accessor :table
+
+    def <=>(other)
+      name <=> other.name
+    end
+
+  protected
+
+    def quote(word)
+      "`#{word}`"
+    end
+
+    def paren(words)
+      "(#{words * ","})"
+    end
+
+  end
+end

data/lib/mysql_inspector/version.rb

@@ -0,0 +1,3 @@
+module MysqlInspector
+  VERSION = "0.1.0"
+end

data/mysql-inspector.gemspec

@@ -1,44 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mysql_inspector/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{mysql-inspector}
-  s.version = "0.0.6"
+  s.name        = "mysql-inspector"
+  s.version     = MysqlInspector::VERSION
+  s.authors     = ["Ryan Carver"]
+  s.email       = ["ryan@ryancarver.com"]
+  s.homepage    = ""
+  s.summary     = %q{Store and understand your MySQL schema}
+  s.description = %q{Store and understand your MySQL schema}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ryan Carver"]
-  s.date = %q{2010-03-23}
-  s.default_executable = %q{mysql-inspector}
-  s.email = %q{ryan@fivesevensix.com}
-  s.executables = ["mysql-inspector"]
-  s.extra_rdoc_files = [
-    "README"
-  ]
-  s.files = [
-    ".gitignore",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "bin/mysql-inspector",
-     "lib/mysql-inspector.rb",
-     "mysql-inspector.gemspec"
-  ]
-  s.homepage = %q{http://github.com/rcarver/mysql-inspector}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rubyforge_project = "mysql-inspector"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Tools for identifying changes to a MySQL schema}
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  # s.add_runtime_dependency "rest-client"
 end
-

data/test/fixtures/migrate/111_create_users.rb

@@ -0,0 +1,7 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table(:users) do |t|
+      t.string :name
+    end
+  end
+end

data/test/fixtures/migrate/222_create_things.rb

@@ -0,0 +1,9 @@
+class CreateThings < ActiveRecord::Migration
+  def change
+    create_table(:things) do |t|
+      t.references :user
+      t.string :name
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,125 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'open3'
+require 'ostruct'
+require 'stringio'
+
+require 'mysql_inspector'
+
+require 'helpers/mysql_utils'
+require 'helpers/mysql_schemas'
+require 'helpers/string_unindented'
+
+class MysqlInspectorSpec < MiniTest::Spec
+  include MysqlSchemas
+
+  def it msg
+    raise "A block must not be passed to the example-level +it+" if block_given?
+    @__current_msg = "it #{msg}"
+  end
+
+  def message msg = nil, ending = ".", &default
+    super(msg || @__current_msg, ending, &default)
+  end
+
+  register_spec_type(self) { |desc| true }
+
+  # Create a temporary directory. This directory will exist for the life of
+  # the spec.
+  #
+  # id - Identifier of the tmpdir (default: the default identifier).
+  #
+  # Returns a String.
+  def tmpdir(id=:default)
+    @tmpdirs[id] ||= Dir.mktmpdir
+  end
+
+  # Get the name of the test database.
+  #
+  # Returns a String.
+  def database_name
+    "mysql_inspector_test"
+  end
+
+  # Create a test mysql database. The database will exist for the life
+  # of the spec.
+  #
+  # schema - String schema to create (default: no schema).
+  #
+  # Returns nothing.
+  def create_mysql_database(schema="")
+    @mysql_database = true
+    MysqlUtils.create_mysql_database(database_name, schema)
+  end
+
+  # Drop the test mysql database.
+  #
+  # Returns nothing.
+  def drop_mysql_database
+    MysqlUtils.drop_mysql_database(database_name)
+  end
+
+  # Get access to the mysql database.
+  #
+  # Returns a MysqlInspector:Access.
+  def access
+    (@access ||= {})[database_name] ||= MysqlInspector::Access.new(database_name, "root", nil, "mysql")
+  end
+
+  let(:config) { MysqlInspector::Config.new }
+
+  before do
+    @tmpdirs = {}
+    @mysql_database = nil
+  end
+
+  after do
+    @tmpdirs.values.each { |dir| FileUtils.rm_rf dir }
+    drop_mysql_database if @mysql_database
+  end
+end
+
+class MysqlInspectorCliSpec < MysqlInspectorSpec
+
+  register_spec_type(self) { |desc| desc =~ /mysql-inspector/ }
+
+  before do
+    config.dir = tmpdir
+  end
+
+  def parse_command(klass, argv)
+    command = klass.new(config, StringIO.new, StringIO.new)
+    command.parse!(argv)
+    command
+  end
+
+  def run_command(klass, argv)
+    command = klass.new(config, StringIO.new, StringIO.new)
+    command.parse!(argv)
+    command.run!
+    command
+  end
+
+  def mysql_inspector(args)
+    cli = MysqlInspector::CLI.new(config, StringIO.new, StringIO.new)
+    argv = args.split(/\s+/).map { |x| x.gsub(/'/, '') }
+    cli.run!(argv)
+    cli
+  end
+
+  def inspect_database(args)
+    mysql_inspector args
+  end
+
+  def stdout
+    subject.stdout.string.chomp
+  end
+
+  def stderr
+    subject.stderr.string.chomp
+  end
+
+  def status
+    subject.status
+  end
+end

data/test/helper_ar.rb

@@ -0,0 +1,37 @@
+require 'active_record'
+require 'mysql2'
+require 'helper'
+
+class MysqlInspectorActiveRecordSpec < MysqlInspectorSpec
+
+  register_spec_type(self) { |desc| desc =~ /activerecord/ }
+
+  before do
+    unless ActiveRecord::Base.connected?
+      ActiveRecord::Base.establish_connection(
+        :adapter => :mysql2,
+        :database => database_name,
+        :username => "root",
+        :password => nil
+      )
+    end
+    create_mysql_database
+    config.migrations = true
+  end
+
+  # Execute all of the fixture migrations.
+  #
+  # Returns nothing.
+  def run_active_record_migrations!
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Migrator.migrate(["test/fixtures/migrate"])
+  end
+
+  # Get access to the mysql database.
+  #
+  # Returns a MysqlInspector:AR::Access.
+  def access
+    MysqlInspector::AR::Access.new(ActiveRecord::Base.connection)
+  end
+
+end

data/test/helpers/mysql_schemas.rb

@@ -0,0 +1,82 @@
+require 'helpers/string_unindented'
+
+# Sample table schemas used for testing.
+module MysqlSchemas
+
+  # A sample starting database.
+  def schema_a
+    [ideas_schema, colors_schema, things_schema_1].join(";\n")
+  end
+
+  # A sample changed database.
+  def schema_b
+    [users_schema, ideas_schema, things_schema_2].join(";\n")
+  end
+
+  def colors_schema
+    <<-STR.unindented
+      CREATE TABLE `colors` (
+        `name` varchar(255) NOT NULL,
+        UNIQUE KEY `colors_primary` (`name`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    STR
+  end
+
+  def ideas_schema
+    <<-STR.unindented
+      CREATE TABLE `ideas` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `name` varchar(255) NOT NULL,
+        `description` text NOT NULL,
+        PRIMARY KEY (`id`),
+        KEY `name` (`name`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    STR
+  end
+
+  def users_schema
+    <<-STR.unindented
+      CREATE TABLE `users` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `first_name` varchar(255) NOT NULL,
+        `last_name` varchar(255) NOT NULL,
+        UNIQUE KEY `users_primary` (`id`),
+        KEY `name` (`first_name`,`last_name`)
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    STR
+  end
+
+  def things_schema_1
+    <<-STR.unindented
+      CREATE TABLE `things` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `name` varchar(255) NOT NULL DEFAULT 'toy',
+        `weight` int(11) DEFAULT NULL,
+        `color` varchar(255) NOT NULL,
+        UNIQUE KEY `things_primary` (`id`),
+        KEY `color` (`color`),
+        CONSTRAINT `belongs_to_color` FOREIGN KEY (`color`) REFERENCES `colors` (`name`) ON DELETE NO ACTION ON UPDATE CASCADE
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    STR
+  end
+
+  def things_schema_2
+    <<-STR.unindented
+      CREATE TABLE `things` (
+        `id` int(11) NOT NULL AUTO_INCREMENT,
+        `name` varchar(255) NOT NULL DEFAULT 'toy',
+        `weight` int(11) DEFAULT NULL,
+        `first_name` varchar(255) NOT NULL,
+        `last_name` varchar(255) NOT NULL,
+        UNIQUE KEY `things_primary` (`id`),
+        KEY `name` (`first_name`,`last_name`),
+        CONSTRAINT `belongs_to_user` FOREIGN KEY (`first_name`, `last_name`) REFERENCES `users` (`first_name`, `last_name`) ON DELETE NO ACTION ON UPDATE CASCADE
+      ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+    STR
+  end
+
+  def things_schema
+    things_schema_2
+  end
+end
+