unique_validation_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8d22a62608548622ce222589c6916de85df638f
+  data.tar.gz: 334955c619c2d49aba3f11abac0d3c23c00e3833
+SHA512:
+  metadata.gz: 7c9cb2a3b3985708c5ad6dc1c93e1d5a7e952cd3563b24f20ac696713cc9a749a3085b865b1a0f5bc413ebe2f90024f722969020b47664e6482c566b050f1e49
+  data.tar.gz: e7d7a8e3db130b5c994089327623e6515d641b39f19a4e3754fc045ff7be82610a45f6a6713c71d6797deed07b01ea593dffcef2ebaaaf8477ff6ed84aa177d3

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# OS X
+.DS_Store

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in unique_validation_inspector.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Igor Khomenko
+
+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,67 @@
+# UniqueValidationInspector
+
+![build passing](https://travis-ci.org/soulfly/unique_validation_inspector.svg?branch=master)
+
+A Rake task that helps you find unique validations in models that do not have proper DB indexes.
+
+If uniqueness validation is enabled, Rails will look for existing records before performing **Model.create**, **Model.save**, **Model.update** ... operations. If a record was found the validation fails and the transaction will be rolled back, if not the record will be saved.
+
+For example, you have **User** model and uniqueness validation for **facebook_id** field. The following SQL query will be performed on validation:
+
+```sql
+ SELECT  1 AS one FROM `users` WHERE (`users`.`facebook_id ` = 1523123128921623) LIMIT 1
+```
+If you do not have DB index for **facebook_id** field then your **Model.create**, **Model.save**, **Model.update** ... operations will be slower and slower with user base grow. 
+
+So this gem is here to notify you about it.
+
+Read [How I Reduced my DB Server Load by 80%](https://schneems.com/2017/07/18/how-i-reduced-my-db-server-load-by-80/) article to understand what kind of performance issues you may have without proper indexes.
+
+## Supported versions
+* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5 (trunk)
+
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x, 5.0.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unique_validation_inspector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unique_validation_inspector
+
+## Usage
+
+Just run the following command in your Rails app directory:
+
+    $ rake inspect_unique_validations
+
+## Output
+
+```bash
+You have the following unique validations:
+
+Model 'Application':
+[:title] (scope 'account_id'). Index exists: false
+
+Model 'User':
+[:email] (scope 'application_id'). Index exists: true
+[:login] (scope 'application_id'). Index exists: false
+[:facebook_id] (scope 'application_id'). Index exists: true
+[:twitter_id] (scope 'application_id'). Index exists: false
+[:external_user_id] (scope 'application_id'). Index exists: false
+[:blob_id] (scope ''). Index exists: true
+```
+All things with **Index exists: false** are problematic and you should fix it by adding proper DB indexes.
+
+## Copyright
+
+Copyright © 2017 Igor Khomenko. See LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unique_validation_inspector"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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/lib/tasks/inspect_unique_validations.rake

@@ -0,0 +1,23 @@
+desc 'Finds unique validations in models that do not have DB indexes.'
+task :inspect_unique_validations => :environment do
+  inspector = UniqueValidationInspector::Inspector.new Rails.application
+
+  defined_unique_validations = inspector.defined_unique_validations
+
+  puts
+  puts "You have the following unique validations:"
+
+  defined_unique_validations.each do |item|
+    model = item[:model]
+    puts
+    puts "Model '#{model.name}':"
+    item[:validators].each do |validation|
+      scope = validation.options[:scope]
+      attributes = validation.attributes
+      index_exists = inspector.defined_unique_indexes(model.table_name, attributes, scope)
+      puts "#{attributes} (scope '#{scope}'). Index exists: #{index_exists}"
+    end
+  end
+  puts
+
+end

data/lib/unique_validation_inspector/version.rb

@@ -0,0 +1,3 @@
+module UniqueValidationInspector
+  VERSION = "0.1.0"
+end

data/lib/unique_validation_inspector.rb

@@ -0,0 +1,38 @@
+require "unique_validation_inspector/version"
+
+module UniqueValidationInspector
+  class Inspector
+    VERSION = UniqueValidationInspector::VERSION
+
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load File.join(File.dirname(__FILE__), 'tasks/inspect_unique_validations.rake')
+      end
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def defined_unique_validations
+      ActiveRecord::Base.descendants.reject do |model|
+        validators = model.validators.select {|v| v.is_a?(ActiveRecord::Validations::UniquenessValidator) }
+        validators.empty?
+      end.collect do |model|
+        validators = model.validators.select {|v| v.is_a?(ActiveRecord::Validations::UniquenessValidator) }
+        {:model => model,  :validators => validators}
+      end
+
+    end
+
+    def defined_unique_indexes(table_name, fields, scope)
+      #https://dev.mysql.com/doc/refman/5.7/en/multiple-column-indexes.html
+
+      columns = []
+      columns += fields
+      columns.unshift(scope) if scope
+      ActiveRecord::Base.connection.indexes(table_name.to_sym).any? { |i| [lambda { |i| i.columns == columns.map(&:to_s) }].all? { |check| check[i] } }
+    end
+
+  end
+end

data/unique_validation_inspector.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "unique_validation_inspector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_validation_inspector"
+  spec.version       = UniqueValidationInspector::VERSION
+  spec.authors       = ["Igor Khomenko"]
+  spec.email         = ["igor@quickblox.com"]
+
+  spec.summary       = "A Rake task that helps you find unique validations in models that do not have DB indexes."
+  spec.description   = "A Rake task investigates the application's models definition, then tells you unique validations that do not have DB indexes."
+  spec.homepage      = "https://igor.io"
+  spec.license       = 'MIT'
+
+  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"]
+
+  spec.add_dependency "rails", ['>= 3.0.0']
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord", ['>= 3.0.0']
+  spec.add_development_dependency "sqlite3", "~> 1.3.13"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: unique_validation_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Khomenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+description: A Rake task investigates the application's models definition, then tells
+  you unique validations that do not have DB indexes.
+email:
+- igor@quickblox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tasks/inspect_unique_validations.rake
+- lib/unique_validation_inspector.rb
+- lib/unique_validation_inspector/version.rb
+- unique_validation_inspector.gemspec
+homepage: https://igor.io
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A Rake task that helps you find unique validations in models that do not
+  have DB indexes.
+test_files: []