git_statistics 0.5.1 → 0.6.0

data/lib/git_statistics/initialize.rb

@@ -1,12 +1,9 @@
 require 'json'
-require 'trollop'
 require 'grit'
 require 'linguist'
-require 'os'
 require 'pathname'
 
 # Must be required before all other files
-require 'git_statistics/core_ext/string'
 require 'git_statistics/blob'
 require 'git_statistics/regex_matcher'
 

data/lib/git_statistics/log.rb

@@ -0,0 +1,59 @@
+require 'logger'
+require 'singleton'
+
+module GitStatistics
+  class Log
+    include Singleton
+
+    attr_accessor :logger, :base_directory, :debugging
+
+    def initialize
+      @base_directory = File.expand_path("../..", __FILE__) + "/"
+      @debugging = false
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::ERROR
+      @logger.formatter = proc do |sev, datetime, progname, msg|
+        "#{msg}\n"
+      end
+    end
+
+    def self.use_debug
+      instance.debugging = true
+      instance.logger.formatter = proc do |sev, datetime, progname, msg|
+        "#{sev} [#{progname}]: #{msg}\n"
+      end
+    end
+
+    # Determine the file, method, line number of the caller
+    def self.parse_caller(message)
+      if /^(?<file>.+?):(?<line>\d+)(?::in `(?<method>.*)')?/ =~ message
+        file = Regexp.last_match[:file]
+        line = Regexp.last_match[:line]
+        method = Regexp.last_match[:method]
+        "#{file.sub(instance.base_directory, "")}:#{line}"
+      end
+    end
+
+    def self.method_missing(method, *args, &blk)
+      if valid_method? method
+        instance.logger.progname = parse_caller(caller(1).first) if instance.debugging
+        instance.logger.send(method, *args, &blk)
+      else
+        super
+      end
+    end
+
+    def self.respond_to_missing?(method, include_all=false)
+      if valid_method? method
+        true
+      else
+        super
+      end
+    end
+
+    def self.valid_method?(method)
+      instance.logger.respond_to? method
+    end
+
+  end
+end

data/lib/git_statistics/pipe.rb

@@ -0,0 +1,29 @@
+module GitStatistics
+  class Pipe
+    include Enumerable
+
+    def initialize(command)
+      @command  = command
+    end
+
+    def command
+      @command.dup.gsub(/\A\|/i, '')
+    end
+
+    def each(&block)
+      lines.each(&block)
+    end
+
+    def empty?
+      lines.empty?
+    end
+
+    def lines
+      io.map { |line| line.strip.force_encoding("iso-8859-1").encode("utf-8") }
+    end
+
+    def io
+      open("|#{command} 2>/dev/null")
+    end
+  end
+end

data/lib/git_statistics/utilities.rb

@@ -1,17 +1,18 @@
+require 'rbconfig'
+
 module GitStatistics
   module Utilities
+
+    class NotInRepository < StandardError; end
+
     def self.get_repository(path = Dir.pwd)
-      # Connect to git repository if it exists
-      directory = Pathname.new(path)
-      repo = nil
-      while !directory.root? do
-        begin
-          repo = Grit::Repo.new(directory)
-          return repo
-        rescue
-          directory = directory.parent
-        end
-      end
+      ascender = Pathname.new(path).to_enum(:ascend)
+      repo_path = ascender.detect { |path| (path + '.git').exist? }
+      raise NotInRepository unless repo_path
+      Grit::Repo.new(repo_path.to_s)
+    rescue NotInRepository
+      Log.error "You must be within a Git project to run git-statistics."
+      exit 0
     end
 
     def self.max_length_in_list(list, max = nil)
@@ -22,10 +23,6 @@ module GitStatistics
       max
     end
 
-    def self.clean_string(string)
-      string.strip.force_encoding("iso-8859-1").encode("utf-8")
-    end
-
     def self.split_old_new_file(old, new)
       # Split the old and new chunks up (separted by the =>)
       split_old = old.split('{')
@@ -84,11 +81,26 @@ module GitStatistics
     end
 
     def self.get_modified_time(file)
-      command = case
-        when OS.mac? then "stat -f %m #{file}"
-        when OS.linux? then "stat -c %Y #{file}"
-        else raise "Update on the Windows operating system is not supported"; end
-      time_at(command)
+      if os == :windows
+        raise "`stat` is not supported on the Windows operating system"
+      end
+      flags = os == :mac ? "-f %m" : "-c %Y"
+      time_at("stat #{flags} #{file}")
+    end
+
+    def os
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        :windows
+      when /darwin|mac os/
+        :mac
+      when /linux/
+        :linux
+      when /solaris|bsd/
+        :unix
+      else
+        :unknown
+      end
     end
 
     def self.time_at(cmd)
@@ -96,9 +108,7 @@ module GitStatistics
     end
 
     def self.number_of_matching_files(directory, pattern)
-      Dir.entries(directory)
-          .select { |file| file =~ pattern }
-          .size
+      Dir.entries(directory).grep(pattern).size
     rescue SystemCallError
       warn "No such directory #{File.expand_path(directory)}"
       0

data/lib/git_statistics/version.rb

@@ -1,3 +1,3 @@
 module GitStatistics
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/branches_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+include GitStatistics
+
+describe Branches do
+  subject { described_class }
+
+  before do
+    subject.stub(:pipe) { fixture(branches) }
+  end
+
+  context "with many branches" do
+    let(:branches) {"git_many_branches.txt"}
+    its(:all) { should have(2).items }
+    its(:all) { should include "issue_2" }
+    its(:all) { should include "master" }
+    its(:current) { should == "issue_2" }
+    its(:detached?) { should be_false }
+  end
+
+  context "with zero branches" do
+    let(:branches) {"git_zero_branches.txt"}
+    its(:all) { should have(1).items }
+    its(:all) { should include "master" }
+    its(:current) { should == "master" }
+    its(:detached?) { should be_false }
+  end
+
+  context "with many branches in detached state" do
+    let(:branches) {"git_many_branches_detached_state.txt"}
+    its(:all) { should have(2).items }
+    its(:all) { should include "issue_2" }
+    its(:all) { should include "master" }
+    its(:current) { should == "(none)" }
+    its(:detached?) { should be_true }
+  end
+
+  context "with zero branches in detached state" do
+    let(:branches) {"git_zero_branches_detached_state.txt"}
+    its(:all) { should have(1).items }
+    its(:all) { should include "master" }
+    its(:current) { should == "(none)" }
+    its(:detached?) { should be_true }
+  end
+end

data/spec/collector_spec.rb

@@ -2,17 +2,14 @@ require 'spec_helper'
 include GitStatistics
 
 describe Collector do
-  let(:verbose) {false}
   let(:limit) {100}
   let(:fresh) {true}
   let(:pretty) {false}
-  let(:collector) {Collector.new(verbose, limit, fresh, pretty)}
+  let(:collector) {Collector.new(limit, fresh, pretty)}
 
   # Create buffer which is an array of cleaned lines
   let(:buffer) {
-    fixture(fixture_file).readlines.collect do |line|
-      line.clean_for_authors
-    end
+    fixture(fixture_file).lines
   }
 
   describe "#collect" do
@@ -83,26 +80,8 @@ describe Collector do
     end
   end
 
-  describe "#collect_branches" do
-    let(:branches) {collector.collect_branches(fixture(fixture_file))}
-
-    context "with many branches" do
-    let(:fixture_file) {"git_many_branches.txt"}
-      it {branches.size.should == 2}
-      it {branches[0].should == "issue_2"}
-      it {branches[1].should == "master"}
-    end
-
-    context "with zero branches" do
-      let(:fixture_file) {"git_zero_branches.txt"}
-      it {branches.size.should == 1}
-      it {branches[0].should == "master"}
-    end
-  end
-
   describe "#acquire_commit_data" do
-    let(:input) {fixture(fixture_file).read}
-    let(:data) {collector.acquire_commit_data(input)}
+    let(:data) {collector.acquire_commit_data(buffer.first)}
 
     context "no parent, first commit" do
       let(:fixture_file) {"commit_buffer_information_first.txt"}
@@ -231,38 +210,38 @@ describe Collector do
   end
 
   describe "#fall_back_collect_commit" do
-    let(:results) {collector.fall_back_collect_commit(sha)}
+    subject { collector.fall_back_collect_commit(sha) }
     context "with valid sha" do
-      let(:fixture_file) {"commit_buffer_whole.txt"}
-      let(:sha) {"260bc61e2c42930d91f3503c5849b0a2351275cf"}
-      it {results.should == buffer}
+      let(:fixture_file) { "commit_buffer_whole.txt" }
+      let(:sha) { "260bc61e2c42930d91f3503c5849b0a2351275cf" }
+      it { should == buffer }
     end
 
     context "with invalid sha" do
-      let(:sha) {"111111aa111a11111a11aa11aaaa11a111111a11"}
-      it {results.should.nil?}
+      let(:sha) { "111111aa111a11111a11aa11aaaa11a111111a11" }
+      it { should be_empty }
     end
   end
 
   describe "#get_blob" do
-    let(:sha) {"695b487432e8a1ede765b4e3efda088ab87a77f8"}  # Commit within repository
-    let(:blob) {collector.get_blob(sha, file)}
+    let(:sha) { "695b487432e8a1ede765b4e3efda088ab87a77f8" }  # Commit within repository
+    subject { collector.get_blob(sha, file) }
 
     context "with valid blob" do
       let(:file) {{:file => "Gemfile.lock"}}
-      it {blob.instance_of?(Grit::Blob).should be_true}
-      it {blob.name.should == file[:file].split(File::Separator).last}
-    end
-
-    context "with invalid blob" do
-      let(:file) {{:file => "dir/nothing.rb"}}
-      it {blob.should.nil?}
+      it { should be_a Grit::Blob }
+      its(:name) { should == File.basename(file[:file]) }
     end
 
     context "with deleted file" do
       let(:file) {{:file => "spec/collector_spec.rb"}}
-      it {blob.instance_of?(Grit::Blob).should be_true}
-      it {blob.name.should == file[:file].split(File::Separator).last}
+      it { should be_a Grit::Blob }
+      its(:name) { should == File.basename(file[:file]) }
+    end
+
+    context "with invalid blob" do
+      let(:file) {{:file => "dir/nothing.rb"}}
+      it { should be_nil }
     end
   end
 

data/spec/commits_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
+require 'fileutils'
 include GitStatistics
 
 describe Commits do
-  let(:verbose) {false}
   let(:limit) {100}
   let(:fresh) {true}
   let(:pretty) {false}
-  let(:collector) {Collector.new(verbose, limit, fresh, pretty)}
+  let(:collector) {Collector.new(limit, fresh, pretty)}
 
   let(:commits) {collector.commits}
 
   let(:fixture_file) {"multiple_authors.json"}
-  let(:save_file) {collector.commits_path + "0.json"}
+  let(:save_file) { File.join(collector.commits_path, "0.json") }
   let(:email) {false}
   let(:merge) {false}
   let(:sort) {:commits}
@@ -21,56 +21,66 @@ describe Commits do
     commits.author_top_n_type(sort)
   end
 
+  describe "#files_in_path" do
+    let(:path) { '/tmp/example' }
+    subject { commits.files_in_path }
+    before do
+      FileUtils.mkdir_p(path)
+      Dir.chdir(path) do
+        FileUtils.touch '0.json'
+        FileUtils.touch '1.json'
+      end
+      commits.stub(:path) { path }
+    end
+    after do
+      FileUtils.rm_rf(path)
+    end
+    its(:count) { should == 2 }
+    it { should_not include '.' }
+    it { should_not include '..' }
+  end
+
   describe "#flush_commits" do
-    let(:commits) {collector.commits.load(fixture(fixture_file))}
+    let(:commits) {collector.commits.load(fixture(fixture_file).file)}
+
+    def commit_size_changes_from(beginning, opts = {})
+      commits.size.should == beginning
+      commits.flush_commits(opts[:force] || false)
+      commits.size.should == opts[:to]
+    end
 
     context "with commits exceeding limit" do
       let(:limit) {2}
-      it do
-        commits.size.should == 3
-        commits.flush_commits
-        commits.size.should == 0
-      end
+      it { commit_size_changes_from(3, to: 0) }
     end
 
     context "with commits equal to limit" do
       let(:limit) {3}
-      it do
-        commits.size.should == 3
-        commits.flush_commits
-        commits.size.should == 0
-      end
+      it { commit_size_changes_from(3, to: 0) }
     end
 
     context "with commits less than limit" do
       let(:limit) {5}
-      it do
-        commits.size.should == 3
-        commits.flush_commits
-        commits.size.should == 3
-      end
+      it { commit_size_changes_from(3, to: 3) }
     end
 
     context "with commits less than limit but forced" do
       let(:limit) {5}
-      it do
-        commits.size.should == 3
-        commits.flush_commits(true)
-        commits.size.should == 0
-      end
+      it { commit_size_changes_from(3, to: 0, force: true) }
     end
   end
 
   describe "#process_commits" do
-    let(:commits) {collector.commits.load(fixture(fixture_file))}
+    let(:commits) {collector.commits.load(fixture(fixture_file).file)}
     let(:type) {:author}
+    subject { commits.stats[author_name] }
+
+    before do
+      commits.process_commits(type, merge)
+    end
 
     context "with merge" do
       let(:merge) {true}
-      subject {
-        commits.process_commits(type, merge)
-        commits.stats[author_name]
-      }
 
       context "on first author" do
         let(:author_name) {"Kevin Jalbert"}
@@ -102,10 +112,6 @@ describe Commits do
 
     context "without merge" do
       let(:merge) {false}
-      subject {
-        commits.process_commits(type, merge)
-        commits.stats[author_name]
-      }
 
       context "on first author" do
         let(:author_name) {"Kevin Jalbert"}
@@ -136,11 +142,11 @@ describe Commits do
 
   describe "#author_top_n_type" do
     let(:sort) {:deletions}
+    subject {stats[author]}
 
     context "with valid data" do
       context "on first author" do
-        author = "John Smith"
-        subject {stats[author]}
+        let(:author) { 'John Smith' }
         it {stats.has_key?(author).should be_true}
         it {subject[:commits].should == 1}
         it {subject[:deletions].should == 16}
@@ -151,8 +157,7 @@ describe Commits do
       end
 
       context "on second author" do
-        author = "Kevin Jalbert"
-        subject {stats[author]}
+        let(:author) { "Kevin Jalbert" }
         it {stats.has_key?(author).should be_true}
         it {subject[:commits].should == 1}
         it {subject[:additions].should == 73}
@@ -170,22 +175,22 @@ describe Commits do
 
     context "with invalid type" do
       let(:sort) {:wrong}
-      it {stats.should.nil?}
+      it { stats.should be_nil }
     end
 
     context "with invalid data" do
       let(:fixture_file) {nil}
-      it {stats.should.nil?}
+      it { stats.should be_nil }
     end
   end
 
   describe "#calculate_statistics" do
     let(:fixture_file) {"single_author_pretty.json"}
+    subject {stats[author]}
 
     context "with email" do
       let(:email) {true}
-      author = "kevin.j.jalbert@gmail.com"
-      subject {stats[author]}
+      let(:author) { "kevin.j.jalbert@gmail.com" }
 
       it {stats.has_key?(author).should be_true}
       it {subject[:commits].should == 1}
@@ -202,8 +207,7 @@ describe Commits do
 
     context "with merge" do
       let(:merge) {true}
-      author = "Kevin Jalbert"
-      subject {stats[author]}
+      let(:author) { 'Kevin Jalbert' }
 
       it {stats.has_key?(author).should be_true}
       it {subject[:commits].should == 2}
@@ -334,10 +338,10 @@ describe Commits do
       let(:pretty) {true}
 
       it do
-        commits.load(fixture(fixture_file))
+        commits.load(fixture(fixture_file).file)
         commits.save("tmp.json", pretty)
 
-        same = FileUtils.compare_file("tmp.json", fixture(fixture_file))
+        same = FileUtils.compare_file("tmp.json", fixture(fixture_file).file)
         FileUtils.remove_file("tmp.json")
 
         same.should be_true
@@ -349,10 +353,10 @@ describe Commits do
       let(:pretty) {false}
 
       it do
-        commits.load(fixture(fixture_file))
+        commits.load(fixture(fixture_file).file)
         commits.save("tmp.json", pretty)
 
-        same = FileUtils.compare_file("tmp.json", fixture(fixture_file))
+        same = FileUtils.compare_file("tmp.json", fixture(fixture_file).file)
         FileUtils.remove_file("tmp.json")
 
         same.should be_true