quality_report 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36b81a22b99492d9995e4446769315fe3a01df58e39ed71a3a1050bc05f1791
-  data.tar.gz: ebc3e1150b528d795fd72e926a462a93aca6311f4a232a3d94c04416bc0a7a7e
+  metadata.gz: eb26bd22c7b99d601f0eca7648de96e15dc06ac06b405c887cca9c92e96d353f
+  data.tar.gz: 03bc3e1613cc9bdb6b84d123164ec213051054d5f05b9627ab57394ca9df721f
 SHA512:
-  metadata.gz: 1e9379b163149edcab1180868a320b7b5529f6c73b5a8c90cc2ffe3292fa818ccc1a48a1cfef9fb6a319fd9dbdf348fc9e6f66749d9b82e4886f2f4a42a50d4d
-  data.tar.gz: f9911d996413da6cf9264b34749e318d01a1c64e85925c76dae7da609966495341e7fc9d5956866b32c477cc7adbf9f0fbbe50bd0422773242b69e16a122003f
+  metadata.gz: 4a35e38922d52d49f34d6e4269e76aa1e43820f7c3d22ab569aa92667397cf3a1b9b0bfeed46fbc188bf3fcf9911166c6ec8372f074c033272e378b21a9e3383
+  data.tar.gz: d841f2ecc4afc0bbefeacc3500be6132e976d82da5705759151527d8be64b03cfdb96083e2819eff1590d725d1f34e59b644c349bb6c08ef09146bf4e893211a

data/.rubocop.yml

@@ -1,2 +1,2 @@
 AllCops:
-  TargetRubyVersion: 3.1 
+  TargetRubyVersion: 3.1

data/README.md

@@ -3,11 +3,13 @@
 ## Installation
 
 ```sh
-gem install quality-report
+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/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/exe/ruby-quality-report

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'json'
+require 'tty-option'
 require 'tty-table'
 require 'pastel'
 
@@ -43,17 +45,27 @@ def generate_csv(combined_stats)
     .join("\n")
 end
 
-def generate_table(combined_stats)
-  table      = TTY::Table.new(header: %W[Author Percent\nFlagged Flagged\nLines All\nLines])
-  table_data = generate_data(combined_stats).reject { should_skip?(_1) }
+def generate_table(combined_stats, colspec: {}, skip: '')
+  default_headings = ['Author', 'Percent Flagged', 'Flagged Lines', 'All lines']
+  static_heading   = colspec.keys&.first # Handle just one column for now
+  all_headings     = (default_headings + [static_heading]).compact
+
+  table         = TTY::Table.new(header: all_headings)
+  table_data    = generate_data(combined_stats).reject { should_skip?(_1) }
+  static_values = colspec[static_heading] || {}
 
   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 }
+    next if skip.include?(stats[:label])
+
+    new_row = [
+      { 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 }
     ]
+    new_row << { value: static_values[stats[:label]], alignment: :left } if static_heading
+
+    table << new_row
   end
 
   render_table(table, table_data)
@@ -109,15 +121,99 @@ 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
+
+#
+# CLI Argument Parser
+#
+class Command
+  include TTY::Option
+
+  usage do
+    program 'ruby-quality-report'
+    no_command
+    header 'Ruby Quality Report'
+    desc <<~DESC
+      Generates a report of the percentage of flagged lines of code written by each author. For improved relevance, it excludes:
+
+        - authors with fewer than 200 lines of code
+        - authors with no commits in the previous 60 days
+
+      It runs a suite of Rubocop metrics on *.rb files recursively starting in the current directory.  Then, using git, it calculates the percentage of warnings per line written, per author. Each failing check is another warning.
+    DESC
+
+    example <<~EXAMPLE1
+      Append a column showing office location. The order of the keys in the JSON does not matter:
+        $ ruby-quality-report -c '{"Location": {"Amy": "NYC", "Bob": "Remote"}}'
+    EXAMPLE1
+
+    example <<~EXAMPLE2
+      Skip one author:
+        $ ruby-quality-report --skip Cathy
+    EXAMPLE2
+  end
+
+  option :add_column do
+    long '--add-column JSON'
+    short '-c JSON'
+    desc 'Add a static column to the report. This is a simple way to add known information. See the examples.'
+  end
+
+  flag :skip do
+    long '--skip AUTHOR'
+    short '-s AUTHOR'
+    desc 'Filter out a git author'
+  end
+
+  flag :help do
+    short '-h'
+    long '--help'
+    desc 'Print this help'
+  end
+
+  def run
+    if params[:help]
+      print help
+      exit 1
+    elsif params.errors.any?
+      puts params.errors.summary
+      exit 1
+    end
+  end
 end
 
 #
 # Execution begins here
 #
+
+command = Command.new
+command.parse
+command.run
+
+add_column_param = command.params[:add_column]
+colspec          = add_column_param ? JSON.parse(add_column_param) : {}
+puts "Adding column: #{colspec.keys.first}" unless colspec.empty?
+
+skip = command.params[:skip] || ''
+puts "Skipping author: #{skip}" if skip != ''
+
 PART_STATS     = `ruby-author-warnings | frequency-list`.freeze
-WHOLE_STATS    = `ruby-line-authors | frequency-list`.freeze
+WHOLE_STATS    = `ruby-line-authors    | frequency-list`.freeze
 COMBINED_STATS = create_combined_stats(PART_STATS, WHOLE_STATS)
 
-puts generate_table(COMBINED_STATS)
+puts generate_table(COMBINED_STATS, colspec:, skip:)

data/lib/quality_report/version.rb

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

data/lib/quality_report.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "quality_report/version"
+require_relative 'quality_report/version'
 
 module QualityReport
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quality_report
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.68'
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  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: tty-table
   requirement: !ruby/object:Gem::Requirement