yard 0.9.26 → 0.9.37

data/templates/default/fulldoc/html/js/full_list.js

@@ -62,8 +62,25 @@ function enableToggles() {
     evt.stopPropagation();
     evt.preventDefault();
     $(this).parent().parent().toggleClass('collapsed');
+    $(this).attr('aria-expanded', function (i, attr) {
+        return attr == 'true' ? 'false' : 'true'
+    });
     highlight();
   });
+
+  // navigation of nested classes using keyboard
+  $('#full_list a.toggle').on('keypress',function(evt) {
+    // enter key is pressed
+    if (evt.which == 13) {
+      evt.stopPropagation();
+      evt.preventDefault();
+      $(this).parent().parent().toggleClass('collapsed');
+      $(this).attr('aria-expanded', function (i, attr) {
+          return attr == 'true' ? 'false' : 'true'
+      });
+      highlight();
+    }
+  });
 }
 
 function populateSearchCache() {
@@ -91,7 +108,7 @@ function enableSearch() {
     }
   });
 
-  $('#full_list').after("<div id='noresults' style='display:none'></div>");
+  $('#full_list').after("<div id='noresults' role='status' style='display: none'></div>");
 }
 
 function ignoredKeyPress(event) {
@@ -154,11 +171,14 @@ function partialSearch(searchString, offset) {
 function searchDone() {
   searchTimeout = null;
   highlight();
-  if ($('#full_list li:visible').size() === 0) {
-    $('#noresults').text('No results were found.').hide().fadeIn();
+  var found = $('#full_list li:visible').size();
+  if (found === 0) {
+    $('#noresults').text('No results were found.');
   } else {
-    $('#noresults').text('').hide();
+    // This is read out to screen readers
+    $('#noresults').text('There are ' + found + ' results.');
   }
+  $('#noresults').show();
   $('#content').removeClass('insearch');
 }
 
@@ -188,6 +208,12 @@ function expandTo(path) {
   $target.addClass('clicked');
   $target.removeClass('collapsed');
   $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
+
+  $target.find('a.toggle').attr('aria-expanded', 'true')
+  $target.parentsUntil('#full_list', 'li').each(function(i, el) {
+    $(el).find('> div > a.toggle').attr('aria-expanded', 'true');
+  });
+
   if($target[0]) {
     window.scrollTo(window.scrollX, $target.offset().top - 250);
     highlight();

data/templates/default/fulldoc/html/setup.rb

@@ -104,6 +104,12 @@ def javascripts_full_list
   %w(js/jquery.js js/full_list.js)
 end
 
+# Sets the HTML language lang="value" where value is the value returned from
+# this method. Defaults to nil which does not set the lang attribute.
+def html_lang
+  nil
+end
+
 def menu_lists
   Object.new.extend(T('layout')).menu_lists
 end
@@ -225,7 +231,8 @@ def class_list(root = Registry.root, tree = TreeContext.new)
     has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
     out << "<li id='object_#{child.path}' class='#{tree.classes.join(' ')}'>"
     out << "<div class='item' style='padding-left:#{tree.indent}'>"
-    out << "<a class='toggle'></a> " if has_children
+    accessible_props = "aria-label='#{name} child nodes' aria-expanded='false' aria-controls='object_#{child.path}'"
+    out << "<a tabindex='0' class='toggle' role='button' #{accessible_props}></a> " if has_children
     out << linkify(child, name)
     out << " &lt; #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
     out << "<small class='search_info'>"
@@ -233,7 +240,8 @@ def class_list(root = Registry.root, tree = TreeContext.new)
     out << "</small>"
     out << "</div>"
     tree.nest do
-      out << "<ul>#{class_list(child, tree)}</ul>" if has_children
+      labeled_by = "aria-labelledby='object_#{child.path}'"
+      out << "<div #{labeled_by}><ul>#{class_list(child, tree)}</ul></div>" if has_children
     end
     out << "</li>"
   end

data/templates/default/layout/html/footer.erb

@@ -1,5 +1,5 @@
 <div id="footer">
   Generated on <%= Time.now.strftime("%c") %> by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
 </div>

data/templates/default/onefile/html/headers.erb

@@ -1,5 +1,7 @@
 <style type="text/css">
   <%= @css_data %>
+  html { width: auto; height: auto; }
+  body { display: block; margin: 1rem; width: auto; }
 </style>
 <script type="text/javascript">
   <%= @js_data %>

data/templates/default/tags/html/example.erb

@@ -1,9 +1,9 @@
 <% if object.has_tag?(:example) %>
   <div class="examples">
-    <p class="tag_title">Examples:</p>
+    <h4 class="tag_title">Examples:</h4>
     <% object.tags(:example).each do |tag| %>
       <% unless tag.name.empty? %>
-        <p class="example_title"><%= htmlify_line(tag.name) %></p>
+        <h5 class="example_title"><%= htmlify_line(tag.name) %></h5>
       <% end %>
       <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
     <% end %>

data/templates/default/tags/html/option.erb

@@ -1,4 +1,4 @@
-<% if object.has_tag?(:option) %>
+<% if object.has_tag?(:option) && object.respond_to?(:parameters) %>
   <% object.parameters.each do |param, default| %>
     <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+|:$/, '') } %>
     <% next if tags.empty? %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.26
+  version: 0.9.37
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -23,47 +23,13 @@ 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"
-- ".travis.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
@@ -199,6 +165,7 @@ files:
 - lib/yard/i18n/pot_generator.rb
 - lib/yard/i18n/text.rb
 - lib/yard/logging.rb
+- lib/yard/open_struct.rb
 - lib/yard/options.rb
 - lib/yard/parser/base.rb
 - lib/yard/parser/c/c_parser.rb
@@ -246,6 +213,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
@@ -298,8 +266,6 @@ files:
 - lib/yard/verifier.rb
 - lib/yard/version.rb
 - po/ja.po
-- samus.json
-- tasks/update_error_map.rake
 - templates/default/class/dot/setup.rb
 - templates/default/class/dot/superklass.erb
 - templates/default/class/html/constructor_details.erb
@@ -427,7 +393,6 @@ files:
 - 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
@@ -448,8 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+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,42 +0,0 @@
-name: Unit Tests
-
-on: [push, pull_request]
-jobs:
-  build:
-    name: "Ruby: ${{ matrix.ruby }} OS: ${{ matrix.os }}"
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, windows-latest, ubuntu-latest]
-        ruby: ["2.4", "2.5", "2.6", "2.7"]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Select Ruby Version
-        uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          base: update
-      - name: Update RubyGems & Bundler
-        run: gem update --system --no-document --conservative
-      - name: Install Dependencies
-        run: bundle install --jobs=3 --retry=3
-      - name: Run Test
-        run: |
-          ruby -v
-          bundle exec rake
-        env:
-          CI: true
-  build_ruby3:
-    name: "Ruby: 3.0 OS: Linux"
-    runs-on: ubuntu-latest
-    container: ruby:3.0-rc-alpine
-    steps:
-      - uses: actions/checkout@v2
-      - run: apk add -U build-base
-      - run: gem update --system --no-document --conservative
-      - run: bundle install --jobs=3 --retry=3
-      - run: ruby -v && bundle exec rake
-        env:
-          CI: true

data/.github/workflows/gem.yml

@@ -1,27 +0,0 @@
-name: Release Version
-
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  release_version:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - id: tag
-        run: echo ::set-output name=TAG::$(echo $GITHUB_REF | cut -d / -f 3)
-      - run: ruby -e 'tag=ENV["GITHUB_REF"].sub("refs/tags/", "").sub("v", "v?");puts File.read("CHANGELOG.md")[/#\s+#{tag}[^\r\n]+\r?\n(.+?)(^#|\Z)/mi,1].strip' > extracted_changelog.md
-      - name: Create Release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ steps.tag.outputs.TAG }}
-          release_name: Release ${{ steps.tag.outputs.TAG }}
-          body_path: extracted_changelog.md
-      - 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/.travis.yml

@@ -1,49 +0,0 @@
-# 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/CODE_OF_CONDUCT.md

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