yard-junk 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d528277a6fb7bba1da971f94aae6b57026c389f3
-  data.tar.gz: 1e87ce70c14f718fcb2cd46eb4dcc5bbb86824e1
+SHA256:
+  metadata.gz: 5ae36216a5faaa685ff336798cdac734e1e1088925647c2f4daed058bfe9ae24
+  data.tar.gz: 9d4bb2f2afd494922f317b5aeb3d29da03bc63bb05c2022fc5cb888eba9eb95b
 SHA512:
-  metadata.gz: b8a095dad1cbc9da2e87a038ed30f563982ac38eb0f18c4f060cf0251ded6fea8cb40eccfb2405710789933b7f5c54faff649626e725678ef675bf3b35dd6d91
-  data.tar.gz: 2466c0a768593a605283f7c136bfb4d012a28701dbf3b32026e48da138162528fd9789275bba4c7dfa94aa6d8a3db6136ae4b91419a5727ab317722d9552dc83
+  metadata.gz: 7ca4fee74f9c585756155d3182acbda310236c2a6e54a79c5df18f9a012beb89e40fef48921ddbc55488ea27212b644bb30f2d0959eec014f1e4529df4fa09a6
+  data.tar.gz: 809c9b9c79fb371a2d6a3b768000122c4dbddb85f97a8c6f41cae089ff591f7926ca009888826007b6bdcabca8616c033697b82c353b568606c560490383748d

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  main:
+    name: >-
+      ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.5, 2.6, 2.7, head ]
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: install dependencies
+        run:  bundle install --jobs 3 --retry 3
+      - name: spec
+        run:  bundle exec rake spec
+      - name: rubocop
+        run:  bundle exec rake rubocop

data/Changelog.md

@@ -1,5 +1,27 @@
 # Yard-Junk changelog
 
+## 0.0.8 -- 2020-11-12
+
+* Support Ruby 2.7 (and hopefully 3.0)
+* Drop support for Rubies below 2.5 :shrug:
+
+## 0.0.7 -- 2017-09-21
+
+* Fix problems with links resolution for RDoc.
+
+## 0.0.6 -- 2017-09-20
+
+* More robust (and more logical) colorization on text output (#25);
+* Fast "sanity check" for using in pre-commit hook on large codebases (#24).
+
+## 0.0.5 -- 2017-09-11
+
+* Fix gem conflict with `did_you_mean`.
+
+## 0.0.4 -- 2017-09-09
+
+* Support for partial reports `yard-junk --path path/to/folder` (#13)
+
 ## 0.0.3 -- 2017-09-07
 
 * Wiser dependency on `did_you_mean`, should not break CIs now.

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    yard-junk (0.0.8)
+      backports (>= 3.18)
+      rainbow
+      yard
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    backports (3.18.2)
+    diff-lcs (1.4.4)
+    docile (1.1.5)
+    fakefs (1.2.2)
+    json (2.3.1)
+    json (2.3.1-java)
+    kramdown (2.3.0)
+      rexml
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.3.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    rubygems-tasks (0.2.4)
+    saharspec (0.0.8)
+      ruby2_keywords
+    simplecov (0.15.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  fakefs
+  kramdown
+  rake
+  rspec (>= 3)
+  rspec-its (~> 1)
+  rubocop
+  rubocop-rspec
+  rubygems-tasks
+  saharspec
+  simplecov (~> 0.9)
+  yard
+  yard-junk!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,7 +1,7 @@
 # Yard-Junk: get rid of junk in your YARD docs!
 
 [![Gem Version](https://badge.fury.io/rb/yard-junk.svg)](http://badge.fury.io/rb/yard-junk)
-[![Build Status](https://travis-ci.org/zverok/yard-junk.svg?branch=master)](https://travis-ci.org/zverok/yard-junk)
+![Build Status](https://github.com/zverok/yard-junk/workflows/CI/badge.svg?branch=master)
 
 Yard-Junk is [yard](https://github.com/lsegal/yard) plugin/patch, that provides:
 
@@ -381,6 +381,19 @@ Examples:
 * `yard-junk --text --html build-artifacts/junk-yard.html` (several formatters at once: text to console,
   HTML to file).
 
+You can also specify pathes to report (useful when working on large codebases, when you want to check
+only your recent piece of work):
+
+```
+yard-junk --path some/path/
+yard-junk --path other/path/*sample*.rb
+yard-junk --path specific/path.rb
+yard-junk --path several,different/*.rb,patterns.rb
+```
+
+Note that `yard-junk` would parse the pathes that set in `.yardopts` as usually, and then
+**filter report** by pattern specified.
+
 ### Rake task (integrating in CI)
 
 Add this to your `Rakefile`:
@@ -416,17 +429,15 @@ Therefore, this independent tool was made.
 
 ## Caveats
 
-* Sometimes YARD doesn't provide enough information to guess in which line of code the problem is;
-  in those cases `yard-junk` just writes something like `file.rb:1` (to stay consistent and not break
-  go-to-file tools);
-* Checking of links to files and URLs proven to be incomplete ([#12](https://github.com/zverok/yard-junk/issues/12)).
+Sometimes YARD doesn't provide enough information to guess in which line of code the problem is;
+in those cases `yard-junk` just writes something like `file.rb:1` (to stay consistent and not break
+go-to-file tools).
 
 ## Roadmap
 
 * Docs for usage as a system-wide YARD plugin;
 * Docs for internals;
-* Documentation quality checks as a next level of YARD checker ([#14](https://github.com/zverok/yard-junk/issues/14));
-* Option to check only selected parts of code ([#13](https://github.com/zverok/yard-junk/issues/13)).
+* Documentation quality checks as a next level of YARD checker ([#14](https://github.com/zverok/yard-junk/issues/14)).
 
 ## Some examples of problems found in popular gems:
 

data/exe/yard-junk

@@ -8,12 +8,14 @@ require 'yard-junk'
 require 'optparse'
 
 formatters = {}
+options = {}
 
-OptionParser.new do |opts|
+OptionParser.new do |opts| # rubocop:disable Metrics/BlockLength
   opts.banner = 'Usage: yard-junk [formatters]'
   opts.separator ''
   opts.separator 'Formatters'
-  opts.separator '(you can use several at once, for example --text to print in console and --html to save HTML report somewhere)'
+  opts.separator '(you can use several at once, for example --text to print in console '\
+                 'and --html to save HTML report somewhere)'
   opts.separator 'Default is: text formatter, printing to STDOUT.'
   opts.separator ''
 
@@ -21,13 +23,31 @@ OptionParser.new do |opts|
     formatters[:text] = path
   end
 
-  opts.on('--html [PATH]', 'HTML formatter, useful as CI artifact (prints to STDOUT by default)') do |path|
+  opts.on('--html [PATH]',
+          'HTML formatter, useful as CI artifact (prints to STDOUT by default)') do |path|
     formatters[:html] = path
   end
 
   opts.separator ''
   opts.separator 'Other options'
 
+  opts.on('-f', '--path PATTERN1,PATTERN2,PATTERN3',
+          'Limit output only to this files. '\
+          'Can be path to file or folder, or glob pattern') do |patterns|
+    options[:pathes] = patterns.split(',')
+  end
+
+  opts.on('-s', '--sanity',
+          'Sanity check for docs: just catch mistyped tags and similar stuff. '\
+          'On large codebases, MUCH faster than full check.') do
+    options[:mode] = :sanity
+  end
+
+  opts.on_tail('-v', '--version', 'Prints version') do
+    puts "YardJunk #{YardJunk::VERSION}"
+    exit
+  end
+
   opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
@@ -36,6 +56,6 @@ end.parse!
 
 formatters = {text: nil} if formatters.empty?
 
-janitor = YardJunk::Janitor.new
+janitor = YardJunk::Janitor.new(**options)
 janitor.run
 exit janitor.report(**formatters)

data/lib/yard-junk.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'yard'
+require_relative 'yard-junk/version'
 require_relative 'yard-junk/logger'
 require_relative 'yard-junk/command_line'
 require_relative 'yard-junk/janitor'

data/lib/yard-junk/command_line.rb

@@ -8,11 +8,15 @@ module YardJunk
       opts.separator ''
       opts.separator 'YardJunk plugin options'
 
-      opts.on('--junk-log-format [FMT]', "YardJunk::Logger format string, by default #{Logger::Message::DEFAULT_FORMAT.inspect}") do |format|
+      opts.on('--junk-log-format [FMT]',
+              'YardJunk::Logger format string, by default '\
+              "#{Logger::Message::DEFAULT_FORMAT.inspect}") do |format|
         Logger.instance.format = format
       end
 
-      opts.on('--junk-log-ignore [TYPE1,TYPE2,...]', "YardJunk::Logger message types to ignore, by default #{Logger::DEFAULT_IGNORE.map(&:inspect).join(', ')}") do |ignore|
+      opts.on('--junk-log-ignore [TYPE1,TYPE2,...]',
+              'YardJunk::Logger message types to ignore, by default '\
+              "#{Logger::DEFAULT_IGNORE.map(&:inspect).join(', ')}") do |ignore|
         Logger.instance.ignore = ignore.to_s.split(',')
       end
 

data/lib/yard-junk/janitor.rb

@@ -2,19 +2,25 @@
 
 require 'benchmark'
 require 'backports/2.3.0/enumerable/grep_v'
+require 'backports/2.6.0/array/to_h'
 
 module YardJunk
   class Janitor
+    def initialize(mode: :full, pathes: nil)
+      @mode = mode
+      @files = expand_pathes(pathes)
+    end
+
     def run(*opts)
       YARD::Registry.clear # Somehow loads all Ruby stdlib classes before Rake task started...
-      Logger.instance.format = nil
+      Logger.instance.format = nil # Nothing shouuld be printed
 
-      puts "Running YardJunk janitor...\n\n"
+      puts "Running YardJunk janitor (version #{YardJunk::VERSION})...\n\n"
 
       @duration = Benchmark.realtime do
         command = YARD::CLI::Yardoc.new
-        command.run('--no-save', '--no-progress', '--no-stats', '--no-output', *opts)
-        Resolver.resolve_all(command.options)
+        command.run(*prepare_options(opts))
+        Resolver.resolve_all(command.options) unless mode == :sanity
       end
 
       self
@@ -41,15 +47,43 @@ module YardJunk
     end
 
     def exit_code
-      return 2 unless errors.empty?
-      return 1 unless problems.empty?
-      0
+      case
+      when !errors.empty? then 2
+      when !problems.empty? then 1
+      else 0
+      end
     end
 
     private
 
+    attr_reader :mode, :files, :yardopts
+
+    BASE_OPTS = %w[--no-save --no-progress --no-stats --no-output --no-cache].freeze
+
+    def prepare_options(opts)
+      case
+      when mode == :full || mode == :sanity && files.nil?
+        [*BASE_OPTS, *opts]
+      when mode == :sanity
+        # TODO: specs
+        [*BASE_OPTS, '--no-yardopts', *yardopts_with_files(files)]
+      else
+        fail ArgumentError, "Undefined mode: #{mode.inspect}"
+      end
+    end
+
+    def yardopts_with_files(files)
+      # Use all options from .yardopts file, but replace file lists
+      YardOptions.new.remove_option('--files').set_files(*files)
+    end
+
     def messages
-      YardJunk::Logger.instance.messages.grep_v(Logger::Undocumentable) # FIXME: Not DRY
+      # FIXME: dropping Undocumentable here is not DRY
+      @messages ||= YardJunk::Logger
+                    .instance
+                    .messages
+                    .grep_v(Logger::Undocumentable)
+                    .select { |m| !files || !m.file || files.include?(File.expand_path(m.file)) }
     end
 
     def errors
@@ -60,12 +94,23 @@ module YardJunk
       messages.select(&:warn?)
     end
 
+    def expand_pathes(pathes)
+      return unless pathes
+
+      Array(pathes)
+        .map { |path| File.directory?(path) ? File.join(path, '**', '*.*') : path }
+        .flat_map(&Dir.method(:[]))
+        .map(&File.method(:expand_path))
+    end
+
     # TODO: specs for the logic
     def guess_reporters(*symbols, **symbols_with_args)
       symbols
-        .map { |sym| [sym, nil] }.to_h.merge(symbols_with_args)
+        .to_h { |sym| [sym, nil] }.merge(symbols_with_args)
         .map { |sym, args| ["#{sym.to_s.capitalize}Reporter", args] }
-        .each { |name, _| Janitor.const_defined?(name) or fail(ArgumentError, "Reporter #{name} not found") }
+        .each { |name,|
+          Janitor.const_defined?(name) or fail(ArgumentError, "Reporter #{name} not found")
+        }
         .map { |name, args| Janitor.const_get(name).new(*args) }
     end
   end
@@ -75,3 +120,4 @@ require_relative 'janitor/base_reporter'
 require_relative 'janitor/text_reporter'
 require_relative 'janitor/html_reporter'
 require_relative 'janitor/resolver'
+require_relative 'janitor/yard_options'

data/lib/yard-junk/janitor/base_reporter.rb

@@ -19,7 +19,7 @@ module YardJunk
       #
       # @overload initialize(filename)
       #   @param filename [String] Name of file to save the output.
-      def initialize(io_or_filename = STDOUT)
+      def initialize(io_or_filename = $stdout)
         @io =
           case io_or_filename
           when ->(i) { i.respond_to?(:puts) } # quacks!
@@ -35,6 +35,7 @@ module YardJunk
 
       def section(title, explanation, messages)
         return if messages.empty?
+
         header(title, explanation)
 
         messages
@@ -43,7 +44,7 @@ module YardJunk
       end
 
       def stats(**stat)
-        _stats(stat.merge(duration: humanize_duration(stat[:duration])))
+        _stats(**stat.merge(duration: humanize_duration(stat[:duration])))
       end
 
       private

data/lib/yard-junk/janitor/resolver.rb

@@ -2,25 +2,39 @@
 
 module YardJunk
   class Janitor
-    # TODO: Tests
     class Resolver
       include YARD::Templates::Helpers::HtmlHelper
+      include YARD::Templates::Helpers::MarkupHelper
 
-      MESSAGE_PATTERN = 'In file `%{file}\':%{line}: Cannot resolve link to %{name} from text: %{link}'
+      # This one is copied from real YARD output
+      OBJECT_MESSAGE_PATTERN = "In file `%{file}':%{line}: " \
+                               'Cannot resolve link to %{name} from text: %{link}'
+
+      # ...while this one is totally invented, YARD doesn't check file existance at all
+      FILE_MESSAGE_PATTERN = "In file `%{file}':%{line}: File '%{name}' does not exist: %{link}"
 
       def self.resolve_all(yard_options)
         YARD::Registry.all.map(&:base_docstring).each { |ds| new(ds, yard_options).resolve }
+        yard_options.files.each { |file| new(file, yard_options).resolve }
       end
 
-      def initialize(docstring, yard_options)
-        @docstring = docstring
+      def initialize(object, yard_options)
         @options = yard_options
+        case object
+        when YARD::CodeObjects::ExtraFileObject
+          init_file(object)
+        when YARD::Docstring
+          init_docstring(object)
+        else
+          fail "Unknown object to resolve #{object.class}"
+        end
       end
 
       def resolve
-        markup_meth = "html_markup_#{options.markup}"
+        markup_meth = "html_markup_#{markup}"
         return unless respond_to?(markup_meth)
-        send(markup_meth, @docstring)
+
+        send(markup_meth, @string)
           .gsub(%r{<(code|tt|pre)[^>]*>(.*?)</\1>}im, '')
           .scan(/{[^}]+}/).flatten
           .map(&CGI.method(:unescapeHTML))
@@ -29,20 +43,62 @@ module YardJunk
 
       private
 
-      attr_reader :options
+      def init_file(file)
+        @string = file.contents
+        @file = file.filename
+        @line = 1
+        @markup = markup_for_file(file.contents, file.filename)
+      end
+
+      def init_docstring(docstring)
+        @string = docstring
+        @root_object = docstring.object
+        @file = @root_object.file
+        @line = @root_object.line
+        @markup = options.markup
+      end
+
+      attr_reader :options, :file, :line, :markup
 
       def try_resolve(link)
         name, _comment = link.tr('{}', '').split(/\s+/, 2)
-        resolved = YARD::Registry.resolve(@docstring.object, name, true, true)
+
+        # See YARD::Templates::Helpers::BaseHelper#linkify for the source of patterns
+        # TODO: there is also {include:}, {include:file:} and {render:} syntaxes, but I've never seen
+        # a project using them. /shrug
+        case name
+        when %r{://}, /^mailto:/ # that's pattern YARD uses
+          # do nothing, assume it is correct
+        when /^file:(\S+?)(?:#(\S+))?$/
+          resolve_file(Regexp.last_match[1], link)
+        else
+          resolve_code_object(name, link)
+        end
+      end
+
+      def resolve_file(name, link)
+        return if options.files.any? { |f| f.name == name || f.filename == name }
+
+        Logger.instance.register(
+          FILE_MESSAGE_PATTERN % {file: file, line: line, name: name, link: link}
+        )
+      end
+
+      def resolve_code_object(name, link)
+        resolved = YARD::Registry.resolve(@root_object, name, true, true)
         return unless resolved.is_a?(YARD::CodeObjects::Proxy)
-        Logger.instance.register(MESSAGE_PATTERN % {file: object.file, line: object.line, name: name, link: link})
+
+        Logger.instance.register(
+          OBJECT_MESSAGE_PATTERN % {file: file, line: line, name: name, link: link}
+        )
       end
 
+      # Used by HtmlHelper for RDoc
       def object
-        @docstring.object
+        @string.object if @string.is_a?(YARD::Docstring)
       end
 
-      # required by HtmlHelper
+      # Used by HtmlHelper
       def serializer
         nil
       end

data/lib/yard-junk/janitor/text_reporter.rb

@@ -11,26 +11,24 @@ module YardJunk
       private
 
       def _stats(**stat)
-        @io.puts "\n#{template_for(stat) % stat}"
+        @io.puts "\n#{colorized_stats(**stat)}"
       end
 
-      NO_ISSUES_TEMPLATE = [
-        Rainbow('%<errors>i failures, %<problems>i problems').green,
-        Rainbow(', (%<duration>s to run)').gray
-      ].join('').freeze
-
-      ERROR_COUNT_TEMPLATE = [
-        Rainbow('%<errors>i failures').red,
-        Rainbow(',').gray,
-        Rainbow(' %<problems>i problems').yellow,
-        Rainbow(', (%<duration>s to run)').gray
-      ].join('').freeze
-
-      def template_for(stat)
-        if stat[:errors].zero? && stat[:problems].zero?
-          NO_ISSUES_TEMPLATE
-        else
-          ERROR_COUNT_TEMPLATE
+      def colorized_stats(errors:, problems:, duration:)
+        colorize(
+          format('%i failures, %i problems', errors, problems), status_color(errors, problems)
+        ) + format(' (%s to run)', duration)
+      end
+
+      def colorize(text, color)
+        Rainbow(text).color(color)
+      end
+
+      def status_color(errors, problems)
+        case
+        when errors.positive? then :red
+        when problems.positive? then :yellow
+        else :green
         end
       end
 
@@ -38,7 +36,7 @@ module YardJunk
         @io.puts
         @io.puts title
         @io.puts '-' * title.length
-        @io.puts explanation + "\n\n"
+        @io.puts "#{explanation}\n\n"
       end
 
       def row(msg)

data/lib/yard-junk/janitor/yard_options.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module YardJunk
+  class Janitor
+    # Allows to properly parse `.yardopts` or other option file YARD supports and gracefully replace
+    # or remove some of options.
+    class YardOptions
+      attr_reader :options, :files, :extra_files
+
+      def initialize
+        internal = Internal.new
+        internal.parse_arguments
+        @options = internal.option_args
+        @files = internal.files
+        @extra_files = internal.options.files
+      end
+
+      def set_files(*files) # rubocop:disable Naming/AccessorMethodName
+        # TODO: REALLY fragile :(
+        @files, @extra_files = files.partition { |f| f =~ /\.(rb|c|cxx|cpp|rake)/ }
+        self
+      end
+
+      def remove_option(long, short = nil)
+        [short, long].compact.each do |o|
+          i = @options.index(o)
+          next unless i
+
+          @options.delete_at(i)
+          @options.delete_at(i) unless @options[i].start_with?('-') # it was argument
+        end
+        self
+      end
+
+      def to_a
+        (@options + @files)
+          .tap { |res| res.concat(['-', *@extra_files]) unless @extra_files.empty? }
+      end
+
+      # The easiest way to think like Yardoc is to become Yardoc, you know.
+      class Internal < YARD::CLI::Yardoc
+        attr_reader :option_args
+
+        def optparse(*args)
+          # remember all passed options...
+          @all_args = args
+          super
+        end
+
+        def parse_files(*args)
+          # ...and substract what left after they were parsed as options, and only files left
+          @option_args = @all_args - args
+          super
+        end
+      end
+    end
+  end
+end

data/lib/yard-junk/logger.rb

@@ -3,6 +3,8 @@
 require 'singleton'
 require 'pp'
 
+require 'backports/2.7.0/enumerable/filter_map'
+
 module YardJunk
   class Logger
     require_relative 'logger/message'
@@ -16,9 +18,10 @@ module YardJunk
     end
 
     def register(msg, severity = :warn)
-      message = Message.registry
-                       .map { |t| t.try_parse(msg, severity: severity, file: @current_parsed_file) }
-                       .compact.first || Message.new(message: msg, file: @current_parsed_file)
+      message =
+        Message.registry.filter_map { |t|
+          t.try_parse(msg, severity: severity, file: @current_parsed_file)
+        }.first || Message.new(message: msg, file: @current_parsed_file)
       messages << message
       puts message.to_s(@format) if output?(message)
     end
@@ -44,8 +47,10 @@ module YardJunk
     end
 
     def ignore=(list)
-      @ignore = Array(list).map(&:to_s)
-                           .each { |type| Message.valid_type?(type) or fail(ArgumentError, "Unrecognized message type to ignore: #{type}") }
+      @ignore = Array(list).map(&:to_s).each do |type|
+        Message.valid_type?(type) or
+          fail(ArgumentError, "Unrecognized message type to ignore: #{type}")
+      end
     end
 
     private

data/lib/yard-junk/logger/message.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'did_you_mean'
+require_relative 'spellcheck'
 
 module YardJunk
   class Logger
@@ -10,7 +10,7 @@ module YardJunk
       def initialize(message:, severity: :warn, code_object: nil, file: nil, line: nil, **extra)
         @message = message.gsub(/\s{2,}/, ' ')
         @file = file
-        @line = line && line.to_i
+        @line = line&.to_i
         @code_object = code_object
         @severity = severity
         @extra = extra
@@ -25,7 +25,7 @@ module YardJunk
           type: type,
           message: message,
           file: file,
-          line: (line && line.to_i) || 1
+          line: line&.to_i || 1
         }.merge(extra)
       end
 
@@ -43,43 +43,7 @@ module YardJunk
         self.class.type
       end
 
-      private
-
-      # DidYouMean changed API dramatically between 1.0 and 1.1, and different rubies have different
-      # versions of it bundled.
-      if DidYouMean.const_defined?(:SpellCheckable) # 1.0 +
-        class SpellChecker < Struct.new(:error, :dictionary) # rubocop:disable Style/StructInheritance
-          include DidYouMean::SpellCheckable
-
-          def candidates
-            {error => dictionary}
-          end
-        end
-
-        def spell_check(error, dictionary)
-          SpellChecker.new(error, dictionary).corrections
-        end
-      elsif DidYouMean.const_defined?(:SpellChecker) # 1.1+
-        def spell_check(error, dictionary)
-          DidYouMean::SpellChecker.new(dictionary: dictionary).correct(error)
-        end
-      elsif DidYouMean.const_defined?(:BaseFinder) # < 1.0
-        class SpellFinder < Struct.new(:error, :dictionary) # rubocop:disable Style/StructInheritance
-          include DidYouMean::BaseFinder
-
-          def searches
-            {error => dictionary}
-          end
-        end
-
-        def spell_check(error, dictionary)
-          SpellFinder.new(error, dictionary).suggestions
-        end
-      else
-        def spell_check(*)
-          []
-        end
-      end
+      include Spellcheck
 
       class << self
         def registry
@@ -98,8 +62,8 @@ module YardJunk
         def try_parse(line, **context)
           @pattern or fail StandardError, "Pattern is not defined for #{self}"
           match = @pattern.match(line) or return nil
-          data = context.reject { |_, v| v.nil? }
-                        .merge(match.names.map(&:to_sym).zip(match.captures).to_h.reject { |_, v| v.nil? })
+          data = context.compact
+                        .merge(match.names.map(&:to_sym).zip(match.captures).to_h.compact)
           data = guard_line(data)
           new(**data)
         end
@@ -114,17 +78,17 @@ module YardJunk
 
         private
 
-        def guard_line(data) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def guard_line(data) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
           # FIXME: Ugly, huh?
           data[:file] && data[:line] && @search_up or return data
           data = data.merge(line: data[:line].to_i)
           data = data.merge(code_object: find_object(data[:file], data[:line]))
           lines = File.readlines(data[:file]) rescue (return data) # rubocop:disable Style/RescueModifier
-          pattern = Regexp.new(@search_up % data.map { |k, v| [k, Regexp.escape(v.to_s)] }.to_h)
+          pattern = Regexp.new(@search_up % data.transform_values { |v| Regexp.escape(v.to_s) })
           _, num = lines.map
                         .with_index { |ln, i| [ln, i + 1] }
                         .first(data[:line]).reverse
-                        .detect { |ln, _| pattern.match(ln) }
+                        .detect { |ln,| pattern.match(ln) }
           num or return data
 
           data.merge(line: num)
@@ -136,6 +100,7 @@ module YardJunk
       end
     end
 
+    # rubocop:disable Layout/LineLength
     class UnknownTag < Message
       pattern %r{^(?<message>Unknown tag (?<tag>@\S+))( in file `(?<file>[^`]+)` near line (?<line>\d+))?$}
       search_up '%{tag}(\W|$)'
@@ -261,5 +226,11 @@ module YardJunk
       pattern %r{^In file `(?<file>[^']+)':(?<line>\d+): (?<message>Cannot resolve link to (?<object>\S+) from text:\s+(?<quote>.+))$}
       search_up '%{quote}'
     end
+
+    class InvalidFileLink < Message
+      pattern %r{^In file `(?<file>[^']+)':(?<line>\d+): (?<message>File '(?<object>\S+)' does not exist:\s+(?<quote>.+))$}
+      search_up '%{quote}'
+    end
+    # rubocop:enable Layout/LineLength
   end
 end

data/lib/yard-junk/logger/spellcheck.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+begin
+  require 'did_you_mean'
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end
+
+module YardJunk
+  class Logger
+    module Spellcheck
+      # DidYouMean changed API dramatically between 1.0 and 1.1, and different rubies have different
+      # versions of it bundled.
+      if !Kernel.const_defined?(:DidYouMean)
+        def spell_check(*)
+          []
+        end
+      elsif DidYouMean.const_defined?(:SpellCheckable) # 1.0 +
+        class SpellChecker < Struct.new(:error, :dictionary) # rubocop:disable Style/StructInheritance
+          include DidYouMean::SpellCheckable
+
+          def candidates
+            {error => dictionary}
+          end
+        end
+
+        def spell_check(error, dictionary)
+          SpellChecker.new(error, dictionary).corrections
+        end
+      elsif DidYouMean.const_defined?(:SpellChecker) # 1.1+
+        def spell_check(error, dictionary)
+          DidYouMean::SpellChecker.new(dictionary: dictionary).correct(error)
+        end
+      elsif DidYouMean.const_defined?(:BaseFinder) # < 1.0
+        class SpellFinder < Struct.new(:error, :dictionary) # rubocop:disable Style/StructInheritance
+          include DidYouMean::BaseFinder
+
+          def searches
+            {error => dictionary}
+          end
+        end
+
+        def spell_check(error, dictionary)
+          SpellFinder.new(error, dictionary).suggestions
+        end
+      else # rubocop:disable Lint/DuplicateBranch -- actually, just impossibility catcher
+        def spell_check(*)
+          []
+        end
+      end
+    end
+  end
+end

data/lib/yard-junk/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module YardJunk
+  # @private
+  MAJOR = 0
+  # @private
+  MINOR = 0
+  # @private
+  PATCH = 8
+
+  # @private
+  VERSION = [MINOR, MAJOR, PATCH].join('.')
+end

data/yard-junk.gemspec

@@ -1,6 +1,8 @@
+require_relative 'lib/yard-junk/version'
+
 Gem::Specification.new do |s|
   s.name     = 'yard-junk'
-  s.version  = '0.0.3'
+  s.version  = YardJunk::VERSION
   s.authors  = ['Victor Shepelev']
   s.email    = 'zverok.offline@gmail.com'
   s.homepage = 'https://github.com/zverok/junk_yard'
@@ -11,7 +13,7 @@ Gem::Specification.new do |s|
   EOF
   s.licenses = ['MIT']
 
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.files = `git ls-files`.split($RS).reject do |file|
     file =~ /^(?:
@@ -31,19 +33,20 @@ Gem::Specification.new do |s|
   s.bindir = 'exe'
   s.executables << 'yard-junk'
 
-  s.add_dependency 'rainbow'
   s.add_dependency 'yard'
-  s.add_dependency 'did_you_mean'
-  s.add_dependency 'backports'
+  s.add_dependency 'did_you_mean' if RUBY_VERSION < '2.3'
+  s.add_dependency 'backports', '>= 3.18'
+  s.add_dependency 'rainbow'
 
-  s.add_development_dependency 'rubocop', '>= 0.49'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rspec', '>= 3'
-  s.add_development_dependency 'rubocop-rspec', '= 1.15.1' # 1.16.0 is broken on JRuby
+  s.add_development_dependency 'rubocop-rspec'
   s.add_development_dependency 'rspec-its', '~> 1'
-  #s.add_development_dependency 'saharspec' # saharspec is moving target!
+  s.add_development_dependency 'saharspec'
   s.add_development_dependency 'fakefs'
   s.add_development_dependency 'simplecov', '~> 0.9'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubygems-tasks'
   s.add_development_dependency 'yard'
+  s.add_development_dependency 'kramdown'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: yard-junk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: backports
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
 - !ruby/object:Gem::Dependency
-  name: did_you_mean
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: backports
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,61 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.1
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: saharspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "    YardJunk is structured logger/error validator plugin for YARD documentation
   gem.\n"
 email: zverok.offline@gmail.com
@@ -200,7 +214,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - Changelog.md
+- Gemfile.lock
 - README.md
 - examples/bare_log.rb
 - examples/formatted_log.rb
@@ -215,9 +231,12 @@ files:
 - lib/yard-junk/janitor/html_reporter.rb
 - lib/yard-junk/janitor/resolver.rb
 - lib/yard-junk/janitor/text_reporter.rb
+- lib/yard-junk/janitor/yard_options.rb
 - lib/yard-junk/logger.rb
 - lib/yard-junk/logger/message.rb
+- lib/yard-junk/logger/spellcheck.rb
 - lib/yard-junk/rake.rb
+- lib/yard-junk/version.rb
 - yard-junk.gemspec
 homepage: https://github.com/zverok/junk_yard
 licenses:
@@ -231,15 +250,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Get rid of the junk in your YARD docs