Add :desc option to option/param definitions

dry-rb · Sep 13, 2017 · 356d6a8 · 356d6a8
1 parent c24751a
commit 356d6a8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/lib/dry/initializer/definition.rb b/lib/dry/initializer/definition.rb
@@ -9,15 +9,17 @@ module Dry::Initializer
   #
   class Definition
     attr_reader :option, :null, :source, :target, :ivar,
-                :type, :optional, :default, :reader
+                :type, :optional, :default, :reader,
+                :desc
 
     def options
       {
         as:       target,
         type:     type,
         optional: optional,
         default:  default,
-        reader:   reader
+        reader:   reader,
+        desc:     desc
       }.reject { |_, value| value.nil? }
     end
 
@@ -48,6 +50,7 @@ def initialize(option, null, source, coercer = nil, **options)
       @reader   = prepare_reader options.fetch(:reader, true)
       @default  = check_default options[:default]
       @optional = options.fetch(:optional, @default)
+      @desc     = options[:desc]&.to_s&.capitalize
     end
 
     def check_source(value)

diff --git a/spec/public_attributes_utility_spec.rb b/spec/public_attributes_utility_spec.rb
@@ -5,7 +5,7 @@
     before do
       class Test::Foo
         extend Dry::Initializer
-        param  :foo, proc(&:to_s)
+        param  :foo, proc(&:to_s), desc: "a weird parameter"
         option :moo, optional: true
         option :bar, default: proc { 1 },     reader: false
         option :baz, optional: true,          reader: :protected