rubycritic 4.6.1 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cdf1485043408cdfbf9a8a0a468f7b20163c2bd982314547d733aca7d185d88
-  data.tar.gz: 365505ba0aedce90a370be8a8ccdc8277f33c2b637c8e1e22f350530240d9889
+  metadata.gz: 9223069d4934bf55e41bd199b4610e9b230b4115d36196354d4aa93d87b8ea01
+  data.tar.gz: 7d1b324b4df74ac99bb1103c6f80678a90e872418eac4faa87dd2f687cdb87cc
 SHA512:
-  metadata.gz: 5e5718fea056a233dcaab942dfe0529230d371ff1ef6fb71711283535c9aa85aab5cd07be697ec97d605574fbce7329e60f69aa608ca0504b54df094c5b65c46
-  data.tar.gz: 301500666e876676cc4caeaa2be96ed33b863dd7cad8b47b8f35461f665b7bc3ae66aa3fe3522466d5f42be679b525625bbe8c3b381da4c9015556c8b2bed348
+  metadata.gz: 91abe36adad615bf645187214511346e8175f28f913462baaa31b0be4bdf1986fa01e3841ff71866fa80f5de9d2e10d0ed6cd53dded35c30b04d2ad1910a5d6f
+  data.tar.gz: 6764cabd0cac4338072f4eadde37819095a10c3c5d5fd78d76d75ffe0e68d12ee58afe0169c286f3ea32fad9e91df145a9396e42154cbd446e78f8ee64b579ad

data/CHANGELOG.md

@@ -1,6 +1,14 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.6.1...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.7.0...main)
 
-# v4.6.0 / 2021-01-28 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.6.0...v4.6.1)
+# v4.7.0 / 2022-05-06 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.6.1...v4.7.0)
+
+* [CHANGE] Run test suite with Ruby 3.1 (by [@etagwerker][])
+* [FEATURE] Allow the Rake task generator to accept a description (by [@anicholson][])
+* [CHANGE] Replace travis-ci with Github Actions for contributors (by [@RyanSnodgrass][])
+* [CHANGE] Drop support for JRuby 9.1.x (by [@RyanSnodgrass][])
+* [BUGFIX] Exit with 0 or 1 from Rake Task. Fixes #214 (by [@RyanSnodgrass][])
+
+# v4.6.1 / 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][])
@@ -13,6 +21,8 @@
 * [BUGFIX] Fix directory structure of reports when comparing branches (by [@denny][])
 * [BUGFIX] Restrict simplecov to versions before data format changed (by [@denny][])
 
+* [BUGFIX] Handle missing comparison file in html template (by @lauratpa)
+
 # 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][])
@@ -366,3 +376,4 @@
 [@jackcasey]: https://github.com/jackcasey
 [@sl4vr]: https://github.com/sl4vr
 [@denny]: https://github.com/denny
+[@RyanSnodgrass]: https://github.com/RyanSnodgrass

data/README.md

@@ -196,6 +196,9 @@ RubyCritic::RakeTask.new do |task|
 
   # Defaults to false
   task.verbose = true
+
+  # Fail the Rake task if RubyCritic doesn't pass. Defaults to true
+  task.fail_on_error = true
 end
 ```
 
@@ -208,6 +211,22 @@ RubyCritic::RakeTask.new do |task|
 end
 ```
 
+If you wish to create multiple Rake tasks (e.g., for local & for ci-specific configuration), you can do so!
+If you decide to do this, you should provide a clearer description for each task:
+
+```ruby
+# for local
+RubyCritic::RakeTask.new("local", "Run RubyCritic (local configuration)" do |task|
+  # ...
+end
+
+# for CI
+RubyCritic::RakeTask.new("ci", "Run RubyCritic (CI configuration)" do |task|
+  task.options = "--mode-ci"
+  # ...
+end
+```
+
 ## Formatters
 
 See [formatters](docs/formatters.md)
@@ -220,6 +239,7 @@ RubyCritic is supporting Ruby versions:
 * 2.5
 * 2.6
 * 2.7
+* 3.0
 
 ## Improving RubyCritic
 

data/lib/rubycritic/generators/html/templates/code_index.html.erb

@@ -25,7 +25,9 @@
                 <td class="center">
                   <% if Config.build_mode? %>
                     <% master_analysed_module = Config.base_branch_collection.find(analysed_module.pathname) %>
-                    <% if master_analysed_module.cost > analysed_module.cost %>
+                    <% if !master_analysed_module %>
+                      <span class="empty-span glyphicon"></span>
+                    <% elsif master_analysed_module.cost > analysed_module.cost %>
                       <span class="glyphicon glyphicon-arrow-up green-color"></span>
                     <% elsif master_analysed_module.cost < analysed_module.cost %>
                       <span class="glyphicon glyphicon-arrow-down red-color"></span>

data/lib/rubycritic/rake_task.rb

@@ -36,11 +36,17 @@ module RubyCritic
     # "-p / --path" since that is set separately. Defaults to ''.
     attr_writer :options
 
-    def initialize(name = :rubycritic)
-      @name    = name
-      @paths   = FileList['.']
-      @options = ''
-      @verbose = false
+    # Whether or not to fail Rake task when RubyCritic does not pass.
+    # Defaults to true.
+    attr_writer :fail_on_error
+
+    def initialize(name = :rubycritic, description = 'Run RubyCritic')
+      @name           = name
+      @description    = description
+      @paths          = FileList['.']
+      @options        = ''
+      @verbose        = false
+      @fail_on_error  = true
 
       yield self if block_given?
       define_task
@@ -48,20 +54,24 @@ module RubyCritic
 
     private
 
-    attr_reader :name, :paths, :verbose, :options
+    attr_reader :name, :description, :paths, :verbose, :options, :fail_on_error
 
     def define_task
-      desc 'Run RubyCritic'
+      desc description
       task(name) { run_task }
     end
 
     def run_task
-      if verbose
-        puts "\n\n!!! Running `#{name}` rake command\n"
-        puts "!!! Inspecting #{paths} #{options.empty? ? '' : "with options #{options}"}\n\n"
-      end
+      print_starting_up_output if verbose
       application = RubyCritic::Cli::Application.new(options_as_arguments + paths)
-      application.execute
+      return unless application.execute.nonzero? && fail_on_error
+
+      abort('RubyCritic did not pass - exiting!')
+    end
+
+    def print_starting_up_output
+      puts "\n\n!!! Running `#{name}` rake command\n"
+      puts "!!! Inspecting #{paths} #{options.empty? ? '' : "with options #{options}"}\n\n"
     end
 
     def options_as_arguments

data/lib/rubycritic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -542,7 +542,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter