contributors 0.1

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/CHANGELOG

@@ -0,0 +1,3 @@
+= Version 0.1
+  * The actual library.
+  * Nake tasks for generating CONTRIBUTORS.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jakub Stastny aka botanicus
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,42 @@
+h1. About
+
+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.
+
+h1. Usage
+
+Just install it through RubyGems:
+
+<pre>
+gem install contributors
+</pre>
+
+Use the API:
+
+<pre>
+require "contributors"
+</pre>
+
+Use the "Nake":https://github.com/botanicus/nake tasks:
+
+<pre>
+load "contributors.nake"
+
+# OPTIONAL: Where the project is located. Defaults to Dir.pwd.
+Task[:contributors].config[:path] = Dir.pwd
+
+# OPTIONAL: Where the CONTRIBUTORS file is located.
+# It can be either a string or a callable object. Defaults to:
+# Proc.new { File.join(task.config[:path], "CONTRIBUTORS") }
+Task[:contributors].config[:output_path] = Proc.new { File.join(task.config[:path], "CONTRIBUTORS") }
+
+# 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: 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]}" }
+</pre>

data/contributors.gemspec

@@ -0,0 +1,38 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require "base64"
+
+Gem::Specification.new do |s|
+  s.name = "contributors"
+  s.version = "0.1"
+  s.authors = ["Jakub Stastny aka botanicus"]
+  s.homepage = "http://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
+  s.email = Base64.decode64("c3Rhc3RueUAxMDFpZGVhcy5jeg==\n")
+  s.has_rdoc = true
+
+  # files
+  s.files = `git ls-files`.split("\n")
+
+  s.require_paths = ["lib"]
+
+  # Ruby version
+  # Current JRuby with --1.9 switch has RUBY_VERSION set to "1.9.2dev"
+  # and RubyGems don't play well with it, so we have to set minimal
+  # Ruby version to 1.9, even if it actually is 1.9.1
+  s.required_ruby_version = ::Gem::Requirement.new("~> 1.9")
+
+  begin
+    require "changelog"
+  rescue LoadError
+    warn "You have to have changelog gem installed for post install message"
+  else
+    s.post_install_message = CHANGELOG.new.version_changes
+  end
+
+  # RubyForge
+  s.rubyforge_project = "contributors"
+end

data/lib/contributors.nake

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+Task.new(:contributors) do |task|
+  task.description = "Regenerate contributors file."
+
+  # 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)" }
+
+  # Helpers.
+  def task.output_path
+    if self.config[:output_path].respond_to?(:call)
+      self.config[:output_path].call
+    else
+      self.config[:output_path]
+    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)
+
+      # 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))
+        end
+      end
+    end
+  end
+end

data/lib/contributors.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+# TODO: Use Grit or something rather than this black magic.
+class Contributors
+  IGNORED_PATTERNS = [/^vendor\//, /^gems\//, /.+\.gem$/]
+
+  attr_reader :path, :ignored_patterns
+  def initialize(path = Dir.pwd, ignored_patterns = IGNORED_PATTERNS)
+    @path, @ignored_patterns = path, ignored_patterns
+  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]
+        p loc
+        results
+      end
+    end
+  end
+
+  def results(sort_by = :LOC)
+    unless [:commits, :LOC].include?(sort_by)
+      raise "Sort_by argument can be only :commits or :LOC!"
+    end
+
+    self.list.sort_by { |_, data| data[sort_by] }.reverse
+  end
+
+  private
+  def repo(&block)
+    Dir.chdir(@path, &block)
+  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
+    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
+
+        buffer
+      end
+    end
+  end
+end

data/tasks.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env nake
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+
+load "contributors.nake"
+
+Task[:contributors].config[:format] = Proc.new { |email, data| "#{email}: #{data.inspect}" }

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: contributors
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Jakub Stastny aka botanicus
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2011-03-07 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+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: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.textile
+- contributors.gemspec
+- lib/contributors.nake
+- lib/contributors.rb
+- tasks.rb
+has_rdoc: true
+homepage: http://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"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: contributors
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: API for getting info about contributors of a project which is in Git.
+test_files: []
+