mongoid 3.1.5 → 8.0.2

data/lib/mongoid/sessions/factory.rb

@@ -1,129 +0,0 @@
-# encoding: utf-8
-require "mongoid/sessions/mongo_uri"
-
-module Mongoid
-  module Sessions
-    module Factory
-      extend self
-
-      # Create a new session given the named configuration. If no name is
-      # provided, return a new session with the default configuration. If a
-      # name is provided for which no configuration exists, an error will be
-      # raised.
-      #
-      # @example Create the session.
-      #   Factory.create(:secondary)
-      #
-      # @param [ String, Symbol ] name The named session configuration.
-      #
-      # @raise [ Errors::NoSessionConfig ] If no config could be found.
-      #
-      # @return [ Moped::Session ] The new session.
-      #
-      # @since 3.0.0
-      def create(name = nil)
-        return default unless name
-        config = Mongoid.sessions[name]
-        raise Errors::NoSessionConfig.new(name) unless config
-        create_session(config)
-      end
-
-      # Get the default session.
-      #
-      # @example Get the default session.
-      #   Factory.default
-      #
-      # @raise [ Errors::NoSessionConfig ] If no default configuration is
-      #   found.
-      #
-      # @return [ Moped::Session ] The default session.
-      #
-      # @since 3.0.0
-      def default
-        create_session(Mongoid.sessions[:default])
-      end
-
-      private
-
-      # Create the session for the provided config.
-      #
-      # @api private
-      #
-      # @example Create the session.
-      #   Factory.create_session(config)
-      #
-      # @param [ Hash ] configuration The session config.
-      #
-      # @return [ Moped::Session ] The session.
-      #
-      # @since 3.0.0
-      def create_session(configuration)
-        raise Errors::NoSessionsConfig.new unless configuration
-        config, options = parse(configuration)
-        configuration.merge!(config) if configuration.delete(:uri)
-        session = Moped::Session.new(config[:hosts], options)
-        session.use(config[:database])
-        if authenticated?(config)
-          session.login(config[:username], config[:password])
-        end
-        session
-      end
-
-      # Are we authenticated with this session config?
-      #
-      # @api private
-      #
-      # @example Is this session authenticated?
-      #   Factory.authenticated?(config)
-      #
-      # @param [ Hash ] config The session config.
-      #
-      # @return [ true, false ] If we are authenticated.
-      #
-      # @since 3.0.0
-      def authenticated?(config)
-        config.has_key?(:username) && config.has_key?(:password)
-      end
-
-      # Parse the configuration. If a uri is provided we need to extract the
-      # elements of it, otherwise the options are left alone.
-      #
-      # @api private
-      #
-      # @example Parse the config.
-      #   Factory.parse(config)
-      #
-      # @param [ Hash ] config The configuration.
-      #
-      # @return [ Array<Hash> ] The configuration, parsed.
-      #
-      # @since 3.0.0
-      def parse(config)
-        options = config[:options].try(:dup) || {}
-        parsed = if config.has_key?(:uri)
-          MongoUri.new(config[:uri]).to_hash
-        else
-          inject_ports(config)
-        end
-        [ parsed, options.symbolize_keys ]
-      end
-
-      # Will inject the default port of 27017 if not supplied.
-      #
-      # @example Inject default ports.
-      #   factory.inject_ports(config)
-      #
-      # @param [ Hash ] config The session configuration.
-      #
-      # @return [ Hash ] The altered configuration.
-      #
-      # @since 3.1.0
-      def inject_ports(config)
-        config["hosts"] = config["hosts"].map do |host|
-          host =~ /:/ ? host : "#{host}:27017"
-        end
-        config
-      end
-    end
-  end
-end

data/lib/mongoid/sessions/mongo_uri.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Sessions
-    class MongoUri
-
-      SCHEME = /(mongodb:\/\/)/
-      USER = /([-.\w:]+)/
-      PASS = /([^@,]+)/
-      NODES = /((([-.\w]+)(?::(\w+))?,?)+)/
-      DATABASE = /(?:\/([-\w]+))?/
-
-      URI = /#{SCHEME}(#{USER}:#{PASS}@)?#{NODES}#{DATABASE}/
-
-      attr_reader :match
-
-      # Get the database provided in the URI.
-      #
-      # @example Get the database.
-      #   uri.database
-      #
-      # @return [ String ] The database.
-      #
-      # @since 3.0.0
-      def database
-        @database ||= match[9]
-      end
-
-      # Get the hosts provided in the URI.
-      #
-      # @example Get the hosts.
-      #   uri.hosts
-      #
-      # @return [ Array<String> ] The hosts.
-      #
-      # @since 3.0.0
-      def hosts
-        @hosts ||= match[5].split(",")
-      end
-
-      # Create the new uri from the provided string.
-      #
-      # @example Create the new uri.
-      #   MongoUri.new(uri)
-      #
-      # @param [ String ] string The uri string.
-      #
-      # @since 3.0.0
-      def initialize(string)
-        @match = string.match(URI)
-      end
-
-      # Get the password provided in the URI.
-      #
-      # @example Get the password.
-      #   uri.password
-      #
-      # @return [ String ] The password.
-      #
-      # @since 3.0.0
-      def password
-        @password ||= match[4]
-      end
-
-      # Get the uri as a Mongoid friendly configuration hash.
-      #
-      # @example Get the uri as a hash.
-      #   uri.to_hash
-      #
-      # @return [ Hash ] The uri as options.
-      #
-      # @since 3.0.0
-      def to_hash
-        config = { database: database, hosts: hosts }
-        if username && password
-          config.merge!(username: username, password: password)
-        end
-        config
-      end
-
-      # Get the username provided in the URI.
-      #
-      # @example Get the username.
-      #   uri.username
-      #
-      # @return [ String ] The username.
-      #
-      # @since 3.0.0
-      def username
-        @username ||= match[3]
-      end
-    end
-  end
-end

data/lib/mongoid/sessions/validators/storage.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Sessions
-    module Validators
-
-      # Validates the options passed to :store_in.
-      module Storage
-        extend self
-
-        VALID_OPTIONS = [ :collection, :database, :session ]
-
-        # Validate the options provided to :store_in.
-        #
-        # @example Validate the options.
-        #   Storage.validate(:collection_name)
-        #
-        # @param [ Class ] klass The model class.
-        # @param [ Hash, String, Symbol ] options The provided options.
-        #
-        # @since 3.0.0
-        def validate(klass, options)
-          if !options.is_a?(::Hash) || !valid_keys?(options)
-            raise Errors::InvalidStorageOptions.new(klass, options)
-          end
-        end
-
-        private
-
-        # Determine if all keys in the options hash are valid.
-        #
-        # @api private
-        #
-        # @example Are all keys valid?
-        #   validator.valid_keys?({ collection: "name" })
-        #
-        # @param [ Hash ] options The options hash.
-        #
-        # @return [ true, false ] If all keys are valid.
-        #
-        # @since 3.0.0
-        def valid_keys?(options)
-          options.keys.all? do |key|
-            VALID_OPTIONS.include?(key)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongoid/sessions/validators.rb

@@ -1,2 +0,0 @@
-# encoding: utf-8
-require "mongoid/sessions/validators/storage"

data/lib/mongoid/sessions.rb

@@ -1,433 +0,0 @@
-# encoding: utf-8
-require "mongoid/sessions/factory"
-require "mongoid/sessions/validators"
-
-module Mongoid
-  module Sessions
-    extend ActiveSupport::Concern
-
-    included do
-      cattr_accessor :default_collection_name, :storage_options
-      self.default_collection_name = self.name.collectionize.to_sym
-    end
-
-    # Get the collection for this model from the session. Will check for an
-    # overridden collection name from the store_in macro or the collection
-    # with a pluralized model name.
-    #
-    # @example Get the model's collection.
-    #   Model.collection
-    #
-    # @return [ Moped::Collection ] The collection.
-    #
-    # @since 3.0.0
-    def collection
-      self.class.collection
-    end
-
-    # Get the name of the collection this model persists to. This will be
-    # either the pluralized class name or the option defined in the store_in
-    # macro.
-    #
-    # @example Get the collection name.
-    #   Model.collection_name
-    #
-    # @return [ String ] The name of the collection.
-    #
-    # @since 3.0.0
-    def collection_name
-      self.class.collection_name
-    end
-
-    # Get the session for this model. This is determined in the following order:
-    #
-    #   1. Any custom configuration provided by the 'store_in' macro.
-    #   2. The 'default' session as provided in the mongoid.yml
-    #
-    # @example Get the session.
-    #   model.mongo_session
-    #
-    # @return [ Moped::Session ] The default moped session.
-    #
-    # @since 3.0.0
-    def mongo_session
-      self.class.mongo_session
-    end
-
-    # Tell the next persistance operation to store in a specific collection,
-    # database or session.
-    #
-    # @example Save the current document to a different collection.
-    #   model.with(collection: "secondary").save
-    #
-    # @example Save the current document to a different database.
-    #   model.with(database: "secondary").save
-    #
-    # @example Save the current document to a different session.
-    #   model.with(session: "replica_set").save
-    #
-    # @example Save with a combination of options.
-    #   model.with(session: "sharded", database: "secondary").save
-    #
-    # @param [ Hash ] options The storage options.
-    #
-    # @option options [ String, Symbol ] :collection The collection name.
-    # @option options [ String, Symbol ] :database The database name.
-    # @option options [ String, Symbol ] :session The session name.
-    #
-    # @return [ Document ] The current document.
-    #
-    # @since 3.0.0
-    def with(options)
-      Threaded.set_persistence_options(self.class, options)
-      self
-    end
-
-    class << self
-
-      # Clear all sessions from the current thread.
-      #
-      # @example Clear all sessions.
-      #   Mongoid::Sessions.clear
-      #
-      # @return [ Array ] The empty sessions.
-      #
-      # @since 3.0.0
-      def clear
-        Threaded.sessions.clear
-      end
-
-      # Get the default session.
-      #
-      # @example Get the default session.
-      #   Mongoid::Sessions.default
-      #
-      # @return [ Moped::Session ] The default session.
-      #
-      # @since 3.0.0
-      def default
-        Threaded.sessions[:default] ||= Sessions::Factory.default
-      end
-
-      # Disconnect all active sessions.
-      #
-      # @example Disconnect all active sessions.
-      #   Mongoid::Sessions.disconnect
-      #
-      # @return [ true ] True.
-      #
-      # @since 3.1.0
-      def disconnect
-        Threaded.sessions.values.each do |session|
-          session.disconnect
-        end
-      end
-
-      # Get a session with the provided name.
-      #
-      # @example Get a session with the name.
-      #   Mongoid::Sessions.with_name(:replica)
-      #
-      # @param [ Symbol ] name The name of the session.
-      #
-      # @return [ Moped::Session ] The named session.
-      #
-      # @since 3.0.0
-      def with_name(name)
-        Threaded.sessions[name.to_sym] ||= Sessions::Factory.create(name)
-      end
-    end
-
-    module ClassMethods
-
-      # Clear all persistence options from the current thread.
-      #
-      # @example Clear the persistence options.
-      #   Mongoid::Sessions.clear_persistence_options
-      #
-      # @return [ true ] True.
-      #
-      # @since 3.0.0
-      def clear_persistence_options
-        Threaded.clear_persistence_options(self)
-      end
-
-      # Get the collection for this model from the session. Will check for an
-      # overridden collection name from the store_in macro or the collection
-      # with a pluralized model name.
-      #
-      # @example Get the model's collection.
-      #   Model.collection
-      #
-      # @return [ Moped::Collection ] The collection.
-      #
-      # @since 3.0.0
-      def collection
-        if opts = persistence_options
-          coll = mongo_session.with(opts)[opts[:collection] || collection_name]
-          clear_persistence_options unless validating_with_query? || _loading_revision?
-          coll
-        else
-          mongo_session[collection_name]
-        end
-      end
-
-      # Get the name of the collection this model persists to. This will be
-      # either the pluralized class name or the option defined in the store_in
-      # macro.
-      #
-      # @example Get the collection name.
-      #   Model.collection_name
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def collection_name
-        __collection_name__
-      end
-
-      # Get the default database name for this model.
-      #
-      # @example Get the default database name.
-      #   Model.database_name
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def database_name
-        __database_name__
-      end
-
-      # Get the overridden database name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_database(:name)+.
-      #
-      # @example Get the overridden database name.
-      #   Model.database_override
-      #
-      # @return [ String, Symbol ] The overridden database name.
-      #
-      # @since 3.0.0
-      def database_override
-        persistence_options.try { |opts| opts[:database] } || Threaded.database_override
-      end
-
-      # Get the session for this model. This is determined in the following order:
-      #
-      #   1. Any custom configuration provided by the 'store_in' macro.
-      #   2. The 'default' session as provided in the mongoid.yml
-      #
-      # @example Get the session.
-      #   Model.mongo_session
-      #
-      # @return [ Moped::Session ] The default moped session.
-      #
-      # @since 3.0.0
-      def mongo_session
-        session = __session__
-        session.use(database_override || current_database_name(session))
-        session
-      end
-
-      # Get the persistence options from the current thread.
-      #
-      # @example Get the persistence options.
-      #   Model.persistence_options
-      #
-      # @return [ Hash ] The persistence options.
-      #
-      # @since 3.0.0
-      def persistence_options
-        Threaded.persistence_options(self)
-      end
-
-      # Get the overridden session name. This either can be overridden by
-      # using +Model.with+ or by overriding at the global level via
-      # +Mongoid.override_session(:name)+.
-      #
-      # @example Get the overridden session name.
-      #   Model.session_override
-      #
-      # @return [ String, Symbol ] The overridden session name.
-      #
-      # @since 3.0.0
-      def session_override
-        persistence_options.try { |opts| opts[:session] } || Threaded.session_override
-      end
-
-      # Give this model specific custom default storage options.
-      #
-      # @example Store this model by default in "artists"
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists"
-      #   end
-      #
-      # @example Store this model by default in the sharded db.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in database: "echo_shard"
-      #   end
-      #
-      # @example Store this model by default in a different session.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in session: "secondary"
-      #   end
-      #
-      # @example Store this model with a combination of options.
-      #   class Band
-      #     include Mongoid::Document
-      #     store_in collection: "artists", database: "secondary"
-      #   end
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def store_in(options)
-        Validators::Storage.validate(self, options)
-        self.storage_options ||= {}
-        self.storage_options.merge!(options)
-      end
-
-      # Tell the next persistance operation to store in a specific collection,
-      # database or session.
-      #
-      # @example Create a document in a different collection.
-      #   Model.with(collection: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different database.
-      #   Model.with(database: "secondary").create(name: "test")
-      #
-      # @example Create a document in a different session.
-      #   Model.with(session: "secondary").create(name: "test")
-      #
-      # @example Create with a combination of options.
-      #   Model.with(session: "sharded", database: "secondary").create
-      #
-      # @param [ Hash ] options The storage options.
-      #
-      # @option options [ String, Symbol ] :collection The collection name.
-      # @option options [ String, Symbol ] :database The database name.
-      # @option options [ String, Symbol ] :session The session name.
-      #
-      # @return [ Class ] The model class.
-      #
-      # @since 3.0.0
-      def with(options)
-        Threaded.set_persistence_options(self, options)
-        self
-      end
-
-      private
-
-      # Get the name of the collection this model persists to.
-      #
-      # @example Get the collection name.
-      #   Model.__collection_name__
-      #
-      # @return [ Symbol ] The name of the collection.
-      #
-      # @since 3.0.0
-      def __collection_name__
-        if storage_options && name = storage_options[:collection]
-          __evaluate__(name)
-        else
-          default_collection_name
-        end
-      end
-
-      # Get the database name for the model.
-      #
-      # @example Get the database name.
-      #   Model.__database_name__
-      #
-      # @return [ Symbol ] The name of the database.
-      #
-      # @since 3.0.0
-      def __database_name__
-        if storage_options && name = storage_options[:database]
-          __evaluate__(name)
-        else
-          Mongoid.sessions[__session_name__][:database]
-        end
-      end
-
-      # Get the session name for the model.
-      #
-      # @example Get the session name.
-      #   Model.__session_name__
-      #
-      # @return [ Symbol ] The name of the session.
-      #
-      # @since 3.0.0
-      def __session_name__
-        if storage_options && name = storage_options[:session]
-          __evaluate__(name)
-        else
-          :default
-        end
-      end
-
-      # Get the session for this class.
-      #
-      # @example Get the session.
-      #   Model.__session__
-      #
-      # @return [ Moped::Session ] The moped session.
-      #
-      # @since 3.0.0
-      def __session__
-        if !(name = session_override).nil?
-          Sessions.with_name(name)
-        else
-          Sessions.with_name(__session_name__)
-        end
-      end
-
-      # Eval the provided value, either byt calling it if it responds to call
-      # or returning the value itself.
-      #
-      # @api private
-      #
-      # @example Evaluate the name.
-      #   Model.__evaluate__(:name)
-      #
-      # @param [ String, Symbol, Proc ] name The name.
-      #
-      # @return [ Symbol ] The value as a symbol.
-      #
-      # @since 3.1.0
-      def __evaluate__(name)
-        name.respond_to?(:call) ? name.call.to_sym : name.to_sym
-      end
-
-      # Get the name of the current database to use. Will check for a session
-      # override with a database first, then database name.
-      #
-      # @api private
-      #
-      # @example Get the current database name.
-      #   Model.current_database_name
-      #
-      # @param [ Moped::Session ] session The current session.
-      #
-      # @return [ Symbol ] The current database name.
-      #
-      # @since 3.1.0
-      def current_database_name(session)
-        if session_override && name = session.options[:database]
-          name
-        else
-          database_name
-        end
-      end
-    end
-  end
-end