indexter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 911b90dad0000c96346c793a439a2fd6859e5163
+  data.tar.gz: 2b931a04a985f947c75e69abbfd8d68004314532
+SHA512:
+  metadata.gz: b3acabd76bfbd893a548cc5bb71da4fb7705bcc7093ad7856956c3c2b4fe6ea157e567ed0cfe5e76cc565f4906bd080404045adea9a9d2798f824364b7cb88ed
+  data.tar.gz: 5b755cdb57f2c4078c3e4e3d3ec006aa60d9dbc6ba6a6e1bb546f532d4fa8f6c9c30547f18c06962b64299f8007b29efeb3932269ca97f2e608fadb1a60c1228

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+indexter-*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at chris@unbounce.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Cummer
+
+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,130 @@
+<p align='center'>
+  <img src='assets/inDexter_logo.jpg' width="600" height="186" alt="inDexter logo" title="inDexter" />
+</p>
+
+A gem for discovering foreign key indexes that may be missing from your Rails project.
+
+### Example
+
+Given a Rails table like so:
+
+```
+ActiveRecord::Schema.define do
+  create_table :addresses, :force => true do |t|
+    t.string :street
+    ...
+    t.integer :user_id
+    t.integer :property_id
+  end
+
+  add_index :addresses, :user_id
+end
+```
+
+By default, **inDexter** will return a hash:
+
+```
+{:suffixes=>["_id", "_uuid"], :exclusions=>["schema_migrations"], :missing=>{"addresses" => ["property_id"]}}
+```
+
+which indicated that you that you might want to add an index on table `addresses` for the `property_id` column.
+
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'indexter'
+```
+
+2. And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install indexter
+    
+## Configuration
+Indexter is configured by creating an `.indexter.yaml` file in the root directory of your project (at the same level as your `.gitignore` and `.ruby-version` file). 
+
+Into this file you define the output format, the tables to be excluded from analysis, and the extensions the denote the columns you want to analyze.
+
+### format
+The output format the results of the analysis should be displayed in. See **Formatters**, below, for more details.
+
+### exclusions
+A list of the tables you *do not* want to analyze.
+
+### suffixes
+A list of the column extensions that define which columns should probably be indexed.
+
+### Example
+
+```
+format: table
+exclusions:
+  - table: default_companies
+  - table: schema_migrations
+  - table: taggings
+suffixes:
+  - _id
+  - _uuid
+```
+
+Indexter provides a convenience rake task for viewing your `.indexter.yaml` config file:
+
+```
+rake indexter:config
+```
+
+## Usage
+
+### Rails Console
+
+```
+$ rails c
+irb(main):001:0> Indexter.validate
+=> {:suffixes=>["_id", "_uuid"], :exclusions=>["schema_migrations"], :missing=>{}}
+```
+In that example the project has no missing indexes.
+
+```
+$ rails c
+irb(main):001:0> Indexter.validate
+=> {:suffixes=>["_id", "_uuid"], :exclusions=>["schema_migrations"], :missing=>{"users"=>["active_company_id"]}}
+```
+In that example the `users` table is missing an index on `active_company_id`.
+
+### Rake Task
+
+```
+$ bundle exec rake indexter:validate
+{:suffixes=>["_id", "_uuid"], :exclusions=>["schema_migrations"], :missing=>{}}
+```
+In that example the project has no missing indexes.
+
+```
+$ bundle exec rake indexter:validate
+{:suffixes=>["_id", "_uuid"], :exclusions=>["schema_migrations"], :missing=>{"users"=>["active_company_id"]}}
+```
+In that example the `users` table is missing an index on `active_company_id`.
+
+## Formatters
+
+Out of the box, inDexter returns a Ruby hash of the results. But maybe that's not what you want? Fortunately inDexter also provides a number of additional formatting options:
+
+* `hash`: the default option, returns a Ruby hash
+* `json`: renders the output as a JSON string
+* `pass_fail`: like a Unix process, returns 0 if no missing index, `n` if missing indexes, where `n` is the number of missing indexes
+* `table`: renders the output as an ASCII-art table
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [Github: inDexter](https://github.com/senorprogrammer/indexter). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "indexter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/indexter.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'indexter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "indexter"
+  spec.version       = Indexter::VERSION
+  spec.authors       = ["Chris Cummer"]
+  spec.email         = ["chriscummer@me.com"]
+
+  spec.summary       = %q{Checks databases tables for indexes on foreign keys.}
+  spec.homepage      = "https://github.com/senorprogrammer/indexter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Production dependencies
+  spec.add_dependency "activerecord"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "terminal-table"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/lib/indexter/config.rb

@@ -0,0 +1,60 @@
+# Indexter::Config
+#
+# Two ways to provide configuration information:
+#
+# 1. Pass a path to a YAML file in the constructor
+# 2. Create a .indexter.yaml file in the root of the project directory,
+#    and Indexter::Config will find it automatically
+#
+# Note that if you have a .indexter.yaml file _and_ you pass in a file
+# path, the file path will trump the default file and over-ride it.
+#
+require 'yaml'
+
+module Indexter
+  class Config
+    attr_reader :config_file_path, :format, :exclusions, :suffixes
+
+    DEFAULT_CONFIG_FILE = './.indexter.yaml'.freeze
+
+    def initialize(config_file_path: DEFAULT_CONFIG_FILE)
+      @config_file_path = config_file_path
+      configure if exists?
+    end
+
+    def exists?
+      File.exists?(config_file_path)
+    end
+
+    def to_yaml
+      @data.to_yaml
+    end
+
+    private
+
+      def configure
+        @data = YAML.load_stream(File.read(config_file_path))
+        return unless @data.any?
+
+        load_format(@data)
+        load_exclusions(@data)
+        load_suffixes(@data)
+      end
+
+      def load_format(data)
+        @format = data.first.fetch('format', nil)
+      end
+
+      def load_exclusions(data)
+        @exclusions = data.first.fetch('exclusions', []).inject({}) do |acc, hash| 
+          acc[hash['table']] = hash.fetch('columns', [])
+          acc
+        end
+      end
+
+      def load_suffixes(data)
+        @suffixes = data.first.fetch('suffixes', [])
+      end
+
+  end
+end

data/lib/indexter/formatters/hash.rb

@@ -0,0 +1,11 @@
+module Indexter
+  module Formatters
+    class Hash
+
+      def format(payload)
+        payload
+      end
+
+    end
+  end
+end

data/lib/indexter/formatters/json.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module Indexter
+  module Formatters
+    class Json
+
+      def format(payload)
+        payload.to_json
+      end
+
+    end
+  end
+end

data/lib/indexter/formatters/pass_fail.rb

@@ -0,0 +1,16 @@
+module Indexter
+  module Formatters
+    class PassFail
+
+      # Returns like a Unix process:
+      #
+      # - 0 : successful, no missing indexes
+      # - n : failure, returns the number of missing indexes
+      #
+      def format(payload)
+        payload.fetch(:missing, {}).flatten.count
+      end
+
+    end
+  end
+end

data/lib/indexter/formatters/table.rb

@@ -0,0 +1,24 @@
+require 'rainbow/ext/string'
+require 'terminal-table'
+
+module Indexter
+  module Formatters
+    class Table
+
+      def format(payload)
+        missing = payload.fetch(:missing, {})
+
+        rows = missing.inject([]) do |acc, (db_table, columns)|
+          acc << [db_table, columns.join("\n")]
+          acc << :separator
+          acc
+        end
+
+        headings = ['Table', 'Column'].map { |col| col.color(:blue).bright }
+
+        Terminal::Table.new(headings: headings, rows: rows).to_s
+      end
+
+    end
+  end
+end

data/lib/indexter/null_config.rb

@@ -0,0 +1,5 @@
+class NullConfig
+  def format; nil; end
+  def exclusions; nil; end
+  def suffixes; nil; end
+end

data/lib/indexter/railtie.rb

@@ -0,0 +1,26 @@
+require 'indexter'
+require 'rails'
+
+module Indexter
+  class Railtie < Rails::Railtie
+    railtie_name :indexter
+
+    rake_tasks do
+      namespace :indexter do
+        desc "Checks the database for missing foreign key indexes"
+        task :validate => :environment do |t, args|
+          config = Indexter::Config.new
+          puts Indexter::Validator.new(config: config).validate
+        end
+
+        task :config do |t, args|
+          config = Indexter::Config.new
+          puts config.to_yaml
+        end
+      end
+
+      task indexter: ['indexter:validate', 'indexter:config']
+    end
+
+  end
+end

data/lib/indexter/validator.rb

@@ -0,0 +1,85 @@
+require 'active_record'
+
+module Indexter
+  class Validator
+    attr_reader :exclusions, :formatter, :results, :suffixes 
+
+    DEFAULT_FORMATTER  = 'hash'
+    DEFAULT_EXCLUSIONS = { 'schema_migrations' => [] }.freeze
+    DEFAULT_SUFFIXES   = ['_id', '_uuid'].freeze
+
+    # -------------------- Instance Methods --------------------
+
+    def initialize(config: nil)
+      configure(config)
+    end
+
+    def validate
+      missing = missing_indexes(tables)
+      output  = build_results(missing)
+
+      results = formatter.new.format(output)
+    end
+
+    private
+
+      def configure(config)
+        config = config || NullConfig.new
+
+        format      = config.format     || DEFAULT_FORMATTER
+        @formatter  = find_formatter(format: format)
+
+        @exclusions = config.exclusions || DEFAULT_EXCLUSIONS
+        @suffixes   = config.suffixes   || DEFAULT_SUFFIXES
+      end
+
+      def find_formatter(format: nil)
+        format     = format || DEFAULT_FORMATTER
+        klass_name = "Indexter::Formatters::#{format.to_s.camelize}"
+        klass      = klass_name.constantize
+      rescue NameError
+        # If an un-known formatter is passed here, fall back to the hash
+        Indexter::Formatters::Hash
+      end
+
+      def missing_indexes(tbls)
+        # Check the intersection between what we expect to have indexes on and what we actually have
+        # indexes on. If the set is not empty, we might be missing an index
+        result = tbls.inject({}) do |acc, table|
+          acc[table] = (id_columns(table) - indexes(table))
+          acc
+        end
+
+        # Reject any tables that have empty results
+        result.delete_if { |_, missing| missing.empty? }
+      end
+
+      # Returns a list of all the tables in the database that are analysable
+      def tables
+        func = ActiveRecord::Base.connection.respond_to?(:data_sources) ? :data_sources : :tables
+        ActiveRecord::Base.connection.send(func) - @exclusions.keys
+      end
+
+      # These are the columns we expect to have an index on that end in COL_SUFFIX
+      def id_columns(table)
+        ActiveRecord::Base.connection.columns(table).select do |column|
+          column.name.end_with? *@suffixes
+        end.map(&:name)
+      end
+
+      # These are the columns we have indexes on that also end in COL_SUFFIX
+      def indexes(table)
+        ActiveRecord::Base.connection.indexes(table).map do |idx_def|
+          idx_def.columns.select { |col| col.end_with? *@suffixes }
+        end.flatten
+      end
+
+      def build_results(missing)
+        {
+          suffixes:   @suffixes,
+          exclusions: @exclusions,
+          missing:    missing
+        }
+      end
+  end
+end

data/lib/indexter/version.rb

@@ -0,0 +1,3 @@
+module Indexter
+  VERSION = "1.0.0"
+end

data/lib/indexter.rb

@@ -0,0 +1,21 @@
+require 'indexter/config'
+require 'indexter/null_config'
+require 'indexter/railtie' if defined?(Rails)
+require 'indexter/validator'
+require 'indexter/version'
+
+require 'indexter/formatters/hash'
+require 'indexter/formatters/json'
+require 'indexter/formatters/pass_fail'
+require 'indexter/formatters/table'
+
+module Indexter
+  extend self
+
+  def validate(config_file_path: Indexter::Config::DEFAULT_CONFIG_FILE)
+    config = Indexter::Config.new(config_file_path: config_file_path)
+    val    = Indexter::Validator.new(config: config)
+
+    val.validate
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: indexter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Cummer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- chriscummer@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/inDexter_logo.jpg
+- assets/inDexter_logo.pxm
+- bin/console
+- bin/setup
+- indexter.gemspec
+- lib/indexter.rb
+- lib/indexter/config.rb
+- lib/indexter/formatters/hash.rb
+- lib/indexter/formatters/json.rb
+- lib/indexter/formatters/pass_fail.rb
+- lib/indexter/formatters/table.rb
+- lib/indexter/null_config.rb
+- lib/indexter/railtie.rb
+- lib/indexter/validator.rb
+- lib/indexter/version.rb
+homepage: https://github.com/senorprogrammer/indexter
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Checks databases tables for indexes on foreign keys.
+test_files: []