git_fame 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f2b28facc6df4785adcfa9332d705bdb32562ef
-  data.tar.gz: 3ce0f6380d3c87b031532f60dde25f472f181276
+  metadata.gz: daa907cac405078c8f5abb7ed8fbfc88287a697c
+  data.tar.gz: 47376faa0102f406245338f2b6bd06f39759db2d
 SHA512:
-  metadata.gz: ba3c3784044e02474e25a028e32b962dd8d4322bcef7b5240e917cfa322f9c89165da9b82dc386e207c54f02793dfc7d40a8d123e535542ebdfd7fdf0e752463
-  data.tar.gz: 7668bff93367a582932ee23e9474effe9c3ac55f39546a37dd831235bfa9fc95a518e8a5cbcf9aee7bd78c4cd82599a6b25e5b8b2bc4dc037f96d6e09fec56b5
+  metadata.gz: be9bf2ff037c1d694a77b7f85cca6fac75f90d0e3020120283a03a0e0d39e987e20a7c545451f8b04a5ac9a86b8f00887fff9150b01ab816bd7d46eb0b530d5a
+  data.tar.gz: 34aa7cf88a69a5547d5b790254f4567bc06b1071f066301285f19ec2353e4878de6bd708a9cc7281bd737341f99b6f1ad87f4207137a06a11ebf3ee6168abafe

data/README.md

@@ -1,6 +1,6 @@
 # GitFame
 
-Who did what in your project?
+Pretty-print collaborators sorted by contributions.
 
 ## Output
 
@@ -10,7 +10,7 @@ Total number of lines: 63,132
 Total number of commits: 4,330
 
 +------------------------+--------+---------+-------+--------------------+
-| name                   | loc    | commits | files | percent            |
+| name                   | loc    | commits | files | distribution       |
 +------------------------+--------+---------+-------+--------------------+
 | 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 |
@@ -44,9 +44,12 @@ Run `git fame` to generate output as above.
 
 #### Options
 
+- `git fame --bytype` Should a breakout of line counts by file type be output? Default is 'false'
+- `git fame --exclude=paths/to/files,paths/to/other/files` Comma separated paths to exclude from the counts. Default is none.
 - `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`.
+- `git fame --whitespace` Ignore whitespace changes when blaming files. Default is `false`.
+- `git fame --repository=/path/to/repo` Git repository to be used. Default is the current folder.
 
 ### Class
 
@@ -57,12 +60,18 @@ Want to work with the data before printing it?
 - **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`.
+- **whitespace** (Boolean) Ignore whitespace changes when blaming files. Default is `false`.
+- **bytype** (Boolean) Should a breakout of line counts by file type be output? Default is 'false'
+- **exclude** (String) Comma separated paths to exclude from the counts. Default is none.
 
 ``` ruby
 repository = GitFame::Base.new({
-  sort: "loc", 
+  sort: "loc",
   repository: "/tmp/repo",
-  progressbar: false
+  progressbar: false,
+  whitespace: false
+  bytype: false,
+  exclude: "vendor, public/assets"
 })
 ```
 
@@ -88,10 +97,15 @@ repository = GitFame::Base.new({
   - `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.distribution` (String) Distribution (in %) between users (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.
+  - `author.file_type_counts` (Array) File types (k) and loc (v)
+
+#### A note about authors found
+
+The list of authors may include what you perceive to be duplicate people. If a git user's configured name or email address change over time, the person will appear multiple times in this list (and your repo's git history).  Git allows you to configure this using the .mailmap feature. See ````git shortlog --help```` for more information.
 
 ## Contributing
 

data/bin/git-fame

@@ -9,6 +9,9 @@ opts = Trollop::options do
   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
+  opt :whitespace, "Ignore whitespace changes", default: false
+  opt :bytype, "Group line counts by file extension (i.e. .rb, .erb, .yml)", default: false
+  opt :exclude, "Paths to exclude (comma separated)", default: "", type: String
 end
 
 Trollop::die :repository, "is not a git repository" unless GitFame::Base.git_repository?(opts[:repository])
@@ -16,5 +19,8 @@ Trollop::die :sort, "must be one of the following; #{sort.join(", ")}" unless so
 GitFame::Base.new({
   repository: opts[:repository],
   progressbar: opts[:progressbar] == 1,
-  sort: opts[:sort]
-}).pretty_puts
+  sort: opts[:sort],
+  whitespace: opts[:whitespace],
+  bytype: opts[:bytype],
+  exclude: opts[:exclude]
+}).pretty_puts

data/lib/git_fame/author.rb

@@ -1,22 +1,25 @@
 module GitFame
   class Author
     include GitFame::Helper
-    attr_accessor :name, :raw_files, :raw_commits, :raw_loc, :files_list
+    attr_accessor :name, :raw_files, :raw_commits, :raw_loc, :files_list, :file_type_counts
     #
     # @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] }
+      @raw_loc          = 0
+      @raw_commits      = 0
+      @raw_files        = 0
+      @file_type_counts = Hash.new(0)
+      args.keys.each do |name| 
+        instance_variable_set "@" + name.to_s, args[name]
+      end
     end
 
     #
-    # @return String Percent of total
     # @format loc / commits / files
+    # @return String Distribution (in %) between users
     #
-    def percent
+    def distribution
       "%.1f / %.1f / %.1f" % [:loc, :commits, :files].
         map{ |w| (send("raw_#{w}") / @parent.send(w).to_f) * 100 }
     end
@@ -26,5 +29,13 @@ module GitFame
         number_with_delimiter(send("raw_#{method}"))
       end
     end
+
+    #
+    # Intended to catch file type counts
+    #
+    def method_missing(m, *args, &block)
+      file_type_counts[m.to_s]
+    end
+
   end
-end
+end

data/lib/git_fame/base.rb

@@ -5,13 +5,21 @@ module GitFame
     #
     # @args[:repository] String Absolute path to git repository
     # @args[:sort] String What should #authors be sorted by?
+    # @args[:bytype] Boolean Should counts be grouped by file extension?
+    # @args[:exclude] String Comma-separated list of paths in the repo which should be excluded
     #
     def initialize(args)
-      @sort = "loc"
-      @progressbar = false
-      args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
-      @authors = {}
+      @sort         = "loc"
+      @progressbar  = false
+      @whitespace   = false
+      @bytype       = false
+      @exclude      = ""
+      @authors      = {}
       @file_authors = Hash.new { |h,k| h[k] = {} }
+      args.keys.each do |name| 
+        instance_variable_set "@" + name.to_s, args[name]
+      end
+      convert_exclude_paths_to_array
     end
 
     #
@@ -23,7 +31,10 @@ module GitFame
       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])
+
+      fields = [:name, :loc, :commits, :files, :distribution]
+      fields << populate.instance_variable_get("@file_extensions").uniq.sort if @bytype
+      table(authors, fields: fields.flatten)
     end
 
     #
@@ -33,6 +44,13 @@ module GitFame
       populate.instance_variable_get("@files").count
     end
 
+    #
+    # @return Array list of repo files processed
+    #
+    def file_list
+      populate.instance_variable_get("@files")
+    end
+
     #
     # @return Fixnum Total number of commits
     #
@@ -52,9 +70,9 @@ module GitFame
     #
     def authors
       authors = populate.instance_variable_get("@authors").values
-      @sort ? authors.sort_by do |author| 
+      @sort ? authors.sort_by do |author|
         if @sort == "name"
-          author.send(@sort) 
+          author.send(@sort)
         else
           -1 * author.send("raw_#{@sort}")
         end
@@ -106,35 +124,44 @@ module GitFame
     def populate
       @_pop ||= lambda {
         @files = execute("git ls-files").split("\n")
+        @file_extensions = []
+        remove_excluded_files
         progressbar = SilentProgressbar.new("Blame", @files.count, @progressbar)
+        blame_opts = @whitespace ? "-w" : ""
         @files.each do |file|
           progressbar.inc
+          if @bytype
+            file_extension = File.extname(file).sub(/\A\./,"")
+            file_extension = "unknown" if file_extension.empty?
+          end
           if type = Mimer.identify(File.join(@repository, file)) and not type.mime_type.match(/binary/)
+            @file_extensions << file_extension # only count extensions that aren't binary!
             begin
-              execute("git blame '#{file}' --line-porcelain").scan(/^author (.+)$/).each do |author|
+              execute("git blame '#{file}' #{blame_opts} --line-porcelain").scan(/^author (.+)$/).each do |author|
                 fetch(author.first).raw_loc += 1
                 @file_authors[author.first][file] ||= 1
+                fetch(author.first).file_type_counts[file_extension] += 1 if @bytype
               end
             rescue ArgumentError; end # Encoding error
           end
         end
 
-        execute("git shortlog -se").split("\n").map do |l| 
+        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, 
+              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, 
+              raw_commits: commits.to_i + user.raw_commits,
+              raw_files: files.count,
               files_list: files
             })
           end
@@ -145,5 +172,24 @@ module GitFame
       }.call
       return self
     end
+
+    #
+    # Converts @exclude argument to an array and removes leading slash
+    #
+    def convert_exclude_paths_to_array
+      @exclude = @exclude.split(",").map{|path| path.strip.sub(/\A\//, "") }
+    end
+
+    #
+    # Removes files matching paths in @exclude from @files instance variable
+    #
+    def remove_excluded_files
+      return if @exclude.empty?
+      @files = @files.map do |path|
+        next if  path =~ /\A(#{@exclude.join("|")})/
+        path
+      end.compact
+    end
+
   end
 end

data/lib/git_fame/version.rb

@@ -1,3 +1,3 @@
 module GitFame
-  VERSION = "1.0.0"
+  VERSION = "1.2.1"
 end

data/spec/git_fame_spec.rb

@@ -23,12 +23,19 @@ describe GitFame::Base do
         author.raw_files.should eq(7)
       end
 
-      it "should have some percentage" do
-        author.percent.should eq("12.6 / 32.9 / 43.8")
+      it "should have a distribution" do
+        author.distribution.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})}
+      let(:author) do 
+        GitFame::Author.new({
+          raw_commits: 12345, 
+          raw_files: 6789, 
+          raw_loc: 1234
+        })
+      end
+
       it "should format #commits" do
         author.commits.should eq("12,345")
       end
@@ -68,6 +75,22 @@ describe GitFame::Base do
     end
   end
 
+  describe "#command_line_arguments" do
+    let(:subject) { GitFame::Base.new({repository: @repository, exclude: "lib", bytype: true }) }
+    it "should exclude the lib folder" do
+      subject.file_list.include?("lib/gash.rb").should be_false
+    end
+
+    let(:author) { subject.authors.first }
+    it "should break out counts by file type" do
+      author.file_type_counts["rdoc"].should eq(23)
+    end
+
+    it "should output zero for file types the author hasn't touched" do
+      author.file_type_counts["derp"].should eq(0)
+    end
+  end
+
   describe "#pretty_print" do
     it "should print" do
       lambda {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_fame
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Linus Oleander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progressbar
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.1.8
 signing_key: 
 specification_version: 4
 summary: 'Generates some awesome stats from git-blame  A Ruby wrapper for git-blame.