foreign_key_checker 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932660f1dc1e1054ce608b324b8eb2b9dda2f3200b9339106677d7ebf1297b87
-  data.tar.gz: bf7e22d072393fafe2b3bd65639150448886efd3c5cdd95a3a4617cd4a99023f
+  metadata.gz: b355b8130d2225136101b32202f457ee9615c33621730fa693fcbcb969af3fcf
+  data.tar.gz: ee8b977be65abc39da0914c804f612bb2fb2a33a98a46c922eedde3866147da1
 SHA512:
-  metadata.gz: 2280e4cff60369551661dc1999d11cdfa8c87b994f68360b6c09c05c2acb7619282f4435d0272ef6b2205b56553d14cc401410dd13d05eb1fdb2f224aff07ff5
-  data.tar.gz: 1fbe7b6fd37d6f97f75c485085c81121213e4a9b450fc8aba300deaabb09f43cdea41899cf6292d4365360be0cd61f327e5415554bf1e5775d28915cba43571d
+  metadata.gz: 8f34d020417ddcaefc15a6faec34ffb495f6383157104b660f28013f85a57d8a390cee15c47613ffed64a884ffc581c4c0c5557c97a36d9e2fadf0ff54021d7a
+  data.tar.gz: a4b0f8032dc6adc78f4780c7c939acc661bb2e9dde713cddee43a5080f59e2882a1433550964f26abb4120491752a83e596f5cc37821561c6ba118cd52f2ad16

data/README.md

@@ -5,6 +5,13 @@ This gem checks `belongs_to` ActiveRecord relations. It finds
 3. broken relations: if you try to join such relation (example: `City.joins(:country)`), there is an exception.
 
 ## Usage
+Generate migration to fix foreign key problems
+```bash
+bundle exec rails generate foreign_key_checker:migration
+```
+
+
+Print information about foreign key problems
 ```bash
 bundle exec rake foreign_key_check
 ```

data/Rakefile

@@ -4,16 +4,6 @@ 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'

data/lib/foreign_key_checker/railtie.rb

@@ -3,5 +3,8 @@ module ForeignKeyChecker
     rake_tasks do
       load 'tasks/foreign_key_checker_tasks.rake'
     end
+    generators do
+      require 'generators/foreign_key_checker/migration/migration_generator.rb'
+    end
   end
 end

data/lib/foreign_key_checker/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyChecker
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/foreign_key_checker.rb

@@ -37,9 +37,22 @@ module ForeignKeyChecker
   end
 
   class ForeignKeyResult < Result
+    attr_reader :scope
     def message
       "There is no foreign_key for relation #{human_relation}\n"
     end
+
+    def migration
+      "add_foreign_key :#{from_table}, :#{to_table}#{
+        ", column: :#{from_column}" if from_column.to_s != "#{to_table.singularize}_id"
+      }#{
+        ", primary_key: :#{to_column}" if to_column.to_s != 'id'
+      }"
+    end
+
+    def to_zombie
+      ZombieResult.new(scope: scope, model: model, association: association)
+    end
   end
 
   class IndexResult < Result
@@ -59,7 +72,26 @@ module ForeignKeyChecker
       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"
+      #"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"
+      "DELETE FROM #{from_t} WHERE #{from_c} IS NOT NULL AND #{from_c} NOT IN (SELECT #{to_c} FROM #{to_t})"
+    end
+
+    def set_null_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)
+      #"UPDATE #{from_t} SET #{from_t}.#{from_c} = NULL FROM #{from_t} LEFT OUTER JOIN #{to_t} ON #{to_t}.#{to_c} = #{from_t}.#{from_c} WHERE #{to_t}.#{to_c} IS NULL"
+      "UPDATE #{from_t} SET #{from_c} = NULL WHERE #{from_c} IS NOT NULL AND #{from_c} NOT IN (SELECT #{to_c} FROM #{to_t})"
+    end
+
+    def set_null_migration
+      "execute('#{set_null_sql}')"
+    end
+
+    def migration(set_null: false)
+      return set_null_migration if set_null
+      "execute('#{delete_sql}')"
     end
 
     def message
@@ -144,7 +176,8 @@ module ForeignKeyChecker
       if foreign_keys && !model.connection.foreign_key_exists?(model.table_name, related.table_name)
         @result[:foreign_keys] << ForeignKeyResult.new(
           model: model,
-          association: association
+          association: association,
+          scope: scope,
         )
       end
 

data/lib/generators/foreign_key_checker/migration/migration_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+module ForeignKeyChecker
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      desc "generates the necessary migrations to fix foreign_key problems"
+      argument :name, type: :string, default: 'FixForeignKeys'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def create_migrations
+        @class_name = name.camelcase.tr(':', '')
+        file_name = name.underscore.tr('/', '_')
+        @done = Dir.glob(Rails.root.join('db', 'migrate', '*.rb')).map do |path|
+          File.open(path).readlines.find { |line| line.include?('ActiveRecord::Migration') && line.include?(@class_name) }
+        end.compact.size
+        @checks = ForeignKeyChecker.check(zombies: false, indexes: false) unless @behavior == :revoke
+        if @behavior == :revoke
+          @file_suffix = "_v#{@done}" if @done > 1
+          @class_suffix = "V#{@done}" if @done > 1
+        else
+          @file_suffix = "_v#{@done + 1}" if @done > 0
+          @class_suffix = "V#{@done + 1}" if @done > 0
+        end
+        migration_template 'migrations/fix_foreign_keys.rb.erb', "db/migrate/#{file_name}#{@file_suffix}.rb"
+      end
+    end
+  end
+end

data/lib/generators/foreign_key_checker/migration/templates/migrations/fix_foreign_keys.rb.erb

@@ -0,0 +1,13 @@
+class <%= @class_name %><%= @class_suffix %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
+  def change
+<% @checks[:foreign_keys].each do |fk| %>
+    reversible do |dir|
+      dir.up do
+        # <%= fk.to_zombie.migration(set_null: true) %>
+        <%= fk.to_zombie.migration %>
+      end
+    end
+    <%= fk.migration %>
+<% end %>
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - AnatolyShirykalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,6 +51,8 @@ files:
 - lib/foreign_key_checker.rb
 - lib/foreign_key_checker/railtie.rb
 - lib/foreign_key_checker/version.rb
+- lib/generators/foreign_key_checker/migration/migration_generator.rb
+- lib/generators/foreign_key_checker/migration/templates/migrations/fix_foreign_keys.rb.erb
 - lib/tasks/foreign_key_checker_tasks.rake
 homepage: https://gitlab.com/pipocavsobake/foreign_key_checker
 licenses: