quality_report 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887fda6d1ac12508da2c4b19b6142b061dddc0a5814a704da31091a674383811
-  data.tar.gz: 41d6473f6b5a673c1f4f3d0ff0dc37bb4ee8f81260874392f1d7cd530a9ce5ee
+  metadata.gz: a14f06872f83645bba1702173f3f9ee1942c54ae51ca3031db00158c63b51217
+  data.tar.gz: 614f5743e39d968b4a431206f5f886a40a258a849e2a89543687ce00b2a8015f
 SHA512:
-  metadata.gz: 583024b0f69b6d41b6f4e9e0451ebeb0f67fc18649df41938cd3bbd4a969b27ea5c95f5c3ae38c107b51af3f51a27fb69e8e0ba2cce43d1fa774ea77f0873fe7
-  data.tar.gz: 14e8f05560c3bd0a0d598ad0c62fa669eaf358914bef07a27007551873f6a45caf7054613e40e58ad3dd3ddc9c4ce885f6fd5d90432112056c16ff66dcbdcbe0
+  metadata.gz: 5af1a4cfcef6c1831c40a5a6a111d684091ad282109015a9438ec9ab692349a7284b73a9e0b06d3ce51c29536f6167e4b3429386841a2fe622f9846ddd99c5a3
+  data.tar.gz: a059cce459f23251d0d7c72cd0b29d4f3f3824fb2bf65a8e2d9fb0af78299a4dec89af4986071534ce690e0e7838aa00289c0171db94da8beddfbc1830197bbe

data/.rubocop.yml

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

data/README.md

@@ -1,39 +1,13 @@
-# QualityReport
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/quality_report`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+# Ruby Quality Report
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```sh
+ruby-quality-report
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+This outputs a CSV report to stdout.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/quality_report.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/ruby-quality-report.

data/exe/frequency-list

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# frequency-list
+#
+# Input:  A list of lines.
+# Output: The unique lines in the input, sorted by frequency of occurrence.
+#
+# EXAMPLE
+#
+# Input:
+#
+#   apple
+#   banana
+#   apple
+#   cherry
+#
+# Output:
+#
+#   2 apple
+#   1 banana
+#   1 cherry
+#
+
+lines = ARGF.readlines
+
+frequency = lines.each_with_object(Hash.new(0)) do |line, counts|
+  counts[line.chomp] += 1
+end
+
+sorted_frequency = frequency.sort_by { |_, count| -count }
+
+sorted_frequency.each do |line, count|
+  puts "#{count} #{line}"
+end

data/exe/line-authors

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# line-authors
+#
+# List the authors of a single file, optionally limited
+# to the specified lines. Outputs one author name for each
+# line.
+#
+# USAGE
+#
+# line-authors <filename> <start line> <end line>
+# line-authors <filename>
+#
+
+GIT_COMMAND = case ARGV.length
+              when 3
+                filename, start_line, end_line = ARGV
+                "git blame --line-porcelain -L #{start_line},#{end_line} #{filename}"
+              when 1
+                filename = ARGV[0]
+                "git blame --line-porcelain #{filename}"
+              else
+                puts 'Usage: line-authors <filename> <start line> <end line>'
+                puts '       line-authors <filename>'
+                exit 1
+              end
+
+puts(`#{GIT_COMMAND}`
+   .lines
+   .select { |line| line.start_with?('author ') }
+   .map { |line| line.split(' ')[1] })

data/exe/ruby-author-warnings

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'json'
+
+#
+# ruby-author-warnings
+#
+# This script outputs the authors of the lines of code that
+# have been flagged by Rubocop as having too high of a complexity.
+#
+# Three metrics are used to determine complexity:
+#
+# - ABC Size
+# - Cyclomatic Complexity
+# - Perceived Complexity
+#
+# Each line of code can trigger one or more of these metrics.
+# Each triggered line is listed as a separate warning.
+#
+
+RUBOCOP_WARNINGS = `rubocop --format json --force-default-config --only Metrics/AbcSize,Metrics/BlockLength,Metrics/BlockNesting,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity`
+
+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'] }}}
+    .flatten
+
+LOCATIONS.each do |location|
+  puts `line-authors #{location[:path]} #{location[:begin]} #{location[:end]}`
+end

data/exe/ruby-line-authors

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+#
+# ruby-line-authors
+#
+# Output the authors of every line of Ruby code in this
+# directory and all subdirectories. Names are output
+# for every line.
+#
+# Example output when Alice wrote three lines and Bob
+# wrote one, irrespective of the number of files:
+#
+# Alice
+# Alice
+# Bob
+# Alice
+
+RUBY_FILES = `find . -name '*.rb'`
+
+RUBY_FILES
+  .each_line{ |filename| puts `line-authors #{filename}` }

data/exe/ruby-quality-report

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tty-table'
+
+#
+# ruby-quality-report
+#
+# This script outputs a CSV spreadsheet file showing the percentage
+# of lines of code written by each author that have been flagged as
+# having too high of a complexity.
+#
+
+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
+
+    {
+      label:,
+      part_count:,
+      whole_count:,
+      percent: float_to_percent(part_count.to_f / whole_count)
+    }
+  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
+  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] }
+    .reverse
+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`
+COMBINED_STATS = create_combined_stats(PART_STATS, WHOLE_STATS)
+
+puts generate_table(COMBINED_STATS)

data/lib/quality_report/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QualityReport
-  VERSION = "0.1.0"
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quality_report
 version: !ruby/object:Gem::Version
-  version: 0.1.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
@@ -41,19 +55,30 @@ dependencies:
 description: 'Ruby code quality report for teams: generates comparative metrics.'
 email:
 - robb@public.law
-executables: []
+executables:
+- frequency-list
+- line-authors
+- ruby-author-warnings
+- ruby-line-authors
+- ruby-quality-report
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
+- exe/frequency-list
+- exe/line-authors
+- exe/ruby-author-warnings
+- exe/ruby-line-authors
+- exe/ruby-quality-report
 - lib/quality_report.rb
 - lib/quality_report/version.rb
 - sig/quality_report.rbs
 homepage: https://github.com/dogweather/ruby-quality-report
 licenses:
-- Mozilla Public License 2.0
+- MPL-2.0
 metadata:
   homepage_uri: https://github.com/dogweather/ruby-quality-report
   source_code_uri: https://github.com/dogweather/ruby-quality-report
@@ -66,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="