yard-relative_markdown_links 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08a3042106a441008993198b7023f440110ab8717ada00cf0047687abad61b4
-  data.tar.gz: bee1ae647802e524aa6b3e9eef92acaa43bed7e84fe785f81e769ad7d0f75466
+  metadata.gz: a1ba604ffff07a62d9a4d07e6e56ad6865d8752a727032e13e46cb08404599cd
+  data.tar.gz: 656f0f6c43e6d766f1c7bb6b3df110efae719b8e74e9e9877b1f0908e698db5a
 SHA512:
-  metadata.gz: bf2b2c96447c81369390515b4b9e666034031bfc796c15fee923653e53acf6c36fa574ceed6ae93d2655bcebc5c6b14fad0cc628741c29531a43f1a4be844d47
-  data.tar.gz: 466b92f58a7b7dc2878692fee6ce9e08e6d881f045832d8d59a95588630c652e6b39f55de92a052f2681ab45a6a9ed00bc3b32dc062de4961b8c38c0c3355052
+  metadata.gz: 459e633a68b4a588370cbe7b18ff64742d99f4d73a59afa5e708f62cf5bd466b25192b1e23f8592e514a7045a27b3f28e5377e119f540a168cba0774a3f11198
+  data.tar.gz: e8c0f800b34e8704f6ffe385a047108eb33d6a7da993e4b7be6e70aebdee5161285f0022d936cadeafc46a03683aeb56cd511295d05102fdd6d87c8a77abda18

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

@@ -0,0 +1,61 @@
+name: pull-request
+
+on:
+  - pull_request
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+
+    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
+
+      - 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@v1
+        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,11 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.5
   Exclude:
     - bin/bundle
     - bin/rake
     - vendor/bundle/**/*
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/MethodLength:

data/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.7.1

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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))
@@ -23,7 +27,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### 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.2.0...HEAD
+[Unreleased]: https://github.com/haines/yard-relative_markdown_links/compare/v0.3.0...HEAD
+[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

data/Gemfile

@@ -3,3 +3,10 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "bundler"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop"
+gem "yard"

data/Gemfile.lock

@@ -1,51 +1,54 @@
 PATH
   remote: .
   specs:
-    yard-relative_markdown_links (0.2.0)
+    yard-relative_markdown_links (0.3.0)
       nokogiri (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    coderay (1.1.2)
-    jaro_winkler (1.5.4)
-    method_source (0.9.2)
+    ast (2.4.1)
+    coderay (1.1.3)
+    method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nokogiri (1.10.9)
+    minitest (5.14.1)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.0.4)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
-    yard (0.9.24)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1)
-  minitest (~> 5.11)
-  pry (~> 0.11)
-  rake (~> 12.1)
-  rubocop (~> 0.80.1)
-  yard (~> 0.9)
+  bundler
+  minitest
+  pry
+  rake
+  rubocop
+  yard
   yard-relative_markdown_links!
 
 BUNDLED WITH

data/README.md

@@ -3,14 +3,13 @@
 [![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/master/LICENSE.md)
-[![Travis](https://img.shields.io/travis/haines/yard-relative_markdown_links.svg?style=flat-square)](https://travis-ci.org/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.
@@ -53,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.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "uri"
 require "yard"
 require "yard/relative_markdown_links/version"
 
@@ -13,14 +14,15 @@ 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

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.2.0"
+    VERSION = "0.3.0"
   end
 end

data/yard-relative_markdown_links.gemspec

@@ -20,18 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  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["source_code_uri"] = spec.homepage
   spec.metadata["yard.run"] = "yri"
 
   spec.add_dependency "nokogiri", "~> 1.8"
-
-  spec.add_development_dependency "bundler", "~> 2.1"
-  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.80.1"
-  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-relative_markdown_links
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Haines
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,101 +24,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !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.80.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.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: 
+description:
 email:
 - andrew@haines.org.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/pull-request.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -129,6 +45,7 @@ files:
 - Rakefile
 - bin/bundle
 - bin/console
+- bin/install-bundler
 - bin/rake
 - bin/setup
 - lib/yard-relative_markdown_links.rb
@@ -140,12 +57,12 @@ 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/master/CHANGELOG.md
+  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
   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
@@ -161,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+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.5
-  - 2.6
-  - 2.7