Sha256: 2cd7bd4dba54e7d4b7435bf430055a29bfcd27c60b66f599547b87c077b0b13c

Contents?: true

Size: 1.67 KB

Versions: 34

Compression:

Stored size: 1.67 KB

Contents

# encoding: utf-8
module Mongoid
  module Config

    # Encapsulates logic for setting options.
    module Options

      # Get the defaults or initialize a new empty hash.
      #
      # @example Get the defaults.
      #   options.defaults
      #
      # @return [ Hash ] The default options.
      #
      # @since 2.3.0
      def defaults
        @defaults ||= {}
      end

      # Define a configuration option with a default.
      #
      # @example Define the option.
      #   Options.option(:persist_in_safe_mode, :default => false)
      #
      # @param [ Symbol ] name The name of the configuration option.
      # @param [ Hash ] options Extras for the option.
      #
      # @option options [ Object ] :default The default value.
      #
      # @since 2.0.0.rc.1
      def option(name, options = {})
        defaults[name] = settings[name] = options[:default]

        class_eval <<-RUBY
          def #{name}
            settings[#{name.inspect}]
          end

          def #{name}=(value)
            settings[#{name.inspect}] = value
          end

          def #{name}?
            #{name}
          end
        RUBY
      end

      # Reset the configuration options to the defaults.
      #
      # @example Reset the configuration options.
      #   config.reset
      #
      # @return [ Hash ] The defaults.
      #
      # @since 2.3.0
      def reset
        settings.replace(defaults)
      end

      # Get the settings or initialize a new empty hash.
      #
      # @example Get the settings.
      #   options.settings
      #
      # @return [ Hash ] The setting options.
      #
      # @since 2.3.0
      def settings
        @settings ||= {}
      end
    end
  end
end

Version data entries

34 entries across 34 versions & 4 rubygems

Version Path
mongoid-3.1.7 lib/mongoid/config/options.rb
mongoid-3.1.6 lib/mongoid/config/options.rb
mongoid-3.1.5 lib/mongoid/config/options.rb
mongoid_heroku_stable-4.0.0 lib/mongoid/config/options.rb
mongoid_rails4-4.0.0 lib/mongoid/config/options.rb
mongoid-3.1.4 lib/mongoid/config/options.rb
mongoid-3.1.3 lib/mongoid/config/options.rb
mongoid-3.1.2 lib/mongoid/config/options.rb
mongoid-3.0.23 lib/mongoid/config/options.rb
mongoid-3.1.1 lib/mongoid/config/options.rb
mongoid-3.1.0 lib/mongoid/config/options.rb
mongoid-3.0.22 lib/mongoid/config/options.rb
mongoid-3.0.21 lib/mongoid/config/options.rb
mongoid-3.0.20 lib/mongoid/config/options.rb
mongoid-3.0.19 lib/mongoid/config/options.rb
mongoid-3.0.18 lib/mongoid/config/options.rb
mongoid-3.0.17 lib/mongoid/config/options.rb
sunrise-cms-0.5.0.rc1 vendor/bundle/ruby/1.9.1/gems/mongoid-3.0.16/lib/mongoid/config/options.rb
mongoid-3.0.16 lib/mongoid/config/options.rb
mongoid-3.0.15 lib/mongoid/config/options.rb