yard-relative_markdown_links 0.1.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 241fab84ccb581bb448a4982b49250ee49b522ea735f59a51b12075b62327951
-  data.tar.gz: 46c1e2924b1022be33a4285392a7919f2f50c9805b27af78de92899e73c1e1d4
+  metadata.gz: 80b7c7cab3b827823c2078b115951199a31f73e9950d5a59c8ef3934e722a369
+  data.tar.gz: 34a0cacb3db651d342c1dca6df506bf71db93b63debc9a8bbae247743dd2d5d2
 SHA512:
-  metadata.gz: ee7f97e58019d1cc899eca68bb052a8f7ed75b5dfdb70c67442a826a5d211ef89e1439d60750abd21df038f20079d606c14bf3b2c8029ed32cc1abf890b5ee58
-  data.tar.gz: 635a2aec1be2c4576d6a098aeb55f790070d4d32ef921b6ca9499ea893899179a5dcc0a5812581d49ccddc9467e6d8e442e937c9aa92ec2d5ae0fd90af4b9520
+  metadata.gz: 7b011be39b3c63128218ea975e62dd4ee94c126582f99a2291dfe6674c0b80f807844d1b47f40844862aa17b81ddbd4333019cba2b6490d580075fad0a5d0ef8
+  data.tar.gz: c53087dbd10685c87f2ed4c1770942f2679fe444eb218dff93e9c46218c076861160d6b063cbe6d9ef7f9bd1599117508112aee22d30e2b6dc4bf77b6596ebaa

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,62 @@
+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/.rubocop.yml

@@ -1,16 +1,25 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.5
   Exclude:
     - bin/bundle
     - bin/rake
     - vendor/bundle/**/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
+Naming/FileName:
+  Exclude:
+    - lib/yard-relative_markdown_links.rb
+
 Style/BlockDelimiters:
   EnforcedStyle: semantic
 
@@ -18,10 +27,19 @@ Style/Documentation:
   Exclude:
     - test/**/*
 
+Style/HashEachMethods:
+  Enabled: true
+
 Style/HashSyntax:
   Exclude:
     - Rakefile
 
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/Lambda:
   EnforcedStyle: literal
 

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+No notable changes.
+
+## [0.4.1] - 2021-11-15
+### Changed
+* Require MFA to publish gem ([#92](https://github.com/haines/yard-relative_markdown_links/pull/92))
+
+## [0.4.0] - 2021-01-29
+### Changed
+* Require Ruby ≥ 2.5 ([#40](https://github.com/haines/yard-relative_markdown_links/pull/40))
+* Test against Ruby 3.0 ([#41](https://github.com/haines/yard-relative_markdown_links/pull/41))
+
+## [0.3.0] - 2020-07-26
+### Added
+- Support for relative links to all extra files, not just markdown ([#9](https://github.com/haines/yard-relative_markdown_links/pull/9))
+
+## [0.2.0] - 2020-03-06
+### Changed
+- Stop testing against old Rubies and upgrade dependencies ([#6](https://github.com/haines/yard-relative_markdown_links/pull/6))
+
+## [0.1.2] - 2018-06-11
+### Changed
+- Fix documentation ([#3](https://github.com/haines/yard-relative_markdown_links/pull/3))
+
+## [0.1.1] - 2018-06-11
+### Changed
+- Fix error on plugin load ([#2](https://github.com/haines/yard-relative_markdown_links/pull/2))
+
+## [0.1.0] - 2018-06-11
+### 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
+[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
+[0.2.0]: https://github.com/haines/yard-relative_markdown_links/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/haines/yard-relative_markdown_links/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/haines/yard-relative_markdown_links/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/haines/yard-relative_markdown_links/compare/51b60cc1664a807cf32742a61b000a6a30da89fd...v0.1.0

data/Gemfile

@@ -3,3 +3,12 @@
 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,52 +1,69 @@
 PATH
   remote: .
   specs:
-    yard-relative_markdown_links (0.1.2)
-      nokogiri (~> 1.8.1)
+    yard-relative_markdown_links (0.4.1)
+      nokogiri (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    coderay (1.1.2)
-    jaro_winkler (1.5.1)
-    method_source (0.9.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    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 (12.3.1)
-    rubocop (0.57.1)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.23.0)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      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.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.4.0)
-    yard (0.9.14)
+      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 (~> 1.16)
-  minitest (~> 5.11)
-  pry (~> 0.11)
-  rake (~> 12.1)
-  rubocop (~> 0.57.1)
-  yard (~> 0.9)
+  bundler
+  minitest
+  pry
+  rake
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+  yard
   yard-relative_markdown_links!
 
 BUNDLED WITH
-   1.16.2
+   2.2.31

data/README.md

@@ -1,9 +1,15 @@
 # YARD::RelativeMarkdownLinks
 
+[![Docs](https://img.shields.io/badge/docs-github.io-blue.svg?style=flat-square)](https://haines.github.io/yard-relative_markdown_links/)
+[![Gem](https://img.shields.io/gem/v/yard-relative_markdown_links.svg?style=flat-square)](https://rubygems.org/gems/yard-relative_markdown_links)
+[![GitHub](https://img.shields.io/badge/github-haines%2Fyard--relative__markdown__links-blue.svg?style=flat-square)](https://github.com/haines/yard-relative_markdown_links)
+[![License](https://img.shields.io/github/license/haines/yard-relative_markdown_links.svg?style=flat-square)](https://github.com/haines/yard-relative_markdown_links/blob/main/LICENSE.md)
+
+
 A [YARD](https://yardoc.org) plugin to allow relative links between Markdown files.
 
 GitHub and YARD render Markdown files differently.
-In particular, relative links between Markdown files that work in GitHub don't work in YARD.
+In particular, relative links in 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.
 
 With this plugin enabled, you'll get `<a href="file.FOO.html">hello</a>` instead, which correctly links through to the rendered HTML file.
@@ -46,6 +52,8 @@ To include all Markdown files in your project, add the following lines to the en
 **/*.md
 ```
 
+If you include other types of file, relative links to those files from Markdown will work as well.
+
 
 ## Development
 

data/bin/install-bundler

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

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.1.2"
+    VERSION = "0.4.1"
   end
 end

data/lib/yard/relative_markdown_links.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "uri"
 require "yard"
 require "yard/relative_markdown_links/version"
 
@@ -13,14 +14,16 @@ module YARD # rubocop:disable Style/Documentation
   # With this plugin enabled, you'll get `<a href="file.FOO.html">hello</a>`
   # instead, which correctly links through to the rendered HTML file.
   module RelativeMarkdownLinks
-    # Resolves relative links to Markdown files.
+    # Resolves relative links from Markdown files.
     # @param [String] text the HTML fragment in which to resolve links.
-    # @return [String] HTML with relative links to Markdown files converted to `{file:}` links.
+    # @return [String] HTML with relative links to extra files converted to `{file:}` links.
     def resolve_links(text)
       html = Nokogiri::HTML.fragment(text)
       html.css("a[href]").each do |link|
         href = URI(link["href"])
-        next unless href.relative? && markup_for_file(nil, href.path) == :markdown
+
+        next unless href.relative? && options.files.map(&:filename).include?(href.path)
+
         link.replace "{file:#{href} #{link.inner_html}}"
       end
       super(html.to_s)

data/yard-relative_markdown_links.gemspec

@@ -19,14 +19,15 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0").reject { |path| path.match(%r{^test/}) } }
   spec.require_paths = ["lib"]
 
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://haines.github.io/yard-relative_markdown_links/"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["yard.run"] = "yri"
 
-  spec.add_dependency "nokogiri", "~> 1.8.1"
+  spec.required_ruby_version = ">= 2.5"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "minitest", "~> 5.11"
-  spec.add_development_dependency "pry", "~> 0.11"
-  spec.add_development_dependency "rake", "~> 12.1"
-  spec.add_development_dependency "rubocop", "~> 0.57.1"
-  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_dependency "nokogiri", "~> 1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-relative_markdown_links
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrew Haines
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,110 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.57.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.57.1
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: 
+        version: '1.8'
+description:
 email:
 - andrew@haines.org.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/pull-request.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -128,6 +46,7 @@ files:
 - Rakefile
 - bin/bundle
 - bin/console
+- bin/install-bundler
 - bin/rake
 - bin/setup
 - lib/yard-relative_markdown_links.rb
@@ -138,8 +57,14 @@ homepage: https://github.com/haines/yard-relative_markdown_links
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/haines/yard-relative_markdown_links/issues
+  changelog_uri: https://github.com/haines/yard-relative_markdown_links/blob/main/CHANGELOG.md
+  documentation_uri: https://haines.github.io/yard-relative_markdown_links/
+  homepage_uri: https://github.com/haines/yard-relative_markdown_links
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/haines/yard-relative_markdown_links
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,16 +72,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.31
+signing_key:
 specification_version: 4
 summary: A YARD plugin to allow relative links between Markdown files
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5