how_is 19.0.0 → 20.0.0

data/lib/how_is/analyzer.rb

@@ -1,222 +0,0 @@
-# frozen_string_literal: true
-
-require "contracts"
-require "ostruct"
-require "date"
-require "json"
-
-class HowIs
-  ##
-  # Represents a completed analysis of the repository being analyzed.
-  class Analysis < OpenStruct
-  end
-
-  # Creates Analysis objects with input data formatted in useful ways.
-  class Analyzer
-    include Contracts::Core
-
-    ##
-    # Raised when attempting to import to an unsupported format.
-    class UnsupportedImportFormat < StandardError
-      def initialize(format)
-        super("Unsupported import format: #{format}")
-      end
-    end
-
-    ##
-    # Generates and returns an analysis.
-    #
-    # @param data [Fetcher::Results] The results gathered by Fetcher.
-    # @param analysis_class (You don't need this.) A class to use instead of
-    #   HowIs::Analysis.
-    Contract Fetcher::Results, C::KeywordArgs[analysis_class: C::Optional[Class]] => Analysis
-    def call(data, analysis_class: Analysis)
-      issues = data.issues
-      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: 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: 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)),
-
-        pulse: data.pulse
-      )
-    end
-
-    ##
-    # Generates an analysis from a hash of report data.
-    #
-    # @param data [Hash] The hash to generate an Analysis from.
-    def self.from_hash(data)
-      hash = data.map { |k, v|
-        v = DateTime.parse(v) if k.end_with?("_date")
-
-        [k, v]
-      }.to_h
-
-      hash.keys.each do |key|
-        next unless hash[key].is_a?(Hash) && hash[key]["date"]
-
-        hash[key]["date"] = DateTime.parse(hash[key]["date"])
-      end
-
-      Analysis.new(hash)
-    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| Date.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?
-
-      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.
-    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
-  end
-end

data/lib/how_is/builds.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require "how_is/fetcher"
-
-class HowIs
-  # Fetches metadata about CI builds.
-  #
-  # Supports Travis
-  class Builds
-    # @param user [String] GitHub user of repository.
-    # @param repo [String] GitHub repository name.
-    def initialize(user:, repo:)
-      @user = user
-      @repo = repo
-      # TODO: Figure out Default Branch of the repo
-    end
-
-    def summary
-      JSON.parse(travis_builds)
-    end
-
-    # Returns API result of /repos/:user/:repo/builds for Push type Travis
-    # events.
-    #
-    # @return [String] JSON result
-    def travis_builds
-      Tessellator::Fetcher::Request::HTTP.call(
-        Tessellator::Fetcher::Config.new,
-        "get",
-        "http://api.travis-ci.org/repos/#{@user}/#{@repo}/builds?event_type=push",
-        {},
-        headers: {"Accept" => "application/vnd.travis-ci.2+json"}
-      ).body
-    end
-  end
-end

data/lib/how_is/contributions.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-
-require "how_is/fetcher"
-
-class HowIs
-  # Fetch information about who has contributed to a repository during a given
-  # period.
-  #
-  # Usage:
-  #
-  #     github = Github.new()
-  #     c = HowIs::Contributions.new(github: github, start_date: '2017-07-01', user: 'how-is', repo: 'how_is')
-  #     c.commits          #=> All commits during July 2017.
-  #     c.contributors #=> All contributors during July 2017.
-  #     c.new_contributors #=> New contributors during July 2017.
-  class Contributions
-    # Returns an object that fetches contributor information about a particular
-    # repository for a month-long period starting on +start_date+.
-    #
-    # @param github [Github] Github client instance.
-    # @param start_date [String] Date in the format YYYY-MM-DD. The first date
-    #                            to include commits from.
-    # @param user [String] GitHub user of repository.
-    # @param repo [String] GitHub repository name.
-    def initialize(github: Fetcher.default_github_instance, start_date:, user:, repo:)
-      @github = github
-
-      # IMPL. DETAIL: The external API uses "start_date" so it's clearer,
-      #               but internally we use "since_date" to match GitHub's API.
-
-      @since_date = Date.strptime(start_date, "%Y-%m-%d")
-
-      d = @since_date.day
-      m = @since_date.month
-      y = @since_date.year
-      @until_date = Date.new(y, m + 1, d)
-
-      @user = user
-      @repo = repo
-
-      @commit = {}
-    end
-
-    # Returns a list of contributors that have zero commits before the @since_date.
-    #
-    # @return [Hash{String => Hash}] Contributors keyed by email
-    def new_contributors
-      # author: GitHub login, name or email by which to filter by commit author.
-      @new_contributors ||= contributors.select do |email, _committer|
-        # Returns true if +email+ never wrote a commit for +@repo+ before +@since_date+.
-        @github.repos.commits.list(user: @user,
-                                   repo: @repo,
-                                   until: @since_date,
-                                   author: email).count.zero?
-      end
-    end
-
-    # @return [Hash{String => Hash}] Author information keyed by author's email.
-    def contributors
-      commits.map { |api_response|
-        [api_response.commit.author.email, api_response.commit.author.to_h]
-      }.to_h
-    end
-
-    def commits
-      @commits ||= begin
-        @github.repos.commits.list(user: @user,
-                                   repo: @repo,
-                                   since: @since_date).map { |c|
-          # The commits list endpoint doesn't include all commit data, e.g. stats.
-          # So, we make N requests here, where N == number of commits returned,
-          # and then we die a bit inside.
-          commit(c.sha)
-        }
-      end
-    end
-
-    def commit(sha)
-      @commit[sha] ||= @github.repos.commits.get(user: @user, repo: @repo, sha: sha)
-    end
-
-    def changes
-      if @stats.nil? || @changed_files.nil?
-        @stats = {
-          "total" => 0,
-          "additions" => 0,
-          "deletions" => 0,
-        }
-
-        @changed_files = []
-
-        commits.map do |commit|
-          commit.stats.each do |k, v|
-            @stats[k] += v
-          end
-
-          @changed_files += commit.files.map { |file| file["filename"] }
-        end
-
-        @changed_files.sort.uniq!
-      end
-
-      {"stats" => @stats, "files" => @changed_files}
-    end
-
-    def changed_files
-      changes["files"]
-    end
-
-    def additions_count
-      changes["stats"]["additions"]
-    end
-
-    def deletions_count
-      changes["stats"]["deletions"]
-    end
-
-    def compare_url
-      since_timestamp = @since_date.to_time.to_i
-      until_timestamp = @until_date.to_time.to_i
-      "https://github.com/#{@user}/#{@repo}/compare/#{default_branch}@%7B#{since_timestamp}%7D...#{default_branch}@%7B#{until_timestamp}%7D" # rubocop:disable Metrics/LineLength
-    end
-
-    def default_branch
-      @default_branch ||= @github.repos.get(user: @user,
-        repo: @repo).default_branch
-    end
-
-    def summary(start_text: nil)
-      # TODO: Pulse has information about _all_ branches. Do we want that?
-      #       If we do, we'd need to pass a branch name as the 'sha' parameter
-      #       to /repos/:owner/:repo/commits.
-      #       https://developer.github.com/v3/repos/commits/
-
-      start_text ||= "From #{pretty_date(@since_date)} through #{pretty_date(@until_date)}"
-
-      "#{start_text}, #{@user}/#{@repo} gained "\
-        "<a href=\"#{compare_url}\">#{pluralize('new commit', commits.length)}</a>, " \
-        "contributed by #{pluralize('author', contributors.length)}. There " \
-        "#{(additions_count == 1) ? 'was' : 'were'} " \
-        "#{pluralize('addition', additions_count)} and " \
-        "#{pluralize('deletion', deletions_count)} across " \
-        "#{pluralize('file', changed_files.length)}."
-    end
-
-    private
-
-    def pretty_date(date)
-      date.strftime("%b %d, %Y")
-    end
-
-    def pluralize(string, number)
-      "#{number} #{string}#{(number == 1) ? '' : 's'}"
-    end
-  end
-end

data/lib/how_is/fetcher.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require "contracts"
-require "github_api"
-require "how_is/pulse"
-
-C ||= Contracts
-
-class HowIs
-  ##
-  # Fetches data from GitHub.
-  class Fetcher
-    include Contracts::Core
-
-    # TODO: Fix this bullshit.
-    # :nodoc:
-    def self.default_github_instance
-      Github.new(auto_pagination: true) do |config|
-        config.basic_auth = ENV["HOWIS_BASIC_AUTH"] if ENV["HOWIS_BASIC_AUTH"]
-      end
-    end
-
-    ##
-    # Standardized representation for fetcher results.
-    #
-    # Implemented as a class instead of passing around a Hash so that it can
-    # be more easily referenced by Contracts.
-    Results = Struct.new(:repository, :issues, :pulls, :pulse) do
-      include Contracts::Core
-
-      Contract String, C::ArrayOf[Hash], C::ArrayOf[Hash], String => nil
-      def initialize(repository, issues, pulls, pulse)
-        super(repository, issues, pulls, pulse)
-      end
-
-      # Struct defines #to_h, but not #to_hash, so we alias them.
-      alias_method :to_hash, :to_h
-    end
-
-    ##
-    # Fetches repository information from GitHub and returns a Results object.
-    Contract String,
-      C::Or[C::RespondTo[:issues, :pulls], nil],
-      C::Or[C::RespondTo[:html_summary], nil] => Results
-    def call(repository,
-             github = nil,
-             pulse = nil)
-      github ||= self.class.default_github_instance
-      pulse ||= HowIs::Pulse.new(repository)
-      user, repo = repository.split("/", 2)
-
-      unless user && repo
-        raise HowIs::CLI::OptionsError, "To generate a report from GitHub, " \
-          "provide the repository " \
-          "username/project. Quitting!"
-      end
-
-      issues  = github.issues.list user: user, repo: repo
-      pulls   = github.pulls.list  user: user, repo: repo
-
-      summary = pulse.html_summary
-
-      Results.new(
-        repository,
-        obj_to_array_of_hashes(issues),
-        obj_to_array_of_hashes(pulls),
-        summary
-      )
-    end
-
-    private
-
-    def obj_to_array_of_hashes(object)
-      object.to_a.map(&:to_h)
-    end
-  end
-end

data/lib/how_is/pulse.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "tessellator/fetcher"
-
-class HowIs
-  # This entire class is a monstrous hack, because GitHub doesn't provide
-  # a good API for Pulse.
-  #
-  # TODO: Use GitHub's Statistics API to replace this garbage.
-  #   See https://github.com/how-is/how_is/issues/122
-  class Pulse
-    def initialize(repository)
-      @repository = repository
-      @pulse_page_response = fetch_pulse!(repository)
-    end
-
-    # Gets the HTML Pulse summary.
-    def html_summary
-      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
-    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")
-    end
-  end
-end

data/lib/how_is/report/base_report.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-class HowIs
-  BaseReport = Struct.new(:analysis)
-
-  ##
-  # Subclasses of BaseReport represent complete reports.
-  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.
-
-      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 analysis.pulse
-
-      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 { |(_, 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
-
-    # === Methods implemented by subclasses of BaseReport ===
-
-    ##
-    # Returns the format of report this class generates.
-    #
-    # @return [Symbol] A lowercase symbol denoting the report format.
-    def format
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends a title to the report.
-    def title(_content)
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends a header to the report.
-    def header(_content)
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends a line of text to the report.
-    def text(_content)
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends a link to the report.
-    def link(_content, _url)
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends an unordered list to the report.
-    def unordered_list(_arr)
-      raise NotImplementedError
-    end
-
-    ##
-    # Appends a horizontal bar graph to the report.
-    def horizontal_bar_graph(_data)
-      raise NotImplementedError
-    end
-
-    ##
-    # Exports the report as a String.
-    def export
-      raise NotImplementedError
-    end
-
-    ##
-    # Exports a report to a file.
-    #
-    # NOTE: May be removed in the future.
-    def export_file(_file)
-      raise NotImplementedError
-    end
-
-    def to_h
-      analysis.to_h
-    end
-    alias_method :to_hash, :to_h
-
-    def to_json
-      JSON.pretty_generate(to_h)
-    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)
-      date_format = "%b %e, %Y"
-      a = analysis
-
-      number_of_type = a.public_send("number_of_#{type}s")
-
-      type_link = a.public_send("#{type}s_url")
-      oldest = a.public_send("oldest_#{type}")
-      newest = a.public_send("newest_#{type}")
-
-      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)}."
-
-        unordered_list [
-          "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)}.",
-        ]
-      end
-    end
-  end
-end