active_record_doctor 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d57d331fcbdfdc3db39937880f3828ef85f03c62
+  data.tar.gz: a7ae1374e2328bc93997d9adec3dece14a5db7fd
+SHA512:
+  metadata.gz: 2410d9d14530b7fffa606263a86d2158a2c5e0d20487c90cfd265b998c179b22044c9dee1177f22fcca9d3e117539332b7dc0bcc8c8c733a798437e1e125bdd4
+  data.tar.gz: 5f30d3ad0e739b262985129e5870ee3af08d212e2124db87dbe03e2d3670b14c8726805d9db0a55782ff30d9f783e30f3a76f11dcbae56de7574dad8c0511281

data/README.rdoc

@@ -0,0 +1,48 @@
+= 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!
+
+{<img src="https://travis-ci.org/gregnavis/active_record_doctor.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/gregnavis/active_record_doctor]
+
+== Installation
+
+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'
+
+Then run:
+
+  bundle install
+
+== Usage
+
+=== Indexing Unindexed Foreign Keys
+
+Foreign keys should be indexed unless it's proven ineffective. However, Rails
+makes it easy to create an unindexed foreign key. Active Record Doctor can
+automatically generate database migrations that add the missing indexes. It's a
+three-step process:
+
+1. Generate a list of unindexed foreign keys by running
+
+     rake active_record_doctor:unindexed_foreign_keys > unindexed_foreign_keys.txt
+
+2. Remove columns that should _not_ be indexed from +unindexed_foreign_keys.txt+
+   as a column can look like a foreign key (i.e. end with +_id+) without being
+   one.
+
+3. Generate the migrations
+
+     rails generate active_record_doctor:add_indexes unindexed_foreign_keys.txt
+
+4. Run the migrations
+
+     rake db:migrate
+
+== Author
+
+This gem is developed and maintained by {Greg Navis}[http://www.gregnavis.com].

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordDoctor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_record_doctor.rb

@@ -0,0 +1,4 @@
+require "active_record_doctor/railtie" if defined?(Rails)
+
+module ActiveRecordDoctor
+end

data/lib/active_record_doctor/printers.rb

@@ -0,0 +1,4 @@
+module ActiveRecordDoctor
+  module Printers
+  end
+end

data/lib/active_record_doctor/printers/io_printer.rb

@@ -0,0 +1,15 @@
+module ActiveRecordDoctor
+  module Printers
+    class IOPrinter
+      def initialize(io: STDOUT)
+        @io = io
+      end
+
+      def print_unindexed_foreign_keys(unindexed_foreign_keys)
+        @io.puts(unindexed_foreign_keys.sort.map do |table, columns|
+          "#{table} #{columns.sort.join(' ')}"
+        end.join("\n"))
+      end
+    end
+  end
+end

data/lib/active_record_doctor/railtie.rb

@@ -0,0 +1,7 @@
+module ActiveRecordDoctor
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/active_record_doctor_tasks.rake"
+    end
+  end
+end

data/lib/active_record_doctor/tasks.rb

@@ -0,0 +1,4 @@
+module ActiveRecordDoctor
+  module Tasks
+  end
+end

data/lib/active_record_doctor/tasks/unindexed_foreign_keys.rb

@@ -0,0 +1,50 @@
+require "active_record_doctor/printers/io_printer"
+
+module ActiveRecordDoctor
+  module Tasks
+    class UnindexedForeignKeys
+      def self.run
+        new.run
+      end
+
+      def initialize(printer: ActiveRecordDoctor::Printers::IOPrinter.new)
+        @printer = printer
+      end
+
+      def run
+        @printer.print_unindexed_foreign_keys(unindexed_foreign_keys)
+      end
+
+      private
+
+      def unindexed_foreign_keys
+        connection.tables.select do |table|
+          "schema_migrations" != table
+        end.map do |table|
+          [
+            table,
+            connection.columns(table).select do |column|
+              foreign_key?(table, column) && !indexed?(table, column)
+            end.map(&:name)
+          ]
+        end.select do |table, columns|
+          !columns.empty?
+        end.to_h
+      end
+
+      def foreign_key?(table, column)
+        column.name.end_with?("_id")
+      end
+
+      def indexed?(table, column)
+        connection.indexes(table).any? do |index|
+          index.columns.first == column.name
+        end
+      end
+
+      def connection
+        @connection ||= ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/active_record_doctor/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordDoctor
+  VERSION = "1.0.1"
+end

data/lib/generators/active_record_doctor/add_indexes/USAGE

@@ -0,0 +1,2 @@
+Usage:
+  rails generate active_record_doctor:add_indexes PATH

data/lib/generators/active_record_doctor/add_indexes/add_indexes_generator.rb

@@ -0,0 +1,48 @@
+module ActiveRecordDoctor
+  class AddIndexesGenerator < Rails::Generators::Base
+    MigrationDescription = Struct.new(:table, :columns)
+
+    desc 'Generate migrations for the specified indexes'
+    argument :path, type: :string, default: nil, banner: 'PATH'
+
+    def create_migrations
+      migration_descriptions = read_migration_descriptions(path)
+      now = Time.now
+
+      migration_descriptions.each_with_index do |migration_description, index|
+        timestamp = (now + index).strftime("%Y%m%d%H%M%S")
+        file_name = "db/migrate/#{timestamp}_index_foreign_keys_in_#{migration_description.table}.rb"
+        create_file(file_name, content(migration_description))
+      end
+    end
+
+    private
+
+    def read_migration_descriptions(path)
+      File.readlines(path).map do |line|
+        table, *columns = line.split(" ")
+        MigrationDescription.new(table, columns)
+      end
+    end
+
+    def content(migration_description)
+      <<EOF
+class IndexForeignKeysIn#{migration_description.table.camelize} < ActiveRecord::Migration
+  def change
+#{add_indexes(migration_description)}
+  end
+end
+EOF
+    end
+
+    def add_indexes(migration_description)
+      migration_description.columns.map do |column|
+        add_index(migration_description.table, column)
+      end.join("\n")
+    end
+
+    def add_index(table, column)
+      "    add_index :#{table}, :#{column}"
+    end
+  end
+end

data/lib/tasks/active_record_doctor_tasks.rake

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

data/test/active_record_doctor/printers/io_printer_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+require 'active_record_doctor/printers/io_printer'
+
+class ActiveRecordDoctor::Printers::IOPrinterTest < ActiveSupport::TestCase
+  def test_print_unindexed_foreign_keys
+    assert_equal(<<EOF, print_unindexed_foreign_keys({ "users" => ["profile_id", "account_id"], "account" => ["group_id"] }))
+account group_id
+users account_id profile_id
+EOF
+  end
+
+  private
+
+  def print_unindexed_foreign_keys(argument)
+    io = StringIO.new
+    ActiveRecordDoctor::Printers::IOPrinter.new(io: io).print_unindexed_foreign_keys(argument)
+    io.string
+  end
+end

data/test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+require 'active_record_doctor/tasks/unindexed_foreign_keys'
+ 
+class ActiveRecordDoctor::Tasks::UnindexedForeignKeysTest < ActiveSupport::TestCase
+  def test_unindexed_foreign_keys_are_reported
+    result = run_task
+
+    assert_equal([{ "users" => ["profile_id"] }], result)
+  end
+
+  private
+
+  def run_task
+    printer = SpyPrinter.new
+    ActiveRecordDoctor::Tasks::UnindexedForeignKeys.new(printer: printer).run
+    printer.unindexed_foreign_keys
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/employer.rb

@@ -0,0 +1,2 @@
+class Employer < ActiveRecord::Base
+end

data/test/dummy/app/models/profile.rb

@@ -0,0 +1,2 @@
+class Profile < ActiveRecord::Base
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  belongs_to :profile
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end