yard 0.9.28 → 0.9.29

data/samus.json

@@ -1,49 +0,0 @@
-{
-  "actions": [
-    {
-      "action": "fs-sedfiles",
-      "files": [
-        "lib/*/version.rb"
-      ],
-      "arguments": {
-        "search": "VERSION = ['\"](.+?)['\"]",
-        "replace": "VERSION = '$version'"
-      }
-    },
-    {
-      "action": "chmod-files",
-      "files": [
-        "**/*,644",
-        "bin/*,755"
-      ]
-    },
-    {
-      "action": "changelog-rotate",
-      "files": [
-        "CHANGELOG.md"
-      ],
-      "arguments": {
-        "title_format": "$version - %B %-d$day_nth, %Y"
-      }
-    },
-    {
-      "action": "git-commit",
-      "files": [
-        "CHANGELOG.md",
-        "lib/*/version.rb"
-      ]
-    },
-    {
-      "action": "git-merge",
-      "arguments": {
-        "branch": "main"
-      }
-    },
-    {
-      "action": "ruby-bundle"
-    },
-    {
-      "action": "rake-task"
-    }
-  ]
-}

data/tasks/prepare_tag.rake

@@ -1,45 +0,0 @@
-require 'json'
-require 'tempfile'
-
-namespace :release do
-  desc 'Updates repository and tags VERSION=X.Y.Z'
-  task :tag do
-    restore_file = Tempfile.new
-    restore_file.close
-    at_exit { restore_file.unlink }
-
-    version = ENV['VERSION']
-    build_path = File.expand_path(File.join(`gem which samus`.strip, '..', '..', 'commands', 'build'))
-    samus_contents = File.read(File.join(__dir__, '..', 'samus.json'))
-    samus_json = JSON.parse(samus_contents.gsub('$version', version))
-
-    samus_json['actions'].each do |action|
-      env = {
-        '_VERSION' => version,
-        '__ORIG_BRANCH' => `git rev-parse --abbrev-ref HEAD`.strip,
-        '__RESTORE_FILE' => restore_file.path,
-      }
-      (action['arguments'] || {}).each {|k, v| env["_#{k.upcase}"] = v }
-      cmd = [File.join(build_path, action['action']), *action['files']]
-      puts "[C] #{action['action']} #{(action['files'] || []).join(' ')}"
-      output = ""
-      IO.popen(env, cmd) {|io| output = io.read }
-      status = $?
-      unless status.success?
-        puts "[F] Last command failed with: #{status.to_i}"
-        puts output
-        exit(status.to_i)
-      end
-    end
-
-    puts ""
-    puts "Tag v#{version} created. To publish, type the following:"
-    puts ""
-    puts "  bundle exec rake release:push VERSION=#{version}"
-  end
-
-  desc 'Pushes the main branch and tag for VERSION=X.Y.Z'
-  task :push do
-    sh "git push main v#{ENV['VERSION']}"
-  end
-end

data/tasks/update_error_map.rake

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-# Script to generate the Error class name map in:
-# lib/yard/handlers/c/base.rb
-
-require 'open-uri'
-require 'stringio'
-
-desc 'Update the error class names map'
-task :update_error_map do
-
-  ERROR_C_URL = 'https://raw.githubusercontent.com/ruby/ruby/master/error.c'
-
-  INIT_MATCH = /void\s+Init_Exception\(void\)\s*\{(.+?)^\}/m
-  NAME_MATCH = /(\w+)\s*=\s*rb_define_class\("([^"]+)"/
-
-  $stderr.puts "Downloading #{ERROR_C_URL} ..."
-  content = open(ERROR_C_URL) { |io| io.read }
-
-  $stderr.puts "Extracting class names ..."
-  init_source = content.match(INIT_MATCH).captures.first
-  map = init_source.scan(NAME_MATCH).sort_by { |key, value| key }
-
-  $stderr.puts "Generating new lookup table ..."
-  indent = '  ' * 4
-  source = StringIO.new
-  source.puts "#{indent}ERROR_CLASS_NAMES = {"
-  map.each do |variable, name|
-    source.puts "#{indent}  '#{variable}' => '#{name}',"
-  end
-  source.puts "#{indent}}"
-
-  $stderr.puts source.string
-
-  $stderr.puts "Patching 'lib/yard/handlers/c/base.rb' ..."
-  CLASS_NAME_MAP_MATCH = /^\s+ERROR_CLASS_NAMES = {[^}]+}/
-
-  PROJECT_PATH = File.expand_path('..', __dir__)
-  C_BASE_HANDLER = File.join(PROJECT_PATH, 'lib/yard/handlers/c/base.rb')
-
-  File.open(C_BASE_HANDLER, 'r+') { |file|
-    content = file.read
-    # .rstrip is added to avoid adding new empty lines due to the new lines
-    # added by `.puts` when building the string.
-    content.gsub!(CLASS_NAME_MAP_MATCH, source.string.rstrip)
-    file.rewind
-    file.truncate(0)
-    file.write(content)
-  }
-
-  $stderr.puts "Done!"
-
-end

data/templates/default/class/dot/setup.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-include T('default/module/dot')
-
-def init
-  super
-  sections.push :superklass
-end

data/templates/default/class/dot/superklass.erb

@@ -1,3 +0,0 @@
-<% if object.superclass.path != "Object" && object.superclass.path != "BasicObject" %>
-  <%= format_path object %> -> <%= format_path object.superclass %>;
-<% end %>

data/templates/default/class/html/constructor_details.erb

@@ -1,8 +0,0 @@
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-  <% if @ctor.namespace != object %>
-    <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>
-  <% else %>
-    <%= yieldall :object => @ctor, :index => 0 %>
-  <% end %>
-</div>

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

@@ -1,2 +0,0 @@
-# frozen_string_literal: true
-include T('default/module/html')

data/templates/default/class/html/subclasses.erb

@@ -1,4 +0,0 @@
-<div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><%= @subclasses.map {|name, child| linkify(child, name) }.join(", ") %></p>
-</div>

data/templates/default/class/setup.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-include T('default/module')
-
-def init
-  super
-  sections.place(:subclasses).before(:children)
-  sections.place(:constructor_details, [T('method_details')]).before(:methodmissing)
-end
-
-def constructor_details
-  ctors = object.meths(:inherited => true, :included => true)
-  @ctor = ctors.find(&:constructor?)
-  return unless @ctor
-  return if prune_method_listing([@ctor]).empty?
-  erb(:constructor_details)
-end
-
-def subclasses
-  return if object.path == "Object" # don't show subclasses for Object
-  unless globals.subclasses
-    globals.subclasses = {}
-    list = run_verifier Registry.all(:class)
-    list.each do |o|
-      (globals.subclasses[o.superclass.path] ||= []) << o if o.superclass
-    end
-  end
-
-  @subclasses = globals.subclasses[object.path]
-  return if @subclasses.nil? || @subclasses.empty?
-  @subclasses = @subclasses.sort_by(&:path).map do |child|
-    name = child.path
-    name = object.relative_path(child) if object.namespace
-    [name, child]
-  end
-  erb(:subclasses)
-end

data/templates/default/class/text/setup.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-include T('default/module/text')
-
-def init
-  super
-  sections.place(:subclasses).before(:children)
-  sections.delete(:children)
-end
-
-def format_object_title(object)
-  "Class: #{object.title} < #{object.superclass.title}"
-end

data/templates/default/class/text/subclasses.erb

@@ -1,5 +0,0 @@
-Direct Known Subclasses:
-------------------------
-
-<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
-

data/templates/default/constant/text/header.erb

@@ -1,11 +0,0 @@
-<%= title_align_right format_object_title(object) %>
-
-
-<%= object.name %> = <%= object.value.size > 40 ? "\n\n" + indent(object.value) : object.value %>
-
-
-<%= hr %>
-
-<%= yieldall %>
-
-<%= hr %>

data/templates/default/constant/text/setup.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-def init
-  sections :header, [T('docstring')]
-end

data/templates/default/docstring/html/abstract.erb

@@ -1,4 +0,0 @@
-<div class="note abstract">
-  <strong>This <%= object.type %> is abstract.</strong>
-  <%= htmlify_line object.tag(:abstract).text %>
-</div>

data/templates/default/docstring/html/deprecated.erb

@@ -1 +0,0 @@
-<div class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></div>

data/templates/default/docstring/html/index.erb

@@ -1,5 +0,0 @@
-<div class="docstring">
-  <div class="discussion">
-    <%= yieldall %>
-  </div>
-</div>

data/templates/default/docstring/html/note.erb

@@ -1,6 +0,0 @@
-<% object.tags(:note).each do |tag| %>
-  <div class="note notetag">
-    <strong>Note:</strong>
-    <%= htmlify_line tag.text %>
-  </div>
-<% end %>

data/templates/default/docstring/html/private.erb

@@ -1,4 +0,0 @@
-<p class="note private">
-  <strong>This <%= object.type %> is part of a private API.</strong>
-  You should avoid using this <%= object.type %> if possible, as it may be removed or be changed in the future.
-</p>

data/templates/default/docstring/html/returns_void.erb

@@ -1 +0,0 @@
-<p class="note returns_void">This method returns an undefined value.</p>

data/templates/default/docstring/html/text.erb

@@ -1 +0,0 @@
-<%= htmlify(docstring_text) %>

data/templates/default/docstring/html/todo.erb

@@ -1,6 +0,0 @@
-<% object.tags(:todo).each do |tag| %>
-  <div class="note todo">
-    <strong>TODO:</strong>
-    <%= htmlify_line tag.text %>
-  </div>
-<% end %>

data/templates/default/docstring/setup.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-def init
-  return if object.docstring.blank? && !object.has_tag?(:api)
-  sections :index, [:private, :deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
-end
-
-def private
-  return unless object.has_tag?(:api) && object.tag(:api).text == 'private'
-  erb(:private)
-end
-
-def abstract
-  return unless object.has_tag?(:abstract)
-  erb(:abstract)
-end
-
-def deprecated
-  return unless object.has_tag?(:deprecated)
-  erb(:deprecated)
-end
-
-def todo
-  return unless object.has_tag?(:todo)
-  erb(:todo)
-end
-
-def note
-  return unless object.has_tag?(:note)
-  erb(:note)
-end
-
-def returns_void
-  return unless object.type == :method
-  return if object.name == :initialize && object.scope == :instance
-  return unless object.tags(:return).size == 1 && object.tag(:return).types == ['void']
-  erb(:returns_void)
-end
-
-def docstring_text
-  text = ""
-  unless object.tags(:overload).size == 1 && object.docstring.empty?
-    text = object.docstring
-  end
-
-  if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
-    text = object.tag(:return).text.gsub(/\A([a-z])/, &:downcase)
-    text = "Returns #{text.sub(/\.\Z/, '')}." unless text.empty? || text =~ /^\s*return/i
-    text = text.gsub(/\A([a-z])/, &:upcase)
-  end
-
-  text.strip
-end

data/templates/default/docstring/text/abstract.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("Abstract. #{object.tag(:abstract).text}")) %>
-

data/templates/default/docstring/text/deprecated.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("Deprecated. #{object.tag(:deprecated).text}")) %>
-

data/templates/default/docstring/text/index.erb

@@ -1,2 +0,0 @@
-
-<%= yieldall %>

data/templates/default/docstring/text/note.erb

@@ -1,4 +0,0 @@
-<% object.tags(:note).each do |tag| %>
-<%= indent(wrap("Note: #{tag.text}")) %>
-
-<% end %>

data/templates/default/docstring/text/private.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("This #{object.type} is part of a private API.")) %>
-

data/templates/default/docstring/text/returns_void.erb

@@ -1 +0,0 @@
-<%= indent(wrap("This method returns an undefined value.")) %>

data/templates/default/docstring/text/text.erb

@@ -1 +0,0 @@
-<%= indent wrap(h(docstring_text.strip), 68) %>

data/templates/default/docstring/text/todo.erb

@@ -1,4 +0,0 @@
-<% object.tags(:todo).each do |tag| %>
-<%= indent(wrap("TODO: #{tag.text}")) %>
-
-<% end %>

data/templates/default/fulldoc/html/css/common.css

@@ -1 +0,0 @@
-/* Override this file with custom rules */

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

@@ -1,58 +0,0 @@
-body {
-  margin: 0;
-  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
-  font-size: 13px;
-  height: 101%;
-  overflow-x: hidden;
-  background: #fafafa;
-}
-
-h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
-.clear { clear: both; }
-.fixed_header { position: fixed; background: #fff; width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; height: 70px; }
-#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
-#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
-#full_list { padding: 0; list-style: none; margin-left: 0; margin-top: 80px; font-size: 1.1em; }
-#full_list ul { padding: 0; }
-#full_list li { padding: 0; margin: 0; list-style: none; }
-#full_list li .item { padding: 5px 5px 5px 12px; }
-#noresults { padding: 7px 12px; background: #fff; }
-#content.insearch #noresults { margin-left: 7px; }
-li.collapsed ul { display: none; }
-li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
-li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
-li { color: #888; cursor: pointer; }
-li.deprecated { text-decoration: line-through; font-style: italic; }
-li.odd { background: #f0f0f0; }
-li.even { background: #fafafa; }
-.item:hover { background: #ddd; }
-li small:before { content: "("; }
-li small:after { content: ")"; }
-li small.search_info { display: none; }
-a, a:visited { text-decoration: none; color: #05a; }
-li.clicked > .item { background: #05a; color: #ccc; }
-li.clicked > .item a, li.clicked > .item a:visited { color: #eee; }
-li.clicked > .item a.toggle { opacity: 0.5; background-position: bottom right; }
-li.collapsed.clicked a.toggle { background-position: top right; }
-#search input { border: 1px solid #bbb; border-radius: 3px; }
-#full_list_nav { margin-left: 10px; font-size: 0.9em; display: block; color: #aaa; }
-#full_list_nav a, #nav a:visited { color: #358; }
-#full_list_nav a:hover { background: transparent; color: #5af; }
-#full_list_nav span:after { content: ' | '; }
-#full_list_nav span:last-child:after { content: ''; }
-
-#content h1 { margin-top: 0; }
-li { white-space: nowrap; cursor: normal; }
-li small { display: block; font-size: 0.8em; }
-li small:before { content: ""; }
-li small:after { content: ""; }
-li small.search_info { display: none; }
-#search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
-#content.insearch #search { background-position: center right; }
-#search input { width: 110px; }
-
-#full_list.insearch ul { display: block; }
-#full_list.insearch .item { display: none; }
-#full_list.insearch .found { display: block; padding-left: 11px !important; }
-#full_list.insearch li a.toggle { display: none; }
-#full_list.insearch li small.search_info { display: block; }