quality_report 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 864f3f5fa2d1b9a35478532a96341ef0b23df5911aa8eb8ac0293beb7e42397a
-  data.tar.gz: 926133e5ba6df85661a397f10e6c035e987b0d3a68920595633a8d3b6d4d9330
+  metadata.gz: 1aafbd19100b614829f3aa4a2d7043b7b7028da09443bb536e37ee809809b6c0
+  data.tar.gz: cf7797690c19a1dc7c1f89737d828a4270bee1b9c36c3183ea642109998fdb45
 SHA512:
-  metadata.gz: 047430fe2e35df46138827d368f7eae6dc24881a41f952e128f59fae156fe0338bfff5a721d148372983513f7d8f45bc71ecc6bd77377918bb8e8d5c755f0e4f
-  data.tar.gz: 154ffb7d0e21db6d0ac67b20a5d73247980ae074bf21323369a4ed2d9add28e4e7af101f11e90d8319240ce5a804715202fea345a2d8fd47d618683863f545c3
+  metadata.gz: e5b3663e60903633291665affbc5347c604fb60037adf8ac7661ddd82929009ad36335ad5e754d09f58b88f916df74d899ef7c75472fdbeb505ac3e2c06796a5
+  data.tar.gz: 9076995297047c26ede10b5c0c892a07eeb0b178e562da85aaf0a61a0a4e8bf173cfdecc62f86045d465d6c58a0d731923c871da28daa19604c2ea3c8e8038c8

data/README.md

@@ -6,6 +6,8 @@
 ruby-quality-report
 ```
 
+This outputs a CSV report to stdout.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/ruby-quality-report.

data/exe/ruby-author-warnings

@@ -21,10 +21,12 @@ RUBOCOP_WARNINGS = `rubocop --format json --force-default-config --only Metrics/
 
 LOCATIONS =
   JSON
-    .parse(RUBOCOP_WARNINGS)['files']
-    .reject{ |f| f['offenses'].empty? }
-    .map{ |f| f['offenses']
-      .map{|o| { path: f['path'], begin: o['location']['start_line'], end: o['location']['last_line'] }}}
+  .parse(RUBOCOP_WARNINGS)['files']
+  .reject { |f| f['offenses'].empty? }
+  .map do |f|
+    f['offenses']
+      .map { |o| { path: f['path'], begin: o['location']['start_line'], end: o['location']['last_line'] } }
+  end
     .flatten
 
 LOCATIONS.each do |location|

data/exe/ruby-line-authors

@@ -15,7 +15,7 @@
 # Bob
 # Alice
 
-RUBY_FILES = `find . -name '*.rb'`
+RUBY_FILES = `find . -name '*.rb'`.freeze
 
 RUBY_FILES
-  .each_line{ |filename| puts `line-authors #{filename}` }
+  .each_line { |filename| puts `line-authors #{filename}` }

data/exe/ruby-quality-report

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tty-table'
 
 #
 # ruby-quality-report
@@ -14,11 +17,12 @@ def create_combined_stats(part_stats, whole_stats)
 
   whole_data.map do |label, whole_count|
     part_count = part_data[label] || 0
+
     {
       label:,
       part_count:,
       whole_count:,
-      percent: part_count.to_f / whole_count.to_f
+      percent: float_to_percent(part_count.to_f / whole_count)
     }
   end
 end
@@ -27,27 +31,67 @@ def make_data_set(two_column_data)
   hash = {}
   two_column_data.each_line do |line|
     count, label = line.split(' ')
-    hash[label] = count.to_i
+    hash[label]  = 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(',') }
+    .tap { |x| x.prepend(['Author,Percent Flagged,Flagged Lines,All Lines']) }
+    .join("\n")
+end
+
+def generate_table(combined_stats)
+  table = TTY::Table.new(header: ['Author', 'Percent Flagged', 'Flagged Lines', 'All Lines'])
+
+  generate_data(combined_stats).each do |stats|
+    next if should_skip?(stats)
+
+    table << [stats[:label], "#{stats[:percent]}%", stats[:part_count], stats[:whole_count]]
+  end
+
+  table.render(:unicode)
+end
+
+def generate_data(combined_stats)
   combined_stats
-    .sort_by{|s| s[:percent]}
+    .sort_by { |s| s[:percent] }
     .reverse
-    .map{ |stats| [stats[:label], stats[:percent], stats[:part_count], stats[:whole_count]].join(',') }
-    .tap{|x| x.prepend(["Author,Percent Flagged,Flagged Lines,All Lines"])}
-    .join("\n")
 end
 
+def should_skip?(stats)
+  less_than_200_lines_total?(stats) || no_commits_in_last_60_days?(stats)
+end
+
+def less_than_200_lines_total?(stats)
+  stats[:whole_count] < 200
+end
+
+def no_commits_in_last_60_days?(stats)
+  author = stats[:label]
+
+  # Get the last commit timestamp in Unix epoch format
+  last_commit = `git log -1 --format="%at" --author="#{author}"`.chomp
+  return true if last_commit.empty? # Handle case where author has no commits
+
+  # 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
+
+  last_commit_time < sixty_days_ago
+end
+
+def float_to_percent(a_float)
+  (Float(a_float) * 100).round(1)
+end
 
 #
 # Execution begins here
 #
-PART_STATS  = `ruby-author-warnings | frequency-list`
-WHOLE_STATS = `ruby-line-authors | frequency-list`
-
+PART_STATS     = `ruby-author-warnings | frequency-list`.freeze
+WHOLE_STATS    = `ruby-line-authors | frequency-list`.freeze
 COMBINED_STATS = create_combined_stats(PART_STATS, WHOLE_STATS)
 
-puts generate_csv(COMBINED_STATS)
+puts generate_table(COMBINED_STATS)

data/lib/quality_report/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quality_report
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Robb Shecter
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.68'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement