yard-relative_markdown_links 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b7c7cab3b827823c2078b115951199a31f73e9950d5a59c8ef3934e722a369
-  data.tar.gz: 34a0cacb3db651d342c1dca6df506bf71db93b63debc9a8bbae247743dd2d5d2
+  metadata.gz: 5d5f120274d159ff20d79282035ec053b5ce4d2fb31773bb9b1b7a94882e756f
+  data.tar.gz: bf7638988dbae4fc00e9cb165335f83127528ee7a9f1151de1439b458797cb6d
 SHA512:
-  metadata.gz: 7b011be39b3c63128218ea975e62dd4ee94c126582f99a2291dfe6674c0b80f807844d1b47f40844862aa17b81ddbd4333019cba2b6490d580075fad0a5d0ef8
-  data.tar.gz: c53087dbd10685c87f2ed4c1770942f2679fe444eb218dff93e9c46218c076861160d6b063cbe6d9ef7f9bd1599117508112aee22d30e2b6dc4bf77b6596ebaa
+  metadata.gz: 41e98baedb8370f27d2f274281347ffb84d1aace580ef386682bce4da37a321247edb87941bb9b2cf629b7dabde0aadc40b3569ef6c73ba554915ca4e63ea6b0
+  data.tar.gz: ac6cf4464c43a5f83855a2e6b6c548d4c16ca7d4bff88d6bfd2900379edf6073502f259fa51c4814fee20d6ffe215aa570978423c36524e97b66f37686305b84

data/CHANGELOG.md

@@ -8,6 +8,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 No notable changes.
 
+## [0.6.0] - 2025-06-14
+### Changed
+* Don't `require "yard"` to avoid a circular require ([#292](https://github.com/haines/yard-relative_markdown_links/pull/292))
+* Require Ruby ≥ 3.2 ([#268](https://github.com/haines/yard-relative_markdown_links/pull/268), [#288](https://github.com/haines/yard-relative_markdown_links/pull/288))
+* Test against Ruby 3.3 ([#212](https://github.com/haines/yard-relative_markdown_links/pull/212))
+* Test against Ruby 3.4 ([#268](https://github.com/haines/yard-relative_markdown_links/pull/268))
+
+## [0.5.0] - 2023-06-12
+### Changed
+* Require Ruby ≥ 3.0 ([#175](https://github.com/haines/yard-relative_markdown_links/pull/175))
+* Test against Ruby 3.1 ([#107](https://github.com/haines/yard-relative_markdown_links/pull/107))
+* Test against Ruby 3.2 ([#175](https://github.com/haines/yard-relative_markdown_links/pull/175))
+* Require Nokogiri ≥ 1.14.3 ([#175](https://github.com/haines/yard-relative_markdown_links/pull/175))
+
+### Fixed
+* Handle links generated by recent versions of RDoc ([#175](https://github.com/haines/yard-relative_markdown_links/pull/175))
+
 ## [0.4.1] - 2021-11-15
 ### Changed
 * Require MFA to publish gem ([#92](https://github.com/haines/yard-relative_markdown_links/pull/92))
@@ -37,7 +54,9 @@ No notable changes.
 ### Added
 - A YARD plugin to allow relative links between Markdown files ([#1](https://github.com/haines/yard-relative_markdown_links/pull/1))
 
-[Unreleased]: https://github.com/haines/yard-relative_markdown_links/compare/v0.4.1...HEAD
+[Unreleased]: https://github.com/haines/yard-relative_markdown_links/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/haines/yard-relative_markdown_links/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/haines/yard-relative_markdown_links/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/haines/yard-relative_markdown_links/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/haines/yard-relative_markdown_links/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/haines/yard-relative_markdown_links/compare/v0.2.0...v0.3.0

data/lib/yard/relative_markdown_links/version.rb

@@ -3,6 +3,6 @@
 module YARD
   module RelativeMarkdownLinks
     # Current version of the yard-relative_markdown_links gem.
-    VERSION = "0.4.1"
+    VERSION = "0.6.0"
   end
 end

data/lib/yard/relative_markdown_links.rb

@@ -2,14 +2,14 @@
 
 require "nokogiri"
 require "uri"
-require "yard"
-require "yard/relative_markdown_links/version"
+
+require_relative "relative_markdown_links/version"
 
 module YARD # rubocop:disable Style/Documentation
   # GitHub and YARD render Markdown files differently. In particular, relative
   # links between Markdown files that work in GitHub don't work in YARD.
   # For example, if you have `[hello](FOO.md)` in your README, YARD renders it
-  # as `<a href="FOO.md">hello</a>`, creating a broken link in your docs.
+  # as `<a href="FOO_md.html">hello</a>`, creating a broken link in your docs.
   #
   # With this plugin enabled, you'll get `<a href="file.FOO.html">hello</a>`
   # instead, which correctly links through to the rendered HTML file.
@@ -18,14 +18,35 @@ module YARD # rubocop:disable Style/Documentation
     # @param [String] text the HTML fragment in which to resolve links.
     # @return [String] HTML with relative links to extra files converted to `{file:}` links.
     def resolve_links(text)
+      return super unless options.files
+
+      filenames = options.files.to_set(&:filename)
+
+      rdoc_filenames = filenames.filter_map { |filename|
+        # https://github.com/ruby/rdoc/blob/0e060c69f51ec4a877e5cde69b31d47eaeb2a2b9/lib/rdoc/markup/to_html.rb#L364-L366
+        match = %r{\A(?<dirname>(?:[^/#]*/)*+)(?<basename>[^/#]+)\.(?<ext>rb|rdoc|md)\z}i.match(filename)
+        next unless match
+
+        ["#{match[:dirname]}#{match[:basename].tr('.', '_')}_#{match[:ext]}.html", filename]
+      }.to_h
+
       html = Nokogiri::HTML.fragment(text)
+
       html.css("a[href]").each do |link|
         href = URI(link["href"])
+        next unless href.relative?
 
-        next unless href.relative? && options.files.map(&:filename).include?(href.path)
+        if filenames.include?(href.path)
+          link.replace "{file:#{href} #{link.inner_html}}"
+          next
+        end
+
+        href.path = rdoc_filenames[href.path]
+        next unless href.path && filenames.include?(href.path)
 
         link.replace "{file:#{href} #{link.inner_html}}"
       end
+
       super(html.to_s)
     end
   end

data/yard-relative_markdown_links.gemspec

@@ -16,7 +16,16 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/haines/yard-relative_markdown_links"
   spec.license = "MIT"
 
-  spec.files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0").reject { |path| path.match(%r{^test/}) } }
+  spec.files = Dir[
+    "lib/**/*.rb",
+    ".yardopts",
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "LICENSE.md",
+    "README.md",
+    "yard-relative_markdown_links.gemspec"
+  ]
+
   spec.require_paths = ["lib"]
 
   spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
@@ -27,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["yard.run"] = "yri"
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 3.2"
 
-  spec.add_dependency "nokogiri", "~> 1.8"
+  spec.add_dependency "nokogiri", ">= 1.14.3", "< 2"
 end

metadata

@@ -1,54 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: yard-relative_markdown_links
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Haines
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.14.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.8'
-description:
+        version: '2'
 email:
 - andrew@haines.org.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/pull-request.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
-- Rakefile
-- bin/bundle
-- bin/console
-- bin/install-bundler
-- bin/rake
-- bin/setup
 - lib/yard-relative_markdown_links.rb
 - lib/yard/relative_markdown_links.rb
 - lib/yard/relative_markdown_links/version.rb
@@ -64,7 +55,6 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/haines/yard-relative_markdown_links
   yard.run: yri
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A YARD plugin to allow relative links between Markdown files
 test_files: []

data/.github/dependabot.yml

@@ -1,16 +0,0 @@
-version: 2
-
-updates:
-  - package-ecosystem: bundler
-    directory: /
-    schedule:
-      interval: weekly
-    reviewers:
-      - haines
-
-  - package-ecosystem: github-actions
-    directory: /
-    schedule:
-      interval: weekly
-    reviewers:
-      - haines

data/.github/workflows/pull-request.yml

@@ -1,62 +0,0 @@
-name: pull-request
-
-on:
-  - pull_request
-
-jobs:
-  test:
-    strategy:
-      matrix:
-        ruby:
-          - "2.5"
-          - "2.6"
-          - "2.7"
-          - "3.0"
-
-    name: Ruby ${{ matrix.ruby }}
-
-    runs-on: ubuntu-latest
-
-    container:
-      image: ruby:${{ matrix.ruby }}-alpine
-
-    env:
-      BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
-
-    steps:
-      - name: Install dependencies
-        run: apk add build-base git tar
-
-      - name: Check out source code
-        uses: actions/checkout@v2
-
-      - name: Install Bundler
-        run: bin/install-bundler
-
-      - name: Compute cache key
-        id: cache-key
-        run: |
-          source /etc/os-release
-          printf \
-            "::set-output name=cache-key::alpine-%s-ruby-%s\n" \
-            "${VERSION_ID}" \
-            "${RUBY_VERSION}"
-
-      - name: Cache gems
-        uses: actions/cache@v2
-        with:
-          key: ${{ steps.cache-key.outputs.cache-key }}-gems-${{ hashFiles('Gemfile.lock') }}
-          path: vendor/bundle
-
-      - name: Install gems
-        run: bin/bundle install
-        env:
-          BUNDLE_FROZEN: true
-          BUNDLE_JOBS: 4
-          BUNDLE_RETRY: 3
-
-      - name: Run RuboCop
-        run: bin/rake rubocop
-
-      - name: Run tests
-        run: bin/rake test

data/.gitignore

@@ -1,4 +0,0 @@
-/.bundle/
-/.yardoc/
-/doc/
-/pkg/

data/.rubocop.yml

@@ -1,53 +0,0 @@
-require:
-  - rubocop-minitest
-  - rubocop-rake
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.5
-  Exclude:
-    - bin/bundle
-    - bin/rake
-    - vendor/bundle/**/*
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Naming/FileName:
-  Exclude:
-    - lib/yard-relative_markdown_links.rb
-
-Style/BlockDelimiters:
-  EnforcedStyle: semantic
-
-Style/Documentation:
-  Exclude:
-    - test/**/*
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashSyntax:
-  Exclude:
-    - Rakefile
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/Lambda:
-  EnforcedStyle: literal
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/WordArray:
-  EnforcedStyle: brackets

data/.ruby-version

@@ -1 +0,0 @@
-3.0.2

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "bundler"
-gem "minitest"
-gem "pry"
-gem "rake"
-gem "rubocop"
-gem "rubocop-minitest"
-gem "rubocop-rake"
-gem "yard"

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    yard-relative_markdown_links (0.4.1)
-      nokogiri (~> 1.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
-      racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    racc (1.5.2)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (1.23.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
-    rubocop-minitest (0.16.0)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-    yard (0.9.26)
-
-PLATFORMS
-  ruby
-  x86_64-darwin-20
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  minitest
-  pry
-  rake
-  rubocop
-  rubocop-minitest
-  rubocop-rake
-  yard
-  yard-relative_markdown_links!
-
-BUNDLED WITH
-   2.2.31

data/Rakefile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rubocop/rake_task"
-require "yard"
-
-Rake::TestTask.new do |task|
-  task.test_files = FileList["test/**/*_test.rb"]
-end
-
-RuboCop::RakeTask.new
-
-desc "Generate documentation"
-YARD::Rake::YardocTask.new :doc
-CLOBBER << "doc/"
-
-task :default => [:doc, :rubocop, :test]

data/bin/bundle

@@ -1,105 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'bundle' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "rubygems"
-
-m = Module.new do
-    module_function
-
-  def invoked_as_script?
-    File.expand_path($0) == File.expand_path(__FILE__)
-  end
-
-  def env_var_version
-    ENV["BUNDLER_VERSION"]
-  end
-
-  def cli_arg_version
-    return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
-    bundler_version = nil
-    update_index = nil
-    ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
-        bundler_version = a
-      end
-      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1 || ">= 0.a"
-      update_index = i
-    end
-    bundler_version
-  end
-
-  def gemfile
-    gemfile = ENV["BUNDLE_GEMFILE"]
-    return gemfile if gemfile && !gemfile.empty?
-
-    File.expand_path("../../Gemfile", __FILE__)
-  end
-
-  def lockfile
-    lockfile =
-      case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
-      else "#{gemfile}.lock"
-      end
-    File.expand_path(lockfile)
-  end
-
-  def lockfile_version
-    return unless File.file?(lockfile)
-    lockfile_contents = File.read(lockfile)
-    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
-    Regexp.last_match(1)
-  end
-
-  def bundler_version
-    @bundler_version ||= begin
-      env_var_version || cli_arg_version ||
-        lockfile_version || "#{Gem::Requirement.default}.a"
-    end
-  end
-
-  def load_bundler!
-    ENV["BUNDLE_GEMFILE"] ||= gemfile
-
-    # must dup string for RG < 1.8 compatibility
-    activate_bundler(bundler_version.dup)
-  end
-
-  def activate_bundler(bundler_version)
-    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
-      bundler_version = "< 2"
-    end
-    gem_error = activation_error_handling do
-      gem "bundler", bundler_version
-    end
-    return if gem_error.nil?
-    require_error = activation_error_handling do
-      require "bundler/version"
-    end
-    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
-    exit 42
-  end
-
-  def activation_error_handling
-    yield
-    nil
-  rescue StandardError, LoadError => e
-    e
-  end
-end
-
-m.load_bundler!
-
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "yard/relative_markdown_links"
-
-require "pry"
-Pry.start

data/bin/install-bundler

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-Gem.install "bundler", Gem::BundlerVersionFinder.bundler_version

data/bin/rake

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-bundle install