schema_plus_indexes 0.1.0

data/spec/named_schema_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe "with multiple schemas" do
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  before(:all) do
+    newdb = case connection.adapter_name
+            when /^mysql/i then      "CREATE SCHEMA IF NOT EXISTS schema_plus_indexes_test2"
+            when /^postgresql/i then "CREATE SCHEMA schema_plus_indexes_test2"
+            when /^sqlite/i then     "ATTACH ':memory:' AS schema_plus_indexes_test2"
+            end
+    begin
+      ActiveRecord::Base.connection.execute newdb
+    rescue ActiveRecord::StatementInvalid => e
+      raise unless e.message =~ /already exists/
+    end
+
+    class User < ::ActiveRecord::Base ; end
+  end
+
+  before(:each) do
+    define_schema do
+      create_table :users, :force => true do |t|
+        t.string :login
+      end
+    end
+
+    connection.execute 'DROP TABLE IF EXISTS schema_plus_indexes_test2.users'
+    connection.execute 'CREATE TABLE schema_plus_indexes_test2.users (id ' + case connection.adapter_name
+          when /^mysql/i then      "integer primary key auto_increment"
+          when /^postgresql/i then "serial primary key"
+          when /^sqlite/i then     "integer primary key autoincrement"
+          end + ", login varchar(255))"
+  end
+
+  context "with indexes in each schema" do
+    before(:each) do
+      connection.execute 'CREATE INDEX ' + case connection.adapter_name
+      when /^mysql/i then      "index_users_on_login ON schema_plus_indexes_test2.users"
+      when /^postgresql/i then "index_users_on_login ON schema_plus_indexes_test2.users"
+      when /^sqlite/i then     "schema_plus_indexes_test2.index_users_on_login ON users"
+      end + " (login)"
+    end
+
+    it "should not find indexes in other schema" do
+      User.reset_column_information
+      expect(User.indexes).to be_empty
+    end
+
+    it "should find index in current schema" do
+      connection.execute 'CREATE INDEX index_users_on_login ON users (login)'
+      User.reset_column_information
+      expect(User.indexes.map(&:name)).to eq(['index_users_on_login'])
+    end
+  end
+
+end
+

data/spec/sanity_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+
+# A basic sanity check to have as a spec when first starting.  Feel free to delete this
+# once you've got real content.
+
+describe "Sanity Check" do
+
+  it "database is connected" do
+    expect(ActiveRecord::Base).to be_connected
+  end
+
+end

data/spec/schema_dumper_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'stringio'
+
+describe "Schema dump" do
+
+  before(:all) do
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Schema.define do
+        connection.tables.each do |table| drop_table table, :cascade => true end
+
+        create_table :users, :force => true do |t|
+          t.string :login
+          t.datetime :deleted_at
+          t.integer :first_post_id
+        end
+
+        create_table :posts, :force => true do |t|
+          t.text :body
+          t.integer :user_id
+          t.integer :first_comment_id
+          t.string :string_no_default
+          t.integer :short_id
+          t.string :str_short
+          t.integer :integer_col
+          t.float :float_col
+          t.decimal :decimal_col
+          t.datetime :datetime_col
+          t.timestamp :timestamp_col
+          t.time :time_col
+          t.date :date_col
+          t.binary :binary_col
+          t.boolean :boolean_col
+        end
+
+        create_table :comments, :force => true do |t|
+          t.text :body
+          t.integer :post_id
+          t.integer :commenter_id
+        end
+      end
+    end
+    class ::User < ActiveRecord::Base ; end
+    class ::Post < ActiveRecord::Base ; end
+    class ::Comment < ActiveRecord::Base ; end
+  end
+
+  it "should include in-table index definition" do
+    with_index Post, :user_id do
+      expect(dump_posts).to match(/"user_id",.*index:/)
+    end
+  end
+
+  it "should not include add_index statement" do
+    with_index Post, :user_id do
+      expect(dump_posts).not_to match(%r{add_index.*user_id})
+    end
+  end
+
+  it "should include index name" do
+    with_index Post, :user_id, :name => "custom_name" do
+      expect(dump_posts).to match(/"user_id",.*index:.*name: "custom_name"/)
+    end
+  end
+
+  it "should define unique index" do
+    with_index Post, :user_id, :name => "posts_user_id_index", :unique => true do
+      expect(dump_posts).to match(/"user_id",.*index:.*name: "posts_user_id_index", unique: true/)
+    end
+  end
+
+  it "should include index order", :mysql => :skip do
+    with_index Post, [:user_id, :first_comment_id, :short_id], :order => { :user_id => :asc, :first_comment_id => :desc } do
+      expect(dump_posts).to match(/"user_id".*index: {.*with: \["first_comment_id", "short_id"\],.*order: {"user_id"=>:asc, "first_comment_id"=>:desc, "short_id"=>:asc}/)
+    end
+  end
+
+  protected
+
+  def to_regexp(string)
+    Regexp.new(Regexp.escape(string))
+  end
+
+  def with_index(*args)
+    options = args.extract_options!
+    model, columns = args
+    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.sort == Array(columns).collect(&:to_s).sort }.name
+    name
+  end
+
+  def dump_schema(opts={})
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.ignore_tables = Array.wrap(opts[:ignore]) || []
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    stream.string
+  end
+
+  def dump_posts
+    dump_schema(:ignore => %w[users comments])
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+require 'simplecov-gem-profile'
+SimpleCov.start "gem"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'active_record'
+require 'schema_plus_indexes'
+require 'schema_dev/rspec'
+
+SchemaDev::Rspec.setup
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include(SchemaPlusIndexesMatchers)
+  config.warnings = true
+end
+
+def define_schema(config={}, &block)
+  ActiveRecord::Migration.suppress_messages do
+    ActiveRecord::Schema.define do
+      connection.tables.each do |table|
+        drop_table table, :cascade => true
+      end
+      instance_eval &block
+    end
+  end
+end
+
+SimpleCov.command_name "[ruby #{RUBY_VERSION} - ActiveRecord #{::ActiveRecord::VERSION::STRING} - #{ActiveRecord::Base.connection.adapter_name}]"
+

data/spec/support/matchers/have_index.rb

@@ -0,0 +1,60 @@
+module SchemaPlusIndexesMatchers
+
+  class HaveIndex
+
+    def initialize(expectation, options = {})
+      set_required_columns(expectation)
+      @unique = options.delete(:unique)
+      @name   = options.delete(:name)
+    end
+
+    def matches?(model)
+      @too_many = nil
+      @model = model
+      indexes = @model.indexes.select { |index| index.columns.to_set == @required_columns }
+      if indexes.length > 1
+        @too_many = indexes.length
+        return false
+      end
+      index = indexes.first
+      return index && (@unique ? index.unique : true) && (@name ? index.name == @name.to_s : true)
+    end
+
+    def failure_message(should_not = false)
+      invert = should_not ? "not to" : "to"
+      what = ""
+      what += "unique " if @unique
+      what += "named '{@name}'" if @name
+      msg = "Expected #{@model.table_name} #{invert} contain one #{what}index on #{@required_columns.entries.inspect}"
+      msg += "; found #{@too_many} indexes" if @too_many
+      msg
+    end
+
+    def failure_message_when_negated
+      failure_message(true)
+    end
+
+    def on(expectation)
+      set_required_columns(expectation)
+      self
+    end
+
+    private
+    def set_required_columns(expectation)
+      @required_columns = Array(expectation).collect(&:to_s).to_set
+    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

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: schema_plus_indexes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ronen barzel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: schema_monkey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: schema_dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-gem-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ronen@barzel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.base
+- gemfiles/rails-4.2/Gemfile.base
+- gemfiles/rails-4.2/Gemfile.mysql2
+- gemfiles/rails-4.2/Gemfile.postgresql
+- gemfiles/rails-4.2/Gemfile.sqlite3
+- lib/schema_plus_indexes.rb
+- lib/schema_plus_indexes/active_record/base.rb
+- lib/schema_plus_indexes/active_record/connection_adapters/abstract_adapter.rb
+- lib/schema_plus_indexes/active_record/connection_adapters/index_definition.rb
+- lib/schema_plus_indexes/middleware/dumper.rb
+- lib/schema_plus_indexes/middleware/migration.rb
+- lib/schema_plus_indexes/middleware/model.rb
+- lib/schema_plus_indexes/middleware/sqlite3.rb
+- lib/schema_plus_indexes/version.rb
+- schema_dev.yml
+- schema_plus_indexes.gemspec
+- spec/index_definition_spec.rb
+- spec/index_spec.rb
+- spec/migration_spec.rb
+- spec/named_schema_spec.rb
+- spec/sanity_spec.rb
+- spec/schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/have_index.rb
+homepage: https://github.com/SchemaPlus/schema_plus_indexes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds shorthands and conveniences to ActiveRecord's handling of indexes
+test_files:
+- spec/index_definition_spec.rb
+- spec/index_spec.rb
+- spec/migration_spec.rb
+- spec/named_schema_spec.rb
+- spec/sanity_spec.rb
+- spec/schema_dumper_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/have_index.rb