mongoid/mongoid

# encoding: utf-8
module Mongoid
  module Clients
    module StorageOptions
      extend ActiveSupport::Concern

      included do

        cattr_accessor :storage_options, instance_writer: false do
          storage_options_defaults
        end
      end

      module ClassMethods
        extend Gem::Deprecate

        # 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 client.
        #   class Band
        #     include Mongoid::Document
        #     store_in client: "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 ] :client The client name.
        #
        # @return [ Class ] The model class.
        #
        # @since 3.0.0
        def store_in(options)
          Validators::Storage.validate(self, options)
          storage_options.merge!(options)
        end

        # Reset the store_in options
        #
        # @example Reset the store_in options
        #   Model.reset_storage_options!
        #
        # @since 4.0.0
        def reset_storage_options!
          self.storage_options = storage_options_defaults.dup
        end

        # Get the default storage options.
        #
        # @example Get the default storage options.
        #   Model.storage_options_defaults
        #
        # @return [ Hash ] Default storage options.
        #
        # @since 4.0.0
        def storage_options_defaults
          {
            collection: name.collectionize.to_sym,
            client: :default,
            database: -> { configured_database }
          }
        end

        # 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
          __evaluate__(storage_options[:collection])
        end

        # Get the client name for the model.
        #
        # @example Get the client name.
        #   Model.client_name
        #
        # @return [ Symbol ] The name of the client.
        #
        # @since 3.0.0
        def client_name
          __evaluate__(storage_options[:client])
        end
        alias :session_name :client_name
        deprecate :session_name, :client_name, 2015, 12

        # Get the database name for the model.
        #
        # @example Get the database name.
        #   Model.database_name
        #
        # @return [ Symbol ] The name of the client.
        #
        # @since 4.0.0
        def database_name
          __evaluate__(storage_options[:database])
        end

        private

        # 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)
          return nil unless name
          name.respond_to?(:call) ? name.call.to_sym : name.to_sym
        end

        def configured_database
          client = Mongoid.clients[client_name]
          if db = client[:database]
            db
          elsif uri = client[:uri]
            client[:database] = Mongo::URI.new(uri).database
          else
            nil
          end
        end
      end
    end
  end
end