yard-junk 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d528277a6fb7bba1da971f94aae6b57026c389f3
-  data.tar.gz: 1e87ce70c14f718fcb2cd46eb4dcc5bbb86824e1
+  metadata.gz: d2951dd9b76ead149237efbb2d837868f334db37
+  data.tar.gz: 6b9e03ce2ec1b7f2c6eebb3fa7a23fa2bad10c95
 SHA512:
-  metadata.gz: b8a095dad1cbc9da2e87a038ed30f563982ac38eb0f18c4f060cf0251ded6fea8cb40eccfb2405710789933b7f5c54faff649626e725678ef675bf3b35dd6d91
-  data.tar.gz: 2466c0a768593a605283f7c136bfb4d012a28701dbf3b32026e48da138162528fd9789275bba4c7dfa94aa6d8a3db6136ae4b91419a5727ab317722d9552dc83
+  metadata.gz: 5b007c4ee552650b8c49d13619cbb98fb3dad7855ebf7a807c0c32ded821535197266e6511ef5754097937286a5bf1832e748fb824c38f9529914322e158e810
+  data.tar.gz: f58438719e6d9a11a7bd995d336e09f97b59aeaf5b81094e46fe7852ebfebe9c574f0fcd80455163333213c4f5f4da71130dac193a77b7dacdf73f63a07c89b7

data/Changelog.md

@@ -1,5 +1,9 @@
 # Yard-Junk changelog
 
+## 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/README.md

@@ -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`:
@@ -425,8 +438,7 @@ Therefore, this independent tool was made.
 
 * 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,6 +8,7 @@ require 'yard-junk'
 require 'optparse'
 
 formatters = {}
+check_path = nil
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: yard-junk [formatters]'
@@ -28,6 +29,15 @@ OptionParser.new do |opts|
   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|
+    check_path = patterns.split(',')
+  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
@@ -38,4 +48,4 @@ formatters = {text: nil} if formatters.empty?
 
 janitor = YardJunk::Janitor.new
 janitor.run
-exit janitor.report(**formatters)
+exit janitor.report(path: check_path, **formatters)

data/lib/yard-junk.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+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/janitor.rb

@@ -7,9 +7,9 @@ module YardJunk
   class Janitor
     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
@@ -20,20 +20,20 @@ module YardJunk
       self
     end
 
-    def stats
+    def stats(path = nil)
       {
-        errors: errors.count,
-        problems: problems.count,
+        errors: filter(errors, path).count,
+        problems: filter(problems, path).count,
         duration: @duration || 0
       }
     end
 
-    def report(*args, **opts)
+    def report(*args, path: nil, **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)
+        reporter.section('Errors', 'severe code or formatting problems', filter(errors, path))
+        reporter.section('Problems', 'mistyped tags or other typos in documentation', filter(problems, path))
 
-        reporter.stats(stats)
+        reporter.stats(stats(path))
         reporter.finalize
       end
 
@@ -60,6 +60,16 @@ module YardJunk
       messages.select(&:warn?)
     end
 
+    def filter(messages, pathes)
+      return messages unless pathes
+      filters =
+        Array(pathes)
+        .map { |path| File.directory?(path) ? File.join(path, '**', '*.*') : path }
+        .flat_map(&Dir.method(:[]))
+        .map(&File.method(:expand_path))
+      messages.select { |m| filters.include?(File.expand_path(m.file)) }
+    end
+
     # TODO: specs for the logic
     def guess_reporters(*symbols, **symbols_with_args)
       symbols

data/lib/yard-junk/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module YardJunk
+  # @private
+  MAJOR = 0
+  # @private
+  MINOR = 0
+  # @private
+  PATCH = 4
+
+  # @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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-junk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Victor Shepelev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -218,6 +218,7 @@ files:
 - lib/yard-junk/logger.rb
 - lib/yard-junk/logger/message.rb
 - lib/yard-junk/rake.rb
+- lib/yard-junk/version.rb
 - yard-junk.gemspec
 homepage: https://github.com/zverok/junk_yard
 licenses: