yeet_dba 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32599ee97b8b627e2a093054e31eed282e2141e93569723b98b40357781d1399
+  data.tar.gz: 2ee79b2e47bee2c889ccee622be08de60f84d5f8daff92585b1cf52e5880e98c
+SHA512:
+  metadata.gz: 8d36e9b4683ea1a9f09238db879e29383ec53fa0e6c28dc4e722738831264833d361a30f2cc6647ad84904e695da4033d7fe0ef5c2a7abc86c59e9a73b30c1f2
+  data.tar.gz: 22fb42465caa8ec621aa472924eeb27c5f14e78a5abe9a858a6f48064d19af3651a42f5d65bd7170608bc8b4078cb0baa970204592cb04942d5993925ab84240

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kevin.coleman@sparkstart.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yeet_dba.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kevin Coleman
+
+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,75 @@
+![Foreign Key by Ary Prasetyo from the Noun Project](./yeet_dba.png)
+
+# yeet_dba - find missing foreign key constraints
+
+yeet_dba 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:
+
+```ruby
+gem 'yeet_dba'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This probably should run against the production database so you can know if there are dangling records. If there are records with a value, but not the corresponding table does not have an id, then the migration will fail.
+
+```
+$ RAILS_ENV=production rails g yeet_dba:foreign_key_migration
+```
+
+This will create a new migration with for every foreign_key that can safely be added without running into orphaned data errors. We also warn you if active_record models that are missing association declarations (`has_many`, `belongs_to`, etc.)`
+
+`WARNING - cannot find association for alternative_housings . supplier_id | suppliers`
+
+We also warn if we have tables that don't have existing models attached to them. This can be safe to ignore, because join tables on many to many relations don't need models, but ideally everything should have an AR model backing it.
+
+`WARNING - cannot find model for alternative_housings . supplier_id | suppliers`
+
+Finnally, if there is a table that we think should have a foreign key constraint, but there are dangling values we warn you against that too.
+
+`WARNING - orphaned rows alternative_housings . supplier_id | suppliers`
+
+## Requirements
+
+Rails 5.2 (but it may work with 5.0+)
+
+## Road map to v1
+
+- [ ] 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
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kevincolemaninc/yeet_dba. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the YeetDb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kevincolemaninc/yeet_dba/blob/master/CODE_OF_CONDUCT.md).
+
+## Logo design attribute
+Foreign Key by Ary Prasetyo from the Noun Project

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yeet_dbaa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/yeet_dba/foreign_key_migration_generator.rb

@@ -0,0 +1,30 @@
+# require 'generators/yeet_dba/generator_helpers'
+
+module YeetDba
+  # Custom scaffolding generator
+  class ForeignKeyMigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+    desc "Generates migration for adding foreign key constraints."   
+
+    def copy_migration_and_spec_files
+      migration_template "add_foreign_keys_yeet_dba.rb",
+                         migration_file,
+                         migration_version: migration_version
+    end
+
+    private
+
+    def migration_file
+      File.join("db/migrate", "add_foreign_keys_yeet_dba.rb")
+    end
+
+    def migration_version
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S%L")
+    end
+  end
+end

data/lib/generators/yeet_dba/generator_helpers.rb

@@ -0,0 +1,5 @@
+module YeetDba
+  module GeneratorHelpers
+
+  end
+end

data/lib/generators/yeet_dba/templates/add_foreign_keys_yeet_dba.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddForeignKeysYeetDba < ActiveRecord::Migration<%= migration_version %>
+  def change
+   <% ::YeetDba::MissingForeignKeys.foreign_keys.each do |foreign_key| %>
+    add_foreign_key :<%= foreign_key.table_a %>,
+                    :<%= foreign_key.table_b %>,
+                    column: :<%= foreign_key.column %>
+   <% end %>
+  end
+end

data/lib/yeet_dba.rb

@@ -0,0 +1,10 @@
+require "yeet_dba/version"
+require "yeet_dba/ar_column"
+require "yeet_dba/ar_table"
+require "yeet_dba/foreign_key"
+require "yeet_dba/missing_foreign_keys"
+require "yeet_dba/verify_data"
+
+module YeetDba
+  class Error < StandardError; end
+end

data/yeet_dba.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$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.authors       = ["Kevin Coleman"]
+  spec.email         = ["kevin.coleman@sparkstart.io"]
+
+  spec.summary       = %q{Generates foreign key constraint migrations for rails databases}
+  spec.description   = %q{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('..', __FILE__)) 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"
+end

data/yeet_dba/ar_column.rb

@@ -0,0 +1,47 @@
+module YeetDba
+  class ArColumn
+    attr_accessor :column_name, :table_name, :tables
+
+    def initialize(column_name:, table_name:, tables:)
+      @column_name = column_name
+      @table_name = table_name
+      @tables = tables
+    end
+
+    def is_association?
+      column_name.name =~ /_id\z/
+    end
+
+    def association_klass
+      model && model.reflections[association_name]&.klass
+    end
+
+    def association_table_name
+      association_klass&.table_name || tables.detect { |table| table == guessed_table_name }
+    end
+
+    def association_name
+      column_name.name.gsub(/_id\z/, '')
+    end
+
+    def model
+      ActiveRecord::Base.descendants.detect { |c| c.table_name == table_name }
+    end
+    
+    def association
+      model && model.reflections[association_name]
+    end
+
+    def polymorphic_association?
+      association && association.options[:polymorphic]
+    end
+
+    def foreign_key_exists?
+      ActiveRecord::Migration.foreign_key_exists?(table_name, column: column_name.name)
+    end
+
+    def guessed_table_name
+      @guessed_table_name ||= association_name.pluralize
+    end
+  end
+end

data/yeet_dba/ar_table.rb

@@ -0,0 +1,47 @@
+module YeetDba
+  class ArTable
+    attr_accessor :table_name, :tables
+
+    def initialize(table_name:, tables:)
+      @table_name = table_name
+      @tables = tables
+    end
+
+    def missing_keys
+      missing_keys_array = []
+      columns.each do |column_name|
+        column = ArColumn.new(column_name: column_name, table_name: table_name, tables: tables)
+        next unless column.is_association?
+
+        unless column.model
+          puts "YeetDba - cannot find model for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+        end
+
+        unless column.association
+          puts "YeetDba - cannot find association for #{table_name} . #{column_name.name} | #{column&.association_table_name}"
+        end
+
+        next if column.polymorphic_association?
+        next if column.foreign_key_exists?
+        next if column.association_table_name.blank?
+
+        if VerifyData.new(column: column).orphaned_rows?
+          puts "YeetDba - 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)
+        missing_keys_array.push(foreign_key)
+      end
+      missing_keys_array
+    end
+
+    private
+
+    def columns
+      ActiveRecord::Base.connection.columns(table_name)
+    end
+  end
+end

data/yeet_dba/foreign_key.rb

@@ -0,0 +1,13 @@
+module YeetDba
+  class ForeignKey
+    attr_accessor :table_a,
+                  :table_b,
+                  :column
+
+    def initialize(table_a:, table_b:, column:)
+      @table_a = table_a
+      @table_b = table_b
+      @column = column
+    end
+  end
+end

data/yeet_dba/missing_foreign_keys.rb

@@ -0,0 +1,11 @@
+module YeetDba
+  class MissingForeignKeys
+    def self.foreign_keys
+      Rails.application.eager_load!
+      tables = ActiveRecord::Base.connection.tables
+      tables.map do |table_name|
+        ArTable.new(table_name: table_name, tables: tables).missing_keys
+      end.flatten
+    end
+  end
+end

data/yeet_dba/verify_data.rb

@@ -0,0 +1,35 @@
+module YeetDba
+  class VerifyData
+  attr_accessor :column
+
+  def initialize(column:)
+    @column = column
+  end
+
+  def orphaned_rows?
+    orphaned_rows.first
+  end
+
+  private
+
+  def orphaned_rows
+    association = column.association
+    binding.pry if column.column_name.is_a?(String)
+
+    column_name = column.column_name.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 
+    bad_ids = 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')
+          .pluck(:id)
+
+    # select the rows with the invalid ids
+    # AR doesn't support joins with update, so the bad_ids are selected in a different query (above ^)
+    model.where(id: bad_ids)
+  end
+end
+end

data/yeet_dba/version.rb

@@ -0,0 +1,3 @@
+module YeetDba
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: yeet_dba
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kevin Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This scan every ActiveRecord model looking for relationships ('has_many',
+  'belongs_to', etc.) and adds foreign key constraints.
+email:
+- kevin.coleman@sparkstart.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/generators/yeet_dba/foreign_key_migration_generator.rb
+- lib/generators/yeet_dba/generator_helpers.rb
+- lib/generators/yeet_dba/templates/add_foreign_keys_yeet_dba.rb
+- lib/yeet_dba.rb
+- yeet_dba.gemspec
+- yeet_dba.png
+- yeet_dba/ar_column.rb
+- yeet_dba/ar_table.rb
+- yeet_dba/foreign_key.rb
+- yeet_dba/missing_foreign_keys.rb
+- yeet_dba/verify_data.rb
+- yeet_dba/version.rb
+homepage: http://rubygems.org/gems/yeet_dba
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://rubygems.org/gems/yeet_dba
+  source_code_uri: https://github.com/kevincolemaninc/yeet_dba
+  changelog_uri: https://github.com/kevincolemaninc/yeet_dba/master/CHANGELOG.md
+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.3
+signing_key: 
+specification_version: 4
+summary: Generates foreign key constraint migrations for rails databases
+test_files: []