how_is 19.0.0 → 20.0.0

data/lib/how_is/sources/github_helpers.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require "how_is/sources/github"
+require "date"
+
+module HowIs
+  module Sources
+    module GithubHelpers
+      def obj_to_array_of_hashes(object)
+        object.to_a.map(&:to_h)
+      end
+
+      # Given an Array of issues or pulls, return a Hash specifying how many
+      # issues or pulls use each label.
+      def num_with_label(issues_or_pulls)
+        # Returned hash maps labels to frequency.
+        # E.g., given 10 issues/pulls with label "label1" and 5 with label "label2",
+        # {
+        #   "label1" => 10,
+        #   "label2" => 5
+        # }
+
+        hash = Hash.new(0)
+        issues_or_pulls.each do |iop|
+          next unless iop["labels"]
+
+          iop["labels"].each do |label|
+            hash[label["name"]] += 1
+          end
+        end
+        hash
+      end
+
+      # Returns the number of issues with no label.
+      def num_with_no_label(issues)
+        issues.select { |x| x["labels"].empty? }.length
+      end
+
+      # Given an Array of dates, average the timestamps and return the date that
+      # represents.
+      def average_date_for(issues_or_pulls)
+        timestamps = issues_or_pulls.map { |iop| DateTime.parse(iop["created_at"]).strftime("%s").to_i }
+        average_timestamp = timestamps.reduce(:+) / issues_or_pulls.length
+
+        DateTime.strptime(average_timestamp.to_s, "%s")
+      end
+
+      # Given an Array of issues or pulls, return the average age of them.
+      # Returns nil if no issues or pulls are provided.
+      def average_age_for(issues_or_pulls)
+        return nil if issues_or_pulls.empty?
+
+        ages = issues_or_pulls.map { |iop| time_ago_in_seconds(iop["created_at"]) }
+        average_age_in_seconds = ages.reduce(:+) / ages.length
+
+        values = period_pairs_for(average_age_in_seconds).reject { |(v, _)| v.zero? }.map { |(v, k)|
+          k += "s" if v != 1
+          [v, k]
+        }
+
+        most_significant = values[0, 2].map { |x| x.join(" ") }
+
+        value =
+          if most_significant.length < 2
+            most_significant.first
+          else
+            most_significant.join(" and ")
+          end
+
+        "approximately #{value}"
+      end
+
+      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?
+
+        iop = sort_iops_by_created_at(issues_or_pulls).first
+
+        {
+          created_at: iop["created_at"],
+          link: iop["html_url"],
+        }
+      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?
+
+        iop = sort_iops_by_created_at(issues_or_pulls).last
+
+        {
+          created_at: iop["created_at"],
+          link: iop["html_url"],
+        }
+      end
+
+      # Given an issue or PR, returns the date it was created.
+      def date_for(issue_or_pull)
+        DateTime.parse(issue_or_pull["created_at"])
+      end
+
+      private
+
+      # Takes an Array of labels, and returns amodified list that includes links
+      # to each label.
+      def with_label_links(labels, repository)
+        labels.map { |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}]
+        }.to_h
+      end
+
+      # Returns how many seconds ago a date (as a String) was.
+      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)
+        return nil if iop.nil?
+
+        ret = {}
+
+        ret["html_url"] = iop["html_url"]
+        ret["number"] = iop["number"]
+        ret["date"] = date_for(iop)
+
+        ret
+      end
+
+      SECONDS_IN_A_YEAR = 31_556_926
+      SECONDS_IN_A_MONTH = 2_629_743
+      SECONDS_IN_A_WEEK = 604_800
+      SECONDS_IN_A_DAY = 86_400
+
+      # Calculates a list of pairs of value and period label.
+      #
+      # @param age_in_seconds [Float]
+      #
+      # @return [Array<Array>] The input age_in_seconds expressed as different
+      #                        units, as pairs of value and unit name.
+      def period_pairs_for(age_in_seconds)
+        years_remainder = age_in_seconds % SECONDS_IN_A_YEAR
+
+        months_remainder = years_remainder % SECONDS_IN_A_MONTH
+
+        weeks_remainder = months_remainder % SECONDS_IN_A_WEEK
+
+        [
+          [age_in_seconds / SECONDS_IN_A_YEAR, "year"],
+          [years_remainder / SECONDS_IN_A_MONTH, "month"],
+          [months_remainder / SECONDS_IN_A_WEEK, "week"],
+          [weeks_remainder / SECONDS_IN_A_DAY, "day"],
+        ]
+      end
+
+      def pluralize(string, number, zero_is_no: false)
+        number_str = number
+        number_str = "no" if number.zero? && zero_is_no
+
+        "#{number_str} #{string}#{(number == 1) ? '' : 's'}"
+      end
+
+      def are_or_is(number)
+        if number == 1
+          "is"
+        else
+          "are"
+        end
+      end
+
+      def pretty_date(date_or_str)
+        if date_or_str.is_a?(DateTime)
+          date = datetime_or_str
+        elsif date_or_str.is_a?(String)
+          date = DateTime.parse(date_or_str)
+        else
+          raise ArgumentError, "expected DateTime or String, got #{date_or_str.class}"
+        end
+
+        date.strftime("%b %_d, %Y")
+      end
+    end
+  end
+end

data/lib/how_is/sources/travis.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "okay/http"
+require "how_is/sources/github"
+
+module HowIs::Sources
+  # Fetches metadata about CI builds from travis-ci.org.
+  class Travis
+    # @param repository [String] GitHub repository name, of the format user/repo.
+    # @param end_date [String] End date for the report being generated.
+    def initialize(repository, end_date)
+      @repository = repository
+      # TODO: Do something with end_date.
+      # TODO: Figure out Default Branch of the repo
+    end
+
+    def builds
+      JSON.parse(fetch_builds)
+    end
+
+    private
+
+    # Returns API result of /repos/:user/:repo/builds for Push type Travis
+    # events.
+    #
+    # @return [String] JSON result
+    def fetch_builds
+      Okay::HTTP.get(
+        "http://api.travis-ci.org/repos/#{@repository}/builds?event_type=push",
+        headers: {"Accept" => "application/vnd.travis-ci.2+json"}
+      ).body
+    end
+  end
+end

data/lib/how_is/sources.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "how_is/version"
+
+module HowIs
+  module Sources
+    # Simply for creating a namespace.
+  end
+end

data/lib/how_is/templates/issues_or_pulls_partial.html_template

@@ -0,0 +1,7 @@
+%{summary}
+
+<ul>
+  <li>Average age: %{average_age}.</li>
+  <li><a href="%{oldest_link}">Oldest %{pretty_type}</a> was opened on %{oldest_date}.</li>
+  <li><a href="%{newest_link}">Newest %{pretty_type}</a> was opened on %{newest_date}.</li>
+</ul>

data/lib/how_is/templates/report.html_template

@@ -0,0 +1,27 @@
+%{frontmatter}<!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%%; /* lol Kernel.format() disapproves. */
+      }
+      .horizontal-bar-graph .fill {
+        display: inline-block;
+        background: #CCC;
+      }
+    </style>
+  </head>
+  <body>
+    <main>
+%{report}
+    </main>
+  </body>
+</html>

data/lib/how_is/templates/report_partial.html_template

@@ -0,0 +1,12 @@
+%{frontmatter}
+<h1>%{title}</h1>
+<p>%{contributions_summary}</p>
+
+<h2>Pull Requests</h2>
+%{pulls_summary}
+
+<h2>Issues</h2>
+%{issues_summary}
+
+<h2>Issues Per Label</h2>
+%{issues_per_label}

data/lib/how_is/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class HowIs
-  VERSION = "19.0.0"
+module HowIs
+  VERSION = "20.0.0"
 end

data/lib/how_is.rb

@@ -1,54 +1,21 @@
 # frozen_string_literal: true
 
 require "how_is/version"
-require "contracts"
-require "cacert"
+require "how_is/report"
+require "github_api"
 
-Cacert.set_in_env
+module HowIs
+  DEFAULT_REPORT_FILE = "report.html"
 
-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"
-
-  DEFAULT_FORMAT = :html
-
-  ##
-  # Generate a HowIs instance, so you can generate reports.
-  #
-  # @param repository [String] The name of a GitHub repository (of the
-  #   format <user or organization>/<repository>).
-  # @param analysis [HowIs::Analysis] Optional; if passed, this Analysis
-  #   object is used instead of generating one.
-  def initialize(repository, analysis = nil, **kw_args)
-    # If no Analysis is passed, generate one.
-    analysis ||= HowIs.generate_analysis(repository: repository, **kw_args)
-
-    # Used by to_html, to_json, etc.
-    @analysis = analysis
+  def self.new(repository, date)
+    Report.new(repository, date)
   end
 
-  ##
-  # Generate an HTML report.
-  #
-  # @return [String] An HTML report.
-  def to_html
-    Report.export(@analysis, :html)
-  end
-
-  ##
-  # Generate a JSON report.
-  #
-  # @return [String] A JSON report.
-  def to_json
-    Report.export(@analysis, :json)
+  def self.github
+    @@github ||=
+      Github.new(auto_pagination: true) do |config|
+        config.basic_auth = ENV["HOWIS_BASIC_AUTH"] if ENV["HOWIS_BASIC_AUTH"]
+      end
   end
 
   ##
@@ -70,140 +37,62 @@ class HowIs
   # @return [HowIs] A HowIs object that can be used for generating other
   #   reports, treating the provided report data as a cache.
   def self.from_hash(data)
-    analysis = HowIs::Analyzer.from_hash(data)
+    analysis = HowIs::Analysis.from_hash(data)
 
     new(analysis.repository, analysis)
   end
 
-  ##
-  # Returns a list of possible export formats.
-  #
-  # @return [Array<String>] An array of the types of reports you can
-  #   generate.
-  def self.supported_formats
-    report_constants = HowIs.constants.grep(/.Report/) - [:BaseReport]
-    report_constants.map { |x| x.to_s.split("Report").first.downcase }
-  end
-
-  ##
-  # Returns whether or not the specified +file+ can be exported to.
-  #
-  # @param file [String] A filename.
-  # @return [Boolean] +true+ if HowIs can export to the file, +false+
-  #   if it can't.
-  def self.can_export_to?(file)
-    # TODO: Check if the file is writable?
-    supported_formats.include?(file.split(".").last)
-  end
-
-  # Generate an analysis.
-  # TODO: This may make more sense as Analysis.new().
-  # TODO: Nothing overrides +fetcher+ and +analyzer+. Remove ability to do so.
-  # FIXME: THIS CODE AND EVERYTHING ASSOCIATED WITH IT IS A FUCKING ATROCITY.
-  Contract C::KeywordArgs[repository: String,
-                          fetcher: C::Optional[Class],
-                          analyzer: C::Optional[Class],
-                          github: C::Optional[C::Any]] => C::Any
-  def self.generate_analysis(repository:,
-        fetcher: Fetcher.new,
-        analyzer: Analyzer.new,
-        github: nil)
-    raw_data = fetcher.call(repository, github)
-    analysis = analyzer.call(raw_data)
-
-    analysis
-  end
-
-  # Generates YAML frontmatter, as is used in Jekyll and other blog engines.
-  #
-  # E.g.,
-  #     generate_frontmatter({'foo' => "bar %{baz}"}, {'baz' => "asdf"})
-  # =>  "---\nfoo: bar asdf\n"
-  Contract C::HashOf[C::Or[String, Symbol] => String],
-           C::HashOf[C::Or[String, Symbol] => C::Any] => String
-  def self.generate_frontmatter(frontmatter, report_data)
-    frontmatter = convert_keys(frontmatter, :to_s)
-    report_data = convert_keys(report_data, :to_sym)
-
-    frontmatter = frontmatter.map { |k, v|
-      # Sometimes report_data has unused keys, which generates a warning, but
-      # we're okay with it.
-      v = silence_warnings { v % report_data }
-
-      [k, v]
-    }.to_h
-
-    YAML.dump(frontmatter)
-  end
-
   ##
   # Generates a series of report files based on a config Hash.
   #
   # @param config [Hash] A Hash specifying the formats, locations, etc
   #   of the reports to generate.
-  # @param github (You don't need this.) An object to replace the GitHub
-  #   class when fetching data.
-  # @param report_class (You don't need this.) An object to replace the
-  #   HowIs::Report class when generating reports.
-  def self.from_config(config,
-        github: nil,
-        report_class: nil)
-    report_class ||= HowIs::Report
-
-    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)
-
-    report_data = {
-      repository: config["repository"],
-      date: date,
-      friendly_date: friendly_date,
-    }
-
-    generated_reports = {}
+  # @param date [String] A string containing the date (YYYY-MM-DD) that the
+  #   report ends on. E.g., for Jan 1-Feb 1 2017, you'd pass 2017-02-01.
+  def self.from_config(config, date)
+    report = Report.new(config["repository"], date)
+    report_data = prepare_report_metadata(config["repository"], date)
 
-    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)
+    generated_reports =
+      config["reports"].map { |format, report_config|
+        # Sometimes report_data has unused keys, which generates a warning, but
+        # we're okay with it, so we wrap it with silence_warnings {}.
+        filename = silence_warnings { report_config["filename"] % report_data }
+        file = File.join(report_config["directory"], filename)
 
-      report = report_class.export(analysis, format)
+        report_export = report.send("to_#{format}", report_config["frontmatter"])
 
-      result = build_report(report_config["frontmatter"], report_data, report)
+        [file, report_export]
+      }
 
-      generated_reports[file] = result
-
-      result
-    end
-
-    generated_reports
+    generated_reports.to_h
   end
 
-  # Combine the frontmatter, report data, and raw report into a report with
-  # frontmatter.
-  def self.build_report(frontmatter, report_data, report)
-    str = StringIO.new
-
-    if frontmatter
-      str.puts generate_frontmatter(frontmatter, report_data)
-      str.puts "---"
-      str.puts
-    end
+  ##
+  # Returns a list of possible export formats.
+  #
+  # @return [Array<String>] An array of the types of reports you can generate.
+  def self.supported_formats
+    ["html", "json"]
+  end
 
-    str.puts report
+  def self.template(filename)
+    dir  = File.expand_path("./how_is/templates/", __dir__)
+    path = File.join(dir, filename)
 
-    str.string
+    open(path).read
   end
 
-  # @example
-  #   convert_keys({'foo' => 'bar'}, :to_sym)
-  #   # => {:foo => 'bar'}
-  def self.convert_keys(data, method_name)
-    data.map { |k, v| [k.send(method_name), v] }.to_h
+  ##
+  # Returns whether or not the specified +file+ can be exported to.
+  #
+  # @param file [String] A filename.
+  # @return [Boolean] +true+ if HowIs can export to the file, +false+
+  #   if it can't.
+  def self.can_export_to?(file)
+    # TODO: Check if the file is writable?
+    supported_formats.include?(file.split(".").last)
   end
-  private_class_method :convert_keys
 
   def self.silence_warnings(&block)
     with_warnings(nil, &block)
@@ -218,4 +107,16 @@ class HowIs
     $VERBOSE = old_verbose
   end
   private_class_method :with_warnings
+
+  def self.prepare_report_metadata(repository, date)
+    end_date = DateTime.strptime(date, "%Y-%m-%d")
+    friendly_end_date = end_date.strftime("%B %d, %y")
+
+    {
+      repository: repository,
+      date: end_date,
+      friendly_date: friendly_end_date,
+    }
+  end
+  private_class_method :prepare_report_metadata
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: how_is
 version: !ruby/object:Gem::Version
-  version: 19.0.0
+  version: 20.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-16 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: contracts
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: tessellator-fetcher
+  name: okay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -197,21 +211,33 @@ files:
 - fixtures/vcr_cassettes/how-is-from-config-frontmatter.yml
 - fixtures/vcr_cassettes/how-is-how-is-travis-api-repos-builds.yml
 - fixtures/vcr_cassettes/how-is-with-config-file.yml
+- fixtures/vcr_cassettes/how_is_contributions_additions_count.yml
 - fixtures/vcr_cassettes/how_is_contributions_all_contributors.yml
+- fixtures/vcr_cassettes/how_is_contributions_changed_files.yml
+- fixtures/vcr_cassettes/how_is_contributions_changes.yml
+- fixtures/vcr_cassettes/how_is_contributions_commits.yml
+- fixtures/vcr_cassettes/how_is_contributions_compare_url.yml
 - fixtures/vcr_cassettes/how_is_contributions_default_branch.yml
+- fixtures/vcr_cassettes/how_is_contributions_deletions_count.yml
 - fixtures/vcr_cassettes/how_is_contributions_new_contributors.yml
+- fixtures/vcr_cassettes/how_is_contributions_summary.yml
+- fixtures/vcr_cassettes/how_is_contributions_summary_2.yml
+- fixtures/vcr_cassettes/how_is_fetcher_call.yml
 - how_is.gemspec
 - lib/how_is.rb
-- lib/how_is/analyzer.rb
-- lib/how_is/builds.rb
 - lib/how_is/cli.rb
-- lib/how_is/contributions.rb
-- lib/how_is/fetcher.rb
-- lib/how_is/pulse.rb
+- lib/how_is/frontmatter.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/sources.rb
+- lib/how_is/sources/github.rb
+- lib/how_is/sources/github/contributions.rb
+- lib/how_is/sources/github/issues.rb
+- lib/how_is/sources/github/pulls.rb
+- lib/how_is/sources/github_helpers.rb
+- lib/how_is/sources/travis.rb
+- lib/how_is/templates/issues_or_pulls_partial.html_template
+- lib/how_is/templates/report.html_template
+- lib/how_is/templates/report_partial.html_template
 - lib/how_is/version.rb
 - roadmap.markdown
 homepage: https://github.com/how-is/how_is
@@ -234,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Quantify the health of a GitHub repository.