yeet_db 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e71e7e7fb74ddf4213f433033223462415c8b89a1e073d6121ccfc003936502
-  data.tar.gz: ff1bd69f2c3e8297a66225e616bcce8f5fefaf9e5bebeac7860496d7df071cf9
+  metadata.gz: 8ec13f950af908e43a89e326bb81e173575c1ffe3e9ce9a122bc8eb8f2d45752
+  data.tar.gz: 19d2ddeae5479d30e5b804475887ff8f7f8de72a49295ff2402a82a05c0694d8
 SHA512:
-  metadata.gz: ae85df15bf889bae95de1caaae5f515ff81c340a21cef83498ad6a713c4341b5da9ccfc91f52d660681eee429891b5b0f0af763dbc5b075f7dbf003f6c1938e4
-  data.tar.gz: '099ed8ea5a188f40d77c7e587ce758991368c1729348a88b85c41554cc4c081680817f31e1896015ed3513e1c146050518dfb32d83e012027dbfaead7db48567'
+  metadata.gz: e422f69dcd856fff98303b7794501da77592f39d378e11e5c424381bdcdad79614fd94fd9d6ba2ef6cc41d092cfaeed39b5483e248a389f323272381b70830dd
+  data.tar.gz: f2c7eeecae89d56097ef9200533e09a07d6157208debb290be1dc5564bccff664b6d9969ddb80fa3941075aac03ea43e0fe52f1063382606400f47539deeb9f1

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/README.md

@@ -1,11 +1,13 @@
 ![Foreign Key by Ary Prasetyo from the Noun Project](./yeet_db.png)
 
-# yeet_db
+# yeet_db - find missing foreign key constraints
 
 yeet_db scans your rails tables for missing foreign key constraints. If there are no dangling records, it will create a migration to add the foreign key constraints on all the table it is safe.
 
 If you have dangling migrations, check the generator logs to see where you have invalid orphaned rows. Orphaned row meaning a row with an id that doesn't exist in the associated table.
 
+but [why should I use foreign keys?](https://softwareengineering.stackexchange.com/questions/375704/why-should-i-use-foreign-keys-in-database)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,13 +46,11 @@ Rails 5.2 (but it may work with 5.0+)
 
 ## Road map to v1
 
-[ ] add rake task identify all dangling records
-
-[ ] add rake task to automatically nullify or destroy dangling records
-
-[ ] run as a rake task
-
-[ ] support "soft delete" gems
+- [ ] rspec tests
+- [ ] add rake task identify all dangling records
+- [ ] add rake task to automatically nullify or destroy dangling records
+- [ ] run as a rake task
+- [ ] support "soft delete" gems
 
 
 ## Development

data/lib/generators/yeet_db/foreign_key_migration_generator.rb

@@ -16,7 +16,7 @@ module YeetDb
     private
 
     def migration_file
-      File.join("db/migrate", "add_foreign_keys.rb")
+      File.join("db/migrate", "add_foreign_keys_yeet_db.rb")
     end
 
     def migration_version

data/lib/generators/yeet_db/templates/add_foreign_keys_yeet_db.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 class AddForeignKeysYeetDb < ActiveRecord::Migration<%= migration_version %>
   def change
    <% ::YeetDb::MissingForeignKeys.foreign_keys.each do |foreign_key| %>
     add_foreign_key :<%= foreign_key.table_a %>,
-                    :<%= foreign_key.table_b %>, 
+                    :<%= foreign_key.table_b %>,
                     column: :<%= foreign_key.column %>
    <% end %>
   end

data/lib/yeet_db/ar_table.rb

@@ -14,11 +14,11 @@ module YeetDb
         next unless column.is_association?
 
         unless column.model
-          puts "WARNING - cannot find model for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+          puts "YeetDb - cannot find model for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
         end
 
         unless column.association
-          puts "WARNING - cannot find association for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+          puts "YeetDb - cannot find association for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
         end
 
         next if column.polymorphic_association?
@@ -26,8 +26,10 @@ module YeetDb
         next if column.association_table_name.blank?
 
         if VerifyData.new(column: column).orphaned_rows?
-          puts "WARNING - orphaned rows #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+          puts "YeetDb - orphaned rows. Skipping #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+          next
         end
+
         foreign_key = ForeignKey.new(table_a: table_name,
                                      table_b: column&.association_table_name,
                                      column: column_name.name)

data/lib/yeet_db/version.rb

@@ -1,3 +1,3 @@
 module YeetDb
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yeet_db
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kevin Coleman