foreign_key_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76ab463a1538404e230ac579e9e2c3494ac47f809637bcaddbf36066228f8d2c
+  data.tar.gz: 83c9a1f74842daa7b447269068e177cb74c50a84fe508b05523e5e33a99c6124
+SHA512:
+  metadata.gz: c710144b4e055d92568ec109b1bb3933a3a8db272f213f584e660bed6b3917316ab1b1a2413a970c0b9c29873d7033d3927e4e4197bd6dbdf61e879b0c609f01
+  data.tar.gz: b515941c4d3a970c089cbe853016624c32b5dcfa8a5b33a0a670483b14cb46f0424749aa0d9b6cb829ef99c2ff37ae023f980f42fba8c4869c7b206a6bb8320e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 AnatolyShirykalov
+
+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,37 @@
+# ForeignKeyChecker
+This gem checks `belongs_to` ActiveRecord relations. It finds
+1. Nonpolymorphic relations without a `foreign_key`
+2. records without a record in related table (example: `city_id` is 1000, but there is not city with id 1000)
+3. broken relations: if you try to join such relation (example: `City.joins(:country)`), there is an exception.
+
+## Usage
+```bash
+bundle exec rake foreign_key_check
+```
+
+Or use it inside your application
+```ruby
+ForeignKeyChecker.check.each do |key, result|
+  ...
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foreign_key_checker'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install foreign_key_checker
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'ForeignKeyChecker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/foreign_key_checker/railtie.rb

@@ -0,0 +1,7 @@
+module ForeignKeyChecker
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/foreign_key_checker_tasks.rake'
+    end
+  end
+end

data/lib/foreign_key_checker/version.rb

@@ -0,0 +1,3 @@
+module ForeignKeyChecker
+  VERSION = '0.1.0'
+end

data/lib/foreign_key_checker.rb

@@ -0,0 +1,188 @@
+require "foreign_key_checker/railtie"
+
+module ForeignKeyChecker
+  class Result
+    attr_reader :model, :association
+    def initialize(data)
+      data.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def from_table
+      model.table_name
+    end
+
+    def to_table
+      association.klass.table_name
+    end
+
+    def from_column
+      association.foreign_key
+    end
+
+    def to_column
+      association.klass.primary_key
+    end
+
+    def human_relation
+      "#{from_table} belongs_to #{to_table} (by column #{from_column} to #{to_column})"
+    end
+
+    def message; end
+
+    def inspect
+      "#<#{self.class.name}:#{self.object_id} #{message}>"
+    end
+  end
+
+  class ForeignKeyResult < Result
+    def message
+      "There is no foreign_key for relation #{human_relation}\n"
+    end
+  end
+
+  class IndexResult < Result
+    def message
+      "There is no index for relation #{human_relation}\n"
+    end
+  end
+
+  class ZombieResult < Result
+    attr_reader :zombies, :scope
+    def sql
+      scope.to_sql
+    end
+
+    def delete_sql
+      from_t = model.connection.quote_table_name(from_table)
+      from_c = model.connection.quote_column_name(from_column)
+      to_t = model.connection.quote_table_name(to_table)
+      to_c = model.connection.quote_column_name(to_column)
+      "DELETE #{from_t} FROM #{from_t}.#{from_c} LEFT OUTER JOIN #{to_t} ON #{to_t}.#{to_c} = #{from_t}.#{from_c} WHERE #{to_t}.#{to_c} IS NULL"
+    end
+
+    def message
+      "#{human_relation} with #{zombies} zombies; processed by statement:\n#{sql}\n"
+    end
+  end
+
+  class BrokenRelationResult < Result
+    attr_reader :error
+    def message
+      "#{human_relation} is bloken with error #{error.class.name}: #{error.message}"
+    end
+  end
+  class Checker
+
+    DEFAULT_OPTIONS = {
+      excluded_modules: [],
+      specification_names: ['primary'],
+      foreign_keys: true,
+      indexes: true,
+      zombies: true,
+      polymorphic_zombies: true,
+    }
+
+    DEFAULT_OPTIONS.keys.each { |key| attr_reader key }
+
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+      @options.each do |key, value|
+        if DEFAULT_OPTIONS.has_key?(key)
+          instance_variable_set("@#{key}", value)
+        end
+      end
+      @result = {
+        zombies: [],
+        foreign_keys: [],
+        indexes: [],
+        broken: [],
+      }
+    end
+
+    def specification_names=(value)
+      value.map(&:to_s)
+    end
+
+    def excluded_model?(model)
+      excluded_modules.each do |mod_name|
+        return true if model.to_s.starts_with?(mod_name)
+      end
+      false
+    end
+
+    def excluded_specification?(model)
+      !specification_names.include?(model.connection_specification_name.to_s)
+    end
+
+    def check_polymorphic_bt_association(model, association)
+
+    end
+
+    def check_foreign_key_bt_association(model, association)
+      return if model.name.starts_with?('HABTM_')
+      related = association.klass
+
+      column_name = model.connection.quote_column_name(association.foreign_key)
+      scope = model.left_outer_joins(association.name).where(
+        "#{related.quoted_table_name}.#{related.quoted_primary_key} IS NULL AND #{model.quoted_table_name}.#{column_name} IS NOT NULL"
+      )
+
+      if zombies
+        number = scope.count
+        if number > 0
+          @result[:zombies] << ZombieResult.new(
+            model: model,
+            association: association,
+            scope: scope,
+            zombies: number,
+          )
+        end
+      end
+
+      if foreign_keys && !model.connection.foreign_key_exists?(model.table_name, related.table_name)
+        @result[:foreign_keys] << ForeignKeyResult.new(
+          model: model,
+          association: association
+        )
+      end
+
+      if indexes && !model.connection.index_exists?(model.table_name, association.foreign_key)
+        @result[:indexes] << IndexResult.new(
+          model: model,
+          association: association,
+        )
+      end
+    rescue ActiveRecord::InverseOfAssociationNotFoundError, ActiveRecord::StatementInvalid => error
+      @result[:broken] << BrokenRelationResult.new(
+        model: model,
+        association: association,
+        error: error,
+      )
+    end
+
+    def check
+      Rails.application.eager_load!
+      ActiveRecord::Base.descendants.each do |model|
+        next if excluded_model?(model)
+        next if excluded_specification?(model)
+
+        model.reflect_on_all_associations(:belongs_to).each do |association|
+          if association.options[:polymorphic] && polymorphic_zombies
+            check_polymorphic_bt_association(model, association)
+            next
+          end
+
+          check_foreign_key_bt_association(model, association)
+        end
+      end
+      @result
+    end
+  end
+  class << self
+    def check(options = {})
+      Checker.new(options).check
+    end
+  end
+end

data/lib/tasks/foreign_key_checker_tasks.rake

@@ -0,0 +1,9 @@
+desc "Explaining what the task does"
+task foreign_key_check: :environment do
+  ForeignKeyChecker.check.each do |key, results|
+    puts key if results.any?
+    results.each do |result|
+      puts result.message
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: foreign_key_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AnatolyShirykalov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run task to obtain problems with your database
+email:
+- pipocavsobake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/foreign_key_checker.rb
+- lib/foreign_key_checker/railtie.rb
+- lib/foreign_key_checker/version.rb
+- lib/tasks/foreign_key_checker_tasks.rake
+homepage: https://rubygems.org/foreign_key_checker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Find problems with relations in active_record models
+test_files: []