git_fame 0.1.0

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/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/fixtures/gash"]
+	path = spec/fixtures/gash
+	url = git://github.com/water/gash.git

data/.rspec

@@ -0,0 +1,5 @@
+--color
+-fs
+-Ilib
+-Ispec
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in git_fame.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Linus Oleander
+
+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,115 @@
+# GitFame
+
+Who did what in your project?
+
+## Output
+
+```
+Total number of files: 2,053
+Total number of lines: 63,132
+Total number of commits: 4,330
+
++------------------------+--------+---------+-------+--------------------+
+| name                   | loc    | commits | files | percent            |
++------------------------+--------+---------+-------+--------------------+
+| Johan Sørensen         | 22,272 | 1,814   | 414   | 35.3 / 41.9 / 20.2 |
+| Marius Mathiesen       | 10,387 | 502     | 229   | 16.5 / 11.6 / 11.2 |
+| Jesper Josefsson       | 9,689  | 519     | 191   | 15.3 / 12.0 / 9.3  |
+| Ole Martin Kristiansen | 6,632  | 24      | 60    | 10.5 / 0.6 / 2.9   |
+| Linus Oleander         | 5,769  | 705     | 277   | 9.1 / 16.3 / 13.5  |
+| Fabio Akita            | 2,122  | 24      | 60    | 3.4 / 0.6 / 2.9    |
+| August Lilleaas        | 1,572  | 123     | 63    | 2.5 / 2.8 / 3.1    |
+| David A. Cuadrado      | 731    | 111     | 35    | 1.2 / 2.6 / 1.7    |
+| Jonas Ängeslevä        | 705    | 148     | 51    | 1.1 / 3.4 / 2.5    |
+| Diego Algorta          | 650    | 6       | 5     | 1.0 / 0.1 / 0.2    |
+| Arash Rouhani          | 629    | 95      | 31    | 1.0 / 2.2 / 1.5    |
+| Sofia Larsson          | 595    | 70      | 77    | 0.9 / 1.6 / 3.8    |
+| Tor Arne Vestbø        | 527    | 51      | 97    | 0.8 / 1.2 / 4.7    |
+| spontus                | 339    | 18      | 42    | 0.5 / 0.4 / 2.0    |
+| Pontus                 | 225    | 49      | 34    | 0.4 / 1.1 / 1.7    |
++------------------------+--------+---------+-------+--------------------+
+```
+
+## Installation
+
+`[sudo] gem install git_fame`
+
+## Usage
+
+### Console
+
+Start by navigating to a git repository.
+
+Run `git fame` to generate output as above.
+
+#### Options
+
+- `git fame --order=loc` Order table by `loc`. Available options are: `loc`, `commits` and `files`. Default is `loc`.
+- `git fame --repository=/path/to/repo` Git repository to be used. Default is the current folder.
+- `git fame --progressbar=1` Should a progressbar be visible during the calculation? Default is `1`.
+
+### Class
+
+Want to work with the data before printing it?
+
+#### Constructor arguments
+
+- **repository** (String) Path to repository.
+- **sort** (String) What should #authors be sorted by? Available options are: `loc`, `commits` and `files`. Default is `loc`.
+- **progressbar** (Boolean) Should a progressbar be shown during the calculation? Default is `false`.
+
+``` ruby
+repository = GitFame::Base.new({
+  sort: "loc", 
+  repository: "/tmp/repo",
+  progressbar: false
+})
+```
+
+#### Print table to console
+
+`repository.pretty_puts`
+
+### Statistics
+
+#### GitFame
+
+- `repository.loc` (Fixnum) Total number of lines.
+- `repository.commits` (Fixnum) Total number of commits.
+- `repository.files` (Fixnum) Total number of files.
+- `repository.authors` (Array< Author >) All authors.
+
+#### Author
+
+`author = repository.authors.first`
+
+- Formated
+  - `author.loc` (String) Number of lines.
+  - `author.commits` (String) Number of commits.
+  - `author.files` (String) Number of files changed.
+- Non formated
+  - `author.percent` (String) Percent of total (loc/commits/files)
+  - `author.raw_loc` (Fixnum) Number of lines.
+  - `author.raw_commits` (Fixnum) Number of commits.
+  - `author.raw_files` (Fixnum) Number of files changed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+
+1. Download fixtures (`spec/fixtures`) using `git submodule update --init`.
+2. Run rspec using `rspec spec`.
+
+## Requirements
+
+*GitFame* is tested in *OS X 10.7.4* using Ruby *1.9.2*.
+
+## License
+
+*GitFame* is released under the *MIT license*.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/git-fame

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby -w
+
+require "git_fame"
+require "trollop"
+
+sort = ["name", "commits", "loc", "files"]
+opts = Trollop::options do
+  version "git-fame #{GitFame::VERSION} (c) 2012 Linus Oleander"
+  opt :repository, "What git repository should be used?", default: "."
+  opt :sort, "What should the printed table be sorted by? #{sort.join(", ")}", default: "loc", type: String
+  opt :progressbar, "Show progressbar during calculation", default: 1, type: Integer
+end
+
+Trollop::die :repository, "is not a git repository" unless GitFame::Base.git_repository?(opts[:repository])
+Trollop::die :sort, "must be one of the following; #{sort.join(", ")}" unless sort.include?(opts[:sort])
+GitFame::Base.new({
+  repository: opts[:repository],
+  progressbar: opts[:progressbar] == 1,
+  sort: opts[:sort]
+}).pretty_puts

data/git_fame.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/git_fame/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Linus Oleander"]
+  gem.email         = ["linus@oleander.nu"]
+  gem.description   = %q{Generates some awesome stats from git-blame}
+  gem.summary       = %q{
+Generates some awesome stats from git-blame
+
+A Ruby wrapper for git-blame.
+Generates data like:
+- Number of files changed by a user
+- Number of commits by user
+- Lines of code by a user
+  }
+  
+  gem.homepage      = "https://github.com/oleander/git-fame-rb"
+
+  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.name          = "git_fame"
+  gem.require_paths = ["lib"]
+  gem.version       = GitFame::VERSION
+
+  gem.add_dependency("progressbar")
+  gem.add_dependency("trollop")
+  gem.add_dependency("hirb")
+  gem.add_dependency("mimer_plus")
+  
+  gem.add_development_dependency("rspec")
+  gem.required_ruby_version = "~> 1.9.0"
+end

data/lib/git_fame.rb

@@ -0,0 +1,9 @@
+$-v = false
+require "git_fame/version"
+require "progressbar"
+require "mimer_plus"
+require "hirb"
+require "git_fame/helper"
+require "git_fame/author"
+require "git_fame/silent_progressbar"
+require "git_fame/base"

data/lib/git_fame/author.rb

@@ -0,0 +1,30 @@
+module GitFame
+  class Author
+    include GitFame::Helper
+    attr_accessor :name, :raw_files, :raw_commits, :raw_loc, :files_list
+    #
+    # @args Hash
+    #
+    def initialize(args = {})
+      @raw_loc = 0
+      @raw_commits = 0
+      @raw_files = 0
+      args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
+    end
+
+    #
+    # @return String Percent of total
+    # @format loc / commits / files
+    #
+    def percent
+      "%.1f / %.1f / %.1f" % [:loc, :commits, :files].
+        map{ |w| (send("raw_#{w}") / @parent.send(w).to_f) * 100 }
+    end
+
+    [:commits, :files, :loc].each do |method|
+      define_method(method) do
+        number_with_delimiter(send("raw_#{method}"))
+      end
+    end
+  end
+end

data/lib/git_fame/base.rb

@@ -0,0 +1,150 @@
+module GitFame
+  class Base
+    include GitFame::Helper
+
+    #
+    # @args[:repository] String Absolute path to git repository
+    # @args[:sort] String What should #authors be sorted by?
+    #
+    def initialize(args)
+      @sort = "loc"
+      @progressbar = false
+      args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
+      @authors = {}
+      @file_authors = Hash.new { |h,k| h[k] = {} }
+    end
+
+    #
+    # Generates pretty output
+    #
+    def pretty_puts
+      extend Hirb::Console
+      Hirb.enable({pager: false})
+      puts "\nTotal number of files: #{number_with_delimiter(files)}"
+      puts "Total number of lines: #{number_with_delimiter(loc)}"
+      puts "Total number of commits: #{number_with_delimiter(commits)}\n"
+      table(authors, fields: [:name, :loc, :commits, :files, :percent])
+    end
+
+    #
+    # @return Fixnum Total number of files
+    #
+    def files
+      populate.instance_variable_get("@files").count
+    end
+
+    #
+    # @return Fixnum Total number of commits
+    #
+    def commits
+      authors.inject(0){ |result, author| author.raw_commits + result }
+    end
+
+    #
+    # @return Fixnum Total number of lines
+    #
+    def loc
+      populate.authors.inject(0){ |result, author| author.raw_loc + result }
+    end
+
+    #
+    # @return Array<Author> A list of authors
+    #
+    def authors
+      authors = populate.instance_variable_get("@authors").values
+      @sort ? authors.sort_by do |author| 
+        if @sort == "name"
+          author.send(@sort) 
+        else
+          -1 * author.send("raw_#{@sort}")
+        end
+      end : authors
+    end
+
+    #
+    # @return Boolean Is the given @dir a git repository?
+    # @dir Path (relative or absolute) to git repository
+    #
+    def self.git_repository?(dir)
+      Dir.exists?(File.join(dir, ".git"))
+    end
+
+    private
+    #
+    # @command String Command to be executed inside the @repository path
+    #
+    def execute(command)
+      Dir.chdir(@repository) do
+        return `#{command}`
+      end
+    end
+
+    #
+    # @author String Author
+    # @args Hash Argument that should be set in @return
+    # @return Author
+    #
+    def update(author, args)
+      fetch(author).tap do |found|
+        args.keys.each do |key|
+          found.send("#{key}=", args[key])
+        end
+      end
+    end
+
+    #
+    # @return Author
+    # @author String
+    #
+    def fetch(author)
+      @authors[author] ||= Author.new({name: author, parent: self})
+    end
+
+    #
+    # @return GitFame
+    #
+    def populate
+      @_pop ||= lambda {
+        @files = execute("git ls-files").split("\n")
+        progressbar = SilentProgressbar.new("Blame", @files.count, @progressbar)
+        @files.each do |file|
+          progressbar.inc
+          if type = Mimer.identify(File.join(@repository, file)) and not type.mime_type.match(/binary/)
+            begin
+              execute("git blame '#{file}'").scan(/\((.+?)\s+\d{4}-\d{2}-\d{2}/).each do |author|
+                fetch(author.first).raw_loc += 1
+                @file_authors[author.first][file] ||= 1
+              end
+            rescue ArgumentError; end # Encoding error
+          end
+        end
+
+        execute("git shortlog -se").split("\n").map do |l| 
+          _, commits, u = l.match(%r{^\s*(\d+)\s+(.+?)\s+<.+?>}).to_a
+          user = fetch(u)
+
+          # Has this user been updated before?
+          if user.raw_commits.zero?
+            update(u, {
+              raw_commits: commits.to_i, 
+              raw_files: @file_authors[u].keys.count, 
+              files_list: @file_authors[u].keys
+            })
+          else
+            # Calculate the number of files edited by users
+            files = (user.files_list + @file_authors[u].keys).uniq
+            update(u, {
+              raw_commits: commits.to_i + user.raw_commits, 
+              raw_files: files.count, 
+              files_list: files
+            })
+          end
+        end
+
+        progressbar.finish
+
+      }.call
+      return self
+    end
+  end
+end

data/lib/git_fame/helper.rb

@@ -0,0 +1,11 @@
+module GitFame
+  module Helper
+    #
+    # @value Fixnum Value to be formated
+    # @return String Formated according ActionView::Helpers::NumberHelper.number_with_delimiter
+    #
+    def number_with_delimiter(value)
+      value.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,")
+    end
+  end
+end

data/lib/git_fame/silent_progressbar.rb

@@ -0,0 +1,11 @@
+class SilentProgressbar < ProgressBar
+  #
+  # @name String Name for progressbar
+  # @steps Fixnum Total number of steps
+  # @active Should progressbar be visible?
+  #
+  def initialize(name, steps, active = false)
+    out =  active ? $stdout : File.new("/dev/null", "w")
+    super(name, steps, out)
+  end
+end

data/lib/git_fame/version.rb

@@ -0,0 +1,3 @@
+module GitFame
+  VERSION = "0.1.0"
+end

data/spec/git_fame_spec.rb

@@ -0,0 +1,96 @@
+describe GitFame::Base do
+  let(:subject) { GitFame::Base.new({repository: @repository}) }
+  describe "#authors" do
+    it "should have a list of authors" do
+      should have(3).authors
+    end
+
+    describe "author" do
+      let(:author) { subject.authors.last }
+      it "should have a bunch of commits" do
+        author.raw_commits.should eq(23)
+      end
+
+      it "should respond to name" do
+        author.name.should eq("Linus Oleander")
+      end
+
+      it "should have a number of locs" do
+        author.raw_loc.should eq(136)
+      end
+
+      it "should have a number of files" do
+        author.raw_files.should eq(7)
+      end
+
+      it "should have some percentage" do
+        author.percent.should eq("12.6 / 32.9 / 43.8")
+      end
+    end
+    describe "format" do
+      let(:author) { GitFame::Author.new({raw_commits: 12345, raw_files: 6789, raw_loc: 1234})}
+      it "should format #commits" do
+        author.commits.should eq("12,345")
+      end
+
+      it "should format #files" do
+        author.files.should eq("6,789")
+      end
+
+      it "should format #loc" do
+        author.loc.should eq("1,234")
+      end
+    end
+  end
+
+  describe "total" do
+    it "should respond to #loc, #commits and #files" do
+      subject.files.should eq(16)
+      subject.commits.should eq(70)
+      subject.loc.should eq(1082)
+    end
+  end
+
+  describe "sort" do
+    it "should be able to sort #authors by name" do
+      authors = GitFame::Base.new({repository: @repository, sort: "name"}).authors
+      authors.map(&:name).should eq(["7rans", "Linus Oleander", "Magnus Holm"])
+    end
+
+    it "should be able to sort #authors by commits" do
+      authors = GitFame::Base.new({repository: @repository, sort: "commits"}).authors
+      authors.map(&:name).should eq(["Magnus Holm", "Linus Oleander", "7rans"])
+    end
+
+    it "should be able to sort #authors by files" do
+      authors = GitFame::Base.new({repository: @repository, sort: "files"}).authors
+      authors.map(&:name).should eq(["7rans", "Linus Oleander", "Magnus Holm"])
+    end
+  end
+
+  describe "#pretty_print" do
+    it "should print" do
+      lambda {
+        2.times { subject.pretty_puts }
+      }.should_not raise_error
+    end
+  end
+
+  describe ".git_repository?" do
+    it "should know if a folder is a git repository [absolute path]" do
+      GitFame::Base.git_repository?(@repository).should be_true
+    end
+
+    it "should know if a folder exists or not [absolute path]" do
+      GitFame::Base.git_repository?("/f67c2bcbfcfa30fccb36f72dca22a817").should be_false
+    end
+
+    it "should know if a folder is a git repository [relative path]" do
+      GitFame::Base.git_repository?("spec/fixtures/gash").should be_true
+    end
+
+    it "should know if a folder exists or not [relative path]" do
+      GitFame::Base.git_repository?("f67c2bcbfcfa30fccb36f72dca22a817").should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rspec"
+require "git_fame"
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+  config.before(:all) do 
+    @repository = File.join(File.dirname(File.dirname(__FILE__)), "spec/fixtures/gash")
+    Dir.chdir(@repository) do
+      `git checkout 7ab01bc5a720`
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: git_fame
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Linus Oleander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: &70317512929600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317512929600
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: &70317512928780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317512928780
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: &70317512926760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317512926760
+- !ruby/object:Gem::Dependency
+  name: mimer_plus
+  requirement: &70317512919640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317512919640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70317512919040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70317512919040
+description: Generates some awesome stats from git-blame
+email:
+- linus@oleander.nu
+executables:
+- git-fame
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/git-fame
+- git_fame.gemspec
+- lib/git_fame.rb
+- lib/git_fame/author.rb
+- lib/git_fame/base.rb
+- lib/git_fame/helper.rb
+- lib/git_fame/silent_progressbar.rb
+- lib/git_fame/version.rb
+- spec/git_fame_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/oleander/git-fame-rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: ! 'Generates some awesome stats from git-blame  A Ruby wrapper for git-blame.
+  Generates data like: - Number of files changed by a user - Number of commits by
+  user - Lines of code by a user'
+test_files:
+- spec/git_fame_spec.rb
+- spec/spec_helper.rb