diggit-developers_activity 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1edbd6db19ea1f6e92927be44f6fc51100f0a5a3
+  data.tar.gz: 080b18b468e0f011fd09631bd19160585a98db7e
+SHA512:
+  metadata.gz: bb5086afe6dc38508ed69f5471c826254f0390e3661febc76c4bdbb8b16508e33a2e396481130a1699b22001af4c7204d19b7780ec27ba447cf2fcb92d9ae7fd
+  data.tar.gz: 82d212f17b36e2009d54ec2f1e9c9726855e16c4e8d2be8cfc8c384f8095f99bf57b3dabf20b866c70050698ff7f20a33ce49b6d656d35326bcbd6b3064fa1d5

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in diggit-developers_activity.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,31 @@
+# Diggit::DevelopersActivity
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'diggit-developers_activity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install diggit-developers_activity
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/diggit-developers_activity/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/diggit-init-dev-activity-workspace

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "diggit/developers_activity/workspace_init"
+
+Diggit::DevelopersActivity::WorkspaceInit.init

data/diggit-developers_activity.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diggit/developers_activity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "diggit-developers_activity"
+  spec.version       = Diggit::DevelopersActivity::VERSION
+  spec.authors       = ["Matthieu Foucault"]
+  spec.email         = ["foucault.matthieu@gmail.com"]
+  spec.summary       = "Analyses and dataset for the diggit tool."
+  spec.description   = "This gem contains a set of analyses extracting developers activity from git repositories,
+  using different granularities of time periods. It also includes a dataset of git repositories for which we extacted
+  the identity of bug-fixing commits for a given release, as well as author identity merge information."
+  spec.homepage      = ""
+  spec.license       = "LGPL"
+
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "diggit", "~> 1.0"
+end

data/lib/diggit/developers_activity.rb

@@ -0,0 +1,12 @@
+require "diggit/developers_activity/version"
+require "diggit/developers_activity/activity_extractor"
+require "diggit/developers_activity/module_metrics_extractor"
+require "diggit/developers_activity/analyses"
+require "diggit/developers_activity/workspace_init"
+
+module Diggit
+	module DevelopersActivity
+		DIFF_OPTIONS = { ignore_whitespace: true, ignore_filemode: true }
+		DIFF_RENAME_OPTIONS = { renames: true, ignore_whitespace: true }
+	end
+end

data/lib/diggit/developers_activity/activity_extractor.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'diggit/developers_activity/activity_extractor/renames'
+require 'diggit/developers_activity/activity_extractor/modules'
+require 'diggit/developers_activity/activity_extractor/authors'
+require 'diggit/developers_activity'
+
+module Diggit
+	module DevelopersActivity
+		# Set of functions extracting developers activity for a given set of commits
+		module ActivityExtractor
+			extend self
+
+			def extract_developers_activity(source, commits, commits_group_id = nil)
+				return [] if commits.empty?
+				contributions = Hash.new { |hash, key| hash[key] = { touches: 0, churn: 0 } }
+				num_commits = 0
+
+				commits.each do |commit|
+					num_commits += 1
+
+					author = Authors.get_author(commit)
+
+					commit.parents.each do |parent|
+						diff = parent.diff(commit, DIFF_OPTIONS)
+						diff.find_similar!(DIFF_RENAME_OPTIONS)
+						diff.each do |patch|
+							maudule = Modules.get_patch_module(patch)
+							next if maudule.nil?
+
+							key = { author: author, 'module' => maudule }
+							contributions[key] = { touches: contributions[key][:touches] + 1,
+																		churn: contributions[key][:churn] + patch.stat[0] + patch.stat[1] }
+						end
+					end
+				end
+
+				puts "num commits #{num_commits}"
+
+				fist_commit_date = commits[0].author[:time]
+
+				# compute metrics and write to result
+				developer_metrics = []
+				contributions.each do |key, value|
+					developer_metrics << { project: source, developer: key[:author], 'module' => key[:module],
+						touches: value[:touches], churn: value[:churn], releaseDate: fist_commit_date,
+						commits_group_id: commits_group_id }
+				end
+				developer_metrics
+			end
+		end
+	end
+end

data/lib/diggit/developers_activity/activity_extractor/authors.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Diggit
+	module DevelopersActivity
+		module ActivityExtractor
+			# Deals with authors identity merging
+			module Authors
+				extend self
+
+				def read_options(source_options)
+					@authors_merge = {}
+					source_options['authors'].each_pair do |k, v|
+						@authors_merge[k.downcase] = v.downcase
+					end
+				end
+
+				def get_author(commit)
+					author = commit.author[:name].downcase
+					((defined? @authors_merge) && (@authors_merge.key? author)) ? @authors_merge[author] : author
+				end
+			end
+		end
+	end
+end

data/lib/diggit/developers_activity/activity_extractor/modules.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'diggit/developers_activity/activity_extractor/renames'
+
+module Diggit
+	module DevelopersActivity
+		module ActivityExtractor
+			# Methods retrieving the module associated to a file.
+			module Modules
+				extend self
+
+				MODULES_REGEXP = "modules"
+				FILE_FILTER = "file-filter"
+
+				def read_options(source, source_options, db)
+					@source = source
+					@db = db
+					@release_files = files_from_cloc_analysis
+					@modules_regexp = source_options.key?(MODULES_REGEXP) ? source_options[MODULES_REGEXP].map { |m| Regexp.new m } : []
+					@file_filter = Regexp.new source_options[FILE_FILTER]
+					@file_filter ||= //
+				end
+
+				def ignore_file?(path)
+					!@release_files.include?(path) || (@file_filter =~ path).nil?
+				end
+
+				def get_module(path)
+					path = Renames.apply(path)
+
+					return nil if ignore_file?(path)
+					@modules_regexp.each do |module_regexp|
+						return module_regexp.to_s if module_regexp =~ path
+					end
+
+					path
+				end
+
+				def get_patch_module(patch)
+					file = patch.delta.old_file[:path]
+					get_module(file)
+				end
+
+				def files_from_cloc_analysis
+					release_files = Set.new
+					cloc_source = @db.db['cloc-file'].find_one({ source: @source })
+					cloc_source["cloc"].each do |cloc_file|
+						release_files << cloc_file["path"]
+					end
+					release_files
+				end
+			end
+		end
+	end
+end

data/lib/diggit/developers_activity/activity_extractor/renames.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'diggit/developers_activity'
+
+module Diggit
+	module DevelopersActivity
+		module ActivityExtractor
+			# Stores file renaming operations.
+			# Allows to retrieve the initial path of a file after having performed a diff on the renaming commits.
+			#
+			# @since 0.0.1
+			module Renames
+				extend self
+
+				def hash
+					@renames_hash ||= {}
+				end
+
+				def clear
+					@renames_hash = {}
+				end
+
+				# Adds a rename operation to the list, if the rename does not create a cycle
+				#
+				# @return true if the rename was added, false otherwise
+				def add(src_path, dest_path)
+					# check for cycle, ie, if there is a rename path from dest to src
+					path = dest_path
+					while hash.key? path
+						path = hash[path]
+						return false if path == src_path
+					end
+
+					hash[src_path] = dest_path
+					true
+				end
+
+				# Apply all renaming operations found on the given path
+				#
+				# @return the path of the file at the S0 snapshot
+				def apply(path)
+					path = hash[path] while hash.key? path
+					path
+				end
+
+				def extract_commit_renames(commit, walk_backwards = true)
+					commit.parents.each do |parent|
+						diff = parent.diff(commit, DIFF_OPTIONS)
+						diff.find_similar!(DIFF_RENAME_OPTIONS)
+						diff.each do |patch|
+							next unless patch.delta.renamed?
+							if walk_backwards
+								renamed_path = patch.delta.new_file[:path]
+								new_path = patch.delta.old_file[:path]
+							else
+								new_path = patch.delta.new_file[:path]
+								renamed_path = patch.delta.old_file[:path]
+							end
+							add(renamed_path, new_path)
+						end
+					end
+				end
+
+				def extract_renames(walker, walk_backwards = true)
+					walker.each { |commit| extract_commit_renames(commit, walk_backwards) }
+				end
+			end
+		end
+	end
+end