how_is 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d03e9957e3cfefe6c95927bf11693ee2556d318
-  data.tar.gz: 9159d25f1cd1f7d221a21fb7d0d38a844a271fda
+  metadata.gz: 8f8b7397035c52022ad95011075e202e3f4e271e
+  data.tar.gz: 1bc5444c77188717a43d667e36d84185576bb6f6
 SHA512:
-  metadata.gz: bad3e1bd77fa4958c81c497b3002309121efc4575c8f5b45e31d302abb7ce23a0332999bcf631e08b735a612acb32ae0eb57e4b35df4d7b332b3adf2618506a2
-  data.tar.gz: f6989dc7995c9aaf8215f1dd813d9173a14aa54fc9003bec21d91885e6335ac26c2a33c76ceaad4791a6243e0b3e9291cd89a5f65b3c7ecd190e72057e95926f
+  metadata.gz: 003439cd51e94bd6e7136cfae977bb8bcb1f7b5f3d9a1b5b3ebf7404f8d3d21ab668901c87565314d17bd1b2bd78e2481151c4ccbcc593b3418a006063c8e407
+  data.tar.gz: 040161c89aa03c12083fcae5c0e944776298b75c65087c0ac5e24b0c85b8dc10312d3b6f2b7c02356dfde0835e99e678e8540aa9e8aaf27806cde3982d8db607

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 rvm:
   - 2.2
-  - jruby
-  - rbx-2
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -1,4 +1,6 @@
 [![Stories in Ready](https://badge.waffle.io/duckinator/how_is.png?label=ready&title=Ready)](https://waffle.io/duckinator/how_is)
+[![Build Status](https://travis-ci.org/duckinator/how_is.svg?branch=master)](https://travis-ci.org/duckinator/how_is)
+
 # How is [your repo]?
 
 `how_is` is tool for generating summaries of the health of a codebase. It uses information available from issues and pull requests to provide an overview of a repository and highlight problem areas of the codebase.

data/exe/how_is

@@ -33,12 +33,16 @@ opts = OptionParser.new do |opts|
     options[:from_file] = file
   end
 
-  opts.on("--report REPORT_FILE", "CSV file containing the report") do |file|
+  opts.on("--report REPORT_FILE", "file containing the report") do |file|
     options[:report_file] = file
   end
 end
 opts.parse!
 
+unless HowIs.can_export_to?(options[:report_file])
+   abort "Invalid file: #{options[:report_file]}. Supported formats: #{HowIs.supported_formats.join(', ')}"
+end
+
 if options[:from_file]
   # Opening this file here seems a bit messy, but it works.
   options[:repository] = JSON.parse(open(options[:from_file]).read)['repository']

data/how_is.gemspec

@@ -19,12 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "github_api", "~> 0.13.1"
-  spec.add_runtime_dependency "configru", "~> 3.6.0"
   spec.add_runtime_dependency "contracts"
   spec.add_runtime_dependency "prawn"
 
   spec.add_runtime_dependency "mini_magick"
 
+  # Travis CI only supports up to Ruby 2.2.0, but Rack 2.0+ requires Ruby 2.2.2+,
+  # so this pegs Rack to the latest version that works with Ruby 2.2.0.
+  spec.add_runtime_dependency "rack", "< 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/how_is/analyzer.rb

@@ -24,19 +24,22 @@ module HowIs
       pulls = data.pulls
 
       analysis_class.new(
+        issues_url: "https://github.com/#{data.repository}/issues",
+        pulls_url: "https://github.com/#{data.repository}/pulls",
+
         repository: data.repository,
 
         number_of_issues:  issues.length,
         number_of_pulls:   pulls.length,
 
-        issues_with_label: num_with_label(issues),
-        issues_with_no_label: num_with_no_label(issues),
+        issues_with_label: with_label_links(num_with_label(issues), data.repository),
+        issues_with_no_label: {link: nil, total: num_with_no_label(issues)},
 
         average_issue_age: average_age_for(issues),
         average_pull_age:  average_age_for(pulls),
 
-        oldest_issue_date: oldest_date_for(issues),
-        oldest_pull_date:  oldest_date_for(pulls),
+        oldest_issue: issue_or_pull_to_hash(oldest_for(issues)),
+        oldest_pull: issue_or_pull_to_hash(oldest_for(pulls)),
       )
     end
 
@@ -51,6 +54,10 @@ module HowIs
         [k, v]
       end.to_h
 
+      %w[oldest_issue oldest_pull].each do |key|
+        hash[key]['date'] = DateTime.parse(hash[key]['date'])
+      end
+
       Analysis.new(hash)
     end
 
@@ -129,13 +136,35 @@ module HowIs
     end
 
     # Given an Array of issues or pulls, return the creation date of the oldest.
-    def oldest_date_for(issues_or_pulls)
-      issues_or_pulls.map {|x| DateTime.parse(x['created_at']) }.sort.first
+    def oldest_for(issues_or_pulls)
+      issues_or_pulls.sort_by {|x| DateTime.parse(x['created_at']) }.first
+    end
+
+    def date_for(issue_or_pull)
+      DateTime.parse(issue_or_pull['created_at'])
     end
 
   private
+    def with_label_links(labels, repository)
+      labels.map do |label, num_issues|
+        label_link = "https://github.com/#{repository}/issues?q=" + CGI.escape("is:open is:issue label:\"#{label}\"")
+
+        [label, {link: label_link, total: num_issues}]
+      end.to_h
+    end
+
     def time_ago_in_seconds(x)
       DateTime.now.strftime("%s").to_i - DateTime.parse(x).strftime("%s").to_i
     end
+
+    def issue_or_pull_to_hash(iop)
+      ret = {}
+
+      ret[:html_url] = iop['html_url']
+      ret[:number] = iop['number']
+      ret[:date] = date_for(iop)
+
+      ret
+    end
   end
 end

data/lib/how_is/report/html.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module HowIs
   class HtmlReport < BaseReport
     def title(_text)
@@ -9,8 +11,12 @@ module HowIs
       @r += "<h2>#{_text}</h2>"
     end
 
+    def link(_text, url)
+      %Q[<a href="#{url}">#{_text}</a>]
+    end
+
     def horizontal_bar_graph(data)
-      biggest = data.map(&:last).max
+      biggest = data.map { |x| x[1] }.max
       get_percentage = ->(number_of_issues) { number_of_issues * 100 / biggest }
 
       longest_label_length = data.map(&:first).map(&:length).max
@@ -19,9 +25,16 @@ module HowIs
       @r += '<table class="horizontal-bar-graph">'
       data.each do |row|
         percentage = get_percentage.(row[1])
+
+        if row[2]
+          label_text = link(row[0], row[2])
+        else
+          label_text = row[1]
+        end
+
         @r += <<-EOF
   <tr>
-    <td style="width: #{label_width}">#{row[0]}</td>
+    <td style="width: #{label_width}">#{label_text}</td>
     <td><span class="fill" style="width: #{percentage}%">#{row[1]}</span></td>
   </tr>
         EOF

data/lib/how_is/report/pdf.rb

@@ -19,13 +19,18 @@ module HowIs
       }
     end
 
+    def link(_text, url)
+      # TODO: Actually have links.
+      _text
+    end
+
     def horizontal_bar_graph(data)
       filename_base = "./issues-per-label"
       dat_file = filename_base + '.dat'
       png_file = filename_base + '.png'
 
       File.open(dat_file, 'w') do |f|
-        data.each_with_index do |(label, n), i|
+        data.each_with_index do |(label, n, link), i|
           f.puts "#{i}\t#{n}\t\"#{label}\""
         end
       end

data/lib/how_is/report.rb

@@ -18,16 +18,19 @@ module HowIs
     end
 
     private
-      def issue_or_pr_summary(type, type_label)
-        oldest_date_format = "%b %e, %Y"
-        a = analysis
+    def issue_or_pr_summary(type, type_label)
+      oldest_date_format = "%b %e, %Y"
+      a = analysis
 
-        number_of_type = a.send("number_of_#{type}s")
+      number_of_type = a.send("number_of_#{type}s")
 
-        "There are #{number_of_type} #{type_label}s open. " +
-        "The average #{type_label} age is #{a.send("average_#{type}_age")}, and the " +
-        "oldest was opened on #{a.send("oldest_#{type}_date").strftime(oldest_date_format)}."
-      end
+      type_link = a.send("#{type}s_url")
+      oldest = a.send("oldest_#{type}")
+
+      "There are #{link("#{number_of_type} #{type_label}s open", type_link)}. " +
+      "The average #{type_label} age is #{a.send("average_#{type}_age")}, and the " +
+      "#{link("oldest", oldest['html_url'])} was opened on #{oldest['date'].strftime(oldest_date_format)}."
+    end
   end
 
   class Report
@@ -45,8 +48,11 @@ module HowIs
       text issue_or_pr_summary "issue", "issue"
 
       header "Issues Per Label"
-      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(k, v)| v.to_i }.reverse
-      issues_per_label << ["(No label)", analysis.issues_with_no_label]
+      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(k, v)| v['total'].to_i }.reverse
+      issues_per_label.map! do |label, hash|
+        [label, hash['total'], hash['link']]
+      end
+      issues_per_label << ["(No label)", analysis.issues_with_no_label['total'], nil]
       horizontal_bar_graph issues_per_label
     end
 

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 module HowIs
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/how_is.rb

@@ -21,6 +21,15 @@ module HowIs
 
     Report.export(analysis, format)
   end
+
+  def self.supported_formats
+    report_constants = HowIs.constants.grep(/.Report/) - [:BaseReport]
+    report_constants.map {|x| x.to_s.split('Report').first.downcase }
+  end
+
+  def self.can_export_to?(file)
+    supported_formats.include?(file.split('.').last)
+  end
 private
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: configru
+  name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: contracts
+  name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: prawn
+  name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- data/how_is_spec/generate_report--generates-a-correct-JSON-report.json
 - data/issues.plg
 - exe/how_is
 - how_is.gemspec

data/data/how_is_spec/generate_report--generates-a-correct-JSON-report.json

@@ -1 +0,0 @@
-{"repository":"rubygems/rubygems","number_of_issues":30,"number_of_pulls":30,"issues_with_label":{"triage":7,"bug report":9,"feedback":4,"osx":1,"bug fix":4,"category - install":5,"feature implementation":2,"major bump":2,"windows":1,"feature request":1,"cleanup":1,"accepted":2,"category - #gem or #require":1,"ready for work":1,"question":3,"administrative":1},"issues_with_no_label":0,"average_issue_age":"approximately 3 months and 1 week","average_pull_age":"approximately 11 months and 3 days","oldest_issue_date":"2016-01-31T21:28:02+00:00","oldest_pull_date":"2013-09-16T15:04:07+00:00"}