Add #inch method to Definition and Config

lib/dry/initializer/builders/attribute.rb

@@ -11,7 +11,7 @@ def call
 
     private
 
-    # rubocop: disable Style/MethodLength
+    # rubocop: disable Metrics/MethodLength
     def initialize(definition)
       @definition = definition
       @option     = definition.option
@@ -26,7 +26,7 @@ def initialize(definition)
       @item       = "__dry_initializer_definition__"
       @val        = @option ? "__dry_initializer_value__" : @source
     end
-    # rubocop: enable Style/MethodLength
+    # rubocop: enable Metrics/MethodLength
 
     def lines
       [

lib/dry/initializer/config.rb

@@ -111,6 +111,18 @@ def finalize
       self
     end
 
+    # Human-readable representation of configured params and options
+    # @return [String]
+    def inch
+      line  =  Builders::Signature[self]
+      line  =  line.gsub("__dry_initializer_options__", "options")
+      lines =  ["@!method initialize(#{line})"]
+      lines += ["Initializes an instance of #{extended_class}"]
+      lines += definitions.values.map(&:inch)
+      lines += ["@return [#{extended_class}]"]
+      lines.join("\n")
+    end
+
     private
 
     def initialize(extended_class = nil, null: UNDEFINED)

lib/dry/initializer/definition.rb

@@ -38,6 +38,15 @@ def code
       Builders::Reader[self]
     end
 
+    def inch
+      @inch ||= (option ? "@option" : "@param ").tap do |text|
+        text << " [Object]"
+        text << (option ? " :#{source}" : " #{source}")
+        text << (optional ? " (optional)" : " (required)")
+        text << " #{desc}" if desc
+      end
+    end
+
     private
 
     def initialize(option, null, source, coercer = nil, **options)