boondoc 0.1.0 → 0.2.0

data/lib/boondoc/yardopts.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'shellwords'
+require "shellwords"
 
 module Boondoc
   # The part of a project's `.yardopts` that Boondoc understands.
@@ -15,21 +15,48 @@ module Boondoc
   #   Boondoc::Yardopts.parse('--title Foo -o doc lib - CHANGELOG.md').settings
   #   # => { title: "Foo", sources: ["lib"], files: ["CHANGELOG.md"] }
   class Yardopts
-    FILE = '.yardopts'
+    FILE = ".yardopts"
     # Long options of the yard gem that take an argument.
     ARGUMENT_OPTIONS = %w[
-      --load --plugin --db --exclude --api --no-api --hide-api --default-return --query --title
-      --readme --main --files --asset --output-dir --markup --markup-provider --charset --template
-      --template-path --format --locale --po-dir --tag --type-tag --type-name-tag --name-tag
-      --title-tag --hide-tag --transitive-tag --non-transitive-tag
+      --load
+      --plugin
+      --db
+      --exclude
+      --api
+      --no-api
+      --hide-api
+      --default-return
+      --query
+      --title
+      --readme
+      --main
+      --files
+      --asset
+      --output-dir
+      --markup
+      --markup-provider
+      --charset
+      --template
+      --template-path
+      --format
+      --locale
+      --po-dir
+      --tag
+      --type-tag
+      --type-name-tag
+      --name-tag
+      --title-tag
+      --hide-tag
+      --transitive-tag
+      --non-transitive-tag
     ].freeze
     # Long options whose argument is optional; it is the next token unless that starts with `-`.
     OPTIONAL_ARGUMENT_OPTIONS = %w[--use-cache --yardopts --no-yardopts --embed-mixin].freeze
     SHORT_ARGUMENT_OPTIONS = {
-      'b' => '--db', 'e' => '--load', 'o' => '--output-dir', 'm' => '--markup', 'M' => '--markup-provider',
-      't' => '--template', 'p' => '--template-path', 'f' => '--format', 'r' => '--readme'
+      "b" => "--db", "e" => "--load", "o" => "--output-dir", "m" => "--markup", "M" => "--markup-provider",
+      "t" => "--template", "p" => "--template-path", "f" => "--format", "r" => "--readme"
     }.freeze
-    SHORT_OPTIONAL_ARGUMENT_OPTIONS = { 'c' => '--use-cache' }.freeze
+    SHORT_OPTIONAL_ARGUMENT_OPTIONS = { "c" => "--use-cache" }.freeze
     NON_RUBY_SOURCE = /\.(?:c|cc|cpp|cxx|h|hpp|y)\z/
     # How long a pattern from `--exclude` may take to match one path.
     REGEXP_TIMEOUT = 1.0
@@ -86,9 +113,9 @@ module Boondoc
       notes = []
       if output_dir && File.expand_path(output_dir, root) != File.expand_path(output, root)
         notes << "ignoring --output-dir #{output_dir} from #{FILE}; writing to #{output} " \
-                 '(set output in .boondoc.yml or pass -o to change)'
+                 "(set output in .boondoc.yml or pass -o to change)"
       end
-      notes << "ignoring from #{FILE}: #{ignored.join(', ')}" if ignored.any?
+      notes << "ignoring from #{FILE}: #{ignored.join(", ")}" if ignored.any?
       notes
     end
 
@@ -99,9 +126,9 @@ module Boondoc
       extra = false
       until tokens.empty?
         token = tokens.shift
-        if token == '-' then extra = true
+        if token == "-" then extra = true
         elsif extra then @files << token
-        elsif token.start_with?('-') then read_option(token, tokens)
+        elsif token.start_with?("-") then read_option(token, tokens)
         else add_source(token)
         end
       end
@@ -116,36 +143,36 @@ module Boondoc
     def takes_argument?(name, rest)
       return false if rest.empty?
 
-      ARGUMENT_OPTIONS.include?(name) || (OPTIONAL_ARGUMENT_OPTIONS.include?(name) && !rest.first.start_with?('-'))
+      ARGUMENT_OPTIONS.include?(name) || (OPTIONAL_ARGUMENT_OPTIONS.include?(name) && !rest.first.start_with?("-"))
     end
 
     # @return [Array(String, String)] the canonical long name (or the token itself) and its inline value, if any
     def split_option(token)
-      return token.split('=', 2).values_at(0, 1) if token.start_with?('--')
+      return token.split("=", 2).values_at(0, 1) if token.start_with?("--")
 
       letter = token[1]
       long = SHORT_ARGUMENT_OPTIONS[letter] || SHORT_OPTIONAL_ARGUMENT_OPTIONS[letter]
       return [token, nil] unless long
 
-      [long, token.length > 2 ? token[2..] : nil]
+      [long, (token.length > 2) ? token[2..] : nil]
     end
 
     def apply(name, value)
       case name
-      when '--output-dir' then @output_dir = value
-      when '--title' then @settings[:title] = value
-      when '--readme', '--main' then @settings[:readme] = value
-      when '--files', '--asset' then add_list(name, value)
-      when '--private', '--protected' then @settings[name.delete_prefix('--').to_sym] = true
-      when '--exclude' then add_exclude(value)
+      when "--output-dir" then @output_dir = value
+      when "--title" then @settings[:title] = value
+      when "--readme", "--main" then @settings[:readme] = value
+      when "--files", "--asset" then add_list(name, value)
+      when "--private", "--protected" then @settings[name.delete_prefix("--").to_sym] = true
+      when "--exclude" then add_exclude(value)
       else @ignored << name
       end
     end
 
     # `--files` and `--asset` take comma-separated lists, as YARD does for `--files`.
     def add_list(name, value)
-      list = name == '--asset' ? @assets : @files
-      list.concat(value.to_s.split(','))
+      list = (name == "--asset") ? @assets : @files
+      list.concat(value.to_s.split(","))
     end
 
     def add_source(glob)

data/lib/boondoc.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'prism'
+require "prism"
 
-require_relative 'boondoc/version'
+require_relative "boondoc/version"
 
 # Markdown-only API documentation for Ruby.
 #
@@ -14,35 +14,35 @@ module Boondoc
   class Error < StandardError; end
 end
 
-require_relative 'boondoc/reporter'
-require_relative 'boondoc/containment'
-require_relative 'boondoc/yardopts'
-require_relative 'boondoc/config'
-require_relative 'boondoc/markdown'
-require_relative 'boondoc/model/docstring'
-require_relative 'boondoc/model/code_object'
-require_relative 'boondoc/model/registry'
-require_relative 'boondoc/type_parser'
-require_relative 'boondoc/docstring_parser'
-require_relative 'boondoc/frontend/comments'
-require_relative 'boondoc/frontend/visitor'
-require_relative 'boondoc/frontend/prism_parser'
-require_relative 'boondoc/yard_bridge'
-require_relative 'boondoc/references'
-require_relative 'boondoc/filter'
-require_relative 'boondoc/path_map'
-require_relative 'boondoc/links'
-require_relative 'boondoc/assets'
-require_relative 'boondoc/stitcher'
-require_relative 'boondoc/core_constants'
-require_relative 'boondoc/linker'
-require_relative 'boondoc/context'
-require_relative 'boondoc/renderer/base'
-require_relative 'boondoc/renderer/docstring'
-require_relative 'boondoc/renderer/method_section'
-require_relative 'boondoc/renderer/namespace_page'
-require_relative 'boondoc/renderer/index'
-require_relative 'boondoc/writer'
-require_relative 'boondoc/generator'
-require_relative 'boondoc/preview'
-require_relative 'boondoc/cli'
+require_relative "boondoc/reporter"
+require_relative "boondoc/containment"
+require_relative "boondoc/yardopts"
+require_relative "boondoc/config"
+require_relative "boondoc/markdown"
+require_relative "boondoc/model/docstring"
+require_relative "boondoc/model/code_object"
+require_relative "boondoc/model/registry"
+require_relative "boondoc/type_parser"
+require_relative "boondoc/docstring_parser"
+require_relative "boondoc/frontend/comments"
+require_relative "boondoc/frontend/visitor"
+require_relative "boondoc/frontend/prism_parser"
+require_relative "boondoc/yard_bridge"
+require_relative "boondoc/references"
+require_relative "boondoc/filter"
+require_relative "boondoc/path_map"
+require_relative "boondoc/links"
+require_relative "boondoc/assets"
+require_relative "boondoc/stitcher"
+require_relative "boondoc/core_constants"
+require_relative "boondoc/linker"
+require_relative "boondoc/context"
+require_relative "boondoc/renderer/base"
+require_relative "boondoc/renderer/docstring"
+require_relative "boondoc/renderer/method_section"
+require_relative "boondoc/renderer/namespace_page"
+require_relative "boondoc/renderer/index"
+require_relative "boondoc/writer"
+require_relative "boondoc/generator"
+require_relative "boondoc/preview"
+require_relative "boondoc/cli"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boondoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Sharp
@@ -13,30 +13,36 @@ dependencies:
   name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
 description: 'boondoc reads YARD-style tags from Ruby source using Prism and writes
   plain GitHub-flavored markdown: one file per class or module, with working relative
   links, plus your README and guides stitched in. No HTML, no site to deploy and host.'
@@ -92,7 +98,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/joe-sharp/boondoc
-  source_code_uri: https://github.com/joe-sharp/boondoc/tree/v0.1.0
+  source_code_uri: https://github.com/joe-sharp/boondoc/tree/v0.2.0
   bug_tracker_uri: https://github.com/joe-sharp/boondoc/issues
   changelog_uri: https://github.com/joe-sharp/boondoc/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'