yard-solargraph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9d1e63061dcae191ddffb63bc9cd123b8e09942de0148e20f07a7b8b9d3182a
+  data.tar.gz: dae371b094921e14a8c1a0f2cf4d213130308af4dc750bbe510e79f28da1d87f
+SHA512:
+  metadata.gz: 0f276a1be7a2cb0aac13c590d5cbfc5dd763c7cbd3e67ba0ef4d38ee5f78c051d8db5f88add9a10c5f70ed13974aee6672357c042c2d6d7c4778bd22f01066c9
+  data.tar.gz: 4d813c22ce648e82869eb32715487b8fed9a1d099eca81aab3a19762b0675558f5e6d581c192136a2863d780d40529b883db05de9e4dda2aae6579f7e7ea7a5c

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.1.0 - February 26, 2025
+- First release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 by Fred Snyder for Castwide Technologies
+
+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,84 @@
+# yard-solargraph
+
+A YARD extension for documenting Solargraph tags.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add yard-solargraph
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install yard-solargraph
+```
+
+## Usage
+
+To include the plugin when you generate yardocs from the command line:
+
+    yardoc --plugin yard-solargraph
+
+To ensure that the plugin gets included when generating yardocs for gems:
+
+1. Add yard-solargraph to your gemspec
+2. Create a `.yardopts` file in your gem's root directory with the `plugin` option:
+   ```
+   --plugin yard-solargraph
+   ```
+
+## Additional Tags
+
+The plugin adds two tags to your YARD documentation: `@generic` and `@yieldreceiver`.
+
+### @generic
+
+Use the `@generic` tag to reference parametrized types.
+
+```ruby
+# @generic T
+class Example
+  # @param [generic<T>]
+  def initialize value
+    @value = value
+  end
+
+  # @return [generic<T>]
+  attr_reader :value
+end
+
+# @return [Example<String>]
+def string_example
+  Example.new('test')
+end
+
+string_example.value # => Solargraph will infer that #value returns a String
+```
+
+### @yieldreceiver
+
+Use the `@yieldreceiver` tag to document the type of receiver that a method will use to evaluate a block.
+
+```ruby
+# @yieldreceiver [Array]
+def eval_in_array &block
+  [].instance_eval &block
+end
+
+eval_in_array do
+  length # => Solargraph will infer that this is an Array#length call
+end
+```
+
+## 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/[USERNAME]/yard-solargraph.

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/lib/yard/solargraph/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YARD
+  module Solargraph
+    VERSION = "0.1.0"
+  end
+end

data/lib/yard/solargraph.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'yard'
+require_relative "solargraph/version"
+
+module YARD
+  module Solargraph
+    # Define a @yieldreceiver tag for documenting the receiver of a block
+    #
+    # @example
+    #   # @yieldreceiver [Array] An array will evaluate the block
+    #   def add5_block(&block) [].instance_eval(&block) end
+    #
+    YARD::Tags::Library.define_tag('Yield Receiver', :yieldreceiver, :with_types)
+
+    # Define a @generic tag for documenting generic classes
+    #
+    # @example
+    #   # @generic T
+    #   class Example
+    #     # @return [generic<T>]
+    #     attr_reader :value
+    #   end
+    #
+    #   # @return [Example<String>]
+    #   def string_example; end
+    #
+    #   string_example.value # => String
+    #
+    YARD::Tags::Library.define_tag('Generics', :generic, :with_types_and_name)
+
+    YARD::Tags::Library.visible_tags.push :yieldreceiver, :generic
+  end
+end

data/lib/yard-solargraph.rb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: yard-solargraph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-26 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description:
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/yard-solargraph.rb
+- lib/yard/solargraph.rb
+- lib/yard/solargraph/version.rb
+homepage: https://solargraph.org
+licenses: []
+metadata:
+  homepage_uri: https://solargraph.org
+  source_code_uri: https://github.com/castwide/yard-solargraph
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A YARD extension for documenting Solargraph tags.
+test_files: []