quality_report 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36b81a22b99492d9995e4446769315fe3a01df58e39ed71a3a1050bc05f1791
-  data.tar.gz: ebc3e1150b528d795fd72e926a462a93aca6311f4a232a3d94c04416bc0a7a7e
+  metadata.gz: 23d2fbfb3f81887e40858181c9822346e770e8f242d96cfb39b8239b5288cb37
+  data.tar.gz: f39b9f3ae08503660b79bcc0d286ae622d5e0aa5c06b056ef635a8af8def8576
 SHA512:
-  metadata.gz: 1e9379b163149edcab1180868a320b7b5529f6c73b5a8c90cc2ffe3292fa818ccc1a48a1cfef9fb6a319fd9dbdf348fc9e6f66749d9b82e4886f2f4a42a50d4d
-  data.tar.gz: f9911d996413da6cf9264b34749e318d01a1c64e85925c76dae7da609966495341e7fc9d5956866b32c477cc7adbf9f0fbbe50bd0422773242b69e16a122003f
+  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

@@ -49,10 +49,10 @@ def generate_table(combined_stats)
 
   table_data.each do |stats|
     table << [
-      { value: stats[:label],         alignment: :left },
-      { value: "#{stats[:percent]}%", alignment: :right },
-      { value: stats[:part_count],    alignment: :right },
-      { value: stats[:whole_count],   alignment: :right }
+      { 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
 
@@ -109,8 +109,21 @@ def no_commits_in_last_60_days?(stats)
   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.4.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.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop