yard-junk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2e9b802aa1bb3391b0962165574b75f10e05cad
-  data.tar.gz: 6b279f93f06feb8ea1c10595d10cc8661f7bcc8d
+  metadata.gz: fcf20dc05e2b7b8cccc8928add0ccfb1a3645534
+  data.tar.gz: a1f0da93aeebcc2b82eb9bb303649cbd4ffc0928
 SHA512:
-  metadata.gz: 381f8c03346812eef369dabc6548c675aef0c309f7cd08b767c0e3603ef1267f08b589acb994789f410039601108aa7cd3de46b42f3e8fc539d683a28b50975b
-  data.tar.gz: d9c65f218d51d23bb573671f9e89c62497bbed28063487a06ede45a1e1d97abd54dd5311e095d2944936d665ef86471dd0f1b385279906a17e5d7be9316a874a
+  metadata.gz: 96e3d2ca3814151e8ea7cfc68aeb32edd0a2ab13b7ed4008eb0b50091a6dcedd14668fbd5d05a56f7a1e151399551a33c442dc7d3921f9b95543ffd256d09412
+  data.tar.gz: 0e599b6a5101aec233c921443a5a9778cb6b7037513075517e134d0b946be52de9bbd0b31682ad6cef48b18b1509d4a7d5459b1f8c09c4ec0272e2212dd1b5fe

data/Changelog.md

@@ -0,0 +1,12 @@
+# Yard-Junk changelog
+
+## 0.0.2 -- 2017-09-03
+
+* Lots of small cleanups and enchancement of README, Gemfile and directory structure ([@olleolleolle]);
+* Colorized text output ([@olleolleolle]);
+* HTML reporter;
+* Options for command line and Rake task.
+
+## 0.0.1 -- 2017-08-27
+
+Yard-Junk was born (Even RubyWeekly [#364](http://rubyweekly.com/issues/364) noticed!)

data/README.md

@@ -12,7 +12,205 @@ Yard-Junk is [yard](https://github.com/lsegal/yard) plugin/patch, that provides:
 
 Let's generate the docs for the [rom](https://github.com/rom-rb/rom) library.
 
-Output of `yard doc` without JunkYard: [too huge to embed in README](https://gist.github.com/zverok/6dcf946d674e63545cee9f8a74e08728).
+<details><summary>Output of `yard doc` without JunkYard</summary>
+
+```
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Types
+	in file 'core/lib/rom/types.rb':9:
+
+	9: include Dry::Types.module
+
+[warn]: Invalid tag format for @example in file `core/lib/rom/global.rb` near line 41
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Schema
+	in file 'core/lib/rom/schema.rb':66:
+
+	66: include Dry::Equalizer(:name, :attributes, :associations)
+
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/schema.rb' near line 149
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/schema.rb' near line 305
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/schema.rb' near line 316
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Command
+	in file 'core/lib/rom/command.rb':30:
+
+	30: include Dry::Equalizer(:relation, :options)
+
+[warn]: @param tag has unknown parameter name: Transaction
+    in file `core/lib/rom/gateway.rb' near line 176
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Pipeline::Composite
+	in file 'core/lib/rom/pipeline.rb':82:
+
+	82: include Dry::Equalizer(:left, :right)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Registry
+	in file 'core/lib/rom/registry.rb':13:
+
+	13: include Dry::Equalizer(:elements)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Relation
+	in file 'core/lib/rom/relation.rb':129:
+
+	129: include Dry::Equalizer(:name, :dataset)
+
+[warn]: @param tag has unknown parameter name: options
+    in file `core/lib/rom/relation.rb' near line 302
+[warn]: @param tag has unknown parameter name: new_options
+    in file `core/lib/rom/relation.rb' near line 411
+[warn]: @param tag has unknown parameter name: klass
+    in file `core/lib/rom/relation.rb' near line 529
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Attribute
+	in file 'core/lib/rom/attribute.rb':17:
+
+	17: include Dry::Equalizer(:type, :options)
+
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/attribute.rb' near line 344
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Container
+	in file 'core/lib/rom/container.rb':101:
+
+	101: include Dry::Equalizer(:gateways, :relations, :mappers, :commands)
+
+[warn]: @param tag has unknown parameter name: base
+    in file `core/lib/rom/plugin_base.rb' near line 41
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Commands::Lazy
+	in file 'core/lib/rom/commands/lazy.rb':10:
+
+	10: include Dry::Equalizer(:command, :evaluator)
+
+[warn]: @param tag has unknown parameter name: The
+    in file `core/lib/rom/configuration.rb' near line 50
+[warn]: @param tag has unknown parameter name: Plugin
+    in file `core/lib/rom/configuration.rb' near line 50
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Relation::Name
+	in file 'core/lib/rom/relation/name.rb':17:
+
+	17: include Dry::Equalizer(:relation, :dataset)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Commands::Graph
+	in file 'core/lib/rom/commands/graph.rb':12:
+
+	12: include Dry::Equalizer(:root, :nodes)
+
+[warn]: @param tag has unknown parameter name: names
+    in file `core/lib/rom/memory/dataset.rb' near line 61
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Relation::Graph
+	in file 'core/lib/rom/relation/graph.rb':29:
+
+	29: include Dry::Equalizer(:root, :nodes)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::PluginRegistryBase
+	in file 'core/lib/rom/plugin_registry.rb':88:
+
+	88: include Dry::Equalizer(:elements, :plugin_type)
+
+[warn]: Unknown tag @raises in file `core/lib/rom/plugin_registry.rb` near line 143
+[warn]: Unknown tag @raises in file `core/lib/rom/plugin_registry.rb` near line 190
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Relation::Loaded
+	in file 'core/lib/rom/relation/loaded.rb':12:
+
+	12: include Dry::Equalizer(:source, :collection)
+
+[warn]: Unknown tag @raises in file `core/lib/rom/relation/loaded.rb` near line 94
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Schema::Inferrer
+	in file 'core/lib/rom/schema/inferrer.rb':27:
+
+	27: include Dry::Equalizer(:options)
+
+[warn]: @param tag has unknown parameter name: name
+    in file `core/lib/rom/command_registry.rb' near line 57
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Relation::Curried
+	in file 'core/lib/rom/relation/curried.rb':22:
+
+	22: include Dry::Equalizer(:relation, :options)
+
+[warn]: Unknown tag @raises in file `core/lib/rom/relation/curried.rb` near line 72
+[warn]: @param tag has unknown parameter name: adapter
+    in file `core/lib/rom/global/plugin_dsl.rb' near line 42
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/relation/combined.rb' near line 33
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Associations::Abstract
+	in file 'core/lib/rom/associations/abstract.rb':17:
+
+	17: include Dry::Equalizer(:definition, :source, :target)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Notifications::Event
+	in file 'core/lib/rom/support/notifications.rb':75:
+
+	75: include Dry::Equalizer(:id, :payload)
+
+[warn]: @param tag has unknown parameter name: command
+    in file `core/lib/rom/commands/class_interface.rb' near line 86
+[warn]: @param tag has unknown parameter name: parent
+    in file `core/lib/rom/commands/class_interface.rb' near line 86
+[warn]: @param tag has unknown parameter name: options
+    in file `core/lib/rom/commands/class_interface.rb' near line 112
+[warn]: @param tag has unknown parameter name:
+    in file `core/lib/rom/commands/class_interface.rb' near line 123
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Commands::Graph::InputEvaluator
+	in file 'core/lib/rom/commands/graph/input_evaluator.rb':5:
+
+	5: include Dry::Equalizer(:tuple_path, :excluded_keys)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Associations::Definitions::Abstract
+	in file 'core/lib/rom/associations/definitions/abstract.rb':16:
+
+	16: include Dry::Equalizer(:source, :target, :result)
+
+[warn]: @param tag has unknown parameter name: options
+    in file `core/lib/rom/associations/definitions/abstract.rb' near line 74
+[warn]: @param tag has unknown parameter name: options
+    in file `changeset/lib/rom/changeset.rb' near line 84
+[warn]: in YARD::Handlers::Ruby::ClassHandler: Undocumentable superclass (class was added without superclass)
+	in file 'changeset/lib/rom/changeset/pipe.rb':28:
+
+	28: class Pipe < Transproc::Transformer[PipeRegistry]
+
+[warn]: @param tag has unknown parameter name: assoc
+    in file `changeset/lib/rom/changeset/stateful.rb' near line 222
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Header
+	in file 'mapper/lib/rom/header.rb':12:
+
+	12: include Dry::Equalizer(:attributes, :model)
+
+[warn]: @param tag has unknown parameter name: model
+    in file `mapper/lib/rom/header.rb' near line 52
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Mapper
+	in file 'mapper/lib/rom/mapper.rb':11:
+
+	11: include Dry::Equalizer(:transformers, :header)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Header::Attribute
+	in file 'mapper/lib/rom/header/attribute.rb':14:
+
+	14: include Dry::Equalizer(:name, :key, :type)
+
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Header::Embedded
+	in file 'mapper/lib/rom/header/attribute.rb':110:
+
+	110: include Dry::Equalizer(:name, :key, :type, :header)
+
+[warn]: @param tag has unknown parameter name:
+    in file `mapper/lib/rom/processor/transproc.rb' near line 215
+[warn]: in YARD::Handlers::Ruby::MixinHandler: Undocumentable mixin: YARD::Parser::UndocumentableError for class ROM::Session
+	in file 'repository/lib/rom/repository/session.rb':8:
+
+	8: include Dry::Equalizer(:queue, :status)
+
+[warn]: The proxy Coercible has not yet been recognized.
+If this class/method is part of your source tree, this will affect your documentation results.
+You can correct this issue by loading the source file for this object before `core/lib/rom/types.rb'
+
+[warn]: The proxy Coercible has not yet been recognized.
+If this class/method is part of your source tree, this will affect your documentation results.
+You can correct this issue by loading the source file for this object before `core/lib/rom/types.rb'
+
+[warn]: The proxy Coercible has not yet been recognized.
+If this class/method is part of your source tree, this will affect your documentation results.
+You can correct this issue by loading the source file for this object before `core/lib/rom/types.rb'
+```
+</details>
 
 Things to notice:
 
@@ -24,7 +222,7 @@ Things to notice:
 * verbose and not very informative errors (look at that "Undocumentable mixin" -- and then grep
   for "The proxy Coercible has not yet been recognized." and compare).
 
-Output of `yard doc` with Yard-Junk:
+<details><summary>Output of `yard doc` with Yard-Junk</summary>
 
 ```
 core/lib/rom/global.rb:40: [InvalidTagFormat] Invalid tag format for @example
@@ -60,6 +258,7 @@ core/lib/rom/types.rb:1: [UnknownNamespace] namespace Coercible is not recognize
 core/lib/rom/types.rb:1: [UnknownNamespace] namespace Coercible is not recognized
 core/lib/rom/types.rb:1: [UnknownNamespace] namespace Coercible is not recognized
 ```
+</details>
 
 Things to notice:
 
@@ -74,7 +273,7 @@ Unknown tag @raises. Did you mean @raise?
 ```
 * Rephrased and cleaned up messages.
 
-`yard-junk` tool output:
+<details><summary>`yard-junk` tool output</summary>
 
 ```
 Problems
@@ -116,6 +315,7 @@ mapper/lib/rom/processor/transproc.rb:212: [MissingParamName] @param tag has emp
 
 0 failures, 32 problems (2 seconds to run)
 ```
+</details>
 
 It is basically the same as above, and:
 
@@ -168,7 +368,18 @@ include Rails.routes
 
 ### Standalone docs check
 
-Just run `yard-junk` command after gem is installed. It should work :)
+Just run `yard-junk` command after gem is installed. Optionally, you can setup "formatters" to use:
+
+* text formatter: suitable for console, sparse colorized output;
+* HTML formatter: suitable as CI artifact, readable in browser.
+
+Examples:
+
+* `yard-junk` (default run, outputs text to STDOUT);
+* `yard-junk --text` (same as above);
+* `yard-junk --text logs/yard.log` (set the output path);
+* `yard-junk --text --html build-artifacts/junk-yard.html` (several formatters at once: text to console,
+  HTML to file).
 
 ### Rake task (integrating in CI)
 
@@ -184,13 +395,21 @@ and then run it (or add to your `.travis.yml`) as
 rake yard:junk
 ```
 
+Rake task also allows to pass formatters (at task definition time), this way:
+
+```ruby
+YardJunk::Rake.task(:text) # default
+YardJunk::Rake.task(text: 'logs/yard.log') # text to file
+YardJunk::Rake.task(:text, html: 'build-artifacts/junk-yard.html') # text to STDOUT, html to file
+```
+
 ## Reasons
 
-Small problems in docs lead to decrease of readability and usability. But it is hard to check for
+Small problems in docs lead to a decrease in readability and usability. But it is hard to check for
 all those problems manually due to YARD's cumbersome output, and lack of CI-ready doc checking tools.
 
-Idea of regularly structured logger was initially [proposed](https://github.com/lsegal/yard/issues/1007)
-as an enchancement for YARD itself, and even some steps were maid by YARD's author in that direction,
+The idea of a regularly structured logger was initially [proposed](https://github.com/lsegal/yard/issues/1007)
+as an enhancement for YARD itself, and even some steps were made by YARD's author in that direction,
 but the idea was abandoned since.
 
 Therefore, this independent tool was made.
@@ -198,31 +417,32 @@ 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 `junk-yard` just writes something like `file.rb:1` (to stay consistent and not break
+  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.
+* Checking of links to files and URLs proven to be incomplete ([#12](https://github.com/zverok/yard-junk/issues/12)).
 
 ## Roadmap
 
 * Docs for usage as a system-wide YARD plugin;
 * Docs for internals;
-* Colorized output for text reporter;
-* HTML reporter for CIs allowing to store build artifacts;
-* Documentation quality checks as a next level of YARD checker;
-* Option to check new/updated code only (integration with git history)?
+* 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)).
 
 ## Some examples of problems found in popular gems:
 
 **NB: All of those are excellent libs! The showcase is of "how hard it is to maintain docs quality",
 not of "how ignorant other programmers are".**
 
-httparty:
+<details><summary>httparty: 2</summary>
+
 ```
 lib/httparty/exceptions.rb:2: [UnknownTag] Unknown tag @abstact. Did you mean @abstract?
 lib/httparty/exceptions.rb:20: [MissingParamName] @param tag has empty parameter name
 ```
+</details>
+
+<details><summary>vcr: 7</summary>
 
-vcr:
 ```
 lib/vcr/deprecations.rb:71: [UnknownParam] @param tag has unknown parameter name: name
 lib/vcr/deprecations.rb:73: [UnknownParam] @param tag has unknown parameter name: options
@@ -232,8 +452,10 @@ lib/vcr/linked_cassette.rb:55: [UnknownParam] @param tag has unknown parameter n
 lib/vcr/linked_cassette.rb:56: [UnknownParam] @param tag has unknown parameter name: context-unowned
 lib/vcr/test_frameworks/cucumber.rb:27: [UnknownParam] @param tag has unknown parameter name: options
 ```
+</details>
+
+<details><summary>eventmachine: 19</summary>
 
-eventmachine:
 ```
 lib/em/channel.rb:39: [UnknownParam] @param tag has unknown parameter name: Subscriber
 lib/em/connection.rb:603: [InvalidLink] Cannot resolve link to Socket.unpack_sockaddr_in from text: {Socket.unpack_sockaddr_in}
@@ -255,8 +477,10 @@ lib/eventmachine.rb:231: [InvalidLink] Cannot resolve link to EventMachine::Call
 lib/eventmachine.rb:319: [UnknownParam] @param tag has unknown parameter name: delay
 lib/eventmachine.rb:345: [UnknownParam] @param tag has unknown parameter name: delay
 ```
+</details>
+
+<details><summary>addressable: 8</summary>
 
-addressable:
 ```
 lib/addressable/template.rb:197: [UnknownParam] @param tag has unknown parameter name: *indexes. Did you mean `indexes`?
 lib/addressable/uri.rb:296: [UnknownParam] @param tag has unknown parameter name: *uris. Did you mean `uris`?
@@ -267,8 +491,10 @@ lib/addressable/uri.rb:2023: [UnknownParam] @param tag has unknown parameter nam
 lib/addressable/uri.rb:2244: [UnknownParam] @param tag has unknown parameter name: *components. Did you mean `components`?
 lib/addressable/uri.rb:2275: [UnknownParam] @param tag has unknown parameter name: *components. Did you mean `components`?
 ```
+</details>
+
+<details><summary>hashie: 16 (mostly not escaped code in docs)</summary>
 
-hashie:
 ```
 lib/hashie/extensions/coercion.rb:68: [UnknownParam] @param tag has unknown parameter name: key
 lib/hashie/extensions/coercion.rb:69: [UnknownParam] @param tag has unknown parameter name: into
@@ -287,10 +513,12 @@ lib/hashie/extensions/deep_find.rb:36: [InvalidLink] Cannot resolve link to loca
 lib/hashie/mash.rb:32: [InvalidLink] Cannot resolve link to :a from text: {:a => {:b => 23, :d => {:e => "abc"}
 lib/hashie/mash.rb:32: [InvalidLink] Cannot resolve link to :g from text: {:g => 44, :h => 29}
 ```
+</details>
 
 ## Authors
 
-[Victor Shepelev](https://github.com/zverok)
+* [Victor Shepelev](https://github.com/zverok)
+* [Olle Jonsson](https://github.com/olleolleolle)
 
 ## License
 

data/exe/yard-junk

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib'))
+
+require 'yard'
+require 'yard-junk'
+require 'optparse'
+
+formatters = {}
+
+OptionParser.new do |opts|
+  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 'Default is: text formatter, printing to STDOUT.'
+  opts.separator ''
+
+  opts.on('--text [PATH]', 'Plaintext formatter (prints to STDOUT by default)') do |path|
+    formatters[:text] = path
+  end
+
+  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_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end.parse!
+
+formatters = {text: nil} if formatters.empty?
+
+janitor = YardJunk::Janitor.new
+janitor.run
+exit janitor.report(**formatters)

data/lib/yard-junk/janitor.rb

@@ -27,8 +27,8 @@ module YardJunk
       }
     end
 
-    def report(*reporters)
-      reporters.each do |reporter|
+    def report(*args, **opts)
+      guess_reporters(*args, **opts).each do |reporter|
         reporter.section('Errors', 'severe code or formatting problems', errors)
         reporter.section('Problems', 'mistyped tags or other typos in documentation', problems)
 
@@ -58,9 +58,19 @@ module YardJunk
     def problems
       messages.select(&:warn?)
     end
+
+    # TODO: specs for the logic
+    def guess_reporters(*symbols, **symbols_with_args)
+      symbols
+        .map { |sym| [sym, nil] }.to_h.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") }
+        .map { |name, args| Janitor.const_get(name).new(*args) }
+    end
   end
 end
 
 require_relative 'janitor/base_reporter'
 require_relative 'janitor/text_reporter'
+require_relative 'janitor/html_reporter'
 require_relative 'janitor/resolver'

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)
+      def initialize(io_or_filename = STDOUT)
         @io =
           case io_or_filename
           when ->(i) { i.respond_to?(:puts) } # quacks!

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module YardJunk
+  class Janitor
+    # Reporter that just outputs everything in HTML format. Useful
+    # for usage with Jenkins. See {BaseReporter} for details about reporters.
+    #
+    class HtmlReporter < BaseReporter
+      HEADER = <<~HTML
+        <!DOCTYPE html>
+        <html lang="en">
+          <header>
+            <meta charset='UTF-8' />
+            <title>YARD-Junk Report</title>
+            <style>
+              body, html {
+              }
+              body {
+                font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+                margin: 0;
+                padding: 20px;
+              }
+              h2 {
+                font-size: 1.6rem;
+              }
+              h2 small {
+                color: gray;
+                font-weight: normal;
+              }
+              span.path {
+                font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+                font-size: 85%;
+              }
+              .problem { color: red; }
+              .notice { color: gray; }
+              p.stats {
+                padding: 10px;
+                font-size: 1.2em;
+                border: 1px dotted silver;
+              }
+            </style>
+          </header>
+          <body>
+            <h1>YARD Validation Report</h1>
+      HTML
+
+      FOOTER = <<~HTML
+          </body>
+        </html>
+      HTML
+
+      SECTION = <<-HTML
+      <h2 class="<%= title == 'Notices' ? 'notice' : 'problem' %>">
+        <%= title %>
+        <small>(<%= explanation %>)</small>
+      </h2>
+      HTML
+
+      ROW = <<-HTML
+      <li><span class="path"><%= file %>:<%= line %></span>: <%= message %></li>
+      HTML
+
+      STATS = <<-HTML
+      <p class="stats">
+        <span class="<%= 'problem' unless errors.zero? %>"><%= errors %> failures</span>,
+        <span class="<%= 'problem' unless problems.zero? %>"><%= problems %> problems</span>
+        (ready in <%= duration %>)
+      </p>
+      HTML
+
+      Helper = Class.new(OpenStruct) do
+        def the_binding
+          binding
+        end
+      end
+
+      attr_reader :html
+
+      def initialize(*)
+        super
+        @html = HEADER.dup
+      end
+
+      def finalize
+        @html << FOOTER
+        @io.puts(@html)
+      end
+
+      private
+
+      def _stats(**stat)
+        render(STATS, **stat)
+      end
+
+      def header(title, explanation)
+        render(SECTION, title: title, explanation: explanation)
+      end
+
+      def row(message)
+        render(ROW, **message.to_h)
+      end
+
+      def render(template, values)
+        html <<
+          ERB.new(template)
+             .result(Helper.new(values).the_binding)
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rainbow'
+
 module YardJunk
   class Janitor
     # Reporter that just outputs everything in plaintext format. Useful
@@ -9,9 +11,27 @@ module YardJunk
       private
 
       def _stats(**stat)
-        line =
-          '%<errors>i failures, %<problems>i problems (%<duration>s to run)' % stat
-        @io.puts "\n#{line}"
+        @io.puts "\n#{template_for(stat) % 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
+        end
       end
 
       def header(title, explanation)

data/lib/yard-junk/rake.rb

@@ -4,12 +4,13 @@ module YardJunk
   module Rake
     extend ::Rake::DSL
 
-    def self.define_task
-      desc 'Check th junk in your YARD Documentation'
+    def self.define_task(*args)
+      desc 'Check the junk in your YARD Documentation'
       task('yard:junk') do
         require 'yard'
         require_relative '../yard-junk'
-        exit Janitor.new.run.report(Janitor::TextReporter.new(STDOUT))
+        args = :text if args.empty?
+        exit Janitor.new.run.report(*args)
       end
     end
   end

data/yard-junk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'yard-junk'
-  s.version  = '0.0.1'
+  s.version  = '0.0.2'
   s.authors  = ['Victor Shepelev']
   s.email    = 'zverok.offline@gmail.com'
   s.homepage = 'https://github.com/zverok/junk_yard'
@@ -18,16 +18,20 @@ Gem::Specification.new do |s|
     spec\/.*
     |Gemfile
     |Rakefile
+    |\.codeclimate.yml
     |\.rspec
     |\.gitignore
     |\.rubocop.yml
+    |\.rubocop_todo.yml
     |\.travis.yml
+    |\.yardopts
     )$/x
   end
   s.require_paths = ["lib"]
-  s.bindir = 'bin'
+  s.bindir = 'exe'
   s.executables << 'yard-junk'
 
+  s.add_dependency 'rainbow'
   s.add_dependency 'yard'
   if RUBY_VERSION < '2.4'
     s.add_dependency 'did_you_mean', '~> 1.0'
@@ -35,11 +39,11 @@ Gem::Specification.new do |s|
     s.add_dependency 'did_you_mean', '~> 1.1'
   end
 
-  s.add_development_dependency 'rubocop', '>= 0.30'
+  s.add_development_dependency 'rubocop', '>= 0.49'
   s.add_development_dependency 'rspec', '>= 3'
   s.add_development_dependency 'rubocop-rspec'
   s.add_development_dependency 'rspec-its', '~> 1'
-  #s.add_development_dependency 'saharspec'
+  #s.add_development_dependency 'saharspec' # saharspec is moving target!
   s.add_development_dependency 'fakefs'
   s.add_development_dependency 'simplecov', '~> 0.9'
   s.add_development_dependency 'rake'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yard-junk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-08-27 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -172,19 +186,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop_todo.yml"
-- ".yardopts"
+- Changelog.md
 - README.md
-- bin/yard-junk
 - examples/bare_log.rb
 - examples/formatted_log.rb
 - examples/input/circular_ref.rb
 - examples/input/lot_of_errors.rb
 - examples/input/unparseable.rb
+- exe/yard-junk
 - lib/yard-junk.rb
 - lib/yard-junk/command_line.rb
 - lib/yard-junk/janitor.rb
 - lib/yard-junk/janitor/base_reporter.rb
+- lib/yard-junk/janitor/html_reporter.rb
 - lib/yard-junk/janitor/resolver.rb
 - lib/yard-junk/janitor/text_reporter.rb
 - lib/yard-junk/logger.rb

data/.rubocop_todo.yml

@@ -1 +0,0 @@
-

data/.yardopts

@@ -1,2 +0,0 @@
---markup markdown
--e ./lib/yard-junk.rb

data/bin/yard-junk

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib'))
-
-require 'yard'
-require 'yard-junk'
-
-janitor = YardJunk::Janitor.new
-janitor.run
-exit janitor.report(YardJunk::Janitor::TextReporter.new(STDOUT))