yard 0.9.28 → 0.9.36

data/po/ja.po

@@ -1501,7 +1501,7 @@ msgstr ""
 "これらのオブジェクトはツリー構造のように振る舞い、これらの直接の子全てのリストを維持している。\n"
 "namespaceではない全てのオブジェクトは単純にベースクラスのサブクラスである。\n"
 "{YARD::CodeObjects::RootObject RootObject} は\n"
-"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamaspaceを参照する。\n"
+"特別な `NamespaceObject` ともいえ、Rubyの中のトップレベルnamespaceを参照する。\n"
 "パラメータとして namespace オブジェクトを受け入れるメソッドは、\n"
 "root オブジェクト用のショートカットとして `:root` シンボルも受け入れる。"
 
@@ -6175,7 +6175,7 @@ msgstr ""
 "'default/class'から自動的に継承する。\n"
 "そして 'default/class/setup.rb' の中に定義されるもの全ては、\n"
 "'default/class/html/setup.rb' によって上書きされることも意味する。\n"
-"(yard/lib以下の話ではなくyard/templetes以下の話)"
+"(yard/lib以下の話ではなくyard/templates以下の話)"
 
 #: ../docs/Templates.md:200
 msgid ""
@@ -7124,7 +7124,7 @@ msgstr "#### Rubyのコードを解析する為の新しい `@!parse` ディレ
 #: ../docs/WhatsNew.md:87
 msgid ""
 "A new {tag:!parse} directive was added that allows a developer to have\n"
-"YARD parse code that might not necessarily be parseable in its original\n"
+"YARD parse code that might not necessarily be parsable in its original\n"
 "form. This is useful when using `instance_eval` and other dynamic\n"
 "meta-programming techniques to define methods or perform functionality.\n"
 "For instance, a common case of the \"self.included\" callback in module\n"
@@ -9452,7 +9452,7 @@ msgid ""
 msgstr ""
 "1. **新しいテンプレートエンジンとテンプレート**\n"
 "2. **yardoc `--query` 引数**\n"
-"3. **Greatly ecpanded API ドキュメント**\n"
+"3. **Greatly expanded API ドキュメント**\n"
 "4. **新しいプラグインのサポート**\n"
 "5. **新しいタグ(@abstract, @private)**\n"
 "6. **デフォルトのrake taskは`rake yard`コマンドになった**"
@@ -9607,7 +9607,7 @@ msgid ""
 "This tag exists so that you can create a query (`--query !@private`) to\n"
 "ignore all of these private objects in your documentation. You can also\n"
 "use the new `--no-private` switch, which is a shortcut to the "
-"afformentioned\n"
+"aforementioned\n"
 "query. You can read more about the new tags in the {file:docs/GettingStarted."
 "md}\n"
 "guide."
@@ -9816,7 +9816,7 @@ msgid ""
 "      # @overload def to_html(html, autolink = true)\n"
 "      #   This docstring describes the specific overload only.\n"
 "      #   @param [String] html the HTML\n"
-"      #   @param [Boolean] autolink whether or not to atuomatically link\n"
+"      #   @param [Boolean] autolink whether or not to automatically link\n"
 "      #     URL references\n"
 "      # @overload def to_html(html, opts = {})\n"
 "      #   @param [String] html the HTML\n"
@@ -9828,7 +9828,7 @@ msgstr ""
 "      # @overload def to_html(html, autolink = true)\n"
 "      #   This docstring describes the specific overload only.\n"
 "      #   @param [String] html the HTML\n"
-"      #   @param [Boolean] autolink whether or not to atuomatically link\n"
+"      #   @param [Boolean] autolink whether or not to automatically link\n"
 "      #     URL references\n"
 "      # @overload def to_html(html, opts = {})\n"
 "      #   @param [String] html the HTML\n"
@@ -11513,7 +11513,7 @@ msgstr ""
 
 # @param [Hash, nil] checksums
 #: ../lib/yard/cli/yardoc.rb:340
-msgid "if supplied, a list of checkums for files."
+msgid "if supplied, a list of checksums for files."
 msgstr "提供する場合は、ファイルの為のチェックサムのリスト"
 
 # @param [Hash, nil]
@@ -15746,7 +15746,7 @@ msgstr ""
 # YARD::DocstringParser
 #: ../lib/yard/docstring_parser.rb:11
 msgid ""
-"The DocstringParser can be subclassed and subtituted during parsing by\n"
+"The DocstringParser can be subclassed and substituted during parsing by\n"
 "setting the {Docstring.default_parser} attribute with the name of the\n"
 "subclass. This allows developers to change the way docstrings are\n"
 "parsed, allowing for completely different docstring syntaxes."
@@ -18512,7 +18512,7 @@ msgstr "翻訳目標のメッセージ"
 # @return [String]
 #: ../lib/yard/i18n/locale.rb:45
 msgid ""
-"translated message. If tarnslation isn't\n"
+"translated message. If translation isn't\n"
 "registered, the +message+ is returned."
 msgstr ""
 
@@ -18525,7 +18525,7 @@ msgstr ""
 
 # @param tag_name
 #: ../lib/yard/i18n/message.rb:11
-msgid "the message ID of the trnslation target message."
+msgid "the message ID of the translation target message."
 msgstr "翻訳目標のメッセージのメッセージID"
 
 # @param [Fixnum, nil] line
@@ -18545,7 +18545,7 @@ msgstr "メッセージ用のコメントのグループ"
 
 # YARD::Handlers::Processor#initialize
 #: ../lib/yard/i18n/message.rb:21
-msgid "Creates a trasnlate target message for message ID +id+."
+msgid "Creates a translate target message for message ID +id+."
 msgstr "メッセージID +id+ 用の翻訳目標のメッセージを作成する"
 
 # @return [Tag]
@@ -18652,7 +18652,7 @@ msgstr ""
 # YARD::I18n::Messages#register
 #: ../lib/yard/i18n/messages.rb:31
 msgid ""
-"Registers a {Message}, the mssage ID of which is +id+. If\n"
+"Registers a {Message}, the message ID of which is +id+. If\n"
 "corresponding +Message+ is already registered, the previously\n"
 "registered object is returned."
 msgstr ""
@@ -18876,7 +18876,7 @@ msgstr ""
 msgid ""
 "Locations of the +Message+ are used to generate the reference\n"
 "line that is started with \"#: \". +relative_base_path+ passed\n"
-"when the generater is created is prepended to each path in location."
+"when the generator is created is prepended to each path in location."
 msgstr ""
 
 # YARD::I18n::PotGenerator#generate
@@ -19475,7 +19475,7 @@ msgstr "tag|example|ハッシュ構文を用いたオプションの設定"
 
 # @param [Hash] options
 #: ../lib/yard/options.rb:99
-msgid "the optin to set"
+msgid "the option to set"
 msgstr "設定するためのオプション"
 
 # @param [Object] value
@@ -23736,7 +23736,7 @@ msgid ""
 "  def run\n"
 "    self.body = 'ERROR! The System is down!'\n"
 "    self.status = 500\n"
-"    self.headers['Conten-Type'] = 'text/plain'\n"
+"    self.headers['Content-Type'] = 'text/plain'\n"
 "  end\n"
 "end"
 msgstr ""
@@ -27892,7 +27892,7 @@ msgstr "任意のタイトルとして、リンクに表示する"
 #: ../lib/yard/templates/helpers/base_helper.rb:143
 #: ../lib/yard/templates/helpers/html_helper.rb:220
 msgid "Links to an extra file"
-msgstr "extarファイルにリンクする"
+msgstr "extraファイルにリンクする"
 
 # @param [String] anchor
 #: ../lib/yard/templates/helpers/base_helper.rb:149
@@ -30096,7 +30096,7 @@ msgstr "解析された式"
 #~ "{Library.default_factory}."
 #~ msgstr ""
 #~ "次の事に留意する。\n"
-#~ "+tag_facotory+ は、タグを解析する為に利用されるfactoryオブジェクトとな"
+#~ "+tag_factory+ は、タグを解析する為に利用されるfactoryオブジェクトとな"
 #~ "る。\n"
 #~ "この値は{DefaultFactory}クラスがデフォルトとなり、\n"
 #~ "{Library.default_factory}を変更する事によって設定できる。"
@@ -31067,7 +31067,7 @@ msgstr "解析された式"
 
 #~ msgid ""
 #~ "* **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a "
-#~ "languge\n"
+#~ "language\n"
 #~ "  optimized for a specific domain (problem) but represented using Ruby "
 #~ "syntax."
 #~ msgstr ""

data/templates/default/fulldoc/html/frames.erb

@@ -5,10 +5,15 @@
 	<title><%= options.title %></title>
 </head>
 <script type="text/javascript">
-  var match = unescape(window.location.hash).match(/^#!(.+)/);
-  var name = match ? match[1] : '<%= url_for_main %>';
-  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
-  window.top.location = name;
+var mainUrl = '<%= url_for_main %>';
+try {
+    var match = decodeURIComponent(window.location.hash).match(/^#!(.+)/);
+    var name = match ? match[1] : mainUrl;
+    var url = new URL(name, location.href);
+    window.top.location.replace(url.origin === location.origin ? name : mainUrl);
+} catch (e) {
+    window.top.location.replace(mainUrl);
+}
 </script>
 <noscript>
   <h1>Oops!</h1>

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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.28
+  version: 0.9.36
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-01 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: 2024-02-29 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,46 +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"
 - ".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
@@ -259,6 +212,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
@@ -311,9 +265,6 @@ files:
 - 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
@@ -441,7 +392,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
@@ -462,7 +412,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. also disable 2.5 due to bundler crashes
-        ruby: [2.2, 2.3, 2.4, 2.6, 2.7, "3.0", 3.1]
-        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/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.