rubycritic 4.4.1 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80cbe6c77393b0819c820cd22c3cc67a0f6a5824598e1f67dbb1f8a7097070d8
-  data.tar.gz: '08b6e201d99ad0537cc440f885a36c5f07cda146766a3009cb4616ce7209fc06'
+  metadata.gz: 4cdf1485043408cdfbf9a8a0a468f7b20163c2bd982314547d733aca7d185d88
+  data.tar.gz: 365505ba0aedce90a370be8a8ccdc8277f33c2b637c8e1e22f350530240d9889
 SHA512:
-  metadata.gz: 1883ee9f5c4832b9fefcabed5f768d368e0b539d7cd7435813546c5a1db0b93856bc0705e525de902dd2d5cd500e6692854476c2b5a24dd23dc5a6a260c37877
-  data.tar.gz: ebdb193754eab2b5d9b94830bda9de53cec62eecc1c11a1a4d15bf50c3a7e7f7bfcd0147fafbd85565f9a28962669e39b097a1f5dce93af77242be699b5d132a
+  metadata.gz: 5e5718fea056a233dcaab942dfe0529230d371ff1ef6fb71711283535c9aa85aab5cd07be697ec97d605574fbce7329e60f69aa608ca0504b54df094c5b65c46
+  data.tar.gz: 301500666e876676cc4caeaa2be96ed33b863dd7cad8b47b8f35461f665b7bc3ae66aa3fe3522466d5f42be679b525625bbe8c3b381da4c9015556c8b2bed348

data/CHANGELOG.md

@@ -1,4 +1,33 @@
-# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.4.1...master)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.6.1...main)
+
+# v4.6.0 / 2021-01-28 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.6.0...v4.6.1)
+
+* [CHANGE] CI: Drop rbx-3 from matrix, does not install (by [@olleolleolle][])
+* [CHANGE] Add support for Ruby 3.0 (by [@etagwerker][])
+* [BUGFIX] Fix images on readme (by [@borisrorsvort][])
+
+# v4.6.0 / 2021-01-28 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.5.2...v4.6.0)
+
+* [CHANGE] Fix rubocop offenses (by [@sl4vr][])
+* [CHANGE] Make Github Linguist ignore vendored files (by [@sl4vr][])
+* [BUGFIX] Fix directory structure of reports when comparing branches (by [@denny][])
+* [BUGFIX] Restrict simplecov to versions before data format changed (by [@denny][])
+
+# v4.5.2 / 2020-08-20 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.5.1...v4.5.2)
+
+* [BUGFIX] Handle simplecov v0.19 and install appraisal (by [@MZiserman][])
+
+# v4.5.1 / 2020-06-29 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.5.0...v4.5.1)
+
+* [BUGFIX] Handle git --name-status Copied (C) operation (by [@rizalmuthi][])
+
+* [FEATURE] Add --churn-after (only supports git) to limit churn analysis to recent history (by [@jackcasey][])
+
+# v4.5.0 / 2020-05-14 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.4.1...v4.5.0)
+
+* [CHANGE] Relax `launchy` version dependency requirement
+* [CHANGE] Drop support for ruby 2.3 (by [@joshrpowell][])
+* [CHANGE] Update Reek dependency to '~> 6.0', '< 7.0' (by [@joshrpowell][])
 
 # v4.4.1 / 2020-02-20 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.4.0...v4.4.1)
 
@@ -334,3 +363,6 @@
 [@GeoffTidey]: https://github.com/GeoffTidey
 [@lloydwatkin]: https://github.com/lloydwatkin
 [@Flink]: https://github.com/Flink
+[@jackcasey]: https://github.com/jackcasey
+[@sl4vr]: https://github.com/sl4vr
+[@denny]: https://github.com/denny

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
 [![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
-<img src="https://github.com/whitesmith/rubycritic/raw/master/images/logo.png" alt="RubyCritic Icon" align="right">
+<img src="https://github.com/whitesmith/rubycritic/raw/main/images/logo.png" alt="RubyCritic Icon" align="right">
 
 RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [Flay][2] and [Flog][3] to provide a quality report of your Ruby code.
 
@@ -27,15 +27,15 @@ This gem provides features such as:
 
 1. An overview of your project:
 
-  ![RubyCritic overview screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/overview.png)
+  ![RubyCritic overview screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/overview.png)
 
 2. An index of the project files with their respective number of smells:
 
-  ![RubyCritic code index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/code.png)
+  ![RubyCritic code index screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/code.png)
 
 3. An index of the smells detected:
 
-  ![RubyCritic smells index screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smells.png)
+  ![RubyCritic smells index screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/smells.png)
 
 4. When analysing code like the following:
 
@@ -51,11 +51,11 @@ This gem provides features such as:
 
   It basically turns something like this:
 
-  ![Reek output screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/reek.png)
+  ![Reek output screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/reek.png)
 
   Into something like this:
 
-  ![RubyCritic file code screenshot](https://github.com/whitesmith/rubycritic/raw/master/images/smell-details.png)
+  ![RubyCritic file code screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/smell-details.png)
 
 5. It uses your source control system (only Git, Mercurial and Perforce
   are currently supported) to compare your currently uncommitted
@@ -216,10 +216,10 @@ See [formatters](docs/formatters.md)
 
 RubyCritic is supporting Ruby versions:
 
-* 2.3
 * 2.4
 * 2.5
 * 2.6
+* 2.7
 
 ## Improving RubyCritic
 
@@ -243,7 +243,7 @@ The current core team consists of:
 
 ## Credits
 
-![Whitesmith](https://github.com/whitesmith/rubycritic/raw/master/images/whitesmith.png)
+![Whitesmith](https://github.com/whitesmith/rubycritic/raw/main/images/whitesmith.png)
 
 RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@Whitesmithco][10].
 

data/lib/rubycritic/analysers/coverage.rb

@@ -9,6 +9,8 @@ module RubyCritic
     class Coverage
       include Colorize
 
+      RESULTSET_FILENAME = '.resultset.json'
+
       def initialize(analysed_modules)
         @analysed_modules = analysed_modules
         @result = results.first
@@ -44,30 +46,28 @@ module RubyCritic
         @result.source_files.detect { |file| file.filename == needle }
       end
 
-      # The path to the .resultset.json cache file
+      # The path to the cache file
       def resultset_path
-        File.join(SimpleCov.coverage_path, '.resultset.json')
+        File.join(SimpleCov.coverage_path, RESULTSET_FILENAME)
       end
 
       def resultset_writelock
-        File.join(SimpleCov.coverage_path, '.resultset.json.lock')
+        "#{resultset_path}.lock"
       end
 
       # Loads the cached resultset from JSON and returns it as a Hash,
       # caching it for subsequent accesses.
       def resultset
-        @resultset ||= begin
-          if (data = stored_data)
-            begin
-              JSON.parse(data) || {}
-            rescue JSON::ParserError => err
-              puts "Error: Loading .resultset.json: #{err.message}"
-              {}
-            end
-          else
-            {}
-          end
-        end
+        @resultset ||= parse_resultset(stored_data)
+      end
+
+      def parse_resultset(data)
+        return {} unless data
+
+        JSON.parse(data) || {}
+      rescue JSON::ParserError => err
+        puts "Error: Loading #{RESULTSET_FILENAME}: #{err.message}"
+        {}
       end
 
       # Returns the contents of the resultset cache as a string or if the file is missing or empty nil
@@ -85,21 +85,23 @@ module RubyCritic
 
       # Ensure only one process is reading or writing the resultset at any
       # given time
-      def synchronize_resultset
+      def synchronize_resultset(&proc)
         # make it reentrant
         return yield if defined?(@resultset_locked) && @resultset_locked == true
 
         return yield unless File.exist?(resultset_writelock)
 
-        begin
-          @resultset_locked = true
-          File.open(resultset_writelock, 'w+') do |file|
-            file.flock(File::LOCK_EX)
-            yield
-          end
-        ensure
-          @resultset_locked = false
+        with_lock(&proc)
+      end
+
+      def with_lock
+        @resultset_locked = true
+        File.open(resultset_writelock, 'w+') do |file|
+          file.flock(File::LOCK_EX)
+          yield
         end
+      ensure
+        @resultset_locked = false
       end
 
       # Gets the resultset hash and re-creates all included instances
@@ -107,11 +109,15 @@ module RubyCritic
       # All results that are above the SimpleCov.merge_timeout will be
       # dropped. Returns an array of SimpleCov::Result items.
       def results
-        array = []
-        resultset.each do |command_name, data|
-          array << ::SimpleCov::Result.from_hash(command_name => data)
+        if Gem.loaded_specs['simplecov'].version >= Gem::Version.new('0.19')
+          ::SimpleCov::Result.from_hash(resultset)
+        else
+          array = []
+          resultset.each do |command_name, data|
+            array << ::SimpleCov::Result.from_hash(command_name => data)
+          end
+          array
         end
-        array
       end
     end
   end

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

@@ -70,6 +70,12 @@ module RubyCritic
               self.minimum_score = Float(min_score)
             end
 
+            opts.on('--churn-after [DATE]', 'Only count churn from a certain date.',
+                    'The date is passed through to version control (currently git only).',
+                    'Example: 2017-01-01') do |churn_after|
+              self.churn_after = churn_after
+            end
+
             opts.on('-m', '--mode-ci [BASE_BRANCH]',
                     'Use CI mode (faster, analyses diffs w.r.t base_branch (default: master))') do |branch|
               self.base_branch = branch || 'master'
@@ -110,6 +116,7 @@ module RubyCritic
             suppress_ratings: suppress_ratings,
             help_text: parser.help,
             minimum_score: minimum_score,
+            churn_after: churn_after,
             no_browser: no_browser,
             base_branch: base_branch,
             feature_branch: feature_branch,
@@ -121,7 +128,7 @@ module RubyCritic
         private
 
         attr_accessor :mode, :root, :formats, :formatters, :deduplicate_symlinks,
-                      :suppress_ratings, :minimum_score, :no_browser,
+                      :suppress_ratings, :minimum_score, :churn_after, :no_browser,
                       :parser, :base_branch, :feature_branch, :threshold_score
         def paths
           @argv unless @argv.empty?

data/lib/rubycritic/commands/compare.rb

@@ -13,6 +13,7 @@ module RubyCritic
     class Compare < Default
       def initialize(options)
         super
+        @original_config_root = Config.root
         @build_number = 0
       end
 
@@ -57,7 +58,7 @@ module RubyCritic
       def analyse_modified_files
         modified_files = Config.feature_branch_collection.where(SourceControlSystem::Git.modified_files)
         analysed_modules = AnalysedModulesCollection.new(modified_files.map(&:path), modified_files)
-        Config.root = "#{Config.root}/compare"
+        Config.root = Config.compare_root_directory
         report(analysed_modules)
       end
 
@@ -85,7 +86,7 @@ module RubyCritic
       end
 
       def branch_directory(branch)
-        "#{Config.root}/compare/#{Config.send(branch)}"
+        "#{@original_config_root}/compare/#{Config.send(branch)}"
       end
 
       # create a txt file with the branch score details

data/lib/rubycritic/configuration.rb

@@ -10,7 +10,7 @@ module RubyCritic
                   :feature_branch, :base_branch_score, :feature_branch_score,
                   :base_root_directory, :feature_root_directory,
                   :compare_root_directory, :threshold_score, :base_branch_collection,
-                  :feature_branch_collection
+                  :feature_branch_collection, :churn_after
 
     def set(options)
       self.mode = options[:mode] || :default
@@ -19,12 +19,17 @@ module RubyCritic
       self.suppress_ratings = options[:suppress_ratings]
       self.open_with = options[:open_with]
       self.no_browser = options[:no_browser]
-      self.base_branch = options[:base_branch]
-      self.feature_branch = options[:feature_branch]
       self.threshold_score = options[:threshold_score].to_i
+      setup_version_control(options)
       setup_formats(options)
     end
 
+    def setup_version_control(options)
+      self.base_branch = options[:base_branch]
+      self.feature_branch = options[:feature_branch]
+      self.churn_after = options[:churn_after]
+    end
+
     def setup_formats(options)
       formats = options[:formats].to_a
       self.formats = formats.empty? ? [:html] : formats
@@ -59,11 +64,15 @@ module RubyCritic
     end
 
     def self.method_missing(method, *args, &block)
-      configuration.public_send(method, *args, &block)
+      if configuration.respond_to?(method)
+        configuration.public_send(method, *args, &block)
+      else
+        super
+      end
     end
 
     def self.respond_to_missing?(symbol, include_all = false)
-      configuration.respond_to_missing?(symbol) || super
+      configuration.respond_to?(symbol) || super
     end
   end
 end

data/lib/rubycritic/generators/html/assets/stylesheets/application.css

@@ -221,7 +221,7 @@ header {
 }
 .sidebar-nav li a:hover {color:#9B111D;}
 .sidebar-nav li a i,.sidebar-nav li a img {font-size:18px;display:block;margin:0 auto;}
-/*End of Layout Stlyes*/
+/*End of Layout Styles*/
 
 .fadeIn {-webkit-animation: fadein 2s; /* Safari, Chrome and Opera > 12.1 */
   -moz-animation: fadein 2s; /* Firefox < 16 */