yard 0.9.27 → 0.9.29

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.27
+  version: 0.9.29
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
+date: 2023-04-08 00:00:00.000000000 Z
+dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
       It enables the user to generate consistent, usable documentation that can be
@@ -37,70 +23,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
-- ".gitattributes"
-- ".github/FUNDING.yml"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/ci.yml"
-- ".github/workflows/gem.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".yardopts"
-- ".yardopts_guide"
-- ".yardopts_i18n"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Dockerfile.samus
-- Gemfile
 - LEGAL
 - LICENSE
 - README.md
-- Rakefile
-- SECURITY.md
-- benchmarks/builtins_vs_eval.rb
-- benchmarks/concat_vs_join.rb
-- benchmarks/erb_vs_erubis.rb
-- benchmarks/format_args.rb
-- benchmarks/generation.rb
-- benchmarks/marshal_vs_dbm.rb
-- benchmarks/parsing.rb
-- benchmarks/pathname_vs_string.rb
-- benchmarks/rdoc_vs_yardoc.rb
-- benchmarks/registry_store_types.rb
-- benchmarks/ri_vs_yri.rb
-- benchmarks/ripper_parser.rb
-- benchmarks/splat_vs_flatten.rb
-- benchmarks/template_erb.rb
-- benchmarks/template_format.rb
-- benchmarks/template_profile.rb
-- benchmarks/yri_cache.rb
 - bin/yard
 - bin/yardoc
 - bin/yri
-- docs/CodeObjects.md
-- docs/GettingStarted.md
-- docs/Handlers.md
-- docs/Overview.md
-- docs/Parser.md
-- docs/Tags.md
-- docs/TagsArch.md
-- docs/Templates.md
-- docs/WhatsNew.md
-- docs/images/code-objects-class-diagram.png
-- docs/images/handlers-class-diagram.png
-- docs/images/overview-class-diagram.png
-- docs/images/parser-class-diagram.png
-- docs/images/tags-class-diagram.png
-- docs/templates/default/fulldoc/html/full_list_tag.erb
-- docs/templates/default/fulldoc/html/setup.rb
-- docs/templates/default/layout/html/setup.rb
-- docs/templates/default/layout/html/tag_list.erb
-- docs/templates/default/yard_tags/html/list.erb
-- docs/templates/default/yard_tags/html/setup.rb
-- docs/templates/plugin.rb
 - lib/rubygems_plugin.rb
 - lib/yard.rb
 - lib/yard/autoload.rb
@@ -259,6 +187,7 @@ files:
 - lib/yard/server/commands/static_file_helpers.rb
 - lib/yard/server/doc_server_helper.rb
 - lib/yard/server/doc_server_serializer.rb
+- lib/yard/server/http_utils.rb
 - lib/yard/server/library_version.rb
 - lib/yard/server/rack_adapter.rb
 - lib/yard/server/router.rb
@@ -310,138 +239,6 @@ files:
 - lib/yard/templates/template_options.rb
 - lib/yard/verifier.rb
 - lib/yard/version.rb
-- po/ja.po
-- samus.json
-- tasks/prepare_tag.rake
-- tasks/update_error_map.rake
-- templates/default/class/dot/setup.rb
-- templates/default/class/dot/superklass.erb
-- templates/default/class/html/constructor_details.erb
-- templates/default/class/html/setup.rb
-- templates/default/class/html/subclasses.erb
-- templates/default/class/setup.rb
-- templates/default/class/text/setup.rb
-- templates/default/class/text/subclasses.erb
-- templates/default/constant/text/header.erb
-- templates/default/constant/text/setup.rb
-- templates/default/docstring/html/abstract.erb
-- templates/default/docstring/html/deprecated.erb
-- templates/default/docstring/html/index.erb
-- templates/default/docstring/html/note.erb
-- templates/default/docstring/html/private.erb
-- templates/default/docstring/html/returns_void.erb
-- templates/default/docstring/html/text.erb
-- templates/default/docstring/html/todo.erb
-- templates/default/docstring/setup.rb
-- templates/default/docstring/text/abstract.erb
-- templates/default/docstring/text/deprecated.erb
-- templates/default/docstring/text/index.erb
-- templates/default/docstring/text/note.erb
-- templates/default/docstring/text/private.erb
-- templates/default/docstring/text/returns_void.erb
-- templates/default/docstring/text/text.erb
-- templates/default/docstring/text/todo.erb
-- templates/default/fulldoc/html/css/common.css
-- templates/default/fulldoc/html/css/full_list.css
-- templates/default/fulldoc/html/css/style.css
-- templates/default/fulldoc/html/frames.erb
-- templates/default/fulldoc/html/full_list.erb
-- templates/default/fulldoc/html/full_list_class.erb
-- templates/default/fulldoc/html/full_list_file.erb
-- templates/default/fulldoc/html/full_list_method.erb
-- templates/default/fulldoc/html/js/app.js
-- templates/default/fulldoc/html/js/full_list.js
-- templates/default/fulldoc/html/js/jquery.js
-- templates/default/fulldoc/html/setup.rb
-- templates/default/layout/dot/header.erb
-- templates/default/layout/dot/setup.rb
-- templates/default/layout/html/breadcrumb.erb
-- templates/default/layout/html/files.erb
-- templates/default/layout/html/footer.erb
-- templates/default/layout/html/headers.erb
-- templates/default/layout/html/index.erb
-- templates/default/layout/html/layout.erb
-- templates/default/layout/html/listing.erb
-- templates/default/layout/html/objects.erb
-- templates/default/layout/html/script_setup.erb
-- templates/default/layout/html/search.erb
-- templates/default/layout/html/setup.rb
-- templates/default/method/html/header.erb
-- templates/default/method/setup.rb
-- templates/default/method/text/header.erb
-- templates/default/method_details/html/header.erb
-- templates/default/method_details/html/method_signature.erb
-- templates/default/method_details/html/source.erb
-- templates/default/method_details/setup.rb
-- templates/default/method_details/text/header.erb
-- templates/default/method_details/text/method_signature.erb
-- templates/default/method_details/text/setup.rb
-- templates/default/module/dot/child.erb
-- templates/default/module/dot/dependencies.erb
-- templates/default/module/dot/header.erb
-- templates/default/module/dot/info.erb
-- templates/default/module/dot/setup.rb
-- templates/default/module/html/attribute_details.erb
-- templates/default/module/html/attribute_summary.erb
-- templates/default/module/html/box_info.erb
-- templates/default/module/html/children.erb
-- templates/default/module/html/constant_summary.erb
-- templates/default/module/html/defines.erb
-- templates/default/module/html/header.erb
-- templates/default/module/html/inherited_attributes.erb
-- templates/default/module/html/inherited_constants.erb
-- templates/default/module/html/inherited_methods.erb
-- templates/default/module/html/item_summary.erb
-- templates/default/module/html/method_details_list.erb
-- templates/default/module/html/method_summary.erb
-- templates/default/module/html/methodmissing.erb
-- templates/default/module/html/pre_docstring.erb
-- templates/default/module/setup.rb
-- templates/default/module/text/children.erb
-- templates/default/module/text/class_meths_list.erb
-- templates/default/module/text/extends.erb
-- templates/default/module/text/header.erb
-- templates/default/module/text/includes.erb
-- templates/default/module/text/instance_meths_list.erb
-- templates/default/module/text/setup.rb
-- templates/default/onefile/html/files.erb
-- templates/default/onefile/html/headers.erb
-- templates/default/onefile/html/layout.erb
-- templates/default/onefile/html/readme.erb
-- templates/default/onefile/html/setup.rb
-- templates/default/root/dot/child.erb
-- templates/default/root/dot/setup.rb
-- templates/default/root/html/setup.rb
-- templates/default/tags/html/example.erb
-- templates/default/tags/html/index.erb
-- templates/default/tags/html/option.erb
-- templates/default/tags/html/overload.erb
-- templates/default/tags/html/see.erb
-- templates/default/tags/html/tag.erb
-- templates/default/tags/setup.rb
-- templates/default/tags/text/example.erb
-- templates/default/tags/text/index.erb
-- templates/default/tags/text/option.erb
-- templates/default/tags/text/overload.erb
-- templates/default/tags/text/see.erb
-- templates/default/tags/text/tag.erb
-- templates/guide/class/html/setup.rb
-- templates/guide/docstring/html/setup.rb
-- templates/guide/fulldoc/html/css/style.css
-- templates/guide/fulldoc/html/js/app.js
-- templates/guide/fulldoc/html/setup.rb
-- templates/guide/layout/html/layout.erb
-- templates/guide/layout/html/setup.rb
-- templates/guide/method/html/header.erb
-- templates/guide/method/html/setup.rb
-- templates/guide/module/html/header.erb
-- templates/guide/module/html/method_list.erb
-- templates/guide/module/html/setup.rb
-- templates/guide/onefile/html/files.erb
-- templates/guide/onefile/html/setup.rb
-- templates/guide/onefile/html/toc.erb
-- templates/guide/tags/html/setup.rb
-- yard.gemspec
 homepage: http://yardoc.org
 licenses:
 - MIT
@@ -462,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.

data/.dockerignore

@@ -1,2 +0,0 @@
-doc
-.yardoc

data/.gitattributes

@@ -1,4 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text eol=lf
-
-*.png binary

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: lsegal

data/.github/ISSUE_TEMPLATE.md

@@ -1,33 +0,0 @@
-[Describe your issue here. Try to be as specific as possible so we can find
-the root cause more quickly!]
-
-## Steps to reproduce
-
-This is the minimal reproduction for the issue. I've done my best to remove
-all extraneous code and unique environment state on my machine before providing
-these steps:
-
-1. Run the following command: `yard doc --no-private`
-2. Open browser to (URL)...
-3. Click on Method List link.
-
-## Actual Output
-
-[Provide the full output (**please run yard with `--debug`**) or screenshots for
-visual issues.]
-
-## Expected Output
-
-[Describe what you *expected* to happen.]
-
-## Environment details:
-
-- OS: [Enter operating system / version here]
-- Ruby version (`ruby -v`): [Enter output of `ruby -v`]
-- YARD version (`yard -v`): [Enter output of `yard -v`]
-- Relevant software dependency/versions:
-  - [Any 3rd party libs required to reproduce, omit if none]
-
-I have read the [Contributing Guide][contrib].
-
-[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +0,0 @@
-# Description
-
-Describe your pull request and problem statement here.
-
-# Completed Tasks
-
-- [ ] I have read the [Contributing Guide][contrib].
-- [ ] The pull request is complete (implemented / written).
-- [ ] Git commits have been cleaned up (squash WIP / revert commits).
-- [ ] I wrote tests and ran `bundle exec rake` locally (if code is attached to PR).
-
-[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: Unit Tests
-
-on: [push, pull_request, workflow_dispatch]
-jobs:
-  build:
-    name: "Ruby: ${{ matrix.ruby }} OS: ${{ matrix.os }}"
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-20.04, macos-10.15, windows-2019]
-        # 3.0 is interpreted as 3
-        ruby: [2.2, 2.3, 2.4, 2.5, 2.6, 2.7, "3.0"]
-        exclude:
-          - { os: windows-2019 , ruby: 2.2 }
-          - { os: windows-2019 , ruby: 2.3 }
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install Ruby & 'bundle install'
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-      - name: Run Test
-        run: |
-          ruby -v
-          bundle exec rake
-        env:
-          CI: true

data/.github/workflows/gem.yml

@@ -1,19 +0,0 @@
-name: Release Version
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  release_version:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: lsegal/github-release-from-changelog-action@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish RubyGem
-        uses: dawidd6/action-publish-gem@v1
-        with:
-          api_key: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -1,14 +0,0 @@
-_Yardoc
-.DS_Store
-*.rbc
-*.pdf
-.yardoc
-*.gem
-Gemfile.lock
-/pkg
-/doc
-/doc_guide
-/coverage
-/.bundle
-/vendor
-spec/examples.txt

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,112 +0,0 @@
-#inherit_from:
-#  - .rubocop_todo.yml
-
-Metrics:
-  Enabled: false
-Layout/LineLength:
-  AutoCorrect: true
-  Max: 100
-Style/Semicolon:
-  AllowAsExpressionSeparator: true
-Style/Documentation:
-  Enabled: false
-Style/ClassVars:
-  Enabled: false
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-Layout/SpaceInsideBlockBraces:
-  SpaceBeforeBlockParameters: false
-Style/NumericPredicate: # ruby 1.8/1.9 do not have positive?/negative?
-  EnforcedStyle: comparison
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Layout/DotPosition:
-  EnforcedStyle: trailing
-Style/FormatString:
-  EnforcedStyle: percent
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-# Disable these until we know what to do with them
-Style/SafeNavigation:
-  Enabled: false # not supported in 1.8...2.1
-Style/GuardClause: # does not provide much value
-  Enabled: false
-Naming/VariableNumber:
-  Enabled: false
-Naming/AccessorMethodName: # this creates breaking changes in the API
-  Enabled: false
-Naming/PredicateName: # this creates breaking changes in the API
-  Enabled: false
-Style/MethodMissingSuper: # this doesn't exist in 1.8/1.9
-  Enabled: false
-Style/MissingRespondToMissing: # this doesn't exist in 1.8/1.9
-  Enabled: false
-Style/Lambda: # not supported in 1.8
-  Enabled: false
-Style/EachWithObject: # not supported in 1.8
-  Enabled: false
-Layout/ParameterAlignment: # does not work correctly with subsequent block
-  Enabled: false
-Layout/ArrayAlignment: # does not support indentation
-  Enabled: false
-Layout/HashAlignment: # does not support indentation
-  Enabled: false
-Style/MultilineTernaryOperator:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Layout/EmptyLineBetweenDefs:
-  AllowAdjacentOneLineDefs: true
-Style/SingleLineMethods:
-  Enabled: false
-Style/SingleLineBlockParams:
-  Enabled: false
-Style/NestedTernaryOperator:
-  Enabled: false
-Style/MutableConstant:
-  Enabled: false
-Style/WhenThen:
-  Enabled: false
-Style/StringLiterals:
-  Enabled: false
-Style/StringLiteralsInInterpolation:
-  Enabled: false
-Style/PerlBackrefs:
-  Enabled: false
-Style/BlockComments:
-  Exclude:
-    - benchmarks/*.rb
-Style/CaseEquality:
-  Enabled: false
-Style/WordArray:
-  Enabled: false
-Style/GlobalVars:
-  Exclude:
-    - benchmarks/**/*.rb
-    - spec/**/*.rb
-Lint/RedundantSplatExpansion:
-  Enabled: false
-Security/Eval:
-  Exclude:
-    - benchmarks/**/*.rb
-    - spec/**/*.rb
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: false
-Lint/RaiseException:
-  Enabled: false
-Lint/StructNewOverride:
-  Enabled: false
-Style/ExponentialNotation:
-  Enabled: false
-Style/HashEachMethods:
-  Enabled: false
-Style/HashTransformKeys:
-  Enabled: false
-Style/HashTransformValues:
-  Enabled: false

data/.yardopts

@@ -1,26 +0,0 @@
---protected
---no-private
---embed-mixin ClassMethods
---exclude /server/templates/
---exclude /yard/rubygems/
---asset docs/images:images
---tag yard.signature:"YARD Tag Signature"
---type-name-tag yard.tag:"YARD Tag"
---type-name-tag yard.directive:"YARD Directive"
---hide-tag yard.tag
---hide-tag yard.directive
---hide-tag yard.signature
---load ./docs/templates/plugin.rb
--
-CHANGELOG.md
-docs/WhatsNew.md
-docs/GettingStarted.md
-docs/Tags.md
-docs/Overview.md
-docs/CodeObjects.md
-docs/Parser.md
-docs/Handlers.md
-docs/TagsArch.md
-docs/Templates.md
-LICENSE
-LEGAL

data/.yardopts_guide

@@ -1,19 +0,0 @@
--t guide
---title YARD
--o doc_guide
---exclude /server/templates/
---exclude /yard/rubygems/
---asset docs/images:images
--
-CHANGELOG.md
-docs/WhatsNew.md
-docs/GettingStarted.md
-docs/Tags.md
-docs/Overview.md
-docs/CodeObjects.md
-docs/Parser.md
-docs/Handlers.md
-docs/TagsArch.md
-docs/Templates.md
-LICENSE
-LEGAL

data/.yardopts_i18n

@@ -1,23 +0,0 @@
---protected
---no-private
---exclude /server/templates/
---exclude /yard/rubygems/
---asset docs/images:images
---tag yard.signature:"YARD Tag Signature"
---type-name-tag yard.tag:"YARD Tag"
---type-name-tag yard.directive:"YARD Directive"
---hide-tag yard.tag
---hide-tag yard.directive
---hide-tag yard.signature
---load ./docs/templates/plugin.rb
--
-CHANGELOG.md
-docs/WhatsNew.md
-docs/GettingStarted.md
-docs/Tags.md
-docs/Overview.md
-docs/CodeObjects.md
-docs/Parser.md
-docs/Handlers.md
-docs/TagsArch.md
-docs/Templates.md