polymorpheus 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ed8d4d7c368cb6a0881483bee736be9da580d24
-  data.tar.gz: 91f6db54c6323d392b470c97dfbc26c01d2f5946
+  metadata.gz: 2b4fa428b1261c05072970feddd72eca1d4e0d70
+  data.tar.gz: 189801e622b209426bb6e39b86a32b7c34bbc954
 SHA512:
-  metadata.gz: 6ae1e2d62b17fb7634779da45165fbec63ce59684dcd038db73d0730f301653a2d5223373fdc0fb4bdab39569432db043d95d8820c449a7972332ceb4088ef2d
-  data.tar.gz: 70a440da6a5470585de16d9478e9899f0ba428ea3c5b8b1cd6e37ce4eb1070f2f575f96f826a47caaf98669e1a572a69360751ebb4ac13701dde79827a23547f
+  metadata.gz: 1624b4a33ce2a7875acda4688ebad9662e2f6201e01d329196cee018acfcbec0bafe86f3d07c732c383525e13b96e3fda65b510f29201615aa7637803300b32c
+  data.tar.gz: f207481aef2d8e20c22c7efb2d86691c2d9ed6ba241356e7eb977a27c3d7c90c1f9aceab5f3b4972956f730ca0baa850d6c5b3e0a38866f54a478e6b8daaeb29

data/README.md

@@ -198,6 +198,6 @@ pic.polymorpheus.query_condition
 * It uses the [Foreigner gem](https://github.com/matthuhiggins/foreigner) under
   the hood for a few things
 
-polymorpheus is Copyright © 2011-2012 Barun Singh and [WegoWise](
+polymorpheus is Copyright © 2011-2015 Barun Singh and [WegoWise](
 http://wegowise.com). It is free software, and may be redistributed under the
 terms specified in the LICENSE file.

data/lib/polymorpheus/mysql_adapter.rb

@@ -5,37 +5,59 @@ module Polymorpheus
       INSERT = 'INSERT'
       UPDATE = 'UPDATE'
 
-      # See the README for explanations regarding the use of these methods
+      # See the README for more information about the use of these methods.
       #
       # table:    a string equal to the name of the db table
       #
       # columns:  a hash, with keys equal to the column names in the table we
       #           are operating on, and values indicating the foreign key
-      #           association through the form "table.column". so,
-      #             { 'employee_id' => 'employees.ssn',
-      #               'product_id' => 'products.id' }
-      #           indicates that the `employee_id` column in `table` should have
-      #           a foreign key constraint connecting it to the `ssn` column
-      #           in the `employees` table, and the `product_id` column should
-      #           have a foreign key constraint with the `id` column in the
-      #           `products` table
-      #
-      # options:  a hash, corrently only accepts one option that allows us to
-      #           add an additional uniqueness constraint.
-      #           if the columns hash was specified as above, and we supplied
-      #           options of
-      #             { :unique => true }
-      #           then this would create a uniqueness constraint in the database
-      #           that would ensure that any given employee_id could only be in
-      #           the table once, and that any given product_id could only be in
-      #           the table once.
-      #
-      #           alternatively, the user can also supply a column name or array
-      #           of column names to the :unique option:
-      #             { :unique => 'picture_url' }
-      #           This would allow an employee_id (or product_id) to appear
-      #           multiple times in the table, but no two employee ids would
-      #           be able to have the same picture_url.
+      #           association through the form "table.column".
+      #
+      #           For example:
+      #
+      #             {
+      #               'employee_id' => 'employees.ssn',
+      #               'product_id' => 'products.id'
+      #             }
+      #
+      #           This indicates that the `employee_id` column in `table`
+      #           should have a foreign key constraint connecting it to the
+      #           `ssn` column in the `employees` table, and the `product_id`
+      #           column should have a foreign key constraint with the `id`
+      #           column in the `products` table.
+      #
+      # options:  a hash, accepting the following options
+      #
+      #   :unique
+      #
+      #       If the columns hash was specified as above, and :unique is true:
+      #
+      #         { :unique => true }
+      #
+      #       Then this creates a uniqueness constraint in the database that
+      #       will ensure that any given employee_id can only be in the table
+      #       once, and that any given product_id can only be in the table
+      #       once.
+      #
+      #       Alternatively, you can supply a column name or array of column
+      #       names to the :unique option:
+      #
+      #         { :unique => 'picture_url' }
+      #
+      #       This will allow an employee_id (or product_id) to appear multiple
+      #       times in the table, but no two employee IDs would be able to have
+      #       the same picture_url.
+      #
+      #    :on_delete
+      #
+      #        Action that happens ON DELETE. Valid values are :nullify,
+      #        :cascade and :restrict.
+      #
+      #    :on_update
+      #
+      #        Action that happens ON UPDATE. Valid values are :nullify,
+      #        :cascade and :restrict.
+
 
       def add_polymorphic_constraints(table, columns, options={})
         column_names = columns.keys.sort
@@ -48,7 +70,8 @@ module Polymorpheus
           ref_table, ref_col = columns[col_name].to_s.split('.')
           add_foreign_key table, ref_table,
                                  :column => col_name,
-                                 :primary_key => (ref_col || 'id')
+                                 :primary_key => (ref_col || 'id'),
+                                 :options => generate_constraints(options)
         end
       end
 
@@ -167,6 +190,27 @@ module Polymorpheus
           columns.map { |c| c.to_s.gsub('_','').first(col_length-1) }.join('_')
       end
 
+      def generate_constraints(options)
+        constraints = []
+
+        ['delete', 'update'].each do |event|
+          option = "on_#{event}".to_sym
+          next unless options.has_key?(option) &&
+                      options[option].respond_to?(:to_sym)
+
+          action = case options[option].to_sym
+            when :nullify then 'SET NULL'
+            when :cascade then 'CASCADE'
+            when :restrict then 'RESTRICT'
+          end
+          next unless action
+
+          constraints << "ON #{event.upcase} #{action}"
+        end
+
+        constraints.join(' ')
+      end
+
     end
   end
 end
@@ -179,4 +223,3 @@ end
   rescue
   end
 end
-

data/lib/polymorpheus/version.rb

@@ -1,3 +1,3 @@
 module Polymorpheus
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/polymorpheus.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency('foreigner')
   s.add_dependency('activerecord', '>= 3.2', '< 4.2')
+
+  s.add_development_dependency('rake', '~> 10.4.2')
   s.add_development_dependency('rspec-rails', '~> 2.14.0')
-  s.add_development_dependency('mysql2', '~> 0.3')
+  s.add_development_dependency('mysql2', '~> 0.3.10')
 end

data/spec/mysql2_adapter_spec.rb

@@ -99,6 +99,39 @@ describe Polymorpheus::ConnectionAdapters::MysqlAdapter do
       it_behaves_like "mysql2 migration statements"
     end
 
+    context "specifying an on update constraint" do
+      include_context "columns with short names"
+      let(:options) { { :on_update => :cascade } }
+      let(:fkey_sql) do
+        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id) ON UPDATE CASCADE
+           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) ON UPDATE CASCADE }
+      end
+
+      it_behaves_like "mysql2 migration statements"
+    end
+
+    context "specifying on delete and on update constraints" do
+      include_context "columns with short names"
+      let(:options) { { :on_update => :cascade, :on_delete => :restrict } }
+      let(:fkey_sql) do
+        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id) ON DELETE RESTRICT ON UPDATE CASCADE
+           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) ON DELETE RESTRICT ON UPDATE CASCADE }
+      end
+
+      it_behaves_like "mysql2 migration statements"
+    end
+
+    context "when on_delete and on_update have invalid arguments" do
+      include_context "columns with short names"
+      let(:options) { { :on_update => :invalid, :on_delete => nil } }
+      let(:fkey_sql) do
+        %{ ALTER TABLE `pets` ADD CONSTRAINT `pets_dog_id_fk` FOREIGN KEY (`dog_id`) REFERENCES `dogs`(id)
+           ALTER TABLE `pets` ADD CONSTRAINT `pets_kitty_id_fk` FOREIGN KEY (`kitty_id`) REFERENCES `cats`(name) }
+      end
+
+      it_behaves_like "mysql2 migration statements"
+    end
+
     context "when table and column names combined are very long" do
       include_context "columns with long names"
 

metadata

@@ -1,77 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: polymorpheus
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Barun Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreigner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.10
 description: Provides a database-friendly method for polymorphic relationships
 email: bsingh@wegowise.com
 executables: []
@@ -120,12 +134,12 @@ 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: 1.3.6
 requirements: []