quality_report 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18d81f9fa7d9dca4e114657e18e06fed11bed99df6746c0438bf2bf9b625441
-  data.tar.gz: 19578513e16b8457a2e388e326834f31f1dd17876c822cf6f509349a2ae261e3
+  metadata.gz: 23d2fbfb3f81887e40858181c9822346e770e8f242d96cfb39b8239b5288cb37
+  data.tar.gz: f39b9f3ae08503660b79bcc0d286ae622d5e0aa5c06b056ef635a8af8def8576
 SHA512:
-  metadata.gz: '03793a5b452e7f3ecc1b3c805eb273ff60f5619dceb902d0f19fc7c1272da7b60751ee737602671b364c00f2a2894568b8cf9c09b6e707feed5029b195c00952'
-  data.tar.gz: 0da7cd9be8337214421ee9ed709dc5a6119fdc48611c4648c70b211e8df0aee85b39c65d24c30dc77be690237f205c34c788176d22e49db38467368c6a9fe9f5
+  metadata.gz: de5bfd72e7ea4b31e0bf57785ea38d5503624f0861adc660c1844848d32d839a90ecfb0ed6f5de1eabe13293846fd1771be45bb8f373725eabf6aed092fb50bf
+  data.tar.gz: bd38063b3c625ac4296dacff7ca0499192bcbb140f744ea7a063a8fe4e3f98c5f1a1ee93831242592e0f744fecef512081f5fc5c9f134751dba6ea91d14e0285

data/README.md

@@ -8,6 +8,8 @@ gem install quality-report
 
 ## Usage
 
+Change to a project directory that contains `*.rb` files. Then:
+
 ```sh
 ruby-quality-report
 ```
@@ -16,7 +18,7 @@ After a bit of a wait, it outputs a report in table form:
 
 ![Screenshot](screenshot-1@2x.webp)
 
-This is showing, for each author, the percentage of problematic lines of code. Lower is better.
+This is showing, for each author, the percentage of problematic lines of code in the repo. Lower is better.
 
 
 ### For improved relevance, it has two filters.
@@ -44,7 +46,7 @@ It runs a subset of [Rubocop Metrics cops](https://docs.rubocop.org/rubocop/cops
 - [Method Length](https://docs.rubocop.org/rubocop/cops_metrics.html#metricsmethodlength)
 - [Perceived Complexity](https://docs.rubocop.org/rubocop/cops_metrics.html#metricsperceivedcomplexity)
 
-It then calculates the percentage of warnings per line written, per author. Each failing check is another warning.
+Then, using git, it calculates the percentage of warnings per line written, per author. Each failing check is another warning.
 
 
 ## Intent
@@ -56,7 +58,7 @@ This is a team management tool to:
 
 ## Foundational Research
 
-Diving a little deeper, I've seen the phenomenon of micro-economies of bug-creation and bug-fixing develop within teams. Some developers appear to be extremely productive. They write a lot of code. But they also introduce a lot of bugs. The productivity is illusory.
+Diving a little deeper, I've seen the phenomenon of "micro-economies" of bug-creation and bug-fixing develop within teams. Some developers appear to be extremely productive. They create a lot of commits. But they also create a lot of bugs. Their productivity is illusory.
 
 This code quality report doesn't track **bugs** per se. But it does report **quality and complexity**. Researchers have found a strong correlation between complexity and bug rate [1]. This link is reflected, _e.g.,_ in international safety standards that mandate low software complexity to reduce failures [2].
 
@@ -69,13 +71,13 @@ Complex code introduces bugs in a second, more subtle way. This is because code
 
 ## Roadmap
 
-- [ ] Colorize the output to separate high, medium, and low warning percentages.
-- [ ] Fix the numerical alignment.
-- [ ] Add a `--csv` option.
-- [ ] Make the filters configurable.
-- [ ] Speed up the scan.
+- [x] Colorize the output to separate high, medium, and low warning percentages.
+- [x] Fix the numerical alignment.
 - [ ] Add a progress bar.
+- [ ] Speed up the scan.
 - [ ] Refactor from script-style coding to a more standard Ruby project.
+- [ ] Make the filters configurable.
+- [ ] Add a `--csv` option.
 
 
 ## Contributing

data/exe/ruby-quality-report

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'tty-table'
+require 'pastel'
 
 #
 # ruby-quality-report
@@ -10,6 +11,9 @@ require 'tty-table'
 # of lines of code written by each author that have been flagged as
 # having too high of a complexity.
 #
+#
+
+SIXTY_DAYS_IN_SECONDS = 60 * 24 * 60 * 60
 
 def create_combined_stats(part_stats, whole_stats)
   part_data  = make_data_set(part_stats)
@@ -40,15 +44,42 @@ def generate_csv(combined_stats)
 end
 
 def generate_table(combined_stats)
-  table = TTY::Table.new(header: ['Author', 'Percent Flagged', 'Flagged Lines', 'All Lines'])
+  table      = TTY::Table.new(header: %W[Author Percent\nFlagged Flagged\nLines All\nLines])
+  table_data = generate_data(combined_stats).reject { should_skip?(_1) }
+
+  table_data.each do |stats|
+    table << [
+      { value: stats[:label],                          alignment: :left },
+      { value: "#{stats[:percent]}%",                  alignment: :right },
+      { value: int_to_accounting(stats[:part_count]),  alignment: :right },
+      { value: int_to_accounting(stats[:whole_count]), alignment: :right }
+    ]
+  end
 
-  generate_data(combined_stats).each do |stats|
-    next if should_skip?(stats)
+  render_table(table, table_data)
+end
 
-    table << [stats[:label], "#{stats[:percent]}%", stats[:part_count], stats[:whole_count]]
+def render_table(table, table_data)
+  pastel = Pastel.new
+
+  table.render(:unicode, alignment: :center, padding: [0, 1], multiline: true) do |renderer|
+    renderer.border.style = :dim
+    renderer.filter = lambda { |val, row_index, _col_index|
+      if row_index <= 0
+        # Header row
+        val
+      else
+        case table_data[row_index - 1][:percent]
+        when 0...40
+          val
+        when 40...50
+          pastel.bold.yellow(val)
+        else
+          pastel.bold.red(val)
+        end
+      end
+    }
   end
-
-  table.render(:unicode, alignments: %i[left right right right])
 end
 
 def generate_data(combined_stats)
@@ -73,13 +104,26 @@ def no_commits_in_last_60_days?(stats)
 
   # Convert Unix timestamp to Time object
   last_commit_time = Time.at(last_commit.to_i)
-  sixty_days_ago   = Time.now - (60 * 24 * 60 * 60) # 60 days in seconds
+  sixty_days_ago   = Time.now - SIXTY_DAYS_IN_SECONDS
 
   last_commit_time < sixty_days_ago
 end
 
+###
+# Converts a float to an integer percentage
+#
 def float_to_percent(a_float)
-  (Float(a_float) * 100).round(1)
+  (Float(a_float) * 100).round
+end
+
+##
+# Converts an integer to a string with commas separating thousands.
+#
+# An alternative implementation is:
+#   an_int.to_s.gsub(/(\d)(?=(\d{3})+(?!\d))/, '\\1,')
+#
+def int_to_accounting(an_int)
+  an_int.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
 end
 
 #

data/lib/quality_report/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QualityReport
-  VERSION = '1.3.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality_report
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop