activerecord-referential_integrity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6ac2cbc77863e65e24222f60379683214e8e914
+  data.tar.gz: d6c9043d8d080abd16499431d0c3b7b2dbcfed14
+SHA512:
+  metadata.gz: 3d20175adab2ba64911e5613c4d185a3182ec0c5f5207efc1c7dacb4d1e7633f30bf9bb3eff55617efb11c9fe495ceb2f2de068fb5c7c86705dc89c05be46592
+  data.tar.gz: aac8adca5abed2d1fda0dec2a73938e8a4f1fc5de7ffa159eb1b5b3e2ff3cacee0e908f4a6e8abdbc418041a2d60dabb219a63fa94bc7a0603a66913f0e8bd17

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Orcas Net, Inc.
+
+MIT License
+
+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,59 @@
+# Referential Integrity for ActiveRecord
+
+Adds as reversible `add_foreign_key` migration to Rails. `add_foreign_key` 
+creates a database level foreign key constraint, this ensures that records 
+cannot reference foreign keys in other tables that do not exist.
+
+See [PostgreSQL foreign key constraint documentation](http://www.postgresql.org/docs/9.3/static/ddl-constraints.html#DDL-CONSTRAINTS-FK) 
+for more.
+
+## Limitations
+
+Currently supports only PostgreSQL.
+Currently is written against Rails/ActiveRecord 3.2.16.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-referential_integrity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-referential_integrity
+
+## Usage
+
+Inside your migrations, call `add_foreign_key`, passing in the table and a hash of column => table pairs.
+
+For example:
+```ruby
+class CreateUserSettings < ActiveRecord::Migration
+  def change
+    create_table :user_settings do |t|
+      t.references :user, null: false
+      # or t.integer :user_id, null: false
+      [...]
+    end
+    
+    add_foreign_key :somethings, :user_id => :users
+  end
+end
+```
+
+TODO: Write usage instructions here
+
+## Versioning
+Uses [Semantic Versioning](http://semver.org).
+
+## Contributing
+
+1. Fork it (http://github.com/orcasnet/activerecord-referential_integrity/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/activerecord-referential_integrity.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/referential_integrity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-referential_integrity'
+  spec.version       = ActiveRecord::ReferentialIntegrity::VERSION
+  spec.authors       = ['Martin Tithonium', 'John Wulff']
+  spec.email         = ['marty@orcasnet.com', 'johnw@orcasnet.com']
+  spec.summary       = %q{Adds add_foreign_key to Rails migrations with relevant databases}
+  spec.description   = %q{Adds as reversible add_foreign_key migration to Rails. Currently supports only PostgreSQL}
+  spec.homepage      = 'https://github.com/orcasnet/activerecord-referential_integrity'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 3.2.16'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/activerecord-referential_integrity.rb

@@ -0,0 +1,9 @@
+require 'activerecord/referential_integrity/version'
+require 'activerecord/referential_integrity/active_record/connection_adapters/abstract_adapter'
+require 'activerecord/referential_integrity/active_record/connection_adapters/postgresql_adapter'
+require 'activerecord/referential_integrity/active_record/migration/command_recorder'
+
+module ActiveRecord
+  module ReferentialIntegrity
+  end
+end

data/lib/activerecord/referential_integrity/active_record/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,9 @@
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  def add_foreign_key(table, keypairs)
+    raise NotImplementedError, 'add_foreign_key is not implemented'
+  end
+
+  def drop_foreign_key(table, keys)
+    raise NotImplementedError, 'drop_foreign_key is not implemented'
+  end
+end

data/lib/activerecord/referential_integrity/active_record/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,19 @@
+class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+  def add_foreign_key(table, keypairs)
+    keypairs.each_pair do |foreign_key, foreign_table|
+      sql =  "ALTER TABLE #{table} "
+      sql << "ADD CONSTRAINT #{table}_fk_#{foreign_key} "
+      sql << "FOREIGN KEY (#{foreign_key}) "
+      sql << "REFERENCES #{foreign_table} (id)"
+      execute sql
+    end
+  end
+
+  def drop_foreign_key(table, keys)
+    keys.each do |foreign_key|
+      sql =  "ALTER TABLE #{table} "
+      sql << "DROP CONSTRAINT IF EXISTS #{table}_fk_#{foreign_key} "
+      execute sql
+    end
+  end
+end

data/lib/activerecord/referential_integrity/active_record/migration/command_recorder.rb

@@ -0,0 +1,11 @@
+class ActiveRecord::Migration::CommandRecorder
+  def add_foreign_key(*args)
+    record(:add_foreign_key, args)
+  end
+  
+  private
+  
+  def invert_add_foreign_key(args)
+    [:drop_foreign_key, [args.first, args.last.keys]]
+  end
+end

data/lib/activerecord/referential_integrity/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ReferentialIntegrity
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-referential_integrity
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Tithonium
+- John Wulff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.16
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Adds as reversible add_foreign_key migration to Rails. Currently supports
+  only PostgreSQL
+email:
+- marty@orcasnet.com
+- johnw@orcasnet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-referential_integrity.gemspec
+- lib/activerecord-referential_integrity.rb
+- lib/activerecord/referential_integrity/active_record/connection_adapters/abstract_adapter.rb
+- lib/activerecord/referential_integrity/active_record/connection_adapters/postgresql_adapter.rb
+- lib/activerecord/referential_integrity/active_record/migration/command_recorder.rb
+- lib/activerecord/referential_integrity/version.rb
+homepage: https://github.com/orcasnet/activerecord-referential_integrity
+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.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Adds add_foreign_key to Rails migrations with relevant databases
+test_files: []