Merge pull request #305 from troessner/add-ultra-verbose-warning-form…

…atter Add ultra verbose warning formatter.
troessner · Nov 5, 2014 · 4ebaf12 · 4ebaf12
2 parents cd99688 + a9cc0f3
commit 4ebaf12
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/features/command_line_interface/options.feature b/features/command_line_interface/options.feature
@@ -42,6 +42,7 @@ Feature: Reek can be controlled using command-line options
           -o, --[no-]color                 Use colors for the output (this is the default)
           -q, --quiet                      Suppress headings for smell-free source files (this is the default)
           -V, --no-quiet, --verbose        Show headings for smell-free source files
+          -U, --ultra-verbose              Be as explanatory as possible
           -n, --no-line-numbers            Suppress line numbers from the output
               --line-numbers               Show line numbers in the output (this is the default)
           -s, --single-line                Show IDE-compatible single-line-per-warning

diff --git a/features/reports/reports.feature b/features/reports/reports.feature
@@ -187,3 +187,19 @@ Feature: Correctly formatted reports
       | args |
       | spec/samples/two_smelly_files/ |
       | spec/samples/two_smelly_files  |
+
+  Scenario Outline: -U or --ultra-verbose adds helpful links to smell warnings
+    When I run reek <option> spec/samples/one_smelly_file/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/one_smelly_file/dirty.rb -- 3 warnings:
+        [1]:D has no descriptive comment (IrresponsibleModule) [https://github.com/troessner/reek/wiki/IrresponsibleModule]
+        [1]:D has the name 'D' (UncommunicativeModuleName) [https://github.com/troessner/reek/wiki/UncommunicativeModuleName]
+        [2]:D#a has the name 'a' (UncommunicativeMethodName) [https://github.com/troessner/reek/wiki/UncommunicativeMethodName]
+      """
+
+    Examples:
+      | option           |
+      | -U               |
+      | --ultra-verbose  |
diff --git a/lib/reek/cli/options.rb b/lib/reek/cli/options.rb
@@ -88,6 +88,9 @@ def set_options
         @parser.on('-V', '--no-quiet', '--verbose', 'Show headings for smell-free source files') do |_opt|
           @strategy = Report::Strategy::Verbose
         end
+        @parser.on('-U', '--ultra-verbose', 'Be as explanatory as possible') do |_opt|
+          @warning_formatter = Report::UltraVerboseWarningFormattter
+        end
         @parser.on('-n', '--no-line-numbers', 'Suppress line numbers from the output') do
           @warning_formatter = Report::SimpleWarningFormatter
         end

diff --git a/lib/reek/cli/report/formatter.rb b/lib/reek/cli/report/formatter.rb
@@ -16,6 +16,20 @@ def self.header(examiner)
         end
       end
 
+      module UltraVerboseWarningFormattter
+        BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/wiki/'
+
+        module_function
+
+        def format(warning)
+          "#{WarningFormatterWithLineNumbers.format(warning)} [#{explanatory_link(warning)}]"
+        end
+
+        def explanatory_link(warning)
+          "#{BASE_URL_FOR_HELP_LINK}#{warning.subclass}"
+        end
+      end
+
       module SimpleWarningFormatter
         def self.format(warning)
           "#{warning.context} #{warning.message} (#{warning.subclass})"

diff --git a/spec/samples/one_smelly_file/dirty.rb b/spec/samples/one_smelly_file/dirty.rb
@@ -0,0 +1,3 @@
+class D
+  def a; end
+end