active_record_doctor 1.5.0 → 1.8.0

data/Rakefile

@@ -1,28 +0,0 @@
-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/compatibility.rb

@@ -1,11 +0,0 @@
-module ActiveRecordDoctor
-  module Compatibility
-    def connection_tables
-      if Rails::VERSION::MAJOR == 5
-        connection.data_sources
-      else
-        connection.tables
-      end
-    end
-  end
-end

data/lib/active_record_doctor/tasks.rb

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

data/lib/active_record_doctor/tasks/undefined_table_references.rb

@@ -1,34 +0,0 @@
-require "active_record_doctor/compatibility"
-require "active_record_doctor/printers/io_printer"
-
-module ActiveRecordDoctor
-  module Tasks
-    class UndefinedTableReferences
-      include Compatibility
-
-      def self.run
-        new.run
-      end
-
-      def initialize(printer: ActiveRecordDoctor::Printers::IOPrinter.new)
-        @printer = printer
-      end
-
-      def run
-        @printer.print_undefined_table_references(undefined_table_references)
-        undefined_table_references.present? ? 1 : 0
-      end
-
-      private
-
-      def undefined_table_references
-        Rails.application.eager_load!
-
-        ActiveRecord::Base.descendants.select do |model|
-          model.table_name.present? &&
-            !model.connection.tables.include?(model.table_name)
-        end
-      end
-    end
-  end
-end

data/lib/active_record_doctor/tasks/unindexed_deleted_at.rb

@@ -1,40 +0,0 @@
-require "active_record_doctor/compatibility"
-require "active_record_doctor/printers/io_printer"
-
-module ActiveRecordDoctor
-  module Tasks
-    class UnindexedDeletedAt
-      include Compatibility
-
-      def self.run
-        new.run
-      end
-
-      def initialize(printer: ActiveRecordDoctor::Printers::IOPrinter.new)
-        @printer = printer
-      end
-
-      def run
-        @printer.print_unindexed_deleted_at(unindexed_deleted_at)
-      end
-
-      private
-
-      def unindexed_deleted_at
-        connection.tables.select do |table|
-          connection.columns(table).map(&:name).include?('deleted_at')
-        end.flat_map do |table|
-          connection.indexes(table).reject do |index|
-            index.where =~ /\bdeleted_at\s+IS\s+NULL\b/i
-          end.map do |index|
-            index.name
-          end
-        end
-      end
-
-      def connection
-        @connection ||= ActiveRecord::Base.connection
-      end
-    end
-  end
-end

data/lib/active_record_doctor/tasks/unindexed_foreign_keys.rb

@@ -1,66 +0,0 @@
-require "active_record_doctor/compatibility"
-require "active_record_doctor/printers/io_printer"
-
-module ActiveRecordDoctor
-  module Tasks
-    class UnindexedForeignKeys
-      include Compatibility
-
-      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
-        hash_from_pairs(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) &&
-                !indexed_as_polymorphic?(table, column)
-            end.map(&:name)
-          ]
-        end.select do |table, columns|
-          !columns.empty?
-        end)
-      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 indexed_as_polymorphic?(table, column)
-        type_column_name = column.name.sub(/_id\Z/, '_type')
-        connection.indexes(table).any? do |index|
-          index.columns == [type_column_name, column.name]
-        end
-      end
-
-      def connection
-        @connection ||= ActiveRecord::Base.connection
-      end
-
-      def hash_from_pairs(pairs)
-        Hash[*pairs.flatten(1)]
-      end
-    end
-  end
-end

data/lib/tasks/active_record_doctor_tasks.rake

@@ -1,27 +0,0 @@
-require "active_record_doctor/tasks/unindexed_foreign_keys"
-require "active_record_doctor/tasks/extraneous_indexes"
-require "active_record_doctor/tasks/missing_foreign_keys"
-require "active_record_doctor/tasks/undefined_table_references"
-require "active_record_doctor/tasks/unindexed_deleted_at"
-
-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
-
-  task :missing_foreign_keys => :environment do
-    ActiveRecordDoctor::Tasks::MissingForeignKeys.run
-  end
-
-  task :undefined_table_references => :environment do
-    exit(ActiveRecordDoctor::Tasks::UndefinedTableReferences.run)
-  end
-
-  task :unindexed_soft_delete => :environment do
-    ActiveRecordDoctor::Tasks::UnindexedDeletedAt.run
-  end
-end

data/test/active_record_doctor/tasks/extraneous_indexes_test.rb

@@ -1,27 +0,0 @@
-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(
-      [
-        ["index_employers_on_id", [:primary_key, "employers"]],
-        ["index_users_on_last_name", [:multi_column, "index_users_on_last_name_and_first_name_and_email", "unique_index_on_users_last_name_and_first_name"]],
-        ["index_users_on_last_name_and_first_name", [:multi_column, "index_users_on_last_name_and_first_name_and_email", "unique_index_on_users_last_name_and_first_name"]],
-        ["index_users_on_email", [:multi_column, "unique_index_on_users_email"]],
-      ].sort,
-      result.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/missing_foreign_keys_test.rb

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

data/test/active_record_doctor/tasks/undefined_table_references_test.rb

@@ -1,19 +0,0 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/undefined_table_references'
-
-class ActiveRecordDoctor::Tasks::UndefinedTableReferencesTest < ActiveSupport::TestCase
-  def test_undefined_table_references_are_reported
-    result = run_task
-
-    assert_equal([Contract], result)
-  end
-
-  private
-
-  def run_task
-    printer = SpyPrinter.new
-    ActiveRecordDoctor::Tasks::UndefinedTableReferences.new(printer: printer).run
-    printer.undefined_table_references
-  end
-end

data/test/active_record_doctor/tasks/unindexed_deleted_at_test.rb

@@ -1,19 +0,0 @@
-require 'test_helper'
-
-require 'active_record_doctor/tasks/unindexed_deleted_at'
-
-class ActiveRecordDoctor::Tasks::UnindexedDeletedAtTest < ActiveSupport::TestCase
-  def test_unindexed_deleted_at_are_reported
-    result = run_task
-
-    assert_equal(['index_profiles_on_first_name_and_last_name'], result)
-  end
-
-  private
-
-  def run_task
-    printer = SpyPrinter.new
-    ActiveRecordDoctor::Tasks::UnindexedDeletedAt.new(printer: printer).run
-    printer.unindexed_deleted_at
-  end
-end

data/test/active_record_doctor/tasks/unindexed_foreign_keys_test.rb

@@ -1,19 +0,0 @@
-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

@@ -1,28 +0,0 @@
-== 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

@@ -1,6 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-// 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

@@ -1,15 +0,0 @@
-/*
- * 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

@@ -1,5 +0,0 @@
-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

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

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

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.table_name = nil
-end

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

@@ -1,3 +0,0 @@
-class Comment < ActiveRecord::Base
-  belongs_to :commentable, polymorphic: true
-end

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

@@ -1,3 +0,0 @@
-class Contract < ApplicationRecord
-  self.table_name = 'contract_records'
-end

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

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

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

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

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

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