inq 26.0.0

data/lib/inq/report_collection.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "inq/report"
+require "okay/warning_helpers"
+
+module Inq
+  ##
+  # A class representing a collection of Reports.
+  class ReportCollection
+    include Okay::WarningHelpers
+
+    def initialize(config, date)
+      @config = config
+
+      # If the config is in the old format, convert it to the new one.
+      unless @config["repositories"]
+        @config["repositories"] = [{
+          "repository" => @config.delete("repository"),
+          "reports" => @config.delete("reports"),
+        }]
+      end
+
+      @date = date
+      @reports = config["repositories"].map(&method(:fetch_report)).to_h
+    end
+
+    # Generates the metadata for the collection of Reports.
+    def metadata(repository)
+      end_date = DateTime.strptime(@date, "%Y-%m-%d")
+      friendly_end_date = end_date.strftime("%B %d, %y")
+
+      {
+        sanitized_repository: repository.tr("/", "-"),
+        repository: repository,
+        date: end_date,
+        friendly_date: friendly_end_date,
+      }
+    end
+    private :metadata
+
+    def config_for(repo)
+      defaults = @config.fetch("default_reports", {})
+      config = @config.dup
+      repos = config.delete("repositories")
+
+      # Find the _last_ one that matches, to allow overriding.
+      repo_config = repos.reverse.find { |conf| conf["repository"] == repo }
+
+      # Use values from default_reports, unless overridden.
+      config["repository"] = repo
+      config["reports"] = defaults.merge(repo_config.fetch("reports", {}))
+      config
+    end
+    private :config_for
+
+    def fetch_report(repo_config)
+      repo = repo_config["repository"]
+      report = Report.new(config_for(repo), @date)
+      [repo, report]
+    end
+    private :fetch_report
+
+    # Converts a ReportCollection to a Hash.
+    #
+    # Also good for giving programmers nightmares, I suspect.
+    def to_h
+      results = {}
+      defaults = @config["default_reports"] || {}
+
+      @config["repositories"].map { |repo_config|
+        repo = repo_config["repository"]
+        config = config_for(repo)
+
+        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 {
+            tmp_filename = report_config["filename"] || defaults[format]["filename"]
+            tmp_filename % metadata(repo)
+          }
+
+          directory = report_config["directory"] || defaults[format]["directory"]
+          file = File.join(directory, filename)
+
+          # Export +report+ to the specified +format+ with the specified
+          # +frontmatter+.
+          frontmatter = report_config["frontmatter"] || {}
+          if defaults.has_key?(format) && defaults[format].has_key?("frontmatter")
+            frontmatter = defaults[format]["frontmatter"].merge(frontmatter)
+          end
+          frontmatter = nil if frontmatter == {}
+
+          export = @reports[repo].send("to_#{format}", frontmatter)
+
+          results[file] = export
+        }
+      }
+      results
+    end
+
+    # Save all of the reports to the corresponding files.
+    #
+    # @return [Array<String>] An array of file paths.
+    def save_all
+      reports = to_h
+      reports.each do |file, report|
+        File.write(file, report)
+      end
+
+      reports.keys
+    end
+  end
+end

data/lib/inq/sources.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "inq/version"
+
+module Inq
+  ##
+  # Various information sources used by Inq.
+  module Sources
+    # Simply for creating a namespace.
+  end
+end

data/lib/inq/sources/ci/appveyor.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "okay/default"
+require "okay/http"
+require "inq/constants"
+require "inq/sources"
+require "inq/sources/github/contributions"
+require "inq/text"
+
+module Inq
+  module Sources
+    module CI
+      # Fetches metadata about CI builds from appveyor.com.
+      class Appveyor
+        # @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"]
+          @start_date = DateTime.parse(start_date)
+          @end_date = DateTime.parse(end_date)
+          @default_branch = Okay.default
+        end
+
+        # @return [String] The default branch name.
+        def default_branch
+          return @default_branch unless @default_branch.nil?
+
+          contributions = Sources::GitHub::Contributions.new(@config, nil, nil)
+
+          @default_branch = contributions.default_branch
+        end
+
+        # Fetches builds for the default branch.
+        #
+        # @return [Hash] Builds for the default branch.
+        def builds
+          @builds ||=
+            fetch_builds["builds"] \
+              .map(&method(:normalize_build)) \
+              .select(&method(:in_date_range?))
+        rescue Net::HTTPServerException
+          # It's not elegant, but it works™.
+          []
+        end
+
+        private
+
+        def in_date_range?(build)
+          build["started_at"] >= @start_date &&
+            build["started_at"] <= @end_date
+        end
+
+        def normalize_build(build)
+          build["started_at"] = DateTime.parse(build["created"])
+          build["html_url"] = "https://ci.appveyor.com/project/#{@repository}/build/#{build['buildNumber']}"
+          build
+        end
+
+        # Returns API result of /api/projects/:repository.
+        # FIXME: This doesn't limit results based on the date range.
+        #
+        # @return [Hash] API results.
+        def fetch_builds
+          @cache.cached("appveyor_builds") do
+            Inq::Text.print "Fetching Appveyor build data."
+
+            ret = Okay::HTTP.get(
+              "https://ci.appveyor.com/api/projects/#{@repository}/history",
+              parameters: {"recordsNumber" => "100"},
+              headers: {
+                "Accept" => "application/json",
+                "User-Agent" => Inq::USER_AGENT,
+              }
+            ).or_raise!.from_json
+
+            Inq::Text.puts
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inq/sources/ci/travis.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "date"
+require "okay/default"
+require "okay/http"
+require "inq/constants"
+require "inq/sources/github"
+require "inq/text"
+
+module Inq
+  module Sources
+    module CI
+      # Fetches metadata about CI builds from travis-ci.org.
+      class Travis
+        BadResponseError = Class.new(StandardError)
+
+        # @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 "Travis.new() got nil repository." if @repository.nil?
+          @start_date = DateTime.parse(start_date)
+          @end_date = DateTime.parse(end_date)
+          @default_branch = Okay.default
+        end
+
+        # @return [String] The default branch name.
+        def default_branch
+          return @default_branch unless @default_branch == Okay.default
+
+          response = fetch("branches", {"sort_by" => "default_branch"})
+          validate_response!(response)
+
+          branches = response["branches"]
+          validate_branches!(branches)
+
+          branch = branches.find { |b| b["default_branch"] == true }
+          @default_branch = branch&.fetch("name", nil)
+        end
+
+        # Returns the builds for the default branch.
+        #
+        # @return [Hash] Hash containing the builds for the default branch.
+        def builds
+          @cache.cached("travis_builds") do
+            raw_builds \
+              .map(&method(:normalize_build)) \
+              .select(&method(:in_date_range?)) \
+              .map(&method(:add_build_urls))
+          end
+        end
+
+        private
+
+        def add_build_urls(build)
+          build["html_url"] = "https://travis-ci.org/#{build['repository']}#{build['@href']}"
+          build
+        end
+
+        def validate_response!(response)
+          return true if hash_with_key?(response, "branches")
+
+          raise BadResponseError,
+            "expected `response' (#{response.class}) to be a Hash with key `\"branches\"'."
+        end
+
+        def validate_branches!(branches)
+          return true if array_of_hashes?(branches)
+
+          raise BadResponseError, "expected `branches' to be Array of Hashes."
+        end
+
+        def array_of_hashes?(ary)
+          ary.is_a?(Array) && ary.all? { |obj| obj.is_a?(Hash) }
+        end
+
+        def hash_with_key?(hsh, key)
+          hsh.is_a?(Hash) && hsh.has_key?(key)
+        end
+
+        def in_date_range?(build, start_date = @start_date, end_date = @end_date)
+          (build["started_at"] >= start_date) \
+            && (build["finished_at"] <= end_date)
+        end
+
+        def raw_builds
+          results = fetch("builds", {
+            "event_type" => "push",
+            "branch.name" => default_branch,
+          })
+
+          results["builds"] || {}
+        rescue Net::HTTPServerException
+          # It's not elegant, but it works™.
+          {}
+        end
+
+        def normalize_build(build)
+          build_keys = ["@href", "pull_request_title", "pull_request_number",
+                        "started_at", "finished_at", "repository", "commit",
+                        "jobs"]
+          result = pluck_keys(build, build_keys)
+
+          commit_keys = ["sha", "ref", "message", "compare_url",
+                         "committed_at", "jobs"]
+          result["commit"] = pluck_keys(result["commit"], commit_keys)
+
+          job_keys = ["href", "id"]
+          result["jobs"] = result["jobs"].map { |j| pluck_keys(j, job_keys) }
+
+          result["repository"] = result["repository"]["slug"]
+
+          ["started_at", "finished_at"].each do |k|
+            next if k.nil?
+            result[k] = DateTime.parse(result[k])
+          end
+
+          result
+        end
+
+        def pluck_keys(hsh, keys)
+          keys.map { |k| [k, hsh[k]] }.to_h
+        end
+
+        # Returns API results for /repos/:user/:repo/<path>.
+        #
+        # @param path [String] Path suffix (appended to /repo/<repo name>/).
+        # @param parameters [Hash] Parameters.
+        # @return [String] JSON result.
+        def fetch(path, parameters = {})
+          @cache.cached("travis_path") do
+            Inq::Text.print "Fetching Travis CI #{path.sub(/e?s$/, '')} data."
+
+            # Apparently this is required for the Travis CI API to work.
+            repo = @repository.sub("/", "%2F")
+
+            ret = Okay::HTTP.get(
+              "https://api.travis-ci.org/repo/#{repo}/#{path}",
+              parameters: parameters,
+              headers: {
+                "Travis-Api-Version" => "3",
+                "Accept" => "application/json",
+                "User-Agent" => Inq::USER_AGENT,
+              }
+            ).or_raise!.from_json
+
+            Inq::Text.puts
+
+            ret
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inq/sources/github.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "inq/version"
+require "inq/sources"
+require "okay/graphql"
+
+module Inq
+  module Sources
+    # Contains configuration information for GitHub-based sources.
+    class Github
+      class ConfigError < StandardError
+      end
+
+      def initialize(config)
+        must_have_key!(config, "sources/github")
+
+        @config = config["sources/github"]
+
+        must_have_key!(@config, "username")
+        must_have_key!(@config, "token")
+      end
+
+      # Verify that +hash+ has a particular +key+.
+      #
+      # @raise [ConfigError] If +hash+ does not have the required +key+.
+      def must_have_key!(hash, key)
+        raise ConfigError, "Expected Hash, got #{hash.class}" unless hash.is_a?(Hash)
+        raise ConfigError, "Expected key `#{key}'" unless hash.has_key?(key)
+      end
+      private :must_have_key!
+
+      # The GitHub username used for authenticating with GitHub.
+      def username
+        @config["username"]
+      end
+
+      # A GitHub Personal Access Token which goes with +username+.
+      def access_token
+        @config["token"]
+      end
+
+      # A string containing both the GitHub username and access token,
+      # used in instances where we use Basic Auth.
+      def basic_auth
+        "#{username}:#{access_token}"
+      end
+
+      # Submit a GraphQL query, and convert it from JSON to a Ruby object.
+      def graphql(query_string)
+        Okay::GraphQL.query(query_string)
+          .submit!(:github, {bearer_token: access_token})
+          .or_raise!
+          .from_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "github_api"
+require "inq/cacheable"
+require "inq/sources/github"
+require "inq/sources/github_helpers"
+require "inq/template"
+require "inq/text"
+require "date"
+
+module Inq
+  module Sources
+    class Github
+      # Fetch information about who has contributed to a repository during
+      # a given period.
+      #
+      # Usage:
+      #
+      #     c = Inq::Contributions.new(start_date: '2017-07-01', user: 'duckinator', repo: 'inq')
+      #     c.commits          #=> All commits during July 2017.
+      #     c.contributors #=> All contributors during July 2017.
+      #     c.new_contributors #=> New contributors during July 2017.
+      class Contributions
+        include Inq::Sources::GithubHelpers
+
+        # Returns an object that fetches contributor information about a
+        # particular repository for a month-long period starting on +start_date+.
+        #
+        # @param config     [Hash]   A config object.
+        # @param start_date [String] Date in the format YYYY-MM-DD.
+        #                            The first date to include commits from.
+        # @param end_date   [String] Date in the format YYYY-MM-DD.
+        #                            The last date to include commits from.
+        # @param cache      [Cacheable] Instance of Inq::Cacheable to cache API calls
+        def initialize(config, start_date, end_date, cache)
+          raise "Got String, need Hash. The Github::Contributions API changed." if config.is_a?(String)
+
+          @config = config
+          @cache = cache
+          @github = Sources::Github.new(config)
+          @repository = config["repository"]
+
+          @user, @repo = @repository.split("/")
+          @github = ::Github.new(auto_pagination: true) { |conf|
+            conf.basic_auth = @github.basic_auth
+          }
+
+          # IMPL. DETAIL: The external API uses "end_date" so it's clearer,
+          #               but internally we use "until_date" to match GitHub's API.
+          @since_date = start_date
+          @until_date = end_date
+
+          @commit = {}
+          @stats = nil
+          @changed_files = nil
+        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
+          @new_contributors ||= contributors.select { |email, _committer|
+            args = {
+              user: @user,
+              repo: @repo,
+              until: @since_date,
+              author: email,
+            }
+            # True if +email+ never wrote a commit for +@repo+ before +@since_date+, false otherwise.
+            commits = @cache.cached("repos_commits", args.to_json) do
+              @github.repos.commits.list(**args)
+            end
+            commits.count.zero?
+          }
+        end
+
+        def new_contributors_html
+          names = new_contributors.values.map { |c| c["name"] }
+          list_items = names.map { |n| "  <li>#{n}</li>" }.join("\n")
+
+          if names.length.zero?
+            num_new_contributors = "no"
+          else
+            num_new_contributors = names.length
+          end
+
+          if names.length == 1
+            was_were = "was"
+            contributor_s = ""
+          else
+            was_were = "were"
+            contributor_s = "s"
+          end
+
+          Template.apply("new_contributors_partial.html", {
+            was_were: was_were,
+            contributor_s: contributor_s,
+            number_of_new_contributors: num_new_contributors,
+            list_items: list_items,
+          }).strip
+        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
+          return @commits if instance_variable_defined?(:@commits)
+
+          args = {
+            user: @user,
+            repo: @repo,
+            since: @since_date,
+            until: @until_date,
+          }
+
+          Inq::Text.print "Fetching #{@repository} commit data."
+
+          # The commits list endpoint doesn't include all stats.
+          # So, to compensate, we make N requests here, where N is number
+          # of commits returned, and then we die a bit inside.
+          @commits = @cache.cached("repos_commits", args.to_json) do
+            @github.repos.commits.list(**args).map { |c|
+              Inq::Text.print "."
+              commit(c.sha)
+            }
+          end
+          Inq::Text.puts
+          @commits
+        end
+
+        def commit(sha)
+          @commit[sha] ||= @cache.cached("repos_commit_#{sha}") do
+            @github.repos.commits.get(user: @user, repo: @repo, sha: sha)
+          end
+        end
+
+        def stats
+          return @stats if @stats
+
+          stats = {"total" => 0, "additions" => 0, "deletions" => 0}
+          commits.map do |commit|
+            stats.keys.each do |key|
+              stats[key] += commit.stats[key]
+            end
+          end
+          @stats = stats
+        end
+
+        def changed_files
+          return @changed_files if @changed_files
+          files = commits.flat_map do |commit|
+            commit.files.map { |file| file["filename"] }
+          end
+          @changed_files = files.sort.uniq
+        end
+
+        def changes
+          {"stats" => stats, "files" => changed_files}
+        end
+
+        def additions_count
+          changes["stats"]["additions"]
+        end
+
+        def deletions_count
+          changes["stats"]["deletions"]
+        end
+
+        def compare_url
+          "https://github.com/#{@user}/#{@repo}/compare/#{default_branch}@%7B#{@since_date}%7D...#{default_branch}@%7B#{@until_date}%7D" # rubocop:disable Metrics/LineLength
+        end
+
+        def default_branch
+          @default_branch ||= @cache.cached("repos_default_branch") do
+            @github.repos.get(user: @user, repo: @repo).default_branch
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def to_html(start_text: nil)
+          start_text ||= "From #{pretty_date(@since_date)} through #{pretty_date(@until_date)}"
+
+          Inq::Template.apply("contributions_partial.html", {
+            start_text: start_text,
+            user: @user,
+            repo: @repo,
+            compare_url: compare_url,
+            additions_count_str: (additions_count == 1) ? "was" : "were",
+            authors: pluralize("author", contributors.length),
+            new_commits: pluralize("new commit", commits.length),
+            additions: pluralize("addition", additions_count),
+            deletions: pluralize("deletion", deletions_count),
+            changed_files: pluralize("file", changed_files.length),
+          }).strip
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end