redhillonrails_core 1.0.9.1 → 1.1.0

data/spec/index_definition_spec.rb

@@ -0,0 +1,145 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'models/user'
+
+describe "Index definition" do
+
+  let(:migration) { ::ActiveRecord::Migration }
+
+  context "when index is multicolumn" do
+    before(:each) do
+      migration.suppress_messages do
+        migration.execute "CREATE INDEX users_login_index ON users (login, deleted_at)"
+      end
+      User.reset_column_information
+      @index = index_definition(%w[login deleted_at])
+    end
+
+    after(:each) do
+      migration.suppress_messages do
+        migration.remove_index :users, :name => 'users_login_index'
+      end
+    end
+
+    it "is included in User.indexes" do
+      User.indexes.select { |index| index.columns == %w[login deleted_at] }.should have(1).item
+    end
+
+  end
+
+  if ::ActiveRecord::Base.connection.class.include?(RedhillonrailsCore::ActiveRecord::ConnectionAdapters::PostgresqlAdapter)
+
+    context "when case insensitive is added" do
+
+      before(:each) do
+        migration.suppress_messages do
+          migration.execute "CREATE INDEX users_login_index ON users(LOWER(login))"
+        end
+        User.reset_column_information
+        @index = User.indexes.detect { |i| i.expression =~ /lower\(\(login\)::text\)/i }
+      end
+
+      after(:each) do
+        migration.suppress_messages do
+          migration.remove_index :users, :name => 'users_login_index'
+        end
+      end
+
+      it "is included in User.indexes" do
+        @index.should_not be_nil
+      end
+
+      it "is not case_sensitive" do
+        @index.should_not be_case_sensitive
+      end
+
+      it "defines expression" do
+        @index.expression.should == "lower((login)::text)"
+      end
+
+      it "doesn't define conditions" do
+        @index.conditions.should be_nil
+      end
+
+    end
+
+
+    context "when index is partial and column is not downcased" do
+      before(:each) do
+        migration.suppress_messages do
+          migration.execute "CREATE INDEX users_login_index ON users(login) WHERE deleted_at IS NULL"
+        end
+        User.reset_column_information
+        @index = index_definition("login")
+      end
+
+      after(:each) do
+        migration.suppress_messages do
+          migration.remove_index :users, :name => 'users_login_index'
+        end
+      end
+
+      it "is included in User.indexes" do
+        User.indexes.select { |index| index.columns == ["login"] }.should have(1).item
+      end
+
+      it "is case_sensitive" do
+        @index.should be_case_sensitive
+      end
+
+      it "doesn't define expression" do
+        @index.expression.should be_nil
+      end
+
+      it "defines conditions" do
+        @index.conditions.should == "(deleted_at IS NULL)"
+      end
+
+    end
+
+    context "when index contains expression" do
+      before(:each) do
+        migration.suppress_messages do
+          migration.execute "CREATE INDEX users_login_index ON users (extract(EPOCH from deleted_at)) WHERE deleted_at IS NULL"
+        end
+        User.reset_column_information
+        @index = User.indexes.detect { |i| i.expression.present? }
+      end
+
+      after(:each) do
+        migration.suppress_messages do
+          migration.remove_index :users, :name => 'users_login_index'
+        end
+      end
+
+      it "exists" do
+        @index.should_not be_nil
+      end
+
+      it "doesnt have columns defined" do
+        @index.columns.should be_empty
+      end
+
+      it "is case_sensitive" do
+        @index.should be_case_sensitive
+      end
+
+      it "defines expression" do
+        @index.expression.should == "date_part('epoch'::text, deleted_at)"
+      end
+
+      it "defines conditions" do
+        @index.conditions.should == "(deleted_at IS NULL)"
+      end
+
+    end
+
+  end # of postgresql specific examples
+
+  protected
+  def index_definition(column_names)
+    User.indexes.detect { |index| index.columns == Array(column_names) }
+  end
+
+
+end

data/spec/index_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'models/user'
+
+describe "add_index" do
+
+  let(:migration) { ::ActiveRecord::Migration }
+
+  after(:each) do
+    migration.suppress_messages do
+      migration.remove_index(:users, :name => @index.name) if @index
+    end
+  end
+
+  it "should create index when called without additional options" do
+    add_index(:users, :login)
+    index_for(:login).should_not be_nil
+  end
+
+  it "should create unique index" do
+    add_index(:users, :login, :unique => true)
+    index_for(:login).unique.should == true
+  end
+
+  it "should assign given name" do
+    add_index(:users, :login, :name => 'users_login_index')
+    index_for(:login).name.should == 'users_login_index'
+  end
+
+  if ::ActiveRecord::Base.connection.class.include?(RedhillonrailsCore::ActiveRecord::ConnectionAdapters::PostgresqlAdapter)
+
+    it "should assign conditions" do
+      add_index(:users, :login, :conditions => 'deleted_at IS NULL')
+      index_for(:login).conditions.should == '(deleted_at IS NULL)'
+    end
+
+    it "should assign expression" do
+      add_index(:users, :expression => "USING hash (upper(login)) WHERE deleted_at IS NULL", :name => 'users_login_index')
+      @index = User.indexes.detect { |i| i.expression.present? }
+      @index.expression.should == "upper((login)::text)"
+      @index.conditions.should == "(deleted_at IS NULL)"
+    end
+
+    it "should raise if no column given and expression is missing" do
+      expect { add_index(:users, :name => 'users_login_index') }.should raise_error(ArgumentError)
+    end
+
+    it "should raise if expression without name is given" do
+      expect { add_index(:users, :expression => "USING btree (login)") }.should raise_error(ArgumentError)
+    end
+
+  end # of postgresql specific examples
+
+  protected
+  def add_index(*args)
+    migration.suppress_messages do
+      migration.add_index(*args)
+    end
+    User.reset_column_information
+  end
+
+  def index_for(column_names)
+    @index = User.indexes.detect { |i| i.columns == Array(column_names).collect(&:to_s) }
+  end
+
+
+end

data/spec/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+
+  belongs_to :post
+
+end

data/spec/models/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+
+  belongs_to :user
+  has_many :comments
+
+end

data/spec/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+
+  has_many :posts
+
+end

data/spec/schema/schema.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Schema.define do
+
+  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
+  end
+
+  add_foreign_key :comments, :post_id, :posts, :id
+
+end

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'stringio'
+
+require 'models/post'
+
+describe "Schema dump" do
+
+  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{add_foreign_key "posts", ["user_id"], "users", ["id"]}))
+    end
+  end
+
+
+  unless ::ActiveRecord::Base.connection.class.include?(RedhillonrailsCore::ActiveRecord::ConnectionAdapters::Sqlite3Adapter)
+
+    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{add_foreign_key "posts", ["user_id"], "users", ["id"], :on_update => :cascade, :on_delete => :set_null}))
+      end
+    end
+
+  end
+
+  it "should include index definition" do
+    with_index Post, :user_id do
+      dump.should match(to_regexp(%q{add_index "posts", ["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{add_index "posts", ["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{add_index "posts", ["user_id"], :name => "posts_user_id_index", :unique => true}))
+    end
+  end
+  
+  if ::ActiveRecord::Base.connection.class.include?(RedhillonrailsCore::ActiveRecord::ConnectionAdapters::PostgresqlAdapter)
+
+  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{add_index "posts", ["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{add_index "posts", ["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{add_index "posts", :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{add_index "posts", ["body"], :name => "posts_body_index", :kind => "hash"}))
+    end
+  end
+
+  end # of postgresql specific examples
+
+  protected
+  def to_regexp(string)
+    Regexp.new(Regexp.escape(string))
+  end
+
+  def with_foreign_key(model, columns, referenced_table_name, referenced_columns, options = {})
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.add_foreign_key(model.table_name, columns, referenced_table_name, referenced_columns, options)
+    end
+    model.reset_column_information
+    yield
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.remove_foreign_key(model.table_name, determine_foreign_key_name(model, columns, options))
+    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
+    yield
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.remove_index(model.table_name, :name => determine_index_name(model, columns, options))
+    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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'redhillonrails_core'
+require 'connection'
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  config.include(RedhillonrailsCoreMatchers)
+  # load schema
+  ActiveRecord::Migration.suppress_messages do
+    eval(File.read(File.join(File.dirname(__FILE__), 'schema', 'schema.rb')))
+  end
+end
+

data/spec/support/reference.rb

@@ -0,0 +1,66 @@
+module RedhillonrailsCoreMatchers
+
+  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 && 
+            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
+      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} #{invert} to 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
+

metadata

@@ -1,14 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: redhillonrails_core
 version: !ruby/object:Gem::Version 
-  hash: 121
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 9
   - 1
-  version: 1.0.9.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - "Micha\xC5\x82 \xC5\x81omnicki"
@@ -16,38 +14,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 +01:00
+date: 2011-01-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: micronaut
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-description: RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins. It creates and drops views and foreign-keys or obtains indexes directly from a model class.
+description: Adds support in ActiveRecord for foreign_keys, complex indexes and other database-related stuff. Easily create foreign_keys, complex indexes and views.
 email: michal.lomnicki@gmail.com
 executables: []
 
@@ -56,39 +38,24 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .document
-- .gitignore
-- .rvmrc
 - CHANGELOG
-- Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
-- Rakefile
-- VERSION
-- examples/example_helper.rb
-- examples/postgresql_index_parser_example.rb
 - init.rb
-- lib/red_hill_consulting/core.rb
-- lib/red_hill_consulting/core/active_record.rb
-- lib/red_hill_consulting/core/active_record/base.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/abstract_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/column.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/foreign_key_definition.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/index_definition.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/mysql4_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/mysql5_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/mysql_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/mysql_column.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/postgresql_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/schema_statements.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/sqlite3_adapter.rb
-- lib/red_hill_consulting/core/active_record/connection_adapters/table_definition.rb
-- lib/red_hill_consulting/core/active_record/schema.rb
-- lib/red_hill_consulting/core/active_record/schema_dumper.rb
 - lib/redhillonrails_core.rb
+- lib/redhillonrails_core/active_record/base.rb
+- lib/redhillonrails_core/active_record/connection_adapters/abstract_adapter.rb
+- lib/redhillonrails_core/active_record/connection_adapters/column.rb
+- lib/redhillonrails_core/active_record/connection_adapters/foreign_key_definition.rb
+- lib/redhillonrails_core/active_record/connection_adapters/index_definition.rb
+- lib/redhillonrails_core/active_record/connection_adapters/mysql_adapter.rb
+- lib/redhillonrails_core/active_record/connection_adapters/mysql_column.rb
+- lib/redhillonrails_core/active_record/connection_adapters/postgresql_adapter.rb
+- lib/redhillonrails_core/active_record/connection_adapters/sqlite3_adapter.rb
+- lib/redhillonrails_core/active_record/connection_adapters/table_definition.rb
+- lib/redhillonrails_core/active_record/schema.rb
+- lib/redhillonrails_core/active_record/schema_dumper.rb
 - redhillonrails_core.gemspec
-- tasks/db/comments.rake
 has_rdoc: true
 homepage: http://github.com/mlomnicki/redhillonrails_core
 licenses: []
@@ -99,30 +66,38 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: RedHill on Rails Core is a plugin that features to support other RedHill on Rails plugins
+summary: Adds support in ActiveRecord for foreign_keys, complex indexes and other database-related stuff
 test_files: 
-- examples/example_helper.rb
-- examples/postgresql_index_parser_example.rb
+- spec/schema/schema.rb
+- spec/foreign_key_spec.rb
+- spec/schema_dumper_spec.rb
+- spec/connections/mysql2/connection.rb
+- spec/connections/postgresql/connection.rb
+- spec/connections/sqlite3/connection.rb
+- spec/connections/mysql/connection.rb
+- spec/support/reference.rb
+- spec/index_definition_spec.rb
+- spec/spec_helper.rb
+- spec/index_spec.rb
+- spec/models/user.rb
+- spec/models/post.rb
+- spec/models/comment.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-MIT-LICENSE

data/.gitignore

@@ -1,23 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-.bundle
-log

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.8.7@redhillonrails_core

data/Gemfile

@@ -1,20 +0,0 @@
-source :rubygems
-
-gem "pg"
-gem "activerecord"
-gem "rake"
-
-group :development, :test do
-  gem "jeweler"
-  gem "micronaut"
-
-  platforms :ruby_18 do
-    gem "ruby-debug"
-  end
-
-  platforms :ruby_19 do
-    gem "ruby-debug19"
-  end
-end
-
-# vim: ft=ruby