Module: Doorkeeper::Config::Option

Included in:
Doorkeeper::Config
Defined in:
lib/doorkeeper/config.rb

Instance Method Summary collapse

Instance Method Details

#extended(base) ⇒ Object


166
167
168
# File 'lib/doorkeeper/config.rb', line 166

def extended(base)
  base.send(:private, :option)
end

#option(name, options = {}) ⇒ Object

Defines configuration option

When you call option, it defines two methods. One method will take place in the Config class and the other method will take place in the Builder class.

The name parameter will set both builder method and config attribute. If the :as option is defined, the builder method will be the specified option while the config attribute will be the name parameter.

If you want to introduce another level of config DSL you can define builder_class parameter. Builder should take a block as the initializer parameter and respond to function build that returns the value of the config attribute.

Options

  • :as

    Set the builder method that goes inside configure block

  • :default

    The default value in case no option was set

Examples

option :name
option :name, as: :set_name
option :name, default: 'My Name'
option :scopes builder_class: ScopesBuilder

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/doorkeeper/config.rb', line 138

def option(name, options = {})
  attribute = options[:as] || name
  attribute_builder = options[:builder_class]

  Builder.instance_eval do
    define_method name do |*args, &block|
      # TODO: is builder_class option being used?
      value = unless attribute_builder
                block ? block : args.first
              else
                attribute_builder.new(&block).build
              end

      @config.instance_variable_set(:"@#{attribute}", value)
    end
  end

  define_method attribute do |*args|
    if instance_variable_defined?(:"@#{attribute}")
      instance_variable_get(:"@#{attribute}")
    else
      options[:default]
    end
  end

  public attribute
end