mongoid-multiple-polymorphic 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 423cecbf3a2ffa2076a3c1713f36c3ff8b3d9589
+  data.tar.gz: a6a7783c17749d2126016d97fe5862bcbf510a81
+SHA512:
+  metadata.gz: 3adabffc2c7015bd8c14969788a18726050ee37cccc82257418281ea2ad990cd02725821379a2de4bd92f535243918243616149df548a10bd811ea9d56491b5c
+  data.tar.gz: 3882091c6eaaf08007d29accf8fd8dbed8135b78e95d57f36443aaf416e89d9f99f054d6c3de7d4de933fcb01d4b56960cfd809c21350bbbb6b7fe2afc75a582

data/.gitignore

@@ -0,0 +1,5 @@
+.idea
+.rspec
+Gemfile.lock
+
+projectFileBackup/**

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Grantoo, LLC
+
+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,6 @@
+mongoid-multiple-polymorphic
+============================
+
+Support backward compatibility for multiple polymorphic relationships for mongoid 4
+
+In mongoid 4, a model can no longer have more than 1 field with the same polymorphic class. This brings back the functionality to allow a smooth transition from mongoid 3 to mongoid 4.

data/lib/mongoid-multiple-polymorphic.rb

@@ -0,0 +1,6 @@
+require 'mongoid'
+require 'mongoid-multiple-polymorphic/mongoid/relations/bindings/referenced/in'
+require 'mongoid-multiple-polymorphic/mongoid/relations/referenced/one'
+require 'mongoid-multiple-polymorphic/mongoid/relations/binding'
+require 'mongoid-multiple-polymorphic/mongoid/relations/metadata'
+require 'mongoid-multiple-polymorphic/mongoid/relations/polymorphic'

data/lib/mongoid-multiple-polymorphic/mongoid/relations/binding.rb

@@ -0,0 +1,40 @@
+module Mongoid
+  module Relations
+    class Binding
+      # Bind the inverse of field, when in a polymorphic relation.
+      #
+      # @api private
+      #
+      # @example Bind the inverse of field.
+      #   binding.bind_inverse_of_field(doc)
+      #
+      # @param [ Document ] doc The document to bind.
+      # @param [ String ] name The name of the relation.
+      #
+      # @since 3.0.0
+      def bind_inverse_of_field(doc, name)
+        if inverse_metadata = metadata.inverse_metadata(doc)
+          if setter = inverse_metadata.inverse_of_field_setter
+            doc.you_must(setter, name)
+          end
+        end
+      end
+
+      def bind_from_relational_parent(doc)
+        check_inverse!(doc)
+        bind_foreign_key(doc, record_id(base))
+        bind_polymorphic_type(doc, base.class.name)
+        bind_inverse(doc, base)
+        bind_inverse_of_field(doc, metadata.name)
+      end
+
+      def unbind_from_relational_parent(doc)
+        check_inverse!(doc)
+        bind_foreign_key(doc, nil)
+        bind_polymorphic_type(doc, nil)
+        bind_inverse(doc, nil)
+        bind_inverse_of_field(doc, nil)
+      end
+    end
+  end
+end

data/lib/mongoid-multiple-polymorphic/mongoid/relations/bindings/referenced/in.rb

@@ -0,0 +1,47 @@
+module Mongoid
+  module Relations
+    module Bindings
+      module Referenced
+        class In < Binding
+          def bind_one
+            binding do
+              check_inverses!(target)
+              bind_foreign_key(base, record_id(target))
+              bind_polymorphic_inverse_type(base, target.class.name)
+              if inverse = metadata.inverse(target)
+                if set_base_metadata
+                  bind_inverse_of_field(base, base.metadata_name)
+                  if base.referenced_many?
+                    target.__send__(inverse).push(base)
+                  else
+                    target.set_relation(inverse, base)
+                  end
+                end
+              end
+            end
+          end
+
+          def unbind_one
+            binding do
+              inverse = metadata.inverse(target)
+              if !inverse && metadata.inverse_of_field
+                inverse = base.__send__(metadata.inverse_of_field)
+              end
+              bind_foreign_key(base, nil)
+              bind_polymorphic_inverse_type(base, nil)
+              bind_inverse_of_field(base, nil)
+              if inverse
+                set_base_metadata
+                if base.referenced_many?
+                  target.__send__(inverse).delete(base)
+                else
+                  target.set_relation(inverse, nil)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-multiple-polymorphic/mongoid/relations/metadata.rb

@@ -0,0 +1,30 @@
+module Mongoid
+  module Relations
+    class Metadata < Hash
+      # Returns the name of the field in which to store the name of the inverse
+      # field for the polymorphic relation.
+      #
+      # @example Get the name of the field.
+      #   metadata.inverse_of_field
+      #
+      # @return [ String ] The name of the field for storing the name of the
+      #   inverse field.
+      #
+      # @since 2.4.5
+      def inverse_of_field
+        @inverse_of_field ||= determine_inverse_for(:field)
+      end
+
+      # Gets the setter for the field that stores the name of the inverse field
+      # on a polymorphic relation.
+      #
+      # @example Get the inverse type setter.
+      #   metadata.inverse_of_field_setter
+      #
+      # @return [ String ] The name of the setter.
+      def inverse_of_field_setter
+        @inverse_of_field_setter ||= inverse_of_field.__setter__
+      end
+    end
+  end
+end

data/lib/mongoid-multiple-polymorphic/mongoid/relations/polymorphic.rb

@@ -0,0 +1,18 @@
+module Mongoid
+  module Relations
+    module Polymorphic
+      module ClassMethods
+        def polymorph(metadata)
+          if metadata.polymorphic?
+            self.polymorphic = true
+            if metadata.relation.stores_foreign_key?
+              field(metadata.inverse_type, type: String)
+              field(metadata.inverse_of_field, type: Symbol)
+            end
+          end
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-multiple-polymorphic/mongoid/relations/referenced/one.rb

@@ -0,0 +1,24 @@
+module Mongoid
+  module Relations
+    module Referenced
+      class One < Relations::One
+
+        private
+
+        class << self
+          def criteria(metadata, object, type = nil)
+            crit = metadata.klass.where(metadata.foreign_key => object)
+            if metadata.polymorphic?
+              crit = crit.where(metadata.type => type.name)
+            end
+            inverse_metadata = metadata.inverse_metadata(metadata.klass)
+            if inverse_metadata.inverse_of_field
+              crit = crit.any_in(inverse_metadata.inverse_of_field => [metadata.name, nil])
+            end
+            crit
+          end
+        end
+      end
+    end
+  end
+end

data/mongoid-multiple-polymorphic.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'mongoid-multiple-polymorphic'
+  s.version     = '0.0.0'
+  s.summary     = "Support backward compatibility for multiple polymorphic relationships for mongoid 4"
+  s.description = "In mongoid 4, a model can no longer have more than 1 field with the same polymorphic class. This brings back the functionality to allow a smooth transition from mongoid 3 to mongoid 4."
+  s.authors     = ["Kirk Chen"]
+  s.email       = 'chen.kirk@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://rubygems.org/gems/mongoid-multiple-polymorphic'
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'mongoid', '~> 4.0'
+end

data/spec/app/models/eye.rb

@@ -0,0 +1,5 @@
+class Eye
+  include Mongoid::Document
+  field :pupil_dilation, type: Integer
+  belongs_to :eyeable, polymorphic: true
+end

data/spec/app/models/face.rb

@@ -0,0 +1,6 @@
+class Face
+  include Mongoid::Document
+
+  has_one :left_eye, class_name: "Eye", as: :eyeable
+  has_one :right_eye, class_name: "Eye", as: :eyeable
+end

data/spec/mongoid-multiple-polymorphic/mongoid-multiple-polymorphic_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe "Multiple polymorphic support" do
+  it "should retrieve the right documents" do
+    face = Face.create!
+    face.left_eye = Eye.create!(:pupil_dilation => 3)
+    face.right_eye = Eye.create!(:pupil_dilation => 5)
+    left_eye_id = face.left_eye.id
+    right_eye_id = face.right_eye.id
+    face.save!
+    face.reload
+    expect(face.left_eye.pupil_dilation).to be(3)
+    expect(face.right_eye.pupil_dilation).to be(5)
+    expect(face.left_eye.id).to eq(left_eye_id)
+    expect(face.right_eye.id).to eq(right_eye_id)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+MODELS = File.join(File.dirname(__FILE__), "app/models")
+$LOAD_PATH.unshift(MODELS)
+
+require "mongoid-multiple-polymorphic"
+require "rspec"
+
+# These environment variables can be set if wanting to test against a database
+# that is not on the local machine.
+ENV["MONGOID_SPEC_HOST"] ||= "localhost"
+ENV["MONGOID_SPEC_PORT"] ||= "27017"
+
+# These are used when creating any connection in the test suite.
+HOST = ENV["MONGOID_SPEC_HOST"]
+PORT = ENV["MONGOID_SPEC_PORT"].to_i
+
+# Moped.logger.level = Logger::DEBUG
+# Mongoid.logger.level = Logger::DEBUG
+
+CONFIG = {
+  sessions: {
+    default: {
+      database: "mongoid_multiple_polymorphic_test",
+      hosts: [ "#{HOST}:#{PORT}" ]
+    }
+  }
+}
+
+# Set the database that the spec suite connects to.
+Mongoid.configure do |config|
+  config.load_configuration(CONFIG)
+end
+
+# Autoload every model for the test suite that sits in spec/app/models.
+Dir[ File.join(MODELS, "*.rb") ].sort.each do |file|
+  name = File.basename(file, ".rb")
+  autoload name.camelize.to_sym, name
+end
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+
+  # Drop all collections and clear the identity map before each spec.
+  config.before(:each) do
+    Mongoid.purge!
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-multiple-polymorphic
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Kirk Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: In mongoid 4, a model can no longer have more than 1 field with the same
+  polymorphic class. This brings back the functionality to allow a smooth transition
+  from mongoid 3 to mongoid 4.
+email: chen.kirk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/mongoid-multiple-polymorphic.rb
+- lib/mongoid-multiple-polymorphic/mongoid/relations/binding.rb
+- lib/mongoid-multiple-polymorphic/mongoid/relations/bindings/referenced/in.rb
+- lib/mongoid-multiple-polymorphic/mongoid/relations/metadata.rb
+- lib/mongoid-multiple-polymorphic/mongoid/relations/polymorphic.rb
+- lib/mongoid-multiple-polymorphic/mongoid/relations/referenced/one.rb
+- mongoid-multiple-polymorphic.gemspec
+- spec/app/models/eye.rb
+- spec/app/models/face.rb
+- spec/mongoid-multiple-polymorphic/mongoid-multiple-polymorphic_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/mongoid-multiple-polymorphic
+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.1
+signing_key: 
+specification_version: 4
+summary: Support backward compatibility for multiple polymorphic relationships for
+  mongoid 4
+test_files: []