inq 26.0.0

data/lib/inq/sources/github/issue_fetcher.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "inq/version"
+require "inq/date_time_helpers"
+require "inq/sources/github"
+require "inq/text"
+
+module Inq
+  module Sources
+    class Github
+      ##
+      # Fetches raw data for GitHub issues.
+      class IssueFetcher
+        include Inq::DateTimeHelpers
+
+        END_LOOP = :terminate_graphql_loop
+
+        GRAPHQL_QUERY = <<~QUERY
+          repository(owner: %{user}, name: %{repo}) {
+            %{type}(first: %{chunk_size}%{after_str}, orderBy:{field: CREATED_AT, direction: ASC}) {
+              edges {
+                cursor
+                node {
+                  number
+                  createdAt
+                  closedAt
+                  updatedAt
+                  state
+                  title
+                  url
+                  labels(first: 100) {
+                    nodes {
+                      name
+                    }
+                  }
+                }
+              }
+            }
+          }
+        QUERY
+
+        CHUNK_SIZE = 100
+
+        attr_reader :type
+
+        # @param issues_source [Issues] Inq::Issues or Inq::Pulls instance for which to fetch issues
+        def initialize(issues_source)
+          @issues_source = issues_source
+          @cache = issues_source.cache
+          @github = Sources::Github.new(issues_source.config)
+          @repository = issues_source.config["repository"]
+          @user, @repo = @repository.split("/", 2)
+          @start_date = issues_source.start_date
+          @end_date = issues_source.end_date
+          @type = issues_source.type
+        end
+
+        def data
+          return @data if instance_variable_defined?(:@data)
+
+          @data = []
+          return @data if last_cursor.nil?
+
+          Inq::Text.print "Fetching #{@repository} #{@issues_source.pretty_type} data."
+
+          @data = @cache.cached("fetch-#{type}") do
+            data = []
+            after, data = fetch_issues(after, data) until after == END_LOOP
+            data.select(&method(:issue_is_relevant?))
+          end
+
+          Inq::Text.puts
+
+          @data
+        end
+
+        def issue_is_relevant?(issue)
+          if !issue["closedAt"].nil? && date_le(issue["closedAt"], @start_date)
+            false
+          else
+            date_ge(issue["createdAt"], @start_date) && date_le(issue["createdAt"], @end_date)
+          end
+        end
+
+        def last_cursor
+          return @last_cursor if instance_variable_defined?(:@last_cursor)
+
+          raw_data = @github.graphql <<~QUERY
+            repository(owner: #{@user.inspect}, name: #{@repo.inspect}) {
+              #{type}(last: 1, orderBy:{field: CREATED_AT, direction: ASC}) {
+                edges {
+                  cursor
+                }
+              }
+            }
+          QUERY
+
+          edges = raw_data.dig("data", "repository", type, "edges")
+          @last_cursor =
+            if edges.nil? || edges.empty?
+              nil
+            else
+              edges.last["cursor"]
+            end
+        end
+
+        def fetch_issues(after, data)
+          Inq::Text.print "."
+
+          after_str = ", after: #{after.inspect}" unless after.nil?
+
+          query = build_query(@user, @repo, type, after_str)
+          raw_data = @github.graphql(query)
+          edges = raw_data.dig("data", "repository", type, "edges")
+
+          data += edge_nodes(edges)
+
+          next_cursor = edges.last["cursor"]
+          next_cursor = END_LOOP if next_cursor == last_cursor
+
+          [next_cursor, data]
+        end
+
+        def build_query(user, repo, type, after_str)
+          format(GRAPHQL_QUERY, {
+            user: user.inspect,
+            repo: repo.inspect,
+            type: type,
+            chunk_size: CHUNK_SIZE,
+            after_str: after_str,
+          })
+        end
+
+        def edge_nodes(edges)
+          return [] if edges.nil?
+          new_data = edges.map { |issue|
+            node = issue["node"]
+            node["labels"] = node["labels"]["nodes"]
+
+            node
+          }
+
+          new_data
+        end
+      end
+    end
+  end
+end

data/lib/inq/sources/github/issues.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "inq/date_time_helpers"
+require "inq/sources/github"
+require "inq/sources/github_helpers"
+require "inq/sources/github/issue_fetcher"
+require "inq/template"
+require "date"
+
+module Inq
+  module Sources
+    class Github
+      ##
+      # Fetches various information about GitHub Issues.
+      class Issues
+        include Inq::DateTimeHelpers
+        include Inq::Sources::GithubHelpers
+
+        attr_reader :config, :start_date, :end_date, :cache
+
+        # @param repository [String] GitHub repository name, of the format user/repo.
+        # @param start_date [String] Start date for the report being generated.
+        # @param end_date   [String] End date for the report being generated.
+        # @param cache      [Cacheable] Instance of Inq::Cacheable to cache API calls
+        def initialize(config, start_date, end_date, cache)
+          @config = config
+          @cache = cache
+          @repository = config["repository"]
+          raise "#{self.class}.new() got nil repository." if @repository.nil?
+          @start_date = start_date
+          @end_date = end_date
+        end
+
+        def url(values = {})
+          defaults = {
+            "is" => singular_type,
+            "created" => "#{@start_date}..#{@end_date}",
+          }
+          values = defaults.merge(values)
+          raw_query = values.map { |k, v|
+            [k, v].join(":")
+          }.join(" ")
+
+          query = CGI.escape(raw_query)
+
+          "https://github.com/#{@repository}/#{url_suffix}?q=#{query}"
+        end
+
+        def average_age
+          average_age_for(data)
+        end
+
+        def oldest
+          result = oldest_for(data)
+          return {} if result.nil?
+
+          result["date"] = pretty_date(result["createdAt"])
+
+          result
+        end
+
+        def newest
+          result = newest_for(data)
+          return {} if result.nil?
+
+          result["date"] = pretty_date(result["createdAt"])
+
+          result
+        end
+
+        def summary
+          number_open = to_a.length
+          pretty_number = pluralize(pretty_type, number_open, zero_is_no: false)
+          was_were = (number_open == 1) ? "was" : "were"
+
+          "<p>A total of <a href=\"#{url}\">#{pretty_number}</a> #{was_were} opened during this period.</p>"
+        end
+
+        def to_html
+          return summary if to_a.empty?
+
+          Inq::Template.apply("issues_or_pulls_partial.html", {
+            summary: summary,
+            average_age: average_age,
+            pretty_type: pretty_type,
+
+            oldest_link: oldest["url"],
+            oldest_date: oldest["date"],
+
+            newest_link: newest["url"],
+            newest_date: newest["date"],
+          })
+        end
+
+        def to_a
+          obj_to_array_of_hashes(data)
+        end
+
+        def type
+          singular_type + "s"
+        end
+
+        def pretty_type
+          "issue"
+        end
+
+        private
+
+        def url_suffix
+          "issues"
+        end
+
+        def singular_type
+          "issue"
+        end
+
+        def data
+          return @data if instance_variable_defined?(:@data)
+
+          fetcher = IssueFetcher.new(self)
+          @data = fetcher.data
+        end
+      end
+    end
+  end
+end

data/lib/inq/sources/github/pulls.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "inq/sources/github/issues"
+
+module Inq
+  module Sources
+    class Github
+      ##
+      # Fetches various information about GitHub Pull Requests
+      class Pulls < Issues
+        def url_suffix
+          "pulls"
+        end
+
+        def singular_type
+          "pull"
+        end
+
+        def type
+          "pullRequests"
+        end
+
+        def pretty_type
+          "pull request"
+        end
+      end
+    end
+  end
+end

data/lib/inq/sources/github_helpers.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "inq/sources/github"
+require "date"
+
+module Inq
+  module Sources
+    ##
+    # Helper functions used by GitHub-related 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 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["createdAt"]) }
+        average_age_in_seconds = ages.reduce(:+) / ages.length
+
+        values =
+          period_pairs_for(average_age_in_seconds) \
+            .reject { |(v, _)| v.zero? } \
+            .map { |(v, k)| pluralize(k, v) }
+
+        value = values[0, 2].join(" and ")
+
+        "approximately #{value}"
+      end
+
+      def sort_iops_by_created_at(issues_or_pulls)
+        issues_or_pulls.sort_by { |x| DateTime.parse(x["createdAt"]) }
+      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
+
+      private
+
+      # 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
+
+      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 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/inq/template.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "inq/version"
+require "okay/template"
+
+module Inq
+  # Provides basic templating functionality.
+  Template = Okay::Template.new(File.expand_path("./templates/", __dir__))
+end

data/lib/inq/templates/contributions_partial.html

@@ -0,0 +1 @@
+%{start_text}, %{user}/%{repo} gained <a href="%{compare_url}">%{new_commits}</a>, contributed by %{authors}. There %{additions_count_str} %{additions} and %{deletions} across %{changed_files}.

data/lib/inq/templates/issues_or_pulls_partial.html

@@ -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/inq/templates/new_contributors_partial.html

@@ -0,0 +1,5 @@
+<p>There %{was_were} %{number_of_new_contributors} new contributor%{contributor_s} during this report period.</p>
+
+<ul>
+%{list_items}
+</ul>

data/lib/inq/templates/report.html

@@ -0,0 +1,19 @@
+%{frontmatter}<!DOCTYPE html>
+<html>
+  <head>
+    <title>%{title}</title>
+    <style>
+      body { font: sans-serif; }
+      main {
+        max-width: 600px;
+        max-width: 72ch;
+        margin: auto;
+      }
+    </style>
+  </head>
+  <body>
+    <main>
+%{report}
+    </main>
+  </body>
+</html>