gitalytics 1.3.0 → 1.3.1

data/assets/gitalytics.html.haml

@@ -0,0 +1,63 @@
+- require 'haml_helper'
+!!!
+%html{lang: "en"}
+  %head
+    %meta{content: "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %meta{charset: "utf-8"}/
+    %meta{content: "IE=edge", "http-equiv" => "X-UA-Compatible"}/
+    %meta{content: "width=device-width, initial-scale=1.0", name: "viewport"}/
+    %meta{content: "Gitalytics Report", name: "description"}/
+    %meta{content: "Gonzalo Robaina", name: "author"}/
+    %title Gitalytics report
+    / Bootstrap core CSS
+    %link{crossorigin: "anonymous", href: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css", integrity: "sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7", rel: "stylesheet"}/
+    %link{crossorigin: "anonymous", href: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap-theme.min.css", integrity: "sha384-fLW2N01lMqjakBkx3l/M9EahuwpSfeNvV63J5ezn3uZzapT0u7EYsXMjQV+0En5r", rel: "stylesheet"}/
+    / HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries
+    /[if lt IE 9]
+      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+      <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+    = render :css
+  %body
+    / Wrap all page content here
+    #wrap
+      / Fixed navbar
+      .navbar.navbar-default.navbar-fixed-top{role: "navigation"}
+        .container
+          .navbar-header
+            %button.navbar-toggle{"data-target" => ".navbar-collapse", "data-toggle" => "collapse", type: "button"}
+              %span.sr-only Toggle navigation
+              %span.icon-bar
+              %span.icon-bar
+              %span.icon-bar
+            %a.navbar-brand{href: "https://rubygems.org/gems/gitalytics"} Gitalytics
+          .collapse.navbar-collapse
+            %ul.nav.navbar-nav
+              %li.active
+                %a{data: {toggle: :tab}, href: "#dashboard"} Dashboard
+              %li
+                %a{data: {toggle: :tab}, href: "#authors"} Authors
+              %li
+                %a{data: {toggle: :tab}, href: "#commits"} Commits
+              %li
+                %a{data: {toggle: :tab}, href: "#dates"} Dates
+              / <li><a href="#contact">Contact</a></li>
+          / /.nav-collapse
+      / Begin page content
+      .container
+        .tab-content
+          = render :dashboard, users: @users, commits: @commits
+          = render :authors, users: @users
+          = render :commits, commits: @commits
+          = render :dates, commits: @commits
+    #footer
+      .container
+        %p.text-muted
+          Gitalytics v#{Gitalytics::VERSION} by
+          %a{href: "http://gonzalo.robaina.me"} Gonzalo Robaina
+    /
+      External JavaScript Files
+      \==================================================
+    %script{src: "https://code.jquery.com/jquery-2.2.4.min.js"}
+    %script{crossorigin: "anonymous", integrity: "sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS", src: "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js"}
+    %script{src: "https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.1.6/Chart.min.js"}
+    = render :javascript, { users: @users, weekday_commits: @weekday_commits }

data/bin/gitalytics

@@ -4,37 +4,46 @@
 Encoding.default_external = Encoding::UTF_8
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 
+require 'benchmark'
 require 'optparse'
 require 'gitalytics'
 
 options = {
+  benchmark: false,
   browser: false,
   format: 'cli',
   group_by: 'name'
 }
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: gitalytics [options]"
+  opts.banner = 'Usage: gitalytics [options]'
 
-  opts.on("-v", "--version", "Display gem version") do |v|
+  opts.on('-v', '--version', 'Display gem version') do
     p "Gitalytics #{Gitalytics::VERSION}"
     exit
   end
 
-  opts.on("-h", "--html", "Outputs html report and displays it in default web browser") do |v|
+  opts.on('-h', '--html', 'Outputs html report and displays it in default web browser') do
     options[:format] = 'html'
     options[:browser] = true
   end
 
-  opts.on("-n", "--no-browser", "Do not open html report in browser") do |v|
+  opts.on('-n', '--no-browser', 'Do not open html report in browser') do
     options[:format] = 'html'
     options[:browser] = false
   end
 
-  opts.on("-e", "--group-email", "Group commits by author's email address") do |v|
+  opts.on('-e', '--group-email', "Group commits by author's email address") do
     options[:group_by] = 'email'
   end
+
+  opts.on('-b', '--benchmark', 'Benchmark gitalytics') do
+    options[:benchmark] = true
+  end
 end.parse!
 
-Dir.chdir($1 || '.')
-Gitalytics.analyze(options)
+if options[:benchmark]
+  puts Benchmark.measure { Gitalytics.analyze(options) }
+else
+  Gitalytics.analyze(options)
+end

data/gitalytics.gemspec

@@ -4,25 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitalytics/version'
 
 Gem::Specification.new do |spec|
-  spec.name        = "gitalytics"
+  spec.name        = 'gitalytics'
   spec.version     = Gitalytics::VERSION
 
-  spec.authors     = ["Gonzalo Robaina"]
-  spec.email       = "gonzalor@gmail.com"
+  spec.authors     = ['Gonzalo Robaina']
+  spec.email       = 'gonzalo@robaina.me'
 
-  spec.summary     = "Git Analytics"
-  spec.description = "Get usefull analytics from your git log"
-  spec.homepage    = "http://gonza.uy/gitalytics"
-  spec.license     = "MIT"
+  spec.summary     = 'Git Analytics'
+  spec.description = 'Get usefull analytics from your git log'
+  spec.homepage    = 'http://gonza.uy/gitalytics'
+  spec.license     = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "color-generator"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_dependency 'color-generator'
+  spec.add_dependency 'haml'
 end

data/lib/gitalytics.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require 'erb'
+require 'haml'
 require 'matrix'
 require 'gitalytics/commit'
 require 'gitalytics/gitlog'
@@ -8,6 +8,7 @@ require 'gitalytics/user'
 require 'gitalytics/version'
 
 module Gitalytics
+  OUTPUT_FILE = 'gitalytics_result.html'.freeze
 
   module_function
 
@@ -32,31 +33,35 @@ module Gitalytics
     end
   end
 
+  def prepare_data(data)
+    @users = data[:users].sort { |x, y| y.commits.length <=> x.commits.length }
+    @commits = data[:commits]
+    weekday_commits = @users.map(&:weekday_commits)
+    @weekday_commits = weekday_commits.map { |a| Vector[*a] }.inject(:+).to_a
+  end
+
+  def template_file
+    dir           = File.dirname(__FILE__)
+    filepath      = File.join(dir, '..', 'assets', 'gitalytics.html.haml')
+    File.read(filepath)
+  end
+
   def output_html_report(data, open_in_browser)
-    template_file = File.read(File.join(File.dirname(__FILE__), "..", "assets", "gitalytics.html.erb"))
-    erb = ERB.new(template_file)
-    output_file = "gitalytics_result.html"
-    File.open(output_file, 'w+') do |file|
-      @users = data[:users].sort do |x, y|
-        y.commits.length <=> x.commits.length
-      end
-      @commits = data[:commits]
-      weekday_commits = @users.map(&:weekday_commits)
-      @weekday_commits = weekday_commits.map { |a| Vector[*a] }.inject(:+).to_a
-
-      file.write(erb.result(binding))
+    File.open(OUTPUT_FILE, 'w+') do |file|
+      prepare_data(data)
+      file.write(Haml::Engine.new(template_file).render(self))
     end
-    open_report_in_browser(output_file) if open_in_browser
+    open_report_in_browser if open_in_browser
   end
 
-  def open_report_in_browser(filename)
-    host = RbConfig::CONFIG['host_os']
-    if host =~ /mswin|mingw|cygwin/
-      system "start #{filename}"
-    elsif host =~ /darwin/
-      system "open #{filename}"
-    elsif host =~ /linux|bsd/
-      system "xdg-open #{filename}"
+  def open_report_in_browser
+    case RbConfig::CONFIG['host_os']
+    when /mswin|mingw|cygwin/
+      system "start #{OUTPUT_FILE}"
+    when /darwin/
+      system "open #{OUTPUT_FILE}"
+    when /linux|bsd/
+      system "xdg-open #{OUTPUT_FILE}"
     end
   end
 end

data/lib/gitalytics/commit.rb

@@ -1,5 +1,4 @@
 class Commit
-
   attr_accessor :hash, :author, :date, :subject, :summary
 
   def initialize(hash)
@@ -8,15 +7,14 @@ class Commit
   end
 
   def insertions
-    summary.inject(0) { |total, current| total + current[:insertions] }
+    summary.inject(0) { |a, e| a + e[:insertions] }
   end
 
   def deletions
-    summary.inject(0) { |total, current| total + current[:deletions] }
+    summary.inject(0) { |a, e| a + e[:deletions] }
   end
 
   def files_committed
-    summary.map{ |s| s[:filename] }
+    summary.map { |s| s[:filename] }
   end
-
 end

data/lib/gitalytics/gitlog.rb

@@ -3,20 +3,19 @@ require 'gitalytics/user'
 require 'date'
 
 module GitLog
-
   module_function
 
-  def parse_git_log(group_by)
-    users, commits = [], []
+  @users   = []
+  @commits = []
 
-    log = get_log
-    blocks = get_blocks(log)
+  def parse_git_log(group_by)
+    blocks = get_blocks(get_log)
 
     blocks.each do |(hash, block_string)|
-      commits << parse_block(hash, block_string, users, group_by)
+      @commits << parse_block(hash, block_string, group_by)
     end
 
-    {users: users, commits: commits}
+    { users: @users, commits: @commits }
   end
 
   def get_log
@@ -25,13 +24,13 @@ module GitLog
 
   def get_blocks(log_string)
     commits = log_string.scan(/^([a-f0-9]{40})/).map(&:first)
-    blocks = log_string.split(/^[a-f0-9]{40}/).map(&:strip)
+    blocks  = log_string.split(/^[a-f0-9]{40}/).map(&:strip)
     blocks.shift # get rid of first empty string
 
     commits.zip(blocks)
   end
 
-  def parse_block(hash, block_string, users, group_by)
+  def parse_block(hash, block_string, group_by)
     commit = Commit.new(hash)
 
     block_string.encode!('UTF-8', 'UTF8-MAC') if defined?(Encoding::UTF8_MAC)
@@ -41,41 +40,39 @@ module GitLog
     commit.subject = data[:subject]
     commit.date = Date.parse(data[:date])
 
-    get_commit_author(data, commit, users, group_by)
+    get_commit_author(data, commit, group_by)
     get_commit_summary(block_string, commit)
 
     commit
   end
 
   def get_commit_summary(block_string, commit)
-    block_string.scan(/^(?<insertions>\d+)\s+(?<deletions>\d+)\s+(?<filename>.*)$/).each do |summary|
+    regex = /^(?<insertions>\d+)\s+(?<deletions>\d+)\s+(?<filename>.*)$/
+    block_string.scan(regex).each do |summary|
       commit.summary << {
         insertions: summary[0].to_i,
         deletions: summary[1].to_i,
-        filename: summary[2],
+        filename: summary[2]
       }
     end
   end
 
-  def get_commit_author(data, commit, users, group_by)
-    user = get_user(data[:name], data[:email], users, group_by)
+  def get_commit_author(data, commit, group_by)
+    user = get_user(data[:name], data[:email], group_by)
 
     commit.author = user
     user.commits << commit
   end
 
-  def get_user(name, email, users, group_by)
-    if group_by == 'name'
-      users.each do |user|
-        return user if user.name == name
-      end
-    elsif group_by == 'email'
-      users.each do |user|
-        return user if user.email == email
-      end
+  def get_user(name, email, group_by)
+    case group_by
+    when 'name'
+      u = @users.index { |user| user.name == name }
+    when 'email'
+      u = @users.index { |user| user.email == email }
     end
-    users << new_user = User.new(name, email)
+    return @users[u] if u
+    @users << new_user = User.new(name, email)
     new_user
   end
-
 end

data/lib/gitalytics/user.rb

@@ -2,14 +2,15 @@ require 'color-generator'
 require 'digest/md5'
 
 class User
-
   attr_accessor :name, :email, :commits, :colors
 
   def initialize(name, email)
-    self.name = name
-    self.email = email
+    self.name    = name
+    self.email   = email
     self.commits = []
-    self.colors = ColorGenerator.new(saturation: 0.3, lightness: 0.75).create_rgb.join(', ')
+    self.colors  = ColorGenerator.new(saturation: 0.3, lightness: 0.75)
+                                 .create_rgb
+                                 .join(', ')
   end
 
   def gravatar
@@ -33,11 +34,11 @@ class User
   end
 
   def total_insertions
-    commits.map(&:insertions).inject(0) { |total, current| total + current }
+    commits.map(&:insertions).inject(0) { |a, e| a + e }
   end
 
   def total_deletions
-    commits.map(&:deletions).inject(0) { |total, current| total + current }
+    commits.map(&:deletions).inject(0) { |a, e| a + e }
   end
 
   def total_changes
@@ -45,7 +46,8 @@ class User
   end
 
   def summary
-    "#{name} has made #{commits.count} commits on #{working_days} separate days during a span of #{commits_period} days."
+    "#{name} has made #{commits.count} commits on #{working_days} "\
+    "separate days during a span of #{commits_period} days."
   end
 
   def rgba(opacity = 1)
@@ -53,10 +55,8 @@ class User
   end
 
   def weekday_commits
-    days = Array.new(7) {0}
-    commits.each do |c|
-      days[c.date.wday] += 1
-    end
+    days = Array.new(7) { 0 }
+    commits.each { |c| days[c.date.wday] += 1 }
     days
   end
 end

data/lib/gitalytics/version.rb

@@ -1,3 +1,3 @@
 module Gitalytics
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/lib/haml_helper.rb

@@ -0,0 +1,8 @@
+module Haml::Helpers
+  def render(partial, locals = {})
+    dir      = File.dirname(__FILE__)
+    filepath = File.join(dir, '..', 'assets', "_#{partial}.html.haml")
+    file     = File.read(filepath)
+    Haml::Engine.new(file).render(Object.new, locals)
+  end
+end

data/test/files/block1

@@ -0,0 +1,4 @@
+2013-02-13 23:11:16 -0200 Gonzalo Robaina <gonzalor@gmail.com> Print basic commit report on the console
+
+6       1       bin/gitalytics
+33      6       lib/gitalytics.rb

data/test/files/block2

@@ -0,0 +1,4 @@
+2012-12-19 06:04:59 -0800 Gonzalo Robaina <gonzalor@gmail.com> Initial commit
+
+16      0       .gitignore
+4       0       README.md

data/test/files/block3

@@ -0,0 +1,7 @@
+2012-12-06 10:29:49 -0200 Gonzalo Robaina <gonzalor@gmail.com> initial commit
+
+1       0       README.md
+3       0       bin/gitalytics
+13      0       gitalytics.gemspec
+49      0       lib/gist.rb
+11      0       lib/gitalytics.rb

data/test/files/git_log

@@ -0,0 +1,15 @@
+bea63e76c7c6d5afd42ac5b24a911b36e5c261f9 2013-02-13 23:11:16 -0200 Gonzalo Robaina <gonzalor@gmail.com> Print basic commit report on the console
+
+6       1       bin/gitalytics
+33      6       lib/gitalytics.rb
+d392710a9e657c72e73ca87df3ed2c8c802441e4 2012-12-19 06:04:59 -0800 Gonzalo Robaina <gonzalor@gmail.com> Initial commit
+
+16      0       .gitignore
+4       0       README.md
+9a99ae5dbc1eaadf268ca925cce9b68d10216151 2012-12-06 10:29:49 -0200 Gonzalo Robaina <gonzalor@gmail.com> initial commit
+
+1       0       README.md
+3       0       bin/gitalytics
+13      0       gitalytics.gemspec
+49      0       lib/gist.rb
+11      0       lib/gitalytics.rb