git_fame 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04200942414c95c6ec6c73bd9c6274d974c4e4ab
-  data.tar.gz: 290528caaf2d7ea37a707177b1a4cfa54ffa3401
+  metadata.gz: 36524eed33e537c38d7e4d6e676e1450d4c4df54
+  data.tar.gz: 40de0dbd6449bda36a1e5ae2a007cf9634a40d24
 SHA512:
-  metadata.gz: 0f9138e9bde7548b928b85adaaf6a45b2821e055c8f77058cdceb01065390abb3b661c2e9a2f7e6edd2add5f6dfe8a49ce18c6bff129cb54a26b51af9d67b7aa
-  data.tar.gz: 4d8c8f0d4545b5f189179f9fc30f05cfd3ef62f6e3f37405f2903ce4972fef5f0c0baf8154c0aa010175b0e81fb301db8312d4d971c278b8224d3f8834404750
+  metadata.gz: 974e123f9581f634674bde0079ae60e58a3dd0235a871af48a729cf87300211d8083465b83ddce133a928aaea6764ce23bd68887bd7c92f881d8441661d62e97
+  data.tar.gz: 20e4ed931d1a244afe97697c40231fdd20b2ca77afefa437a4fce80e1ab9662bca058da8a987f20fb65d992fff69e2196a24275349a80c10cfdc879a8108d320

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.1.0
+- 1.9.3
+script:
+ - 'rspec spec/git_fame_spec.rb --format documentation'
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/e2b034ea2dbc919b02f7
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: change  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/README.md

@@ -1,4 +1,7 @@
 # GitFame
+[![Join the chat at https://gitter.im/oleander/git-fame-rb](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oleander/git-fame-rb)
+[![Build Status](https://travis-ci.org/oleander/git-fame-rb.svg?branch=master)](https://travis-ci.org/oleander/git-fame-rb)
+[![Coverage Status](https://coveralls.io/repos/oleander/git-fame-rb/badge.svg?branch=master&service=github)](https://coveralls.io/github/oleander/git-fame-rb?branch=master)
 
 Pretty-print collaborators sorted by contributions.
 
@@ -44,12 +47,13 @@ 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 --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 --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.
+- `git fame --branch=master` Branch to run on. Default is `master`.
 
 ### Class
 
@@ -63,6 +67,7 @@ Want to work with the data before printing it?
 - **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.
+- **branch** (String) Branch to run on. Default is `master`.
 
 ``` ruby
 repository = GitFame::Base.new({
@@ -71,7 +76,8 @@ repository = GitFame::Base.new({
   progressbar: false,
   whitespace: false
   bytype: false,
-  exclude: "vendor, public/assets"
+  exclude: "vendor, public/assets",
+  branch: "master"
 })
 ```
 
@@ -105,7 +111,7 @@ repository = GitFame::Base.new({
 
 #### 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.
+The list of authors may include 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
 
@@ -118,7 +124,7 @@ The list of authors may include what you perceive to be duplicate people. If a g
 ## Testing
 
 1. Download fixtures (`spec/fixtures`) using `git submodule update --init`.
-2. Run rspec using `rspec spec`.
+2. Run rspec using `rspec spec/git_fame_spec.rb`.
 
 ## Requirements
 

data/bin/git-fame

@@ -11,7 +11,9 @@ opts = Trollop::options do
   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 :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
 end
 
 Trollop::die :repository, "is not a git repository" unless GitFame::Base.git_repository?(opts[:repository])
@@ -22,5 +24,7 @@ GitFame::Base.new({
   sort: opts[:sort],
   whitespace: opts[:whitespace],
   bytype: opts[:bytype],
-  exclude: opts[:exclude]
+  include: opts[:include],
+  exclude: opts[:exclude],
+  branch: opts[:branch]
 }).pretty_puts

data/git_fame.gemspec

@@ -29,8 +29,9 @@ Generates data like:
   gem.add_dependency("hirb")
   gem.add_dependency("mimer_plus")
   gem.add_dependency("string-scrub")
-  
-  gem.add_development_dependency("rspec")
+
+  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,4 +1,5 @@
 require "string-scrub"
+require_relative "./errors"
 
 module GitFame
   class Base
@@ -8,8 +9,9 @@ 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 
+    # @args[:exclude] String Comma-separated list of paths in the repo
     #   which should be excluded
+    # @args[:branch] String Branch to run from
     #
     def initialize(args)
       @sort         = "loc"
@@ -17,12 +19,14 @@ module GitFame
       @whitespace   = false
       @bytype       = false
       @exclude      = ""
+      @include      = ""
       @authors      = {}
       @file_authors = Hash.new { |h,k| h[k] = {} }
-      args.keys.each do |name| 
+      args.keys.each do |name|
         instance_variable_set "@" + name.to_s, args[name]
       end
       @exclude = convert_exclude_paths_to_array
+      @branch = (@branch.nil? or @branch.empty?) ? "master" : @branch
     end
 
     #
@@ -95,10 +99,23 @@ module GitFame
     # @dir Path (relative or absolute) to git repository
     #
     def self.git_repository?(dir)
-      Dir.exists?(File.join(dir, ".git"))
+      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?
+    #
+    def branch_exists?
+      Dir.chdir(@repository) do
+        system "git show-ref #{@branch} > /dev/null 2>&1"
+      end
+    end
+
     #
     # @command String Command to be executed inside the @repository path
     #
@@ -134,12 +151,17 @@ module GitFame
     #
     def populate
       @_populate ||= begin
-        @files = execute("git ls-files").split("\n")
+        unless branch_exists?
+          raise BranchNotFound.new("Does '#{@branch}' exist?")
+        end
+
+        @files = execute("git ls-tree -r #{@branch} --name-only #{@include}").
+          split("\n")
         @file_extensions = []
         remove_excluded_files
         progressbar = SilentProgressbar.new(
-          "Blame", 
-          @files.count, 
+          "Blame",
+          @files.count,
           @progressbar
         )
         blame_opts = @whitespace ? "-w" : ""
@@ -161,8 +183,9 @@ module GitFame
           # only count extensions that aren't binary
           @file_extensions << file_extension
 
+
           output = execute(
-            "git blame '#{file}' #{blame_opts} --line-porcelain"
+            "git blame #{blame_opts} --line-porcelain #{@branch} -- '#{file}'"
           )
           output.scan(/^author (.+)$/).each do |author|
             fetch(author.first).raw_loc += 1
@@ -174,7 +197,7 @@ module GitFame
           end
         end
 
-        execute("git shortlog -se").split("\n").map do |l|
+        execute("git shortlog #{@branch} -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?

data/lib/git_fame/errors.rb

@@ -0,0 +1,4 @@
+module GitFame
+  class BranchNotFound < StandardError
+  end
+end

data/lib/git_fame/version.rb

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

data/spec/git_fame_spec.rb

@@ -2,7 +2,7 @@ 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
+      subject.should have(3).authors
     end
 
     describe "author" do
@@ -120,21 +120,42 @@ describe GitFame::Base do
 
   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
+      GitFame::Base.git_repository?(@repository).should eq(true)
     end
 
     it "should know if a folder exists or not [absolute path]" do
       GitFame::Base.git_repository?("/f67c2bcbfcfa30fccb36f72dca22a817").
-        should be_false
+        should eq(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
+      GitFame::Base.git_repository?("spec/fixtures/gash").should eq(true)
     end
 
     it "should know if a folder exists or not [relative path]" do
       GitFame::Base.git_repository?("f67c2bcbfcfa30fccb36f72dca22a817").
-        should be_false
+        should eq(false)
+    end
+  end
+
+  describe "branches" do
+    it "should handle existing branches" do
+      authors = GitFame::Base.new({
+        repository: @repository, 
+        branch: "0.1.0"
+      }).authors
+
+      authors.count.should eq(1)
+      authors.first.name.should eq("Magnus Holm")
+    end
+
+    it "should raise an error if branch doesn't exist" do
+      expect {
+        GitFame::Base.new({
+          repository: @repository, 
+          branch: "f67c2bcbfcfa30fccb36f72dca22a817"
+        }).authors
+      }.to raise_error(GitFame::BranchNotFound)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require "rspec"
 require "git_fame"
+require "coveralls"
+
+Coveralls.wear!
 
 RSpec.configure do |config|
   config.mock_with :rspec

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: git_fame
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Linus Oleander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-09-21 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
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  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: rake
+  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
@@ -116,9 +130,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitmodules"
-- ".rspec"
+- .gitignore
+- .gitmodules
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -128,6 +143,7 @@ files:
 - lib/git_fame.rb
 - lib/git_fame/author.rb
 - lib/git_fame/base.rb
+- lib/git_fame/errors.rb
 - lib/git_fame/helper.rb
 - lib/git_fame/silent_progressbar.rb
 - lib/git_fame/version.rb
@@ -142,17 +158,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: 'Generates some awesome stats from git-blame  A Ruby wrapper for git-blame.