traceindex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1976ad785be5c111087d12387e9a84df779ec397bc278e3824c9fdf66343140
+  data.tar.gz: 9585e24b1aff78526e791572ae31401ed47dbb243aae0a4044657bc9263a5753
+SHA512:
+  metadata.gz: b7af461287ee4ab0e7c95ef037b618082603a539ba55057b60f0728bea43635fe6c40388553c7c04796d138caecca37d9fa0eac15b5e550cb2faf236d864bba1
+  data.tar.gz: 9f51f3ae65db56ef36c5cc2b1d616fa48c9e5cc7e3a71af1ca06dcceb5ab58837cd2cabcd87278cecbd525a6da6f8b0c01035610b178cad39b0ed9b48c44140f

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.log
+spec/database.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in traceroute.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Akira Kusumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# traceindex
+
+A Rake task that helps you find missing indexes in your Rails app.
+
+## Install
+
+Put this line in your Gemfile:
+```
+gem 'traceindex'
+```
+
+Then bundle:
+```
+% bundle
+```
+
+
+## Usage
+
+Just run the following command in your Rails app directory.
+
+```
+% rake traceindex
+```
+
+If you want the rake task to fail when errors are found.
+
+```
+% FAIL_ON_ERROR=1 rake traceindex
+```
+
+## How do I tell it to ignore columns?
+
+Create a .traceindex.yaml or .traceindex.yml file in your root directory.
+
+```yaml
+ignore_columns:
+  - users.created_user_id
+ignore_models:
+  - ActiveStorage::Blob
+  - ActiveStorage::Attachment
+  - ActionText::RichText
+  - ActionMailbox::InboundEmail
+```
+
+## Copyright
+
+Copyright (c) 2020 Akira Kusumoto. See MIT-LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tasks/traceindex.rake

@@ -0,0 +1,12 @@
+desc 'Prints out missing indexes'
+task traceindex: :environment do
+  traceindex   = Traceindex.new(Rails.application)
+  column_names = traceindex.missing_index_column_names
+
+  if column_names.size > 0
+    puts "Missing index columns (#{column_names.size}):"
+    column_names.each { |column| puts "  #{column}" }
+
+    raise 'Missing indexes detected.' if ENV['FAIL_ON_ERROR']
+  end
+end

data/lib/traceindex.rb

@@ -0,0 +1,62 @@
+class Traceindex
+  VERSION = Gem.loaded_specs['traceindex'].version.to_s
+
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "tasks/traceindex.rake")
+    end
+  end
+
+  def initialize(app)
+    @app            = app
+    @ignore_models  = []
+    @ignore_columns = []
+
+    (config["ignore_models"] || []).each do |ignored_model|
+      @ignore_models << ignored_model
+    end
+
+    (config["ignore_columns"] || []).each do |ignored_column|
+      @ignore_columns << ignored_column
+    end
+  end
+
+  def missing_index_column_names
+    models.each.with_object([]) do |model, missing_index_columns|
+      id_columns = model.columns.select {|column| column.name.end_with?("_id") }
+
+      indexes = ActiveRecord::Base.connection.indexes(model.table_name)
+
+      id_columns.each do |id_column|
+        if @ignore_columns.include?("#{model.table_name}.#{id_column.name}")
+          next
+        end
+
+        next unless indexes.none? {|index| index.columns.first == id_column.name }
+
+        missing_index_columns << "#{model.table_name}.#{id_column.name}"
+      end
+    rescue => e
+      puts e.message
+    end
+  end
+
+  private
+
+  def config_filename
+    %w[.traceindex.yaml .traceindex.yml].detect {|f| File.exist?(f) }
+  end
+
+  def config
+    @config ||= config_filename ? YAML.load_file(config_filename) : {}
+  end
+
+  def models
+    return @models if @models
+
+    @app.eager_load!
+    @models ||= ActiveRecord::Base.descendants.reject(&:abstract_class).reject do |model|
+      @ignore_models.include?(model.name)
+    end
+  end
+end

data/spec/app.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails/all'
+require 'action_controller/railtie'
+
+require 'traceindex'
+
+module DummyApp
+  class Application < Rails::Application
+    config.root = File.expand_path(__dir__)
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  YAML.load(File.read('spec/database.yml'))['test']
+)
+
+ActiveRecord::Schema.define version: 0 do
+  create_table :users, force: true do |t|
+    t.integer :created_user_id, index: true
+    t.integer :updated_user_id, index: false
+  end
+end
+
+class User < ActiveRecord::Base
+end

data/spec/database.yml.sample

@@ -0,0 +1,15 @@
+default: &default
+  adapter: mysql2
+  encoding: utf8
+  pool: 5
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+
+development:
+  <<: *default
+  database: traceindex_development
+
+test:
+  <<: *default
+  database: traceindex_test

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'pry'
+require 'rails'
+require 'traceindex'
+require_relative 'app'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/traceroute_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Traceindex do
+  it 'has a version number' do
+    expect(Traceindex::VERSION).not_to be nil
+  end
+
+  describe '#missing_index_column_names' do
+    it 'missing index found.' do
+      traceindex = Traceindex.new(Rails.application)
+      expect(traceindex.missing_index_column_names).to eq(['users.updated_user_id'])
+    end
+
+    context 'If you have a configuration file' do
+      before do
+        File.open '.traceindex.yml', 'w' do |file|
+          file.puts 'ignore_columns:'
+          file.puts '  - users.updated_user_id'
+          file.puts 'ignore_models:'
+          file.puts '  - User'
+        end
+      end
+
+      after do
+        File.delete '.traceindex.yml'
+      end
+
+      it 'missing index not found.' do
+        traceindex = Traceindex.new(Rails.application)
+        expect(traceindex.missing_index_column_names).to eq([])
+      end
+    end
+  end
+end

data/traceindex.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'traceindex'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Akira Kusumoto']
+  s.email       = ['akirakusumo10@gmail.com']
+  s.homepage    = 'https://github.com/bluerabbit/traceindex'
+  s.summary     = 'A Rake task that helps you find the missing indexes for your Rails app'
+  s.description = "This Rake task investigates the application's tables definition, then tells you missing indexes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 4.0.0']
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rspec', '~> 3.9'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: traceindex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Kusumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: This Rake task investigates the application's tables definition, then
+  tells you missing indexes
+email:
+- akirakusumo10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/traceindex.rake
+- lib/traceindex.rb
+- spec/app.rb
+- spec/database.yml.sample
+- spec/spec_helper.rb
+- spec/traceroute_spec.rb
+- traceindex.gemspec
+homepage: https://github.com/bluerabbit/traceindex
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rake task that helps you find the missing indexes for your Rails app
+test_files:
+- spec/app.rb
+- spec/database.yml.sample
+- spec/spec_helper.rb
+- spec/traceroute_spec.rb