rubycritic 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2b8e076626a6a29d140f9f6552b6f5829e0f8d258b9cc47afa4fc1f21acbcc
-  data.tar.gz: 6ef348632806a7a388aebadb6d53eec20870f0efc93459433debeda020126f00
+  metadata.gz: d3132430741ac30bdaa6f20f560ede65e01b93acf76b7153ae19775aeb968ee4
+  data.tar.gz: 51263545f9e96e3e17e04c2e3c43c1afe5832e112bc0f75ece347491625dc691
 SHA512:
-  metadata.gz: b081e071ffad334bb27a1e469f5debe08bd2b3cc563cf1c5196c745539c237eb640297df2936461913a1b1fc4a714a8365786191bbe016725c94a96f80b7dd74
-  data.tar.gz: a937c6a4142b87a414b513492517d4defccdf06d182b1a846fea149142d6bf10d06c42dcf62fad5edd8746d7eb7236d427d12109f0e3b13573577dc6902848c7
+  metadata.gz: 9889018dec050aeb9ec6bb29674ae687847e94dd86cf916826af7f7f3a07946ef9885341f6c9b205ebe3c62e6f22404eeab507ef58c6936dcf738a2a3200231b
+  data.tar.gz: e9de8a1897ca29f08a99fe912ffb78f7244305da7c63d0552f0ce0d702a0397247c91d27e25eef7937ccdd1bd13080fde8ab6b6f60ebb26d3d97999c8801b7ff

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.0.0...master)
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.0.1...master)
+
+# 4.0.1 / 2019-03-12 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.0.0...v4.0.1)
+
+* [FEATUE] Allow passing formatters from the outside (by [@marcgrimme][] and [@onumis][])
+* [CHANGE] Fix aruba deprecation warning
 
 # 4.0.0 / 2019-02-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v4.0.0)
 

data/README.md

@@ -112,23 +112,33 @@ For a full list of the command-line options run:
 $ rubycritic --help
 ```
 
-| Command flag                | Description                                                                                    |
-|-----------------------------|------------------------------------------------------------------------------------------------|
-| `-v` / `--version`          | Displays the current version and exits                                                         |
-| `-p` / `--path`             | Set path where report will be saved (tmp/rubycritic by default)                                |
-| `-f` / `--format`           | Report smells in the given format: `html` (default; will open in a browser), `json`, `console` |
-| `-s` / `--minimum-score`    | Set a minimum score (FLOAT: ex: 96.28), default: 0                                             |
-| `-m` / `--mode-ci`          | Use CI mode. Faster, analyses diffs w.r.t base_branch (default: master), see -b                |
-| `-b` / `--branch`           | Set branch to compare                                                                          |
-| `-t` / `--maximum-decrease` | Set a threshold for score difference between two branches (works only with -b), default: 0     |
-| `--deduplicate-symlinks`    | De-duplicate symlinks based on their final target                                              |
-| `--suppress-ratings`        | Suppress letter ratings                                                                        |
-| `--no-browser`              | Do not open html report with browser                                                           |
+| Command flag                        | Description                                                     |
+|-------------------------------------|-----------------------------------------------------------------|
+| `-v` / `--version`                  | Displays the current version and exits                          |
+| `-p` / `--path`                     | Set path where report will be saved (tmp/rubycritic by default) |
+| `-f` / `--format`                   | Report smells in the given format(s)<sup>1</sup>                |
+| `--custom-format path:classname`    | Load and instantiate custom formatter(s)<sup>2</sup>            |
+| `-s` / `--minimum-score`            | Set a minimum score (FLOAT: ex: 96.28), default: 0              |
+| `-m` / `--mode-ci`                  | Use CI mode<sup>3</sup>                                         |
+| `-b` / `--branch`                   | Set branch to compare                                           |
+| `-t` / `--maximum-decrease`         | Threshold for score difference between two branches<sup>4</sup> |
+| `--deduplicate-symlinks`            | De-duplicate symlinks based on their final target               |
+| `--suppress-ratings`                | Suppress letter ratings                                         |
+| `--no-browser`                      | Do not open html report with browser                            |
+
+1. Available output formats:
+- `html` (default; will open in a browser)
+- `json`
+- `console`
+- `lint`
+2. See [custom formatters docs](/docs/formatters.md)
+3. Faster, analyses diffs w.r.t base_branch (default: master), see `-b`
+4. Works only with `-b`, default: 0
 
 You also can use a config file. Just create a `.rubycritic.yml` on your project root path.
 
 Here are one example:
-```
+```yml
 mode_ci:
   enabled: true # default is false
   branch: 'production' # default is master
@@ -202,16 +212,18 @@ RubyCritic::RakeTask.new do |task|
 end
 ```
 
+## Formatters
+
+See [formatters](docs/formatters.md)
 
 ## Compatibility
 
 RubyCritic is supporting Ruby versions:
 
-* 2.1
-* 2.2
 * 2.3
 * 2.4
 * 2.5
+* 2.6
 
 
 ## Improving RubyCritic

data/lib/rubycritic/cli/options.rb

@@ -16,7 +16,6 @@ module RubyCritic
       def parse
         argv_options.parse
         file_options.parse
-
         self
       end
 

data/lib/rubycritic/cli/options/argv.rb

@@ -5,13 +5,14 @@ require 'optparse'
 module RubyCritic
   module Cli
     class Options
+      # rubocop:disable Metrics/ClassLength
       class Argv
         def initialize(argv)
           @argv = argv
           self.parser = OptionParser.new
         end
 
-        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
         def parse
           parser.new do |opts|
             opts.banner = 'Usage: rubycritic [options] [paths]'
@@ -43,11 +44,28 @@ module RubyCritic
               '  html (default; will open in a browser)',
               '  json',
               '  console',
-              '  lint'
+              '  lint',
+              'Multiple formats are supported.'
             ) do |format|
               formats << format
             end
 
+            formatters = []
+            self.formatters = formatters
+            opts.on(
+              '--custom-format [REQUIREPATH]:[CLASSNAME]|[CLASSNAME]',
+              'Instantiate a given class as formatter and call report for reporting.',
+              'Two ways are possible to load the formatter.',
+              'If the class is not autorequired the REQUIREPATH can be given together',
+              'with the CLASSNAME to be loaded seperated by a :.',
+              'Example: rubycritic/markdown/reporter.rb:RubyCritic::MarkDown::Reporter',
+              'or if the file is already required the CLASSNAME is enough',
+              'Example: RubyCritic::MarkDown::Reporter',
+              'Multiple formatters are supported.'
+            ) do |formatter|
+              formatters << formatter
+            end
+
             opts.on('-s', '--minimum-score [MIN_SCORE]', 'Set a minimum score') do |min_score|
               self.minimum_score = Float(min_score)
             end
@@ -86,6 +104,7 @@ module RubyCritic
             mode: mode,
             root: root,
             formats: formats,
+            formatters: formatters,
             deduplicate_symlinks: deduplicate_symlinks,
             paths: paths,
             suppress_ratings: suppress_ratings,
@@ -97,11 +116,11 @@ module RubyCritic
             threshold_score: threshold_score
           }
         end
-        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
 
         private
 
-        attr_accessor :mode, :root, :formats, :deduplicate_symlinks,
+        attr_accessor :mode, :root, :formats, :formatters, :deduplicate_symlinks,
                       :suppress_ratings, :minimum_score, :no_browser,
                       :parser, :base_branch, :feature_branch, :threshold_score
         def paths
@@ -112,6 +131,7 @@ module RubyCritic
           self.feature_branch = SourceControlSystem::Git.current_branch
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/rubycritic/configuration.rb

@@ -5,7 +5,7 @@ require 'rubycritic/source_control_systems/base'
 module RubyCritic
   class Configuration
     attr_reader :root
-    attr_accessor :source_control_system, :mode, :formats, :deduplicate_symlinks,
+    attr_accessor :source_control_system, :mode, :formats, :formatters, :deduplicate_symlinks,
                   :suppress_ratings, :open_with, :no_browser, :base_branch,
                   :feature_branch, :base_branch_score, :feature_branch_score,
                   :base_root_directory, :feature_root_directory,
@@ -15,7 +15,6 @@ module RubyCritic
     def set(options)
       self.mode = options[:mode] || :default
       self.root = options[:root] || 'tmp/rubycritic'
-      self.formats = options[:formats] || [:html]
       self.deduplicate_symlinks = options[:deduplicate_symlinks]
       self.suppress_ratings = options[:suppress_ratings]
       self.open_with = options[:open_with]
@@ -23,6 +22,12 @@ module RubyCritic
       self.base_branch = options[:base_branch]
       self.feature_branch = options[:feature_branch]
       self.threshold_score = options[:threshold_score].to_i
+      setup_formats(options)
+    end
+
+    def setup_formats(options)
+      self.formats = options[:formats] || [:html]
+      self.formatters = options[:formatters] || []
     end
 
     def root=(path)

data/lib/rubycritic/reporter.rb

@@ -5,9 +5,12 @@ module RubyCritic
     REPORT_GENERATOR_CLASS_FORMATS = %i[json console lint].freeze
 
     def self.generate_report(analysed_modules)
-      Config.formats.uniq.each do |format|
+      RubyCritic::Config.formats.uniq.each do |format|
         report_generator_class(format).new(analysed_modules).generate_report
       end
+      RubyCritic::Config.formatters.each do |formatter|
+        report_generator_class_from_formatter(formatter).new(analysed_modules).generate_report
+      end
     end
 
     def self.report_generator_class(config_format)
@@ -19,5 +22,18 @@ module RubyCritic
         Generator::HtmlReport
       end
     end
+
+    def self.report_generator_class_from_formatter(formatter)
+      require_path, class_name = formatter.sub(/([^:]):([^:])/, '\1\;\2').split('\;', 2)
+      class_name ||= require_path
+      require require_path unless require_path == class_name
+      class_from_path(class_name)
+    end
+
+    def self.class_from_path(path)
+      path.split('::').inject(Object) { |obj, klass| obj.const_get klass }
+    rescue NameError => error
+      raise "Could not create reporter for class #{path}. Error: #{error}!"
+    end
   end
 end

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay