rubycritic 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8572beecbb1728adcda3fd6814cca239ce53e1b
-  data.tar.gz: 80825e46376df6b51b860055d01e86b80b64a340
+  metadata.gz: fb8941448d84144db4e15c3cb37731de9c78a9b9
+  data.tar.gz: 36cf41f7d42d12668c4abe9f6300e0cbdeec43a5
 SHA512:
-  metadata.gz: fc743073fcc8bf35c343d65ed22aaf7a8aa28420c4cebfdfbde6d2081fe228a765391ef1e9f28ca08c5c69aec01d8a8379b177b1567d2ebf5b0ee2bdf9c63124
-  data.tar.gz: '0990bfc4da09ad3b33c75819c73136d66b0fbb9c7ab57d971570157eb28c6d84ede2961f5505140d236184b7fd1e62449dedf4a5031120ca73d7c1cb19382836'
+  metadata.gz: 2174e7c073020b197681db5c4af3501b302f85d64cb858c224e772d93a268eeebd68bf9d530203a20f278918d5bd03370be8a7d5ff988e83e1d1a7792ab05908
+  data.tar.gz: fb77e4cc9ce6aafe5cc8239f90d79f6354046568934f6baf37eda7bb47786fe77b256c8fef53fa548e442d7caad8b0e627eda1f9e6beb5c68b0aada9d2e3feaf

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 .ruby-gemset
 .ruby-version
 .DS_Store
+.byebug_history

data/.rubocop_todo.yml

@@ -17,7 +17,7 @@ Metrics/MethodLength:
     - 'lib/rubycritic/platforms/base.rb'
 
 # Offense count: 4
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Exclude:
     - 'lib/rubycritic/analysers/helpers/ast_node.rb'
     - 'lib/rubycritic/generators/html/base.rb'
@@ -37,9 +37,9 @@ Style/SpecialGlobalVars:
 
 # Offense count: 1
 Style/MethodMissing:
-  Exclude: 
+  Exclude:
     - 'lib/rubycritic/configuration.rb'
 
 # Offense count: 3
-Style/IndentHeredoc:
+Layout/IndentHeredoc:
   Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v3.2.3...master)
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v3.3.0...master)
+
+# 3.3.0 / 2017-10-10 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.3...v3.3.0)
+
+* [FEATURE] Add lint format similar to Golint (by [@nightscape][])
+* [CHANGE] Update `cucumber` to 3.0 (by [@onumis][]) 
+* [CHANGE] Update `rake` to 12.0 (by [@onumis][])
+* [CHANGE] Update `rubocop` to 0.50.0 (by [@onumis][])
+* [CHANGE] Accepting floating point values from Flog (by [@onumis][])
 
 # 3.2.3 / 2017-05-31 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.2.2...v3.2.3)
 
@@ -215,3 +223,4 @@
 [@georgedrummond]: https://github.com/georgedrummond
 [@yuku-t]: https://github.com/yuku-t
 [@ochagata]: https://github.com/ochagata
+[@nightscape]: https://github.com/nightscape

data/README.md

@@ -117,7 +117,7 @@ $ rubycritic --help
 | `-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                                   |
+| `-s` / `--minimum-score` | Set a minimum score (FLOAT: ex: 96.28)                |
 | `--mode-ci`              | Use CI mode (faster, but only analyses last commit)   |
 | `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
 | `--suppress-ratings`     | Suppress letter ratings                               |

data/docs/jenkins-pr-reviews.md

@@ -0,0 +1,64 @@
+# Making Jenkins review Pull Requests
+
+## Installing Jenkins and setting up RubyCritic
+
+There is a step-by-step tutorial on how to set up Jenkins in [`building-own-code-climate.md`](./building-own-code-climate.md).
+
+### Installing required plugins
+
+Installing a Jenkins Plugin is extremely easy. All you have to do is proceed to `Manage Jenkins`, go to `Manage Plugins`, select the `Available` tab and then check the desired plugin.
+
+For creating comments on PRs we are going to use the [Violation Comments to GitHub Jenkins Plugin](https://github.com/jenkinsci/violation-comments-to-github-plugin).
+
+## Configuring the project
+
+The Violation plugin has parsers for many different formats, and the GoLint one is compatible with the `lint` format created by RubyCritic.
+We're assuming that you use a `Jenkinsfile` for creating a pipeline, but the approach can be adapted to other scenarios.
+
+
+```groovy
+pipeline {
+  agent any
+
+  stages {
+    stage('Build') {
+      steps {
+        // Install gems etc.
+      }
+    }
+    stage('Test') {
+      steps {
+        parallel tests: { // We are running tests and code_checks in parallel to shorten build times
+          sh 'bundle exec rspec'
+        },
+        code_checks: {
+          sh 'bundle exec rubycritic -f lint'
+        }
+      }
+    }
+    stage('Package / Deploy') {
+      steps {
+        parallel deploy: {
+          // Create Docker image / deploy via Capistrano / ...
+        },
+        publish_code_review: {
+          step([
+            $class: 'ViolationsToGitHubRecorder',
+            config: [
+              repositoryName: 'your_project_name',
+              pullRequestId: env.CHANGE_ID, // The CHANGE_ID env variable will be set to the PR ID by Jenkins
+              createSingleFileComments: true, // Create one comment per violation
+              commentOnlyChangedContent: true, // Only comment on lines that have changed
+              keepOldComments: false,
+              violationConfigs: [
+                [ pattern: '.*/lint\\.txt$', parser: 'GOLINT', reporter: 'RubyCritic' ], // RubyCritic will output a lint.txt file in GoLint compatible format
+              ]
+            ]])
+        }
+      }
+    }
+  }
+}
+```
+
+For further information, check out the documentation of the [Violation Comments to GitHub Jenkins Plugin](https://github.com/jenkinsci/violation-comments-to-github-plugin).

data/features/command_line_interface/minimum_score.feature

@@ -3,17 +3,17 @@ Feature: Break if overall score is below minimum
   RubyCritic returns the exit status according with the score
 
   Scenario: Status indicates a success when not using --minimum-score
-    Given the smelly file 'smelly.rb' with a score of 93.75
+    Given the smelly file 'smelly.rb' with a score of 93.19
     When I run rubycritic smelly.rb
     Then the exit status indicates a success
 
   Scenario: Status indicates an error when score below the minimum
-    Given the smelly file 'smelly.rb' with a score of 93.75
+    Given the smelly file 'smelly.rb' with a score of 93.19
     When I run rubycritic --minimum-score 100 smelly.rb
     Then the exit status indicates an error
 
   Scenario: Status indicates a success when score is above the minimum
-    Given the smelly file 'smelly.rb' with a score of 93.75
+    Given the smelly file 'smelly.rb' with a score of 93.19
     When I run rubycritic --minimum-score 93 smelly.rb
     Then the exit status indicates a success
 
@@ -23,11 +23,11 @@ Feature: Break if overall score is below minimum
     Then the exit status indicates a success
 
   Scenario: Prints the score on output
-    Given the smelly file 'smelly.rb' with a score of 93.75
+    Given the smelly file 'smelly.rb' with a score of 93.19
     When I run rubycritic smelly.rb
     Then the output should contain:
     """
-    Score: 93.75
+    Score: 93.19
     """
 
   Scenario: Prints a message informing the score is below the minimum

data/features/command_line_interface/options.feature

@@ -25,6 +25,7 @@ Feature: RubyCritic can be controlled using command-line options
                                              html (default; will open in a browser)
                                              json
                                              console
+                                             lint
           -s, --minimum-score [MIN_SCORE]  Set a minimum score
           -m, --mode-ci                    Use CI mode (faster, but only analyses last commit)
               --deduplicate-symlinks       De-duplicate symlinks based on their final target

data/features/rake_task.feature

@@ -61,5 +61,5 @@ Feature: RubyCritic can be run via Rake task
       """
     Then the output should contain:
       """
-      Score (93.75) is below the minimum 95
+      Score (93.19) is below the minimum 95
       """

data/features/step_definitions/sample_file_steps.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Given(/^the smelly file 'smelly.rb'/) do
-  contents = <<-EOS.strip_heredoc
+  contents = <<-RUBY.strip_heredoc
     class AllTheMethods
       def method_missing(method, *args, &block)
         message = "I"
@@ -13,17 +13,17 @@ Given(/^the smelly file 'smelly.rb'/) do
         self.send(method)
       end
     end
-  EOS
+  RUBY
   write_file('smelly.rb', contents)
 end
 
 Given(/^the clean file 'clean.rb'/) do
-  contents = <<-EOS.strip_heredoc
+  contents = <<-RUBY.strip_heredoc
     # Explanatory comment
     class Clean
       def foo; end
     end
-  EOS
+  RUBY
   write_file('clean.rb', contents)
 end
 

data/features/support/env.rb

@@ -22,11 +22,11 @@ class RubyCriticWorld
   end
 
   def rake(name, task_def)
-    header = <<-EOS.strip_heredoc
+    header = <<-RUBY.strip_heredoc
       require 'rubycritic'
       require 'rubycritic/rake_task'
 
-    EOS
+    RUBY
     write_file 'Rakefile', header + task_def
     run_simple("rake #{name}", false)
   end

data/lib/rubycritic/analysers/complexity.rb

@@ -16,7 +16,7 @@ module RubyCritic
         @analysed_modules.each do |analysed_module|
           @flog.reset
           @flog.flog(analysed_module.path)
-          analysed_module.complexity = @flog.total_score.round
+          analysed_module.complexity = @flog.total_score.round(2)
           print green '.'
         end
         puts ''

data/lib/rubycritic/cli/options.rb

@@ -22,17 +22,18 @@ module RubyCritic
 
           opts.on(
             '-f', '--format [FORMAT]',
-            %i[html json console],
+            %i[html json console lint],
             'Report smells in the given format:',
             '  html (default; will open in a browser)',
             '  json',
-            '  console'
+            '  console',
+            '  lint'
           ) do |format|
             self.format = format
           end
 
           opts.on('-s', '--minimum-score [MIN_SCORE]', 'Set a minimum score') do |min_score|
-            self.minimum_score = Integer(min_score)
+            self.minimum_score = Float(min_score)
           end
 
           opts.on('-m', '--mode-ci', 'Use CI mode (faster, but only analyses last commit)') do

data/lib/rubycritic/core/analysed_module.rb

@@ -7,6 +7,9 @@ module RubyCritic
   class AnalysedModule
     include Virtus.model
 
+    # Complexity is reduced by a factor of 25 when calculating cost
+    COMPLEXITY_FACTOR = 25.0
+
     attribute :name
     attribute :smells_count
     attribute :file_location
@@ -16,7 +19,7 @@ module RubyCritic
     attribute :smells, Array, default: []
     attribute :churn
     attribute :committed_at
-    attribute :complexity
+    attribute :complexity, Float, default: Float::INFINITY
     attribute :duplication, Integer, default: 0
     attribute :methods_count
 
@@ -37,7 +40,8 @@ module RubyCritic
     end
 
     def cost
-      @cost ||= smells.map(&:cost).inject(0, :+) + (complexity / 25)
+      @cost ||= smells.map(&:cost).inject(0.0, :+) +
+                (complexity / COMPLEXITY_FACTOR)
     end
 
     def rating

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -32,9 +32,11 @@ module RubyCritic
     end
 
     def score
-      MAX_SCORE - average_limited_cost * COST_MULTIPLIER
-    rescue
-      0.0
+      if @modules.any?
+        MAX_SCORE - average_limited_cost * COST_MULTIPLIER
+      else
+        0.0
+      end
     end
 
     def summary
@@ -48,8 +50,16 @@ module RubyCritic
     private
 
     def average_limited_cost
-      avg = map { |mod| limited_cost_for(mod) }.reduce(:+) / @modules.size.to_f
-      [avg, ZERO_SCORE_COST].min
+      [average_cost, ZERO_SCORE_COST].min
+    end
+
+    def average_cost
+      num_modules = @modules.size
+      if num_modules > 0
+        map { |mod| limited_cost_for(mod) }.reduce(:+) / num_modules.to_f
+      else
+        0.0
+      end
     end
 
     def limited_cost_for(mod)

data/lib/rubycritic/generators/lint_report.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/text/lint'
+
+module RubyCritic
+  module Generator
+    class LintReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        FileUtils.mkdir_p(generator.file_directory)
+        File.open(generator.file_pathname, 'w+') do |file|
+          file.write(reports.join("\n"))
+        end
+      end
+
+      def generator
+        Text::Lint
+      end
+
+      def reports
+        @analysed_modules.sort.map do |mod|
+          generator.new(mod).render
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/lint.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'erb'
+module RubyCritic
+  module Generator
+    module Text
+      class Lint
+        class << self
+          TEMPLATE_PATH = File.expand_path('../templates/lint.erb', __FILE__)
+          FILE_NAME = 'lint.txt'.freeze
+
+          def file_directory
+            @file_directory ||= Pathname.new(Config.root)
+          end
+
+          def file_pathname
+            Pathname.new(file_directory).join FILE_NAME
+          end
+
+          def erb_template
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
+          end
+        end
+
+        def initialize(analysed_module)
+          @analysed_module = analysed_module
+        end
+
+        def render
+          erb_template.result(binding)
+        end
+
+        private
+
+        def erb_template
+          self.class.erb_template
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/templates/lint.erb

@@ -0,0 +1,3 @@
+<%- @analysed_module.smells.each do |smell| -%>
+<%= smell.locations.first.to_s %>: <%= smell.to_s %>
+<%- end -%>

data/lib/rubycritic/reporter.rb

@@ -14,6 +14,9 @@ module RubyCritic
       when :console
         require 'rubycritic/generators/console_report'
         Generator::ConsoleReport
+      when :lint
+        require 'rubycritic/generators/lint_report'
+        Generator::LintReport
       else
         require 'rubycritic/generators/html_report'
         Generator::HtmlReport

data/lib/rubycritic/source_control_systems/git.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
+require 'tty/which'
+
 module RubyCritic
   module SourceControlSystem
     class Git < Base
       register_system
+      GIT_EXECUTABLE = TTY::Which.which('git')
+
+      def self.git(arg)
+        `#{GIT_EXECUTABLE} #{arg}`
+      end
+
+      def git(arg)
+        self.class.git(arg)
+      end
 
       def self.supported?
-        `git branch 2>&1` && $?.success?
+        git('branch 2>&1') && $?.success?
       end
 
       def self.to_s
@@ -14,11 +25,11 @@ module RubyCritic
       end
 
       def revisions_count(path)
-        `git log --follow --format=%h #{path.shellescape}`.count("\n")
+        git("log --follow --format=%h #{path.shellescape}").count("\n")
       end
 
       def date_of_last_commit(path)
-        `git log -1 --date=iso --format=%ad #{path.shellescape}`.chomp!
+        git("log -1 --date=iso --format=%ad #{path.shellescape}").chomp!
       end
 
       def revision?
@@ -26,7 +37,7 @@ module RubyCritic
       end
 
       def head_reference
-        `git rev-parse --verify HEAD`.chomp!
+        git('rev-parse --verify HEAD').chomp!
       end
 
       def travel_to_head
@@ -40,17 +51,17 @@ module RubyCritic
 
       def stash_changes
         stashes_count_before = stashes_count
-        `git stash`
+        git('stash')
         stashes_count_after = stashes_count
         stashes_count_after > stashes_count_before
       end
 
       def stashes_count
-        `git stash list --format=%h`.count("\n")
+        git('stash list --format=%h').count("\n")
       end
 
       def travel_to_original_state
-        `git stash pop`
+        git('stash pop')
       end
     end
   end

data/lib/rubycritic/source_locator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require 'rubycritic/configuration'
 
 module RubyCritic
   class SourceLocator

data/lib/rubycritic/version.rb

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

data/rubycritic.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
@@ -25,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'flay', '~> 2.8'
   spec.add_runtime_dependency 'flog', '~> 4.4'
   spec.add_runtime_dependency 'launchy', '2.4.3'
+  spec.add_runtime_dependency 'tty-which', '~> 0.3.0'
   spec.add_runtime_dependency 'parser', '~> 2.4.0'
   spec.add_runtime_dependency 'rainbow', '~> 2.1'
   spec.add_runtime_dependency 'reek', '~> 4.4'
@@ -33,10 +33,13 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'aruba', '~> 0.12', '>= 0.12.0'
   spec.add_development_dependency 'bundler', '~> 1.3', '>= 1.3.0'
-  spec.add_development_dependency 'cucumber', '~> 2.2', '>= 2.2.0'
+  spec.add_development_dependency 'cucumber', '~> 3.0', '>= 2.2.0'
   spec.add_development_dependency 'fakefs', '~> 0.10', '>= 0.10.0'
   spec.add_development_dependency 'minitest', '~> 5.3', '>= 5.3.0'
+  spec.add_development_dependency 'minitest-around', '~> 0.4.0'
+  spec.add_development_dependency 'diff-lcs', '~> 1.3'
   spec.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
-  spec.add_development_dependency 'rake', '~> 11.0', '>= 11.0.0'
-  spec.add_development_dependency 'rubocop', '~> 0.48.0'
+  spec.add_development_dependency 'rake', '~> 12.0', '>= 11.0.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'byebug', '~> 9.0', '>= 8.0'
 end

data/test/lib/rubycritic/commands/status_reporter_test.rb

@@ -50,13 +50,13 @@ describe RubyCritic::Command::StatusReporter do
       it 'should return the correct status' do
         @reporter.score = score
         @reporter.status.must_equal score_below_minimum
-        @reporter.status_message.must_equal 'Score (98.0) is below the minimum 99'
+        @reporter.status_message.must_equal 'Score (98.0) is below the minimum 99.0'
       end
 
       it 'should format the score' do
         @reporter.score = 98.95258620689656
         @reporter.status.must_equal score_below_minimum
-        @reporter.status_message.must_equal 'Score (98.95) is below the minimum 99'
+        @reporter.status_message.must_equal 'Score (98.95) is below the minimum 99.0'
       end
     end
 

data/test/lib/rubycritic/generators/json_report_test.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
 require 'test_helper'
-require 'rubycritic/core/analysed_modules_collection'
+require 'rubycritic/analysers_runner'
 require 'rubycritic/generators/json_report'
 require 'json'
 require 'fakefs/safe'
 
 describe RubyCritic::Generator::JsonReport do
   describe '#generate_report' do
-    before(:each) do
-      FakeFS.activate!
-      create_analysed_modules_collection
-      generate_report
+    around do |example|
+      capture_output_streams do
+        with_cloned_fs(&example)
+      end
     end
 
-    after(:each) { FakeFS.deactivate! }
-
-    it 'creates a report.json file' do
-      assert File.file?('test/samples/report.json'), 'expected report.json file to be created'
-    end
-
-    it 'report file has data inside' do
-      data = File.read('test/samples/report.json')
-      assert data != '', 'expected report file not to be empty'
+    it 'creates a report file with JSON data inside' do
+      sample_files = Dir['test/samples/**/*.rb']
+      create_analysed_modules_collection
+      generate_report
+      data = JSON.parse(File.read('test/samples/report.json'))
+      analysed_files = data['analysed_modules'].map { |h| h['path'] }.uniq
+      assert_matched_arrays analysed_files, sample_files
     end
   end
 
   def create_analysed_modules_collection
-    @analysed_modules_collection = RubyCritic::AnalysedModulesCollection.new('test/samples/')
     RubyCritic::Config.root = 'test/samples'
+    RubyCritic::Config.source_control_system = RubyCritic::SourceControlSystem::Git.new
+    analyser_runner = RubyCritic::AnalysersRunner.new('test/samples/')
+    @analysed_modules_collection = analyser_runner.run
   end
 
   def generate_report

data/test/lib/rubycritic/generators/lint_report_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'rubycritic/analysers_runner'
+require 'rubycritic/generators/lint_report'
+require 'fakefs/safe'
+
+describe RubyCritic::Generator::LintReport do
+  describe '#generate_report' do
+    around do |example|
+      capture_output_streams do
+        with_cloned_fs(&example)
+      end
+    end
+
+    it 'report file has data inside' do
+      sample_files = Dir['test/samples/**/*.rb'].reject { |f| File.zero?(f) }
+      create_analysed_modules_collection
+      generate_report
+      lines = File.readlines('test/samples/lint.txt').map(&:strip).reject(&:empty?)
+      analysed_files = lines.map { |line| line.split(':').first }.uniq
+      assert_matched_arrays analysed_files, sample_files
+    end
+  end
+
+  def create_analysed_modules_collection
+    RubyCritic::Config.root = 'test/samples'
+    RubyCritic::Config.source_control_system = RubyCritic::SourceControlSystem::Git.new
+    analyser_runner = RubyCritic::AnalysersRunner.new('test/samples/')
+    @analysed_modules_collection = analyser_runner.run
+  end
+
+  def generate_report
+    report = RubyCritic::Generator::LintReport.new(@analysed_modules_collection)
+    report.generate_report
+  end
+end

data/test/lib/rubycritic/source_control_systems/perforce_test.rb

@@ -66,7 +66,7 @@ describe RubyCritic::SourceControlSystem::Perforce do
     describe '::in_client_directory?' do
       context 'current directory is in p4 client' do
         let(:p4_info) do
-          <<-END
+          <<-P4INFO
 User name: unit_test_user
 Client name: UNIT_TEST_CLIENT
 Client host: MACHINE_NAME
@@ -75,7 +75,7 @@ Current directory: /path/to/client/root/ruby_project/unit_test
 Peer address: 127.0.0.1::3000
 Client address: 127.0.0.1
 Server address: the.server.address.com
-          END
+          P4INFO
         end
 
         it 'calls p4 info and parse the result' do
@@ -86,7 +86,7 @@ Server address: the.server.address.com
 
       context 'current directory is not in p4 client' do
         let(:p4_info) do
-          <<-END
+          <<-P4INFO
 User name: unit_test_user
 Client name: UNIT_TEST_CLIENT
 Client host: MACHINE_NAME
@@ -95,7 +95,7 @@ Current directory: /somewhere/else/ruby_project/unit_test
 Peer address: 127.0.0.1::3000
 Client address: 127.0.0.1
 Server address: the.server.address.com
-          END
+          P4INFO
         end
 
         it 'calls p4 info and parse the result' do
@@ -107,7 +107,7 @@ Server address: the.server.address.com
 
     describe 'retrieve informations' do
       let(:p4_stats) do
-        <<-END
+        <<-P4STATS
 ... clientFile /path/to/client/a_ruby_file.rb
 ... headTime 1473075551
 ... headRev 16
@@ -118,7 +118,7 @@ Server address: the.server.address.com
 ... action opened
 ... headRev 12
 ... headChange 2103504
-        END
+        P4STATS
       end
 
       describe 'build_file_cache' do

data/test/test_helper.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'minitest/autorun'
+require 'minitest/around/spec'
 require 'minitest/pride'
 require 'mocha/mini_test'
 require 'ostruct'
+require 'diff/lcs'
 
 def context(*args, &block)
   describe(*args, &block)
@@ -18,6 +20,19 @@ ensure
   $stderr = STDERR
 end
 
+def with_cloned_fs
+  FakeFS do
+    begin
+      config = File.expand_path('..', __dir__)
+      FakeFS::FileSystem.clone(config)
+      Dir.chdir(config)
+      yield
+    ensure
+      FakeFS::FileSystem.clear
+    end
+  end
+end
+
 module MiniTest
   module Assertions
     ##
@@ -31,7 +46,8 @@ module MiniTest
       assert_kind_of Array, exp_ary
       act_ary = act.to_ary
       assert_kind_of Array, act_ary
-      assert_equal exp_ary.sort, act_ary.sort
+      diffs = Diff::LCS.sdiff(act_ary.sort, exp_ary.sort).reject(&:unchanged?)
+      assert diffs.empty?, "There are diffs between expected and actual values:\n#{diffs.map(&:inspect).join("\n")}"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +182,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
@@ -178,7 +192,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
@@ -222,6 +236,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +290,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -258,7 +300,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -268,14 +310,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.0
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.0
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -301,6 +363,7 @@ files:
 - bin/rubycritic
 - docs/building-own-code-climate.md
 - docs/core-metrics.md
+- docs/jenkins-pr-reviews.md
 - features/command_line_interface/minimum_score.feature
 - features/command_line_interface/options.feature
 - features/rake_task.feature
@@ -398,7 +461,10 @@ files:
 - lib/rubycritic/generators/html_report.rb
 - lib/rubycritic/generators/json/simple.rb
 - lib/rubycritic/generators/json_report.rb
+- lib/rubycritic/generators/lint_report.rb
+- lib/rubycritic/generators/text/lint.rb
 - lib/rubycritic/generators/text/list.rb
+- lib/rubycritic/generators/text/templates/lint.erb
 - lib/rubycritic/generators/text/templates/list.erb
 - lib/rubycritic/rake_task.rb
 - lib/rubycritic/reporter.rb
@@ -432,6 +498,7 @@ files:
 - test/lib/rubycritic/core/smells_array_test.rb
 - test/lib/rubycritic/generators/console_report_test.rb
 - test/lib/rubycritic/generators/json_report_test.rb
+- test/lib/rubycritic/generators/lint_report_test.rb
 - test/lib/rubycritic/generators/turbulence_test.rb
 - test/lib/rubycritic/generators/view_helpers_test.rb
 - test/lib/rubycritic/revision_comparator_test.rb
@@ -482,7 +549,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter
@@ -506,6 +573,7 @@ test_files:
 - test/lib/rubycritic/core/smells_array_test.rb
 - test/lib/rubycritic/generators/console_report_test.rb
 - test/lib/rubycritic/generators/json_report_test.rb
+- test/lib/rubycritic/generators/lint_report_test.rb
 - test/lib/rubycritic/generators/turbulence_test.rb
 - test/lib/rubycritic/generators/view_helpers_test.rb
 - test/lib/rubycritic/revision_comparator_test.rb