mysql-inspector 0.0.1 → 0.0.2

data/README

@@ -12,7 +12,7 @@ master, which adds a new column metal_grade.
 
 Start by storing the new state of your database.
 
-% mysql-inspector --target zippers_development --write
+% mysql-inspector --target --write zippers_development
 
 This command says "store the state of the zippers_development database as my
 target version".
@@ -20,7 +20,7 @@ target version".
 Now, go back to your master branch and load its database into
 zippers_development, then dump the contents.
 
-% mysql-inspector --current zippers_development --write
+% mysql-inspector --current --write zippers_development
 
 Now, in order to write database migrations for master to smoother let's see
 what changes occurred.
@@ -35,11 +35,11 @@ information is right here.
 
 mysql% alter table zippers add column metal_grade int(11) NOT NULL DEFAULT '0';
 
-Now we can compare the two again. This time we need to add the --force argument
-to say that it's ok to overwrite the previous dump.
+Now we can compare the two again. This time we need to add the --force
+argument to say that it's ok to overwrite the previous dump. We'll also go
+ahead and run the diff.
 
-% mysql-inspector --current zippers_development --write --force
-% mysql-inspector --diff
+% mysql-inspector --current --write zippers_development --force --diff
 
 No differences!
 

data/Rakefile

@@ -6,6 +6,7 @@ begin
     gemspec.email = "ryan@fivesevensix.com"
     gemspec.homepage = "http://github.com/rcarver/mysql-inspector"
     gemspec.authors = ["Ryan Carver"]
+    gemspec.executables = ["mysql-inspector"]
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/mysql-inspector

@@ -4,73 +4,86 @@ require 'optparse'
 require "lib/mysql-inspector"
 
 options = {
-  :databases => [],
   :versions => [],
   :base_dir => ".",
   :diff => false,
   :grep => false,
-  :dump => false,
+  :write => false,
   :clean => false
 }
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: ????"
+  opts.banner = "Usage: #{File.basename $0} [options]"
 
-  opts.on("-c", "--current [db]") do |db_name|
+  opts.on("-c", "--current", "Perform the given action(s) with the current version.") do
     options[:versions] << "current"
-    options[:databases] << db_name
   end
 
-  opts.on("-t", "--target [db]") do |db_name|
+  opts.on("-t", "--target", "Perform the given action(s) with the target version.") do
     options[:versions] << "target"
-    options[:databases] << db_name
   end
 
-  opts.on("-w", "--write") do |yes|
-    options[:dump] = true
+  opts.on("-w", "--write DB", "Store a schema for the database") do |db_name|
+    options[:write] = db_name
   end
 
-  opts.on("-f", "--force") do |ok|
+  opts.on("-f", "--force", "Overwrite a previously stored schema") do |ok|
     options[:clean] = true
   end
 
-  opts.on("-g", "--grep foo_id,bar_id") do |columns|
+  opts.on("-d", "--diff", "Output a comparison between the current and target schemas") do |info|
+    options[:diff] = true
+  end
+
+  opts.on("-g", "--grep foo_id,bar_id", "Find columns and/or indices matching the pattern") do |columns|
     options[:grep] = columns.split(",").collect { |c| c.strip }
   end
 
-  opts.on("-d", "--diff") do |info|
-    options[:diff] = true
+  opts.on("-h", "--help", "What you're looking at") do
+    puts opts
   end
 
-end.parse!
+  puts opts if ARGV.empty?
 
-options[:versions].compact!
-options[:databases].compact!
+end.parse!
 
-options[:versions].collect! do |version|
-  MysqlInspector::Dump.new(version, options[:base_dir])
+def how_to_write_version(input)
+  "#{File.basename $0} --#{input.version} --write DB_NAME"
 end
 
-if options[:clean]
-  options[:versions].each { |v| v.clean! }
-end
+begin
 
-if options[:dump]
-  raise "Missing database names" unless options[:versions].size == options[:databases].size
-  options[:versions].zip(options[:databases]).each do |v, d|
-    v.dump!(d)
+  options[:versions].collect! do |version|
+    MysqlInspector::Dump.new(version, options[:base_dir])
   end
-end
 
-if options[:grep]
-  options[:versions].each do |v|
-    grep = MysqlInspector::Grep.new(v)
-    grep.find(STDOUT, *options[:grep])
+  if options[:clean]
+    options[:versions].each { |v| v.clean! }
+  end
+
+  if options[:write]
+    raise MysqlInspector::Precondition, "Please specify which version to write" if options[:versions].size == 0
+    raise MysqlInspector::Precondition, "I can only write one version at a time" unless options[:versions].size == 1
+    version = options[:versions].first
+    version.dump!(options[:write])
+  end
+
+  if options[:grep]
+    options[:versions].each do |v|
+      grep = MysqlInspector::Grep.new(v)
+      grep.find(STDOUT, *options[:grep])
+    end
+  end
+
+  if options[:diff]
+    inputs = ["current", "target"].collect { |version| MysqlInspector::Dump.new(version, options[:base_dir]) }
+    inputs.each do |input|
+      raise MysqlInspector::Precondition, "No #{input.version} version exists. Write one with `#{how_to_write_version(input)}`" unless input.exists?
+    end
+    comparison = MysqlInspector::Comparison.new(*inputs)
+    comparison.compare(STDOUT)
   end
-end
 
-if options[:diff]
-  inputs = ["current", "target"].collect { |version| MysqlInspector::Dump.new(version, options[:base_dir]) }
-  comparison = MysqlInspector::Comparison.new(*inputs)
-  comparison.compare(STDOUT)
+rescue MysqlInspector::Precondition => e
+  puts "#{e.message}."
 end

data/lib/mysql-inspector.rb

@@ -2,6 +2,8 @@ require "fileutils"
 
 module MysqlInspector
 
+  Precondition = Class.new(StandardError)
+
   module Config
     extend self
 
@@ -17,7 +19,7 @@ module MysqlInspector
     def mysqldump_path
       @mysqldump_path ||= begin
         path = `which mysqldump`.chomp
-        raise "mysqldump was not in your path" if path.empty?
+        raise Precondition, "mysqldump was not in your path" if path.empty?
         path
       end
     end
@@ -57,8 +59,12 @@ module MysqlInspector
       FileUtils.rm_rf(dir)
     end
 
+    def exists?
+      File.exist?(dir)
+    end
+
     def dump!(db_name)
-      raise "Destination exists! (#{dir.inspect})" if File.exist?(dir)
+      raise Precondition, "Can't overwrite an existing schema at #{dir.inspect}" if exists?
       @db_name = db_name
       FileUtils.mkdir_p(dir)
       Config.mysqldump("--no-data", "-T #{dir}", "--skip-opt", db_name).run!
@@ -72,7 +78,7 @@ module MysqlInspector
     end
 
     def read_db_name
-      raise "No dump exists at #{dir.inspect}" unless File.exist?(info_file)
+      raise Precondition, "No dump exists at #{dir.inspect}" unless File.exist?(info_file)
       File.read(info_file).strip
     end
   end

data/mysql-inspector.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mysql-inspector}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Carver"]
-  s.date = %q{2010-03-03}
+  s.date = %q{2010-03-05}
   s.default_executable = %q{mysql-inspector}
   s.email = %q{ryan@fivesevensix.com}
   s.executables = ["mysql-inspector"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ryan Carver
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-03 00:00:00 -08:00
+date: 2010-03-05 00:00:00 -08:00
 default_executable: mysql-inspector
 dependencies: []