yard-dry-initializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39a09f1722d473bcf5146568ceb2d575ed5927e5b05f4fc0255bda963beeab75
+  data.tar.gz: 9cffcac3f30db2d90be738c157c107608b846d4a5257993940a52e656c8563d1
+SHA512:
+  metadata.gz: 6f969d2dbb74c05ba12061852684e50b4df64c9a392b768f0214365c46629dbd20e5d19345bbdf98a80a7888305cd37e2df6be317b825fd0db65320f48dfc632
+  data.tar.gz: 2749bb64f7e46d9af4d9f142168c7fd2040689e9b71ec39602c40183b1a04614392b1c877527e4dbddb7a9d6ca0c9bbe552687971e1b8a8cd9e7a9db99cb2f37

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.*"
+    - "*.gemspec"
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in yard-dry-initializer.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# YARD plugin for Dry::Initializer
+
+The [dry-initializer] gem is awesome. It makes defining dependencies of your classes so convenient and declarative.
+
+But when you're using these classses, how to get know which positional arguments does it expect and in which order and which keyword ones?
+
+It's easy (but bother) to look into source code, but in case of using inheritance it will be very cumbersome.
+
+This YARD plugin to the rescue!
+
+<a href="https://evilmartians.com/?utm_source=yard-dry-initializer&utm_campaign=project_page"><img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+Write this:
+
+```
+class Base
+  extend Dry::Initializer
+
+  param :account,                       comment: "End user account on behalf of which all actions are done"
+  option :force, default: -> { false }, comment: "Execute action regardless of pre-checks result"
+end
+
+class ProcessSubject < Base
+  param :subject
+  option :filter, comment: "Callable object, given +subject+ will allow processing if returns true"
+  option :force,  default: -> { true }
+end
+```
+
+And you will get this:
+
+![Example of generated docs for ProcessSubject class](generated_docs_example.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-dry-initializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Add this line in your `.yardopts`:
+
+    --plugin dry-initializer
+
+## Usage
+
+Use YARD as usual, enjoy new info in your docs.
+
+If you're getting `[error]: Error loading plugin 'yard-dry-initializer'` error you may need to invoke `yard` via `bundle exec` or generate binstubs for it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Envek/yard-dry-initializer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'yard/dry/initializer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yard-dry-initializer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'yard/dry/initializer'

data/lib/yard/dry/initializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'yard/dry/initializer/param_handler'
+require 'yard/dry/initializer/option_handler'
+require 'yard/dry/initializer/version'
+
+module YARD
+  module Dry
+    module Initializer
+    end
+  end
+end

data/lib/yard/dry/initializer/common_handler.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module YARD
+  module Dry
+    module Initializer
+      module CommonHandler
+        def process
+          return unless reader?
+
+          # Define reader method
+          object = YARD::CodeObjects::MethodObject.new(namespace, reader_name)
+          register(object)
+          object.visibility = reader_visibility
+          object.dynamic = true
+          doc = "Reader method for the +#{definition_name}+ initializer parameter."
+          object.docstring = [comment, doc].compact.join("\n\n")
+
+          # Register as attribute unless it is already registered
+          return if namespace.attributes[:instance].key?(reader_name.to_sym)
+          namespace.attributes[:instance][reader_name.to_sym] = { read: object }
+        end
+
+        protected
+
+        def constructor
+          @constructor ||= begin
+            existing = namespace.meths.find(&:constructor?)
+            return create_constructor unless existing
+            return existing if existing.namespace == namespace
+            copy_parent_constructor(existing)
+          end
+        end
+
+        def create_constructor
+          YARD::CodeObjects::MethodObject.new(namespace, :initialize)
+        end
+
+        def copy_parent_constructor(existing_constructor)
+          YARD::CodeObjects::MethodObject.new(namespace, :initialize) do |new_constructor|
+            existing_constructor.copy_to(new_constructor)
+
+            # To allow replace arguments independent of parent
+            new_constructor.parameters = existing_constructor.parameters.map(&:dup)
+            # new_constructor.add_tag(*existing_constructor.tags.map(&:dup))
+          end
+        end
+
+        def definition_name
+          statement.parameters.first.jump(:tstring_content, :ident).source
+        end
+
+        def options
+          raw_options = statement.parameters[2] || statement.parameters[1]
+          return {} unless raw_options
+          raw_options.map do |o|
+            [o.first.jump(:tstring_content, :ident).source, o[1]]
+          end.to_h
+        end
+
+        def reader?
+          return true unless options.key?('reader:')
+          options['reader:'].jump(:tstring_content, :ident).source != 'false'
+        end
+
+        def reader_name
+          if options.key?('as:')
+            options['as:'].jump(:tstring_content, :ident).source
+          else
+            definition_name
+          end
+        end
+
+        def reader_visibility
+          return :public unless options.key?('reader:')
+          options['reader:'].jump(:tstring_content, :ident).source.to_sym
+        end
+
+        def comment
+          return nil unless options.key?('comment:')
+          options['comment:'].jump(:tstring_content, :ident).source
+        end
+
+        def default_string
+          return options['default:'][1].source if options.key?('default:')
+          'nil' if options.key?('optional:') && options['optional:'].jump(:tstring_content, :ident).source == 'true'
+        end
+      end
+    end
+  end
+end

data/lib/yard/dry/initializer/option_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'yard/dry/initializer/common_handler'
+
+module YARD
+  module Dry
+    module Initializer
+      class OptionHandler < ::YARD::Handlers::Ruby::Base
+        include CommonHandler
+
+        handles method_call(:option)
+        namespace_only
+
+        def process
+          super
+
+          unless constructor.tags('param').find { |t| t.name == 'options' }
+            constructor.parameters << ['**options', nil]
+            constructor.add_tag(YARD::Tags::Tag.new(:param, nil, ['Hash'], 'options'))
+          end
+
+          existing_tag = constructor.tags('option').find { |t| t.pair.name == definition_name }
+          comment = self.comment || existing_tag&.pair&.text
+          default = default_string && [default_string] || existing_tag&.pair&.defaults
+          option = YARD::Tags::DefaultTag.new(:option, comment, nil, definition_name, default)
+          if existing_tag
+            existing_tag.pair = option
+          else
+            constructor.add_tag(YARD::Tags::OptionTag.new(:option, 'options', option))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/dry/initializer/param_handler.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'yard/dry/initializer/common_handler'
+
+module YARD
+  module Dry
+    module Initializer
+      class ParamHandler < ::YARD::Handlers::Ruby::Base
+        include CommonHandler
+
+        handles method_call(:param)
+        namespace_only
+
+        def process
+          super
+
+          add_constructor_param
+          add_constructor_tag
+        end
+
+        protected
+
+        def add_constructor_param
+          existing_index = constructor.parameters.index do |name, _default|
+            name == definition_name
+          end
+          if existing_index
+            constructor.parameters[existing_index] = [definition_name, default_string]
+          else
+            constructor.parameters.insert(last_param_index, [definition_name, default_string])
+          end
+        end
+
+        def last_param_index
+          return -1 if constructor.parameters.empty?
+          constructor.parameters.last.first.start_with?('**') ? -2 : -1
+        end
+
+        def add_constructor_tag
+          if existing_tag
+            existing_tag.text = comment
+            existing_tag.instance_variable_set(:@defaults, default_string && [default_string])
+          else
+            param = YARD::Tags::DefaultTag.new(:param, comment, nil, definition_name, [default_string])
+            constructor.add_tag(param)
+          end
+        end
+
+        def existing_tag
+          @existing_tag ||=
+            constructor.tags.find do |tag|
+              tag.name == definition_name && tag.tag_name == 'param'
+            end
+        end
+      end
+    end
+  end
+end

data/lib/yard/dry/initializer/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module YARD
+  module Dry
+    module Initializer
+      VERSION = '0.1.0'
+    end
+  end
+end

data/yard-dry-initializer.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/dry/initializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yard-dry-initializer'
+  spec.version       = YARD::Dry::Initializer::VERSION
+  spec.authors       = ['Andrey Novikov']
+  spec.email         = ['envek@envek.name']
+
+  spec.summary       = 'Generates documentation for your params and options'
+  spec.description   = <<~MSG
+    Generates for you all YARD declarations of attributes
+    and initializer parameters created by dry-initializer gem.
+  MSG
+  spec.homepage      = 'https://github.com/Envek/yard-dry-initializer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'yard', '>= 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: yard-dry-initializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Generates for you all YARD declarations of attributes
+  and initializer parameters created by dry-initializer gem.
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- generated_docs_example.png
+- lib/yard-dry-initializer.rb
+- lib/yard/dry/initializer.rb
+- lib/yard/dry/initializer/common_handler.rb
+- lib/yard/dry/initializer/option_handler.rb
+- lib/yard/dry/initializer/param_handler.rb
+- lib/yard/dry/initializer/version.rb
+- yard-dry-initializer.gemspec
+homepage: https://github.com/Envek/yard-dry-initializer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generates documentation for your params and options
+test_files: []