quality_report 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 864f3f5fa2d1b9a35478532a96341ef0b23df5911aa8eb8ac0293beb7e42397a
-  data.tar.gz: 926133e5ba6df85661a397f10e6c035e987b0d3a68920595633a8d3b6d4d9330
+  metadata.gz: a14f06872f83645bba1702173f3f9ee1942c54ae51ca3031db00158c63b51217
+  data.tar.gz: 614f5743e39d968b4a431206f5f886a40a258a849e2a89543687ce00b2a8015f
 SHA512:
-  metadata.gz: 047430fe2e35df46138827d368f7eae6dc24881a41f952e128f59fae156fe0338bfff5a721d148372983513f7d8f45bc71ecc6bd77377918bb8e8d5c755f0e4f
-  data.tar.gz: 154ffb7d0e21db6d0ac67b20a5d73247980ae074bf21323369a4ed2d9add28e4e7af101f11e90d8319240ce5a804715202fea345a2d8fd47d618683863f545c3
+  metadata.gz: 5af1a4cfcef6c1831c40a5a6a111d684091ad282109015a9438ec9ab692349a7284b73a9e0b06d3ce51c29536f6167e4b3429386841a2fe622f9846ddd99c5a3
+  data.tar.gz: a059cce459f23251d0d7c72cd0b29d4f3f3824fb2bf65a8e2d9fb0af78299a4dec89af4986071534ce690e0e7838aa00289c0171db94da8beddfbc1830197bbe

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-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
@@ -33,21 +37,43 @@ def make_data_set(two_column_data)
 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)
+  stats[:whole_count] < 200
+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`
+WHOLE_STATS    = `ruby-line-authors | frequency-list`
 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.1.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.1.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