schema_plus 0.1.0.pre1

data/spec/schema/auto_schema.rb

@@ -0,0 +1,23 @@
+ActiveRecord::Schema.define do
+  connection.tables.each do |table| drop_table table end
+
+  create_table :users, :force => true do |t|
+    t.string :login, :index => { :unique => true }
+  end
+
+  create_table :members, :force => true do |t|
+    t.string :login
+  end
+  
+  create_table :comments, :force => true do |t|
+    t.string :content
+    t.integer :user
+    t.integer :user_id
+    t.foreign_key :user_id, :users, :id
+  end
+
+  create_table :posts, :force => true do |t|
+    t.string :content
+  end
+
+end

data/spec/schema/core_schema.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Schema.define do
+  connection.tables.each do |table| drop_table table end
+
+  create_table :users, :force => true do |t|
+    t.string :login
+    t.datetime :deleted_at
+  end
+
+  create_table :posts, :force => true do |t|
+    t.text :body
+    t.integer :user_id
+    t.integer :author_id
+  end
+
+  create_table :comments, :force => true do |t|
+    t.text :body
+    t.integer :post_id
+    t.foreign_key :post_id, :posts, :id
+  end
+
+end

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,167 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'stringio'
+
+require 'models/post'
+
+describe "Schema dump (core)" do
+
+  before(:all) do
+    load_core_schema
+  end
+
+  let(:dump) do
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.ignore_tables = %w[users comments]
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  end
+
+  it "should include foreign_key definition" do
+    with_foreign_key Post, :user_id, :users, :id do
+      dump.should match(to_regexp(%q{t.foreign_key ["user_id"], "users", ["id"]}))
+    end
+  end
+
+  it "should include foreign_key options" do
+    with_foreign_key Post, :user_id, :users, :id, :on_update => :cascade, :on_delete => :set_null do
+      dump.should match(to_regexp(%q{t.foreign_key ["user_id"], "users", ["id"], :on_update => :cascade, :on_delete => :set_null}))
+    end
+  end
+
+  it "should include index definition" do
+    with_index Post, :user_id do
+      dump.should match(to_regexp(%q{t.index ["user_id"]}))
+    end
+  end
+
+  it "should include index name" do
+    with_index Post, :user_id, :name => "posts_user_id_index" do
+      dump.should match(to_regexp(%q{t.index ["user_id"], :name => "posts_user_id_index"}))
+    end
+  end
+  
+  it "should define unique index" do
+    with_index Post, :user_id, :name => "posts_user_id_index", :unique => true do
+      dump.should match(to_regexp(%q{t.index ["user_id"], :name => "posts_user_id_index", :unique => true}))
+    end
+  end
+
+  if SchemaPlusHelpers.postgresql?
+
+    it "should define case insensitive index" do
+      with_index Post, :name => "posts_user_body_index", :expression => "USING btree (LOWER(body))" do
+        dump.should match(to_regexp(%q{t.index ["body"], :name => "posts_user_body_index", :case_sensitive => false}))
+      end
+    end
+
+    it "should define conditions" do
+      with_index Post, :user_id, :name => "posts_user_id_index", :conditions => "user_id IS NOT NULL" do
+        dump.should match(to_regexp(%q{t.index ["user_id"], :name => "posts_user_id_index", :conditions => "(user_id IS NOT NULL)"}))
+      end
+    end
+
+    it "should define expression" do
+      with_index Post, :name => "posts_freaky_index", :expression => "USING hash (least(id, user_id))" do
+        dump.should match(to_regexp(%q{t.index :name => "posts_freaky_index", :kind => "hash", :expression => "LEAST(id, user_id)"}))
+      end
+    end
+
+    it "should define kind" do
+      with_index Post, :name => "posts_body_index", :expression => "USING hash (body)" do
+        dump.should match(to_regexp(%q{t.index ["body"], :name => "posts_body_index", :kind => "hash"}))
+      end
+    end
+
+  end
+
+  protected
+  def to_regexp(string)
+    Regexp.new(Regexp.escape(string))
+  end
+
+  def with_foreign_key(model, columns, referenced_table_name, referenced_columns, options = {})
+    table_columns = model.columns.reject{|column| column.name == 'id'}
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.create_table model.table_name, :force => true do |t|
+        table_columns.each do |column|
+          t.column column.name, column.type
+        end
+        t.foreign_key columns, referenced_table_name, referenced_columns, options
+      end
+    end
+    model.reset_column_information
+    begin
+      yield
+    ensure
+      ActiveRecord::Migration.suppress_messages do
+        ActiveRecord::Migration.create_table model.table_name, :force => true do |t|
+          table_columns.each do |column|
+            t.column column.name, column.type
+          end
+        end
+      end
+    end
+  end
+  
+  def with_index(model, columns, options = {})
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.add_index(model.table_name, columns, options)
+    end
+    model.reset_column_information
+    begin
+      yield
+    ensure
+      ActiveRecord::Migration.suppress_messages do
+        ActiveRecord::Migration.remove_index(model.table_name, :name => determine_index_name(model, columns, options))
+      end
+    end
+  end
+
+  def determine_index_name(model, columns, options)
+    name = columns[:name] if columns.is_a?(Hash)
+    name ||= options[:name]
+    name ||= model.indexes.detect { |index| index.table == model.table_name.to_s && index.columns == Array(columns).collect(&:to_s) }.name
+    name
+  end
+
+  def determine_foreign_key_name(model, columns, options)
+    name = options[:name] 
+    name ||= model.foreign_keys.detect { |fk| fk.table_name == model.table_name.to_s && fk.column_names == Array(columns).collect(&:to_s) }.name
+  end
+
+end
+
+describe "Schema dump (auto)" do
+  
+  before(:all) do
+    load_auto_schema
+  end
+
+  let(:dump) do
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.ignore_tables = []
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  end
+
+  unless SchemaPlusHelpers.sqlite3?
+    it "shouldn't include :index option for index" do
+      add_column(:author_id, :integer, :references => :users, :index => true) do
+        dump.should_not match(/index => true/)
+      end
+    end
+  end
+    
+  protected
+  def add_column(column_name, *args)
+    table = Post.table_name
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.add_column(table, column_name, *args)
+      Post.reset_column_information
+      yield if block_given?
+      ActiveRecord::Migration.remove_column(table, column_name)
+    end
+  end
+
+end
+

data/spec/schema_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActiveRecord::Schema do
+
+  let(:schema) { ActiveRecord::Schema }
+
+  let(:connection) { ActiveRecord::Base.connection }
+
+  context "defining with auto_index and auto_create" do
+
+    around(:each) do |example|
+      with_auto_index do
+        with_auto_create do
+          example.run
+        end
+      end
+    end
+
+    it "should pass" do
+      expect { define_schema }.should_not raise_error
+    end
+
+    it "should create only explicity added indexes" do
+      define_schema
+      connection.tables.collect { |table| connection.indexes(table) }.flatten.should have(1).item
+    end
+
+    it "should create only explicity added foriegn keys" do
+      define_schema
+      connection.tables.collect { |table| connection.foreign_keys(table) }.flatten.should have(1).item
+    end
+
+  end
+
+  protected
+  def define_schema
+    ActiveRecord::Migration.suppress_messages do
+      schema.define do
+        connection.tables.each do |table| drop_table table end
+
+        create_table :users, :force => true do
+        end
+
+        create_table :posts, :force => true do |t|
+          t.integer :user_id, :references => :users, :index => true
+        end
+      end
+    end
+  end
+
+  def with_auto_index(value = true)
+    old_value = SchemaPlus.config.foreign_keys.auto_index
+    SchemaPlus.config.foreign_keys.auto_index = value
+    begin
+      yield
+    ensure
+      SchemaPlus.config.foreign_keys.auto_index = old_value
+    end
+  end
+
+  def with_auto_create(value = true)
+    old_value = SchemaPlus.config.foreign_keys.auto_create
+    SchemaPlus.config.foreign_keys.auto_create = value
+    begin
+      yield
+    ensure
+      SchemaPlus.config.foreign_keys.auto_create = old_value
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+if RUBY_VERSION > "1.9"
+  require 'simplecov'
+  require 'simplecov-gem-adapter'
+  SimpleCov.start "gem"
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'active_record'
+require 'schema_plus'
+require 'connection'
+
+SchemaPlus.insert
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include(SchemaPlusMatchers)
+  config.include(SchemaPlusHelpers)
+end
+
+def load_schema(name)
+  ActiveRecord::Migration.suppress_messages do
+    eval(File.read(File.join(File.dirname(__FILE__), 'schema', name)))
+  end
+end
+
+def load_core_schema
+  SchemaPlus.setup do |config|
+    config.foreign_keys.auto_create = false;
+  end
+  load_schema('core_schema.rb')
+  load 'models/user.rb'
+  load 'models/post.rb'
+  load 'models/comment.rb'
+end
+
+def load_auto_schema
+  SchemaPlus.setup do |config|
+    config.foreign_keys.auto_create = true;
+  end
+  load_schema('auto_schema.rb')
+  load 'models/user.rb'
+  load 'models/post.rb'
+  load 'models/comment.rb'
+end
+
+def remove_all_models
+    ObjectSpace.each_object(Class) do |c|
+      next unless c.ancestors.include? ActiveRecord::Base
+      next if c == ActiveRecord::Base
+      next if c.name.blank?
+      ActiveSupport::Dependencies.remove_constant c.name
+    end
+  end
+
+SimpleCov.command_name ActiveRecord::Base.connection.adapter_name if defined? SimpleCov

data/spec/support/extensions/active_model.rb

@@ -0,0 +1,13 @@
+# ported from rspec-rails
+# There is no reason to install whole gem as we
+# need only that tiny helper
+module ::ActiveModel::Validations
+
+  def error_on(attribute)
+    self.valid?
+    [self.errors[attribute]].flatten.compact
+  end
+
+  alias :errors_on :error_on
+
+end

data/spec/support/helpers.rb

@@ -0,0 +1,16 @@
+module SchemaPlusHelpers
+  extend self
+
+  def mysql?
+    ActiveRecord::Base.connection.adapter_name =~ /^mysql/i
+  end
+
+  def postgresql?
+    ActiveRecord::Base.connection.adapter_name =~ /^postgresql/i
+  end
+
+  def sqlite3?
+    ActiveRecord::Base.connection.adapter_name =~ /^sqlite/i
+  end
+
+end

data/spec/support/matchers/automatic_foreign_key_matchers.rb

@@ -0,0 +1,2 @@
+require 'support/matchers/reference'
+require 'support/matchers/have_index'

data/spec/support/matchers/have_index.rb

@@ -0,0 +1,52 @@
+module SchemaPlusMatchers
+
+  class HaveIndex
+
+    def initialize(expectation, options = {})
+      set_required_columns(expectation, options)
+    end
+
+    def matches?(model)
+      @model = model
+      @model.indexes.any? do |index|
+        index.columns.to_set == @required_columns &&
+          (@unique  ? index.unique : true) &&
+          (@name    ? index.name == @name.to_s : true)
+      end
+    end
+
+    def failure_message_for_should(should_not = false)
+      invert = should_not ? "not to" : ""
+      "Expected #{@model.table_name} to #{invert} contain index on #{@required_columns.entries.inspect}"
+    end
+
+    def failure_message_for_should_not
+      failure_message_for_should(true)
+    end
+
+    def on(expectation)
+      set_required_columns(expectation)
+      self
+    end
+
+    private
+    def set_required_columns(expectation, options = {})
+      @required_columns = Array(expectation).collect(&:to_s).to_set
+      @unique = options.delete(:unique)
+      @name   = options.delete(:name)
+    end
+
+  end
+
+  def have_index(*expectation)
+    options = expectation.extract_options!
+    HaveIndex.new(expectation, options)
+  end
+
+  def have_unique_index(*expectation)
+    options = expectation.extract_options!
+    options[:unique] = true
+    HaveIndex.new(expectation, options)
+  end
+
+end

data/spec/support/matchers/reference.rb

@@ -0,0 +1,66 @@
+module SchemaPlusMatchers
+
+  class Reference
+    def initialize(expected)
+      @column_names = nil
+      unless expected.empty?
+        @references_column_names = Array(expected).collect(&:to_s)
+        @references_table_name = @references_column_names.shift 
+      end
+    end
+
+    def matches?(model)
+      @model = model
+      if @references_table_name
+        @result = @model.foreign_keys.select do |fk|
+          fk.references_table_name == @references_table_name && 
+            @references_column_names.empty? ? true : fk.references_column_names == @references_column_names 
+        end
+      else
+        @result = @model.foreign_keys
+      end
+      if @column_names 
+        @result.any? do |fk| 
+          fk.column_names == @column_names &&
+            (@on_update ? fk.on_update == @on_update : true) &&
+            (@on_delete ? fk.on_delete == @on_delete : true)
+        end
+      else
+        !@result.empty?
+      end
+    end
+
+    def failure_message_for_should(should_not = false)
+      target_column_names = @column_names.present? ? "(#{@column_names.join(', ')})" : "" 
+      destinantion_column_names = @references_table_name ? "#{@references_table_name}(#{@references_column_names.join(', ')})" : "anything"
+      invert = should_not ? 'not' : ''
+      "Expected #{@model.table_name}#{target_column_names} to #{invert} reference #{destinantion_column_names}"
+    end
+
+    def failure_message_for_should_not
+      failure_message_for_should(true)
+    end
+  
+    def on(*column_names)
+      @column_names = column_names.collect(&:to_s)
+      self
+    end
+
+    def on_update(action)
+      @on_update = action
+      self
+    end
+
+    def on_delete(action)
+      @on_delete = action
+      self
+    end
+
+  end
+
+  def reference(*expect)
+    Reference.new(expect)
+  end
+
+end
+