boondoc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f854aff827f84fc734634d7e01d80908ff4f347532ab20cce7996771876b9f1f
-  data.tar.gz: 3ebdb2551d145c72e70639cad96e5f31366fbe98e21db115da1a8964f9b8d2a2
+  metadata.gz: 7c13a5463fe03339e80ae333ab749e43ea5c7cb96fdbb84ea912e8244137f6e1
+  data.tar.gz: 1f5c49a3410b19c83702dd14c132c86ae6d2e2713f355a55d1785ca61d06b20f
 SHA512:
-  metadata.gz: e7cdde7b2696fa3bca5cf2b8dcb7825ea28ffe4c2f69db5fa41444330fa7d6910b5ec683f11ab21106cca39c2978fe247dcd2b701d4d27f15753bbb6fb912427
-  data.tar.gz: d78c6cca549633e526d9f979d59d0bc653fb4339c23f57a51370ef8b57c14e296c77ab3f8f803c58818e356bc188b07d5f80294449a1179a178b401e7a064878
+  metadata.gz: 8e66df66817ff7dad455164c0b73370af4878cd278515b1f0037e3348a8736a6480801ad08c2aa4b972cda1794ba3635f290b21fc81b0e029e3b02037155ab46
+  data.tar.gz: 1acb6c00c6d5d089d709f1303ca1dd768d597fe6a0446efa42bfa82b8d9105165c8e81a90225a7d904f659b89481fbeeec542fa06dd80197fbf15253069cdf46

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-11-03
+
+### 📦 Dependencies
+- **prism 2.x is now allowed** (`>= 1.0, < 3`). The thor floor is now 1.2, down from 1.3; thor 1.0 and 1.1 fail to load on Ruby 3.4 and later.
+- The README now asks for yard 0.9.39 or later with `--yard-macros`, since older releases fail on Ruby 4.0.
+- CI runs the specs against the oldest supported versions (prism 1.0, thor 1.2, yard 0.9.39), the latest prism 1.x, prism 2.x, and without yard, using Appraisal2.
+
 ## [0.1.0] - 2026-10-25
 
 ### ✨ Features

data/README.md

@@ -307,9 +307,11 @@ Boondoc does not expand YARD macros and directives (`@!macro`, `@!method`,
 pass `--yard-macros`:
 
 ```ruby
-gem 'yard', group: :development
+gem 'yard', '>= 0.9.39', group: :development
 ```
 
+Older yard releases fail to load on Ruby 4.0, which no longer ships `ostruct`.
+
 Prism remains the source of truth. YARD is run as a second pass and only
 contributes the objects that directives create and the expanded docstrings of
 comments that use a macro.

data/exe/boondoc

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'boondoc'
+require "boondoc"
 
 Boondoc::CLI.start_with_default(ARGV)

data/lib/boondoc/assets.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathname'
+require "pathname"
 
 module Boondoc
   # The files that are copied into the output directory next to the pages: images, video, PDFs,
@@ -53,7 +53,7 @@ module Boondoc
     private
 
     def add(map, entry)
-      from, directory = entry.split(':', 2)
+      from, directory = entry.split(":", 2)
       Dir.glob(from, base: @config.root).each do |match|
         sources(match).each do |source, within|
           output = directory ? output_path(directory, within) : source
@@ -73,19 +73,19 @@ module Boondoc
       raise Error, "#{match} is outside the project (#{@config.root})" unless Containment.inside?(full, @config.root)
       return [[relative(full), File.basename(full)]] if File.file?(full)
 
-      Dir.glob('**/*', base: full).select { |path| named_file?(File.join(full, path)) }
-         .map { |path| [relative(File.join(full, path)), path] }
+      Dir.glob("**/*", base: full).select { |path| named_file?(File.join(full, path)) }
+        .map { |path| [relative(File.join(full, path)), path] }
     end
 
     def named_file?(full)
-      inside = full.delete_prefix(File.join(@config.root, ''))
-      File.file?(full) && inside.split('/').none? { |part| part.start_with?('.') } &&
-        Containment.inside?(full, @config.root) && !full.start_with?(File.join(@config.output_dir, ''))
+      inside = full.delete_prefix(File.join(@config.root, ""))
+      File.file?(full) && inside.split("/").none? { |part| part.start_with?(".") } &&
+        Containment.inside?(full, @config.root) && !full.start_with?(File.join(@config.output_dir, ""))
     end
 
     def output_path(directory, within)
       path = Pathname.new(File.join(directory, within)).cleanpath.to_s
-      raise Error, "asset destination #{directory} is outside the output directory" if path.start_with?('..', '/')
+      raise Error, "asset destination #{directory} is outside the output directory" if path.start_with?("..", "/")
 
       path
     end
@@ -96,7 +96,7 @@ module Boondoc
 
     # Remembers an embedded file that is worth copying and returns where it goes.
     def link(absolute)
-      root = File.join(@config.root, '')
+      root = File.join(@config.root, "")
       return nil unless absolute.start_with?(root) && copyable?(absolute)
 
       output = absolute.delete_prefix(root)
@@ -106,7 +106,7 @@ module Boondoc
 
     def copyable?(absolute)
       File.file?(absolute) && !Stitcher::MARKDOWN.match?(absolute) &&
-        !absolute.start_with?(File.join(@config.output_dir, '')) && Containment.inside?(absolute, @config.root)
+        !absolute.start_with?(File.join(@config.output_dir, "")) && Containment.inside?(absolute, @config.root)
     end
   end
 end

data/lib/boondoc/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module Boondoc
   # The `boondoc` command.
@@ -14,7 +14,7 @@ module Boondoc
     # @return [void]
     def self.start_with_default(argv)
       known = COMMANDS.include?(argv.first) || COMMAND_FLAGS.include?(argv.first)
-      start(known ? argv : ['generate', *argv])
+      start(known ? argv : ["generate", *argv])
     end
 
     # @return [Boolean] exit non-zero when a command fails
@@ -22,7 +22,7 @@ module Boondoc
       true
     end
 
-    desc 'generate [GLOBS]', 'Write markdown documentation (default command)'
+    desc "generate [GLOBS]", "Write markdown documentation (default command)"
     long_desc <<~DESC
       Parses the Ruby files matching GLOBS (default: lib/**/*.rb) and writes one markdown
       file per class or module, plus an index, into the output directory.
@@ -34,46 +34,48 @@ module Boondoc
       The output directory must be inside the project, and not reached through a symlink.
       Sources outside the project are skipped with a warning.
     DESC
-    option :output, aliases: '-o', type: :string, desc: 'Output directory (default: docs)'
-    option :index, type: :string, desc: 'Name of the index page (default: README.md)'
-    option :readme, type: :string, desc: 'File to use as the index page (default: README.md if present)'
-    option :skip_readme, type: :boolean, desc: 'Do not include a README in the index page'
-    option :files, type: :array, desc: 'Extra markdown files or globs to stitch in'
-    option :assets, type: :array, desc: 'Files, directories, or globs to copy into the output (FROM or FROM:DIR)'
-    option :copy_linked_assets, type: :boolean,
-                                desc: 'Also copy the files that pages embed, such as images in the README'
-    option :exclude, type: :array, desc: 'Ruby files or globs to leave out'
-    option :title, type: :string, desc: 'Title for the index page when there is no README'
-    option :private, type: :boolean, desc: 'Include private methods and @private objects'
-    option :protected, type: :boolean, desc: 'Include protected methods'
-    option :yard_macros, type: :boolean, desc: 'Expand @!macro, @!method, and @!attribute using the yard gem'
-    option :yardopts, type: :boolean, desc: 'Read .yardopts (default; --no-yardopts to skip it)'
-    option :strict, type: :boolean, desc: 'Exit non-zero if there are warnings'
-    option :force, type: :boolean, desc: 'Overwrite files in the output directory that boondoc did not write'
-    option :allow_outside_output, type: :boolean,
-                                  desc: 'Allow an output directory outside the project (a security risk if the ' \
-                                        'project is not trusted; for docs kept outside the repository)'
-    option :config, aliases: '-c', type: :string, desc: 'Config file (default: .boondoc.yml)'
-    option :quiet, aliases: '-q', type: :boolean, desc: 'Only print warnings and errors'
+    option :output, aliases: "-o", type: :string, desc: "Output directory (default: docs)"
+    option :index, type: :string, desc: "Name of the index page (default: README.md)"
+    option :readme, type: :string, desc: "File to use as the index page (default: README.md if present)"
+    option :skip_readme, type: :boolean, desc: "Do not include a README in the index page"
+    option :files, type: :array, desc: "Extra markdown files or globs to stitch in"
+    option :assets, type: :array, desc: "Files, directories, or globs to copy into the output (FROM or FROM:DIR)"
+    option :copy_linked_assets,
+      type: :boolean,
+      desc: "Also copy the files that pages embed, such as images in the README"
+    option :exclude, type: :array, desc: "Ruby files or globs to leave out"
+    option :title, type: :string, desc: "Title for the index page when there is no README"
+    option :private, type: :boolean, desc: "Include private methods and @private objects"
+    option :protected, type: :boolean, desc: "Include protected methods"
+    option :yard_macros, type: :boolean, desc: "Expand @!macro, @!method, and @!attribute using the yard gem"
+    option :yardopts, type: :boolean, desc: "Read .yardopts (default; --no-yardopts to skip it)"
+    option :strict, type: :boolean, desc: "Exit non-zero if there are warnings"
+    option :force, type: :boolean, desc: "Overwrite files in the output directory that boondoc did not write"
+    option :allow_outside_output,
+      type: :boolean,
+      desc: "Allow an output directory outside the project (a security risk if the " \
+            "project is not trusted; for docs kept outside the repository)"
+    option :config, aliases: "-c", type: :string, desc: "Config file (default: .boondoc.yml)"
+    option :quiet, aliases: "-q", type: :boolean, desc: "Only print warnings and errors"
     def generate(*globs)
       Generator.new(Config.load(overrides(globs))).run
     rescue Error => e
       raise Thor::Error, "boondoc: #{e.message}"
     end
 
-    desc 'serve', 'Preview the generated docs in a browser with gh markdown-preview'
+    desc "serve", "Preview the generated docs in a browser with gh markdown-preview"
     long_desc <<~DESC
       Starts the gh markdown-preview extension of the GitHub CLI from inside the output
       directory, so the links between pages work. Offers to install the extension when
       it is missing. Run `boondoc` first to generate the docs.
     DESC
-    option :output, aliases: '-o', type: :string, desc: 'Directory holding the docs (default: docs)'
-    option :allow_outside_output, type: :boolean, desc: 'Allow a docs directory outside the project'
-    option :host, type: :string, default: Preview::DEFAULT_HOST, desc: 'Address to bind'
-    option :port, aliases: '-p', type: :numeric, desc: 'Port to listen on (default: 3333)'
-    option :config, aliases: '-c', type: :string, desc: 'Config file (default: .boondoc.yml)'
+    option :output, aliases: "-o", type: :string, desc: "Directory holding the docs (default: docs)"
+    option :allow_outside_output, type: :boolean, desc: "Allow a docs directory outside the project"
+    option :host, type: :string, default: Preview::DEFAULT_HOST, desc: "Address to bind"
+    option :port, aliases: "-p", type: :numeric, desc: "Port to listen on (default: 3333)"
+    option :config, aliases: "-c", type: :string, desc: "Config file (default: .boondoc.yml)"
     def serve
-      config = Config.load(options.slice('output', 'config', 'allow_outside_output').transform_keys(&:to_sym))
+      config = Config.load(options.slice("output", "config", "allow_outside_output").transform_keys(&:to_sym))
       Preview.new(config.output_dir, host: options[:host], port: options[:port]) do
         yes?("The gh markdown-preview extension is not installed. Install #{Preview::EXTENSION} now? [y/N]")
       end.start
@@ -81,7 +83,7 @@ module Boondoc
       raise Thor::Error, "boondoc: #{e.message}"
     end
 
-    desc 'version', 'Print the boondoc version'
+    desc "version", "Print the boondoc version"
     def version
       puts Boondoc::VERSION
     end

data/lib/boondoc/config.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Boondoc
   # Options for one run, merged from defaults, `.yardopts`, `.boondoc.yml`, and the command line.
   class Config
-    FILE = '.boondoc.yml'
+    FILE = ".boondoc.yml"
     DEFAULTS = {
-      sources: ['lib/**/*.rb'], exclude: [], output: 'docs', index: 'README.md',
+      sources: ["lib/**/*.rb"], exclude: [], output: "docs", index: "README.md",
       readme: nil, files: [], assets: [], copy_linked_assets: false, title: nil,
       private: false, protected: false, yard_macros: false,
       strict: false, force: false, quiet: false, allow_outside_output: false, yardopts: true
@@ -23,11 +23,11 @@ module Boondoc
     # A test and a description for each type name in {TYPES}.
     CHECKS = {
       list: [->(value) { value.is_a?(String) || (value.is_a?(Array) && value.all?(String)) },
-             'a string or a list of strings'],
-      string: [->(value) { value.is_a?(String) }, 'a string'],
-      optional_string: [->(value) { value.nil? || value.is_a?(String) }, 'a string'],
-      file_or_false: [->(value) { value.nil? || value == false || value.is_a?(String) }, 'a file name or false'],
-      boolean: [->(value) { [true, false].include?(value) }, 'true or false']
+             "a string or a list of strings"],
+      string: [->(value) { value.is_a?(String) }, "a string"],
+      optional_string: [->(value) { value.nil? || value.is_a?(String) }, "a string"],
+      file_or_false: [->(value) { value.nil? || value == false || value.is_a?(String) }, "a file name or false"],
+      boolean: [->(value) { [true, false].include?(value) }, "true or false"]
     }.freeze
 
     attr_reader(*DEFAULTS.keys)
@@ -71,8 +71,9 @@ module Boondoc
       settings = YAML.safe_load_file(path, symbolize_names: true) || {}
       return settings unless settings.key?(:allow_outside_output)
 
-      raise Error, 'allow_outside_output cannot be set in a config file, because the project being ' \
-                   'documented is not trusted to choose it; pass --allow-outside-output on the command line'
+      raise Error,
+        "allow_outside_output cannot be set in a config file, because the project being " \
+        "documented is not trusted to choose it; pass --allow-outside-output on the command line"
     end
     private_class_method :read_file
 
@@ -84,7 +85,7 @@ module Boondoc
     # @raise [Error] on unknown options, or an option of the wrong type
     def initialize(root: Dir.pwd, from_yardopts: nil, **options)
       unknown = options.keys - DEFAULTS.keys
-      raise Error, "unknown option#{'s' if unknown.size > 1}: #{unknown.join(', ')}" if unknown.any?
+      raise Error, "unknown option#{"s" if unknown.size > 1}: #{unknown.join(", ")}" if unknown.any?
 
       @root = File.expand_path(root)
       @yardopts_file = from_yardopts
@@ -135,7 +136,7 @@ module Boondoc
     # @raise [Error] when an explicitly named README does not exist or is outside the project
     def readme_file
       return nil if readme == false
-      return inside_project('README.md') if readme.nil? && File.file?(File.join(root, 'README.md'))
+      return inside_project("README.md") if readme.nil? && File.file?(File.join(root, "README.md"))
       return nil if readme.nil?
       raise Error, "readme not found: #{readme}" unless File.file?(File.expand_path(readme, root))
 
@@ -159,8 +160,8 @@ module Boondoc
 
     def source_split
       @source_split ||= (expand(sources, ruby: true) - expand(exclude, ruby: true))
-                        .reject { |path| excluded_by_yardopts?(path) }
-                        .partition { |path| Containment.inside?(File.expand_path(path, root), root) }
+        .reject { |path| excluded_by_yardopts?(path) }
+        .partition { |path| Containment.inside?(File.expand_path(path, root), root) }
     end
 
     def excluded_by_yardopts?(path)
@@ -170,16 +171,17 @@ module Boondoc
     end
 
     def check_output_inside(path)
-      return if path == root || path.start_with?(File.join(root, ''))
+      return if path == root || path.start_with?(File.join(root, ""))
 
-      raise Error, "output directory #{path} is outside the project (#{root}). A project must not choose where " \
-                   'boondoc writes. To write there anyway, pass --allow-outside-output; that is a security ' \
-                   'risk if you do not trust the project, and it is how docs are kept outside the repository.'
+      raise Error,
+        "output directory #{path} is outside the project (#{root}). A project must not choose where " \
+        "boondoc writes. To write there anyway, pass --allow-outside-output; that is a security " \
+        "risk if you do not trust the project, and it is how docs are kept outside the repository."
     end
 
     def expand(patterns, ruby: false)
       Array(patterns).flat_map do |pattern|
-        pattern = File.join(pattern, '**', '*.rb') if ruby && File.directory?(File.expand_path(pattern, root))
+        pattern = File.join(pattern, "**", "*.rb") if ruby && File.directory?(File.expand_path(pattern, root))
         paths = Dir.glob(pattern, base: root).select { |path| File.file?(File.expand_path(path, root)) }
         paths.map { |path| relative(path) }
       end.uniq.sort
@@ -188,7 +190,7 @@ module Boondoc
     # Paths under the root become relative to it, with `..` segments resolved.
     def relative(path)
       absolute = File.expand_path(path, root)
-      absolute.start_with?(File.join(root, '')) ? absolute.delete_prefix(File.join(root, '')) : path
+      absolute.start_with?(File.join(root, "")) ? absolute.delete_prefix(File.join(root, "")) : path
     end
 
     # Files that are copied into the output must not come from elsewhere on the machine.

data/lib/boondoc/containment.rb

@@ -14,7 +14,7 @@ module Boondoc
     def inside?(path, directory)
       real = File.realpath(path)
       base = File.realpath(directory)
-      real == base || real.start_with?(File.join(base, ''))
+      real == base || real.start_with?(File.join(base, ""))
     rescue SystemCallError
       false
     end
@@ -29,11 +29,11 @@ module Boondoc
     # @return [String, nil] the first component that is a symlink, or nil when
     #   there is none or `path` is not below `directory`
     def symlink_between(path, directory)
-      base = File.join(File.expand_path(directory), '')
+      base = File.join(File.expand_path(directory), "")
       full = File.expand_path(path)
       return nil unless full.start_with?(base)
 
-      parts = full.delete_prefix(base).split('/')
+      parts = full.delete_prefix(base).split("/")
       parts.each_index.map { |count| File.join(base, *parts.first(count + 1)) }.find { |step| File.symlink?(step) }
     end
   end

data/lib/boondoc/context.rb

@@ -16,8 +16,15 @@ module Boondoc
       @path_map = PathMap.new(config, registry)
       @assets = Assets.new(config)
       @stitcher = Stitcher.new(config, assets: assets)
-      @linker = Linker.new(config: config, registry: registry, filter: filter, path_map: path_map,
-                           stitcher: stitcher, assets: assets, reporter: reporter)
+      @linker = Linker.new(
+        config: config,
+        registry: registry,
+        filter: filter,
+        path_map: path_map,
+        stitcher: stitcher,
+        assets: assets,
+        reporter: reporter
+      )
       @meths = {}
       @aliases = {}
     end

data/lib/boondoc/core_constants.rb

@@ -5,19 +5,159 @@ module Boondoc
   # fixed list, because what happens to be loaded in boondoc's own process
   # (Thor, Rake, Boondoc itself) says nothing about the project being documented.
   CORE_CONSTANTS = %w[
-    ArgumentError Array BasicObject Binding Class ClosedQueueError Comparable Complex ConditionVariable Data
-    Dir EOFError Encoding EncodingError Enumerable Enumerator Errno Exception FalseClass Fiber FiberError File
-    FileTest Float FloatDomainError FrozenError GC Hash IO IOError IndexError Integer Interrupt Kernel KeyError
-    LoadError LocalJumpError Marshal MatchData Math Method Module Mutex NameError NilClass NoMatchingPatternError
-    NoMatchingPatternKeyError NoMemoryError NoMethodError NotImplementedError Numeric Object ObjectSpace Pathname
-    Proc Process Queue Ractor Random Range RangeError Rational Refinement Regexp RegexpError Ruby RubyVM
-    RuntimeError ScriptError SecurityError Set Signal SignalException SizedQueue StandardError StopIteration String
-    Struct Symbol SyntaxError SystemCallError SystemExit SystemStackError Thread ThreadError ThreadGroup Time
-    TracePoint TrueClass TypeError UnboundMethod UncaughtThrowError Warning ZeroDivisionError
-    Base64 Benchmark BigDecimal CGI CSV Coverage DRb Date DateTime Delegator Digest ERB Etc Fcntl Fiddle FileUtils
-    Find Forwardable GetoptLong IPAddr IPSocket JSON Logger Monitor MonitorMixin Net Observable Open3 OpenSSL
-    OpenStruct OptionParser PP PStore Psych Racc Readline Reline Resolv Ripper SecureRandom Shellwords
-    SimpleDelegator Singleton Socket StringIO StringScanner Syslog TCPServer TCPSocket Tempfile Timeout Tmpdir
-    TSort UDPSocket UNIXServer UNIXSocket URI WeakRef YAML Zlib
+    ArgumentError
+    Array
+    BasicObject
+    Binding
+    Class
+    ClosedQueueError
+    Comparable
+    Complex
+    ConditionVariable
+    Data
+    Dir
+    EOFError
+    Encoding
+    EncodingError
+    Enumerable
+    Enumerator
+    Errno
+    Exception
+    FalseClass
+    Fiber
+    FiberError
+    File
+    FileTest
+    Float
+    FloatDomainError
+    FrozenError
+    GC
+    Hash
+    IO
+    IOError
+    IndexError
+    Integer
+    Interrupt
+    Kernel
+    KeyError
+    LoadError
+    LocalJumpError
+    Marshal
+    MatchData
+    Math
+    Method
+    Module
+    Mutex
+    NameError
+    NilClass
+    NoMatchingPatternError
+    NoMatchingPatternKeyError
+    NoMemoryError
+    NoMethodError
+    NotImplementedError
+    Numeric
+    Object
+    ObjectSpace
+    Pathname
+    Proc
+    Process
+    Queue
+    Ractor
+    Random
+    Range
+    RangeError
+    Rational
+    Refinement
+    Regexp
+    RegexpError
+    Ruby
+    RubyVM
+    RuntimeError
+    ScriptError
+    SecurityError
+    Set
+    Signal
+    SignalException
+    SizedQueue
+    StandardError
+    StopIteration
+    String
+    Struct
+    Symbol
+    SyntaxError
+    SystemCallError
+    SystemExit
+    SystemStackError
+    Thread
+    ThreadError
+    ThreadGroup
+    Time
+    TracePoint
+    TrueClass
+    TypeError
+    UnboundMethod
+    UncaughtThrowError
+    Warning
+    ZeroDivisionError
+    Base64
+    Benchmark
+    BigDecimal
+    CGI
+    CSV
+    Coverage
+    DRb
+    Date
+    DateTime
+    Delegator
+    Digest
+    ERB
+    Etc
+    Fcntl
+    Fiddle
+    FileUtils
+    Find
+    Forwardable
+    GetoptLong
+    IPAddr
+    IPSocket
+    JSON
+    Logger
+    Monitor
+    MonitorMixin
+    Net
+    Observable
+    Open3
+    OpenSSL
+    OpenStruct
+    OptionParser
+    PP
+    PStore
+    Psych
+    Racc
+    Readline
+    Reline
+    Resolv
+    Ripper
+    SecureRandom
+    Shellwords
+    SimpleDelegator
+    Singleton
+    Socket
+    StringIO
+    StringScanner
+    Syslog
+    TCPServer
+    TCPSocket
+    Tempfile
+    Timeout
+    Tmpdir
+    TSort
+    UDPSocket
+    UNIXServer
+    UNIXSocket
+    URI
+    WeakRef
+    YAML
+    Zlib
   ].freeze
 end

data/lib/boondoc/docstring_parser.rb

@@ -47,7 +47,7 @@ module Boondoc
     end
 
     def continuation?(line)
-      line.strip.empty? || line.start_with?(' ', "\t")
+      line.strip.empty? || line.start_with?(" ", "\t")
     end
 
     def finish_tag
@@ -63,17 +63,17 @@ module Boondoc
 
     def build(name, first, rest)
       case name
-      when 'example'  then Model::Tag.new(tag_name: name, name: first, text: rest)
-      when 'overload' then overload(first, rest)
-      when 'option'   then option(join(first, rest))
-      when 'see'      then see(join(first, rest))
+      when "example"  then Model::Tag.new(tag_name: name, name: first, text: rest)
+      when "overload" then overload(first, rest)
+      when "option"   then option(join(first, rest))
+      when "see"      then see(join(first, rest))
       when *NAMED     then named(name, join(first, rest))
       else typed(name, join(first, rest))
       end
     end
 
     def overload(signature, rest)
-      Model::Tag.new(tag_name: 'overload', signature: signature, docstring: self.class.parse(rest))
+      Model::Tag.new(tag_name: "overload", signature: signature, docstring: self.class.parse(rest))
     end
 
     # `@param name [Types] text` or `@param [Types] name text`
@@ -96,15 +96,21 @@ module Boondoc
       types, text = TypeParser.extract(text.to_s)
       key, text = text.split(/\s+/, 2)
       default = text.to_s[/\A\((.*?)\)\s*/, 1]
-      text = text.to_s.sub(/\A\(.*?\)\s*/, '') if default
-      Model::Tag.new(tag_name: 'option', name: name, types: types, key: key, default: default,
-                     text: text.to_s.strip)
+      text = text.to_s.sub(/\A\(.*?\)\s*/, "") if default
+      Model::Tag.new(
+        tag_name: "option",
+        name: name,
+        types: types,
+        key: key,
+        default: default,
+        text: text.to_s.strip
+      )
     end
 
     # `@see reference text`
     def see(text)
       name, text = text.split(/\s+/, 2)
-      Model::Tag.new(tag_name: 'see', name: name, text: text.to_s.strip)
+      Model::Tag.new(tag_name: "see", name: name, text: text.to_s.strip)
     end
 
     def join(first, rest)
@@ -113,7 +119,7 @@ module Boondoc
 
     def dedent(lines)
       indent = lines.reject { |line| line.strip.empty? }.map { |line| line[/\A[ \t]*/].size }.min || 0
-      lines.map { |line| line[indent..] || '' }.join("\n").strip
+      lines.map { |line| line[indent..] || "" }.join("\n").strip
     end
   end
 end

data/lib/boondoc/frontend/comments.rb

@@ -23,7 +23,7 @@ module Boondoc
       # @param line [Integer]
       # @return [Boolean] true when the line carries a trailing `# :nodoc:`
       def nodoc?(line)
-        @trailing[line].to_s.include?(':nodoc:')
+        @trailing[line].to_s.include?(":nodoc:")
       end
 
       # @return [Array<Integer>] last lines of comment blocks that contain YARD directives
@@ -58,9 +58,9 @@ module Boondoc
       end
 
       def clean(lines)
-        lines = lines.grep_v(IGNORED).map { |line| line.delete_prefix('#').rstrip }
+        lines = lines.grep_v(IGNORED).map { |line| line.delete_prefix("#").rstrip }
         indent = lines.reject(&:empty?).map { |line| line[/\A */].size }.min || 0
-        lines.map { |line| line[indent..] || '' }.join("\n")
+        lines.map { |line| line[indent..] || "" }.join("\n")
       end
     end
   end

data/lib/boondoc/frontend/prism_parser.rb

@@ -21,7 +21,7 @@ module Boondoc
       # @param source [String] Ruby source
       # @param label [String] file name to record on objects
       # @return [void]
-      def parse(source, label = '(source)')
+      def parse(source, label = "(source)")
         result = ::Prism.parse(source)
         return syntax_error(label, result) if result.failure?