forceful_foreign_key 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ede7c1b031e46881a77748a7718bdec296f863c
+  data.tar.gz: 5b1d06921229951f3487eff5ccc6a60f45d45f2b
+SHA512:
+  metadata.gz: 1a634192531f703424f176eabceab9a627ea6145efbfb0ccd724e0321c20cf2c50dfc8167322979bd44daf69e69b6cddadc9f00b8265dec69ae8569d00fc8d06
+  data.tar.gz: e4962775284f205da2b22de3973a8e7709807007d7e209dbdb9e0c663c9e2de7821ba8422958f24db02af29241db391d96c839f9509c89c94bee1eb42e717ed8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forceful_foreign_key.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 shaw3257
+
+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,24 @@
+# ForcefulForeignKey
+
+When `force: true` is set, It will delete orphaned data before applying the foreign key constraint. Use cautiously!
+
+```Ruby
+class AddFKContraint < ActiveRecord::Migration
+  def change
+    add_foreign_key 'foo', 'bar', force: true
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forceful_foreign_key'
+```
+tall forceful_foreign_key
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'active_record'
+require "forceful_foreign_key"
+
+`createdb forceful_foreign_key_dev > /dev/null 2>&1`
+`createuser -s forceful_foreign_key_dev > /dev/null 2>&1`
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :host     => "localhost",
+  :username => "forceful_foreign_key_dev",
+  :password => "",
+  :database => "forceful_foreign_key_dev"
+)
+
+require "irb"
+IRB.start

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/forceful_foreign_key.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forceful_foreign_key/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forceful_foreign_key"
+  spec.version       = ForcefulForeignKey::VERSION
+  spec.authors       = ["shaw3257"]
+  spec.email         = ["shaw3257@gmail.com"]
+
+  spec.summary       = "Forcefully creates a foreign key"
+  spec.description   = "Forcefully creates a foreign key and will recursively delete"
+  spec.homepage      = "https://github.com/viewthespace/forceful-foreign-key"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency('activerecord', '>= 3.0')
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+end

data/lib/forceful_foreign_key/graph.rb

@@ -0,0 +1,93 @@
+module ForcefulForeignKey
+  class Graph
+
+    attr_reader :graph
+    attr_reader :dry_run
+
+    def initialize dry_run: false
+      @dry_run = dry_run
+      init_dep_graph
+      build_graph
+    end
+
+    def delete_orphans(from_table:, from_column:, target_table:, target_column:, parent_ids: [])
+      limit = 1_000
+      offset = 0
+      if parent_ids.empty?
+        sql = "select distinct #{from_table}.id from #{from_table} left outer join #{target_table} on #{target_table}.#{target_column} = #{from_table}.#{from_column} where #{from_table}.#{from_column} is not null and #{target_table}.#{target_column} is null"
+      else
+        sql = "select distinct #{from_table}.id from #{from_table} left outer join #{target_table} on #{target_table}.#{target_column} = #{from_table}.#{from_column} where #{target_table}.#{target_column} in(#{parent_ids.join(',')})"
+      end
+      sql += " limit #{limit} offset 0"
+      loop do
+        ids = ActiveRecord::Base.connection.execute(sql).map{ |r| r['id'] }
+        break if ids.empty?
+        if dry_run
+          sql.gsub!(/\d+/, (offset += limit).to_s)
+        end
+        graph[from_table][:edges].each do |edge|
+          delete_orphans(from_table: edge[:table], from_column: edge[:column], target_table: from_table, target_column: 'id', parent_ids: ids)
+        end
+        delete_sql = "delete from #{from_table} where id in (#{ids.join(',')})"
+        puts delete_sql
+        select_sql = "select *  from #{from_table} where id in (#{ids.join(',')})"
+        r = ActiveRecord::Base.connection.execute(select_sql).to_a
+        unless dry_run
+          ActiveRecord::Base.connection.execute(delete_sql)
+        end
+      end
+    end
+
+    def init_dep_graph
+      @graph = tables.each_with_object({}){ |tables, graph| graph[tables] = { edges: [] } }
+    end
+
+    def build_graph
+      init_dep_graph
+      graph.each do |table, obj|
+        fks.select{ |fk| fk['references_table'] == table }.each do |fk|
+          obj[:edges].push({table: fk['table_name'], column: fk['column_name'] })
+        end
+      end
+    end
+
+    def fks
+      ActiveRecord::Base.connection.execute(
+          <<-SQL
+          SELECT tc.table_name,
+          kcu.constraint_name,
+          kcu.column_name,
+          ccu.table_name AS references_table,
+          ccu.column_name AS references_field
+          FROM information_schema.table_constraints tc
+  
+          LEFT JOIN information_schema.key_column_usage kcu
+          ON tc.constraint_catalog = kcu.constraint_catalog
+          AND tc.constraint_schema = kcu.constraint_schema
+          AND tc.constraint_name = kcu.constraint_name
+  
+          LEFT JOIN information_schema.referential_constraints rc
+          ON tc.constraint_catalog = rc.constraint_catalog
+          AND tc.constraint_schema = rc.constraint_schema
+          AND tc.constraint_name = rc.constraint_name
+  
+          LEFT JOIN information_schema.constraint_column_usage ccu
+          ON rc.unique_constraint_catalog = ccu.constraint_catalog
+          AND rc.unique_constraint_schema = ccu.constraint_schema
+          AND rc.unique_constraint_name = ccu.constraint_name
+          WHERE lower(tc.constraint_type) in ('foreign key')
+      SQL
+      ).to_a
+    end
+
+    def tables
+      ActiveRecord::Base.connection.execute(
+          <<-SQL
+          SELECT * FROM information_schema.tables
+          WHERE table_schema = 'public'
+      SQL
+      ).to_a.map{ |r| r['table_name'] }
+    end
+
+  end
+end

data/lib/forceful_foreign_key/version.rb

@@ -0,0 +1,3 @@
+module ForcefulForeignKey
+  VERSION = "0.1.0"
+end

data/lib/forceful_foreign_key.rb

@@ -0,0 +1,19 @@
+require "forceful_foreign_key/version"
+require "forceful_foreign_key/graph"
+
+module ActiveRecord::ConnectionAdapters::SchemaStatements
+  alias_method :old_add_foreign_key, :add_foreign_key
+
+  def add_foreign_key(from_table, to_table, options = {})
+    return unless supports_foreign_keys?
+    if options[:force]
+      graph = ForcefulForeignKey::Graph.new
+      graph.build_graph
+      graph.delete_orphans(from_table: from_table,
+                           from_column: options[:column] || "#{to_table}_id",
+                           target_table: to_table,
+                           target_column: options[:primary_key] || 'id')
+    end
+    old_add_foreign_key from_table, to_table, options
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: forceful_foreign_key
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shaw3257
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !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: database_cleaner
+  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: pry
+  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: Forcefully creates a foreign key and will recursively delete
+email:
+- shaw3257@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- forceful_foreign_key.gemspec
+- lib/forceful_foreign_key.rb
+- lib/forceful_foreign_key/graph.rb
+- lib/forceful_foreign_key/version.rb
+homepage: https://github.com/viewthespace/forceful-foreign-key
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Forcefully creates a foreign key
+test_files: []