foreign_key_checker 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ba348e8860c85305d58ec740c7d49dd318a11f2d80fff5905e434281b0f75e
-  data.tar.gz: 0e40f9cff0e3af05525c529217c28eb360e008f6e20cf1b6268d0146c71955e7
+  metadata.gz: cf9685280dd2c9ad8232c3b4fe7d4f72dcc56ccdbbaf0b55d826792196185f05
+  data.tar.gz: de9a1d21793299c0df12e92b09fd2661b160d9794d6bb01a7080478fecc3db96
 SHA512:
-  metadata.gz: f66ab3eacf8fd3238740483184683f871bbf0cd482ae3fa644d7120a8f01bde616ef571ab19638c6bae9e2a677650838370858a9f2e8ab776829a17d48a75f8a
-  data.tar.gz: 53fd8d518399d7b61ee42cb7e47ac01f5604852e724e78971c7fd63a2009ac8b95afbc4ddd17a433da453dc7b4b0427d3c813a241015c0525b233473af9bb319
+  metadata.gz: 7f3b6138b99b780ed15ab03c43c0745bfc9511089e4fe0b4bb29cc962d232f7d942d3e314dc56bc8422e193631872d7415a5a28251281fad1bca704fb3c2ab6b
+  data.tar.gz: d7c3c677d063a6e2210d3627caac91431024e940b44e4e2b33c912f48c532a662c81678a1f5aa32f8cccffe19c3bdf0fbd7e10c13796f129de2dc9c60044705d

data/README.md

@@ -23,7 +23,7 @@ ForeignKeyChecker.check.each do |key, result|
 end
 ```
 
-Get general information about foreign keys (only postgresql, mysql2)
+Get general information about foreign keys
 ```ruby
 ForeignKeyChecker::Utils.get_foreign_keys_hash
 # =>  {"users"=>[#<ForeignKeyChecker::Utils::Result:0x00005645e51756e8 @from_table="user_rating_changes", @from_column="user_id", @to_table="users", @to_column="id">]}

data/lib/foreign_key_checker.rb

@@ -1,5 +1,9 @@
 require "foreign_key_checker/railtie"
 require 'foreign_key_checker/utils'
+module ForeignKeyChecker::Checkers
+end
+require 'foreign_key_checker/checkers/relations'
+require 'foreign_key_checker/checkers/tables'
 
 module ForeignKeyChecker
   class TypeMismatch < StandardError; end
@@ -162,12 +166,21 @@ module ForeignKeyChecker
     def check_types(model, association)
       type_from = model.columns_hash[association.foreign_key.to_s].sql_type
       type_to = association.klass.columns_hash[association.klass.primary_key.to_s].sql_type
-      raise TypeMismatch, "TypeMissMatch #{type_from} != #{type_to}" if type_from != type_to
+      raise TypeMismatch, "TypeMissMatch for relation #{model}##{association.name} #{type_from} != #{type_to}" if type_from != type_to
     end
 
     def check_foreign_key_bt_association(model, association)
       return if model.name.starts_with?('HABTM_')
-      related = association.klass
+      begin
+        related = association.klass
+      rescue NameError => error
+        @result[:broken] << BrokenRelationResult.new(
+          model: model,
+          association: association,
+          error: error,
+        )
+        return
+      end
 
       column_name = model.connection.quote_column_name(association.foreign_key)
       scope = model.left_outer_joins(association.name).where(
@@ -188,7 +201,7 @@ module ForeignKeyChecker
         end
       end
 
-      if foreign_keys && !model.connection.foreign_key_exists?(model.table_name, related.table_name)
+      if foreign_keys && !model.connection.foreign_key_exists?(model.table_name, related.table_name, column: association.foreign_key, primary_key: related.primary_key)
         scope.first
         @result[:foreign_keys] << ForeignKeyResult.new(
           model: model,

data/lib/foreign_key_checker/checkers/relations.rb

@@ -0,0 +1,122 @@
+require 'foreign_key_checker/utils'
+
+module ForeignKeyChecker::Checkers::Relations
+  class Result
+    attr_reader :ok, :model, :association, :fk, :error, :table
+    def initialize(**args)
+      %i[model association ok error fk table].each do |key|
+        instance_variable_set("@#{key}", args[key])
+      end
+    end
+  end
+  class JoinResult < Result
+    def message
+      "expect { #{model.to_s}.joins(:#{association.name}).first }.to_not raise_exception" if !ok
+    end
+  end
+  class ErrorResult < Result
+    def message
+      "`#{model.to_s}##{association.name}` is broken\n#{error.class.to_s}\n#{error.message}\n#{error.backtrace.join("\n")}" if !ok
+    end
+  end
+  class HasOneOrManyResult < Result
+    def message
+      "expected has_many or has_one association for #{fk.inspect}"
+    end
+  end
+  class HasOneOrManyDependentResult < Result
+    def message
+      "expected has_many or has_one association with dependent option for #{fk.inspect}"
+    end
+  end
+  class NoModelResult < Result
+    def message
+      "expected find model for table #{table}"
+    end
+  end
+  def self.check_by_join
+    Rails.application.eager_load!
+    models = ActiveRecord::Base.descendants
+    models.each_with_object([]) do |model, results|
+      next if model.to_s.include?('HABTM')
+      model.reflect_on_all_associations.each do |association|
+        begin
+          next if association.options[:polymorphic]
+          next if association.scope && association.scope.is_a?(Proc) && association.scope.arity > 0
+          next if model.connection_specification_name != association.klass.connection_specification_name
+
+          model.joins(association.name).first
+          result = JoinResult.new(model: model, association: association, ok: true)
+          yield result if block_given?
+          results << result
+        rescue => e
+          result = JoinResult.new(model: model, association: association, ok: false, error: e)
+          yield result if block_given?
+          results << result
+        end
+      end
+    end
+  end
+
+  def self.check_by_fks
+    Rails.application.eager_load!
+    models = ActiveRecord::Base.descendants.group_by(&:table_name)
+    check_relation = proc do |model, fk, association|
+      begin
+        pk = association.options[:primary_key] || model.primary_key
+        association.klass.table_name.to_s == fk.from_table.to_s && association.foreign_key.to_s == fk.from_column.to_s && pk.to_s == fk.to_column.to_s
+      rescue => e
+        if block_given?
+          yield ErrorResult.new(model: model, association: association, fk: fk, ok: false, error: e)
+        else
+          p model
+          p fk
+          p association
+          raise e
+        end
+      end
+    end
+    ForeignKeyChecker::Utils.get_foreign_keys_hash.each do |to_table, fks|
+      fks.each do |fk|
+        unless models.key?(fk.to_table)
+          result = NoModelResult.new(ok: false, table: fk.to_table)
+          if block_given?
+            yield result
+          else
+            raise result.message
+          end
+          next
+        end
+        models[fk.to_table].each do |model|
+          next if model.connection_specification_name != 'primary'
+          ok = false
+          ok ||= !!model.reflect_on_all_associations(:has_many).find do |association|
+            check_relation.call(model, fk, association)
+          end
+          ok ||= !!model.reflect_on_all_associations(:has_one).find do |association|
+            check_relation.call(model, fk, association)
+          end
+          if block_given?
+            yield HasOneOrManyResult.new(model: model, fk: fk, ok: ok)
+          else
+            raise "expected has_many or has_one association for #{fk.inspect}" if !ok
+          end
+          next if !ok
+
+          dep = false
+          dep ||= !!model.reflect_on_all_associations(:has_many).find do |association|
+            check_relation.call(model, fk, association) && association.options[:dependent]
+          end
+          dep ||= !!model.reflect_on_all_associations(:has_one).find do |association|
+            check_relation.call(model, fk, association) && association.options[:dependent]
+          end
+          if block_given?
+            yield HasOneOrManyDependentResult.new(model: model, fk: fk, ok: ok)
+          else
+            raise "expected has_many or has_one association with dependent option for #{fk.inspect}" if !dep
+          end
+        end
+      end
+    end
+  end
+end

data/lib/foreign_key_checker/checkers/tables.rb

@@ -0,0 +1,88 @@
+require 'foreign_key_checker/utils'
+
+# Стоит использовать в тех случаях, когда подключается rails к уже существующей базе
+# Можно проверить, для каких таблиц всё ещё нет ActiveRecord-моделей
+module ForeignKeyChecker::Checkers::Tables
+  SPECIAL_TABLES = ['schema_migrations', 'ar_internal_metadata'].freeze
+  # Список таблиц, не описанных моделями (в том числе HABTM-моделями, сгенерированными автоматически rails)
+  def self.without_models(specification_name = 'primary')
+    Rails.application.eager_load!
+
+    actual_tables = ForeignKeyChecker::Utils.get_tables
+    actual_tables - modelised_tables(specification_name) - SPECIAL_TABLES
+  end
+
+  def self.without_foreign_keys(specification_name = 'primary')
+    all_fks = ForeignKeyChecker::Utils.get_foreign_keys
+    results = []
+    models(specification_name).each do |model|
+      model.column_names.each do |column_name|
+        next unless column_name.ends_with?('_id')
+        next if all_fks.find { |fk| fk.from_table = model.table_name && fk.from_column == column_name }
+
+        table_name = column_name.delete_suffix('_id')
+        results << ["#{table_name}.#{column_name}"]
+      end
+    end
+  end
+
+  def self.modelised_tables(specification_name = 'primary')
+    models(specification_name).map(&:table_name)
+  end
+
+  def self.models(specification_name = 'primary')
+    ActiveRecord::Base.descendants.select do |model|
+      model.connection_specification_name == specification_name
+    end
+  end
+
+
+  def self.common_tables
+    ForeignKeyChecker::Utils.get_tables - SPECIAL_TABLES
+  end
+
+  class Result
+    attr_reader :table_name, :foreign_keys, :internal_references
+    def initialize(**args)
+      %i[table_name foreign_keys internal_references].each do |key|
+        instance_variable_set("@#{key}", args[key] || args[key].to_s)
+      end
+    end
+
+    def ok?
+      foreign_keys.blank?
+    end
+
+    def referenced?
+      foreign_keys.present?
+    end
+
+    def ext_ref?
+      !internal_references
+    end
+
+  end
+
+  def self.check
+    tables = without_models
+    fks = ForeignKeyChecker::Utils.get_foreign_keys_hash
+    fks.default = []
+    tables.map do |table|
+      Result.new(
+        table_name: table,
+        foreign_keys: fks[table] || [],
+        internal_references: (fks[table].map(&:from_table) - tables).empty?,
+      )
+    end
+  end
+
+  # TODO вспомнить, что я тут задумал
+  def self.ordered(results = check)
+    return results if results.size == 0
+    oks = results.select(&:ok?)
+    if oks.size == 0
+      raise "no ok"
+    end
+  end
+
+end

data/lib/foreign_key_checker/utils.rb

@@ -9,7 +9,7 @@ module ForeignKeyChecker
     class UnsupportedConnectionAdapter < StandardError; end
     def self.get_foreign_keys(model = ActiveRecord::Base)
       adapter = model.connection_config[:adapter]
-      raise(UnsupportedConnectionAdapter, adapter) unless %w[postgresql mysql2].include?(adapter)
+      raise(UnsupportedConnectionAdapter, adapter) unless %w[postgresql mysql2 sqlserver sqlite3].include?(adapter)
 
       connection = model.connection
       send("get_#{adapter}_foreign_keys", connection)
@@ -22,6 +22,22 @@ module ForeignKeyChecker
       end
     end
 
+    def self.get_sqlite3_foreign_keys(connection)
+      res = connection.select_all <<-SQL
+        SELECT
+          m.name as from_table,
+          p."from" as from_column,
+          p."table" as to_table,
+          p."to" as to_column
+        FROM
+          sqlite_master m
+          JOIN pragma_foreign_key_list(m.name) p ON 1
+        WHERE m.type = 'table'
+        ORDER BY m.name ;
+      SQL
+      res.to_a.map{|i| Result.new(i) }
+    end
+
     def self.get_mysql2_foreign_keys(connection)
       res = connection.select_all <<-SQL
         SELECT
@@ -57,5 +73,54 @@ module ForeignKeyChecker
       SQL
       res.to_a.map{ |i| Result.new(i) }
     end
+
+    def self.get_sqlserver_foreign_keys(connection)
+      res = connection.select_all <<-SQL
+        SELECT  obj.name AS FK_NAME,
+            sch.name AS [schema_name],
+            tab1.name AS [from_table],
+            col1.name AS [from_column],
+            tab2.name AS [to_table],
+            col2.name AS [to_column]
+        FROM sys.foreign_key_columns fkc
+        INNER JOIN sys.objects obj
+            ON obj.object_id = fkc.constraint_object_id
+        INNER JOIN sys.tables tab1
+            ON tab1.object_id = fkc.parent_object_id
+        INNER JOIN sys.schemas sch
+            ON tab1.schema_id = sch.schema_id
+        INNER JOIN sys.columns col1
+            ON col1.column_id = parent_column_id AND col1.object_id = tab1.object_id
+        INNER JOIN sys.tables tab2
+            ON tab2.object_id = fkc.referenced_object_id
+        INNER JOIN sys.columns col2
+            ON col2.column_id = referenced_column_id AND col2.object_id = tab2.object_id
+      SQL
+      res.to_a.map { |i| Result.new(i) }
+    end
+
+    def self.get_tables(model = ActiveRecord::Base)
+      adapter = model.connection_config[:adapter]
+      raise(UnsupportedConnectionAdapter, adapter) unless %w[postgresql mysql2 sqlite3 sqlserver].include?(adapter)
+
+      connection = model.connection
+      send("get_#{adapter}_tables", connection)
+    end
+
+    def self.get_mysql2_tables(connection)
+      connection.select_all("SELECT table_name FROM information_schema.tables WHERE TABLE_SCHEMA = '#{connection.current_database}'").to_a.pluck('table_name')
+    end
+
+    def self.get_postgresql_tables(connection)
+      connection.select_all("SELECT tablename FROM pg_catalog.pg_tables WHERE schemaname != 'pg_catalog' AND schemaname != 'information_schema'").to_a.pluck('tablename')
+    end
+
+    def self.get_sqlite3_tables(connection)
+      connection.select_all("SELECT name FROM sqlite_master WHERE type='table'").to_a.pluck('name') - ['sqlite_sequence']
+    end
+
+    def self.get_sqlserver_tables(connection)
+      connection.tables
+    end
   end
 end

data/lib/foreign_key_checker/version.rb

@@ -1,3 +1,3 @@
 module ForeignKeyChecker
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreign_key_checker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - AnatolyShirykalov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,104 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: 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: tiny_tds
+  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: activerecord-sqlserver-adapter
+  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: irb
+  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: e2mmap
+  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: annotate
+  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
@@ -49,6 +147,8 @@ files:
 - README.md
 - Rakefile
 - lib/foreign_key_checker.rb
+- lib/foreign_key_checker/checkers/relations.rb
+- lib/foreign_key_checker/checkers/tables.rb
 - lib/foreign_key_checker/railtie.rb
 - lib/foreign_key_checker/utils.rb
 - lib/foreign_key_checker/version.rb
@@ -60,7 +160,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Find problems with relations in active_record models
 test_files: []