dry-initializer 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67fcba3cf78d1b854e4ff970cc130c505d5d493c
-  data.tar.gz: 8f8efa2a05d06ba5b4f9d0d8db8f70d4bbe1f76a
+  metadata.gz: a1ca51134d5d589e28d742d78ea453809ef53ea0
+  data.tar.gz: e1c9fe841d80609eb35a17f2d5742bae2f9dd026
 SHA512:
-  metadata.gz: d1ded457500d4a80d184c34a8045f8c7cee0ce914c1d007d980237c1cca6eb2fd9e35f4c5e7a0a7dc55c0b1ec2bc43168d969c549d8aee6e47ba9e6525b789ed
-  data.tar.gz: b948cc6fce3c2b98587364945790942d095997a36b5b9c0ce30ccd53453cff6b12169fcb87c4d086a74862aed7a02ce55bb0332aeef89e513f9af5f3a432f4bf
+  metadata.gz: eb91104134574f2c106b813076de9798788f558c25cdd0bdadc0098fc6f90cea915d15e742d4805fcd32aed28c5e53a4801ed04397a51c8a668d69989f4dc8d4
+  data.tar.gz: b104ca6bd0b5b46de69036754a7669b162bc88856aec29a298571bf5a988d8eee1c54c15aa0a0b774b872e12f2a596f190796a62f43ea36f333fe5fb4d3a4802

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.2.0] [2017-09-13]
+
+### Added
+- Option `:desc` for option/param to add a description (nepalez)
+
+- Methods `Definition#inch` and `Config#inch` to inspect definitions (nepalez)
+
+  ```ruby
+  class User
+    extend Dry::Initializer
+    option :name,  proc(&:to_s), optional: true, desc: "User name"
+    option :email, optional: true, desc: "user email"
+  end
+
+  User.dry_initializer.inch
+  # @!method initialize(*, **options)
+  # Initializes an instance of User
+  # @option [Object] :name (optional) User name
+  # @option [Object] :email (optional) User email
+  # @return [User]
+  ```
+
 ## [2.1.0] [2017-09-11]
 
 ### Added
@@ -687,3 +709,5 @@ First public release
 [1.4.0]: https://github.com/dry-rb/dry-initializer/compare/v1.3.0...v1.4.0
 [1.4.1]: https://github.com/dry-rb/dry-initializer/compare/v1.4.0...v1.4.1
 [2.0.0]: https://github.com/dry-rb/dry-initializer/compare/v1.4.1...v2.0.0
+[2.1.0]: https://github.com/dry-rb/dry-initializer/compare/v2.0.0...v2.1.0
+[2.2.0]: https://github.com/dry-rb/dry-initializer/compare/v2.1.0...v2.2.0

data/README.md

@@ -46,7 +46,7 @@ require 'dry-initializer'
 require 'dry-types'
 
 class User
-  extend Dry::Initializer::Mixin
+  extend Dry::Initializer
 
   # Params of the initializer along with corresponding readers
   param  :name,  proc(&:to_s)

data/dry-initializer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name     = "dry-initializer"
-  gem.version  = "2.1.0"
+  gem.version  = "2.2.0"
   gem.author   = ["Vladimir Kochnev (marshall-lee)", "Andrew Kozin (nepalez)"]
   gem.email    = "andrew.kozin@gmail.com"
   gem.homepage = "https://github.com/dryrb/dry-initializer"

data/lib/dry/initializer/builders/attribute.rb

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

data/lib/dry/initializer/config.rb

@@ -111,6 +111,18 @@ module Dry::Initializer
       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)

data/lib/dry/initializer/definition.rb

@@ -9,7 +9,8 @@ module Dry::Initializer
   #
   class Definition
     attr_reader :option, :null, :source, :target, :ivar,
-                :type, :optional, :default, :reader
+                :type, :optional, :default, :reader,
+                :desc
 
     def options
       {
@@ -17,7 +18,8 @@ module Dry::Initializer
         type:     type,
         optional: optional,
         default:  default,
-        reader:   reader
+        reader:   reader,
+        desc:     desc
       }.reject { |_, value| value.nil? }
     end
 
@@ -36,6 +38,15 @@ module Dry::Initializer
       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)
@@ -48,6 +59,7 @@ module Dry::Initializer
       @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)

data/spec/public_attributes_utility_spec.rb

@@ -5,7 +5,7 @@ describe Dry::Initializer, ".dry_initializer.public_attributes" do
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-initializer
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Vladimir Kochnev (marshall-lee)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec