project-health 0.0.1 → 0.0.2

data/README.md

@@ -24,13 +24,61 @@ gem install project-health
 
 ## Usage
 
+### From command line:
+
+Set GitHub username/password to increase API rates
+
+```bash
+export GITHUB_USERNAME=username
+export GITHUB_PASSWORD=password
+```
+
+```bash
+project-health capistrano/capistrano
+```
+
+Result
+
+```
+Showing project health for capistrano/capistrano
+
+Basic
+┌─────────────┬─────────────────────────────────────┐
+│ Name        ╎ capistrano/capistrano               │
+│ Description ╎ Remote multi-server automation tool │
+│ Created     ╎ 2009-02-26T16:14:04Z                │
+│ Last push   ╎ 2012-11-09T07:48:26Z                │
+│ Language    ╎ Ruby                                │
+│ Stars       ╎ 2853                                │
+└─────────────┴─────────────────────────────────────┘
+
+Pull Requests
+┌────────────────────────────────┬───────┐
+│ All                            ╎ 142   │
+│ Open                           ╎ 8     │
+│ Closed                         ╎ 134   │
+│ Open %                         ╎ 5.63  │
+│ Closed %                       ╎ 94.37 │
+│ Open/Closed % ratio            ╎ 0.06  │
+│ Open time in days              ╎ 804   │
+│ Min open time in days          ╎ 6     │
+│ Max open time in days          ╎ 390   │
+│ Average days request is opened ╎ 100   │
+│ Health                         ╎ Good  │
+└────────────────────────────────┴───────┘
+
+```
+
+### From code:
+
 ```ruby
 require 'pp'
 require 'project-health'
 
-ProjectHealth.configure do |config|
-  #config.login = ''  # use your github name
-  #config.password = '' # use your github password
+# Set GitHub username/password to increase API rates
+ProjectHealth.config do |c|
+  #c.login = ''  # use your github name
+  #c.password = '' # use your github password
 end
 
 project = ProjectHealth.new('capistrano/capistrano')
@@ -42,7 +90,13 @@ Result
 
 ```ruby
 {"Project"=>
-  {"Name"=>"capistrano/capistrano",
+  {"Basic"=>
+    {"Name"=>"capistrano/capistrano",
+     "Description"=>"Remote multi-server automation tool",
+     "Created"=>"2009-02-26T16:14:04Z",
+     "Last push"=>"2012-11-09T07:48:26Z",
+     "Language"=>"Ruby",
+     "Stars"=>2853},
    "Pull Requests"=>
     {"All"=>142,
      "Open"=>8,
@@ -50,14 +104,13 @@ Result
      "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,
+     "Open time in days"=>804,
+     "Min open time in days"=>6,
+     "Max open time in days"=>390,
+     "Average days request is opened"=>100,
      "Health"=>"Good"}}}
 ```
 
-
 ## Contributing
 
 1. Fork it

data/bin/project-health

@@ -15,13 +15,20 @@ 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
   puts "Showing project health for #{repo}"
-  puts
-  project.stats['Project'].each{|c| table c.last}
-  puts
+  project.stats['Project'].each do |c|
+    puts
+    puts c.first
+    table(c.last, headers: false, unicode: true, description: false)
+  end
   puts
 end
 

data/lib/project-health.rb

@@ -5,7 +5,6 @@ require 'project-health/project'
 
 module ProjectHealth
   class << self
-    include Config
     def new(*args)
       ProjectHealth::Project.new(*args)
     end

data/lib/project-health/config.rb

@@ -8,10 +8,6 @@ class Numeric
 end
 
 module ProjectHealth
-  module Config
-    mattr_accessor :login, :password
-    def configure
-      yield self
-    end
-  end
+  include ActiveSupport::Configurable
+  config_accessor :login, :password
 end

data/lib/project-health/project.rb

@@ -5,8 +5,8 @@ module ProjectHealth
 
     def initialize(name)
       @oct = Octokit::Client.new(:auto_traversal => true,
-                                 :per_page => 500, :login => Config.login,
-                                 :password=> Config.password)
+                                 :per_page => 500, :login => ProjectHealth.config.login,
+                                 :password=> ProjectHealth.config.password)
       @name = name
       @reports = []
       add_report :basic

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

@@ -1,14 +1,31 @@
 module ProjectHealth
   class BasicReport
 
-    attr_reader :name
+    attr_reader :name, :title, :language, :stars,
+                :created, :last_push, :description
 
     def initialize(oct, name)
-      @name = name
+      @name        = name
+      repo         = oct.repo(name)
+      @language    = repo["language"]
+      @stars       = repo["watchers_count"]
+      @created     = repo["created_at"]
+      @last_push   = repo["pushed_at"]
+      @description = repo["description"]
     end
 
     def stats
-      { "Name" => name }
+      {
+        "Basic" =>
+        {
+          "Name" => name,
+          "Description" => description,
+          "Created" => created,
+          "Last push" => last_push,
+          "Language" => language,
+          "Stars" => stars
+        }
+       }
     end
   end
 end

data/lib/project-health/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: project-health
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: