mongoid 2.4.10 → 3.0.0

data/lib/mongoid/relations/embedded/atomic/set.rb

@@ -1,61 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Embedded #:nodoc:
-      module Atomic #:nodoc:
-
-        class Set < Operation
-
-          # Get the merged operations for the single atomic set.
-          #
-          # @example Get the operations
-          #   set.operations
-          #
-          # @return [ Hash ] The set operations.
-          #
-          # @since 2.0.0
-          def operations
-            { "$set" => { path => documents } }
-          end
-
-          private
-
-          # Parses the incoming operations to get the documents to set.
-          #
-          # @example Parse the operations.
-          #   set.parse(
-          #     { "addresses" => { "$pushAll" => [{ "_id" => "street" }] } }
-          #   )
-          #
-          # @param [ Hash ] operations The ops to parse.
-          #
-          # @since 2.0.0
-          def parse(operations)
-            modifier = operations.keys.first
-            extract(modifier, operations[modifier])
-          end
-
-          # Extract a document from the operation.
-          #
-          # @example Extract the document.
-          #   set.extract({ "$pushAll" => [{ "_id" => "street" }] })
-          #
-          # @param [ Hash ] operation The op to extract from.
-          #
-          # @since 2.0.0
-          def extract(modifier, operations)
-            @path = operations.keys.first
-            case modifier
-            when "$push"
-              documents.push(operations[path])
-            when "$pushAll"
-              documents.push(operations[path].first)
-            when "$set"
-              @documents = operations[path]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/embedded/atomic/unset.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Embedded #:nodoc:
-      module Atomic #:nodoc:
-
-        class Unset < Operation
-
-          # Get the merged operations for the single atomic set.
-          #
-          # @example Get the operations
-          #   set.operations
-          #
-          # @return [ Hash ] The set operations.
-          #
-          # @since 2.0.0
-          def operations
-            { "$unset" => { path => true } }
-          end
-
-          private
-
-          # Parses the incoming operations to get the documents to set.
-          #
-          # @example Parse the operations.
-          #   set.parse(
-          #     { "addresses" => { "$pushAll" => [{ "_id" => "street" }] } }
-          #   )
-          #
-          # @param [ Hash ] operations The ops to parse.
-          #
-          # @since 2.0.0
-          def parse(operations)
-            modifier = operations.keys.first
-            @path ||= operations[modifier].keys.first
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/embedded/atomic.rb

@@ -1,89 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/embedded/atomic/operation"
-require "mongoid/relations/embedded/atomic/pull"
-require "mongoid/relations/embedded/atomic/push_all"
-require "mongoid/relations/embedded/atomic/set"
-require "mongoid/relations/embedded/atomic/unset"
-
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Embedded #:nodoc:
-
-      # This module provides the ability for calls to be declared atomic.
-      module Atomic
-
-        MODIFIERS = {
-          :$pull => Pull,
-          :$pushAll => PushAll,
-          :$set => Set,
-          :$unset => Unset
-        }
-
-        private
-
-        # Executes a block of commands in an atomic fashion. Mongoid will
-        # intercept all database upserts while in this block and combine them
-        # into a single database call. When the block concludes the atomic
-        # update will occur.
-        #
-        # Since the collection is accessed through the class it would not be
-        # thread safe to give it state so we access the atomic updater via the
-        # current thread.
-        #
-        # @note This operation is not safe when attemping to do illegal updates
-        #   for different objects or collections, since the updator is not
-        #   scoped on the thread. This is meant for Mongoid internal use only
-        #   to keep existing design clean.
-        #
-        # @example Atomically $set multiple saves.
-        #   atomically(:$set) do
-        #     address_one.save!
-        #     address_two.save!
-        #   end
-        #
-        # @example Atomically $pushAll multiple new docs.
-        #   atomically(:$pushAll) do
-        #     person.addresses.push([ address_one, address_two ])
-        #   end
-        #
-        # @todo Durran: Move executions to thread local stack.
-        #
-        # @param [ Symbol ] modifier The atomic modifier to perform.
-        # @param [ Proc ] block The block to execute.
-        #
-        # @return [ Object ] The result of the operation.
-        #
-        # @since 2.0.0
-        def atomically(modifier, &block)
-          updater = Threaded.update_consumer(collection_name) ||
-            Threaded.set_update_consumer(collection_name, MODIFIERS[modifier].new)
-          count_executions do
-            block.call if block
-          end.tap do
-            if @executions.zero?
-              Threaded.set_update_consumer(collection_name, nil)
-              updater.execute(collection)
-            end
-          end
-        end
-
-        # Execute the block, incrementing the executions before the call and
-        # decrementing them after in order to be able to nest blocks within
-        # each other.
-        #
-        # @example Execute and increment.
-        #   execute { block.call }
-        #
-        # @param [ Proc ] block The block to call.
-        #
-        # @since 2.0.0
-        def count_executions(&block)
-          @executions ||= 0 and @executions += 1
-          block.call.tap do
-            @executions -=1
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/referenced/batch/insert.rb

@@ -1,57 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Referenced #:nodoc:
-      module Batch #:nodoc:
-
-        # Handles all the batch insert collection.
-        class Insert
-          attr_accessor :documents, :options
-
-          # Consumes an execution that was supposed to hit the database, but is
-          # now being deferred to later in favor of a single batch insert.
-          #
-          # @example Consume the operation.
-          #   set.consume({ "field" => "value" }, { :safe => true })
-          #
-          # @param [ Hash ] document The document to collect.
-          # @param [ Hash ] options The persistence options.
-          #
-          # @option options [ true, false ] :safe Persist in safe mode.
-          #
-          # @since 2.0.2, batch-relational-insert
-          def consume(document, options = {})
-            @consumed, @options = true, options
-            (@documents ||= []).push(document)
-          end
-
-          # Has this operation consumed any executions?
-          #
-          # @example Is this consumed?
-          #   insert.consumed?
-          #
-          # @return [ true, false ] If the operation has consumed anything.
-          #
-          # @since 2.0.2, batch-relational-insert
-          def consumed?
-            !!@consumed
-          end
-
-          # Execute the batch insert operation on the collection.
-          #
-          # @example Execute the operation.
-          #   insert.execute(collection)
-          #
-          # @param [ Collection ] collection The root collection.
-          #
-          # @since 2.0.2, batch-relational-insert
-          def execute(collection)
-            if collection && consumed?
-              collection.insert(documents, options)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/relations/referenced/batch.rb

@@ -1,73 +0,0 @@
-# encoding: utf-8
-require "mongoid/relations/referenced/batch/insert"
-
-module Mongoid #:nodoc:
-  module Relations #:nodoc:
-    module Referenced #:nodoc:
-
-      # This module provides the ability for single insert calls to be batch
-      # inserted.
-      module Batch
-
-        private
-
-        # Executes a number of save calls in a single batch. Mongoid will
-        # intercept all database inserts while in this block and combine them
-        # into a single database call. When the block concludes the batch
-        # insert will occur.
-        #
-        # Since the collection is accessed through the class it would not be
-        # thread safe to give it state so we access the atomic updater via the
-        # current thread.
-        #
-        # @note This operation is not safe when attemping to do illegal updates
-        #   for different objects or collections, since the updator is not
-        #   scoped on the thread. This is meant for Mongoid internal use only
-        #   to keep existing design clean.
-        #
-        # @example Batch update multiple appends.
-        #   batched do
-        #     person.posts << [ post_one, post_two, post_three ]
-        #   end
-        #
-        # @todo Durran: Move executions to thread local stack.
-        #
-        # @param [ Proc ] block The block to execute.
-        #
-        # @return [ Object ] The result of the operation.
-        #
-        # @since 2.0.2, batch-relational-insert
-        def batched(&block)
-          name = collection.name
-          inserter = Threaded.insert(name) || Threaded.set_insert(name, Insert.new)
-          count_executions(&block)
-        ensure
-          if @executions.zero?
-            Threaded.set_insert(name, nil)
-            inserter.execute(collection)
-          end
-        end
-
-        # Execute the block, incrementing the executions before the call and
-        # decrementing them after in order to be able to nest blocks within
-        # each other.
-        #
-        # @todo Durran: Combine common code with embedded atomics.
-        #
-        # @example Execute and increment.
-        #   execute { block.call }
-        #
-        # @param [ Proc ] block The block to call.
-        #
-        # @since 2.0.2, batch-relational-insert
-        def count_executions
-          @executions ||= 0
-          @executions += 1
-          yield
-        ensure
-          @executions -=1
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/safety.rb

@@ -1,105 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-
-  # The +Safety+ module is used to provide a DSL to execute database operations
-  # in safe mode on a per query basis, either from the +Document+ class level
-  # or instance level.
-  module Safety
-    extend ActiveSupport::Concern
-
-    # Execute the following instance-level persistence operation in safe mode.
-    #
-    # @example Upsert in safe mode.
-    #   person.safely.upsert
-    #
-    # @example Destroy in safe mode with w and fsync options.
-    #   person.safely(:w => 2, :fsync => true).destroy
-    #
-    # @param [ Hash ] options The safe mode options.
-    #
-    # @option options [ Integer ] :w The number of nodes to write to.
-    # @option options [ Integer ] :wtimeout Time to wait for return from all
-    #   nodes.
-    # @option options [ true, false ] :fsync Should a fsync occur.
-    #
-    # @return [ Proxy ] The safety proxy.
-    def safely(safety = true)
-      tap { Threaded.safety_options = safety }
-    end
-
-    # Execute the following instance-level persistence operation without safe mode.
-    # Allows per-request overriding of safe mode when the persist_in_safe_mode
-    # config option is turned on.
-    #
-    # @example Upsert in safe mode.
-    #   person.unsafely.upsert
-    #
-    # @return [ Proxy ] The safety proxy.
-    def unsafely
-      tap { Threaded.safety_options = false }
-    end
-
-    class << self
-
-      # Static class method of easily getting the desired safe mode options
-      # from anywhere in the framework.
-      #
-      # @example Get the options with safe mode included.
-      #   Safety.merge_safety_options({ :safe => false })
-      #
-      # @param [ Hash ] options The persistence options.
-      #
-      # @return [ Hash ] The options hash.
-      #
-      # @since 2.1.0
-      def merge_safety_options(options = {})
-        options ||= {}
-        return options if options[:safe]
-
-        unless Threaded.safety_options.nil?
-          safety = Threaded.safety_options
-        else
-          safety = Mongoid.persist_in_safe_mode
-        end
-        options.merge!({ :safe => safety })
-      end
-    end
-
-    module ClassMethods #:nodoc:
-
-      # Execute the following class-level persistence operation in safe mode.
-      #
-      # @example Create in safe mode.
-      #   Person.safely.create(:name => "John")
-      #
-      # @example Delete all in safe mode with options.
-      #   Person.safely(:w => 2, :fsync => true).delete_all
-      #
-      # @param [ Hash ] options The safe mode options.
-      #
-      # @option options [ Integer ] :w The number of nodes to write to.
-      # @option options [ Integer ] :wtimeout Time to wait for return from all
-      #   nodes.
-      # @option options [ true, false ] :fsync Should a fsync occur.
-      #
-      # @return [ Proxy ] The safety proxy.
-      def safely(safety = true)
-        tap { Threaded.safety_options = safety }
-      end
-
-      # Execute the following class-level persistence operation without safe mode.
-      # Allows per-request overriding of safe mode when the persist_in_safe_mode
-      # config option is turned on.
-      #
-      # @example Upsert in safe mode.
-      #   Person.unsafely.create(:name => "John")
-      #
-      # @return [ Proxy ] The safety proxy.
-      #
-      # @since 2.3.0
-      def unsafely
-        tap { Threaded.safety_options = false }
-      end
-    end
-  end
-end

data/lib/mongoid/scope.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  # This module handles behaviour for defining scopes on classes.
-  class Scope
-    attr_reader :conditions, :extensions
-
-    # Create the new +Scope+. If a block is passed in, this Scope will store
-    # the block for future calls to #extend.
-    #
-    # @example Create a new scope.
-    #   Scope.new(:title => "Sir")
-    #
-    # @param [ Hash ] conditions The scoping limitations.
-    def initialize(conditions = {}, &block)
-      @conditions = conditions
-      @extensions = Module.new(&block) if block_given?
-    end
-
-    # Extend a supplied criteria.
-    #
-    # @example Extend the criteria.
-    #   scope.extend(criteria)
-    #
-    # @param [ Criteria } criteria A mongoid criteria to extend.
-    #
-    # @return [ Criteria ] The new criteria object.
-    def extend(criteria)
-      extensions ? criteria.extend(extensions) : criteria
-    end
-  end
-end