lib/sinclair/configurable.rb in sinclair-1.3.1 vs lib/sinclair/configurable.rb in sinclair-1.3.2
- old
+ new
@@ -15,11 +15,12 @@
#
# @example
# class MyConfigurable
# extend Sinclair::Configurable
#
- # configurable_with :host, :port
+ # # port is defaulted to 80
+ # configurable_with :host, port: 80
# end
#
# MyConfigurable.configure do
# host 'interstella.com'
# port 5555
@@ -29,17 +30,36 @@
# # returns 'interstella.com'
#
# MyConfigurable.config.port
# # returns 5555
#
- # MyConfigurable.reset
+ # MyConfigurable.reset_config
#
# MyConfigurable.config.host
# # returns nil
+ #
+ # MyConfigurable.config.port
+ # # returns 80
module Configurable
- delegate :config, :reset_config, :configure, to: :config_factory
+ # (see ConfigFactory#config)
+ # @see ConfigFactory#config
+ def config
+ config_factory.config
+ end
+ # (see ConfigFactory#reset_config)
+ # @see ConfigFactory#reset_config
+ def reset_config
+ config_factory.reset_config
+ end
+
+ # (see ConfigFactory#configure)
+ # @see ConfigFactory#configure
+ def configure(&block)
+ config_factory.configure(&block)
+ end
+
protected
# @api private
#
# @private
@@ -62,10 +82,10 @@
end
end
private
- # @visibility public
+ # @!visibility public
#
# Adds a configuration option to config class
#
# @return [Array<Symbol>] list of possible
# configurations