reek 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e9938a6d72e1e64ab84f0cbfc67d43574a0d9b8
-  data.tar.gz: 102ac522a9e2df22fbbec630f09d97174e4e5bd0
+  metadata.gz: f4119a0e66c059ea4a0d565bfab3ecfaeef3c722
+  data.tar.gz: 60149f1e3dda3e9f1b9f1e03f2287817ab9715ce
 SHA512:
-  metadata.gz: c7b67443588cd094db2a47cd4fddf96190ea87c4c44e68fe6620f86638346e1dc38ad9e84941e6939360765762738b3fa5902289db52f2fa1ef1e78066b412ef
-  data.tar.gz: 16a5d7d2c2750e4a7d1324ca9bb6076fb3caad8eb929fb319dff712e895c6ffe73420e4f914317a5981f26300dc3fe5f1c926e36e69dd1ed7b1bbed0214ff2a8
+  metadata.gz: de5e40087670fc35f74a341f9e50c477aa1deaeb914abe7466afe4ce53efaf9fb38633b814424cc50cc20aa08e1563f1e65169d159bc29b6e720f012d11b628b
+  data.tar.gz: ed3e2bddfbc5e369f1079da7e1a7684dc6ab28d1ad6d64625541587ec47c0173b7596de15ac4b26737401a6cb0d9ec82a8c0696cd88603e57772530254ead51f

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 2.0.1
+
+* (leonelgalan) Add support for json reports
+* (chastell) Escape Regexp-like Strings on CodeContext matches (Bug https://github.com/troessner/reek/pull/397)
+
 == 2.0.0
 
 * (troessner) Revise, improve & refactor our Rspec matcher and remove smell_of

data/README.md

@@ -209,8 +209,9 @@ If you don't feel like getting your hands dirty with code there are still other
 `reek` supports 3 output formats:
 
 * plain text (default)
-* html (-H, --html)
-* yaml (-y, --yaml)
+* html (`--format html`)
+* yaml (`--format yaml`)
+* json (`--format json`)
 
 ## Additional resources
 
@@ -229,3 +230,13 @@ Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
 
 * [Stack Overflow](http://stackoverflow.com/questions/tagged/reek)
 * [RDoc](http://rdoc.info/projects/troessner/reek)
+
+## Contributors
+
+A non exhaustive list:
+
+* Kevin Rutherford
+* Matijs van Zuijlen
+* Andrew Wagner
+* Gilles Leblanc
+* Timo Rößner

data/Rakefile

@@ -3,4 +3,5 @@ require 'bundler/gem_tasks'
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task default: [:test, :rubocop]
+task default: :test
+task default: :rubocop unless RUBY_ENGINE == 'rbx'

data/features/command_line_interface/options.feature

@@ -1,4 +1,3 @@
-@options
 Feature: Reek can be controlled using command-line options
   In order to change reek's default behaviour
   As a developer
@@ -8,7 +7,7 @@ Feature: Reek can be controlled using command-line options
     When I run reek --no-such-option
     Then the exit status indicates an error
     And it reports the error "Error: invalid option: --no-such-option"
-    And stdout equals ""
+    And there is no output on stdout
 
   Scenario: display the current version number
     When I run reek --version
@@ -39,6 +38,7 @@ Feature: Reek can be controlled using command-line options
                                              html
                                              text (default)
                                              yaml
+                                             json
 
       Text format options:
               --[no-]color                 Use colors for the output (this is the default)
@@ -53,5 +53,4 @@ Feature: Reek can be controlled using command-line options
       Utility options:
           -h, --help                       Show this message
           -v, --version                    Show version
-
       """

data/features/command_line_interface/smell_selection.feature

@@ -15,5 +15,4 @@ Feature: Smell selection
         Dirty#a calls @s.title 2 times (DuplicateMethodCall)
         Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
       4 total warnings
-
       """

data/features/command_line_interface/smells_count.feature

@@ -1,4 +1,3 @@
-@smells_count
 Feature: Reports total number of code smells
   In order to monitor the total number of smells
   Reek outputs the total number of smells among all files inspected.
@@ -44,6 +43,5 @@ Feature: Reports total number of code smells
     Then it succeeds
     And it reports:
     """
-
     0 total warnings
     """

data/features/command_line_interface/stdin.feature

@@ -1,4 +1,3 @@
-@stdin
 Feature: Reek reads from $stdin when no files are given
   In order to use reek with pipelines
   As a developer
@@ -7,14 +6,12 @@ Feature: Reek reads from $stdin when no files are given
   Scenario: return zero status with no smells
     When I pass "def simple() @fred = 3 end" to reek
     Then it succeeds
-    And it reports:
-      """
-      """
+    And it reports nothing
 
   Scenario: outputs nothing on empty stdin
     When I pass "" to reek
     Then it succeeds
-    And stdout equals ""
+    And it reports nothing
 
   Scenario: outputs header only on empty stdin in verbose mode
     When I pass "" to reek -V
@@ -22,7 +19,6 @@ Feature: Reek reads from $stdin when no files are given
     And it reports:
       """
       $stdin -- 0 warnings
-
       """
 
   Scenario: return non-zero status when there are smells
@@ -34,13 +30,10 @@ Feature: Reek reads from $stdin when no files are given
         [1]:Turn has no descriptive comment (IrresponsibleModule)
         [1]:Turn has the variable name '@x' (UncommunicativeVariableName)
         [1]:Turn#y has the name 'y' (UncommunicativeMethodName)
-
       """
 
-  @stderr
   Scenario: syntax error causes the source to be ignored
     When I pass "def incomplete" to reek
     Then it reports a parsing error
     Then it succeeds
-    And stdout equals ""
-
+    And it reports nothing

data/features/configuration_files/masking_smells.feature

@@ -1,4 +1,3 @@
-@masking
 Feature: Masking smells using config files
   In order to keep my reports meaningful
   As a developer
@@ -23,9 +22,7 @@ Feature: Masking smells using config files
     When I run reek -c spec/samples/corrupt_config_file/corrupt.reek spec/samples/corrupt_config_file
     Then it reports the error 'Error: Invalid configuration file "corrupt.reek" -- Not a hash'
     And the exit status indicates an error
-    And it reports:
-      """
-      """
+    And it reports nothing
 
   Scenario: missing source file is an error
     When I run reek spec/samples/missing_source_file/dirty.rb
@@ -65,7 +62,6 @@ Feature: Masking smells using config files
         [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
-  @comments
   Scenario: provide extra masking inline in comments
     When I run reek -c spec/samples/inline_config/masked.reek spec/samples/inline_config
     Then the exit status indicates smells

data/features/configuration_files/overrides_defaults.feature

@@ -1,4 +1,3 @@
-@overrides_defaults
 Feature: Overriding current rules by specifying new configuration values
   In order to customize Reek to suit my needs
   As a developer

data/features/rake_task/rake_task.feature

@@ -1,4 +1,3 @@
-@rake
 Feature: Reek can be driven through its Task
   Reek provides an easy way to integrate its use into Rakefiles,
   via the Task class. These scenarios test its various options.
@@ -79,6 +78,4 @@ Feature: Reek can be driven through its Task
       end
       """
     Then it succeeds
-    And it reports:
-      """
-      """
+    And it reports nothing

data/features/reports/json.feature

@@ -0,0 +1,73 @@
+Feature: Report smells using simple JSON layout
+  In order to parse reek's output simply and consistently, simply
+  output a list of smells in JSON.
+
+  Scenario: output is empty when there are no smells
+    When I run reek --format json spec/samples/three_clean_files
+    Then it succeeds
+    And it reports this JSON:
+    """
+    []
+    """
+
+  Scenario: Indicate smells and print them as JSON when using files
+    When I run reek --format json spec/samples/standard_smelly/minimal_dirty.rb
+    Then the exit status indicates smells
+    And it reports this JSON:
+      """
+      [
+          {
+              "smell_category": "IrresponsibleModule",
+              "smell_type": "IrresponsibleModule",
+              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
+              "context": "C",
+              "lines": [
+                  1
+              ],
+              "message": "has no descriptive comment",
+              "name": "C"
+          },
+          {
+              "smell_category": "UncommunicativeName",
+              "smell_type": "UncommunicativeModuleName",
+              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
+              "context": "C",
+              "lines": [
+                  1
+              ],
+              "message": "has the name 'C'",
+              "name": "C"
+          },
+          {
+              "smell_category": "UncommunicativeName",
+              "smell_type": "UncommunicativeMethodName",
+              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
+              "context": "C#m",
+              "lines": [
+                  2
+              ],
+              "message": "has the name 'm'",
+              "name": "m"
+          }
+      ]
+      """
+
+  Scenario: Indicate smells and print them as JSON when using STDIN
+    When I pass "class Turn; end" to reek --format json
+    Then the exit status indicates smells
+    And it reports this JSON:
+      """
+      [
+          {
+              "smell_category": "IrresponsibleModule",
+              "smell_type": "IrresponsibleModule",
+              "source": "$stdin",
+              "context": "Turn",
+              "lines": [
+                  1
+              ],
+              "message": "has no descriptive comment",
+              "name": "Turn"
+          }
+      ]
+      """

data/features/reports/reports.feature

@@ -1,4 +1,3 @@
-@reports
 Feature: Correctly formatted reports
   In order to get the most out of reek
   As a developer
@@ -87,7 +86,6 @@ Feature: Correctly formatted reports
     Then it succeeds
     And it reports:
       """
-
       0 total warnings
       """
 
@@ -117,7 +115,6 @@ Feature: Correctly formatted reports
     Then it succeeds
     And it reports:
     """
-
     0 total warnings
     """
 

data/features/reports/yaml.feature

@@ -1,4 +1,3 @@
-@yaml
 Feature: Report smells using simple YAML layout
   In order to parse reek's output simply and consistently, simply
   output a list of smells in Yaml.

data/features/ruby_api/api.feature

@@ -1,4 +1,3 @@
-@masking
 Feature: The Reek API maintains backwards compatibility
   In order to use Reek without fuss
   As a developer

data/features/samples.feature

@@ -1,10 +1,8 @@
-@samples
 Feature: Basic smell detection
   In order to write better software
   As a developer
   I want to detect the smells in my Ruby code
 
-  @inline
   Scenario: Correct smells from inline.rb
     When I run reek --no-line-numbers spec/samples/inline.rb
     Then the exit status indicates smells
@@ -282,7 +280,6 @@ Feature: Basic smell detection
       RedCloth#to_html has approx 26 statements (TooManyStatements)
     """
 
-  @ruby20
   Scenario: Correct smells from a source file with Ruby 2.0 specific syntax
     When I run reek spec/samples/ruby20_syntax.rb
     Then the exit status indicates smells
@@ -292,7 +289,6 @@ Feature: Basic smell detection
       [1]:SomeClass has no descriptive comment (IrresponsibleModule)
     """
 
-  @ruby21
   Scenario: Correct smells from a source file with Ruby 2.1 specific syntax
     When I run reek spec/samples/ruby21_syntax.rb
     Then the exit status indicates smells

data/features/step_definitions/reek_steps.rb

@@ -10,8 +10,12 @@ When /^I run rake (\w*) with:$/ do |name, task_def|
   rake(name, task_def)
 end
 
-Then /^stdout equals "([^\"]*)"$/ do |report|
-  expect(@last_stdout).to eq report
+Then /^it reports nothing$/ do
+  expect(@last_stdout).to eq ''
+end
+
+Then /^there is no output on stdout$/ do
+  expect(@last_stdout).to eq ''
 end
 
 Then /^stdout includes "(.*)"$/ do |text|
@@ -31,7 +35,7 @@ Then /^the exit status indicates smells$/ do
 end
 
 Then /^it reports:$/ do |report|
-  expect(@last_stdout.chomp).to eq report.chomp
+  expect(@last_stdout).to eq "#{report}\n"
 end
 
 Then /^it reports this yaml:$/ do |expected_yaml|
@@ -40,6 +44,12 @@ Then /^it reports this yaml:$/ do |expected_yaml|
   expect(actual_warnings).to eq expected_warnings
 end
 
+Then /^it reports this JSON:$/ do |expected_json|
+  expected_warnings = JSON.parse(expected_json.chomp)
+  actual_warnings = JSON.parse(@last_stdout)
+  expect(actual_warnings).to eq expected_warnings
+end
+
 Then /^stderr reports:$/ do |report|
   expect(@last_stderr).to eq report
 end
@@ -65,7 +75,7 @@ Then /^it should indicate the line numbers of those smells$/ do
 end
 
 Then /^it reports the current version$/ do
-  expect(@last_stdout).to eq "reek #{Reek::VERSION}\n"
+  expect(@last_stdout).to eq "reek #{Reek::Version::STRING}\n"
 end
 
 Given(/^"(.*?)" exists in the working directory$/) do |path|

data/features/support/env.rb

@@ -9,6 +9,9 @@ begin
 rescue LoadError # rubocop:disable Lint/HandleExceptions
 end
 
+#
+# Provides runner methods used in the cucumber steps.
+#
 class ReekWorld
   def run(cmd)
     stderr_file = Tempfile.new('reek-world')

data/lib/reek/cli/option_interpreter.rb

@@ -34,6 +34,8 @@ module Reek
         case @options.report_format
         when :yaml
           Report::YamlReport
+        when :json
+          Report::JsonReport
         when :html
           Report::HtmlReport
         else # :text

data/lib/reek/cli/options.rb

@@ -52,9 +52,9 @@ module Reek
       def set_alternative_formatter_options
         @parser.separator "\nReport format:"
         @parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml'
+          '  html', '  text (default)', '  yaml', '  json'
         ) do |opt|
           @options.report_format = opt
         end
@@ -122,7 +122,7 @@ module Reek
           exit
         end
         @parser.on_tail('-v', '--version', 'Show version') do
-          puts "#{@parser.program_name} #{Reek::VERSION}\n"
+          puts "#{@parser.program_name} #{Reek::Version::STRING}\n"
           exit
         end
       end

data/lib/reek/cli/report/formatter.rb

@@ -52,7 +52,7 @@ module Reek
 
         def format(warning)
           "#{super} " \
-          "[#{explanatory_link(warning)}]"
+            "[#{explanatory_link(warning)}]"
         end
 
         def explanatory_link(warning)

data/lib/reek/cli/report/location_formatter.rb

@@ -1,18 +1,29 @@
 module Reek
   module Cli
     module Report
+      #
+      # Formats the location of a warning as an empty string.
+      #
       module BlankLocationFormatter
         def self.format(_warning)
           ''
         end
       end
 
+      #
+      # Formats the location of a warning as an array of line numbers.
+      #
       module DefaultLocationFormatter
         def self.format(warning)
           "#{warning.lines.inspect}:"
         end
       end
 
+      #
+      # Formats the location of a warning as a combination of source file name
+      # and line number. In this format, it is not possible to show more than
+      # one line number, so the first number is displayed.
+      #
       module SingleLineLocationFormatter
         def self.format(warning)
           "#{warning.source}:#{warning.lines.first}: "