lincoln 0.0.1 → 0.0.2

data/RUNNING_UNIT_TESTS

@@ -0,0 +1,8 @@
+== Creating the test database
+
+This gem currently only supports Mysql. To run the unit tests, first create a database named lincoln_test on
+localhost. See database.rb for connection details for the test suite.
+
+== Running with Rake
+
+After creating the default database, run "rake" to run all the tests.

data/Rakefile

@@ -4,9 +4,10 @@ require 'bundler'
 
 Bundler::GemHelper.install_tasks
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-task :default => :spec
+task :default => :test

data/lib/lincoln.rb

@@ -1,4 +1,3 @@
 require 'active_record'
 require File.dirname(__FILE__) + "/lincoln/attr_ignore"
-
-ActiveRecord::Base.send(:include, Lincoln::AttrIgnore)
+require File.dirname(__FILE__) + "/lincoln/mysql_adapter"

data/lib/lincoln/attr_ignore.rb

@@ -37,4 +37,6 @@ module Lincoln
     module InstanceMethods
     end
   end
-end
+end
+
+ActiveRecord::Base.send(:include, Lincoln::AttrIgnore)

data/lib/lincoln/mysql_adapter.rb

@@ -0,0 +1,111 @@
+# ActiveRecord::ConnectionAdapters::SchemaStatements
+# module ActiveRecord
+#   module ConnectionAdapters
+#     module SchemaStatements
+#       def change_table(table_name)
+#         yield Lincoln::Table.new(table_name, self)
+#       end
+#     end
+#   end
+# end
+
+module Lincoln
+  module ChangeTableOptimization
+    def change_table(table_name)
+      @table_name = table_name
+      @new_table_name = generate_table_name(table_name)
+      copy_table_structure(table_name, @new_table_name)
+      
+      super(@new_table_name)
+      
+      copy_data(table_name, @new_table_name)
+      swap_tables(@new_table_name, table_name)
+      
+      @table_name = nil
+      @new_table_name = nil
+    end
+    
+    def add_column(table_name, column_name, type, options = {})
+      track("add", column_name)
+      super
+    end
+    
+    def remove_column(table_name, *column_names)
+      column_names.each { |c| track("remove", c) }
+      super
+    end
+    
+    def rename_column_with_tracking(table_name, column_name, new_column_name)
+      track("rename", [column_name, new_column_name])
+      rename_column_without_tracking(table_name, column_name, new_column_name)
+    end
+    
+    def index_name(table_name, options)
+      if @table_name != nil
+        return super(@table_name, options)
+      end
+      super(table_name, options)
+    end
+    
+    private
+    
+    def track(operation, data)
+      @track ||= {}
+      @track[operation] ||= []
+      @track[operation].push(data)
+    end
+    
+    def column_removed?(column_name)
+      @track ||= {}
+      @track["remove"] ||= []
+      @track["remove"].include?(column_name)
+    end
+    
+    def column_added?(column_name)
+      @track ||= {}
+      @track["add"] ||= []
+      @track["add"].include?(column_name)
+    end
+    
+    def new_column_name(column_name)
+      @track ||= {}
+      @track["rename"] ||= []
+      @track["rename"].each do |rename_array|
+        if rename_array.first.to_s == column_name.to_s
+          return rename_array.last
+        end
+      end
+      column_name
+    end
+    
+    def generate_table_name(table_name)
+      "#{table_name}_#{Time.now.to_i}_#{(rand * 100_000_000).to_i}"
+    end
+    
+    def copy_table_structure(table_name, new_table_name)
+      execute("CREATE TABLE #{quote_table_name(new_table_name)} LIKE #{quote_table_name(table_name)}")
+    end
+    
+    def copy_data(table_name, new_table_name)
+      original_column_names = columns(table_name).map do |column|
+        return nil if column_removed?(column.name) || column_added?(column.name)
+        quote_column_name(column.name)
+      end.flatten
+      
+      new_column_names = columns(table_name).map do |column|
+        return nil if column_removed?(column.name) || column_added?(column.name)
+        quote_column_name(new_column_name(column.name))
+      end.flatten
+      
+      execute("INSERT INTO #{quote_table_name(new_table_name)} (#{new_column_names.join(", ")}) SELECT #{original_column_names.join(", ")} FROM #{quote_table_name(table_name)}")
+    end
+    
+    def swap_tables(new_table_name, table_name)
+      rename_table(table_name, "#{new_table_name}_bak")
+      rename_table(new_table_name, table_name)
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, Lincoln::ChangeTableOptimization)
+ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:alias_method_chain, :rename_column, :tracking)

data/lib/lincoln/version.rb

@@ -1,3 +1,3 @@
 module Lincoln
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lincoln.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   
   s.add_dependency('activerecord', '~> 3.0')
-  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "mysql"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/shoulda_matchers/column_matcher.rb

@@ -0,0 +1,111 @@
+module Lincoln
+  module Matchers
+    def have_column(column_name, &blk)
+      ColumnMatcher.new(column_name, &blk)
+    end
+    
+    class ColumnMatcher
+      def initialize(column_name)
+        @column_name = column_name.to_s
+      end
+      
+      def matches?(klass)
+        @klass = klass.class
+        @column = find_column
+        
+        column_exists? && 
+          correct_type? && 
+          correct_precision? &&
+          correct_default? &&
+          correct_limit?
+      end
+      
+      def with_type(type)
+        @type = type.to_s
+        self
+      end
+      
+      def with_precision(precision)
+        @precision = precision.to_s
+        self
+      end
+      
+      def with_default(default)
+        @default = default.to_s
+        self
+      end
+      
+      def with_limit(limit)
+        @limit = limit.to_s
+        self
+      end
+
+      def description
+        "have a column named #{@column_name}"
+      end
+
+      def failure_message
+        "Expected column with name '#{@column_name}'"
+      end
+      
+      def negative_failure_message
+        "Did not expect column with name '#{@column_name}'"
+      end
+      
+      private
+      
+      def find_column
+        columns = @klass.columns.find_all { |c| c.name == @column_name }
+        columns.size == 1 ? columns.first : nil
+      end
+      
+      def column_exists?
+        !@column.nil?
+      end
+      
+      def correct_type?
+        return true if @type.nil?
+        
+        if @column.type.to_s != @type
+          @missing = "actual column type was '#{@column.type}'"
+          false
+        else
+          true
+        end
+      end
+      
+      def correct_precision?
+        return true if @precision.nil?
+        
+        if @column.precision.to_s != @precision
+          @missing = "actual column precision was '#{@column.precision}'"
+          false
+        else
+          true
+        end
+      end
+      
+      def correct_default?
+        return true if @default.nil?
+        
+        if @column.default.to_s != @default
+          @missing = "actual column default was '#{@column.default}'"
+          false
+        else
+          true
+        end
+      end
+      
+      def correct_limit?
+        return true if @limit.nil?
+        
+        if @column.limit.to_s != @limit
+          @missing = "actual column limit was '#{@column.limit}'"
+          false
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/shoulda_matchers/index_matcher.rb

@@ -0,0 +1,48 @@
+module Lincoln
+  module Matchers
+    def have_index(column_name, &blk)
+      ColumnIndex.new(column_name, &blk)
+    end
+    
+    class ColumnIndex
+      def initialize(columns_for_index)
+        @columns_for_index = columns_for_index
+        @columns_for_index = [columns_for_index] unless columns_for_index.kind_of?(Array)
+        @columns_for_index = @columns_for_index.map { |c| c.to_s }
+      end
+      
+      def matches?(klass)
+        @klass = klass.class
+        @index = find_index
+        
+        index_exists?
+      end
+      
+      def description
+        "have an index for column '#{@columns_for_index.inspect}'"
+      end
+
+      def failure_message
+        "Expected index with name '#{@columns_for_index.inspect}'"
+      end
+      
+      def negative_failure_message
+        "Did not expect column with name '#{@columns_for_index.inspect}'"
+      end
+      
+      private
+      
+      def find_index
+        indexes = @klass.connection.indexes(@klass.table_name).find_all do |index|
+          index.columns == @columns_for_index
+        end
+        indexes.size == 1 ? indexes.first : nil
+      end
+      
+      def index_exists?
+        !@index.nil?
+      end
+      
+    end
+  end
+end

data/shoulda_matchers/lincoln_matchers.rb

@@ -0,0 +1,9 @@
+Dir.glob("#{File.dirname(__FILE__)}/**/*.rb") do |file|
+  require file
+end
+
+# Mix in the matchers to test case
+class Test::Unit::TestCase
+  include Lincoln::Matchers
+  extend Lincoln::Matchers
+end

data/test/lib/database.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'mysql',
+  :host => 'localhost',
+  :user => 'root',
+  :database => 'lincoln_test'
+})
+
+def create_my_models
+  ActiveRecord::Schema.define do
+    create_table "my_models", :force => true do |t|
+      t.string :column1, :column2, :column3
+    end
+  end
+end

data/test/test_attr_ignore.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class AttrIgnoreTest < ActiveSupport::TestCase
+  setup do
+    create_my_models
+  end
+  
+  should "have ignore_attributes" do
+    assert_equal Set.new(["column1", "column2"]), MyModel.ignore_attributes
+  end
+  
+  should "ignore columns specified in ignore_attr" do
+    column_names = MyModel.columns.collect { |column| column.name }
+    assert_equal ["id", "column3"], column_names
+  end
+end
+
+class MyModel < ActiveRecord::Base
+  attr_ignore :column1, :column2
+end

data/test/test_change_table.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class MyModelTest < ActiveSupport::TestCase
+  setup do
+    create_my_models
+  end
+  
+  context "MyModel" do
+    setup do
+      MyModelsAddColumn.up
+      MyModel.reset_column_information
+    end
+
+    should have_index("column2")
+    should have_column("column4").with_type(:string)
+    
+    should have_column("created_at")
+    should have_column("updated_at")
+    
+    should have_column("column5").with_type(:string)
+    should have_column("column6").with_type(:text)
+    should have_column("column7").with_type(:integer)
+    should have_column("column8").with_type(:float)
+    should have_column("column9").with_type(:integer).with_precision(10)
+    should have_column("column10").with_type(:datetime)
+    should have_column("column11").with_type(:datetime)
+    should have_column("column12").with_type(:time)
+    should have_column("column13").with_type(:date)
+    should have_column("column14").with_type(:binary)
+    should have_column("column15").with_type(:boolean)
+    
+    should have_column("model1_id").with_type(:integer)
+    should have_column("model2_id").with_type(:integer)
+    should have_column("model2_type").with_type(:string)
+    
+    context "remove columns" do
+      setup do
+        MyModelsRemoveColumn.up
+        MyModel.reset_column_information
+      end
+      
+      should_not have_column("column1")
+      should_not have_index("column2")
+      should_not have_column("created_at")
+      should_not have_column("updated_at")
+      should_not have_column("model1_id")
+      should_not have_column("model2_id")
+      should_not have_column("model2_type")
+    end
+    
+    context "changes columns" do
+      setup do
+        MyModelsChangeColumn.up
+        MyModel.reset_column_information
+      end
+      
+      should_not have_column("column4")
+      should have_column("column40")
+      should have_column("column3").with_default('default')
+      should have_column("column3").with_limit(20)
+    end
+  end
+end
+
+class MyModel < ActiveRecord::Base
+end
+
+class MyModelsAddColumn < ActiveRecord::Migration
+  def self.up
+    change_table(:my_models) do |t|
+      t.index :column2
+      
+      t.column :column4, :string
+      t.string :column5
+      t.text :column6
+      t.integer :column7
+      t.float :column8
+      t.decimal :column9
+      t.datetime :column10
+      t.timestamp :column11
+      t.time :column12
+      t.date :column13
+      t.binary :column14
+      t.boolean :column15
+      
+      t.timestamps
+      
+      t.references :model1
+      t.belongs_to :model2, :polymorphic => true
+    end
+  end
+end
+
+class MyModelsRemoveColumn < ActiveRecord::Migration
+  def self.up
+    change_table(:my_models) do |t|
+      t.remove :column1
+      t.remove_index :column2
+      t.remove_timestamps
+      t.remove_references :model1
+      t.remove_belongs_to :model2, :polymorphic => true
+    end
+  end
+end
+
+class MyModelsChangeColumn < ActiveRecord::Migration
+  def self.up
+    change_table(:my_models) do |t|
+      t.change :column3, :string, :limit => 20
+      t.change_default :column3, 'default'
+      t.rename :column4, :column40
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'shoulda'
+
+require 'active_record'
+# Debug activerecord
+# require 'logger'
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Load the schema
+TEST_ROOT = File.expand_path(File.dirname(__FILE__))
+$: << File.join(TEST_ROOT, 'lib')
+load 'database.rb'
+
+# Load the matchers
+require File.dirname(__FILE__) + '/../shoulda_matchers/lincoln_matchers'
+
+require 'lincoln'

data/tools/file_split.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+awk '/--/{i++}{print > ("split."i)}' $1
+ls | awk '/split\.[0-9]+/'

data/tools/query_tester.sh

@@ -0,0 +1,27 @@
+file_names=`./file_split.sh $1`
+
+times_to_run_query=${2:-"4"}
+
+for file_name in $file_names
+do
+  uncached_sum=0
+  cached_sum=0
+
+  for (( i=1; i<=$times_to_run_query; i++ ))
+  do
+    sudo /etc/init.d/mysql restart &>/dev/null
+    uncached=`mysql -u root quantum_production -vvv < $file_name | awk '/\((.*) sec\)/' | sed 's/^.*(//' | sed 's/ .*$//'`
+    cached=`mysql -u root quantum_production -vvv < $file_name | awk '/\((.*) sec\)/' | sed 's/^.*(//' | sed 's/ .*$//'`
+    uncached_sum=`ruby -e "print ($uncached_sum + $uncached)"`
+    cached_sum=`ruby -e "print ($cached_sum + $cached)"`
+    echo "$uncached $cached"
+  done
+
+  uncached_average=`ruby -e "print ($uncached_sum/$times_to_run_query)"`
+  cached_average=`ruby -e "print ($cached_sum/$times_to_run_query)"`
+
+  echo "Average of uncached: $uncached_average"
+  echo "Average of cached: $cached_average"
+done
+
+rm $file_names

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lincoln
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ben Curren
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -07:00
+date: 2011-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,20 +34,33 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: shoulda
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
-        - 2
         - 0
-        version: "2.0"
+        version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Extensions to ActiveRecord to make it easier to run at scale.
 email: 
 - ben@outright.com
@@ -61,15 +74,22 @@ files:
 - .gitignore
 - Gemfile
 - README.md
+- RUNNING_UNIT_TESTS
 - Rakefile
-- autotest/discover.rb
 - lib/lincoln.rb
 - lib/lincoln/attr_ignore.rb
+- lib/lincoln/mysql_adapter.rb
 - lib/lincoln/version.rb
 - lincoln.gemspec
-- spec/attr_ignore_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- shoulda_matchers/column_matcher.rb
+- shoulda_matchers/index_matcher.rb
+- shoulda_matchers/lincoln_matchers.rb
+- test/lib/database.rb
+- test/test_attr_ignore.rb
+- test/test_change_table.rb
+- test/test_helper.rb
+- tools/file_split.sh
+- tools/query_tester.sh
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -109,6 +129,7 @@ signing_key:
 specification_version: 3
 summary: Extensions to ActiveRecord to make it easier to run at scale.
 test_files: 
-- spec/attr_ignore_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- test/lib/database.rb
+- test/test_attr_ignore.rb
+- test/test_change_table.rb
+- test/test_helper.rb

data/autotest/discover.rb

@@ -1 +0,0 @@
-Autotest.add_discovery { "rspec" }

data/spec/attr_ignore_spec.rb

@@ -1,16 +0,0 @@
-require File.dirname(__FILE__) + "/spec_helper"
-
-describe "attr_reader" do
-  it "has ignore_attributes" do
-    MyModel.ignore_attributes.should == Set.new(["column1", "column2"])
-  end
-  
-  it "ignores columns specified in ignore_attr" do
-    column_names = MyModel.columns.collect { |column| column.name }
-    column_names.should == ["column3"]
-  end
-end
-
-class MyModel < ActiveRecord::Base
-  attr_ignore :column1, :column2
-end

data/spec/spec_helper.rb

@@ -1,21 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'rubygems'
-require 'rspec'
-require 'rspec/autorun'
-
-# Need to override ActivreRecord::Base before we require lincoln
-# for testing
-require 'active_record'
-class ActiveRecord::Base
-  def self.columns
-    [ActiveRecord::ConnectionAdapters::Column.new("column1", nil, "string", false), 
-      ActiveRecord::ConnectionAdapters::Column.new("column2", nil, "string", false), 
-      ActiveRecord::ConnectionAdapters::Column.new("column3", nil, "string", false)]
-  end
-end
-require 'lincoln'
-
-RSpec.configure do |config|
-
-end