mongoid-locomotive 2.0.0.beta9

data/lib/mongoid/persistence/command.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Persistence commands extend from this class to get basic functionality on
+    # initialization.
+    class Command
+      attr_reader \
+        :collection,
+        :document,
+        :klass,
+        :options,
+        :selector,
+        :validate
+
+      # Initialize the persistence +Command+.
+      #
+      # Options:
+      #
+      # document_or_class: The +Document+ or +Class+ to get the collection.
+      # validate: Is the document to be validated.
+      # selector: Optional selector to use in query.
+      #
+      # Example:
+      #
+      # <tt>DeleteAll.new(Person, false, {})</tt>
+      def initialize(document_or_class, validate = true, selector = {})
+        if document_or_class.is_a?(Mongoid::Document)
+          @document = document_or_class
+          @collection = @document.embedded? ? @document._root.collection : @document.collection
+        else
+          @klass = document_or_class
+          @collection = @klass.collection
+        end
+        @selector, @validate = selector, validate
+        @options = { :safe => Mongoid.persist_in_safe_mode }
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/insert.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Insert is a persistence command responsible for taking a document that
+    # has not been saved to the database and saving it.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.insert(
+    #     { "_id" : 1, "field" : "value" },
+    #     false
+    #   );
+    class Insert < Command
+      # Insert the new document in the database. This delegates to the standard
+      # MongoDB collection's insert command.
+      #
+      # Example:
+      #
+      # <tt>Insert.persist</tt>
+      #
+      # Returns:
+      #
+      # The +Document+, whether the insert succeeded or not.
+      def persist
+        return @document if @validate && @document.invalid?(:create)
+        @document.run_callbacks(:create) do
+          @document.run_callbacks(:save) do
+            if insert
+              @document.new_record = false
+              @document._children.each { |child| child.new_record = false }
+              @document.move_changes
+            end
+          end
+        end; @document
+      end
+
+      protected
+      # Insert the document into the database.
+      def insert
+        if @document.embedded?
+          Persistence::InsertEmbedded.new(@document, @validate).persist
+        else
+          @collection.insert(@document.raw_attributes, @options)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/insert_embedded.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Insert is a persistence command responsible for taking a document that
+    # has not been saved to the database and saving it. This specific class
+    # handles the case when the document is embedded in another.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.insert(
+    #     { "_id" : 1, "field" : "value" },
+    #     false
+    #   );
+    class InsertEmbedded < Command
+      # Insert the new document in the database. If the document's parent is a
+      # new record, we will call save on the parent, otherwise we will $push
+      # the document onto the parent.
+      #
+      # Example:
+      #
+      # <tt>Insert.persist</tt>
+      #
+      # Returns:
+      #
+      # The +Document+, whether the insert succeeded or not.
+      def persist
+        return @document if @validate && @document.invalid?(:create)
+        parent = @document._parent
+        @document.run_callbacks(:create) do
+          @document.run_callbacks(:save) do
+            if parent.new_record?
+              parent.insert
+            else
+              update = { @document._inserter => { @document._position => @document.raw_attributes } }
+              @collection.update(parent._selector, update, @options.merge(:multi => false))
+              @document.new_record = false
+            end
+          end
+        end
+        @document
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "_id" : 1 },
+    #     false
+    #   );
+    class Remove < Command
+      # Remove the document from the database: delegates to the MongoDB
+      # collection remove method.
+      #
+      # Example:
+      #
+      # <tt>Remove.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ if success, +false+ if not.
+      def persist
+        remove
+      end
+
+      protected
+      # Remove the document from the database.
+      def remove
+        if @document.embedded?
+          Persistence::RemoveEmbedded.new(@document, @validate).persist
+        else
+          @collection.remove({ :_id => @document.id }, @options)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove_all.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "field" : value },
+    #     false
+    #   );
+    class RemoveAll < Command
+      # Remove the document from the database: delegates to the MongoDB
+      # collection remove method.
+      #
+      # Example:
+      #
+      # <tt>Remove.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ if success, +false+ if not.
+      def persist
+        remove
+      end
+
+      protected
+      # Remove the document from the database.
+      def remove
+        selector = (@klass.hereditary ? @selector.merge(:_type => @klass.name) : @selector)
+        count = @collection.find(selector).count
+        @collection.remove(selector, @options)
+        count
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/remove_embedded.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Remove is a persistence command responsible for deleting a document from
+    # the database.
+    #
+    # The underlying query resembles the following MongoDB query:
+    #
+    #   collection.remove(
+    #     { "_id" : 1 },
+    #     false
+    #   );
+    class RemoveEmbedded < Command
+      # Insert the new document in the database. If the document's parent is a
+      # new record, we will call save on the parent, otherwise we will $push
+      # the document onto the parent.
+      #
+      # Remove the document from the database. If the parent is a new record,
+      # it will get removed in Ruby only. If the parent is not a new record
+      # then either an $unset or $set will occur, depending if it's an
+      # embeds_one or embeds_many.
+      #
+      # Example:
+      #
+      # <tt>RemoveEmbedded.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ or +false+, depending on if the removal passed.
+      def persist
+        parent = @document._parent
+        parent.remove(@document)
+        unless parent.new_record?
+          update = { @document._remover => removal_selector }
+          @collection.update(parent._selector, update, @options.merge(:multi => false))
+        end; true
+      end
+
+      protected
+      # Get the value to pass to the removal modifier.
+      def setter
+        @document._index ? @document.id : true
+      end
+
+      def removal_selector
+        @document._index ? { @document._pull => { "_id" => @document.id } } : { @document._path => setter }
+      end
+    end
+  end
+end

data/lib/mongoid/persistence/update.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Persistence #:nodoc:
+    # Update is a persistence command responsible for taking a document that
+    # has already been saved to the database and saving it, depending on
+    # whether or not the document has been modified.
+    #
+    # Before persisting the command will check via dirty attributes if the
+    # document has changed, if not, it will simply return true. If it has it
+    # will go through the validation steps, run callbacks, and set the changed
+    # fields atomically on the document. The underlying query resembles the
+    # following MongoDB query:
+    #
+    #   collection.update(
+    #     { "_id" : 1,
+    #     { "$set" : { "field" : "value" },
+    #     false,
+    #     false
+    #   );
+    #
+    # For embedded documents it will use the positional locator:
+    #
+    #   collection.update(
+    #     { "_id" : 1, "addresses._id" : 2 },
+    #     { "$set" : { "addresses.$.field" : "value" },
+    #     false,
+    #     false
+    #   );
+    #
+    class Update < Command
+      # Persist the document that is to be updated to the database. This will
+      # only write changed fields via MongoDB's $set modifier operation.
+      #
+      # Example:
+      #
+      # <tt>Update.persist</tt>
+      #
+      # Returns:
+      #
+      # +true+ or +false+, depending on validation.
+      def persist
+        return false if validate && @document.invalid?(:update)
+        @document.run_callbacks(:save) do
+          @document.run_callbacks(:update) do
+            if update
+              @document.move_changes
+              @document._children.each do |child|
+                child.move_changes
+                child.new_record = false if child.new_record?
+              end
+            else
+              return false
+            end
+          end
+        end; true
+      end
+
+      protected
+      # Update the document in the database atomically.
+      def update
+        updates = @document._updates
+        unless updates.empty?
+          other_pushes = updates.delete(:other)
+          
+          @collection.update(@document._selector, updates, @options.merge(:multi => false))
+          @collection.update(@document._selector, { "$pushAll" => other_pushes }, @options.merge(:multi => false)) if other_pushes
+        end; true
+      end
+    end
+  end
+end

data/lib/mongoid/railtie.rb

@@ -0,0 +1,67 @@
+require "singleton"
+require "rails"
+require "mongoid/config"
+module Rails #:nodoc:
+  module Mongoid #:nodoc:
+    class Railtie < Rails::Railtie #:nodoc:
+
+      config.generators.orm :mongoid, :migration => false
+
+      rake_tasks do
+        load "mongoid/railties/database.rake"
+      end
+
+      # Exposes Mongoid's configuration to the Rails application configuration.
+      #
+      # Example:
+      #
+      #   module MyApplication
+      #     class Application < Rails::Application
+      #       config.mongoid.logger = Logger.new($stdout, :warn)
+      #       config.mongoid.reconnect_time = 10
+      #     end
+      #   end
+      config.mongoid = ::Mongoid::Config.instance
+
+      # Initialize Mongoid. This will look for a mongoid.yml in the config
+      # directory and configure mongoid appropriately.
+      #
+      # Example mongoid.yml:
+      #
+      #   defaults: &defaults
+      #     host: localhost
+      #     slaves:
+      #       # - host: localhost
+      #         # port: 27018
+      #       # - host: localhost
+      #         # port: 27019
+      #     allow_dynamic_fields: false
+      #     parameterize_keys: false
+      #     persist_in_safe_mode: false
+      #
+      #   development:
+      #     <<: *defaults
+      #     database: mongoid
+      initializer "setup database" do
+        config_file = Rails.root.join("config", "mongoid.yml")
+        if config_file.file?
+          settings = YAML.load(ERB.new(config_file.read).result)[Rails.env]
+          ::Mongoid.from_hash(settings) if settings.present?
+        end
+      end
+
+      initializer "verify that mongoid is configured" do
+        config.after_initialize do
+          begin
+            ::Mongoid.master
+          rescue ::Mongoid::Errors::InvalidDatabase => e
+            unless Rails.root.join("config", "mongoid.yml").file?
+              puts "\nMongoid config not found. Create a config file at: config/mongoid.yml"
+              puts "to generate one run: script/rails generate mongoid:config\n\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/railties/database.rake

@@ -0,0 +1,60 @@
+namespace :db do
+
+  if not Rake::Task.task_defined?("db:drop")
+    desc 'Drops all the collections for the database for the current Rails.env'
+    task :drop => :environment do
+      Mongoid.master.collections.each{|col| col.drop unless col.name == 'system.users' || col.name == "system.indexes" }
+    end
+  end
+
+  if not Rake::Task.task_defined?("db:seed")
+    # if another ORM has defined db:seed, don't run it twice.
+    desc 'Load the seed data from db/seeds.rb'
+    task :seed => :environment do
+      seed_file = File.join(Rails.root, 'db', 'seeds.rb')
+      load(seed_file) if File.exist?(seed_file)
+    end
+  end
+
+  if not Rake::Task.task_defined?("db:setup")
+    desc 'Create the database, and initialize with the seed data'
+    task :setup => [ 'db:create', 'db:seed' ]
+  end
+
+  if not Rake::Task.task_defined?("db:reseed")
+    desc 'Delete data and seed'
+    task :reseed => [ 'db:drop', 'db:seed' ]
+  end
+
+  if not Rake::Task.task_defined?("db:create")
+    task :create => :environment do
+      # noop
+    end
+  end
+
+  if not Rake::Task.task_defined?("db:migrate")
+    task :migrate => :environment do
+      # noop
+    end
+  end
+
+  if not Rake::Task.task_defined?("db:schema:load")
+    namespace :schema do
+      task :load do
+        # noop
+      end
+    end
+  end
+
+  if not Rake::Task.task_defined?("db:test:prepare")
+    namespace :test do
+      task :prepare do
+        # noop
+      end
+    end
+  end
+
+  ########
+  # TODO: lots more useful db tasks can be added here. stuff like copyDatabase, etc
+  ########
+end