how_is 11.0.0 → 12.0.0

data/lib/how_is/analyzer.rb

@@ -44,6 +44,9 @@ module HowIs
 
         oldest_issue: issue_or_pull_to_hash(oldest_for(issues)),
         oldest_pull: issue_or_pull_to_hash(oldest_for(pulls)),
+
+        newest_issue: issue_or_pull_to_hash(newest_for(issues)),
+        newest_pull: issue_or_pull_to_hash(newest_for(pulls)),
       )
     end
 
@@ -147,12 +150,24 @@ module HowIs
       "approximately #{value}"
     end
 
-    # Given an Array of issues or pulls, return the creation date of the oldest.
+    def sort_iops_by_created_at(issues_or_pulls)
+      issues_or_pulls.sort_by {|x| DateTime.parse(x['created_at']) }
+    end
+
+    # Given an Array of issues or pulls, return the oldest.
     # Returns nil if no issues or pulls are provided.
     def oldest_for(issues_or_pulls)
       return nil if issues_or_pulls.empty?
 
-      issues_or_pulls.sort_by {|x| DateTime.parse(x['created_at']) }.first
+      sort_iops_by_created_at(issues_or_pulls).first
+    end
+
+    # Given an Array of issues or pulls, return the newest.
+    # Returns nil if no issues or pulls are provided.
+    def newest_for(issues_or_pulls)
+      return nil if issues_or_pulls.empty?
+
+      sort_iops_by_created_at(issues_or_pulls).last
     end
 
     # Given an issue or PR, returns the date it was created.

data/lib/how_is/report/base_report.rb

@@ -0,0 +1,129 @@
+require 'json'
+
+module HowIs
+  ##
+  # Subclasses of BaseReport represent complete reports.
+  class BaseReport < Struct.new(:analysis)
+    def generate_report_text!
+      # title, text, header, horizontal_bar_graph, etc,
+      # append to @r, which is returned at the end of the function.
+
+      title "How is #{analysis.repository}?"
+
+      # DateTime#new_offset(0) sets the timezone to UTC. I think it does this
+      # without changing anything besides the timezone, but who knows, 'cause
+      # new_offset is entirely undocumented! (Even though it's used in the
+      # DateTime documentation!)
+      #
+      # TODO: Stop pretending everyone who runs how_is is in UTC.
+      text "Monthly report, ending on #{DateTime.now.new_offset(0).strftime('%B %e, %Y')}."
+
+      text github_pulse_summary
+
+      header "Pull Requests"
+      issue_or_pr_summary "pull", "pull request"
+
+      header "Issues"
+      issue_or_pr_summary "issue", "issue"
+
+      header "Issues Per 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
+
+      # See comment at beginning of function.
+      @r
+    end
+
+
+    
+    def format
+      raise NotImplementedError
+    end
+
+    def title(_text)
+      raise NotImplementedError
+    end
+
+    def header(_text)
+      raise NotImplementedError
+    end
+
+    def text(_text)
+      raise NotImplementedError
+    end
+
+    def link(_text, url)
+      raise NotImplementedError
+    end
+
+    def unordered_list(arr)
+      raise NotImplementedError
+    end
+
+    def horizontal_bar_graph(data)
+      raise NotImplementedError
+    end
+
+    def monthly_summary
+      raise NotImplementedError
+    end
+
+    def export
+      raise NotImplementedError
+    end
+
+    def export_file(file)
+      raise NotImplementedError
+    end
+
+    def to_h
+      analysis.to_h
+    end
+    alias :to_hash :to_h
+
+    def to_json
+      JSON.pretty_generate(to_h)
+    end
+
+    private
+    def github_pulse_summary
+      @pulse ||= HowIs::Pulse.new(analysis.repository)
+      @pulse.send("#{format}_summary")
+    end
+
+    def pluralize(text, number)
+      number == 1 ? text : "#{text}s"
+    end
+
+    def are_is(number)
+      number == 1 ? "is" : "are"
+    end
+
+    def issue_or_pr_summary(type, type_label)
+      date_format = "%b %e, %Y"
+      a = analysis
+
+      number_of_type = a.send("number_of_#{type}s")
+
+      type_link = a.send("#{type}s_url")
+      oldest = a.send("oldest_#{type}")
+      newest = a.send("newest_#{type}")
+
+      if number_of_type == 0
+        text "There are #{link("no #{type_label}s open", type_link)}."
+      else
+        text "There #{are_is(number_of_type)} #{link("#{number_of_type} #{pluralize(type_label, number_of_type)} open", type_link)}."
+
+        unordered_list [
+          "Average age: #{a.send("average_#{type}_age")}.",
+          "#{link('Oldest ' + type_label, oldest['html_url'])} was opened on #{oldest['date'].strftime(date_format)}.",
+          "#{link('Newest ' + type_label, newest['html_url'])} was opened on #{newest['date'].strftime(date_format)}.",
+        ]
+      end
+    end
+  end
+end

data/lib/how_is/report/html.rb

@@ -1,5 +1,5 @@
 require 'cgi'
-require 'how_is/pulse'
+require 'how_is/report/base_report'
 
 module HowIs
   class HtmlReport < BaseReport
@@ -9,29 +9,42 @@ module HowIs
 
     def title(_text)
       @title = _text
-      @r += "<h1>#{_text}</h1>"
+      @r += "\n<h1>#{_text}</h1>\n"
     end
 
     def header(_text)
-      @r += "<h2>#{_text}</h2>"
+      @r += "\n<h2>#{_text}</h2>\n"
     end
 
     def link(_text, url)
       %Q[<a href="#{url}">#{_text}</a>]
     end
 
-    def monthly_summary
-      pulse.html_summary
+    def text(_text)
+      @r += "<p>#{_text}</p>\n"
+    end
+
+    def unordered_list(arr)
+      @r += "\n<ul>\n"
+      arr.each do |item|
+        @r += "  <li>#{item}</li>\n"
+      end
+      @r += "</ul>\n\n"
     end
 
     def horizontal_bar_graph(data)
+      if data.length == 1 && data[0][0] == "(No label)"
+        text "There are no open issues to graph."
+        return
+      end
+
       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
       label_width = "#{longest_label_length}ch"
 
-      @r += '<table class="horizontal-bar-graph">'
+      @r += "<table class=\"horizontal-bar-graph\">\n"
       data.each do |row|
         percentage = get_percentage.(row[1])
 
@@ -46,22 +59,23 @@ module HowIs
     <td style="width: #{label_width}">#{label_text}</td>
     <td><span class="fill" style="width: #{percentage}%">#{row[1]}</span></td>
   </tr>
+
         EOF
       end
-      @r += "</table>"
+      @r += "</table>\n"
     end
 
-    def text(_text)
-      @r += "<p>#{_text}</p>"
+    def monthly_summary
+      pulse.html_summary
     end
 
-    def export(&block)
+    def export
       @r = ''
-      instance_exec(&block)
+      generate_report_text!
     end
 
-    def export_file(file, &block)
-      report = export(&block)
+    def export_file(file)
+      report = export
 
       File.open(file, 'w') do |f|
         f.puts <<-EOF

data/lib/how_is/report/json.rb

@@ -1,14 +1,16 @@
+require 'how_is/report/base_report'
+
 module HowIs
   class JsonReport < BaseReport
     def format
       :json
     end
 
-    def export(&block)
+    def export
       to_json
     end
 
-    def export_file(file, &block)
+    def export_file(file)
       File.open(file, 'w') do |f|
         f.write export
       end

data/lib/how_is/report.rb

@@ -8,102 +8,17 @@ module HowIs
     end
   end
 
-  ##
-  # Represents a completed report.
-  class BaseReport < Struct.new(:analysis)
-    def format
-      raise NotImplementedError
-    end
-
-    def github_pulse_summary
-      @pulse ||= HowIs::Pulse.new(analysis.repository)
-      @pulse.send("#{format}_summary")
-    end
-
-    def to_h
-      analysis.to_h
-    end
-    alias :to_hash :to_h
-
-    def to_json
-      to_h.to_json
-    end
-
-    private
-    def pluralize(text, number)
-      number == 1 ? text : "#{text}s"
-    end
-
-    def are_is(number)
-      number == 1 ? "is" : "are"
-    end
-
-    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")
-
-      type_link = a.send("#{type}s_url")
-      oldest = a.send("oldest_#{type}")
-
-      if number_of_type == 0
-        "There are #{link("no #{type_label}s open", type_link)}."
-      else
-        "There #{are_is(number_of_type)} #{link("#{number_of_type} #{pluralize(type_label, number_of_type)} 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
-  end
-
   class Report
     require 'how_is/report/json'
     require 'how_is/report/html'
 
-    # The way this entire class works is there is a REPORT_BLOCK proc which
-    # calls various methods to create the report, and REPORT_BLOCK is eventually
-    # instance_exec'd by the various *Report (HtmlReport, previously PdfReport)
-    # classes, which define the methods required.
-    #
-    # The *Report class inherit from BaseReport, which implements the common
-    # methods for them.
-
-    REPORT_BLOCK = proc do
-      title "How is #{analysis.repository}?"
-
-      # DateTime#new_offset(0) sets the timezone to UTC. I think it does this
-      # without changing anything besides the timezone, but who knows, 'cause
-      # new_offset is entirely undocumented! (Even though it's used in the
-      # DateTime documentation!)
-      #
-      # TODO: Stop pretending everyone who runs how_is is in UTC.
-      text "Monthly report, ending on #{DateTime.now.new_offset(0).strftime('%B %e, %Y')}."
-
-      text github_pulse_summary
-
-      header "Pull Requests"
-      text issue_or_pr_summary "pull", "pull request"
-
-      header "Issues"
-      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['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
-
     ##
     # Export a report to a file.
     def self.export_file(analysis, file)
       format = file.split('.').last
       report = get_report_class(format).new(analysis)
 
-      report.export_file(file, &REPORT_BLOCK)
+      report.export_file(file)
     end
 
     ##
@@ -111,7 +26,7 @@ module HowIs
     def self.export(analysis, format = HowIs::DEFAULT_FORMAT)
       report = get_report_class(format).new(analysis)
 
-      report.export(&REPORT_BLOCK)
+      report.export
     end
 
   private

data/lib/how_is/version.rb

@@ -1,3 +1,3 @@
 module HowIs
-  VERSION = "11.0.0"
+  VERSION = "12.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2016-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -202,7 +202,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rspec-ignore-tags"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -213,8 +212,9 @@ files:
 - bin/console
 - bin/setup
 - exe/how_is
-- fixtures/vcr_cassettes/how_is-example-repository.yml
-- fixtures/vcr_cassettes/how_is-with-config-file.yml
+- fixtures/vcr_cassettes/how-is-example-empty-repository.yml
+- fixtures/vcr_cassettes/how-is-example-repository.yml
+- fixtures/vcr_cassettes/how-is-with-config-file.yml
 - how_is.gemspec
 - lib/how_is.rb
 - lib/how_is/analyzer.rb
@@ -223,6 +223,7 @@ files:
 - lib/how_is/fetcher.rb
 - lib/how_is/pulse.rb
 - lib/how_is/report.rb
+- lib/how_is/report/base_report.rb
 - lib/how_is/report/html.rb
 - lib/how_is/report/json.rb
 - lib/how_is/version.rb
@@ -247,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository is.

data/.rspec-ignore-tags

@@ -1,2 +0,0 @@
---format documentation
---color