mongoid-multi-db 3.0.0

data/lib/mongoid/extensions/array/deletion.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+
+      # This module contains deletion helpers for arrays.
+      module Deletion
+
+        # Delete the first object in the array that is equal to the supplied
+        # object and return it. This is much faster than performing a standard
+        # delete for large arrays ince it attempt to delete multiple in the
+        # other.
+        #
+        # @example Delete the first object.
+        #   [ "1", "2", "1" ].delete_one("1")
+        #
+        # @param [ Object ] object The object to delete.
+        #
+        # @return [ Object ] The deleted object.
+        #
+        # @since 2.1.0
+        def delete_one(object)
+          position = index(object)
+          position ? delete_at(position) : nil
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/false_class/equality.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module FalseClass #:nodoc:
+
+      # Adds equality hooks for false values.
+      module Equality
+
+        # Is the passed value a boolean?
+        #
+        # @example Is the value a boolean type?
+        #   false.is_a?(Boolean)
+        #
+        # @param [ Class ] other The class to check.
+        #
+        # @return [ true, false ] If the other is a boolean.
+        #
+        # @since 1.0.0
+        def is_a?(other)
+          return true if other.name == "Boolean"
+          super(other)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/hash/criteria_helpers.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+
+      # Expands complex criterion into mongodb selectors.
+      module CriteriaHelpers
+
+        # Expand the complex criteria into a MongoDB compliant selector hash.
+        #
+        # @example Convert the criterion.
+        #   {}.expand_complex_criteria
+        #
+        # @return [ Hash ] The mongo selector.
+        #
+        # @since 1.0.0
+        def expand_complex_criteria
+          {}.tap do |hsh|
+            each_pair do |k,v|
+              if k.respond_to?(:key) && k.respond_to?(:to_mongo_query)
+                hsh[k.key] ||= {}
+                hsh[k.key].merge!(k.to_mongo_query(v))
+              else
+                hsh[k] = v
+              end
+            end
+          end
+        end
+
+        # Get the id attribute from this hash, whether it's prefixed with an
+        # underscore or is a symbol.
+        #
+        # @example Extract the id.
+        #   { :_id => 1 }.extract_id
+        #
+        # @return [ Object ] The value of the id.
+        #
+        # @since 2.3.2
+        def extract_id
+          self["id"] || self["_id"] || self[:id] || self[:_id]
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/hash/scoping.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+
+      # Adds functionality for criteria scoping/merging.
+      module Scoping
+
+        # Get the hash scoped for criteria merges.
+        #
+        # @example Get the hash.
+        #   { :field => "value" }.scoped
+        #
+        # @param [ Array ] args The arguments (ignored).
+        #
+        # @return [ Hash ] The hash unmodified.
+        #
+        # @since 1.0.0
+        def scoped(*args)
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/integer/checks.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Integer #:nodoc:
+
+      # This module has object checks in it.
+      module Checks #:nodoc:
+
+        # Is the object not to be converted to bson on criteria creation?
+        #
+        # @example Is the object unconvertable?
+        #   object.unconvertable_to_bson?
+        #
+        # @return [ true ] If the object is unconvertable.
+        #
+        # @since 2.2.1
+        def unconvertable_to_bson?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/nil/collectionization.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Nil #:nodoc:
+
+      # This module safeguards collection access on anonymous classes.
+      module Collectionization
+
+        # Get the name of a nil collection.
+        #
+        # @example Get the nil name.
+        #   nil.collectionize
+        #
+        # @return [ String ] A blank string.
+        #
+        # @since 1.0.0
+        def collectionize
+          to_s.collectionize
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/checks.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+
+      # This module has object checks in it.
+      module Checks #:nodoc:
+
+        # Since Active Support's blank? check looks to see if the object
+        # responds to #empty? and will call it if it does, we need another way
+        # to check if the object is empty or nil in case the user has defined a
+        # field called "empty" on the document.
+        #
+        # @example Is the array vacant?
+        #   [].vacant?
+        #
+        # @example Is the object vacant?
+        #   nil.vacant?
+        #
+        # @return [ true, false ] True if empty or nil, false if not.
+        #
+        # @since 2.0.2
+        def _vacant?
+          is_a?(::Array) || is_a?(::String) ? empty? : !self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/reflections.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+
+      # This module contains reflection convenience methods.
+      module Reflections
+        extend ActiveSupport::Concern
+
+        # Get the value for an instance variable or nil if it doesn't exist.
+        #
+        # @example Get the value for an instance var.
+        #   document.ivar("person")
+        #
+        # @param [ String ] name The name of the variable.
+        #
+        # @return [ Object, nil ] The value or nil.
+        #
+        # @since 2.0.0.rc.1
+        def ivar(name)
+          if instance_variable_defined?("@#{name}")
+            return instance_variable_get("@#{name}")
+          else
+            false
+          end
+        end
+
+        # Remove the instance variable for the provided name.
+        #
+        # @example Remove the instance variable
+        #   document.remove_ivar("person")
+        #
+        # @param [ String ] name The name of the variable.
+        #
+        # @return [ true, false ] If the variable was defined.
+        #
+        # @since 2.1.0
+        def remove_ivar(name)
+          if instance_variable_defined?("@#{name}")
+            return remove_instance_variable("@#{name}")
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/substitutable.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+
+      # This module is for defining base substitutable behaviour.
+      module Substitutable #:nodoc:
+
+        def substitutable
+          self
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object/yoda.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Object #:nodoc:
+
+      # This module behaves like the master jedi.
+      module Yoda #:nodoc:
+
+        # Do or do not, there is no try. -- Yoda.
+        #
+        # @example Do or do not.
+        #   object.do_or_do_not(:use, "The Force")
+        #
+        # @param [ String, Symbol ] name The method name.
+        # @param [ Array ] *args The arguments.
+        #
+        # @return [ Object, nil ] The result of the method call or nil if the
+        #   method does not exist.
+        #
+        # @since 2.0.0.rc.1
+        def do_or_do_not(name, *args)
+          return nil unless name
+          respond_to?(name) ? send(name, *args) : nil
+        end
+
+        # You must unlearn what you have learned. -- Yoda
+        #
+        # @example You must perform this execution.
+        #   object.you_must(:use, "The Force")
+        #
+        # @param [ String, Symbol ] name The method name.
+        # @param [ Array ] *args The arguments.
+        #
+        # @return [ Object, nil ] The result of the method call or nil if the
+        #   method does not exist. Nil if the object is frozen.
+        #
+        # @since 2.2.1
+        def you_must(name, *args)
+          frozen? ? nil : do_or_do_not(name, *args)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/object_id/conversions.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module ObjectId #:nodoc:
+
+      # Provides conversions to and from BSON::ObjectIds and Strings, Arrays,
+      # and Hashes.
+      module Conversions
+
+        # Convert the supplied arguments to object ids based on the class
+        # settings.
+        #
+        # @todo Durran: This method can be refactored.
+        #
+        # @example Convert a string to an object id
+        #   BSON::ObjectId.convert(Person, "4c52c439931a90ab29000003")
+        #
+        # @example Convert an array of strings to object ids.
+        #   BSON::ObjectId.convert(Person, [ "4c52c439931a90ab29000003" ])
+        #
+        # @example Convert a hash of id strings to object ids.
+        #   BSON::ObjectId.convert(Person, { :_id => "4c52c439931a90ab29000003" })
+        #
+        # @param [ Class ] klass The class to convert the ids for.
+        # @param [ Object, Array, Hash ] object The object to convert.
+        #
+        # @raise BSON::InvalidObjectId If using object ids and passed bad
+        #   strings.
+        #
+        # @return [ BSON::ObjectId, Array, Hash ] The converted object ids.
+        #
+        # @since 2.0.0.rc.7
+        def convert(klass, object, reject_blank = true)
+          return object if object.is_a?(BSON::ObjectId) || !klass.using_object_ids?
+          case object
+          when ::String
+            return nil if object.blank?
+            if object.unconvertable_to_bson?
+              object
+            else
+              BSON::ObjectId.legal?(object) ? BSON::ObjectId.from_string(object) : object
+            end
+          when ::Array
+            object.delete_if { |arg| arg.blank? } if reject_blank
+            object.replace(object.map { |arg| convert(klass, arg, reject_blank) })
+          when ::Hash
+            object.tap do |hash|
+              hash.each_pair do |key, value|
+                next unless klass.object_id_field?(key)
+                hash[key] = convert(klass, value, reject_blank)
+              end
+            end
+          else
+            object
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/proc/scoping.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module Proc #:nodoc:
+
+      # Adds functionality for criteria scoping/merging.
+      module Scoping
+
+        # Get the proc scoped for criteria merges.
+        #
+        # @example Get the hash.
+        #   proc.scoped
+        #
+        # @param [ Array ] args The arguments to delegate to the proc.
+        #
+        # @return [ Object ] The result of the proc call.
+        #
+        # @since 1.0.0
+        def scoped(*args)
+          call(*args).scoped
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/extensions/string/checks.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Extensions #:nodoc:
+    module String #:nodoc:
+
+      # This module has object checks in it.
+      module Checks #:nodoc:
+        attr_accessor :unconvertable_to_bson
+
+        # Is the string a valid value for a Mongoid id?
+        #
+        # @example Is the string an id value?
+        #   "_id".mongoid_id?
+        #
+        # @return [ true, false ] If the string is id or _id.
+        #
+        # @since 2.3.1
+        def mongoid_id?
+          self =~ /^(|_)id$/
+        end
+
+        # Is the object not to be converted to bson on criteria creation?
+        #
+        # @example Is the object unconvertable?
+        #   object.unconvertable_to_bson?
+        #
+        # @return [ true, false ] If the object is unconvertable.
+        #
+        # @since 2.2.1
+        def unconvertable_to_bson?
+          !!@unconvertable_to_bson
+        end
+      end
+    end
+  end
+end