yard-sig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f35a0b2f65d1d710a4e41c9d8a40c2f0d70fc00d05e2dc6562c34342d53fb66d
+  data.tar.gz: 688ec18293586b50e61dbb2bfb2a9a9f99c00bbc0f31786861a99f31dbb687ea
+SHA512:
+  metadata.gz: 30c4739f18458e18084c42ed9836a33923ed389939db04caeebd73f2ca7f39fa9f9fdb3206800f544eb0828547d08a550766f79e753f2cb61856218abd10c04b
+  data.tar.gz: 19fc367e95f0447f3e387580d4f8ce62f16771d2f4b1e8ced043bda3e7ea1c65e19d1fee462e593500a91c69b4868ce8441acdd41dbeabf528966e185fca87f5

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Exclude:
+    - "lib/yard-sig.rb"
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"

data/.yardopts

@@ -0,0 +1 @@
+--plugin sig

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-06-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sinsoku.listy@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Takumi Shotoku
+
+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,46 @@
+# yard-sig
+
+A YARD plugin for writing documentations with [RBS syntax](https://github.com/ruby/rbs).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add yard-sig
+
+Then specify it as an argument when running YARD.
+
+    $ bundle exec yard doc --plugin sig
+
+## Usage
+
+This plugin provides a `@!sig` directive to define types as follows.
+
+```ruby
+class Foo
+  # @!sig (Integer, Integer) -> Integer
+  def sum(a, b)
+    a + b
+  end
+end
+```
+
+Using this directive will cause it to be replaced internally by `@param` and `@return` tags when YARD runs.
+
+## 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 the created tag, 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/sinsoku/yard-sig. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sinsoku/yard-sig/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Yard::Sig project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/yard-sig/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/yard-sig/sig.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module YardSig
+  class Sig
+    TAG_ORDER = %w[param yieldparam yieldreturn return].freeze
+
+    # @!sig (String source, ?Array[Array[String]] parameters, ?String namespace) -> self
+    def initialize(source, parameters = [], namespace = "")
+      @source = source
+      @parameters = parameters
+      @namespace = namespace
+    end
+
+    # @!sig () -> Array[YARD::Tags::Tag]
+    def to_tags
+      tags = rbs_type_to_tags(rbs_method_type.type)
+      tags += rbs_type_to_tags(rbs_method_type.block.type, within_block: true) if rbs_method_type.block
+
+      tags.compact.sort_by { |tag| TAG_ORDER.index(tag.tag_name) }
+    end
+
+    private
+
+    def rbs_method_type
+      @rbs_method_type ||= RBS::Parser.parse_method_type(@source)
+    end
+
+    def rbs_type_to_tags(rbs_type, within_block: false)
+      positionals = rbs_type.required_positionals + rbs_type.optional_positionals
+
+      tags = positionals.map.with_index do |param, i|
+        build_param_tag(param, :positionals, pos: i, within_block: within_block)
+      end
+      tags << build_param_tag(rbs_type.rest_positionals, :rest, within_block: within_block)
+      tags << build_param_tag(rbs_type.rest_keywords, :keyrest, within_block: within_block)
+      tags << build_return_tag(rbs_type.return_type, within_block: within_block)
+
+      tags.compact
+    end
+
+    def build_param_tag(type, kind, pos: nil, within_block: false) # rubocop:disable Metrics/MethodLength
+      return unless type
+
+      yard_types = to_yard_type(type.type)
+      return unless yard_types
+
+      tag_name = within_block ? :yieldparam : :param
+      name = type.name ? type.name.to_s : find_name_from_yard(kind, pos)
+
+      if kind == :rest
+        yard_types = "Array<#{yard_types}>"
+      elsif kind == :keyrest
+        yard_types = "Hash<Symbol, #{yard_types}>"
+      end
+
+      YARD::Tags::Tag.new(tag_name, "", yard_types, name)
+    end
+
+    def build_return_tag(type, within_block: false)
+      return unless type
+
+      yard_types = to_yard_type(type)
+      return unless yard_types
+
+      tag_name = within_block ? :yieldreturn : :return
+      YARD::Tags::Tag.new(tag_name, "", yard_types)
+    end
+
+    def to_yard_type(type) # rubocop:disable Metrics
+      case type
+      when RBS::Types::Bases::Void, RBS::Types::Bases::Any, RBS::Types::Bases::Bottom
+        nil
+      when RBS::Types::Bases::Top
+        "Object"
+      when RBS::Types::Union
+        type.types.map { |t| to_yard_type(t) }.join(", ")
+      when RBS::Types::Tuple
+        args = type.types.map { |t| to_yard_type(t) }.join(", ")
+        "Array[#{args}]"
+      when RBS::Types::Bases::Bool
+        "Boolean"
+      when RBS::Types::Bases::Instance
+        @namespace.to_s
+      when RBS::Types::ClassInstance
+        args = type.args.map { |t| to_yard_type(t) }.join(", ")
+        args.empty? ? type.to_s : "#{type.name}<#{args}>"
+      else
+        type.to_s
+      end
+    end
+
+    def find_name_from_yard(kind, pos) # rubocop:disable Metrics
+      @param_names ||= {}.tap do |h|
+        names = @parameters.map(&:first)
+
+        h[:rest] = names.find { |s| s.start_with?(/\*\w/) }&.then { |name| name.delete_prefix("*") }
+        h[:keyrest] = names.find { |s| s.start_with?(/\*\*\w/) }&.then { |name| name.delete_prefix("**") }
+        h[:block] = names.find { |s| s.start_with?("&") }&.then { |name| name.delete_prefix("&") }
+        h[:keywords] = names.select { |s| s.end_with?(":") }.map { |name| name.delete_suffix(":") }
+        h[:positionals] = names.grep(/\w/)
+      end
+      kind == :positionals ? @param_names.dig(kind, pos) : @param_names[kind]
+    end
+  end
+end

data/lib/yard-sig/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module YardSig
+  VERSION = "0.1.0"
+end

data/lib/yard-sig.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rbs"
+require "yard"
+
+require_relative "yard-sig/version"
+require_relative "yard-sig/sig"
+
+module YardSig
+  class Error < StandardError; end
+
+  class SigDirective < ::YARD::Tags::Directive
+    # @!sig () -> void
+    def call
+      validate_arguments_forwarding!
+
+      sig = Sig.new(tag.text, object.parameters, object.namespace.path)
+      parser.tags += sig.to_tags
+    rescue Error => e
+      log.warn(e.message)
+    end
+
+    private
+
+    def validate_arguments_forwarding!
+      return unless object.signature.include?("(...)")
+
+      raise Error, "arguments forwarding is not supported."
+    end
+  end
+end
+
+YARD::Tags::Library.define_directive :sig, YardSig::SigDirective

data/sig/yard/sig.rbs

@@ -0,0 +1,6 @@
+module Yard
+  module Sig
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: yard-sig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takumi Shotoku
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+description: It provides a way to define types with `@!sig` directive instead of other
+  tags.
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yard-sig.rb
+- lib/yard-sig/sig.rb
+- lib/yard-sig/version.rb
+- sig/yard/sig.rbs
+homepage: https://github.com/sinsoku/yard-sig
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sinsoku/yard-sig
+  source_code_uri: https://github.com/sinsoku/yard-sig/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/sinsoku/yard-sig/tree/v0.1.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: A YARD plugin for writing documentations with RBS syntax
+test_files: []