git-health-check 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Snape
+
+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,37 @@
+# Git Health Check
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'git-health-check'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-health-check
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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
+
+# To Do:
+
+1. add timings
+2. add CLI arguments
+3. improve logic
+4. improve reporting
+5. use Thor instead of OptionParser

data/Rakefile

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

data/bin/ghc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'git-health-check'
+
+exit GitHealthCheck::Cli::Application.new(ARGV).execute

data/git-health-check.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-health-check/version'
+
+Gem::Specification.new do |gem|
+  gem.name = "git-health-check"
+  gem.version = GitHealthCheck::VERSION
+  gem.authors = ["Ben Snape"]
+  gem.email = ["bsnape@gmail.com"]
+  gem.description = %q{Git Health Check}
+  gem.summary = %q{Git Health Check}
+  gem.homepage = "http://wwww.bensnape.com"
+
+  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"]
+
+  gem.add_dependency("ruport")
+  gem.add_development_dependency("rake")
+
+end

data/lib/git-health-check.rb

@@ -0,0 +1,11 @@
+require "git-health-check/version"
+require 'git-health-check/history'
+require 'git-health-check/working_copy'
+require 'git-health-check/report'
+require 'git-health-check/git_lib'
+require 'git-health-check/packfile'
+require 'git-health-check/cli/git_health_check_command'
+require 'git-health-check/cli/application'
+require 'git-health-check/cli/options'
+require 'git-health-check/cli/version_command'
+require 'git-health-check/cli/help_command'

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

@@ -0,0 +1,35 @@
+module GitHealthCheck
+  module Cli
+
+    class Application
+
+      SUCCESS = 0
+      ERROR = 1
+
+      def initialize(argv)
+        @options = GitHealthCheck::Cli::Options.new(argv)
+        @status = SUCCESS
+      end
+
+      def execute
+        begin
+          cmd = @options.parse
+          cmd.execute(self)
+        rescue Exception => error
+          $stderr.puts "Error: #{error}"
+          @status = ERROR
+        end
+        @status
+      end
+
+      def output(text)
+        print text
+      end
+
+      def report_success
+        @status
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'ruport'
+
+module GitHealthCheck
+  module Cli
+
+    class GitHealthCheckCommand
+
+      def initialize(parser, threshold = 0.5)
+        @threshold = threshold
+        @parser = parser
+        @repository = Dir.pwd
+      end
+
+      def execute(view)
+        history = GitHealthCheck::History.new(@repository, 'HEAD', @threshold)
+        working_copy = GitHealthCheck::WorkingCopy.new @repository
+        packfile = GitHealthCheck::Packfile.new(@repository)
+        packfile.packfile_stats
+
+        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")
+        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] }
+        history_output.each { |sha, size, path, where, who| history_report << [sha, size, path, where, who] }
+
+        report = GitHealthCheck::Report.new(working_copy_report.to_html, history_report.to_html, packfile)
+        report.create
+
+        view.report_success
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module GitHealthCheck
+  module Cli
+
+    class HelpCommand < GitHealthCheckCommand
+
+      def initialize(parser)
+        @parser = parser
+      end
+
+      def execute(view)
+        view.output(@parser.to_s)
+        view.report_success
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'optparse'
+
+module GitHealthCheck
+  module Cli
+
+    class Options
+
+      def initialize(argv)
+        @argv = argv
+        @parser = OptionParser.new
+        @command_class = GitHealthCheckCommand
+        set_parser_options
+      end
+
+      def banner
+        return <<EOB
+Usage: ghc [option]
+
+Output metrics for your Git repository.
+
+Examples:
+    ghc
+    ghc -t 10
+    ghc -t 0.2
+
+EOB
+      end
+
+      def set_parser_options
+        @parser.banner = banner
+
+        @parser.separator "Options:"
+
+        @parser.on("-v", "--version", "Displays the gem version") { @command_class = VersionCommand }
+
+        @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|
+          @threshold = n
+        end
+      end
+
+      def parse
+        @parser.parse!(@argv)
+        @threshold ? @command_class.new(@parser, @threshold) : @command_class.new(@parser)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module GitHealthCheck
+  module Cli
+
+    class VersionCommand < GitHealthCheckCommand
+
+      def execute(view)
+        view.output("Git-Health-Check Version: #{GitHealthCheck::VERSION}\n")
+        view.report_success
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module GitHealthCheck
+  class GitLib
+
+    def initialize(repository_path)
+      Dir.chdir repository_path
+    end
+
+    def get_commit_author(commit_sha)
+      `git log #{commit_sha} -n 1 | grep Author | cut -f 2- -d ' '`.chomp
+    end
+
+    def get_commit_details(commit_sha)
+      `git show -s #{commit_sha} --format='%h: %cr'`.chomp
+    end
+
+    def get_pack_number
+      `ls .git/objects/pack/pack-*.idx 2> /dev/null | wc -l`.to_i
+    end
+
+    def get_status
+      `git status`
+    end
+
+    def filesystem_check
+      `git fsck --full --strict`
+    end
+
+    def garbage_collection
+      `git gc`
+    end
+
+    def repack
+      `git repack -a -d -f --depth=250 --window=250` # better than gc --aggressive
+                                                     # http://metalinguist.wordpress.com/2007/12/06/the-woes-of-git-gc-aggressive-and-how-git-deltas-work/
+    end
+
+    def count_objects
+      `git count-objects -v`
+    end
+
+  end
+end

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

@@ -0,0 +1,41 @@
+# Thanks to mislav
+#
+# http://stackoverflow.com/questions/298314/find-files-in-git-repo-over-x-megabytes-that-dont-exist-in-head
+module GitHealthCheck
+
+  class History
+
+    MEGABYTE = 1000 ** 2
+
+    def initialize(repository, head = 'HEAD', threshold = 0.1)
+      @head = head
+      @bytes_threshold = threshold.to_f * MEGABYTE
+      Dir.chdir repository
+      @git_lib = GitHealthCheck::GitLib.new repository
+    end
+
+    def search
+
+      big_files = {}
+
+      # list commit objects in chronological order
+      IO.popen("git rev-list #@head", 'r') do |rev_list|
+        rev_list.each_line do |commit|
+          # list contents of the tree object
+          `git ls-tree -zrl #{commit.chomp!}`.split("\0").each do |object|
+            bits, type, sha, size, path = object.split(/\s+/, 5)
+            size = size.to_i
+            big_files[sha] = [path, size, commit] if size >= @bytes_threshold
+          end
+        end
+      end
+
+      big_files.map do |sha, (path, size, commit_sha)|
+        where = @git_lib.get_commit_details commit_sha
+        who = @git_lib.get_commit_author commit_sha
+        [sha, size.to_f / MEGABYTE, path, where, who]
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,25 @@
+module GitHealthCheck
+  class Packfile
+
+    attr_reader :count
+    attr_reader :size
+    attr_reader :in_pack
+    attr_reader :pack_count
+    attr_reader :size_of_pack
+    attr_reader :prune_packable
+    attr_reader :garbage
+
+    def initialize(repository)
+      @repository = repository
+      @git_lib = GitHealthCheck::GitLib.new repository
+    end
+
+    def packfile_stats
+      stats = @git_lib.count_objects
+      @count, @size, @in_pack, @pack_count, @size_of_pack, @prune_packable, @garbage = stats.split("\n").map do |stat|
+        stat.scan /\d+/
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'erb'
+
+module GitHealthCheck
+
+  class Report
+
+    def initialize(working_copy, history, packfile)
+      @working_copy = working_copy
+      @history = history
+      @packfile = packfile
+      @report_directory = Dir.pwd + "/healthcheck"
+      @repository = Dir.pwd
+    end
+
+    def get_binding
+      binding
+    end
+
+    def get_template
+      File.read(File.dirname(__FILE__) + "/report/report.erb")
+    end
+
+    def create
+      rhtml = ERB.new(get_template)
+      output = rhtml.result(get_binding)
+
+      Dir.mkdir @report_directory unless File.directory? @report_directory
+
+      File.open(@report_directory + "/report.html", "w+") do |f|
+        f.write output
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Git Health Check</title>
+
+  <style type="text/css">
+      html {
+      }
+
+      body {
+          background: none repeat scroll 0 0 #FFFFFF;
+          color: #000000;
+          font-family: tahoma, verdana, arial, sans-serif;
+          font-size: 80%;
+          line-height: 1.5em;
+          margin: 10px;
+          padding: 0;
+      }
+
+      a {
+          color: #0254D0;
+          text-decoration: none;
+      }
+
+      h1, h2, h3 {
+          color: #000000;
+          letter-spacing: 0;
+      }
+
+      h1 {
+          font-size: 24px;
+      }
+
+      h2 {
+          font-size: 20px;
+          margin: 10px 27px 15px 0;
+          padding: 20px 0 2px;
+      }
+
+      h3 {
+          font-size: 16px;
+      }
+
+      #history {
+          padding: 0 0 0 20px;
+      }
+
+      #working-copy {
+          padding: 0 0 0 20px;
+      }
+  </style>
+</head>
+<body>
+<h1>Git Health Check Report Summary for <%= @repository %></h1>
+
+<hr>
+
+<div id="packfile-stats">
+  <h2>Packfile Statistics</h2>
+  <ul>
+    <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' %>
+      <% else %>
+          <%= 'kB' %>
+      <% end %>
+    </li>
+  </ul>
+</div>
+
+<div id="repository-size">
+
+  <h2>Repository Size</h2>
+
+  <div id="working-copy">
+
+    <h3>Working Copy</h3>
+
+    <p>This metric inspects your repository's <a href="http://git-scm.com/book/en/Git-Internals-Packfiles">packfile</a>
+      contents via its index to identify the <em>n</em> (default 10) largest objects - and consequently the
+      <strong>largest files</strong> - in your working copy.</p> <br>
+
+    <p><%= @working_copy %></p>
+
+  </div>
+
+  <div id="history">
+    <h3>History</h3>
+
+    <p>This metric thoroughly inspects your repository's history and identifies the largest files over a configurable
+      threshold (defaults at 0.5 MB) that have been committed in the past <strong>but are
+      no longer part of the working copy</strong>.</p> <br>
+
+    <p><%= @history %></p>
+  </div>
+</div>
+
+</body>
+</html>

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

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

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

@@ -0,0 +1,40 @@
+module GitHealthCheck
+
+  class WorkingCopy
+
+    def initialize(repository)
+      @repository = repository
+      @git_lib = GitHealthCheck::GitLib.new repository
+    end
+
+    def fast_find_in_working_copy(number=10)
+      raise 'no packs found' if @git_lib.get_pack_number == 0
+      objects = `git verify-pack -v .git/objects/pack/pack-*.idx | grep -E 'tree|blob' | sort -k4nr`
+
+      objects = objects.split("\n")
+
+      test = {}
+
+      objects.each do |object|
+        break if test.size == number
+        sha = object.match(/^\w+/)[0]
+        #path = `git rev-list --all --objects | grep #{sha} | cut -f 2 -d ' '`.chomp
+        path = `git rev-list --all --objects | grep #{sha}`.match(/\w+\s(.*)/)[1]
+        # an empty path means you need to do a garbage collection
+        next unless File.exist?("#@repository/#{path}")
+
+        sha, type, size, size_in_pack, offset = object.split
+
+        # convert from byte to kilobyte
+        size = (size.to_f / 1024).round 2
+        size_in_pack = (size_in_pack.to_f / 1024).round 2
+
+        test[sha] = [size, size_in_pack, path]
+      end
+
+      test
+    end
+
+
+  end
+end

data/test_client.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: git-health-check
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Snape
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Git Health Check
+email:
+- bsnape@gmail.com
+executables:
+- ghc
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ghc
+- git-health-check.gemspec
+- lib/git-health-check.rb
+- lib/git-health-check/cli/application.rb
+- lib/git-health-check/cli/git_health_check_command.rb
+- lib/git-health-check/cli/help_command.rb
+- lib/git-health-check/cli/options.rb
+- lib/git-health-check/cli/version_command.rb
+- lib/git-health-check/git_lib.rb
+- lib/git-health-check/history.rb
+- lib/git-health-check/packfile.rb
+- lib/git-health-check/report.rb
+- 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: 
+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: Git Health Check
+test_files: []