active_record_doctor 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5905a5c62589cb50dcd33a9c016b8662995d86bd
-  data.tar.gz: e5bd8bf894d6202b8752fa414cad9f330ecc9c7e
+  metadata.gz: be1694f7ee06ee05eb0381bea35f5a1446e067ab
+  data.tar.gz: 7e781c490ba3276e6bae081d911b7ffc9e2795a3
 SHA512:
-  metadata.gz: c29856aae90e13ec1f52e82740fb8cd3a8232fc494d7793e1a6a308af47d7c4aac56dd2fb19fba0b52ef7fdca751b732a0bcbfa0b54680d144cbf104a815ec95
-  data.tar.gz: aed214ddccfbcfccf6029dc7fcb52fa8eef8fc0ad4f423f6c59859d29fb06d80fb51e6b7846072856295b3d1ef5d2212e4d8e3ffb8ebbec6522292db7cbf3b66
+  metadata.gz: 8d30f1aad3a7469e7d0a693bae9254781875025086d3762487c70c5e740d12c9212bfe651f77a8c3b732a93b8d2a748921a654622e851b044882baa6907d9845
+  data.tar.gz: 6dae1b721f9e19573935fc1ca883c5d3fd4a0c73c63d97db9171300259c96cb287a3edf08913a7a56b9dd4c51120308192827083aaeefa930cff6c08470d480a

data/README.rdoc

@@ -1,7 +1,14 @@
 = Active Record Doctor
 
 Active Record Doctor helps to keep the database in a good shape. Currently, it
-can index unindexed foreign keys. More features coming soon!
+can:
+
+* index unindexed foreign keys
+* detect extraneous indexes
+
+More features coming soon!
+
+Want to suggest a feature? Just shoot me {an email}[mailto:contact@gregnavis.com].
 
 {<img src="https://travis-ci.org/gregnavis/active_record_doctor.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/gregnavis/active_record_doctor]
 
@@ -10,9 +17,7 @@ can index unindexed foreign keys. More features coming soon!
 The preferred installation method is adding +active_record_doctor+ to your
 +Gemfile+:
 
-  # git: is required as the gem hasn't been released yet
-  gem 'active_record_doctor', group: :development,
-    github: 'gregnavis/active-record-doctor'
+  gem 'active_record_doctor', group: :development
 
 Then run:
 
@@ -43,6 +48,37 @@ three-step process:
 
      rake db:migrate
 
+=== Removing Extraneous Indexes
+
+Let me illustrate with an example. Consider a +users+ table with columns
++first_name+ and +last_name+. If there are two indexes:
+
+* A two-column index on +last_name, first_name+.
+* A single-column index on +last_name+.
+
+Then the latter index can be dropped as the former can play its role. In
+general, a multi-column index on +column_1, column_2, ..., column_n+ can replace
+indexes on:
+
+* +column_1+
+* +column_1+, +column_2+
+* ...
+* +column_1+, +column_2+, ..., +column_(n - 1)+
+
+To discover such indexes automatically just follow these steps:
+
+1. List extraneous indexes by running:
+
+    rake active_record_doctor:extraneous_indexes
+
+2. Confirm that each of the indexes can be indeed dropped.
+
+3. Create a migration to drop the indexes.
+
+The indexes aren't dropped automatically because there's usually just a few of
+them and it's a good idea to double-check that you won't drop something
+necessary.
+
 == Author
 
 This gem is developed and maintained by {Greg Navis}[http://www.gregnavis.com].

data/lib/active_record_doctor/printers/io_printer.rb

@@ -10,6 +10,17 @@ module ActiveRecordDoctor
           "#{table} #{columns.sort.join(' ')}"
         end.join("\n"))
       end
+
+      def print_extraneous_indexes(extraneous_indexes)
+        if extraneous_indexes.empty?
+          @io.puts("No indexes are extraneous.")
+        else
+          @io.puts("The following indexes are extraneous and can be removed:")
+          extraneous_indexes.each do |index, super_index|
+            @io.puts("  #{index} (can be handled by #{super_index})")
+          end
+        end
+      end
     end
   end
 end

data/lib/active_record_doctor/tasks/extraneous_indexes.rb

@@ -0,0 +1,63 @@
+require "active_record_doctor/printers/io_printer"
+
+module ActiveRecordDoctor
+  module Tasks
+    class ExtraneousIndexes
+      def self.run
+        new.run
+      end
+
+      def initialize(printer: ActiveRecordDoctor::Printers::IOPrinter.new)
+        @printer = printer
+      end
+
+      def run
+        @printer.print_extraneous_indexes(extraneous_indexes)
+      end
+
+      private
+
+      def extraneous_indexes
+        @extraneous_indexes ||=
+          tables.reject do |table|
+            "schema_migrations" == table
+          end.map do |table|
+            indexes = indexes(table)
+            maximum_indexes = indexes.select do |index|
+              indexes.all? do |another_index|
+                index == another_index || !prefix?(index, another_index)
+              end
+            end
+
+            indexes.reject do |index|
+              maximum_indexes.include?(index)
+            end.map do |extraneous_index|
+              [
+                extraneous_index.name,
+                maximum_indexes.find do |maximum_index|
+                  prefix?(extraneous_index, maximum_index)
+                end.name
+              ]
+            end
+          end.flatten(1)
+      end
+
+      def prefix?(lhs, rhs)
+       lhs.columns.count <= rhs.columns.count &&
+        rhs.columns[0...lhs.columns.count] == lhs.columns
+      end
+
+      def indexes(table_name)
+        @connection.indexes(table_name)
+      end
+
+      def tables
+        @tables ||= connection.tables
+      end
+
+      def connection
+        @connection ||= ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/active_record_doctor/tasks/unindexed_foreign_keys.rb

@@ -18,7 +18,7 @@ module ActiveRecordDoctor
       private
 
       def unindexed_foreign_keys
-        connection.tables.select do |table|
+        hash_from_pairs(connection.tables.select do |table|
           "schema_migrations" != table
         end.map do |table|
           [
@@ -29,7 +29,7 @@ module ActiveRecordDoctor
           ]
         end.select do |table, columns|
           !columns.empty?
-        end.to_h
+        end)
       end
 
       def foreign_key?(table, column)
@@ -45,6 +45,10 @@ module ActiveRecordDoctor
       def connection
         @connection ||= ActiveRecord::Base.connection
       end
+
+      def hash_from_pairs(pairs)
+        Hash[*pairs.flatten(1)]
+      end
     end
   end
 end

data/lib/active_record_doctor/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordDoctor
-  VERSION = "1.0.2"
+  VERSION = "1.1.1"
 end

data/lib/tasks/active_record_doctor_tasks.rake

@@ -1,7 +1,12 @@
 require "active_record_doctor/tasks/unindexed_foreign_keys"
+require "active_record_doctor/tasks/extraneous_indexes"
 
 namespace :active_record_doctor do
   task :unindexed_foreign_keys => :environment do
     ActiveRecordDoctor::Tasks::UnindexedForeignKeys.run
   end
+
+  task :extraneous_indexes => :environment do
+    ActiveRecordDoctor::Tasks::ExtraneousIndexes.run
+  end
 end

data/test/active_record_doctor/tasks/extraneous_indexes_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+require 'active_record_doctor/tasks/extraneous_indexes'
+ 
+class ActiveRecordDoctor::Tasks::ExtraneousIndexesTest < ActiveSupport::TestCase
+  def test_extraneous_indexes_are_reported
+    result = run_task
+
+    assert_equal(
+      result.sort,
+      [
+        ["index_users_on_last_name_and_first_name", "index_users_on_last_name_and_first_name_and_email"],
+        ["index_users_on_last_name", "index_users_on_last_name_and_first_name_and_email"]
+      ].sort
+    )
+  end
+
+  private
+
+  def run_task
+    printer = SpyPrinter.new
+    ActiveRecordDoctor::Tasks::ExtraneousIndexes.new(printer: printer).run
+    printer.extraneous_indexes
+  end
+end

data/test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb

@@ -6,7 +6,7 @@ class ActiveRecordDoctor::Tasks::UnindexedForeignKeysTest < ActiveSupport::TestC
   def test_unindexed_foreign_keys_are_reported
     result = run_task
 
-    assert_equal([{ "users" => ["profile_id"] }], result)
+    assert_equal({ "users" => ["profile_id"] }, result)
   end
 
   private

data/test/dummy/db/migrate/20160213101213_create_users.rb

@@ -2,12 +2,17 @@ class CreateUsers < ActiveRecord::Migration
   def change
     create_table :users do |t|
       t.string :email
+      t.string :first_name
+      t.string :last_name
       t.references :profile, foreign_key: true
       t.references :employer, foreign_key: true
       t.string :country_code, null: false
 
       t.timestamps null: false
     end
+    add_index :users, [:last_name, :first_name, :email]
+    add_index :users, [:last_name, :first_name]
+    add_index :users, :last_name
     add_index :users, :email, unique: true
     add_index :users, [:employer_id, :country_code]
   end

data/test/dummy/db/schema.rb

@@ -28,6 +28,8 @@ ActiveRecord::Schema.define(version: 20160213102131) do
 
   create_table "users", force: :cascade do |t|
     t.string   "email"
+    t.string   "first_name"
+    t.string   "last_name"
     t.integer  "profile_id"
     t.integer  "employer_id"
     t.string   "country_code", null: false
@@ -37,5 +39,8 @@ ActiveRecord::Schema.define(version: 20160213102131) do
 
   add_index "users", ["email"], name: "index_users_on_email", unique: true
   add_index "users", ["employer_id", "country_code"], name: "index_users_on_employer_id_and_country_code"
+  add_index "users", ["last_name", "first_name", "email"], name: "index_users_on_last_name_and_first_name_and_email"
+  add_index "users", ["last_name", "first_name"], name: "index_users_on_last_name_and_first_name"
+  add_index "users", ["last_name"], name: "index_users_on_last_name"
 
 end

data/test/dummy/log/development.log

@@ -652,3 +652,308 @@ Migrating to IndexForeignKeysInUsers (20160402143434)
             FROM sqlite_temp_master
             WHERE name='index_users_on_email' AND type='index'
 
+   (30.9ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL) 
+   (0.0ms)  select sqlite_version(*)
+   (35.9ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  ActiveRecord::SchemaMigration Load (0.0ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to CreateUsers (20160213101213)
+   (0.0ms)  begin transaction
+   (0.2ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar, "first_name" varchar, "last_name" varchar, "profile_id" integer, "employer_id" integer, "country_code" varchar NOT NULL, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  CREATE  INDEX "index_users_on_last_name_and_first_name_and_email" ON "users" ("last_name", "first_name", "email")
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)  CREATE  INDEX "index_users_on_last_name_and_first_name" ON "users" ("last_name", "first_name")
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)  CREATE  INDEX "index_users_on_last_name" ON "users" ("last_name")
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)  CREATE UNIQUE INDEX "index_users_on_email" ON "users" ("email")
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)  CREATE  INDEX "index_users_on_employer_id_and_country_code" ON "users" ("employer_id", "country_code")
+  SQL (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20160213101213"]]
+   (28.3ms)  commit transaction
+Migrating to CreateProfiles (20160213101232)
+   (0.1ms)  begin transaction
+   (0.2ms)  CREATE TABLE "profiles" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "first_name" varchar, "last_name" varchar, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+  SQL (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20160213101232"]]
+   (33.6ms)  commit transaction
+Migrating to CreateEmployers (20160213102131)
+   (0.0ms)  begin transaction
+   (0.2ms)  CREATE TABLE "employers" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+  SQL (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20160213102131"]]
+   (19.2ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.0ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_employer_id_and_country_code' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_email' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name' AND type='index'
+
+   (0.0ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_last_name_and_first_name_and_email' AND type='index'
+