polymorphic_integer_type 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6c2cf440c0f3c18a7617ca1afb6ef64df29f5318
-  data.tar.gz: c69f7e53591f29f1ca30f34824fcd82cf0d8347f
+SHA256:
+  metadata.gz: 0d7804d64bb9623f7c1e99d9cc3e9d87660c4aa0377dcb990d0f36116e9d0f84
+  data.tar.gz: 4530a6917ae04b9e5b22823551a2c999909b32406d899aad950ac26373db333a
 SHA512:
-  metadata.gz: 6d53e634ae33cd8ea9be786f8e5d8416154773a5795bff1a9d9b943961336755d416fef200cea78655d67d74253b52d95d2c18d1949cbd71f98550bc40050e12
-  data.tar.gz: 3a35e05e8c28d847255c7f16168bda71f176f247f6260e2d54879e2a295764fd8f5a93de7dbbb146505040477a7e0e162755d6f8983e57de0ded30ba796d8158
+  metadata.gz: 0017c3e990e834177af622495715ea839c720bd5d511faf9675ae74820e9bff2a2cf63c7d648b7098b135b009a88a7f5a8386ee359e412f22749c77980d18939
+  data.tar.gz: 156289387a5dd038b1c8380b18514e78f9f3c418c0fd0fff5deb844d8a94006ea742fd3cc47ed6948cf970f3e1dde106df0a60b781b388300ed969aa5f6bdb7c

data/README.md

@@ -6,11 +6,11 @@ Rails' polymorphic associations are pretty useful. The example they give to set
 class Picture < ActiveRecord::Base
   belongs_to :imageable, polymorphic: true
 end
- 
+
 class Employee < ActiveRecord::Base
   has_many :pictures, as: :imageable
 end
- 
+
 class Product < ActiveRecord::Base
   has_many :pictures, as: :imageable
 end
@@ -31,7 +31,7 @@ class CreatePictures < ActiveRecord::Migration
 end
 ```
 
-The problem with this approach is that `imageable_type` is a string (and by default it is 255 characters). This is a little ridiculous. For comparison, if we had a state machine with X states, would we describe the states with strings `"State1", "State2", etc` or would we just enumerate the state column and make it an integer? This gem will allow us to use an integer for the `imageable_type` column. 
+The problem with this approach is that `imageable_type` is a string (and by default it is 255 characters). This is a little ridiculous. For comparison, if we had a state machine with X states, would we describe the states with strings `"State1", "State2", etc` or would we just enumerate the state column and make it an integer? This gem will allow us to use an integer for the `imageable_type` column.
 
 ## Installation
 
@@ -60,7 +60,7 @@ class Picture < ActiveRecord::Base
   belongs_to :imageable, polymorphic: {1 => "Employee", 2 => "Product"}
 end
 ```
- 
+
  Next, include `PolymorphicIntegerType::Extensions` into any of the models that point back to the polymorphic integer type association (e.g., `Picture#imageable`) and add a [polymorphic association using `as:`](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations).
 
 ```ruby
@@ -69,7 +69,7 @@ class Employee < ActiveRecord::Base
 
   has_many :pictures, as: :imageable
 end
- 
+
 class Product < ActiveRecord::Base
   include PolymorphicIntegerType::Extensions
 
@@ -84,10 +84,10 @@ You can also store polymorphic type mappings separate from your models. This sho
 ```ruby
 PolymorphicIntegerType::Mapping.configuration do |config|
   config.add :imageable, {1 => "Employee", 2 => "Product" }
-end 
+end
 ```
 
-Note: The mapping here can start from whatever integer you wish, but I would advise not using 0. The reason being that if you had a new class, for instance `Avatar`, and also wanted to use this polymorphic association but forgot to include it in the mapping, it would effectively get `to_i` called on it and stored in the database. `"Avatar".to_i == 0`, so if your mapping included 0, this would create a weird bug. 
+Note: The mapping here can start from whatever integer you wish, but I would advise not using 0. The reason being that if you had a new class, for instance `Avatar`, and also wanted to use this polymorphic association but forgot to include it in the mapping, it would effectively get `to_i` called on it and stored in the database. `"Avatar".to_i == 0`, so if your mapping included 0, this would create a weird bug.
 
 ### Migrating an existing association
 
@@ -95,14 +95,14 @@ If you want to convert a polymorphic association that is already a string, you'l
 
 ```ruby
 class PictureToPolymorphicIntegerType < ActiveRecord::Migration
-  
+
   def up
     change_table :pictures do |t|
       t.integer :new_imageable_type
     end
 
     execute <<-SQL
-      UPDATE reminders
+      UPDATE picture
       SET new_imageable_type = CASE imageable_type
                                  WHEN 'Employee' THEN 1
                                  WHEN 'Product' THEN 2

data/lib/polymorphic_integer_type.rb

@@ -3,6 +3,8 @@ ACTIVE_RECORD_VERSION = Gem::Version.new(ActiveRecord::VERSION::STRING)
 require "polymorphic_integer_type/version"
 require "polymorphic_integer_type/extensions"
 require "polymorphic_integer_type/mapping"
+require "polymorphic_integer_type/module_generator"
+require "polymorphic_integer_type/belongs_to_polymorphic_association_extension"
 
 if ACTIVE_RECORD_VERSION < Gem::Version.new("5")
   require "polymorphic_integer_type/activerecord_4/predicate_builder_extension"
@@ -14,8 +16,4 @@ if ACTIVE_RECORD_VERSION >= Gem::Version.new("5.0") && ACTIVE_RECORD_VERSION < G
   require "polymorphic_integer_type/activerecord_5_0_0/association_query_handler_extension"
 end
 
-if ACTIVE_RECORD_VERSION < Gem::Version.new("5.2.0")
-  require "polymorphic_integer_type/activerecord_4/belongs_to_polymorphic_association_extension"
-end
-
 module PolymorphicIntegerType; end

data/lib/polymorphic_integer_type/activerecord_5_0_0/polymorphic_array_value_extension.rb

@@ -1,17 +1,31 @@
 module PolymorphicIntegerType
   module PolymorphicArrayValueExtension
+
+    # original method:
+    # def type_to_ids_mapping
+    #   default_hash = Hash.new { |hsh, key| hsh[key] = [] }
+    #   result = values.each_with_object(default_hash) do |value, hash|
+    #     hash[klass(value).polymorphic_name] << convert_to_id(value)
+    #   end
+    # end
+
     def type_to_ids_mapping
-      super.tap do |result|
-        association = @associated_table.send(:association)
-        klass = association.active_record
-        name = association.name
+      association = @associated_table.send(:association)
+      name = association.name
+      default_hash = Hash.new { |hsh, key| hsh[key] = [] }
+      values.each_with_object(default_hash) do |value, hash|
+        klass = respond_to?(:klass, true) ? klass(value) : value.class
+        if association.active_record.respond_to?("#{name}_type_mapping")
+          mapping = association.active_record.send("#{name}_type_mapping")
+          key ||= mapping.key(klass.polymorphic_name) if klass.respond_to?(:polymorphic_name)
+          key ||= mapping.key(klass.sti_name)
+          key ||= mapping.key(klass.base_class.to_s)
+          key ||= mapping.key(klass.base_class.sti_name)
 
-        if klass.respond_to?("#{name}_type_mapping")
-          result.transform_keys! do |key|
-            klass.send("#{name}_type_mapping").key(key)
-          end
+          hash[key] << convert_to_id(value)
+        else
+          hash[klass.polymorphic_name] << convert_to_id(value)
         end
-        result
       end
     end
   end

data/lib/polymorphic_integer_type/{activerecord_4/belongs_to_polymorphic_association_extension.rb → belongs_to_polymorphic_association_extension.rb}

@@ -3,7 +3,9 @@ module ActiveRecord
     class BelongsToPolymorphicAssociation < BelongsToAssociation
       private def replace_keys(record)
         super
-        owner[reflection.foreign_type] = record.class.base_class
+        unless record.nil?
+          owner[reflection.foreign_type] = record.class.base_class
+        end
       end
     end
   end

data/lib/polymorphic_integer_type/extensions.rb

@@ -20,37 +20,11 @@ module PolymorphicIntegerType
           _polymorphic_foreign_types << foreign_type
 
           # Required way to dynamically define a class method on the model
-          singleton_class.__send__(:define_method, "#{foreign_type}_mapping") do
+          define_singleton_method("#{foreign_type}_mapping") do
             mapping
           end
 
-          foreign_type_extension = Module.new do
-            define_method foreign_type do
-              t = super()
-              self.class.send("#{foreign_type}_mapping")[t]
-            end
-
-            define_method "#{foreign_type}=" do |klass|
-              mapping = self.class.send("#{foreign_type}_mapping")
-              enum = mapping.key(klass.to_s)
-              if klass.kind_of?(Class) && klass <= ActiveRecord::Base
-                enum ||= mapping.key(klass.polymorphic_name) if klass.respond_to?(:polymorphic_name)
-                enum ||= mapping.key(klass.sti_name)
-                enum ||= mapping.key(klass.base_class.to_s)
-                enum ||= mapping.key(klass.base_class.sti_name)
-              end
-              enum ||= klass if klass != NilClass
-              super(enum)
-            end
-
-            define_method "#{name}=" do |record|
-              super(record)
-              send("#{foreign_type}=", record.class)
-              association(name).loaded!
-            end
-          end
-
-          include(foreign_type_extension)
+          ModuleGenerator.generate_and_include(self, foreign_type, name)
 
           validate do
             t = send(foreign_type)

data/lib/polymorphic_integer_type/mapping.rb

@@ -15,6 +15,6 @@ module PolymorphicIntegerType
       @@mapping[as] || {}
     end
 
+    singleton_class.send(:alias_method, :[]=, :add)
   end
-
 end

data/lib/polymorphic_integer_type/module_generator.rb

@@ -0,0 +1,34 @@
+module PolymorphicIntegerType
+  class ModuleGenerator
+    def self.generate_and_include(klass,foreign_type, name)
+      foreign_type_extension = Module.new do
+        define_method foreign_type do
+          t = super()
+          self.class.send("#{foreign_type}_mapping")[t]
+        end
+
+        define_method "#{foreign_type}=" do |klass|
+          mapping = self.class.send("#{foreign_type}_mapping")
+          enum = mapping.key(klass.to_s)
+          if klass.kind_of?(Class) && klass <= ActiveRecord::Base
+            enum ||= mapping.key(klass.polymorphic_name) if klass.respond_to?(:polymorphic_name)
+            enum ||= mapping.key(klass.sti_name)
+            enum ||= mapping.key(klass.base_class.to_s)
+            enum ||= mapping.key(klass.base_class.sti_name)
+          end
+          enum ||= klass if klass != NilClass
+          super(enum)
+        end
+
+        define_method "#{name}=" do |record|
+          super(record)
+          send("#{foreign_type}=", record.class)
+          association(name).loaded!
+        end
+      end
+
+      klass.include(foreign_type_extension)
+    end
+  end
+end
+

data/lib/polymorphic_integer_type/version.rb

@@ -1,3 +1,3 @@
 module PolymorphicIntegerType
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/polymorphic_integer_type.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord"
+  spec.add_dependency "activerecord", "< 6"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry-byebug"
 end

data/spec/polymorphic_integer_type_spec.rb

@@ -14,6 +14,50 @@ describe PolymorphicIntegerType do
 
   let(:link) { Link.create(source: source, target: target) }
 
+
+  context "when creating associations" do
+    it "sets the source_type" do
+      link = dog.source_links.new
+      expect(link.source_type).to eq("Animal")
+    end
+
+    it "sets the target_type" do
+      link = kibble.target_links.new
+      expect(link.target_type).to eq("Food")
+    end
+
+    context "when models are namespaced" do
+      context "and mappings include namespaces" do
+        it "sets the source_type" do
+          allow(Link).to receive(:source_type_mapping).and_return({3 => "Namespaced::Plant"})
+          allow(Link).to receive(:source_type_mapping2).and_return({3 => "Namespaced::Plant"})
+
+          link = Namespaced::Plant.create(name: "Oak").source_links.new
+          expect(link.source_type).to eq("Namespaced::Plant")
+        end
+
+        it "sets the target_type" do
+          allow(Link).to receive(:target_type_mapping).and_return({3 => "Namespaced::Activity"})
+          link = Namespaced::Activity.create(name: "swaying").target_links.new
+          expect(link.target_type).to eq("Namespaced::Activity")
+        end
+      end
+
+      context "and mappings don't include namespaces" do
+        it "sets the source type" do
+          Link.source_type_mapping
+          link = Namespaced::Plant.create(name: "Oak").source_links.new
+          expect(link.source_type).to eq("Plant")
+        end
+
+        it "sets the target type" do
+          link = Namespaced::Activity.create(name:"swaying").target_links.new
+          expect(link.target_type).to eq("Activity")
+        end
+      end
+    end
+  end
+
   context "when the source is nil" do
     let(:source) { nil }
     let(:target) { nil }
@@ -73,6 +117,15 @@ describe PolymorphicIntegerType do
     it "properly finds the object with a find_by" do
       expect(Link.find_by(source: source, id: link.id)).to eql link
     end
+
+    context "when source and target are namespaced without modifying polymorphic_name" do
+      it "properly finds the object" do
+        plant = Namespaced::Plant.create(name: "Mighty", kind: "Oak", owner: owner)
+        activity = Namespaced::Activity.create(name: "swaying")
+        link = Link.create(source: plant, target: activity)
+        expect(Link.where(source: plant, id: link.id).first).to eql link
+      end
+    end
   end
 
   shared_examples "proper source" do
@@ -103,7 +156,6 @@ describe PolymorphicIntegerType do
         expect(source.source_links[0].source).to eql source
       end
     end
-
   end
   context "When a link is given polymorphic record" do
     let(:link) { Link.create(source: source) }
@@ -116,9 +168,7 @@ describe PolymorphicIntegerType do
 
       include_examples "proper source"
       include_examples "proper target"
-
     end
-
   end
 
   context "When a link is given polymorphic id and type" do
@@ -131,9 +181,7 @@ describe PolymorphicIntegerType do
       before { link.update_attributes(target_id: target.id, target_type: target.class.to_s) }
       include_examples "proper source"
       include_examples "proper target"
-
     end
-
   end
 
   context "When using a relation to the links with eager loading" do
@@ -146,9 +194,7 @@ describe PolymorphicIntegerType do
     it "should be able to return the links and the targets" do
       expect(cat.source_links).to match_array links
       expect(cat.source_links.includes(:target).collect(&:target)).to match_array [water, kibble]
-
     end
-
   end
 
   context "When using a through relation to the links with eager loading" do
@@ -161,9 +207,7 @@ describe PolymorphicIntegerType do
     it "should be able to return the links and the targets" do
       expect(owner.pet_source_links).to match_array links
       expect(owner.pet_source_links.includes(:target).collect(&:target)).to match_array [water, kibble]
-
     end
-
   end
 
   context "When eager loading the polymorphic association" do
@@ -178,16 +222,12 @@ describe PolymorphicIntegerType do
         expect(links.first.source).to eql cat
         expect(links.last.source).to eql dog
       end
-
     end
 
     it "should be able to preload the association" do
       l = Link.includes(:source).where(id: link.id).first
       expect(l.source).to eql cat
     end
-
-
-
   end
 
   context "when the association is an STI table" do
@@ -239,7 +279,7 @@ describe PolymorphicIntegerType do
     include_examples "proper target"
 
     it "creates foreign_type mapping method" do
-      expect(Link.source_type_mapping).to eq({1 => "Person", 2 => "Animal"})
+      expect(Link.source_type_mapping).to eq({1 => "Person", 2 => "Animal", 3 => "Plant"})
       expect(InlineLink.source_type_mapping).to eq({10 => "Person", 11 => "InlineAnimal"})
     end
 

data/spec/spec_helper.rb

@@ -5,11 +5,14 @@ require 'support/configuration'
 require 'support/link'
 require 'support/animal'
 require 'support/namespaced_animal'
+require 'support/namespaced_plant'
 require 'support/dog'
 require 'support/person'
 require 'support/food'
 require 'support/drink'
+require 'support/namespaced_activity'
 require 'byebug'
+require 'pry'
 
 RSpec.configure do |config|
   config.before(:suite) do

data/spec/support/configuration.rb

@@ -1,4 +1,4 @@
 PolymorphicIntegerType::Mapping.configuration do |config|
-  config.add :source, {1 => "Person", 2 => "Animal"}
-  config.add :target, {1 => "Food", 2 => "Drink"}
+  config.add :source, {1 => "Person", 2 => "Animal", 3 => "Plant"}
+  config.add :target, {1 => "Food", 2 => "Drink", 3 => "Activity"}
 end

data/spec/support/link.rb

@@ -3,12 +3,4 @@ class Link < ActiveRecord::Base
 
   belongs_to :source, polymorphic: true, integer_type: true
   belongs_to :target, polymorphic: true, integer_type: true
-
-  def source=(val)
-    super(val)
-  end
-
-  def source_type=(val)
-    super(val)
-  end
 end

data/spec/support/migrations/6_create_plant_table.rb

@@ -0,0 +1,17 @@
+class CreatePlantTable < ActiveRecord::Migration[5.2]
+
+  def up
+    create_table :plants do |t|
+      t.string :name
+      t.string :type
+      t.string :kind
+      t.integer :owner_id
+    end
+  end
+
+  def down
+    drop_table :plants
+  end
+
+end
+

data/spec/support/migrations/7_create_activity_table.rb

@@ -0,0 +1,15 @@
+class CreateActivityTable < ActiveRecord::Migration[5.2]
+
+  def up
+    create_table :activities do |t|
+      t.string :name
+    end
+  end
+
+  def down
+    drop_table :activities
+  end
+
+end
+
+

data/spec/support/namespaced_activity.rb

@@ -0,0 +1,11 @@
+module Namespaced
+  class Activity < ActiveRecord::Base
+    include PolymorphicIntegerType::Extensions
+
+    self.store_full_sti_class = false
+    self.table_name = "activities"
+
+    has_many :target_links, as: :target, inverse_of: :target, integer_type: true, class_name: "Link"
+  end
+end
+

data/spec/support/namespaced_plant.rb

@@ -0,0 +1,11 @@
+module Namespaced
+  class Plant < ActiveRecord::Base
+    include PolymorphicIntegerType::Extensions
+
+    self.store_full_sti_class = false
+    self.table_name = "plants"
+
+    belongs_to :owner, class_name: "Person"
+    has_many :source_links, as: :source, inverse_of: :source, integer_type: true, class_name: "Link"
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: polymorphic_integer_type
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Kyle d'Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,12 +117,13 @@ files:
 - gemfiles/Gemfile.rails-5.2-stable
 - gemfiles/Gemfile.rails-5.2-stable.lock
 - lib/polymorphic_integer_type.rb
-- lib/polymorphic_integer_type/activerecord_4/belongs_to_polymorphic_association_extension.rb
 - lib/polymorphic_integer_type/activerecord_4/predicate_builder_extension.rb
 - lib/polymorphic_integer_type/activerecord_5_0_0/association_query_handler_extension.rb
 - lib/polymorphic_integer_type/activerecord_5_0_0/polymorphic_array_value_extension.rb
+- lib/polymorphic_integer_type/belongs_to_polymorphic_association_extension.rb
 - lib/polymorphic_integer_type/extensions.rb
 - lib/polymorphic_integer_type/mapping.rb
+- lib/polymorphic_integer_type/module_generator.rb
 - lib/polymorphic_integer_type/version.rb
 - polymorphic_integer_type.gemspec
 - spec/polymorphic_integer_type_spec.rb
@@ -139,7 +140,11 @@ files:
 - spec/support/migrations/3_create_person_table.rb
 - spec/support/migrations/4_create_food_table.rb
 - spec/support/migrations/5_create_drink_table.rb
+- spec/support/migrations/6_create_plant_table.rb
+- spec/support/migrations/7_create_activity_table.rb
+- spec/support/namespaced_activity.rb
 - spec/support/namespaced_animal.rb
+- spec/support/namespaced_plant.rb
 - spec/support/person.rb
 homepage: ''
 licenses:
@@ -161,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Use integers rather than strings for the _type field
@@ -180,5 +185,9 @@ test_files:
 - spec/support/migrations/3_create_person_table.rb
 - spec/support/migrations/4_create_food_table.rb
 - spec/support/migrations/5_create_drink_table.rb
+- spec/support/migrations/6_create_plant_table.rb
+- spec/support/migrations/7_create_activity_table.rb
+- spec/support/namespaced_activity.rb
 - spec/support/namespaced_animal.rb
+- spec/support/namespaced_plant.rb
 - spec/support/person.rb