github-stats 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b06fb068ddd3c1e7e0e13ac784674cb3b74c33e
-  data.tar.gz: 825ae518a430007fbdbd65b492556db6c365d917
+  metadata.gz: ab422a50b60641cae6051a695a86876b5e5ad707
+  data.tar.gz: 43dfaa3d02fe256f39641d7f132afd9879b724c8
 SHA512:
-  metadata.gz: 8d5a88b2a8408bd4d259e0ea1eb5f9f423e1131540c165c1e3f1cefe4b4181e74915065b6179ba4a2888c6fc7d41522f78e1f32950d5479e01467c70a0bbfc31
-  data.tar.gz: 0127f29ca42621cce9d1779331c0da9013b5ce6a05a42e31b83bf271d25df2e22f7f1d0d0ef607afe662f7a1e5199ea17d5b0f33d3d5c3308718faf6951ddb15
+  metadata.gz: c43a0a82b19ca8e1db9301965e89c0577da86e1253314da443873e0ab95fc689cb289833ba1cb99ad1052ac532b2bce397fbb04f908f8c051c7c1a2fe1dd54a9
+  data.tar.gz: 83a13c2de52cfa8b2a56af2f0db89057a39047d25ef2d1ee9a7ebe6f034403acac89bb158df4c3c261d958c222815cce760185571f56b48f35c4f7121b7a3749

data/README.md

@@ -1,22 +1,23 @@
-# Github Issue Stats
+# Github Issue Stats [![Gem Version](https://badge.fury.io/rb/github-stats.svg)](https://badge.fury.io/rb/github-stats)
+
 
 Github issues are a decent way to track work on a small project; and with the rise of tools such as Waffle.io and ZenHub, it appears that they will slowly but surely become better and better for managing long term projects.
 
-However statistical analysis of github issues is still very much lacking. `github-issue-stats` is a command line tool / gem that takes github searches and converts them into useful project reports.
+However statistical analysis of github issues is still very much lacking. `github-stats` is a command line tool / gem that takes github searches and converts them into useful project reports.
 
 ## Installation & Usage
-Assuming you are using Ruby 1.9.3 or above: `gem install github-issue-stats` will install the tool. Running `github-issue-stats "whatever github search string you want"` will run the search, outputting a closed by week report.
+Assuming you are using Ruby 1.9.3 or above: `gem install github-stats` will install the tool. Running `github-stats "whatever github search string you want"` will run the search, outputting a closed by week report.
 
-For a detailed list of options and command line flags, please refer to `github-issue-stats --help`.
+For a detailed list of options and command line flags, please refer to `github-stats --help`.
 
 **Please Note!** Github's Search API restricts searches to [the first 1,000 results](https://developer.github.com/v3/search/#about-the-search-api) and limits [unauthenticated requests to 10 per minute](https://developer.github.com/v3/search/#rate-limit). This means you can run 1 report per-minute that would return a full 1,000 issues.
 
-I recommend using filters such as [`state:closed`](https://help.github.com/articles/searching-issues/#search-based-on-whether-an-issue-or-pull-request-is-open) and/or [`updated:>=2016-01-01`](https://help.github.com/articles/searching-issues/#search-based-on-when-an-issue-or-pull-request-was-created-or-last-updated) to scope your requests down, based upon the report type.
+I recommend using filters such as [`state:closed`](https://help.github.com/articles/searching-issues/#search-based-on-whether-anor-pull-request-is-open) and/or [`updated:>=2016-01-01`](https://help.github.com/articles/searching-issues/#search-based-on-when-anor-pull-request-was-created-or-last-updated) to scope your requests down, based upon the report type.
 
 ### Example
 The following example shows how to get a closed by week report for Rails for the first 4 weeks of May 2016
 ```
-$ github-issue-stats "repo:rails/rails type:issue is:closed closed:2016-05-01..2016-05-28"
+$ github-stats "repo:rails/rails type:issue is:closed closed:2016-05-01..2016-05-28"
 2016-17 3 1
 2016-18 27 10
 2016-19 30 20

data/bin/github-stats

@@ -28,7 +28,7 @@ OptionParser.new do |opts|
     options[:ingest] = ingest
   end
 
-  opts.on('-r REPORT_TYPE', '--report REPORT_TYPE', 'Defaults to closed_by_week') do |report_type|
+  opts.on('-r REPORT_TYPE', '--report REPORT_TYPE', 'Default is closed_by_week; may be cycle_time, closed_by_week, or created_by_week') do |report_type|
     options[:report_type] = report_type
   end
 end.parse!

data/lib/github_stats.rb

@@ -3,6 +3,8 @@ require 'sequel'
 
 require_relative 'github_stats/cli'
 require_relative 'github_stats/database'
+require_relative 'github_stats/reports'
+require_relative 'github_stats/created_by_week_report'
 require_relative 'github_stats/closed_by_week_report'
 require_relative 'github_stats/issue_ingester'
 

data/lib/github_stats/cli.rb

@@ -19,7 +19,7 @@ module GithubStats
     def run
       setup_db
       ingest
-      report
+      results
     end
 
     private def setup_db
@@ -38,13 +38,16 @@ module GithubStats
     end
 
     private def report
-      results = ClosedByWeekReport.new(search_string, options).results
-      SpaceSeperatedLinePerResultResultsView.new(results)
+      Reports.for(options[:report_type]).new(search_string, options)
+    end
+
+    private def results
+      CommaSeperatedLinePerResultResultsView.new(report.results)
     end
 
     # Transforms a result set into a space-seperated table the results hash
     # keys becoming the table headers and line breaks between rows.
-    class SpaceSeperatedLinePerResultResultsView
+    class CommaSeperatedLinePerResultResultsView
       attr_accessor :results
       def initialize(results)
         self.results = results
@@ -55,8 +58,8 @@ module GithubStats
       end
 
       def to_s
-        fields.join(' ') + "\n" + results.map do |result|
-          fields.map(&result.method(:fetch)).join(' ')
+        fields.join(',') + "\n" + results.map do |result|
+          fields.map(&result.method(:fetch)).join(',')
         end.join("\n")
       end
     end

data/lib/github_stats/closed_by_week_report.rb

@@ -1,65 +1,26 @@
 require_relative 'database'
+require_relative 'report'
 module GithubStats
-  # Provides week-by-week breakdown of issues closed, grouped by week
-  # with a 3 week moving average.
-  class ClosedByWeekReport
-    attr_accessor :search_string, :options
-
-    def initialize(search_string, options)
-      self.search_string = search_string
-      self.options = options
-    end
-
-    def results
-      results = with_velocity(with_week_closed(with_qty(issues)))
-      Results.new(results)
-    end
-
-    private def with_velocity(issues)
-      closed_two_weeks_ago = 0
-      closed_last_week = 0
-      issues.map do |issue|
-        issue[:velocity] = average(closed_two_weeks_ago, closed_last_week,
-                                   issue[:qty])
-        closed_two_weeks_ago = closed_last_week
-        closed_last_week = issue[:qty]
-        issue
+  module Reports
+    # Provides week-by-week breakdown of issues closed, grouped by week
+    # with a 3 week moving average.
+    class ClosedByWeekReport
+      attr_accessor :search_string, :options
+      include Report
+
+      def results
+        results = with_moving_average(:velocity,
+                                      by_week_closed(with_qty(issues)))
+        Reports::Results.new(results, keys: [:week_closed, :qty, :velocity])
       end
-    end
-
-    private def average(*numbers)
-      numbers.reduce(:+) / numbers.length
-    end
-
-    private def with_qty(dataset)
-      dataset.select { count(:id).as qty }
-    end
-
-    private def with_week_closed(dataset)
-      dataset.select_append { strftime('%Y-%W', closed_at).as(week_closed) }
-        .group_by(:week_closed)
-    end
-
-    private def issues
-      db.issues.where(search_string: search_string).where { closed_at !~ nil }
-    end
-
-    private def db
-      @db ||= Database.new(options)
-    end
-
-    # Provides enumerable access to the results
-    class Results
-      attr_accessor :data
-      extend Forwardable
-      def_delegators :data, :each, :map
 
-      def initialize(data)
-        self.data = data
+      private def by_week_closed(dataset)
+        dataset.select_append { strftime('%Y-%W', closed_at).as(week_closed) }
+          .group_by(:week_closed)
       end
 
-      def keys
-        [:week_closed, :qty, :velocity]
+      private def issues
+        db.issues.where(search_string: search_string).where { closed_at !~ nil }
       end
     end
   end

data/lib/github_stats/created_by_week_report.rb

@@ -0,0 +1,29 @@
+require_relative 'database'
+require_relative 'report'
+module GithubStats
+  module Reports
+    # Provides week-by-week breakdown of issues created, grouped by week
+    # with a 3 week moving average.
+    class CreatedByWeekReport
+      attr_accessor :search_string, :options
+
+      include Report
+
+      def results
+        results = with_moving_average(:add_rate,
+                                      by_week_created(with_qty(issues)))
+        Reports::Results.new(results, keys: [:week_created, :qty, :add_rate])
+      end
+
+      private def by_week_created(dataset)
+        dataset.select_append { strftime('%Y-%W', created_at).as(week_created) }
+          .group_by(:week_created)
+      end
+
+      private def issues
+        db.issues.where(search_string: search_string)
+          .where { created_at !~ nil }
+      end
+    end
+  end
+end

data/lib/github_stats/cycle_time_report.rb

@@ -0,0 +1,36 @@
+require_relative 'database'
+require_relative 'report'
+module GithubStats
+  module Reports
+    # Provides issue cycle time from started at to done
+    class CycleTimeReport
+      attr_accessor :search_string, :options
+      include Report
+
+      def results
+        Results.new(with_cycle_time(issues), keys: [:week_closed, :created_at, :started_at, :closed_at, :cycle_time, :url])
+      end
+
+      private def with_cycle_time(dataset)
+        dataset.all.map do |item|
+          item[:week_closed] = (item[:closed_at].strftime("%Y-%W"))
+          item[:cycle_time] = work_days_between(item[:closed_at], item[:started_at])
+          item
+        end
+      end
+
+      private def work_days_between(end_time, start_time)
+        hours_between = (end_time - start_time) / 60 / 60
+        return hours_between.to_f / 24.to_f if hours_between < 12
+        days_between = (end_time.strftime('%j').to_i - start_time.strftime('%j').to_i)
+        weeks_between = (end_time.strftime('%W').to_i - start_time.strftime('%W').to_i)
+        return (hours_between - (days_between * 10 + weeks_between * 28)).to_f / 24.to_f
+      end
+
+      private def issues
+        db.issues.where(search_string: search_string).where { closed_at !~ nil }
+                                                     .where { started_at !~ nil }
+      end
+    end
+  end
+end

data/lib/github_stats/github_client.rb

@@ -6,33 +6,12 @@ module GithubStats
 
     def initialize(options)
       self.octokit = Octokit::Client.new(access_token:
-                                          options[:github_access_token])
+                                          options[:github_access_token],
+                                         auto_paginate: true)
     end
 
     def search_issues(query, options = { per_page: 100 })
       octokit.search_issues(query, options)
-      Response.new(self)
-    end
-
-    def last_response
-      octokit.last_response
-    end
-
-    # Auto-paginate!
-    class Response
-      attr_reader :client
-      def initialize(client)
-        @client = client
-      end
-
-      def each(&block)
-        last_response = client.last_response
-        loop do
-          last_response.data.items.each(&block)
-          last_response = last_response.rels[:next].get
-          break if last_response.rels[:next].nil?
-        end
-      end
     end
   end
 end

data/lib/github_stats/issue_ingester.rb

@@ -11,25 +11,39 @@ module GithubStats
 
     def ingest
       return unless options[:ingest]
-      github.search_issues(search_string).each(&method(:insert_or_update))
+      github.search_issues(search_string).items.each(&method(:insert_or_update))
     end
 
     private def insert_or_update(result)
       issue = issues.first(github_id: result[:id])
-      return insert(result) unless issue
-      return update(issue, result) if issue[:closed_at] != result[:closed_at] ||
-                                      issue[:created_at] != result[:created_at]
+      started_at = started_at(result)
+      return insert(result, started_at: started_at) unless issue
+      return update(issue, result, started_at: started_at) if issue[:closed_at] != result[:closed_at] ||
+                                                              issue[:created_at] != result[:created_at] ||
+                                                              issue[:started_at] != started_at
     end
 
-    private def update(issue, result)
+    private def started_at(result)
+      starting_events = result.rels[:events].get.data.select do |event|
+        event[:event] == 'labeled' &&  (event[:label] || {})[:name] == 'in-progress'
+      end.sort_by do |event|
+        event[:created_at]
+      end
+      starting_event = starting_events.last
+      starting_event.nil? ? nil : starting_event[:created_at]
+    end
+
+    private def update(issue, result, started_at:)
       issue.update(closed_at: result[:closed_at],
-                   created_at: result[:created_at])
+                   created_at: result[:created_at],
+                   started_at: started_at)
     end
 
-    private def insert(result)
+    private def insert(result, started_at:)
       issues.insert(search_string: search_string, github_id: result[:id],
                     closed_at: result[:closed_at],
                     created_at: result[:created_at],
+                    started_at: started_at,
                     url: result[:url])
     end
 

data/lib/github_stats/report.rb

@@ -0,0 +1,34 @@
+module GithubStats
+  module Reports
+    module Report
+      def initialize(search_string, options)
+        self.search_string = search_string
+        self.options = options
+      end
+
+      private def with_moving_average(label, weeks)
+        closed_two_weeks_ago = 0
+        closed_last_week = 0
+        weeks.map do |week|
+          week[label] = average(closed_two_weeks_ago, closed_last_week,
+                                week[:qty])
+          closed_two_weeks_ago = closed_last_week
+          closed_last_week = week[:qty]
+          week
+        end
+      end
+
+      private def average(*numbers)
+        numbers.reduce(:+) / numbers.length
+      end
+
+      private def with_qty(dataset)
+        dataset.select { count(:id).as qty }
+      end
+
+      private def db
+        @db ||= Database.new(options)
+      end
+    end
+  end
+end

data/lib/github_stats/reports.rb

@@ -0,0 +1,25 @@
+require_relative 'closed_by_week_report'
+require_relative 'cycle_time_report'
+require_relative 'created_by_week_report'
+
+module GithubStats
+  module Reports
+    def self.for(report_type)
+      { 'closed_by_week' => ClosedByWeekReport,
+        'created_by_week' => CreatedByWeekReport,
+        'cycle_time' => CycleTimeReport }.fetch(report_type)
+    end
+
+    # Provides enumerable access to the results
+    class Results
+      attr_accessor :data, :keys
+      extend Forwardable
+      def_delegators :data, :each, :map
+
+      def initialize(data, keys: [])
+        self.data = data
+        self.keys = keys
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zee@Zinc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-29 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -69,9 +69,13 @@ files:
 - lib/github_stats.rb
 - lib/github_stats/cli.rb
 - lib/github_stats/closed_by_week_report.rb
+- lib/github_stats/created_by_week_report.rb
+- lib/github_stats/cycle_time_report.rb
 - lib/github_stats/database.rb
 - lib/github_stats/github_client.rb
 - lib/github_stats/issue_ingester.rb
+- lib/github_stats/report.rb
+- lib/github_stats/reports.rb
 homepage: https://github.com/zincmade/github-stats
 licenses:
 - MIT