git_fame 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36524eed33e537c38d7e4d6e676e1450d4c4df54
-  data.tar.gz: 40de0dbd6449bda36a1e5ae2a007cf9634a40d24
+  metadata.gz: f8bb9724458ff2755921443d6d9ac63cbeec1d1f
+  data.tar.gz: a39b694ad844e5020bc062b39dcbd744d3ac57c9
 SHA512:
-  metadata.gz: 974e123f9581f634674bde0079ae60e58a3dd0235a871af48a729cf87300211d8083465b83ddce133a928aaea6764ce23bd68887bd7c92f881d8441661d62e97
-  data.tar.gz: 20e4ed931d1a244afe97697c40231fdd20b2ca77afefa437a4fce80e1ab9662bca058da8a987f20fb65d992fff69e2196a24275349a80c10cfdc879a8108d320
+  metadata.gz: c0499b7494115af787d7cd64a07e2ae8276e18a7b2141d7ce33d5bd14b2b426c56bf85488fae4ed00195e50273d9fb3df479e6b6e3aa2a6f7dc17b715c600788
+  data.tar.gz: 0b740f88d34139fc9f1be37fdf30313889a0148ebdd3710d0c53c265b8782017666cb5bf246ee21e86e3ce6322b6c86f58836964c4e3474fea43538cc7db911b

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
+- 2.2.0
 - 2.1.0
+- 2.0.0
 - 1.9.3
 script:
  - 'rspec spec/git_fame_spec.rb --format documentation'

data/README.md

@@ -54,6 +54,7 @@ Run `git fame` to generate output as above.
 - `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.
 - `git fame --branch=master` Branch to run on. Default is `master`.
+- `git fame --format=output` Output format. Default is `pretty`. Additional: csv.
 
 ### Class
 
@@ -68,6 +69,7 @@ Want to work with the data before printing it?
 - **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.
 - **branch** (String) Branch to run on. Default is `master`.
+- **format** (String) Output format. Default is `pretty`.
 
 ``` ruby
 repository = GitFame::Base.new({
@@ -77,7 +79,8 @@ repository = GitFame::Base.new({
   whitespace: false
   bytype: false,
   exclude: "vendor, public/assets",
-  branch: "master"
+  branch: "master",
+  format: "pretty"
 })
 ```
 
@@ -85,6 +88,10 @@ repository = GitFame::Base.new({
 
 `repository.pretty_puts`
 
+#### Print csv table to console
+
+`repository.csv_puts
+
 ### Statistics
 
 #### GitFame

data/bin/git-fame

@@ -5,7 +5,7 @@ require "trollop"
 
 sort = ["name", "commits", "loc", "files"]
 opts = Trollop::options do
-  version "git-fame #{GitFame::VERSION} (c) 2012 Linus Oleander"
+  version "git-fame #{GitFame::VERSION} (c) 2015 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
@@ -14,11 +14,12 @@ opts = Trollop::options do
   opt :include, "Paths to include in git ls-files", default: "", type: String
   opt :exclude, "Paths to exclude (comma separated)", default: "", type: String
   opt :branch, "Branch to run on", default: "master", type: String
+  opt :format, "Format (pretty/csv)", default: "pretty", type: String
 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({
+fame = GitFame::Base.new({
   repository: opts[:repository],
   progressbar: opts[:progressbar] == 1,
   sort: opts[:sort],
@@ -27,4 +28,5 @@ GitFame::Base.new({
   include: opts[:include],
   exclude: opts[:exclude],
   branch: opts[:branch]
-}).pretty_puts
+})
+opts[:format] == "csv" ? fame.csv_puts : fame.pretty_puts

data/lib/git_fame/base.rb

@@ -1,4 +1,5 @@
 require "string-scrub"
+require "csv"
 require_relative "./errors"
 
 module GitFame
@@ -29,22 +30,62 @@ module GitFame
       @branch = (@branch.nil? or @branch.empty?) ? "master" : @branch
     end
 
+    #
+    # @return Boolean Is the given @dir a git repository?
+    # @dir Path (relative or absolute) to git repository
+    #
+    def self.git_repository?(dir)
+      return false unless File.directory?(dir)
+      Dir.chdir(dir) do
+        system "git rev-parse --git-dir > /dev/null 2>&1"
+      end
+    end
+
     #
     # Generates pretty output
     #
     def pretty_puts
       extend Hirb::Console
-      Hirb.enable({pager: false})
+      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"
 
-      fields = [:name, :loc, :commits, :files, :distribution]
-      if @bytype
-        fields << populate.instance_variable_get("@file_extensions").
-          uniq.sort
+      table(authors, fields: fields)
+    end
+
+    #
+    # Prints CSV
+    #
+    def csv_puts
+      puts to_csv
+    end
+
+    #
+    # Generate csv output
+    #
+    def to_csv
+      CSV.generate do |csv|
+        csv << fields
+        authors.each do |author|
+          csv << fields.map do |f|
+            author.send(f)
+          end
+        end
+      end
+    end
+
+    #
+    # Calculate columns to show
+    #
+    def fields
+      @_fields ||= begin
+        fields = [:name, :loc, :commits, :files, :distribution]
+        if @bytype
+          fields += populate.instance_variable_get("@file_extensions")
+        end
+        fields.uniq
       end
-      table(authors, fields: fields.flatten)
     end
 
     #
@@ -80,33 +121,22 @@ module GitFame
     # @return Array<Author> A list of authors
     #
     def authors
-      authors = populate.instance_variable_get("@authors").values
-      if @sort
-        authors.sort_by do |author|
-          if @sort == "name"
-            author.send(@sort)
-          else
-            -1 * author.send("raw_#{@sort}")
+      @_authors ||= begin
+        authors = populate.instance_variable_get("@authors").values
+        if @sort
+          authors.sort_by do |author|
+            if @sort == "name"
+              author.send(@sort)
+            else
+              -1 * author.send("raw_#{@sort}")
+            end
           end
+        else
+          authors
         end
-      else
-        authors
       end
     end
 
-    #
-    # @return Boolean Is the given @dir a git repository?
-    # @dir Path (relative or absolute) to git repository
-    #
-    def self.git_repository?(dir)
-      return false unless File.directory?(dir)
-      Dir.chdir(dir) do
-        system "git rev-parse --git-dir > /dev/null 2>&1"
-      end
-    end
-
-    private
-
     #
     # @return Boolean Does the branch exist?
     #
@@ -116,13 +146,13 @@ module GitFame
       end
     end
 
+    private
+
     #
     # @command String Command to be executed inside the @repository path
     #
     def execute(command)
-      Dir.chdir(@repository) do
-        return `#{command}`.scrub
-      end
+      Dir.chdir(@repository) { `#{command}`.scrub }
     end
 
     #
@@ -183,7 +213,6 @@ module GitFame
           # only count extensions that aren't binary
           @file_extensions << file_extension
 
-
           output = execute(
             "git blame #{blame_opts} --line-porcelain #{@branch} -- '#{file}'"
           )

data/lib/git_fame/version.rb

@@ -1,3 +1,3 @@
 module GitFame
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

data/spec/git_fame_spec.rb

@@ -118,6 +118,21 @@ describe GitFame::Base do
     end
   end
 
+  describe "#csv_print" do
+    it "should print" do
+      lambda {
+        subject.csv_puts
+      }.should_not raise_error
+    end
+
+    it "should be equal to" do
+      subject.to_csv.should eq("name,loc,commits,files,distribution\n" \
+                            "Magnus Holm,586,41,4,54.2 / 58.6 / 25.0\n" \
+                            "7rans,360,6,10,33.3 / 8.6 / 62.5\n" \
+                            "Linus Oleander,136,23,7,12.6 / 32.9 / 43.8\n")
+    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 eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_fame
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Linus Oleander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progressbar