project-health 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    project-health (0.0.1)
+      activesupport (~> 3.2.8)
+      hirb (~> 0.7)
+      octokit (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    coderay (1.0.6)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    hirb (0.7.0)
+    i18n (0.6.1)
+    method_source (0.7.1)
+    multi_json (1.3.7)
+    multipart-post (1.1.5)
+    octokit (1.18.0)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.2)
+      multi_json (~> 1.3)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  project-health!
+  pry

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Serg Podtynnyi
+
+MIT License
+
+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,67 @@
+# Project Health
+
+Library for calculating project health report and analysis based on GitHub Activity data
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'project-health'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install project-health
+```
+
+## Usage
+
+```ruby
+require 'pp'
+require 'project-health'
+
+ProjectHealth.configure do |config|
+  #config.login = ''  # use your github name
+  #config.password = '' # use your github password
+end
+
+project = ProjectHealth.new('capistrano/capistrano')
+
+pp project.stats
+```
+
+Result
+
+```ruby
+{"Project"=>
+  {"Name"=>"capistrano/capistrano",
+   "Pull Requests"=>
+    {"All"=>142,
+     "Open"=>8,
+     "Closed"=>134,
+     "Open %"=>5.63,
+     "Closed %"=>94.37,
+     "Open/Closed % ratio"=>0.06,
+     "Open time in days"=>801,
+     "Min open time in days"=>5,
+     "Max open time in days"=>389,
+     "Average open time in days per request"=>100,
+     "Health"=>"Good"}}}
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/project-health

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require 'project-health'
+require 'pp'
+require 'hirb'
+
+def help_general
+  puts "Project Health Version: #{ProjectHealth::VERSION}"
+  puts
+  puts "Usage: project-health username/repo "
+  puts
+  puts "Example: project-health capistrano/capistrano"
+  puts
+  puts
+end
+
+def show_project_stats(repo)
+  extend Hirb::Console
+  project = ProjectHealth.new(repo)
+  puts "Project Health Version: #{ProjectHealth::VERSION}"
+  puts
+  puts "Showing project health for #{repo}"
+  puts
+  project.stats['Project'].each{|c| table c.last}
+  puts
+  puts
+end
+
+begin
+  if $stdin.isatty
+    $stdin.sync = true
+  end
+  if $stdout.isatty
+    $stdout.sync = true
+  end
+  args = *ARGV
+  command = args.shift.strip rescue 'help'
+  if command == 'help'
+    help_general
+  else
+    show_project_stats(command)
+  end
+rescue Interrupt
+  `stty icanon echo`
+  puts "Command cancelled."
+rescue => error
+  puts error
+  exit(1)
+end
+
+

data/lib/project-health/config.rb

@@ -0,0 +1,17 @@
+require "active_support/core_ext"
+require 'octokit'
+
+class Numeric
+  def percent_of(n)
+    self.to_f / n.to_f * 100.0
+  end
+end
+
+module ProjectHealth
+  module Config
+    mattr_accessor :login, :password
+    def configure
+      yield self
+    end
+  end
+end

data/lib/project-health/project.rb

@@ -0,0 +1,27 @@
+module ProjectHealth
+  class Project
+
+    attr_reader :name
+
+    def initialize(name)
+      @oct = Octokit::Client.new(:auto_traversal => true,
+                                 :per_page => 500, :login => Config.login,
+                                 :password=> Config.password)
+      @name = name
+      @reports = []
+      add_report :basic
+      add_report :pull_requests
+    end
+
+    def add_report(report)
+      @reports << ProjectHealth.const_get("#{report}_report".to_s.camelize).new(@oct, name)
+    end
+
+    def stats
+      result = {}
+      @reports.map{|x| result.merge!(x.stats) }
+      { "Project" => result }
+    end
+
+  end
+end

data/lib/project-health/report/basic.rb

@@ -0,0 +1,14 @@
+module ProjectHealth
+  class BasicReport
+
+    attr_reader :name
+
+    def initialize(oct, name)
+      @name = name
+    end
+
+    def stats
+      { "Name" => name }
+    end
+  end
+end

data/lib/project-health/report/pull_requests.rb

@@ -0,0 +1,78 @@
+module ProjectHealth
+  class PullRequestsReport
+
+    attr_reader :pulls_open, :pulls_closed, :pulls_all
+
+    def initialize(oct, name)
+      @pull_open_time = []
+      @pulls_open   = oct.pull_requests(name, :open).tap{|x| x.each(&method(:calc_open_pull_time)) }.count
+      @pulls_closed = oct.pull_requests(name, :closed).count
+      @pulls_all    = pulls_open + pulls_closed
+    end
+
+    def stats
+      {
+        "Pull Requests"=>
+        {
+          'All'      => pulls_all,
+          'Open'     => pulls_open,
+          'Closed'   => pulls_closed,
+          'Open %'   => pulls_open_percent.to_f.round(2),
+          'Closed %' => pulls_closed_percent.to_f.round(2),
+          'Open/Closed % ratio' => open_closed_pull_ratio.to_f.round(2),
+          'Open time in days' => pull_open_time,
+          'Min open time in days' => pull_min_open_time,
+          'Max open time in days' => pull_max_open_time,
+          'Average days request is opened' => pull_average_open_time,
+          'Health' => pulls_health
+        }
+      }.delete_if{|k,v| v.kind_of?(Float) && v.nan?}
+    end
+
+    def pulls_open_percent
+      pulls_open.percent_of(pulls_all)
+    end
+
+    def pulls_closed_percent
+      pulls_closed.percent_of(pulls_all)
+    end
+
+    def open_closed_pull_ratio
+      result = pulls_open_percent / pulls_closed_percent
+    end
+
+    def pull_open_time
+      @pull_open_time.inject(:+)
+    end
+
+    def pull_average_open_time
+      pull_open_time / pulls_open
+    end
+
+    def pull_min_open_time
+      @pull_open_time.min
+    end
+
+    def pull_max_open_time
+      @pull_open_time.max
+    end
+
+    def pulls_health
+      case open_closed_pull_ratio.to_f
+      when 0..0.1
+        "Good"
+      when 0.1..0.2
+        "Normal"
+      when 0.2..1
+        "Bad"
+      else
+        "Unknown"
+      end
+    end
+
+    private
+    def calc_open_pull_time(pull)
+      @pull_open_time << (DateTime.now.to_i - pull.created_at.to_datetime.to_i)/60/60/24
+    end
+  end
+end

data/lib/project-health/reports.rb

@@ -0,0 +1,2 @@
+require 'project-health/report/basic'
+require 'project-health/report/pull_requests'

data/lib/project-health/version.rb

@@ -0,0 +1,3 @@
+module ProjectHealth
+  VERSION = "0.0.1"
+end

data/lib/project-health.rb

@@ -0,0 +1,13 @@
+require 'project-health/version'
+require 'project-health/config'
+require 'project-health/reports'
+require 'project-health/project'
+
+module ProjectHealth
+  class << self
+    include Config
+    def new(*args)
+      ProjectHealth::Project.new(*args)
+    end
+  end
+end

data/project-health.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'project-health/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "project-health"
+  gem.version       = ProjectHealth::VERSION
+  gem.authors       = ["Serg Podtynnyi"]
+  gem.email         = ["serg@podtynnyi.com"]
+  gem.description   = %q{Library for calculating project health report and analysis based on GitHub Activity data}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/shtirlic/project-health"
+
+  gem.add_dependency "octokit", "~> 1.0"
+  gem.add_dependency "activesupport", "~> 3.2.8"
+  gem.add_dependency "hirb", "~> 0.7"
+
+  gem.executables   = "project-health"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: project-health
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Serg Podtynnyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Library for calculating project health report and analysis based on GitHub
+  Activity data
+email:
+- serg@podtynnyi.com
+executables:
+- project-health
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/project-health
+- lib/project-health.rb
+- lib/project-health/config.rb
+- lib/project-health/project.rb
+- lib/project-health/report/basic.rb
+- lib/project-health/report/pull_requests.rb
+- lib/project-health/reports.rb
+- lib/project-health/version.rb
+- project-health.gemspec
+homepage: https://github.com/shtirlic/project-health
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Library for calculating project health report and analysis based on GitHub
+  Activity data
+test_files: []