yard 0.9.23 → 0.9.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484d7d1eba166d665522d156cf729726c9398f422785cb6151291e91489408fe
-  data.tar.gz: 96bdb186472b35313799c19852f9ff1dbb00a294f1748eb310555a2a0e074cb6
+  metadata.gz: d0e3a62dcbb66515f56fe9a2cb919aa97881dced6e7cf052a7ce0201ff9222cf
+  data.tar.gz: 06714cb7f3e754d10fb2e784c0a0d49a5fee20aaee75778565daea8b61c453c1
 SHA512:
-  metadata.gz: 4e1b559f847bda1e1554f000be7734797511abedb1b1dec1cb94d7392cce11d66397f39d25257de07a8681eb92ce2e9256df47c57e15d9a68a835c7c6154b91b
-  data.tar.gz: e7e0bdccc9f896f459bed1dbeb3ea37d1b373c9a0c9a05a624d84ecfeba1b7fbceda87ba6576df96b13649f1969733316ce499c234003c101ef7a93ca914b153
+  metadata.gz: 4a993609ba381fdc0419ac8332605b10a3995ff818626c20e64095f4f845e28297d38a81c890aa95a187ca8fd7d8e7d9f291d7251ac96ba1bee7a5a249f2db3d
+  data.tar.gz: f71cc60bc0fbe36419f8f142e07bbee5fd19b9e539099256bb644f1f61f57e9fa61c96ff95e879d584bdb48b3f988d5e945277acbc6e0f083cf1a6c8584c45df

data/.gitattributes

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

data/.github/FUNDING.yml

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

data/.github/ISSUE_TEMPLATE.md

@@ -22,12 +22,12 @@ visual issues.]
 
 ## 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]
+- 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
+[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -4,9 +4,9 @@ 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).
+- [ ] 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
+[contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md

data/.github/workflows/ci.yml

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

@@ -0,0 +1,19 @@
+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/.rubocop.yml

@@ -1,13 +1,11 @@
 #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
+Layout/LineLength:
+  AutoCorrect: true
+  Max: 100
 Style/Semicolon:
   AllowAsExpressionSeparator: true
 Style/Documentation:
@@ -16,23 +14,21 @@ Style/ClassVars:
   Enabled: false
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   SpaceBeforeBlockParameters: false
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
 Style/NumericPredicate: # ruby 1.8/1.9 do not have positive?/negative?
   EnforcedStyle: comparison
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: trailing
 Style/FormatString:
   EnforcedStyle: percent
-Style/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
-Style/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 # Disable these until we know what to do with them
@@ -40,29 +36,31 @@ Style/SafeNavigation:
   Enabled: false # not supported in 1.8...2.1
 Style/GuardClause: # does not provide much value
   Enabled: false
-Style/VariableNumber:
+Naming/VariableNumber:
+  Enabled: false
+Naming/AccessorMethodName: # this creates breaking changes in the API
   Enabled: false
-Style/AccessorMethodName: # this creates breaking changes in the API
+Naming/PredicateName: # this creates breaking changes in the API
   Enabled: false
-Style/PredicateName: # this creates breaking changes in the API
+Style/MethodMissingSuper: # this doesn't exist in 1.8/1.9
   Enabled: false
-Style/MethodMissing: # this doesn't exist in 1.8/1.9
+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
-Style/AlignParameters: # does not work correctly with subsequent block
+Layout/ParameterAlignment: # does not work correctly with subsequent block
   Enabled: false
-Style/AlignArray: # does not support indentation
+Layout/ArrayAlignment: # does not support indentation
   Enabled: false
-Style/AlignHash: # does not support indentation
+Layout/HashAlignment: # does not support indentation
   Enabled: false
 Style/MultilineTernaryOperator:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
-Style/EmptyLineBetweenDefs:
+Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 Style/SingleLineMethods:
   Enabled: false
@@ -91,9 +89,24 @@ Style/GlobalVars:
   Exclude:
     - benchmarks/**/*.rb
     - spec/**/*.rb
-Lint/UnneededSplatExpansion:
+Lint/RedundantSplatExpansion:
   Enabled: false
-Lint/Eval:
+Security/Eval:
   Exclude:
     - benchmarks/**/*.rb
-- spec/**/*.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/CHANGELOG.md

@@ -1,4 +1,50 @@
-# master
+# main
+
+# 0.9.27 - November 29th, 2021
+
+[0.9.27]: https://github.com/lsegal/yard/compare/v0.9.26...v0.9.27
+
+- Add support for Ruby 3.0 endless method definitions. (#1376, #1381)
+- Add existence check for README file (#1367)
+- Support module_function decorator (#1365)
+- Add CommonMarker markup support (`-m commonmarker`) (#1157, #1388)
+- Fix nested array parsing (#1389)
+- Add WEBrick as a runtime dependency for Ruby 3.0 support (#1400)
+- Support `fail_on_warning` option in `yard stats` command (#1392)
+- Better integration with Sorbet (#1401)
+- Handle include mixins on complex paths (#1386)
+- Fix `@!scope` maintaining state in lone comment blocks (#1411)
+- Remove support for Travis CI
+
+# 0.9.26 - December 26th, 2020
+
+[0.9.26]: https://github.com/lsegal/yard/compare/v0.9.25...v0.9.26
+
+- Add support for Ruby 3.0 and fix tests
+- Fix support for `frozen_string_literal: false` magic comments (#1363)
+
+# 0.9.25 - May 3rd, 2020
+
+[0.9.25]: https://github.com/lsegal/yard/compare/v0.9.24...v0.9.25
+
+- Fix parsing issue with conditional blocks mixed with conditional modifiers.
+  (#1308, #1324, #1326, #1327)
+- Add table of contents IDs to redcarpet generated markdown. (#1323)
+- Backport fixes for Ruby 1.9 (#1320)
+- Fix parsing of checksums in yard server (#1301)
+- Map Ruby C variable error names to Ruby classes (#1270, #1275)
+- Fix initialization of RDocMarkup across threads (#1318)
+- Remove warning for Kernel#open (#1312)
+- Omit spec files in gem package (#1307)
+- README updates (#1322)
+
+# 0.9.24 - January 8th, 2020
+
+[0.9.24]: https://github.com/lsegal/yard/compare/v0.9.23...v0.9.24
+
+- Add {YARD::CodeObjects::NamespaceMapper.on_invalidate} callback when separator
+  cache is changed.
+- Fix issue where Registry fails to resolve first-time lookups on instance methods.
 
 # 0.9.23 - January 5th, 2020
 
@@ -35,9 +81,9 @@
 
 - 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.
+  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
 

data/CONTRIBUTING.md

@@ -42,7 +42,7 @@ If you believe you have found a bug, please include a few things in your report:
    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
+_"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
@@ -132,7 +132,7 @@ 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
+[code]: https://github.com/lsegal/yard/blob/main/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/

data/Gemfile

@@ -7,8 +7,9 @@ group :development do
   gem 'rdoc'
   gem 'json'
   gem 'simplecov'
-  gem 'samus', '~> 3.0.8', :require => false
+  gem 'samus', '~> 3.0.9', :require => false
   gem 'coveralls', :require => false
+  gem 'webrick'
 end
 
 group :asciidoc do
@@ -16,11 +17,12 @@ group :asciidoc do
 end
 
 group :markdown do
-  gem 'redcarpet', :platforms => [:ruby]
+  gem 'redcarpet'
+  gem 'commonmarker'
 end
 
 group :textile do
-  gem 'RedCloth', :platforms => [:ruby]
+  gem 'RedCloth'
 end
 
 group :server do