time_to_first_comment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b111abb3ac5ecd9abaaade06d90e71c2e79e6cda
+  data.tar.gz: 8d22dc67dc85a63f98c0793eb14d4c17a02eb6a7
+SHA512:
+  metadata.gz: 08d626ac6c7cee49e30cc03db9f334a5db722e6b25caa550e4e043f6e85fe7034f7dab47e27e09718d50ab091b817a53cc408168f19a49cf91decacfa31be2ef
+  data.tar.gz: d0ccf06ba30cf5febf0b63d89fffe0f3afcf8fa3ae755af11bcc4de270619aa24ae763b6f3ffdb2a0d2bd15d27e64832aa621ae3376712f091dcdc397d087124

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+pkg/
+.yardoc/
+time_to_first_comment-0.1.0.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 130

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* First release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in time_to_first_comment.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julio Olivera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Time To First Comment
+
+Know how much it took for PRs on a repo to get their first comment.
+
+# Usage
+
+```
+gem install time_to_first_comment
+```
+
+## CLI
+
+The gem comes bundled with a CLI to quickly get data for a repo:
+
+```
+$ time_to_first_comment --repo someuser/somerepo --from 2015-12-01 --to 2015-12-15
+Some pull request: No comments yet.
+Some other pull request: 17 hrs 21 mins 2 secs until first comment.
+```
+
+Available options:
+
+```
+$ time_to_first_comment
+Usage: time_to_first_comment [options]
+    -r, --repo          Repository to look for PRs on
+        --from          PRs created since this date - YYYY-MM-DD
+        --to            PRs created up to this date - YYYY-MM-DD
+    -e, --endpoint      Custom API endpoint to connect to Github Enterprise
+    -t, --token         Access Token to query Github as a specific user
+```
+
+## API
+
+You can use the gem in your own code to use the data any way you want:
+
+```
+require 'time_to_first_comment'
+
+# You have to pass an instance of Octokit::Client that the gem will use to query Github.
+# This way, you can configure that instance any way you like.
+stats = TimeToFirstComment::PullRequestsStats.new(Octokit::Client.new)
+
+stats.time_to_first_comment('someuser/somerepo').each do |pull, seconds|
+  # Here `pull` is an instance of Sawyer::Resource returned by Octokit::Client.
+  # `seconds` is the number of seconds until that PR got its first comment, or nil if there were none yet.
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'time_to_first_comment'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/time_to_first_comment

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'time_to_first_comment'
+
+TimeToFirstComment::Cli.new.respond(ARGV)

data/lib/time_to_first_comment.rb

@@ -0,0 +1,6 @@
+require 'time_to_first_comment/version'
+require 'time_to_first_comment/pull_requests_stats'
+require 'time_to_first_comment/cli'
+
+module TimeToFirstComment
+end

data/lib/time_to_first_comment/cli.rb

@@ -0,0 +1,47 @@
+require 'octokit'
+require 'chronic_duration'
+require 'slop'
+
+module TimeToFirstComment
+  class Cli
+    def respond(arguments)
+      opts = Slop.parse(arguments) do
+        on :r, :repo=, 'Repository to look for PRs on'
+        on :from=, 'PRs created since this date - YYYY-MM-DD', argument: :optional
+        on :to=, 'PRs created up to this date - YYYY-MM-DD', argument: :optional
+        on :e, :endpoint=, 'Custom API endpoint to connect to Github Enterprise', argument: :optional
+        on :t, :token=, 'Access Token to query Github as a specific user', argument: :optional
+      end
+
+      unless opts.map(&:value).compact.any?
+        puts opts.help
+        return
+      end
+
+      if opts.missing.include?('repo')
+        puts 'Missing repository.'
+        puts opts.help
+        return
+      end
+
+      stats = TimeToFirstComment::PullRequestsStats.new(octokit_client(endpoint: opts[:endpoint], token: opts[:token]))
+
+      stats.time_to_first_comment(opts[:repo], from: opts[:from], to: opts[:to]).each do |pull, seconds|
+        if seconds
+          puts %(#{pull.title}: #{ChronicDuration.output(seconds)} until first comment.)
+        else
+          puts %(#{pull.title}: No comments yet.)
+        end
+      end
+    end
+
+    private
+
+    def octokit_client(endpoint:, token:)
+      options = {}
+      options[:api_endpoint] = endpoint if endpoint
+      options[:access_token] = token if token
+      Octokit::Client.new(options)
+    end
+  end
+end

data/lib/time_to_first_comment/pull_requests_stats.rb

@@ -0,0 +1,71 @@
+module TimeToFirstComment
+  class PullRequestsStats
+    attr_accessor :client
+
+    # Creates a new instance of the stats generator.
+    #
+    # @param client [Octokit::Client]
+    def initialize(client)
+      self.client = client
+    end
+
+    # Gets the time until the first comment for a given repo's pull requests.
+    #
+    # @param repo [String] A string supported by {Octokit::Client} like 'username/repo'
+    # @param options [Hash] Options for selecting the PRs to check.
+    # @option options [String] :from PRs created starting from this date. The format is YYYY-MM-DD.
+    # @option options [String] :to PRs created up to this date. The format is YYYY-MM-DD.
+    # @return [Array<Array>] An array with tuples that include the pull request as the first parameter and the number of seconds
+    #   until the first comment arrived as the second (`nil` if there are no comments).
+    # @example Get the time to first comment for the PRs in the repo 'username/repo'
+    #   client = TimeToFirstComment::PullRequestsStats.new(Octokit::Client.new)
+    #   client.time_to_first_comment('username/repo', from: '2015-03-12', to: '2015-05-10')
+    #   #=> [[<Sawyer::Resource ...>, 12000], [<Sawyer::Resource ...>, nil]]
+    def time_to_first_comment(repo, options = {})
+      repo_query = "repo:#{repo}"
+      date_range_query = date_query(:created, options[:from], options[:to])
+
+      pulls = client.search_issues("type:pr sort:updated #{repo_query} #{date_range_query}")[:items]
+
+      pulls.map do |pull|
+        [pull, seconds_until_first_comment(repo, pull)]
+      end
+    end
+
+    private
+
+    # Given a Pull Request ({Sawyer::Resource}) and the repo it belongs to it returns the number of seconds until the first
+    # comment happened, or `nil` if there were none.
+    #
+    # @param repo [String] The name of the repo the PR belongs to.
+    # @param pull [Sawyer::Resource] A Pull Request from {Octokit}.
+    # @return [Fixnum] The number of seconds until that PRs first comment, or `nil`.
+    def seconds_until_first_comment(repo, pull)
+      issue_comments = pull.rels[:comments].get.data
+      review_comments = client.review_comments(repo, pull.number)
+      first_comment = (issue_comments + review_comments).sort_by(&:created_at).first
+      first_comment.created_at - pull.created_at if first_comment
+    end
+
+    # Returns a query string for searching Github's API. It can be either for date created or updated, and with from and/or to
+    # dates.
+    #
+    # @param [Symbol] type Either :created or :updated
+    # @param [String] from Date from, the format is YYYY-MM-DD.
+    # @param [String] to Date to, the format is YYYY-MM-DD.
+    # @return [String] description A string for querying Github's API. An empty string if no date is provided.
+    def date_query(type, from, to)
+      if from && to
+        dates = "#{from}..#{to}"
+      elsif from
+        dates = ">=#{from}"
+      elsif to
+        dates = "<=#{to}"
+      else
+        return ''
+      end
+
+      "#{type}:#{dates}"
+    end
+  end
+end

data/lib/time_to_first_comment/version.rb

@@ -0,0 +1,3 @@
+module TimeToFirstComment
+  VERSION = '0.1.0'
+end

data/time_to_first_comment.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_to_first_comment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'time_to_first_comment'
+  spec.version       = TimeToFirstComment::VERSION
+  spec.authors       = ['Julio Olivera']
+  spec.email         = ['julio.olvr@gmail.com']
+
+  spec.summary       = 'Utility to check how much time passed until the first comment was added to a Pull Request'
+  spec.homepage      = 'https://github.com/julioolvr/time-to-first-comment'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['time_to_first_comment']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'octokit', '~> 4.2'
+  spec.add_dependency 'chronic_duration', '~> 0.10'
+  spec.add_dependency 'slop', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: time_to_first_comment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julio Olivera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- julio.olvr@gmail.com
+executables:
+- time_to_first_comment
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/time_to_first_comment
+- lib/time_to_first_comment.rb
+- lib/time_to_first_comment/cli.rb
+- lib/time_to_first_comment/pull_requests_stats.rb
+- lib/time_to_first_comment/version.rb
+- time_to_first_comment.gemspec
+homepage: https://github.com/julioolvr/time-to-first-comment
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Utility to check how much time passed until the first comment was added to
+  a Pull Request
+test_files: []
+has_rdoc: