Module Grape::DSL::Settings
In: lib/grape/dsl/settings.rb

Keeps track of settings (implemented as key-value pairs, grouped by types), in two contexts: top-level settings which apply globally no matter where they‘re defined, and inheritable settings which apply only in the current scope and scopes nested under it.

Methods

api_class_setting   get_or_set   global_setting   inheritable_setting   namespace_end   namespace_inheritable   namespace_inheritable_to_nil   namespace_reverse_stackable   namespace_reverse_stackable_with_hash   namespace_setting   namespace_stackable   namespace_stackable_with_hash   namespace_start   route_end   route_setting   top_level_setting   unset   unset_api_class_setting   unset_global_setting   unset_namespace_inheritable   unset_namespace_setting   unset_namespace_stackable   unset_route_setting   within_namespace  

Attributes

inheritable_setting  [W] 
top_level_setting  [W] 

Public Instance methods

get_or_set(type, key, value)

@param type [Symbol] @param key [Symbol] @param value [Object] will be stored if the value is currently empty @return either the old value, if it wasn‘t nil, or the given value

global_setting(key, value = nil)

@param key [Symbol] @param value [Object] @return (see get_or_set)

inheritable_setting()

Fetch our current inheritable settings, which are inherited by nested scopes but not shared across siblings.

namespace_end()

Set the inheritable settings pointer back up by one level.

namespace_start()

Fork our inheritable settings to a new instance, copied from our parent‘s, but separate so we won‘t modify it. Every call to this method should have an answering call to namespace_end.

route_end()

Stop defining settings for the current route and clear them for the next, within a namespace.

top_level_setting()

Fetch our top-level settings, which apply to all endpoints in the API.

unset(type, key)

@param type [Symbol] @param key [Symbol]

unset_global_setting(key)

@param key [Symbol]

within_namespace() {|if block_given?| ...}

Execute the block within a context where our inheritable settings are forked to a new copy (see namespace_start).

[Validate]