yard 0.9.16 → 0.9.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 60bd85d004be2eaeed43646cc7211142cea13298
-  data.tar.gz: aa523a2062c7d8929699dc08466fec4d76183628
+SHA256:
+  metadata.gz: 3ce18eac2e64c2f48f33278cf01032c7e36b2ec78cf15eed67a90b126a675ca1
+  data.tar.gz: e4eb11a4995a2a14207acb50421b16b0d5b760c71141135bf519c402ae182c3c
 SHA512:
-  metadata.gz: 9dfcc5ebef57766151261684c04838f2fa59f5711033dd71d0f163aefee347df3ae6af07f3c0f749f9baa09a880859373576a1b6c328cbd7b9143cf8c366b1ba
-  data.tar.gz: fb836be48722eba0098e3dabad576cd64eb061aaa74477a1051bdb9ba85711092f649246f96871802ed679bd10a09e0a5cd3119e72b96da5291794b753ea7fde
+  metadata.gz: f795f923bea85e6de27fa5ddedd7b097c63811e274f90192cca65e0d3c748e1ebf4273fd202857dfd28047445e8a1edd30d270064016cb2d668e7f5e9d5d1eee
+  data.tar.gz: 1aa66474fd6f00a5d94e85272b223867763378593d093cfed1da7eaaef15954845c1728548e4bc4f868ce4f8f4c7a598be9e8f44fb73954c1577e607414de7fd

data/.dockerignore

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

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+[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/master/CONTRIBUTING.md

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+# 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/master/CONTRIBUTING.md

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,99 @@
+#inherit_from:
+#  - .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/**/*' # need to reset this apparently
+    - 'lib/yard/parser/ruby/legacy/ruby_lex.rb' # old file, don't touch
+Metrics:
+  Enabled: false
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+Style/Documentation:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/NumericPredicate: # ruby 1.8/1.9 do not have positive?/negative?
+  EnforcedStyle: comparison
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/DotPosition:
+  EnforcedStyle: trailing
+Style/FormatString:
+  EnforcedStyle: percent
+Style/IndentArray:
+  EnforcedStyle: consistent
+Style/IndentHash:
+  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
+Style/VariableNumber:
+  Enabled: false
+Style/AccessorMethodName: # this creates breaking changes in the API
+  Enabled: false
+Style/PredicateName: # this creates breaking changes in the API
+  Enabled: false
+Style/MethodMissing: # 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
+Style/AlignParameters: # does not work correctly with subsequent block
+  Enabled: false
+Style/AlignArray: # does not support indentation
+  Enabled: false
+Style/AlignHash: # does not support indentation
+  Enabled: false
+Style/MultilineTernaryOperator:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/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/UnneededSplatExpansion:
+  Enabled: false
+Lint/Eval:
+  Exclude:
+    - benchmarks/**/*.rb
+- spec/**/*.rb

data/.travis.yml

@@ -0,0 +1,52 @@
+# Enables Travis to use their new container-based infrastructure
+sudo: false
+
+# Build for Ruby
+language: ruby
+
+# Enables caching for bundler
+cache: bundler
+
+# Specify which ruby versions you wish to run your tests on, each version will be used
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.3"
+  - "2.4"
+  - "2.5"
+  - "2.6"
+  - "2.7"
+  # - ruby-head
+  # - jruby
+
+# Define how to run your tests (defaults to `bundle exec rake` or `rake` depending on whether you have a `Gemfile`)
+script: "bundle exec rake"
+
+# Define tasks to be completed before and after tests run . Will allow folding of content on frontend
+#before_script:
+#  - command_1
+#  - command_2
+#
+#after_script:
+#  - command_1
+#  - command_2
+
+# Specify an ENV variable to run before: 'bundle install' and 'rake' (or your defined 'script')
+env:
+  - CI=1
+
+# Specify the recipients for email notification
+#notifications:
+#  recipients:
+#    - email-address-1
+#    - email-address-2
+
+# Disable email notifications
+#notifications:
+#  disabled: true
+
+# notifications:
+#   webhooks:
+#     urls:
+#       - https://webhooks.gitter.im/e/c6dbb9323007dfcf81df

data/.yardopts_guide

@@ -0,0 +1,19 @@
+-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

@@ -0,0 +1,23 @@
+--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

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # master
 
+# 0.9.21 - December 31st, 2019
+
+[0.9.21]: https://github.com/lsegal/yard/compare/v0.9.20...v0.9.21
+
+- Updates to add support for Ruby 2.7.0 (#1290, #1296)
+- Fix parsing of multiline method signatures (#1220)
+- Remove RubyGems post install message (#1269)
+- Improve object deletion from RegistryStore (#1284)
+- Improve memory usage performance (#1260)
+- Handle include and extend calls with explicit receivers (#1274)
+- Fix deep nesting of TOC items (#1288)
+- Fix highlighting for Asciidoc markup code blocks (#1276)
+- Fix HTML formatting of script tags (#1263)
+- Update jquery to 3.4.1 (#1294)
+- Test fixes (#1244)
+
+# 0.9.20 - June 27th, 2019
+
+[0.9.20]: https://github.com/lsegal/yard/compare/v0.9.19...v0.9.20
+
+- Fix parsing of stringified Symbols in Ruby source (#1256).
+- Fix path traversal vulnerability in `yard server`. This bug would allow
+ unsanitized HTTP requests to access arbitrary files on the machine of a
+ `yard server` host under certain conditions. Thanks to CuongMX from
+ Viettel Cyber Security for discovering this vulnerability.
+
+# 0.9.19 - April 2nd, 2019
+
+[0.9.19]: https://github.com/lsegal/yard/compare/v0.9.16...v0.9.19
+
+- Fixed bug in browser back button (#1071, #1228)
+- Fixed handling of ArgumentError in ExtraFileObject (#1198)
+- Fixed double return tag displaying on boolean methods (#1226)
+- Removed unused `Module#namespace_name` function (#1229)
+- Fixed parsing order of README files. YARD will now prefer README over
+  README.md over README.x.md or README-x.md (and the like). READMEs will now
+  also be ordered by filename; the first README is still chosen unless
+  `--readme` is provided.
+- Updated AsciiDoc markup support to use non-deprecated calls.
+
 # [0.9.16] - August 11th, 2018
 
 [0.9.16]: https://github.com/lsegal/yard/compare/v0.9.15...v0.9.16
@@ -193,7 +233,7 @@ contributions to this version.
   to `default/fulldoc/html`, specifically the index or navigation lists.
 - Added support for Ruby 2.1+ decorator style method declaration syntax. YARD now
   supports:
-    private def foo(x, y) end
+  private def foo(x, y) end
 - Metadata headers in extra files can now be escaped from rendering by enclosing them
   in HTML comment blocks (`<!--\n @metadata here... \n-->`). Ensure that the opening
   comment tag is alone on the first line of the file to use this functionality.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+This document provides community guidelines for a safe, respectful, productive,
+and collaborative place for any person who is willing to contribute to the YARD
+project. It applies to all “collaborative space”, which is defined as community
+communications channels (such as mailing lists, submitted patches, commit
+comments, etc.).
+
+* Participants will be tolerant of opposing views.
+
+* Participants must ensure that their language and actions are free of personal
+  attacks and disparaging personal remarks.
+
+* When interpreting the words and actions of others, participants should always
+  assume good intentions.
+
+* Behaviour which can be reasonably considered harassment will not be tolerated.

data/CONTRIBUTING.md

@@ -0,0 +1,140 @@
+# Contributing Guide
+
+## Help YARD Help You!
+
+**YARD thrives off of the contributions of its users**. This project will gladly
+review pull requests and issues. This document outlines how to maximize
+the chance of a reported issue being resolved or pull request being accepted.
+
+## Code of Conduct
+
+**All reported issues, pull requests, communication, and code related to YARD**
+**must follow the [Code of Conduct][code] or they will be moderated immediately**.
+Please take time to familiarize yourself with the Code of Conduct before
+you get started. Fundamentally, **you are expected to behave with respect** to all
+other users.
+
+## Filing a Bug Report
+
+**You can submit bug reports on our [GitHub issue tracker][issues]**.
+
+If you believe you have found a bug, please include a few things in your report:
+
+1. **A minimal reproduction of the issue**. Providing a huge blob of code is
+   better than nothing, but providing the shortest possible set of instructions
+   is even better. Take out any instructions or code that, when removed, have
+   no effect on the problematic behavior. The easier your bug is to triage and
+   diagnose, the higher up in the priority list it will go. We can do this stuff,
+   but limited time means this may not happen immediately. Make your bug report
+   extremely accessible and you will almost guarantee a quick fix.
+
+2. **Your environment and relevant versions**. Please include your Ruby,
+   YARD, and system versions (including OS) when reporting a bug. This
+   makes it easier to diagnose problems. If the issue or stack trace
+   includes another library, consider also listing any dependencies
+   that may be affecting the issue. This is where a minimal reproduction
+   case helps a lot.
+
+3. **Your expected result**. Tell us what you think should happen. This
+   helps us to understand the context of your problem. Many complex features
+   can contain ambiguous usage, and your use case may differ from the
+   intended one. If we know your expectations, we can more easily determine
+   if the behavior is intentional or not.
+
+Finally, please **DO NOT** submit a report that states a feature simply
+*"does not work"* without any additional information in the report. Consider
+the issue from the maintainer's perspective: in order to fix your bug, we
+need to drill down to the broken line of code, and in order to do this,
+we must be able to reproduce the issue on our end to find that line of
+code. The easier we can do this, the quicker your bug gets fixed. Help
+us help you by providing as much information as you possibly can. We may
+not have the tools or environment to properly diagnose your issue, so
+your help may be required to debug the issue.
+
+Also **consider opening a pull request** to fix the issue yourself if you can.
+This will likely speed up the fix time significantly. See below for
+information on how to do this.
+
+## Asking a Question
+
+**Questions are accepted on [GitHub issues][issues], but consider signing up**
+**for the [YARD mailing list][ml]** and asking it there so that we can organize
+issues appropriately. You can also hop onto IRC (irc.freenode.net / #yard)
+for quick questions.
+
+## Asking for a Feature
+
+**YARD does not currently accept feature requests filed as GitHub issues**. If
+you are looking to have a feature implemented into YARD, consider doing this
+yourself and [submitting a pull request][pr] (PR) with your work. If the work
+required is involved, consider starting a discussion on the [mailing list][ml]
+or opening an issue to ask a question; we will be happy to have a conversation
+and let you know if the feature would be considered. They usually are, but
+it might be prudent to ask first!
+
+Please do not fret if your feature request gets closed immediately. We do this
+to keep our issue tracker clean. **Closing an issue does not mean it would not**
+**be accepted as a pull request**. If the feature would not be accepted as a
+PR, this will be communicated in the closed issue.
+
+## Making a Change via Pull Request
+
+**You can also submit pull requests on our [GitHub issue tracker][issues]**.
+
+If you've been working on a patch or feature that you want in YARD, here are
+some tips to ensure the quickest turnaround time on getting it merged in:
+
+1. **Keep your changes small**. If your feature is large, consider splitting
+   it up into smaller portions and submit pull requests for each component
+   individually. Feel free to describe this in your first PR or on the
+   mailing list, but note that it will be much easier to review changes
+   if they affect smaller portions of code at a time.
+
+2. **Keep commits brief and clean**: YARD uses Git and tries to maintain a
+   clean repository. Please ensure that you use [commit conventions][commit]
+   to make things nice and neat both in the description and commit history.
+   Specifically, consider squashing commits if you have partial or complete
+   reverts of code. Each commit should provide an atomic change that moves
+   the project forwards, not back. Any changes that only fix other parts of
+   your PR should be hidden from the commit history.
+
+3. **Follow our coding conventions**. YARD uses typical Ruby source formatting,
+   though it occasionally has minor differences with other projects you may
+   have seen. Please look through a few files (at least the file you are
+   editing) to ensure that you are consistent in the formatting your PR is
+   using.
+
+4. **Make sure you have tests**. Not all changes require tests, but if your
+   changes involve code, you should consider adding at least one new test
+   case for your change (and ideally a couple of tests). This will add
+   confidence when reviewing and will make accepting the change much easier.
+
+5. **Make sure ALL the tests pass**. YARD has a fairly large suite of tests.
+   Please make sure you can run all of the tests (`bundle exec rake`) prior
+   to submitting your PR. Please also remember that YARD supports a number
+   of environments, including OS X, Linux, Windows, and a number of older
+   Ruby versions (1.8+), so if you can test under these environments, that
+   helps (but is not required). At the very least, be aware of this fact
+   when submitting code.
+
+If your change is large, consider starting a discussion on the [mailing list][ml]
+or opening an issue to ask a question; we will be happy to have a conversation
+and let you know if the feature would be considered. They usually are, but
+it might be prudent to ask first!
+
+## Maintainers
+
+**Interested in helping to maintain YARD? Email [lsegal@soen.ca][mail]** for more
+information. Offering to be a project maintainer is an important contribution
+to open source software, and your work will be highly valued in the community.
+If you have been a contributor, consider being a member of the core team to
+help handle day-to-day operations, such as releases, bug fixes, and triage.
+You can do some of this as a non-maintainer too, but if you like this project,
+we can always use more hands on deck!
+
+[code]: https://github.com/lsegal/yard/blob/master/CODE_OF_CONDUCT.md
+[issues]: http://github.com/lsegal/yard/issues
+[commit]: http://chris.beams.io/posts/git-commit/
+[pr]: https://help.github.com/articles/using-pull-requests/
+[ml]: https://groups.google.com/forum/#!forum/yardoc
+[mail]: mailto:lsegal@soen.ca