git_stats 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f3520a3ad6f9c046a9b1764cedcf337dfadd229
-  data.tar.gz: 8b48cb4ea3d79e15bc0bb2ecf67df7b67f5ed61a
+  metadata.gz: 2fdf7c3f12067e71e3eddbd26ece408572f6d0bf
+  data.tar.gz: 79b20aeae19c213893f447432a34bd81bb89880e
 SHA512:
-  metadata.gz: 7decc1f75bd9778ddcb96d6c76c2751c92db8d7a88e04827ad7e4073476f2e2ac18b8136512253833160d837593994ed485e831da62ef3b32c5a329d348e2754
-  data.tar.gz: c31d7266352df2493e81d6a93ecb0f0a1785e281c708f170fe5843c0b2e9230ee259feb5a4383206ff56822040550e1c73c0226170e2eff4f5594b6fc17821ca
+  metadata.gz: 3286e2ccc323720aa0532f0112d77ff103136646ac14f64e425c7787e3c9b67bc91eee7e0f23e22cfe15a0d0ca02796a61f9e7aa8fab0fae5cc23f4aa9194a7d
+  data.tar.gz: 87b139080a6f5420c7267cc858d73ba4494c745e40b60e599fe2ac2f763a615b08e28d67f89c235c7f85bad73a6b3891ec3148c7b3542035fedf7129edb4d1bb

data/.gitmodules

@@ -1,3 +1,6 @@
 [submodule "spec/integration/test_repo"]
 	path = spec/integration/test_repo
 	url = git://github.com/tomgi/git_stats_test_repo.git
+[submodule "spec/integration/test_repo_tree"]
+	path = spec/integration/test_repo_tree
+	url = git://github.com/irevert/git_stats_test_repo_tree

data/README.md

@@ -34,16 +34,22 @@ It browses the repository and outputs html page with statistics.
       git_stats generate
 
     Options:
-      p, [--path=PATH]          # Path to repository from which statistics should be generated.
-                                # Default: .
-      o, [--output=OUTPUT]      # Output path where statistics should be written.
-                                # Default: ./git_stats
-      l, [--language=LANGUAGE]  # Language of written statistics.
-                                # Default: en
-      f, [--from=FROM]          # Commit from where statistics should start.
-      t, [--to=TO]              # Commit where statistics should stop.
-                                # Default: HEAD
-      s, [--silent]             # Silent mode. Don't output anything.
+      p, [--path=PATH]              # Path to repository from which statistics should be generated.
+                                    # Default: .
+      o, [--out-path=OUT_PATH]      # Output path where statistics should be written.
+                                    # Default: ./git_stats
+      l, [--language=LANGUAGE]      # Language of written statistics.
+                                    # Default: en
+      f, [--from=FROM]              # Commit from where statistics should start.
+      t, [--to=TO]                  # Commit where statistics should stop.
+                                    # Default: HEAD
+      s, [--silent], [--no-silent]  # Silent mode. Don't output anything.
+      d, [--tree=TREE]              # Tree where statistics should be generated.
+                                    # Default: .
+      c, [--comment=COMMENT]        # The string which is used for comments.
+                                    # Default: //
+
+
 
 #### Start generator with default settings
 

data/config/locales/de.yml

@@ -12,8 +12,10 @@ de:
   commits_by_hour: Commits in der Stunde
   files: Dateien
   lines: Zeilen
+  comments: Kommentare
   files_by_date: Dateien nach Datum
   lines_by_date: Zeilen nach Datum
+  comments_by_date: Kommentare nach Datum
   files_by_extension: Dateien nach Erweiterungen
   lines_by_extension: Zeilen nach Erweiterungen
   hour_of_day: Tagesstunden

data/config/locales/en.yml

@@ -1,6 +1,7 @@
 en:
   project_name: Project name
   project_version: Project version
+  tree_path: Tree path
   generated_at: Generated at
   generator: Generator
   report_period: Report period
@@ -12,8 +13,10 @@ en:
   commits_by_hour: Commits by hour
   files: Files
   lines: Lines
+  comments: Comments
   files_by_date: Files by date
   lines_by_date: Lines by date
+  comments_by_date: Comments by date
   files_by_extension: Files by extension
   lines_by_extension: Lines by extension
   hour_of_day: Hour of day
@@ -57,4 +60,4 @@ en:
   details: Details
   insertions_by_date: Lines added by date
   deletions_by_date: Lines deleted by date
-  changed_lines_by_date: Changed lines by date
+  changed_lines_by_date: Changed lines by date

data/lib/git_stats/base.rb

@@ -2,10 +2,10 @@
 require 'git_stats/core_extensions/hash'
 require 'git_stats/core_extensions/string'
 require 'git_stats/core_extensions/symbol'
+require 'git_stats/core_extensions/enumerable'
 
 require 'git_stats/version'
 require 'git_stats/i18n'
-require 'git_stats/by_field_finder'
 require 'git_stats/cli'
 require 'git_stats/generator'
 require 'git_stats/validator'
@@ -18,6 +18,8 @@ require 'git_stats/git_data/command_runner'
 require 'git_stats/git_data/commit'
 require 'git_stats/git_data/repo'
 require 'git_stats/git_data/short_stat'
+require 'git_stats/git_data/comment_stat'
+require 'git_stats/git_data/tree'
 
 require 'git_stats/stats_view/template'
 require 'git_stats/stats_view/view'

data/lib/git_stats/cli.rb

@@ -4,16 +4,18 @@ require "thor"
 
 class GitStats::CLI < Thor
   option :path, :aliases => :p, :default => '.', :desc => 'Path to repository from which statistics should be generated.'
-  option :output, :aliases => :o, :default => './git_stats', :desc => 'Output path where statistics should be written.'
+  option :out_path, :aliases => :o, :default => './git_stats', :desc => 'Output path where statistics should be written.'
   option :language, :aliases => :l, :default => 'en', :desc => 'Language of written statistics.'
   option :from, :aliases => :f, :desc => 'Commit from where statistics should start.'
   option :to, :aliases => :t, :default => 'HEAD', :desc => 'Commit where statistics should stop.'
   option :silent, :aliases => :s, :type => :boolean, :desc => 'Silent mode. Don\'t output anything.'
-
+  option :tree, :aliases => :d, :default => '.', :desc => 'Tree where statistics should be generated.'
+  option :comment, :aliases => :c, :default => '//', :desc => 'The string which is used for comments.'
+  
   desc 'generate', 'Generates the statistics of a repository'
   def generate
     I18n.locale = options[:language]
-    GitStats::Generator.new(options[:path], options[:output], options[:from], options[:to]) { |g|
+    GitStats::Generator.new(options) { |g|
       g.add_command_observer { |command, result| puts "#{command}" } unless options[:silent]
     }.render_all
   end

data/lib/git_stats/core_extensions/enumerable.rb

@@ -0,0 +1,10 @@
+module Enumerable
+	def first!(&block)
+		matching = find(&block)
+		if matching.nil?
+			raise "Sequence contains no matching elements"
+		else
+			matching
+		end
+	end
+end

data/lib/git_stats/generator.rb

@@ -4,12 +4,12 @@ module GitStats
     delegate :add_command_observer, to: :@repo
     delegate :render_all, to: :@view
 
-    def initialize(repo_path, out_path, first_commit_sha = nil, last_commit_sha = "HEAD")
-      validate_repo_path(repo_path)
+    def initialize(options)
+      validate_repo_path(options[:path])
 
-      @repo = GitData::Repo.new(path: repo_path, first_commit_sha: first_commit_sha, last_commit_sha: last_commit_sha)
+      @repo = GitData::Repo.new(options)
       view_data = StatsView::ViewData.new(@repo)
-      @view = StatsView::View.new(view_data, out_path)
+      @view = StatsView::View.new(view_data, options[:out_path])
 
       yield self if block_given?
     end

data/lib/git_stats/git_data/comment_stat.rb

@@ -0,0 +1,38 @@
+# -*- encoding : utf-8 -*-
+module GitStats
+  module GitData
+    class CommentStat
+      attr_reader :commit, :insertions, :deletions
+
+      def initialize(commit)
+        @commit = commit
+        calculate_stat
+      end
+
+      def changed_lines
+        insertions + deletions
+      end
+
+      def to_s
+        "#{self.class} #@commit"
+      end
+
+      def escape_characters_in_string(string)
+      	pattern = /(\'|\"|\.|\*|\/|\-|\\)/
+      	string.gsub(pattern){|match|"\\"  + match}
+      end
+      
+      private
+      def calculate_stat
+        escaped_string = escape_characters_in_string(commit.repo.comment_string)
+        stat_line = commit.repo.run("git show #{commit.sha} | awk 'BEGIN {adds=0; dels=0} {if ($0 ~ /^\\+#{escaped_string}/) adds++; if ($0 ~ /^\-#{escaped_string}/) dels++} END {print adds \" insertions \" dels \" deletes\"}'").lines.to_a[0]
+        if stat_line.blank?
+          @insertions = @deletions = 0
+        else
+          @insertions = stat_line[/(\d+) insertions?/, 1].to_i
+          @deletions = stat_line[/(\d+) deletes?/, 1].to_i
+        end
+      end
+    end
+  end
+end

data/lib/git_stats/git_data/commit.rb

@@ -9,9 +9,9 @@ module GitStats
       attr_reader :repo, :sha, :stamp, :date, :author
 
       def files
-        @files ||= repo.run_and_parse("git ls-tree -r #{self.sha}").map do |file|
+        @files ||= repo.run_and_parse("git ls-tree -r #{self.sha} -- #{repo.tree_path}").map do |file|
           Blob.new(repo: repo, filename: file[:filename], sha: file[:sha])
-        end.extend(ByFieldFinder)
+        end
       end
 
       def binary_files
@@ -37,11 +37,11 @@ module GitStats
       end
 
       def files_count
-        @files_count ||= repo.run("git ls-tree -r --name-only #{self.sha} | wc -l").to_i
+        @files_count ||= repo.run("git ls-tree -r --name-only #{self.sha} -- #{repo.tree_path}| wc -l").to_i
       end
 
       def lines_count
-        @lines_count ||= repo.run("git diff --shortstat `git hash-object -t tree /dev/null` #{self.sha}").lines.map do |line|
+        @lines_count ||= repo.run("git diff --shortstat `git hash-object -t tree /dev/null` #{self.sha} -- #{repo.tree_path}").lines.map do |line|
           line[/(\d+) insertions?/, 1].to_i
         end.sum
       end
@@ -50,6 +50,10 @@ module GitStats
         @short_stat ||= ShortStat.new(self)
       end
 
+      def comment_stat
+        @comment_stat ||= CommentStat.new(self)
+      end
+
       def to_s
         "#{self.class} #@sha"
       end

data/lib/git_stats/git_data/repo.rb

@@ -6,32 +6,51 @@ module GitStats
     class Repo
       include HashInitializable
 
-      attr_reader :path, :first_commit_sha, :last_commit_sha
-
       delegate :files, :files_by_extension, :files_by_extension_count, :lines_by_extension,
-               :files_count, :binary_files, :text_files, :lines_count, to: :last_commit
+               :files_count, :binary_files, :text_files, :lines_count, :comments_count, to: :last_commit
 
       def initialize(params)
         super(params)
         @path = File.expand_path(@path)
+        @tree_path ||= "."
+      end
+
+      def path
+        @path ||= '.'
+      end
+
+      def first_commit_sha
+        @first_commit_sha
+      end
+
+      def last_commit_sha
+        @last_commit_sha ||= 'HEAD'
+      end
+
+      def tree_path
+        @tree_path ||= '.'
+      end
+
+      def comment_string
+        @comment_string ||= '//'
       end
 
       def authors
-        @authors ||= run_and_parse("git shortlog -se #{commit_range}").map do |author|
+        @authors ||= run_and_parse("git shortlog -se #{commit_range} #{tree_path}").map do |author|
           Author.new(repo: self, name: author[:name], email: author[:email])
-        end.extend(ByFieldFinder)
+        end
       end
 
       def commits
-        @commits ||= run_and_parse("git rev-list --pretty=format:'%h|%at|%ai|%aE' #{commit_range} | grep -v commit").map do |commit_line|
+        @commits ||= run_and_parse("git rev-list --pretty=format:'%h|%at|%ai|%aE' #{commit_range} #{tree_path} | grep -v commit").map do |commit_line|
           Commit.new(
               repo: self,
               sha: commit_line[:sha],
               stamp: commit_line[:stamp],
               date: DateTime.parse(commit_line[:date]),
-              author: authors.by_email(commit_line[:author_email])
+              author: authors.first! { |a| a.email == commit_line[:author_email] }
           )
-        end.sort_by! { |e| e.date }.extend(ByFieldFinder)
+        end.sort_by! { |e| e.date }
       end
 
       def commits_period
@@ -63,6 +82,15 @@ module GitStats
         }]
       end
 
+      def comments_count_by_date
+        sum = 0
+        @comment_count_each_day ||= Hash[commits.map { |commit|
+          sum += commit.comment_stat.insertions
+          sum -= commit.comment_stat.deletions
+          [commit.date.to_date, sum]
+        }].fill_empty_days!(aggregated: true)
+      end
+
       def last_commit
         commits.last
       end
@@ -71,14 +99,14 @@ module GitStats
         @first_commit_sha.blank? ? last_commit_sha : "#@first_commit_sha..#{last_commit_sha}"
       end
 
-      def last_commit_sha
-        @last_commit_sha ||= 'HEAD'
-      end
-
       def short_stats
         @short_stats ||= commits.map(&:short_stat)
       end
 
+      def comment_stats
+        @comment_stats ||= commits.map(&:comment_stat)
+      end
+
       def activity
         @activity ||= Activity.new(commits)
       end
@@ -87,8 +115,12 @@ module GitStats
         @project_version ||= run("git rev-parse --short #{commit_range}").strip
       end
 
+      def tree
+        @tree ||= Tree.new(repo: self, relative_path: @tree_path)
+      end
+
       def project_name
-        @project_name ||= File.basename(path)
+        @project_name ||= (File.expand_path(File.join(path, tree_path)).sub(File.dirname(File.expand_path(path))+File::SEPARATOR,"") || File.basename(path))
       end
 
       def run(command)
@@ -132,6 +164,7 @@ module GitStats
         command_observers.each { |o| o.call(command, result) }
       end
 
+
     end
   end
 end

data/lib/git_stats/git_data/short_stat.rb

@@ -19,7 +19,7 @@ module GitStats
 
       private
       def calculate_stat
-        stat_line = commit.repo.run("git show --shortstat --oneline #{commit.sha}").lines.to_a[1]
+        stat_line = commit.repo.run("git show --shortstat --oneline #{commit.sha} -- #{commit.repo.tree_path}").lines.to_a[1]
         if stat_line.blank?
           @files_changed = @insertions = @deletions = 0
         else

data/lib/git_stats/git_data/tree.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+require 'git_stats/hash_initializable'
+
+module GitStats
+  module GitData
+    class Tree
+      include HashInitializable
+
+      attr_reader :repo, :relative_path
+
+      def authors
+        @authors ||= run_and_parse("git shortlog -se #{commit_range}").map do |author|
+          Author.new(repo: self, name: author[:name], email: author[:email])
+        end
+      end
+      
+      def ==(other)
+        ((self.repo == other.repo) && (self.relative_path == other.relative_path))
+      end
+
+    end
+  end
+end

data/lib/git_stats/i18n.rb

@@ -1,2 +1,3 @@
 # -*- encoding : utf-8 -*-
 I18n.load_path += Dir['../../../../config/locales/*.yml'.absolute_path]
+I18n.enforce_available_locales = true

data/lib/git_stats/stats_view/charts/authors_charts.rb

@@ -3,14 +3,16 @@ module GitStats
   module StatsView
     module Charts
       class AuthorsCharts
+        AUTHORS_ON_CHART_LIMIT = 4
+
         def initialize(authors)
           @authors = authors
         end
 
-        def commits_sum_by_author_by_date(limit = 4, authors = nil)
+        def commits_sum_by_author_by_date(authors = nil)
           Chart.new do |f|
             f.multi_date_chart(
-                data: (authors || @authors.sort_by { |author| -author.commits.size }[0..limit]).map { |author| {name: author.name, data: author.commits_sum_by_date} },
+                data: (authors || @authors.sort_by { |author| -author.commits.size }[0..AUTHORS_ON_CHART_LIMIT]).map { |author| {name: author.name, data: author.commits_sum_by_date} },
                 title: :lines_by_date.t,
                 y_text: :lines.t
             )
@@ -18,10 +20,10 @@ module GitStats
         end
 
         [:insertions, :deletions, :changed_lines].each do |method|
-          define_method "#{method}_by_author_by_date" do |limit = 4, authors = nil|
+          define_method "#{method}_by_author_by_date" do |authors = nil|
             Chart.new do |f|
               f.multi_date_chart(
-                  data: (authors || @authors.sort_by { |author| -author.send(method) }[0..limit]).map { |author| {name: author.name, data: author.send("#{method}_by_date")} },
+                  data: (authors || @authors.sort_by { |author| -author.send(method) }[0..AUTHORS_ON_CHART_LIMIT]).map { |author| {name: author.name, data: author.send("#{method}_by_date")} },
                   title: :lines_by_date.t,
                   y_text: :lines.t
               )

data/lib/git_stats/stats_view/charts/charts.rb

@@ -3,7 +3,7 @@ module GitStats
   module StatsView
     module Charts
       class All
-        delegate :files_by_extension, :lines_by_extension, :files_by_date, :lines_by_date, to: :repo_charts
+        delegate :files_by_extension, :lines_by_extension, :files_by_date, :lines_by_date, :comments_by_date, to: :repo_charts
 
         delegate :commits_sum_by_author_by_date, :changed_lines_by_author_by_date,
                  :insertions_by_author_by_date, :deletions_by_author_by_date, to: :authors_charts

data/lib/git_stats/stats_view/charts/repo_charts.rb

@@ -47,6 +47,16 @@ module GitStats
           end
         end
 
+        def comments_by_date
+          Chart.new do |f|
+            f.date_chart(
+                data: @repo.comments_count_by_date,
+                title: :comments_by_date.t,
+                y_text: :comments.t
+            )
+          end
+        end
+
       end
     end
   end