fides 0.0.2

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fides.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marty Kraft
+
+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,63 @@
+# Fides
+
+This gem adds helper methods for use in Rails migrations that creates SQL triggers to enforce the 
+integrity of polymorphic associations at the database level.
+
+When an attempt is made to create or update a record in a polymorphic table the SQL trigger checks for
+the existance of the referred-to model of the specified type in the other table. If it doesn't exist in 
+it throws a descriptive SQL exception.
+
+Similarly, when an attempt is made to delete a record from a table that could be pointed to from the
+polymorphic table, a SQL trigger checks that there are no references to it in the polymorphic table. If
+there are it throws a SQL exception suggesting changing the delete order.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fides'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fides
+
+## Usage
+
+Fides has the following public methods:
+
+- `add_polymorphic_triggers`
+- `remove_polymorphic_triggers`
+
+Following the [Rails Polymorphic Associations example](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations),
+you would do the following in a migration:
+
+    class AddReferentialIntegrityToImageable < ActiveRecord::Migration
+
+      def self.up
+        add_polymorphic_triggers(:polymorphic_model => "Picture", :has_many_models => ["Employee", "Product"])
+      end
+
+      def self.down
+        remove_polymorphic_triggers(:polymorphic_model => "Picture")
+      end
+    
+    end
+
+Fides assumes the use of Rails conventions, so if there's something that needs overriding just open a
+bug or shoot me a pull request.
+
+## Caveats
+
+Fides currently only functions with PostgreSQL. Please feel free to contribute other adapters.
+
+## Contributing
+
+1. Fork it
+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,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+ 
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/fides'
+  t.test_files = FileList['test/lib/fides/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/fides.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fides/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fides"
+  spec.version       = Fides::VERSION
+  spec.authors       = ["Martin Kraft"]
+  spec.email         = ["martin.kraft@gmail.com"]
+  spec.description   = %q{Maintains referential integrity of Rails polymorphic associations.}
+  spec.summary       = %q{Creates SQL triggers from Rails migrations to enforce the integrity of 
+                        polymorphic associations at the database level.}
+  spec.homepage      = "https://github.com/mkraft/fides"
+  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 "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/fides/version.rb

@@ -0,0 +1,3 @@
+module Fides
+  VERSION = "0.0.2"
+end

data/lib/fides.rb

@@ -0,0 +1,120 @@
+require "fides/version"
+require 'active_support/concern'
+
+module Fides
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    def add_polymorphic_triggers(opts)
+      has_many_models = opts[:has_many_models]
+      polymorphic_model = opts[:polymorphic_model]
+      interface_name = opts.has_key?(:interface_name) ? opts[:interface_name] : interface_name(polymorphic_model)
+
+      sql = get_create_function_sql(interface_name, has_many_models, polymorphic_model)
+      sql << get_delete_function_sql(interface_name, has_many_models, polymorphic_model)
+
+      execute sql
+    end
+
+    def remove_polymorphic_triggers(opts)
+      polymorphic_model = opts[:polymorphic_model]
+      interface_name = opts.has_key?(:interface_name) ? opts[:interface_name] : interface_name(polymorphic_model)
+
+      execute %{
+        DROP FUNCTION IF EXISTS check_#{interface_name}_create_integrity() CASCADE;
+        DROP FUNCTION IF EXISTS check_#{interface_name}_delete_integrity() CASCADE;
+      }
+    end
+
+    private
+
+    # TODO: Is it safe to just grab the first polymorphic association?
+    def interface_name(model_name)
+      model_name.constantize.reflect_on_all_associations.select { |r| r if r.options[:polymorphic] }.first.name
+    end
+
+    def get_create_function_sql(interface_name, models, polymorphic_model)
+      sql = "DROP FUNCTION IF EXISTS check_#{interface_name}_create_integrity() CASCADE;"
+      
+      sql << %{
+        CREATE FUNCTION check_#{interface_name}_create_integrity() RETURNS TRIGGER AS '
+          BEGIN
+            IF NEW.#{interface_name}_type = ''#{models[0]}'' AND EXISTS (
+                SELECT id FROM #{models[0].constantize.table_name} WHERE id = NEW.#{interface_name}_id) THEN
+              RETURN NEW;
+      }
+
+      models[1..-1].each do |model|
+        sql << %{
+          ELSEIF NEW.#{interface_name}_type = ''#{model}'' AND EXISTS (
+              SELECT id FROM #{model.constantize.table_name} WHERE id = NEW.#{interface_name}_id) THEN
+            RETURN NEW;
+        }
+      end
+      
+      sql << %{
+            ELSE
+              RAISE EXCEPTION ''No % model with id %.'', NEW.#{interface_name}_type, NEW.#{interface_name}_id;
+              RETURN NULL;
+            END IF;
+          END'
+          LANGUAGE plpgsql;
+
+          CREATE TRIGGER check_#{interface_name}_create_integrity_trigger 
+            BEFORE INSERT OR UPDATE ON #{polymorphic_model.constantize.table_name} 
+            FOR EACH ROW EXECUTE PROCEDURE check_#{interface_name}_create_integrity();
+      }
+
+      return sql
+    end
+
+    def get_delete_function_sql(interface_name, models, polymorphic_model)
+      polymorphic_model_table_name = polymorphic_model.constantize.table_name
+      
+      sql = ""
+      sql << %{
+        CREATE FUNCTION check_#{interface_name}_delete_integrity() RETURNS TRIGGER AS '
+          BEGIN
+            IF TG_TABLE_NAME = ''#{models[0].constantize.table_name}'' AND EXISTS (
+              SELECT id FROM #{polymorphic_model_table_name} 
+              WHERE #{interface_name}_type = ''#{models[0]}'' AND #{interface_name}_id = OLD.id) THEN
+              RAISE EXCEPTION ''There are records in #{polymorphic_model_table_name} that refer to %. You must delete those records first.'', OLD;
+      }
+
+      models[1..-1].each do |model|
+        sql << %{
+          ELSEIF TG_TABLE_NAME = ''#{model.constantize.table_name}'' AND EXISTS (
+            SELECT id FROM #{polymorphic_model_table_name} 
+            WHERE #{interface_name}_type = ''#{model}'' AND #{interface_name}_id = OLD.id) THEN
+              RAISE EXCEPTION ''There are records in #{polymorphic_model_table_name} that refer to %. You must delete those records first.'', OLD;
+        }
+      end
+
+      sql << %{
+            ELSE
+              RETURN NULL;
+            END IF;
+          END'
+        LANGUAGE plpgsql;
+      }
+
+      models.each do |model|
+        table_name = model.constantize.table_name
+        
+        sql << %{
+          CREATE TRIGGER check_#{table_name}_delete_integrity_trigger 
+            BEFORE DELETE ON #{table_name} 
+            FOR EACH ROW EXECUTE PROCEDURE check_#{interface_name}_delete_integrity();
+        }
+      end
+
+      return sql
+    end
+
+  end
+
+end
+
+ActiveRecord::Migration.send(:include, Fides)

data/test/lib/fides/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+ 
+describe Fides do
+ 
+  it "must be defined" do
+    Fides::VERSION.wont_be_nil
+  end
+ 
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/fides.rb', __FILE__)

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fides
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Martin Kraft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Maintains referential integrity of Rails polymorphic associations.
+email:
+- martin.kraft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fides.gemspec
+- lib/fides.rb
+- lib/fides/version.rb
+- test/lib/fides/version_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mkraft/fides
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Creates SQL triggers from Rails migrations to enforce the integrity of  polymorphic
+  associations at the database level.
+test_files:
+- test/lib/fides/version_test.rb
+- test/test_helper.rb