reek 3.6.1 → 3.7.0

data/lib/reek/cli/options.rb

@@ -9,7 +9,7 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 6 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
     # :reek:Attribute: { enabled: false }
     class Options
       attr_reader :argv, :parser, :smells_to_detect
@@ -26,6 +26,7 @@ module Reek
         @parser           = OptionParser.new
         @report_format    = :text
         @location_format  = :numbers
+        @show_links       = true
         @smells_to_detect = []
         @colored          = color_support?
 
@@ -72,9 +73,9 @@ module Reek
       def set_alternative_formatter_options
         parser.separator "\nReport format:"
         parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :code_climate],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml'
+          '  html', '  text (default)', '  yaml', '  json', '  xml', '  code_climate'
         ) do |opt|
           self.report_format = opt
         end
@@ -112,7 +113,7 @@ module Reek
           self.show_empty = show_empty
         end
         parser.on('-U', '--[no-]wiki-links',
-                  'Show link to related wiki page for each smell (default: false)') do |show_links|
+                  'Show link to related wiki page for each smell (default: true)') do |show_links|
           self.show_links = show_links
         end
       end

data/lib/reek/cli/warning_collector.rb

@@ -16,7 +16,7 @@ module Reek
       end
 
       def warnings
-        warnings_set.to_a.sort
+        warnings_set.sort
       end
 
       private

data/lib/reek/report.rb

@@ -12,7 +12,8 @@ module Reek
       json: JSONReport,
       html: HTMLReport,
       xml: XMLReport,
-      text: TextReport
+      text: TextReport,
+      code_climate: CodeClimateReport
     }
 
     LOCATION_FORMATTERS = {

data/lib/reek/report/code_climate_formatter.rb

@@ -0,0 +1,46 @@
+require 'codeclimate_engine'
+require 'private_attr'
+
+module Reek
+  module Report
+    # Generates a hash in the structure specified by the Code Climate engine spec
+    class CodeClimateFormatter
+      private_attr_reader :warning
+
+      def initialize(warning)
+        @warning = warning
+      end
+
+      def to_hash
+        CCEngine::Issue.new(check_name: check_name,
+                            description: description,
+                            categories: categories,
+                            location: location
+                           ).to_hash
+      end
+
+      private
+
+      def description
+        [warning.context, warning.message].join(' ')
+      end
+
+      def check_name
+        [warning.smell_category, warning.smell_type].join('/')
+      end
+
+      def categories
+        # TODO: provide mappings for Reek's smell categories
+        ['Complexity']
+      end
+
+      def location
+        warning_lines = warning.lines
+        CCEngine::Location::LineRange.new(
+          path: warning.source,
+          line_range: warning_lines.first..warning_lines.last
+        )
+      end
+    end
+  end
+end

data/lib/reek/report/formatter.rb

@@ -1,5 +1,6 @@
 require 'private_attr/everywhere'
 require_relative 'location_formatter'
+require_relative '../report/code_climate_formatter'
 
 module Reek
   module Report
@@ -9,13 +10,13 @@ module Reek
     # passed-in warning formatter.
     #
     module Formatter
-      def self.format_list(warnings, formatter: SimpleWarningFormatter.new)
-        warnings.map do |warning|
-          "  #{formatter.format warning}"
-        end.join("\n")
+      module_function
+
+      def format_list(warnings, formatter: SimpleWarningFormatter.new)
+        warnings.map { |warning| "  #{formatter.format(warning)}" }.join("\n")
       end
 
-      def self.header(examiner)
+      def header(examiner)
         count = examiner.smells_count
         result = Rainbow("#{examiner.description} -- ").cyan +
           Rainbow("#{count} warning").yellow
@@ -42,6 +43,11 @@ module Reek
         warning.yaml_hash
       end
 
+      # :reek:UtilityFunction
+      def format_code_climate_hash(warning)
+        CodeClimateFormatter.new(warning).to_hash
+      end
+
       private_attr_reader :location_formatter
     end
 
@@ -53,12 +59,11 @@ module Reek
       BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/blob/master/docs/'
 
       def format(warning)
-        "#{super} " \
-          "[#{explanatory_link(warning)}]"
+        "#{super} [#{explanatory_link(warning)}]"
       end
 
       def format_hash(warning)
-        super(warning).merge('wiki_link' => explanatory_link(warning))
+        super.merge('wiki_link' => explanatory_link(warning))
       end
 
       private

data/lib/reek/report/report.rb

@@ -143,6 +143,18 @@ module Reek
       end
     end
 
+    #
+    # Displays a list of smells in Code Climate engine format
+    # (https://github.com/codeclimate/spec/blob/master/SPEC.md)
+    # JSON with empty array for 0 smells
+    #
+    class CodeClimateReport < Base
+      # @public
+      def show(out = $stdout)
+        out.print ::JSON.generate smells.map { |smell| warning_formatter.format_code_climate_hash(smell) }
+      end
+    end
+
     #
     # Saves the report as a HTML file
     #

data/lib/reek/smells/smell_warning.rb

@@ -61,13 +61,13 @@ module Reek
       end
 
       def base_message
-        "#{context} #{message} (#{smell_type})"
+        "#{smell_type}: #{context} #{message}"
       end
 
       protected
 
       def sort_key
-        [context, message, smell_category]
+        [smell_type, context, message]
       end
 
       private

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.6.1'
+    STRING = '3.7.0'
   end
 end

data/reek.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'parser',       '~> 2.2', '>= 2.2.2.5'
-  s.add_runtime_dependency 'private_attr', '~> 1.1'
-  s.add_runtime_dependency 'rainbow',      '~> 2.0'
-  s.add_runtime_dependency 'unparser',     '~> 0.2.2'
+  s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.1.0'
+  s.add_runtime_dependency 'parser',                '~> 2.2', '>= 2.2.2.5'
+  s.add_runtime_dependency 'private_attr',          '~> 1.1'
+  s.add_runtime_dependency 'rainbow',               '~> 2.0'
+  s.add_runtime_dependency 'unparser',              '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
   s.add_development_dependency 'aruba',         '~> 0.10.0'

data/spec/reek/report/code_climate_formatter_spec.rb

@@ -0,0 +1,63 @@
+require_relative '../../spec_helper'
+require_lib 'reek/report/code_climate_formatter'
+
+RSpec.describe Reek::Report::CodeClimateFormatter, '#to_hash' do
+  it "sets the type as 'issue'" do
+    warning = FactoryGirl.build(:smell_warning)
+    issue = Reek::Report::CodeClimateFormatter.new(warning)
+
+    result = issue.to_hash
+
+    expect(result).to include(type: 'issue')
+  end
+
+  it 'sets the category' do
+    warning = FactoryGirl.build(:smell_warning)
+    issue = Reek::Report::CodeClimateFormatter.new(warning)
+
+    result = issue.to_hash
+
+    expect(result).to include(categories: ['Complexity'])
+  end
+
+  it 'constructs a description based on the context and message' do
+    warning = FactoryGirl.build(:smell_warning,
+                                context: 'context foo',
+                                message: 'message bar')
+    issue = Reek::Report::CodeClimateFormatter.new(warning)
+
+    result = issue.to_hash
+
+    expect(result).to include(
+      description: 'context foo message bar')
+  end
+
+  it 'sets a check name based on the smell detector' do
+    warning = FactoryGirl.build(:smell_warning,
+                                smell_detector: Reek::Smells::UtilityFunction.new)
+    issue = Reek::Report::CodeClimateFormatter.new(warning)
+
+    result = issue.to_hash
+
+    expect(result).to include(check_name: 'LowCohesion/UtilityFunction')
+  end
+
+  it 'sets the location' do
+    warning = FactoryGirl.build(:smell_warning,
+                                lines: [1, 2],
+                                source: 'a/ruby/source/file.rb')
+    issue = Reek::Report::CodeClimateFormatter.new(warning)
+
+    result = issue.to_hash
+
+    expect(result).to include(
+      location: {
+        path: 'a/ruby/source/file.rb',
+        lines: {
+          begin: 1,
+          end: 2
+        }
+      }
+    )
+  end
+end

data/spec/reek/report/code_climate_report_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../../spec_helper'
+require_lib 'reek/examiner'
+require_lib 'reek/report/report'
+require_lib 'reek/report/formatter'
+
+require 'json'
+require 'stringio'
+
+RSpec.describe Reek::Report::CodeClimateReport do
+  let(:options) { {} }
+  let(:instance) { Reek::Report::CodeClimateReport.new(options) }
+  let(:examiner) { Reek::Examiner.new(source) }
+
+  before do
+    instance.add_examiner examiner
+  end
+
+  context 'with empty source' do
+    let(:source) { '' }
+
+    it 'prints empty json' do
+      expect { instance.show }.to output(/^\[\]$/).to_stdout
+    end
+  end
+
+  context 'with smelly source' do
+    let(:source) { 'def simple(a) a[3] end' }
+
+    it 'prints smells as json' do
+      out = StringIO.new
+      instance.show(out)
+      out.rewind
+      result = JSON.parse(out.read)
+      expected = JSON.parse <<-EOS
+        [
+          {
+            "type": "issue",
+            "check_name": "UncommunicativeName/UncommunicativeParameterName",
+            "description": "simple has the parameter name 'a'",
+            "categories": ["Complexity"],
+            "location": {
+              "path": "string",
+              "lines": {
+                "begin": 1,
+                "end": 1
+              }
+            }
+          },
+          {
+            "type": "issue",
+            "check_name": "LowCohesion/UtilityFunction",
+            "description": "simple doesn't depend on instance state (maybe move it to another class?)",
+            "categories": ["Complexity"],
+            "location": {
+              "path": "string",
+              "lines": {
+                "begin": 1,
+                "end": 1
+              }
+            }
+          }
+        ]
+      EOS
+
+      expect(result).to eq expected
+    end
+  end
+end

data/spec/reek/report/json_report_spec.rb

@@ -36,20 +36,20 @@ RSpec.describe Reek::Report::JSONReport do
           {
             "context":        "simple",
             "lines":          [1],
-            "message":        "doesn't depend on instance state (maybe move it to another class?)",
-            "smell_category": "LowCohesion",
-            "smell_type":     "UtilityFunction",
+            "message":        "has the parameter name 'a'",
+            "smell_category": "UncommunicativeName",
+            "smell_type":     "UncommunicativeParameterName",
             "source":         "string",
-            "name":           "simple"
+            "name":           "a"
           },
           {
             "context":        "simple",
             "lines":          [1],
-            "message":        "has the parameter name 'a'",
-            "smell_category": "UncommunicativeName",
-            "smell_type":     "UncommunicativeParameterName",
+            "message":        "doesn't depend on instance state (maybe move it to another class?)",
+            "smell_category": "LowCohesion",
+            "smell_type":     "UtilityFunction",
             "source":         "string",
-            "name":           "a"
+            "name":           "simple"
           }
         ]
       EOS
@@ -67,16 +67,6 @@ RSpec.describe Reek::Report::JSONReport do
         result = JSON.parse(out.read)
         expected = JSON.parse <<-EOS
           [
-            {
-              "context":        "simple",
-              "lines":          [1],
-              "message":        "doesn't depend on instance state (maybe move it to another class?)",
-              "smell_category": "LowCohesion",
-              "smell_type":     "UtilityFunction",
-              "source":         "string",
-              "name":           "simple",
-              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
-            },
             {
               "context":        "simple",
               "lines":          [1],
@@ -86,6 +76,16 @@ RSpec.describe Reek::Report::JSONReport do
               "source":         "string",
               "name":           "a",
               "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+            },
+            {
+              "context":        "simple",
+              "lines":          [1],
+              "message":        "doesn't depend on instance state (maybe move it to another class?)",
+              "smell_category": "LowCohesion",
+              "smell_type":     "UtilityFunction",
+              "source":         "string",
+              "name":           "simple",
+              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
             }
           ]
         EOS

data/spec/reek/report/yaml_report_spec.rb

@@ -33,14 +33,6 @@ RSpec.describe Reek::Report::YAMLReport do
       result = YAML.load(out.read)
       expected = YAML.load <<-EOS
 ---
-- context:        "simple"
-  lines:
-  - 1
-  message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_category: "LowCohesion"
-  smell_type:     "UtilityFunction"
-  source:         "string"
-  name:           "simple"
 - context:        "simple"
   lines:
   - 1
@@ -49,6 +41,14 @@ RSpec.describe Reek::Report::YAMLReport do
   smell_type:     "UncommunicativeParameterName"
   source:         "string"
   name:           "a"
+- context:        "simple"
+  lines:
+  - 1
+  message:        "doesn't depend on instance state (maybe move it to another class?)"
+  smell_category: "LowCohesion"
+  smell_type:     "UtilityFunction"
+  source:         "string"
+  name:           "simple"
       EOS
 
       expect(result).to eq expected
@@ -63,15 +63,6 @@ RSpec.describe Reek::Report::YAMLReport do
         result = YAML.load(out.read)
         expected = YAML.load <<-EOS
 ---
-- context:        "simple"
-  lines:
-  - 1
-  message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_category: "LowCohesion"
-  smell_type:     "UtilityFunction"
-  source:         "string"
-  name:           "simple"
-  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
 - context:        "simple"
   lines:
   - 1
@@ -81,6 +72,15 @@ RSpec.describe Reek::Report::YAMLReport do
   source:         "string"
   name:           "a"
   wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+- context:        "simple"
+  lines:
+  - 1
+  message:        "doesn't depend on instance state (maybe move it to another class?)"
+  smell_category: "LowCohesion"
+  smell_type:     "UtilityFunction"
+  source:         "string"
+  name:           "simple"
+  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
         EOS
 
         expect(result).to eq expected