yeet_dba 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ebeaa010c0aac25fec89ae37bfa612bba92ac059f409d555a41c62a591e9ac
-  data.tar.gz: 2a1936a44bb7ec4f776420be9517c08604fc6ca5f0f7f4855adf8458cd6cda61
+  metadata.gz: 52cc31e276691be6f75f50eef374d4511c108fd5e4d9abcce296c36bf810e481
+  data.tar.gz: 0c6fb6686fbe35055dc7be0f3bd2456988efe20acc7c8da404e6f5e594bee2da
 SHA512:
-  metadata.gz: aca3b09485598e836fcd99c4a8dde0986dfa2a602b69c15fe2f45e06472e050868be0200760eec6c77779a4f0891912b8626f65890028d041ac406960266a9c8
-  data.tar.gz: 06e42dba1df5abdc3aa4e2f5a0c0e8fc998838d820378cb6df994c6a247448740c09fac9e31b153a234e1b2139ad01a67d632d2f9e9c33de4fb701e5b357adf7
+  metadata.gz: 39709844b54331b0a73002c4ca7085fccc83d7cdfc97a54af40c7bf895df30890d65ee68473e64fea92e13bef56bb3ea872c64238e22497b453f622b0aad1847
+  data.tar.gz: 00c8ec4a3d6182ce6fff3112ded9eba2b55bb9291ecf96b8258fa3e3d1341166468525d6b2327b3d9eb79e04034a5a3ea8b35f03c1bac1c893314d8cd72de359

data/.yeet_dba.example.yml

@@ -0,0 +1,3 @@
+---
+  exclude_tables:
+    - table_to_be_ignored

data/CHANGELOG.md

@@ -1,29 +1,33 @@
-# 1.0.1 (unreleased, master)
-
-## Minor changes
-
-# 1.0.0
-
-## Minor changes
-
-Improved test coverage
-
-# 0.1.2
-
-## Major changes
-
-Added rake task to find invalid data
-Added rake task to nullify and delete invalid data
-
-## Minor changes
-
-Add rubocop
-Add rspec tests
-
-# 0.1.1
-
-Patch bug with skipping invalid columns that have orphaned data
-
-# 0.1.0
-
-Initial release
+# 1.0.1 (unreleased, master)
+
+## Minor changes
+
+Support Rails 6
+Update gems and remove pry
+Fix bug in `find_orphaned_rows` rake task for [Issue #10](https://github.com/KevinColemanInc/yeet_dba/issues/10)
+
+# 1.0.0
+
+## Minor changes
+
+Improved test coverage
+
+# 0.1.2
+
+## Major changes
+
+Added rake task to find invalid data
+Added rake task to nullify and delete invalid data
+
+## Minor changes
+
+Add rubocop
+Add rspec tests
+
+# 0.1.1
+
+Patch bug with skipping invalid columns that have orphaned data
+
+# 0.1.0
+
+Initial release

data/Gemfile

@@ -11,5 +11,3 @@ gem 'railties'
 gem 'rspec-rails'
 gem 'sqlite3'
 gem 'test-unit'
-
-gem 'pry', require: true

data/Gemfile.lock

@@ -1,118 +1,113 @@
-PATH
-  remote: .
-  specs:
-    yeet_dba (0.2.1)
-      actionpack (>= 3.0, < 6.0)
-      activerecord (>= 3.0, < 6.0)
-      railties (>= 3.0, < 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.3)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.2)
-      mini_portile2 (~> 2.4.0)
-    power_assert (1.1.4)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.6)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-rails (3.8.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sqlite3 (1.4.0)
-    test-unit (3.3.1)
-      power_assert
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  actionpack
-  activerecord
-  bundler (~> 1.17)
-  pry
-  railties
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rspec-rails
-  sqlite3
-  test-unit
-  yeet_dba!
-
-BUNDLED WITH
-   1.17.3
+PATH
+  remote: .
+  specs:
+    yeet_dba (1.0.1)
+      actionpack (>= 3.0, < 7.0)
+      activerecord (>= 3.0, < 7.0)
+      railties (>= 3.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    power_assert (1.1.5)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sqlite3 (1.4.1)
+    test-unit (3.3.3)
+      power_assert
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activerecord
+  bundler (~> 1.17)
+  railties
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  sqlite3
+  test-unit
+  yeet_dba!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -21,7 +21,7 @@ But this doesn't work if you don't nullify the `company_id` when the company is
 
 ### But what is the difference between yeet_db and [lol_dba](https://github.com/plentz/lol_dba)?
 
-lol_dba will only add indexes for RoR models. yeet_dba looks at every table (including join tables) to add foreign key constraints, which also add indexes.
+lol_dba will only add indexes for RoR models. yeet_dba looks at every table (including join tables) to add foreign key constraints.
 
 ## Installation
 
@@ -63,6 +63,16 @@ SELECT "notifications".* FROM "notifications" left join active_storage_attachmen
 
 ```
 
+If you need to ignore certain tables from being checked simply add a `.yeet_dba.yml` in the Rails.root directory.
+
+```
+---
+  exclude_tables:
+    - table_to_be_ignored
+```
+
+For a sample configuration file check `.yeet_dba.example.yml`.
+
 ### 2. Fix invalid rows
 
 You can either manually repair your data via rails console or direct SQL queries, or you can run a rake task to resolve failures.
@@ -154,4 +164,3 @@ Foreign Key by Ary Prasetyo from the Noun Project
 ## Author
 
 Kevin Coleman, [https://kcoleman.me/](https://kcoleman.me)
-

data/lib/yeet_dba/missing_foreign_keys.rb

@@ -21,7 +21,23 @@ module YeetDba
     end
 
     def self.tables
-      ActiveRecord::Base.connection.tables
+      ActiveRecord::Base.connection.tables - self.ignored_tables
+    end
+
+    def self.ignored_tables
+      config['exclude_tables'] || []
+    end
+
+    def self.config
+      @config ||= begin
+        config_file = Pathname.new(Rails.root).join('.yeet_dba.yml')
+
+        if File.exist?(config_file)
+          YAML.load(File.read(config_file))
+        else
+          {}
+        end
+      end
     end
   end
 end

data/lib/yeet_dba/tasks/bad_data/find_orphaned_rows.rake

@@ -11,7 +11,7 @@ namespace :yeet_dba do
       puts "🚨Houston, we have a problem 🚨. We found #{columns.length} invalid column#{columns.length == 1 ? '' : 's'}."
       puts
       columns.each do |invalid_column|
-        puts "-> #{invalid_column.table}.#{invalid_column.column}"
+        puts "-> #{invalid_column.table_name}.#{invalid_column.column}"
         puts "Invalid rows:   #{invalid_column.orphaned_rows_count}"
         puts "Foreign table:  #{invalid_column.association_table_name}"
         puts

data/lib/yeet_dba/verify_data.rb

@@ -1,37 +1,35 @@
-require 'pry'
-
-module YeetDba
-  class VerifyData
-    attr_accessor :column
-
-    def initialize(column:)
-      @column = column
-    end
-
-    def orphaned_rows?
-      orphaned_rows.first
-    end
-
-    def orphaned_rows_count
-      orphaned_rows.count
-    end
-
-    def query
-      orphaned_rows.to_sql
-    end
-
-    def orphaned_rows
-      association = column.association
-
-      column_name = column.db_column.name
-      table_name = column.table_name
-      association_table = column.association_table_name
-      model = column.model
-
-      # Check to see there could be rows with bad data
-      model.joins("left join #{association_table} as association_table on association_table.id = #{table_name}.#{column_name}")
-           .where.not(column_name => nil)
-           .where('association_table.id is null')
-    end
-  end
-end
+module YeetDba
+  class VerifyData
+    attr_accessor :column
+
+    def initialize(column:)
+      @column = column
+    end
+
+    def orphaned_rows?
+      orphaned_rows.first
+    end
+
+    def orphaned_rows_count
+      orphaned_rows.count
+    end
+
+    def query
+      orphaned_rows.to_sql
+    end
+
+    def orphaned_rows
+      association = column.association
+
+      column_name = column.db_column.name
+      table_name = column.table_name
+      association_table = column.association_table_name
+      model = column.model
+
+      # Check to see there could be rows with bad data
+      model.joins("left join #{association_table} as association_table on association_table.id = #{table_name}.#{column_name}")
+           .where.not(column_name => nil)
+           .where('association_table.id is null')
+    end
+  end
+end

data/lib/yeet_dba/version.rb

@@ -1,3 +1,3 @@
-module YeetDba
-  VERSION = '1.0.0'.freeze
-end
+module YeetDba
+  VERSION = '1.0.1'.freeze
+end

data/yeet_dba.gemspec

@@ -1,45 +1,45 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'yeet_dba/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'yeet_dba'
-  spec.version       = YeetDba::VERSION
-  spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ['Kevin Coleman']
-  spec.email         = ['kevin.coleman@sparkstart.io']
-
-  spec.summary       = 'Generates foreign key constraint migrations for rails databases'
-  spec.description   = "This scan every ActiveRecord model looking for relationships ('has_many', 'belongs_to', etc.) and adds foreign key constraints."
-  spec.homepage      = 'http://rubygems.org/gems/yeet_dba'
-  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['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/kevincolemaninc/yeet_dba'
-    spec.metadata['changelog_uri'] = 'https://github.com/kevincolemaninc/yeet_dba/master/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-
-  spec.required_ruby_version = '>= 2.4.0'
-  spec.add_dependency 'actionpack', '>= 3.0', '< 6.0'
-  spec.add_dependency 'activerecord', '>= 3.0', '< 6.0'
-  spec.add_dependency 'railties', '>= 3.0', '< 6.0'
-end
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yeet_dba/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yeet_dba'
+  spec.version       = YeetDba::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Kevin Coleman']
+  spec.email         = ['kevin.coleman@sparkstart.io']
+
+  spec.summary       = 'Generates foreign key constraint migrations for rails databases'
+  spec.description   = "This scan every ActiveRecord model looking for relationships ('has_many', 'belongs_to', etc.) and adds foreign key constraints."
+  spec.homepage      = 'http://rubygems.org/gems/yeet_dba'
+  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['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/kevincolemaninc/yeet_dba'
+    spec.metadata['changelog_uri'] = 'https://github.com/kevincolemaninc/yeet_dba/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.add_dependency 'actionpack', '>= 3.0', '< 7.0'
+  spec.add_dependency 'activerecord', '>= 3.0', '< 7.0'
+  spec.add_dependency 'railties', '>= 3.0', '< 7.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yeet_dba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,7 +61,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -71,7 +71,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,7 +91,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -111,7 +111,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 description: This scan every ActiveRecord model looking for relationships ('has_many',
   'belongs_to', etc.) and adds foreign key constraints.
 email:
@@ -125,6 +125,7 @@ files:
 - ".rspec"
 - ".rubocop"
 - ".travis.yml"
+- ".yeet_dba.example.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile