humanoid 1.2.7

data/lib/humanoid/enslavement.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Enslavement #:nodoc:
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        class_inheritable_accessor :enslaved
+        self.enslaved = false
+
+        delegate :enslaved?, :to => "self.class"
+      end
+    end
+
+    module ClassMethods #:nodoc
+      # Set whether or not this documents read operations should delegate to
+      # the slave database by default.
+      #
+      # Example:
+      #
+      #   class Person
+      #     include Humanoid::Document
+      #     enslave
+      #   end
+      def enslave
+        self.enslaved = true
+      end
+
+      # Determines if the class is enslaved or not.
+      #
+      # Returns:
+      #
+      # True if enslaved, false if not.
+      def enslaved?
+        self.enslaved == true
+      end
+    end
+  end
+end

data/lib/humanoid/errors.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+module Humanoid #:nodoc
+  module Errors #:nodoc
+
+    # Raised when querying the database for a document by a specific id which
+    # does not exist. If multiple ids were passed then it will display all of
+    # those.
+    #
+    # Example:
+    #
+    # <tt>DocumentNotFound.new(Person, ["1", "2"])</tt>
+    class DocumentNotFound < RuntimeError
+      def initialize(klass, ids)
+        @klass, @identifier = klass, ids.is_a?(Array) ? ids.join(", ") : ids
+      end
+      def message
+        "Document not found for class #{@klass} and id(s) #{@identifier}"
+      end
+    end
+
+    # Raised when invalid options are passed into a constructor or method.
+    #
+    # Example:
+    #
+    # <tt>InvalidOptions.new</tt>
+    class InvalidOptions < RuntimeError; end
+
+    # Raised when the database connection has not been set up properly, either
+    # by attempting to set an object on the db that is not a +Mongo::DB+, or
+    # not setting anything at all.
+    #
+    # Example:
+    #
+    # <tt>InvalidDatabase.new("Not a DB")</tt>
+    class InvalidDatabase < RuntimeError
+      def initialize(database)
+        @database = database
+      end
+      def message
+        "Database should be a Mongo::DB, not #{@database.class.name}"
+      end
+    end
+
+    # Raised when a persisence method ending in ! fails validation. The message
+    # will contain the full error messages from the +Document+ in question.
+    #
+    # Example:
+    #
+    # <tt>Validations.new(person.errors)</tt>
+    class Validations < RuntimeError
+      def initialize(errors)
+        @errors = errors
+      end
+      def message
+        "Validation failed: #{@errors.full_messages}"
+      end
+    end
+
+    # This error is raised when trying to access a Mongo::Collection from an
+    # embedded document.
+    #
+    # Example:
+    #
+    # <tt>InvalidCollection.new(Address)</tt>
+    class InvalidCollection < RuntimeError
+      def initialize(klass)
+        @klass = klass
+      end
+      def message
+        "Access to the collection for #{@klass.name} is not allowed " +
+          "since it is an embedded document, please access a collection from " +
+          "the root document"
+      end
+    end
+
+  end
+end

data/lib/humanoid/extensions.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require "humanoid/extensions/array/accessors"
+require "humanoid/extensions/array/aliasing"
+require "humanoid/extensions/array/assimilation"
+require "humanoid/extensions/array/conversions"
+require "humanoid/extensions/array/parentization"
+require "humanoid/extensions/boolean/conversions"
+require "humanoid/extensions/date/conversions"
+require "humanoid/extensions/datetime/conversions"
+require "humanoid/extensions/float/conversions"
+require "humanoid/extensions/hash/accessors"
+require "humanoid/extensions/hash/assimilation"
+require "humanoid/extensions/hash/conversions"
+require "humanoid/extensions/hash/criteria_helpers"
+require "humanoid/extensions/hash/scoping"
+require "humanoid/extensions/integer/conversions"
+require "humanoid/extensions/nil/assimilation"
+require "humanoid/extensions/object/conversions"
+require "humanoid/extensions/proc/scoping"
+require "humanoid/extensions/string/conversions"
+require "humanoid/extensions/string/inflections"
+require "humanoid/extensions/symbol/inflections"
+require "humanoid/extensions/time/conversions"
+
+class Array #:nodoc
+  include Humanoid::Extensions::Array::Accessors
+  include Humanoid::Extensions::Array::Assimilation
+  include Humanoid::Extensions::Array::Conversions
+  include Humanoid::Extensions::Array::Parentization
+end
+
+class Boolean #:nodoc
+  extend Humanoid::Extensions::Boolean::Conversions
+end
+
+class Date #:nodoc
+  extend Humanoid::Extensions::Date::Conversions
+end
+
+class DateTime #:nodoc
+  extend Humanoid::Extensions::DateTime::Conversions
+end
+
+class Float #:nodoc
+  extend Humanoid::Extensions::Float::Conversions
+end
+
+class Hash #:nodoc
+  include Humanoid::Extensions::Hash::Accessors
+  include Humanoid::Extensions::Hash::Assimilation
+  include Humanoid::Extensions::Hash::CriteriaHelpers
+  include Humanoid::Extensions::Hash::Scoping
+  extend Humanoid::Extensions::Hash::Conversions
+end
+
+class Integer #:nodoc
+  extend Humanoid::Extensions::Integer::Conversions
+end
+
+class NilClass #:nodoc
+  include Humanoid::Extensions::Nil::Assimilation
+end
+
+class Object #:nodoc:
+  include Humanoid::Extensions::Object::Conversions
+end
+
+class Proc #:nodoc:
+  include Humanoid::Extensions::Proc::Scoping
+end
+
+class String #:nodoc
+  include Humanoid::Extensions::String::Inflections
+  extend Humanoid::Extensions::String::Conversions
+end
+
+class Symbol #:nodoc
+  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
+  include Humanoid::Extensions::Symbol::Inflections
+end
+
+class Time #:nodoc
+  extend Humanoid::Extensions::Time::Conversions
+end

data/lib/humanoid/extensions/array/accessors.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+      module Accessors #:nodoc:
+        # If the attributes already exists in the array then they will be
+        # updated, otherwise they will be appended.
+        def update(attributes)
+          delete_if { |e| attributes["_id"] && (e["_id"] == attributes["_id"]) }
+          self.<< attributes
+        end
+
+        alias :merge! :update
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/array/aliasing.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+class Array
+  alias :count :size
+end

data/lib/humanoid/extensions/array/assimilation.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+      module Assimilation #:nodoc:
+        # Introduces a child object into the +Document+ object graph. This will
+        # set up the relationships between the parent and child and update the
+        # attributes of the parent +Document+.
+        #
+        # Options:
+        #
+        # parent: The +Document+ to assimilate into.
+        # options: The association +Options+ for the child.
+        #
+        # Example:
+        #
+        # <tt>[{:street => "Queen St."}, {:street => "King St."}].assimilate(person, options)</tt>
+        #
+        # Returns: The child +Document+.
+        def assimilate(parent, options)
+          each { |child| child.assimilate(parent, options) }
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/array/conversions.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+      # This module converts arrays into humanoid related objects.
+      module Conversions #:nodoc:
+        # Converts this array into an array of hashes.
+        def humanoidize
+          collect { |obj| obj.attributes }
+        end
+
+        def self.included(base)
+          base.class_eval do
+            extend ClassMethods
+          end
+        end
+
+        module ClassMethods
+          def get(value)
+            value
+          end
+          def set(value)
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/array/parentization.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Array #:nodoc:
+      module Parentization #:nodoc:
+        # Adds the parent document to each element in the array.
+        def parentize(parent, association_name)
+          each { |obj| obj.parentize(parent, association_name) }
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/boolean/conversions.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Boolean #:nodoc:
+      module Conversions #:nodoc:
+        def set(value)
+          val = value.to_s
+          val == "true" || val == "1"
+        end
+        def get(value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/date/conversions.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Date #:nodoc:
+      module Conversions #:nodoc:
+        def set(value)
+          value.to_date.at_midnight.to_time unless value.blank?
+        end
+        def get(value)
+          value ? value.getlocal.to_date : value
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/datetime/conversions.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module DateTime #:nodoc:
+      module Conversions #:nodoc:
+        def set(value)
+          return nil if value.blank?
+          ::DateTime.parse(value.to_s).utc
+        end
+        def get(value)
+          return nil if value.blank?
+          ::Time.zone ? ::Time.parse(value.to_s).getlocal.to_datetime : value.to_datetime
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/float/conversions.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Float #:nodoc:
+      module Conversions #:nodoc:
+        def set(value)
+          return nil if value.blank?
+          value =~ /\d/ ? value.to_f : value
+        end
+        def get(value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/hash/accessors.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+      module Accessors #:nodoc:
+
+        # Remove a set of attributes from a hash. If the attributes are
+        # contained in an array it will remove it from the array, otherwise it
+        # will delete the child attribute completely.
+        def remove(key, attrs)
+          elements = self[key]
+          if elements
+            key.singular? ? self[key] = nil : elements.delete(attrs)
+          end
+        end
+
+        # Inserts new attributes into the hash. If the elements are present in
+        # the hash it will update them, otherwise it will add the new
+        # attributes into the hash as either a child hash or child array of
+        # hashes.
+        def insert(key, attrs)
+          elements = self[key]
+          if elements
+            elements.merge!(attrs)
+          else
+            self[key] = key.singular? ? attrs : [attrs]
+          end
+        end
+
+        # If a _type key exists in the hash, return the class for the value.
+        def klass
+          class_name = self["_type"]
+          class_name ? class_name.constantize : nil
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/hash/assimilation.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+      module Assimilation #:nodoc:
+        # Introduces a child object into the +Document+ object graph. This will
+        # set up the relationships between the parent and child and update the
+        # attributes of the parent +Document+.
+        #
+        # Options:
+        #
+        # parent: The +Document+ to assimilate into.
+        # options: The association +Options+ for the child.
+        #
+        # Example:
+        #
+        # <tt>{:first_name => "Hank", :last_name => "Moody"}.assimilate(name, options)</tt>
+        #
+        # Returns: The child +Document+.
+        def assimilate(parent, options, type = nil)
+          klass = type ? type : options.klass
+          child = klass.instantiate(:_parent => parent)
+          child.write_attributes(self.merge("_type" => klass.name))
+          child.identify
+          child.assimilate(parent, options)
+        end
+      end
+    end
+  end
+end

data/lib/humanoid/extensions/hash/conversions.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Humanoid #:nodoc:
+  module Extensions #:nodoc:
+    module Hash #:nodoc:
+      module Conversions #:nodoc:
+        def get(value)
+          value
+        end
+        def set(value)
+          value
+        end
+      end
+    end
+  end
+end