contributors 0.1.2 → 0.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+= Version 0.2
+  * Rewritten using Grit.
+  * Ignored patterns don't work anymore.
+  * Contributors#results takes the criterium for counting
+    lines of code as the second argument. It can be either
+    :additions, :deletions or :total, which is the default value.
+
 = Version 0.1
   * The actual library.
   * Nake tasks for generating CONTRIBUTORS.

data/README.textile

@@ -17,13 +17,19 @@ require "contributors"
 
 contributors = Contributors.new
 contributors.results
-# => {"stastny@101ideas.cz" => {:name => "Jakub Stastny aka botanicus", :commits = >3, :LOC = >219}}
+# => {#<Grit::Actor "Jakub Stastny aka botanicus <stastny@101ideas.cz>"> => {:commits => 9, :LOC => 255}}
 
-# You can optionally specify project path and list of ignored patterns thusly:
-contributors = Contributors.new(Dir.pwd, [/^(vendor|gems)\//, /.+\.gem$/])
+# You can optionally specify project path thusly:
+contributors = Contributors.new(Dir.pwd)
 
-# The Contributors#result method takes an optional argument determining by which field you want to sort the results:
-contributors.resuls(:LOC) # or :commits
+# The Contributors#result method takes an optional argument
+# determining by which field you want to sort the results:
+contributors.results(:LOC) # or :commits
+
+# By default it takes all the changes (as the second argument
+# defaults to :total), but if you want, you can limit changes
+# on :additions or :deletions only:
+contributors.results(:LOC, :additions)
 </pre>
 
 Use the "Nake":https://github.com/botanicus/nake tasks:
@@ -42,11 +48,11 @@ Task[:contributors].config[:output_path] = Proc.new { File.join(task.config[:pat
 # OPTIONAL: How to sort results, options are :commits or :LOC, :LOC is default.
 Task[:contributors].config[:sort_by] = :LOC
 
-# OPTIONAL: An array of regular expressions which should be ignored.
-# Defaults to Contributors::IGNORED_PATTERNS, which is [/^vendor\//, /^gems\//, /.+\.gem$/].
-Task[:contributors].config[:ignore] = Contributors::IGNORED_PATTERNS
+# OPTIONAL: Criterium for counting lines of code. Can be either
+# :additions, :deletions or :total (which is the default value).
+Task[:contributors].config[:criterium] = :total
 
 # OPTIONAL: How to format each line. E-mail is author's e-mail and in data
 there are keys :name, :commits and :LOC. Commits and LOC are both integers.
-Task[:contributors].config[:format] = -> { |email, data| "#{email}: #{data[:LOC]}" }
+Task[:contributors].config[:format] = -> { |author, data| "#{author.email}: #{data[:LOC]}" }
 </pre>

data/contributors.gemspec

@@ -5,9 +5,9 @@ require "base64"
 
 Gem::Specification.new do |s|
   s.name = "contributors"
-  s.version = "0.1.2"
+  s.version = "0.2"
   s.authors = ["Jakub Stastny aka botanicus"]
-  s.homepage = "http://github.com/botanicus/contributors"
+  s.homepage = "https://github.com/botanicus/contributors"
   s.summary = "API for getting info about contributors of a project which is in Git."
   s.description = "The contributors gem is useful for getting informations about project contributors. It assumes that Git is used. In particular it can be used for generating CONTRIBUTORS file."
   s.cert_chain = nil
@@ -33,6 +33,9 @@ Gem::Specification.new do |s|
     s.post_install_message = CHANGELOG.new.version_changes
   end
 
+  # Dependencies
+  s.add_dependency "grit"
+
   # RubyForge
   s.rubyforge_project = "contributors"
 end

data/lib/contributors.nake

@@ -6,9 +6,9 @@ Task.new(:contributors) do |task|
   # Settings.
   task.config[:path]        = Dir.pwd
   task.config[:output_path] = Proc.new { File.join(task.config[:path], "CONTRIBUTORS") }
-  task.config[:ignore]      = nil
   task.config[:sort_by]     = :LOC
-  task.config[:format]      = Proc.new { |email, data| "#{data[:name]}: #{data[:commits]} (#{data[:LOC]} LOC)" }
+  task.config[:criterium]   = :total
+  task.config[:format]      = Proc.new { |author, data| "#{author.name}: #{data[:commits]} commits, #{data[:LOC]} LOC" }
 
   # Helpers.
   def task.output_path
@@ -19,21 +19,20 @@ Task.new(:contributors) do |task|
     end
   end
 
-  def task.ignored_patterns
-    self.config[:ignore] || Contributors::IGNORED_PATTERNS
-  end
-
   # Define the actual task.
   task.define do
     require "contributors"
 
     Dir.chdir(task.config[:path]) do
-      contributors = Contributors.new(task.config[:path], task.ignored_patterns)
+      contributors = Contributors.new(task.config[:path])
 
       # Write the actual CONTRIBUTORS file.
       File.open(task.output_path, "w") do |file|
-        contributors.results.each do |email, data|
-          file.puts(task.config[:format].call(email, data))
+        sort_by = self.config[:sort_by]
+        criterium = self.config[:criterium]
+
+        contributors.results(sort_by, criterium).each do |author, data|
+          file.puts(task.config[:format].call(author, data))
         end
       end
     end

data/lib/contributors.rb

@@ -1,65 +1,58 @@
 # encoding: utf-8
 
-# TODO: Use Grit or something rather than this black magic.
+require "grit"
+
 class Contributors
-  IGNORED_PATTERNS = [/^vendor\//, /^gems\//, /.+\.gem$/]
+  attr_reader :path
+  def initialize(path = Dir.pwd)
+    @path = path
+  end
 
-  attr_reader :path, :ignored_patterns
-  def initialize(path = Dir.pwd, ignored_patterns = IGNORED_PATTERNS)
-    @path, @ignored_patterns = path, ignored_patterns
+  def repo
+    @repo ||= Grit::Repo.new(@path)
   end
 
-  def list
-    repo do
-      authors = %x{git log | grep ^Author:}.split("\n")
-      results = authors.reduce(Hash.new) do |results, line|
-        line.match(/^Author: (.+) <(.+)>$/)
-        name, email = $1, $2
-        results[email] ||= Hash.new
-        results[email][:name] = name
-        results[email][:commits] ||= 0
-        results[email][:commits] += 1
-        results[email][:LOC] = loc[email] || 0
-        results
-      end
+  def authors_and_commits
+    hash = Hash.new { |hash, key| hash[key] = Array.new }
+    repo.commits("master", false).reduce(hash) do |buffer, commit|
+      key = buffer.keys.find { |author| author.email == commit.author.email }
+      key ||= commit.author
+
+      buffer[key] << commit
+      buffer
     end
   end
 
-  def results(sort_by = :LOC)
-    unless [:commits, :LOC].include?(sort_by)
-      raise "Sort_by argument can be only :commits or :LOC!"
+  # ["additions", "deletions", "total"]
+  def list(criterium = :total)
+    unless [:additions, :deletions, :total].include?(criterium)
+      raise ArgumentError.new("Criterium can be one of: :additions, :deletions or :total.")
     end
 
-    self.list.sort_by { |_, data| data[sort_by] }.reverse
-  end
-
-  private
-  def repo(&block)
-    Dir.chdir(@path, &block)
-  end
+    authors_and_commits.reduce(Hash.new) do |buffer, pair|
+      author, commits = pair
+      buffer[author] = {
+        commits: commits.length,
+        LOC: commits.reduce(0) do |lines, commit|
+          lines + commit.stats.to_hash[criterium.to_s]
+        end
+      }
 
-  def files
-    files = %x{git ls-files}.split("\n")
-    files.select do |path|
-      self.ignored_patterns.any? do |pattern|
-        not path.match(pattern)
-      end
+      buffer
     end
   end
 
-  # TODO: At the moment this are any lines, not lines of code.
-  # {email_1 => LOC for email_1, email_2 => LOC for email_2}
-  def loc
-    @loc ||= begin
-      files.reduce(Hash.new) do |buffer, path|
-        emails = %x{git blame '#{path}' --show-email | awk '{ print $2 }' | ruby -pe '$_.sub!(/^.*<(.+)>.*$/, "\\\\1")'}
-        emails.split("\n").each do |email|
-          buffer[email] ||= 0
-          buffer[email] += 1
-        end
+  def results(sort_by = :LOC, criterium = :total)
+    unless [:commits, :LOC].include?(sort_by)
+      raise "Sort_by argument can be only :commits or :LOC!"
+    end
 
-        buffer
-      end
+    # Note: Hash#sort_by(&block) returns an Array, even on 1.9,
+    # which isn't really necessary, as hashes on 1.9 are sorted.
+    sorted_array = self.list(criterium).sort_by { |_, data| data[sort_by] }
+    sorted_array.reverse.reduce(Hash.new) do |buffer, pair|
+      author, stats = pair
+      buffer.merge(author => stats)
     end
   end
 end

data/tasks.rb

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
 
 load "contributors.nake"
 
-Task[:contributors].config[:format] = Proc.new { |email, data| "#{email}: #{data.inspect}" }
+Task[:contributors].config[:format] = Proc.new { |author, data| "#{author.inspect}: #{data.inspect}" }

metadata

@@ -2,17 +2,27 @@
 name: contributors
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: "0.2"
 platform: ruby
 authors: 
 - Jakub Stastny aka botanicus
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2011-03-13 00:00:00 +00:00
+date: 2011-05-02 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: The contributors gem is useful for getting informations about project contributors. It assumes that Git is used. In particular it can be used for generating CONTRIBUTORS file.
 email: stastny@101ideas.cz
 executables: []
@@ -31,11 +41,12 @@ files:
 - lib/contributors.rb
 - tasks.rb
 has_rdoc: true
-homepage: http://github.com/botanicus/contributors
+homepage: https://github.com/botanicus/contributors
 licenses: []
 
-post_install_message: "[\e[32mVersion 0.1\e[0m] The actual library.\n\
-  [\e[32mVersion 0.1\e[0m] Nake tasks for generating CONTRIBUTORS.\n"
+post_install_message: "[\e[32mVersion 0.2\e[0m] Rewritten using Grit.\n\
+  [\e[32mVersion 0.2\e[0m] Ignored patterns don't work anymore.\n\
+  [\e[32mVersion 0.2\e[0m] Contributors#results takes the criterium for counting lines of code as the second argument. It can be either :additions, :deletions or :total, which is the default value.\n"
 rdoc_options: []
 
 require_paths: