git_fame 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8bb9724458ff2755921443d6d9ac63cbeec1d1f
-  data.tar.gz: a39b694ad844e5020bc062b39dcbd744d3ac57c9
+  metadata.gz: 0b26bdf2f4da7bdd079f978625dd588c62129595
+  data.tar.gz: f0f316759efda81f61fdee295afe76e1cac9dc7f
 SHA512:
-  metadata.gz: c0499b7494115af787d7cd64a07e2ae8276e18a7b2141d7ce33d5bd14b2b426c56bf85488fae4ed00195e50273d9fb3df479e6b6e3aa2a6f7dc17b715c600788
-  data.tar.gz: 0b740f88d34139fc9f1be37fdf30313889a0148ebdd3710d0c53c265b8782017666cb5bf246ee21e86e3ce6322b6c86f58836964c4e3474fea43538cc7db911b
+  metadata.gz: e646b20e3fca5711245540a3c2d1996adbfbeeeed14e59ff9c1a26324d5cbbf5b8c303c87fb8b9aed287884d19be85d9ab2d67379d1a2992fd7046e77096b9a2
+  data.tar.gz: 4105beaa8b3e8d0000a6dbe00ce6a434012345e1f204f579344ce80c58a2dbf6cd744856e95b46eca4c17057457e6dfee7e577f5c0ae5089879f257e8854b564

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+- 2.3.1
 - 2.2.0
 - 2.1.0
 - 2.0.0

data/README.md

@@ -49,7 +49,7 @@ Run `git fame` to generate output as above.
 
 - `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, realtive paths to exclude from the counts. Note that you should not start the paths with a dot. Default is none.
-- `git fame --order=loc` Order table by `loc`. Available options are: `loc`, `commits` and `files`. Default is `loc`.
+- `git fame --sort=loc` Order table by `loc`. Available options are: `loc`, `commits` and `files`. Default is `loc`.
 - `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.
@@ -90,7 +90,7 @@ repository = GitFame::Base.new({
 
 #### Print csv table to console
 
-`repository.csv_puts
+`repository.csv_puts`
 
 ### Statistics
 
@@ -139,4 +139,4 @@ The list of authors may include duplicate people. If a git user's configured nam
 
 ## License
 
-*GitFame* is released under the *MIT license*.
+*GitFame* is released under the *MIT license*.

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) 2015 Linus Oleander"
+  version "git-fame #{GitFame::VERSION} (c) 2012-#{Date.today.year} 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
@@ -13,6 +13,7 @@ opts = Trollop::options do
   opt :bytype, "Group line counts by file extension (i.e. .rb, .erb, .yml)", default: false
   opt :include, "Paths to include in git ls-files", default: "", type: String
   opt :exclude, "Paths to exclude (comma separated)", default: "", type: String
+  opt :extension, "Comma-separated list of extensions to consider, leave blank for all", default: "", type: String
   opt :branch, "Branch to run on", default: "master", type: String
   opt :format, "Format (pretty/csv)", default: "pretty", type: String
 end
@@ -27,6 +28,7 @@ fame = GitFame::Base.new({
   bytype: opts[:bytype],
   include: opts[:include],
   exclude: opts[:exclude],
+  extensions: opts[:extension],
   branch: opts[:branch]
 })
 opts[:format] == "csv" ? fame.csv_puts : fame.pretty_puts

data/git_fame.gemspec

@@ -4,9 +4,9 @@ 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.description   = %q{Generates awesome stats from git-blame}
   gem.summary       = %q{
-Generates some awesome stats from git-blame
+Generates awesome stats from git-blame
 
 A Ruby wrapper for git-blame.
 Generates data like:
@@ -14,7 +14,7 @@ Generates data like:
 - 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($\)
@@ -28,10 +28,14 @@ Generates data like:
   gem.add_dependency("trollop")
   gem.add_dependency("hirb")
   gem.add_dependency("mimer_plus")
-  gem.add_dependency("string-scrub")
+
+  if RUBY_VERSION.to_f < 2.1
+    gem.add_dependency("scrub_rb")
+  end
 
   gem.add_development_dependency("rspec", "2.10.0")
   gem.add_development_dependency("rake")
   gem.add_development_dependency("coveralls")
+
   gem.required_ruby_version = ">= 1.9.2"
 end

data/lib/git_fame/base.rb

@@ -1,6 +1,8 @@
-require "string-scrub"
 require "csv"
 require_relative "./errors"
+if RUBY_VERSION.to_f < 2.1
+  require "scrub_rb"
+end
 
 module GitFame
   class Base
@@ -19,6 +21,7 @@ module GitFame
       @progressbar  = false
       @whitespace   = false
       @bytype       = false
+      @extensions   = ""
       @exclude      = ""
       @include      = ""
       @authors      = {}
@@ -27,7 +30,19 @@ module GitFame
         instance_variable_set "@" + name.to_s, args[name]
       end
       @exclude = convert_exclude_paths_to_array
+      @extensions = convert_extensions_to_array
       @branch = (@branch.nil? or @branch.empty?) ? "master" : @branch
+
+      # Fields that should be visible in the final table
+      # Used by #csv_puts, #to_csv and #pretty_puts
+      # Format: [ [:method_on_author, "custom column name"] ]
+      @visible_fields = [
+        :name,
+        :loc,
+        :commits,
+        :files,
+        [:distribution, "distribution (%)"]
+      ]
     end
 
     #
@@ -66,7 +81,7 @@ module GitFame
     #
     def to_csv
       CSV.generate do |csv|
-        csv << fields
+        csv << printable_fields
         authors.each do |author|
           csv << fields.map do |f|
             author.send(f)
@@ -75,19 +90,6 @@ module GitFame
       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
-    end
-
     #
     # @return Fixnum Total number of files
     #
@@ -148,6 +150,25 @@ module GitFame
 
     private
 
+    def printable_fields
+      @_printable_fields ||= raw_fields.map do |field|
+        field.is_a?(Array) ? field.last : field
+      end
+    end
+
+    def raw_fields
+      return @visible_fields unless @bytype
+      @_raw_fields ||= (
+        @visible_fields + populate.instance_variable_get("@file_extensions")
+      ).uniq
+    end
+
+    def fields
+      @_fields ||= raw_fields.map do |field|
+        field.is_a?(Array) ? field.first : field
+      end
+    end
+
     #
     # @command String Command to be executed inside the @repository path
     #
@@ -185,8 +206,9 @@ module GitFame
           raise BranchNotFound.new("Does '#{@branch}' exist?")
         end
 
-        @files = execute("git ls-tree -r #{@branch} --name-only #{@include}").
-          split("\n")
+        command = "git ls-tree -r #{@branch} --name-only #{@include}"
+        command += " | grep \"\\.\\(#{@extensions.join("\\|")}\\)$\"" unless @extensions.empty?
+        @files = execute(command).split("\n")
         @file_extensions = []
         remove_excluded_files
         progressbar = SilentProgressbar.new(
@@ -260,13 +282,20 @@ module GitFame
       @exclude.split(",").map{|path| path.strip.sub(/\A\//, "") }
     end
 
+    #
+    # Converts @extensions argument to an array
+    #
+    def convert_extensions_to_array
+      @extensions.split(",")
+    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("|")})/
+        next if path =~ /\A(#{@exclude.join("|")})/
         path
       end.compact
     end

data/lib/git_fame/version.rb

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

data/spec/git_fame_spec.rb

@@ -28,10 +28,10 @@ describe GitFame::Base do
       end
     end
     describe "format" do
-      let(:author) do 
+      let(:author) do
         GitFame::Author.new({
-          raw_commits: 12345, 
-          raw_files: 6789, 
+          raw_commits: 12345,
+          raw_files: 6789,
           raw_loc: 1234
         })
       end
@@ -61,7 +61,7 @@ describe GitFame::Base do
   describe "sort" do
     it "should be able to sort #authors by name" do
       authors = GitFame::Base.new({
-        repository: @repository, 
+        repository: @repository,
         sort: "name"
       }).authors
       authors.map(&:name).
@@ -70,7 +70,7 @@ describe GitFame::Base do
 
     it "should be able to sort #authors by commits" do
       authors = GitFame::Base.new({
-        repository: @repository, 
+        repository: @repository,
         sort: "commits"
       }).authors
       authors.map(&:name).
@@ -79,7 +79,7 @@ describe GitFame::Base do
 
     it "should be able to sort #authors by files" do
       authors = GitFame::Base.new({
-        repository: @repository, 
+        repository: @repository,
         sort: "files"
       }).authors
       authors.map(&:name).
@@ -88,19 +88,24 @@ describe GitFame::Base do
   end
 
   describe "#command_line_arguments" do
-    let(:subject) do 
+    let(:subject) do
       GitFame::Base.new({
-        repository: @repository, 
-        exclude: "lib", 
-        bytype: true
-      }) 
+        repository: @repository,
+        exclude: "lib",
+        bytype: true,
+        extensions: "rb,rdoc"
+      })
     end
 
     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 exclude non rb or rdoc files" do
+      subject.file_list.include?("HISTORY").should be_false
+    end
+
+    let(:author) { subject.authors.find { |author| author.name == "7rans" } }
     it "should break out counts by file type" do
       author.file_type_counts["rdoc"].should eq(23)
     end
@@ -126,7 +131,7 @@ describe GitFame::Base do
     end
 
     it "should be equal to" do
-      subject.to_csv.should eq("name,loc,commits,files,distribution\n" \
+      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")
@@ -156,7 +161,7 @@ describe GitFame::Base do
   describe "branches" do
     it "should handle existing branches" do
       authors = GitFame::Base.new({
-        repository: @repository, 
+        repository: @repository,
         branch: "0.1.0"
       }).authors
 
@@ -167,7 +172,7 @@ describe GitFame::Base do
     it "should raise an error if branch doesn't exist" do
       expect {
         GitFame::Base.new({
-          repository: @repository, 
+          repository: @repository,
           branch: "f67c2bcbfcfa30fccb36f72dca22a817"
         }).authors
       }.to raise_error(GitFame::BranchNotFound)

metadata

@@ -1,83 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: git_fame
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Linus Oleander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mimer_plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: string-scrub
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,31 +84,31 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generates some awesome stats from git-blame
+description: Generates awesome stats from git-blame
 email:
 - linus@oleander.nu
 executables:
@@ -130,10 +116,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .gitmodules
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -158,12 +144,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -171,9 +157,9 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-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'
+summary: 'Generates 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