quality_report 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d2fbfb3f81887e40858181c9822346e770e8f242d96cfb39b8239b5288cb37
-  data.tar.gz: f39b9f3ae08503660b79bcc0d286ae622d5e0aa5c06b056ef635a8af8def8576
+  metadata.gz: 51abac0022982e8c18d66396b580a4acadcbc14f86fd698f6e551e0d95cd304a
+  data.tar.gz: 8f4c5b26c6dd55268206ebe402642a88a287e5339d93a7dcd2532b11093e5564
 SHA512:
-  metadata.gz: de5bfd72e7ea4b31e0bf57785ea38d5503624f0861adc660c1844848d32d839a90ecfb0ed6f5de1eabe13293846fd1771be45bb8f373725eabf6aed092fb50bf
-  data.tar.gz: bd38063b3c625ac4296dacff7ca0499192bcbb140f744ea7a063a8fe4e3f98c5f1a1ee93831242592e0f744fecef512081f5fc5c9f134751dba6ea91d14e0285
+  metadata.gz: 701288fc0a288adba125cb2299810b79067ef86486ae1c94cdf87f86b0ebdf030226cb4c925c10a43455ee606a2a70f3396b5d538feb5b07200cbeedb22acde2
+  data.tar.gz: cfca2cab37975eed90e80b6c018f35c7a193f4977c7c6d62b21057f6d8513d0a3b3fd1bc33e4f1f9f826bbd5887bfd81bd7a69134b793cec5a22c6beb9c3138d

data/.rubocop.yml

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

data/README.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-gem install quality-report
+gem install quality_report
 ```
 
 ## Usage
@@ -73,6 +73,8 @@ Complex code introduces bugs in a second, more subtle way. This is because code
 
 - [x] Colorize the output to separate high, medium, and low warning percentages.
 - [x] Fix the numerical alignment.
+- [ ] --add-column option.
+- [ ] --skip option.
 - [ ] Add a progress bar.
 - [ ] Speed up the scan.
 - [ ] Refactor from script-style coding to a more standard Ruby project.

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'
 
@@ -19,46 +21,60 @@ def create_combined_stats(part_stats, whole_stats)
   part_data  = make_data_set(part_stats)
   whole_data = make_data_set(whole_stats)
 
-  whole_data.map do |label, whole_count|
-    part_count = part_data[label] || 0
+  whole_data.map do |author, whole_count|
+    part_count = part_data[author] || 0
     percent    = float_to_percent(part_count.to_f / whole_count)
 
-    { label:, part_count:, whole_count:, percent: }
+    { author:, part_count:, whole_count:, percent: }
   end
 end
 
 def make_data_set(two_column_data)
   hash = {}
   two_column_data.each_line do |line|
-    count, label = line.split(' ')
-    hash[label]  = count.to_i
+    count, author = line.split(' ')
+    hash[author]  = count.to_i
   end
   hash
 end
 
 def generate_csv(combined_stats)
   generate_data(combined_stats)
-    .map { |stats| [stats[:label], stats[:percent], stats[:part_count], stats[:whole_count]].join(',') }
+    .map { |stats| [stats[:author], stats[:percent], stats[:part_count], stats[:whole_count]].join(',') }
     .tap { |x| x.prepend(['Author,Percent Flagged,Flagged Lines,All Lines']) }
     .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: '')
+  author_heading   = ['Author']
+  static_heading   = [colspec.keys&.first].compact
+  default_headings = ['Percent Flagged', 'Flagged Lines', 'All lines']
+  all_headings     = author_heading + static_heading + default_headings
+
+  table         = TTY::Table.new(header: all_headings)
+  table_data    = generate_data(combined_stats).reject { should_skip?(_1) }
+  static_values = colspec[static_heading.first] || {}
 
   table_data.each do |stats|
-    table << [
-      { value: stats[:label],                          alignment: :left },
+    next if skip.include?(stats[:author])
+
+    author_column   = [{ value: stats[:author], alignment: :left }]
+    static_column   = [static_heading.any? ? { value: static_values[stats[:author]], alignment: :left } : nil]
+    dynamic_columns = [
       { value: "#{stats[:percent]}%",                  alignment: :right },
       { value: int_to_accounting(stats[:part_count]),  alignment: :right },
       { value: int_to_accounting(stats[:whole_count]), alignment: :right }
     ]
+
+    table << (author_column + static_column + dynamic_columns).compact
   end
 
   render_table(table, table_data)
 end
 
+##
+# Renders the table with color coding based on the percentage of flagged lines.
+#
 def render_table(table, table_data)
   pastel = Pastel.new
 
@@ -96,7 +112,7 @@ def less_than_200_lines_total?(stats)
 end
 
 def no_commits_in_last_60_days?(stats)
-  author = stats[:label]
+  author = stats[:author]
 
   # Get the last commit timestamp in Unix epoch format
   last_commit = `git log -1 --format="%at" --author="#{author}"`.chomp
@@ -126,11 +142,82 @@ 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.5.0'
+  VERSION = '1.7.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.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-10 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