git-health-check 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,44 @@
 # Git Health Check
 
-TODO: Write a gem description
+This gem outputs a set of metrics for your Git repository which allows you to monitor its size over its lifetime.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem:
 
-    gem 'git-health-check'
+    $ gem install git-health-check
 
-And then execute:
+## Usage
 
-    $ bundle
+Currently, the gem is best utilised as a post-build step and possibly outside of your push-triggered CI job depending on the size of your repository. Execution should take a couple of seconds for most people but for very large repositories with many thousands of commits - e.g. 1GB+ - it could take 10-15 minutes.
 
-Or install it yourself as:
+ To perform a default run (the history threshold is set at 0.5MB):
 
-    $ gem install git-health-check
+    $ ghc
 
-## Usage
+ To specify a threshold value (in MB) on the history reporting:
+
+    $ ghc -t 2
+
+ A report is generated at `healthcheck/report.html`
+
+ To view a list of available commands:
+
+    $ ghc -h
+
+    Usage: ghc [option]
+
+    Output metrics for your Git repository.
+
+    Examples:
+        ghc
+        ghc -t 10
+        ghc -t 0.2
 
-TODO: Write usage instructions here
+    Options:
+        -v, --version                    Displays the gem version
+        -h, --help                       Displays this help message
+        -t, --threshold THRESHOLD        Specify history size threshold in MB (default 0.5)
 
 ## Contributing
 
@@ -31,7 +51,10 @@ TODO: Write usage instructions here
 # To Do:
 
 1. add timings
-2. add CLI arguments
-3. improve logic
-4. improve reporting
-5. use Thor instead of OptionParser
+2. add further CLI arguments (e.g. `-n` for number of results)
+3. improve general logic - especially git_health_check_command.rb
+4. improve reporting - something better than ERB
+5. explore the use of Thor instead of OptionParser
+6. output number of commits - `git shortlog | grep -E '^[ ]+\w+' | wc -l` *or* `git log --pretty=format:'' | wc -l`
+7. output total number of commits across all branches - `git rev-list --all | wc -l`
+8. output contributors - `git shortlog | grep -E '^[^ ]'` *or* `git shortlog -n -s`

data/lib/git-health-check/cli/git_health_check_command.rb

@@ -20,7 +20,7 @@ module GitHealthCheck
         working_copy_output = working_copy.fast_find_in_working_copy
         history_output = history.search
 
-        working_copy_report = Table("object sha", "size (KB)", "compressed (KB)", "path")
+        working_copy_report = Table("object sha", "size (kB)", "compressed (kB)", "path")
         history_report = Table("object sha", "size (MB)", "path", "commit details", "author")
 
         working_copy_output.each { |sha, (size, csize, path)| working_copy_report << [sha, size, csize, path] }

data/lib/git-health-check/cli/options.rb

@@ -35,7 +35,7 @@ EOB
 
         @parser.on("-h", "--help", "Displays this help message") { @command_class = HelpCommand }
 
-        @parser.on("-t", "--threshold THRESHOLD", Float, "Specify history size threshold in mB (default 0.5)") do |n|
+        @parser.on("-t", "--threshold THRESHOLD", Float, "Specify history size threshold in MB (default 0.5)") do |n|
           @threshold = n
         end
       end

data/lib/git-health-check/report/report.erb

@@ -61,13 +61,14 @@
     <li><strong>Number of <a href="http://git-scm.com/book/en/Git-Internals-Git-Objects">objects</a> in
       pack:</strong> <%= @packfile.pack_count[0] %></li>
 
-    <li><strong>Total packfile size: </strong><%= @packfile.size_of_pack[0] %>
-      <% if @packfile.size_of_pack[0].to_i >= 1073741824 %>
-          <%= 'gb' %>
-      <% elsif @packfile.size_of_pack[0].to_i >= 1048576 %>
-          <%= 'mb' %>
+    <li><strong>Total packfile size: </strong>
+      <% size = @packfile.size_of_pack[0].to_f %>
+      <% if size >= 1048576 %>
+          <%= size / 1048576 %> GB
+      <% elsif size >= 1024 %>
+          <%= size / 1024 %> MB
       <% else %>
-          <%= 'kB' %>
+          <%= size %> kB
       <% end %>
     </li>
   </ul>

data/lib/git-health-check/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-health-check
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruport
@@ -71,7 +71,6 @@ files:
 - lib/git-health-check/report/report.erb
 - lib/git-health-check/version.rb
 - lib/git-health-check/working_copy.rb
-- test_client.rb
 homepage: http://wwww.bensnape.com
 licenses: []
 post_install_message: 

data/test_client.rb

@@ -1,6 +0,0 @@
-require 'git-health-check'
-
-ARGV << '-t'
-ARGV << '10'
-
-GitHealthCheck::Cli::Application.new(ARGV).execute