lhm 1.2.0 → 1.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.3.0 (May 28, 2013)
+
+* Add Lhm.cleanup method for removing copy tables, thanks @bogdan
+* Limit copy table names to 64 characters, thanks @charliesome
+
 # 1.2.0 (February 22, 2013)
 
 * Added DataMapper support, no API changes for current users. Refer to the

data/README.md

@@ -52,6 +52,11 @@ ActiveRecord 2.3.x and 3.x (mysql and mysql2 adapters), as well as DataMapper
 Lhm also works with dm-master-slave-adapter, it'll bind to the master before
 running the migrations.
 
+## Limitations
+
+Lhm requires a monotonically increasing numeric Primary Key on the table, due to how
+the Chunker works.
+
 ## Installation
 
 Install it via `gem install lhm` or add `gem "lhm"` to your Gemfile.

data/lib/lhm.rb

@@ -34,8 +34,6 @@ module Lhm
   # @return [Boolean] Returns true if the migration finishes
   # @raise [Error] Raises Lhm::Error in case of a error and aborts the migration
   def self.change_table(table_name, options = {}, &block)
-    connection = Connection.new(adapter)
-
     origin = Table.parse(table_name, connection)
     invoker = Invoker.new(origin, connection)
     block.call(invoker.migrator)
@@ -44,6 +42,23 @@ module Lhm
     true
   end
 
+  def self.cleanup(run = false)
+    lhm_tables = connection.select_values("show tables").select do |name|
+      name =~ /^lhm(a|n)_/
+    end
+    return true if lhm_tables.empty?
+    if run
+      lhm_tables.each do |table|
+        connection.execute("drop table #{table}")
+      end
+      true
+    else
+      puts "Existing LHM backup tables: #{lhm_tables.join(", ")}."
+      puts "Run Lhm.cleanup(true) to drop them all."
+      false
+    end
+  end
+
   def self.setup(adapter)
     @@adapter = adapter
   end
@@ -55,4 +70,10 @@ module Lhm
         ActiveRecord::Base.connection
       end
   end
+
+  protected
+  def self.connection
+    Connection.new(adapter)
+  end
+
 end

data/lib/lhm/connection.rb

@@ -28,7 +28,7 @@ module Lhm
 
       def show_create(table_name)
         sql = "show create table `#{ table_name }`"
-        select_values(sql).last
+        select_one(sql).values.last
       end
 
       def current_database
@@ -51,7 +51,7 @@ module Lhm
       end
 
       def select_values(sql)
-        select_one(sql).values
+        select_all(sql)
       end
 
       def select_value(sql)

data/lib/lhm/migration.rb

@@ -14,7 +14,7 @@ module Lhm
     end
 
     def archive_name
-      "lhma_#{ startstamp }_#{ @origin.name }"
+      "lhma_#{ startstamp }_#{ @origin.name }"[0...64]
     end
 
     def intersection

data/lib/lhm/version.rb

@@ -2,5 +2,5 @@
 # Schmidt
 
 module Lhm
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/integration/cleanup_spec.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2011 - 2013, SoundCloud Ltd., Rany Keddo, Tobias Bielohlawek, Tobias
+# Schmidt
+
+require File.expand_path(File.dirname(__FILE__)) + '/integration_helper'
+
+require 'lhm'
+
+describe Lhm, "cleanup" do
+  include IntegrationHelper
+  before(:each) { connect_master! }
+
+  describe "changes" do
+    before(:each) do
+      table_create(:users)
+      Lhm.change_table(:users, :atomic_switch => false) do |t|
+        t.add_column(:logins, "INT(12) DEFAULT '0'")
+        t.add_index(:logins)
+      end
+    end
+
+    it "should show temporary tables" do
+      output = capture_stdout do
+        Lhm.cleanup
+      end
+      output.must_include("Existing LHM backup tables")
+      output.must_match(/lhma_[0-9_]*_users/)
+    end
+
+    it "should delete temporary tables" do
+      Lhm.cleanup(true).must_equal(true)
+      Lhm.cleanup.must_equal(true)
+    end
+  end
+end

data/spec/integration/integration_helper.rb

@@ -50,6 +50,10 @@ module IntegrationHelper
     end
 
     Lhm.setup(adapter)
+    unless defined?(@@cleaned_up)
+      Lhm.cleanup(true)
+      @@cleaned_up  = true
+    end
     @connection = Lhm::Connection.new(adapter)
   end
 
@@ -154,4 +158,17 @@ module IntegrationHelper
   def master_slave_mode?
     !!ENV["MASTER_SLAVE"]
   end
+
+  #
+  # Misc
+  #
+  
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out.string
+  ensure
+    $stdout = ::STDOUT
+  end
 end

data/spec/unit/migration_spec.rb

@@ -20,4 +20,9 @@ describe Lhm::Migration do
     stamp = "%Y_%m_%d_%H_%M_%S_#{ "%03d" % (@start.usec / 1000) }"
     @migration.archive_name.must_equal "lhma_#{ @start.strftime(stamp) }_origin"
   end
+
+  it "should limit table name to 64 characters" do
+    migration = Lhm::Migration.new(OpenStruct.new(:name => "a_very_very_long_table_name_that_should_make_the_LHMA_table_go_over_64_chars"), nil)
+    migration.archive_name.size == 64
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhm
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -94,6 +94,7 @@ files:
 - spec/fixtures/users.ddl
 - spec/integration/atomic_switcher_spec.rb
 - spec/integration/chunker_spec.rb
+- spec/integration/cleanup_spec.rb
 - spec/integration/entangler_spec.rb
 - spec/integration/integration_helper.rb
 - spec/integration/lhm_spec.rb
@@ -132,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: online schema changer for mysql