how_is 18.0.4 → 18.0.5

data/lib/how_is/pulse.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'tessellator/fetcher'
+require "tessellator/fetcher"
 
 class HowIs
   # This entire class is a monstrous hack, because GitHub doesn't provide
@@ -14,33 +14,34 @@ class HowIs
       @pulse_page_response = fetch_pulse!(repository)
     end
 
-    # This is probably dead code.
-    def text_summary
-      raise NotImplementedError
-    end
-
     # Gets the HTML Pulse summary.
     def html_summary
-      parts =
-        @pulse_page_response.body
-          .split('<div class="section diffstat-summary">')
-
-      if parts.length == 1
-        return "There hasn't been any activity on #{@repository} in the last month."
+      if stats_section?
+        stats_html_fragment.gsub('<a href="/', '<a href="https://github.com/')
+      else
+        "There hasn't been any activity on #{@repository} in the last month."
       end
-
-      parts
-        .last
-        .split('</div>').first
-        .gsub('<a href="/', '<a href="https://github.com/')
-        .strip
     end
 
     private
 
+    HTML_SEPARATOR_FOR_STATS = '<div class="section diffstat-summary">'
+
+    def stats_section?
+      parts.count > 1
+    end
+
+    def parts
+      @parts ||= @pulse_page_response.body.split(HTML_SEPARATOR_FOR_STATS)
+    end
+
+    def stats_html_fragment
+      parts.last.split("</div>").first.strip
+    end
+
     # Fetch Pulse page from GitHub for scraping.
     def fetch_pulse!(repository)
-      Tessellator::Fetcher.new.call('get', "https://github.com/#{repository}/pulse/monthly")
+      Tessellator::Fetcher.new.call("get", "https://github.com/#{repository}/pulse/monthly")
     end
   end
 end

data/lib/how_is/report/base_report.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 class HowIs
+  BaseReport = Struct.new(:analysis)
+
   ##
   # Subclasses of BaseReport represent complete reports.
-  class BaseReport < Struct.new(:analysis)
+  class BaseReport
     def generate_report_text!
       # title, text, header, horizontal_bar_graph, etc,
       # append to @r, which is returned at the end of the function.
@@ -29,11 +31,11 @@ class HowIs
       issue_or_pr_summary "issue", "issue"
 
       header "Issues Per Label"
-      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(_, v)| v['total'].to_i }.reverse
+      issues_per_label = analysis.issues_with_label.to_a.sort_by { |(_, v)| v["total"].to_i }.reverse
       issues_per_label.map! do |label, hash|
-        [label, hash['total'], hash['link']]
+        [label, hash["total"], hash["link"]]
       end
-      issues_per_label << ["(No label)", analysis.issues_with_no_label['total'], nil]
+      issues_per_label << ["(No label)", analysis.issues_with_no_label["total"], nil]
       horizontal_bar_graph issues_per_label
 
       # See comment at beginning of function.
@@ -123,19 +125,20 @@ class HowIs
       date_format = "%b %e, %Y"
       a = analysis
 
-      number_of_type = a.send("number_of_#{type}s")
+      number_of_type = a.public_send("number_of_#{type}s")
 
-      type_link = a.send("#{type}s_url")
-      oldest = a.send("oldest_#{type}")
-      newest = a.send("newest_#{type}")
+      type_link = a.public_send("#{type}s_url")
+      oldest = a.public_send("oldest_#{type}")
+      newest = a.public_send("newest_#{type}")
 
-      if number_of_type == 0
+      if number_of_type.zero?
         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)}."
+        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")}.",
+          "Average age: #{a.public_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)}.",
         ]

data/lib/how_is/report/html.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'cgi'
-require 'how_is/report/base_report'
+require "cgi"
+require "how_is/report/base_report"
 
 class HowIs
+  # HTML Report implementation
   class HtmlReport < BaseReport
     def format
       :html
@@ -34,6 +35,14 @@ class HowIs
       @r += "</ul>\n\n"
     end
 
+    ROW_HTML_GRAPH = <<-EOF
+  <tr>
+    <td style="width: %{label_width}">%{label_text}</td>
+    <td><span class="fill" style="width: %{percentage}%%">%{link_text}</span></td>
+  </tr>
+
+    EOF
+
     def horizontal_bar_graph(data)
       if data.length == 1 && data[0][0] == "(No label)"
         text "There are no open issues to graph."
@@ -48,65 +57,63 @@ class HowIs
 
       @r += "<table class=\"horizontal-bar-graph\">\n"
       data.each do |row|
-        percentage = get_percentage.call(row[1])
-
-        label_text =
-          if row[2]
-            link(row[0], row[2])
-          else
-            row[0]
-          end
-
-        @r += <<-EOF
-  <tr>
-    <td style="width: #{label_width}">#{label_text}</td>
-    <td><span class="fill" style="width: #{percentage}%">#{row[1]}</span></td>
-  </tr>
-
-        EOF
+        @r += Kernel.format(ROW_HTML_GRAPH, label_width: label_width,
+          label_text: label_text_for(row),
+          percentage: get_percentage.call(row[1]),
+          link_text: row[1])
       end
       @r += "</table>\n"
     end
 
     def export
-      @r = ''
+      @r = ""
       generate_report_text!
     end
 
+    HTML_DOC_TEMPLATE = <<~EOF
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>%{title}</title>
+        <style>
+        body { font: sans-serif; }
+        main {
+          max-width: 600px;
+          max-width: 72ch;
+          margin: auto;
+        }
+         .horizontal-bar-graph {
+          position: relative;
+          width: 100%;
+        }
+        .horizontal-bar-graph .fill {
+          display: inline-block;
+          background: #CCC;
+        }
+        </style>
+      </head>
+      <body>
+        <main>
+        %{report}
+        </main>
+      </body>
+      </html>
+    EOF
+
     def export_file(file)
-      report = export
-
-      File.open(file, 'w') do |f|
-        f.puts <<~EOF
-          <!DOCTYPE html>
-          <html>
-          <head>
-            <title>#{@title}</title>
-            <style>
-            body { font: sans-serif; }
-            main {
-              max-width: 600px;
-              max-width: 72ch;
-              margin: auto;
-            }
-
-            .horizontal-bar-graph {
-              position: relative;
-              width: 100%;
-            }
-            .horizontal-bar-graph .fill {
-              display: inline-block;
-              background: #CCC;
-            }
-            </style>
-          </head>
-          <body>
-            <main>
-            #{report}
-            </main>
-          </body>
-          </html>
-        EOF
+      content = Kernel.format(HTML_DOC_TEMPLATE, title: @title, report: export)
+      File.open(file, "w") do |f|
+        f.puts content
+      end
+    end
+
+    private
+
+    def label_text_for(row)
+      if row[2]
+        link(row[0], row[2])
+      else
+        row[0]
       end
     end
   end

data/lib/how_is/report/json.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'how_is/report/base_report'
+require "how_is/report/base_report"
 
 class HowIs
   ##
@@ -26,7 +26,7 @@ class HowIs
     ##
     # Generates a report and writes it to a file.
     def export_file(file)
-      File.open(file, 'w') do |f|
+      File.open(file, "w") do |f|
         f.write export
       end
     end

data/lib/how_is/report.rb

@@ -1,23 +1,26 @@
 # frozen_string_literal: true
 
-require 'date'
+require "date"
 require "pathname"
 
 class HowIs
+  # Raised when attempting to export to an unsupported format
   class UnsupportedExportFormat < StandardError
     def initialize(format)
       super("Unsupported export format: #{format}")
     end
   end
 
+  # Report control class with class methods to make reports for an analysis
+  # or to save reports in files, or otherwise interact with the files.
   class Report
-    require 'how_is/report/json'
-    require 'how_is/report/html'
+    require "how_is/report/json"
+    require "how_is/report/html"
 
     ##
     # Export a report to a file.
     def self.export_file(analysis, file)
-      format = file.split('.').last
+      format = file.split(".").last
       report = get_report_class(format).new(analysis)
 
       report.export_file(file)
@@ -37,7 +40,7 @@ class HowIs
     # @param file [String,Pathname] Name of file to write to
     # @param report [Report] Report to store
     def self.save_report(file, report)
-      File.open(file, 'w') do |f|
+      File.open(file, "w") do |f|
         f.write report
       end
     end
@@ -49,7 +52,7 @@ class HowIs
     #
     # @return [String] Report format inferred from file name
     def self.infer_format(file)
-      Pathname(file).extname.delete('.')
+      Pathname(file).extname.delete(".")
     end
 
     ##

data/lib/how_is/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HowIs
-  VERSION = "18.0.4"
+  VERSION = "18.0.5"
 end

data/lib/how_is.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
-require 'how_is/version'
-require 'contracts'
-require 'cacert'
+require "how_is/version"
+require "contracts"
+require "cacert"
 
 Cacert.set_in_env
 
 C = Contracts
 
+# HowIs control class used from the CLI tool.
+#
+# Generates an analysis and has methods to build reports from it.
 class HowIs
   include Contracts::Core
 
-  require 'how_is/fetcher'
-  require 'how_is/analyzer'
-  require 'how_is/report'
+  require "how_is/fetcher"
+  require "how_is/analyzer"
+  require "how_is/report"
 
   DEFAULT_FORMAT = :html
 
@@ -79,7 +82,7 @@ class HowIs
   #   generate.
   def self.supported_formats
     report_constants = HowIs.constants.grep(/.Report/) - [:BaseReport]
-    report_constants.map { |x| x.to_s.split('Report').first.downcase }
+    report_constants.map { |x| x.to_s.split("Report").first.downcase }
   end
 
   ##
@@ -90,7 +93,7 @@ class HowIs
   #   if it can't.
   def self.can_export_to?(file)
     # TODO: Check if the file is writable?
-    supported_formats.include?(file.split('.').last)
+    supported_formats.include?(file.split(".").last)
   end
 
   # Generate an analysis.
@@ -147,28 +150,28 @@ class HowIs
         report_class: nil)
     report_class ||= HowIs::Report
 
-    date = Date.strptime(Time.now.to_i.to_s, '%s')
-    friendly_date = date.strftime('%B %d, %y')
+    date = Date.strptime(Time.now.to_i.to_s, "%s")
+    friendly_date = date.strftime("%B %d, %y")
 
-    analysis = HowIs.generate_analysis(repository: config['repository'], github: github)
+    analysis = HowIs.generate_analysis(repository: config["repository"], github: github)
 
     report_data = {
-      repository: config['repository'],
+      repository: config["repository"],
       date: date,
       friendly_date: friendly_date,
     }
 
     generated_reports = {}
 
-    config['reports'].map do |format, report_config|
+    config["reports"].map do |format, report_config|
       # Sometimes report_data has unused keys, which generates a warning, but
       # we're okay with it.
-      filename = silence_warnings { report_config['filename'] % report_data }
-      file = File.join(report_config['directory'], filename)
+      filename = silence_warnings { report_config["filename"] % report_data }
+      file = File.join(report_config["directory"], filename)
 
       report = report_class.export(analysis, format)
 
-      result = build_report(report_config['frontmatter'], report_data, report)
+      result = build_report(report_config["frontmatter"], report_data, report)
 
       generated_reports[file] = result
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 18.0.4
+  version: 18.0.5
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -156,14 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - me@duckie.co
@@ -172,15 +186,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github_changelog_generator"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - ISSUES.md
 - LICENSE.txt
 - README.md
@@ -194,10 +209,13 @@ files:
 - fixtures/vcr_cassettes/how-is-example-repository.yml
 - fixtures/vcr_cassettes/how-is-from-config-frontmatter.yml
 - fixtures/vcr_cassettes/how-is-with-config-file.yml
+- fixtures/vcr_cassettes/how_is_contributions_all_contributors.yml
+- fixtures/vcr_cassettes/how_is_contributions_new_contributors.yml
 - how_is.gemspec
 - lib/how_is.rb
 - lib/how_is/analyzer.rb
 - lib/how_is/cli.rb
+- lib/how_is/contributions.rb
 - lib/how_is/fetcher.rb
 - lib/how_is/pulse.rb
 - lib/how_is/report.rb
@@ -226,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.

data/Gemfile.lock

@@ -1,110 +0,0 @@
-PATH
-  remote: .
-  specs:
-    how_is (18.0.4)
-      contracts (~> 0.16.0)
-      github_api (~> 0.17.0)
-      slop (~> 4.4.1)
-      tessellator-fetcher (~> 5.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.4.0)
-    ast (2.3.0)
-    contracts (0.16.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    curl_cacert (1.0.0)
-    default (1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    github_api (0.17.0)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      mime-types (>= 1.16, < 3.0)
-      oauth2 (~> 1.0)
-    hashdiff (0.3.4)
-    hashie (3.5.6)
-    heresy (4.0.0)
-      default (~> 1.0.0)
-      heresy-string (~> 1.0.0)
-      net-socket (~> 1.0.0)
-    heresy-string (1.0.0)
-    jwt (1.5.6)
-    mayhaps (0.3.0)
-    mime-types (2.99.3)
-    multi_json (1.12.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    net-socket (1.0.0)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    openssl-better_defaults (0.0.1)
-    parser (2.4.0.0)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    rack (2.0.3)
-    rainbow (2.2.2)
-      rake
-    rake (11.3.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.47.1)
-      parser (>= 2.3.3.1, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    safe_yaml (1.0.4)
-    slop (4.4.3)
-    tessellator-fetcher (5.0.1)
-      curl_cacert
-      heresy (~> 4.0.0)
-      mayhaps (~> 0.3.0)
-      openssl-better_defaults
-    thread_safe (0.3.6)
-    timecop (0.8.1)
-    unicode-display_width (1.3.0)
-    vcr (3.0.3)
-    webmock (3.0.1)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.11)
-  how_is!
-  rake (~> 11.2)
-  rspec (~> 3.5)
-  rubocop (~> 0.47.0)
-  timecop (~> 0.8.1)
-  vcr (~> 3.0)
-  webmock
-
-BUNDLED WITH
-   1.15.1