polymorphic_constraints 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed6f087b6184e90229664c7babc83e07cbef14b7
+  data.tar.gz: 11e033df6d896daa23f5ab6e1bf11c715fe81451
+SHA512:
+  metadata.gz: 1388891050a080dd7b8db0fd7370b46f95c66aafdb5c76533c565c78cd4b642b165304f1c86bf287cb79554c17d1a70f61cf00aef33bd41fdd1549c69dc107b3
+  data.tar.gz: df0f4e667bfe22ccb6980f8bac7621678b3bb3afa11291b4901b25bf73f33a7c5917a2def524065ef9ea198c72719ef163136425fd6726bab0ed18f707c8ea5d

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+Gemfile.lock
+gemfiles/*.lock
+coverage/
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3
+gemfile:
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_3.2.gemfile
+  - gemfiles/rails_3.1.gemfile

data/Appraisals

@@ -0,0 +1,15 @@
+appraise 'rails-3.1' do
+  gem 'rails', '3.1.12'
+end
+
+appraise 'rails-3.2' do
+  gem 'rails', '3.2.18'
+end
+
+appraise 'rails-4.0' do
+  gem 'rails', '4.0.10'
+end
+
+appraise 'rails-4.1' do
+  gem 'rails', '4.1.6'
+end

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in polymorphic_constraints.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+gem 'appraisal'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,254 @@
+# Polymorphic Constraints
+
+[![Build Status](https://travis-ci.org/musaffa/polymorphic_constraints.svg)](https://travis-ci.org/musaffa/polymorphic_constraints)
+[![Coverage Status](https://coveralls.io/repos/musaffa/polymorphic_constraints/badge.png)](https://coveralls.io/r/musaffa/polymorphic_constraints)
+[![Code Climate](https://codeclimate.com/github/musaffa/polymorphic_constraints/badges/gpa.svg)](https://codeclimate.com/github/musaffa/polymorphic_constraints)
+
+Polymorphic Constraints gem introduces some methods to your migrations to help to maintain the referential integrity for your Rails polymorphic associations.
+
+It uses triggers to enforce the constraints. It enforces constraints on `insert`, `update` and `delete`. `update` and `delete` constraints works like the `:restrict` option of foreign key. 
+
+## Support
+
+It supports the following adapters:
+
+* sqlite3
+* postgresql
+* mysql2
+
+Supported platforms:
+
+* Ruby versions - 1.9.3, 2.0, 2.1 or greater
+* Rails versions - 3.1, 3.2, 4.0, 4.1 or greater
+
+(let me know if it works on lesser rails versions)
+
+## Installation
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'polymorphic_constraints'
+```
+
+## API Examples
+
+This gem adds the following methods to your migrations:
+
+* add_polymorphic_constraints(relation, associated_model, options)
+* update_polymorphic_constraints(relation, associated_model, options)
+* remove_polymorphic_constraints(relation)
+
+From [Rails Guide](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations)
+take these examples:
+
+```ruby
+class Picture < ActiveRecord::Base
+  belongs_to :imageable, polymorphic: true
+end
+ 
+class Employee < ActiveRecord::Base
+  has_many :pictures, as: :imageable, dependent: :destroy
+end
+ 
+class Product < ActiveRecord::Base
+  has_many :pictures, as: :imageable
+end
+```
+
+Add a new migration:
+
+```ruby
+class AddPolymorphicConstraints < ActiveRecord::Migration
+  def change
+    add_polymorphic_constraints :imageable, :pictures
+  end
+end
+```
+Or you can add it to pictures migration:
+
+```ruby
+class CreateComments < ActiveRecord::Migration
+  create_table :pictures do |t|
+    t.references :imageable, polymorphic: true
+    t.timestamps
+  end
+
+  add_polymorphic_constraints :imageable, :pictures
+end
+```
+For the second method to work properly, the polymorphic tables `employees` and `products` have to be in the database first i.e `pictures` migration should come after the migrations of `employees` and `products`.
+
+run: `rake db:migrate`
+
+This migration will create the necessary triggers to apply insert, update and delete constraints on polymorphic relation named `imageable`.
+
+```ruby
+# insert
+>> picture = Picture.new
+>> picture.imageable_id = 1
+>> picture.imageable_type = 'Product'
+>> picture.save # raises ActiveRecord::RecordNotFound exception. there's no product with id 1
+
+>> product = Product.create
+
+>> picture.imageable_id = product.id
+>> picture.imageable_type = 'World'
+>> picture.save # raises ActiveRecord::RecordNotFound exception. there's no imageable model named 'World'.
+
+>> picture.imageable_type = product.class.to_s # 'Product'
+>> picture.save # saves successfully
+
+# update
+>> picture.imageable_type = 'Hello'
+>> picture.save # raises ActiveRecord::RecordNotFound exception. there's no imageable model named 'Hello'.
+
+>> employee = Employee.create
+
+>> picture.imageable_id = employee.id
+>> picture.imageable_type = employee.class.to_s # 'Employee'
+>> picture.save # update completes successfully
+
+# delete/destroy
+>> employee.delete # raises ActiveRecord::ReferenceViolation exeption. cannot delete because the picture still refers to the employee as the imageable.
+>> employee.destroy # destroys successfully. unlike product, employee implements dependent destroy on imageable. so it destroys the picture first, then it destroys itself.
+>> Employee.count # 0
+>> Picture.count # 0
+
+>> picture = Picture.new
+>> picture.imageable_id = product.id
+>> picture.imageable_type = product.class.to_s # 'Product'
+>> picture.save
+
+>> product.delete # raises ActiveRecord::ReferenceViolation exeption. cannot delete because the picture still refers to the product as the imageable.
+>> product.destroy # raises ActiveRecord::ReferenceViolation exeption. works the same as delete because product model hasn't implemented dependent destroy on imageable.
+
+>> another_product = Product.create
+>> another_product.delete # deletes successfully as no picture refers to this product.
+```
+
+## Exceptions
+
+* `ActiveRecord::RecordNotFound` - It is raised when insert/update is attempted on a table with a record that refers to a non-existent polymorphic record in another table.
+* `ActiveRecord::ReferenceViolation` - It is raised when a delete is attempted from a polymorphic table that is referred to by a record in the associated table.
+
+_naming convention:_ in the above example `Product` and `Employee` are polymorphic tables. `Picture` is an associated table. 
+
+## Model Search Strategy:
+
+When you add polymorphic constraints like this:
+
+```ruby
+add_polymorphic_constraints :imageable, :pictures
+```
+the gem will search for models acting as imageable using `ActiveRecord::Base.descendants`. This will search all the models including your gems, models directory etc.
+
+You can also explicitly specify the models with which you want to create polymorphic constraints.
+
+```ruby
+add_polymorphic_constraints :imageable, :pictures, polymorphic_models: [:employee]
+```
+This will create polymorphic constraints only between `pictures` and `employees`. `:polymorphic_models` will supersede `ActiveRecord::Base.descendants` search_strategy.
+
+**Note:** `:polymorphic_models` option requires an array. The models specified in the array should be in singular form. Make sure the models indeed have the polymorphic relationship (in this example, `:employee` acting as `:imageable` with `:pictures`).
+
+## Update Constraints
+
+This gem creates triggers using the existing state of the application. If you add any model later or add new polymorphic relationships in the existing model, it wont have any polymorphic constraint applied to it. For example, if you add a member class later in the application life cycle:
+
+```ruby
+class Member < ActiveRecord::Base
+  has_many :pictures, as: :imageable, dependent: :destroy
+end
+```
+There will be no polymorphic constraints between `pictures` and `members`. You have to renew the `imageable` constraints by adding another migration:
+
+```ruby
+class AgainUpdatePolymorphicConstraints < ActiveRecord::Migration
+  def change
+    update_polymorphic_constraints :imageable, :pictures
+  end
+end
+```
+This will delete all the existing `:imageable` constraints and create new ones. You can also specify `:polymorphic_models` options with `update_polymorphic_constraints` method. See [Model Search Strategy](#model-search-strategy)
+
+**Note:** `update_polymorphic_constraints` is simply an alias to `add_polymorphic_constraints`.
+
+## Schema Dump
+
+The gem doesn't support `ruby` schema dump yet. You have to dump `sql` instead of schema.rb. To do this, change the application config settings:
+
+```ruby
+# app/config/application.rb
+config.active_record.schema_format = :sql
+```
+
+```ruby
+rake db:structure:dump
+```
+
+## Migration Rollback
+
+`add_polymorphic_constraints` and `update_polymorphic_constraints` are both reversible. So you don't need to worry about rollback.
+
+```ruby
+class AddPolymorphicConstraints < ActiveRecord::Migration
+  def change
+    add_polymorphic_constraints :imageable, :pictures
+  end
+end
+```
+
+You can also use `up` and `down` like this:
+
+```ruby
+class AddPolymorphicConstraints < ActiveRecord::Migration
+  def self.up
+    add_polymorphic_constraints :imageable, :pictures
+  end
+
+  def self.down
+    remove_polymorphic_constraints :imageable
+  end
+end
+```
+
+This `remove_polymorphic_constraints` will delete all the existing `:imageable` constraints during rollback.
+
+**Caution:** After migration, always test if rollback works properly.
+
+## Tests
+
+```ruby
+rake
+rake test:unit
+rake test:integration:all
+rake test:integration:sqlite
+rake test:integration:postgresql
+rake test:integration:mysql
+```
+
+## Problems
+
+Please use GitHub's [issue tracker](http://github.com/musaffa/polymorphic_constraints/issues).
+
+## TODO
+1. Ruby schema dump
+2. Supporting `on_delete`, `on_update` options with `:nullify`, `:restrict` and `:cascade`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Inspirations
+
+* [Foreigner](https://github.com/matthuhiggins/foreigner)
+* [Fides](https://github.com/mkraft/fides)
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= PolymorphicConstraints
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,61 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'fileutils'
+# require 'rdoc/task'
+
+namespace :test do
+  task :prepare_database do
+    FileUtils.copy 'spec/dummy/config/database.sqlite.yml', 'spec/dummy/config/database.yml'
+  end
+
+  RSpec::Core::RakeTask.new(:unit_specs) do |t|
+    t.pattern = ['spec/lib/**/*_spec.rb']
+  end
+
+  task :unit => [:prepare_database, :unit_specs]
+
+  namespace :integration do
+    rule '.yml' do |file|
+      FileUtils.copy ('spec/dummy/config/' + file.name), 'spec/dummy/config/database.yml'
+    end
+
+    task :sqlite => 'database.sqlite.yml' do
+      RSpec::Core::RakeTask.new(:sqlite_integration) do |t|
+        t.pattern = 'spec/integration/active_record_integration_spec.rb'
+      end
+      Rake::Task['sqlite_integration'].execute
+    end
+    task :postgresql => 'database.postgresql.yml' do
+      RSpec::Core::RakeTask.new(:postgresql_integration) do |t|
+        t.pattern = 'spec/integration/active_record_integration_spec.rb'
+      end
+      Rake::Task['postgresql_integration'].execute
+    end
+    task :mysql => 'database.mysql.yml' do
+      RSpec::Core::RakeTask.new(:mysql_integration) do |t|
+        t.pattern = 'spec/integration/active_record_integration_spec.rb'
+      end
+      Rake::Task['mysql_integration'].execute
+    end
+
+    task :all => [:sqlite, :postgresql, :mysql]
+  end
+end
+
+task :default => ['test:unit', 'test:integration:all']
+
+# RDoc::Task.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'PolymorphicConstraints'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.rdoc')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+# Bundler::GemHelper.install_tasks

data/gemfiles/rails_3.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "3.1.12"
+
+gemspec :path => "../"

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "3.2.18"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "4.0.10"
+
+gemspec :path => "../"