github-stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b06fb068ddd3c1e7e0e13ac784674cb3b74c33e
+  data.tar.gz: 825ae518a430007fbdbd65b492556db6c365d917
+SHA512:
+  metadata.gz: 8d5a88b2a8408bd4d259e0ea1eb5f9f423e1131540c165c1e3f1cefe4b4181e74915065b6179ba4a2888c6fc7d41522f78e1f32950d5479e01467c70a0bbfc31
+  data.tar.gz: 0127f29ca42621cce9d1779331c0da9013b5ce6a05a42e31b83bf271d25df2e22f7f1d0d0ef607afe662f7a1e5199ea17d5b0f33d3d5c3308718faf6951ddb15

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016, Zinc Technology Inc
+
+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,25 @@
+# Github Issue 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.
+
+## 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.
+
+For a detailed list of options and command line flags, please refer to `github-issue-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.
+
+### 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"
+2016-17 3 1
+2016-18 27 10
+2016-19 30 20
+2016-20 20 25
+2016-21 20 23
+```

data/bin/github-stats

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: github-stats [options] <search-string>'
+  opts.on('-h', '--help', 'Prints help') do
+    puts opts
+    exit
+  end
+
+  opts.on('--setup-db', TrueClass, 'Creates the database') do |setup_db|
+    options[:setup_db] = setup_db
+  end
+
+  opts.on('-d', '--database-url DATABASE_URL', 'which database to use') do |database_url|
+    puts "wat"
+    options[:database_url] = database_url
+  end
+
+  opts.on('--github-access-token ACCESS_TOKEN', 'Use a github access token for great private repo access/etc.') do |access_token|
+    options[:github_access_token] = access_token
+  end
+
+  opts.on('--[no-]ingest', 'Whether or not to ingest data or to rely on the databases state') do |ingest|
+    options[:ingest] = ingest
+  end
+
+  opts.on('-r REPORT_TYPE', '--report REPORT_TYPE', 'Defaults to closed_by_week') do |report_type|
+    options[:report_type] = report_type
+  end
+end.parse!
+
+require_relative '../lib/github_stats'
+
+puts GithubStats::CLI.run(ARGV, options)

data/lib/github_stats.rb

@@ -0,0 +1,11 @@
+require 'octokit'
+require 'sequel'
+
+require_relative 'github_stats/cli'
+require_relative 'github_stats/database'
+require_relative 'github_stats/closed_by_week_report'
+require_relative 'github_stats/issue_ingester'
+
+#
+module GithubStats
+end

data/lib/github_stats/cli.rb

@@ -0,0 +1,64 @@
+module GithubStats
+  # Main entrance point to the command line tool.
+  # Sets defaults and parses options etc.
+  class CLI
+    def self.run(search_string, options)
+      new(search_string, options).run
+    end
+
+    attr_accessor :search_string, :options
+
+    def initialize(remaining_args, options)
+      @search_string = remaining_args.join(' ')
+      options[:database_url] ||= "sqlite://#{home_dir}/db.sqlite"
+      options[:report_type] ||= 'issues_closed_by_week'
+      options[:ingest] = true unless options.key?(:ingest)
+      @options = options
+    end
+
+    def run
+      setup_db
+      ingest
+      report
+    end
+
+    private def setup_db
+      Database.new(options).setup
+    end
+
+    private def home_dir
+      return if @home_dir
+      @home_dir = File.join(Dir.home, '.github-stats')
+      Dir.mkdir(@home_dir) unless Dir.exist?(@home_dir)
+      @home_dir
+    end
+
+    private def ingest
+      IssueIngester.new(search_string, options).ingest
+    end
+
+    private def report
+      results = ClosedByWeekReport.new(search_string, options).results
+      SpaceSeperatedLinePerResultResultsView.new(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
+      attr_accessor :results
+      def initialize(results)
+        self.results = results
+      end
+
+      def fields
+        results.keys
+      end
+
+      def to_s
+        fields.join(' ') + "\n" + results.map do |result|
+          fields.map(&result.method(:fetch)).join(' ')
+        end.join("\n")
+      end
+    end
+  end
+end

data/lib/github_stats/closed_by_week_report.rb

@@ -0,0 +1,66 @@
+require_relative 'database'
+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
+      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
+      end
+
+      def keys
+        [:week_closed, :qty, :velocity]
+      end
+    end
+  end
+end

data/lib/github_stats/database.rb

@@ -0,0 +1,54 @@
+Sequel.database_timezone = :utc
+Sequel.application_timezone = :utc
+module GithubStats
+  # Encapsulates database bits and bobs and tiddles.
+  class Database
+    attr_accessor :options, :adapter
+    def initialize(options)
+      self.options = options
+    end
+
+    def adapter
+      @adapter ||= Sequel.connect(database_url)
+    end
+
+    def issues
+      adapter[:issues]
+    end
+
+    def setup
+      return if setup?
+      create_issues
+      create_events
+    end
+
+    private def setup?
+      File.exist?(URI.parse(database_url).path)
+    end
+
+    private def create_issues
+      adapter.create_table :issues do
+        primary_key :id
+        String :url
+        String :search_string
+        Integer :github_id
+        DateTime :closed_at
+        DateTime :created_at
+        DateTime :started_at
+      end
+    end
+
+    private def create_events
+      adapter.create_table :events do
+        primary_key :id
+        foreign_key :issue_id, :issues, on_delete: :cascade
+        DateTime :created_at
+        String :type
+      end
+    end
+
+    private def database_url
+      options[:database_url]
+    end
+  end
+end

data/lib/github_stats/github_client.rb

@@ -0,0 +1,38 @@
+module GithubStats
+  # Encapsulates github interactions so we can inject boring defaults and
+  # auto-paginate and potentially throttle or whatever.
+  class GithubClient
+    attr_accessor :octokit
+
+    def initialize(options)
+      self.octokit = Octokit::Client.new(access_token:
+                                          options[:github_access_token])
+    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

@@ -0,0 +1,48 @@
+require_relative 'github_client'
+module GithubStats
+  # Retrieves issues from Github and upserts them into the database.
+  class IssueIngester
+    attr_accessor :search_string, :options
+
+    def initialize(search_string, options)
+      self.search_string = search_string
+      self.options = options
+    end
+
+    def ingest
+      return unless options[:ingest]
+      github.search_issues(search_string).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]
+    end
+
+    private def update(issue, result)
+      issue.update(closed_at: result[:closed_at],
+                   created_at: result[:created_at])
+    end
+
+    private def insert(result)
+      issues.insert(search_string: search_string, github_id: result[:id],
+                    closed_at: result[:closed_at],
+                    created_at: result[:created_at],
+                    url: result[:url])
+    end
+
+    private def issues
+      db.issues.where(search_string: search_string)
+    end
+
+    private def db
+      @db ||= Database.new(options)
+    end
+
+    private def github
+      @github ||= GithubClient.new(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: github-stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zee@Zinc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.34'
+description: Throughput, cycle time, velocity, etc
+email: zee+github-stats@zincma.de
+executables:
+- github-stats
+extensions: []
+extra_rdoc_files:
+- README.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- bin/github-stats
+- lib/github_stats.rb
+- lib/github_stats/cli.rb
+- lib/github_stats/closed_by_week_report.rb
+- lib/github_stats/database.rb
+- lib/github_stats/github_client.rb
+- lib/github_stats/issue_ingester.rb
+homepage: https://github.com/zincmade/github-stats
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Project-management oriented stats for github
+test_files: []