project-health 0.0.2 → 0.0.3

data/README.md

@@ -76,7 +76,7 @@ require 'pp'
 require 'project-health'
 
 # Set GitHub username/password to increase API rates
-ProjectHealth.config do |c|
+ProjectHealth.configure do |c|
   #c.login = ''  # use your github name
   #c.password = '' # use your github password
 end

data/bin/project-health

@@ -15,11 +15,6 @@ end
 
 def show_project_stats(repo)
   extend Hirb::Console
-
-  ProjectHealth.config do |c|
-    c.login    = ENV["GITHUB_USERNAME"]
-    c.password = ENV["GITHUB_PASSWORD"]
-  end
   project = ProjectHealth.new(repo)
   puts "Project Health Version: #{ProjectHealth::VERSION}"
   puts
@@ -50,7 +45,7 @@ rescue Interrupt
   `stty icanon echo`
   puts "Command cancelled."
 rescue => error
-  puts error
+  p error
   exit(1)
 end
 

data/lib/project-health.rb

@@ -6,7 +6,10 @@ require 'project-health/project'
 module ProjectHealth
   class << self
     def new(*args)
-      ProjectHealth::Project.new(*args)
+      Project.new(*args)
+    end
+    def configure(&block)
+      Project.configure(&block)
     end
   end
 end

data/lib/project-health/config.rb

@@ -8,6 +8,10 @@ class Numeric
 end
 
 module ProjectHealth
-  include ActiveSupport::Configurable
-  config_accessor :login, :password
+  class Project
+    include ActiveSupport::Configurable
+    config_accessor :login, :password
+    self.login = ENV["GITHUB_USERNAME"]
+    self.password = ENV["GITHUB_PASSWORD"]
+  end
 end

data/lib/project-health/project.rb

@@ -4,13 +4,14 @@ module ProjectHealth
     attr_reader :name
 
     def initialize(name)
-      @oct = Octokit::Client.new(:auto_traversal => true,
-                                 :per_page => 500, :login => ProjectHealth.config.login,
-                                 :password=> ProjectHealth.config.password)
+      @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
+      add_report :issues
     end
 
     def add_report(report)

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

@@ -0,0 +1,78 @@
+module ProjectHealth
+  class IssuesReport
+
+    attr_reader :open, :closed, :all
+
+    def initialize(oct, name)
+      @open_times = []
+      @open   = oct.issues(name, {state: :open}).tap{|x| x.each(&method(:calc_open_issue_time)) }.count
+      @closed = oct.issues(name, {state: :closed}).count
+      @all    = open + closed
+    end
+
+    def stats
+      {
+        "Issues"=>
+        {
+          'All'      => all,
+          'Open'     => open,
+          'Closed'   => closed,
+          'Open %'   => open_percent.to_f.round(2),
+          'Closed %' => closed_percent.to_f.round(2),
+          'Open/Closed % ratio' => open_closed_ratio.to_f.round(2),
+          'Open time in days' => open_time,
+          'Min open time in days' => min_open_time,
+          'Max open time in days' => max_open_time,
+          'Average days issue is opened' => average_open_time,
+          'Health' => health
+        }
+      }.delete_if{|k,v| v.kind_of?(Float) && v.nan?}
+    end
+
+    def open_percent
+      open.percent_of all
+    end
+
+    def closed_percent
+      closed.percent_of all
+    end
+
+    def open_closed_ratio
+      result = open_percent / closed_percent
+    end
+
+    def open_time
+      @open_times.inject(:+) || 0
+    end
+
+    def average_open_time
+      open_time / open if open > 0
+    end
+
+    def min_open_time
+      @open_times.min
+    end
+
+    def max_open_time
+      @open_times.max
+    end
+
+    def health
+      case open_closed_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_issue_time(issue)
+      @open_times << (DateTime.now.to_i - issue.created_at.to_datetime.to_i)/60/60/24
+    end
+  end
+end

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

@@ -1,64 +1,64 @@
 module ProjectHealth
   class PullRequestsReport
 
-    attr_reader :pulls_open, :pulls_closed, :pulls_all
+    attr_reader :open, :closed, :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
+      @open_times = []
+      @open   = oct.pull_requests(name, :open).tap{|x| x.each(&method(:calc_open_pull_time)) }.count
+      @closed = oct.pull_requests(name, :closed).count
+      @all    = open + 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
+          'All'      => all,
+          'Open'     => open,
+          'Closed'   => closed,
+          'Open %'   => open_percent.to_f.round(2),
+          'Closed %' => closed_percent.to_f.round(2),
+          'Open/Closed % ratio' => open_closed_ratio.to_f.round(2),
+          'Open time in days' => open_time,
+          'Min open time in days' => min_open_time,
+          'Max open time in days' => max_open_time,
+          'Average days request is opened' => average_open_time,
+          'Health' => health
         }
       }.delete_if{|k,v| v.kind_of?(Float) && v.nan?}
     end
 
-    def pulls_open_percent
-      pulls_open.percent_of(pulls_all)
+    def open_percent
+      open.percent_of all
     end
 
-    def pulls_closed_percent
-      pulls_closed.percent_of(pulls_all)
+    def closed_percent
+      closed.percent_of all
     end
 
-    def open_closed_pull_ratio
-      result = pulls_open_percent / pulls_closed_percent
+    def open_closed_ratio
+      result = open_percent / closed_percent
     end
 
-    def pull_open_time
-      @pull_open_time.inject(:+)
+    def open_time
+      @open_times.inject(:+) || 0
     end
 
-    def pull_average_open_time
-      pull_open_time / pulls_open
+    def average_open_time
+      open_time / open if open > 0
     end
 
-    def pull_min_open_time
-      @pull_open_time.min
+    def min_open_time
+      @open_times.min
     end
 
-    def pull_max_open_time
-      @pull_open_time.max
+    def max_open_time
+      @open_times.max
     end
 
-    def pulls_health
-      case open_closed_pull_ratio.to_f
+    def health
+      case open_closed_ratio.to_f
       when 0..0.1
         "Good"
       when 0.1..0.2
@@ -72,7 +72,7 @@ module ProjectHealth
 
     private
     def calc_open_pull_time(pull)
-      @pull_open_time << (DateTime.now.to_i - pull.created_at.to_datetime.to_i)/60/60/24
+      @open_times << (DateTime.now.to_i - pull.created_at.to_datetime.to_i)/60/60/24
     end
   end
 end

data/lib/project-health/reports.rb

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

data/lib/project-health/version.rb

@@ -1,3 +1,3 @@
 module ProjectHealth
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: project-health
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2012-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -79,6 +79,7 @@ files:
 - lib/project-health/config.rb
 - lib/project-health/project.rb
 - lib/project-health/report/basic.rb
+- lib/project-health/report/issues.rb
 - lib/project-health/report/pull_requests.rb
 - lib/project-health/reports.rb
 - lib/project-health/version.rb
@@ -109,3 +110,4 @@ specification_version: 3
 summary: Library for calculating project health report and analysis based on GitHub
   Activity data
 test_files: []
+has_rdoc: