MFOL-bugspots 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8954c0d8725adbc49e46c0b41f04baf63ee79c3b
+  data.tar.gz: d1ae42eff16eaf6999feb4197ce435b4ef8d66ec
+SHA512:
+  metadata.gz: 7f8afae0ea150a481fd8d97d19983cda64d55a55b9b22f9ece1f6e7e7bee8a8efef7fdf3eb3adc72405e7943eedd848266357d8c0d8904acb727daf5a6f35e42
+  data.tar.gz: 369da80bdcf592809f7868fc7a2e054e3a23c11e764347a54f355df606aa5cac9aea30523093eb1fa1398b4a436622a28efad872bf5cb1244813ec443d81150c

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rbenv-version

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+#gem 'rugged', git: 'git://github.com/libgit2/rugged.git', branch: 'development', submodules: true
+
+# Specify your gem's dependencies in bugspots.gemspec
+gemspec

data/README.md

@@ -0,0 +1,89 @@
+# Bugspots - Bug Prediction Heuristic
+
+An implementation of the simple bug prediction heuristic outlined by the Google Engineering team: [Bug Prediction at Google](http://google-engtools.blogspot.com/2011/12/bug-prediction-at-google.html)
+
+> Well, we actually have a great, authoritative record of where code has been requiring fixes: our bug tracker and our source control commit log! The research indicates that predicting bugs from the source history works very well, so we decided to deploy it at Google.
+
+Point bugspots at any git repo and it will identify the hotspots for you.
+
+## Usage
+
+```bash
+$> gem install bugspots
+$> bugspots /path/to/repo
+$> git bugspots (in root of current git project, --help for options)
+```
+
+## Results
+
+```bash
+$> cd /your/git/repo
+$> git bugspots -d 500
+
+  .. example output ..
+
+	Scanning /git/eventmachine repo
+	Found 31 bugfix commits, with 23 hotspots:
+
+	Fixes:
+		- Revert "Write maximum of 16KB of data to an SSL connection per tick (fixes #233)" for #273
+		- Do not close attached sockets (fixes #200)
+		- Write maximum of 16KB of data to an SSL connection per tick (fixes #233)
+		- Merge branch 'master' into close_schedule_fix
+		- Remove dependency on readbytes.rb for ruby 1.9 (fixes #167, #234)
+		- Fix compilation on MSVC2008 (fixes #253)
+		- EM::Deferrable#(callback|errback|timeout) now return self so you can chain them (closes #177)
+		- Make EventMachine::Connection#get_peername and #get_sockname valid for IPv6 (closes #132)
+		- reconnect DNS socket if closed
+		- Use String#bytesize in EM::Connection#send_datagram for 1.9 (closes #153)
+		- Fix an issue that would cause the EM process to block when the loopbreak pipe filled up (closes #158)
+		- namespace std is already included, so just call min(). fixes vc6 issue with min macro
+		- Use close() instead of closesocket() to prevent FD leaks on windows.
+		- Stop advertising non-available authentication mechanisms, allow multi-line authentication - fixes compatibility with javamail
+		- typo fixes and undef fstat for ruby on Windows
+		- Deprecate now aged info, as it's fixed
+		- Some fixes for Solaris and Nexenta (opensolaris kernel + linux userland)
+		- Some fixes for solaris
+		- Minor fixes for rbx compatibility
+		- Reduce the size of the RunEpollOnce stack frame by 800kb. This fixes the long-standing epoll+threads issue (#84)
+		- Fixed aggregated event handling for kqueue and notify, fixed path for ifconfig.
+		- More win32 fixes
+		- Added test for reactor_thread? and fixed up EM.schedule for pre-reactor schedules
+		- Merge branch 'master' of git@github.com:eventmachine/eventmachine
+		- Use read instead of recv in ConnectionDescriptor::Read (fixes EM.attach issues with pipes)
+		- Use false to indicated a cancelled timer instead of using an empty proc. Reduces mem usage in certain situations.
+		- Inotify fixes: file_delete only fires after fds have been closed, use syscall hackery for older linux distributions (*cough* debian)
+		- Clean up deferrable.rb: fixed rdoc, alias method wrappers, remove unnecessary forwardable
+		- More solaris build fixes.
+		- More solaris build issues fixed
+		- fixed a small bug with basic auth (cherry-pick conflict merge from mmmurf (closes #92))
+
+	Hotspots:
+		0.9723 - ext/ed.cpp
+		0.3311 - ext/ed.h
+		0.3271 - ext/em.cpp
+		0.3034 - lib/eventmachine.rb
+		0.2433 - lib/em/protocols/postgres3.rb
+		0.2403 - ext/project.h
+		0.0431 - lib/em/deferrable.rb
+		0.029 - ext/cmain.cpp
+		0.0278 - ext/rubymain.cpp
+		0.0277 - ext/eventmachine.h
+		0.0241 - lib/em/resolver.rb
+		0.0241 - tests/test_resolver.rb
+		0.0225 - lib/em/connection.rb
+		0.0013 - lib/em/protocols/smtpserver.rb
+		0.0003 - ext/extconf.rb
+		0.0002 - tests/test_basic.rb
+		0.0001 - ext/em.h
+		0.0001 - ext/cplusplus.cpp
+		0.0001 - ext/fastfilereader/extconf.rb
+		0.0 - lib/em/filewatcher.rb
+		0.0 - tests/test_file_watch.rb
+		0.0 - ext/fastfilereader/mapper.cpp
+		0.0 - lib/protocols/httpclient.rb
+```
+
+### License
+
+(MIT License) - Copyright (c) 2011 Ilya Grigorik

data/Rakefile

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

data/bin/bugspots

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'bugspots'
+require 'optparse'
+require 'rainbow'
+require 'rainbow/ext/string'
+
+ARGV << '--help' if ARGV.empty?
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: bugspots /path/to/git/repo"
+
+  # Option: Set Branch
+  opts.on('-b', '--branch [name]', 'branch to crawl') do |b|
+    options[:branch] = b.to_s
+  end
+  
+  # Option: Set Bugfix Indicator
+  opts.on('-f', '--file [file extension]', 'The type of file to scan') do |f|
+    options[:fileExt] = f.to_s
+  end
+
+  # Option: Set Depth
+  opts.on('-d', '--depth [depth]', 'depth of log crawl (integer)') do |d|
+    options[:depth] = d.to_i
+  end
+
+  # Option: Set Bugfix Indicator
+  opts.on('-w', '--words ["w1,w2"]', 'bugfix indicator word list, ie: "fixes,closed"') do |words|
+    options[:regex] = Regexp.new(words.split(',').join('|'))
+  end
+
+  # Option: Set Bugfix Indicator
+  opts.on('-r', '--regex [regex]', Regexp, 'bugfix indicator regex, ie: "fix(es|ed)?" or "/fixes #(\d+)/i"') do |regex|
+    options[:regex] = regex
+  end
+
+  # Option: Set Timestamp Display
+  opts.on('--display-timestamps', 'show timestamps of each identified fix commit') do |dt|
+    options[:display_timestamps] = true
+  end
+end.parse!
+
+# Set a reasonable default of depth
+options[:depth] ||= 500
+
+# Set master as the default branch
+options[:branch] ||= "master"
+
+# Set the default file extionsion to include to be php
+options[:fileExt] ||= ".php"
+
+puts "Scanning #{ARGV[0]} repo with #{options[:fileExt]} files".foreground(:green)
+
+begin
+  fixes, spots = Bugspots.scan(ARGV[0], options[:branch], options[:fileExt], options[:depth], options[:regex])
+
+  puts "\tFound #{fixes.size} bugfix commits, with #{spots.size} hotspots:".foreground(:yellow)
+  puts
+
+  puts "\tFixes:".foreground(:green).underline
+  fixes.each do |fix|
+    message = "\t\t- "
+    message << "#{fix.date} " if options[:display_timestamps]
+    message << "#{fix.message}"
+    puts message.foreground(:yellow)
+  end
+
+  puts "\n"
+  puts "\tHotspots:".foreground(:green).underline
+  spots.each do |spot|
+    puts "\t\t#{spot.score}".foreground(:red) + " - #{spot.file}".foreground(:yellow)
+  end
+
+rescue Rugged::RepositoryError
+  puts "Invalid Git repository - please run from or specify the full path to the root of the project.".foreground(:red)
+end

data/bin/git-bugspots

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if ARGV.empty? or not Dir.exists? ARGV[0]
+  ARGV.unshift Dir.pwd
+end
+
+exec 'bugspots', ARGV.join(' ')

data/bugspots.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bugspots/version"
+
+Gem::Specification.new do |s|
+  s.license     = "MIT"
+  s.name        = "MFOL-bugspots"
+  s.version     = Bugspots::VERSION
+  s.authors     = ["Xiaoming Cai"]
+  s.email       = ["ming.cxm@gmail.com"]
+  s.homepage    = "https://github.com/cxm0000/MFOL-bugspots"
+  s.summary     = "Implementation of simple bug prediction hotspot heuristic"
+  s.description = s.summary
+
+  s.rubyforge_project = "MFOL-bugspots"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rugged", ">= 0.21.0"
+  s.add_dependency "rainbow"
+end

data/lib/bugspots.rb

@@ -0,0 +1,2 @@
+require "bugspots/version"
+require "bugspots/scanner"

data/lib/bugspots/scanner.rb

@@ -0,0 +1,63 @@
+require "rugged"
+
+module Bugspots
+  Fix = Struct.new(:message, :date, :files)
+  Spot = Struct.new(:file, :score)
+
+  # Filter all results before this threshold
+  ScoreThreshold = 0.01
+
+  def self.scan(repo, branch = "master", fileExt = ".php", depth = 500, regex = nil)
+
+    regex ||= /\b(fix(es|ed)?|close(s|d)?)\b/i
+    fixes = []
+
+    repo = Rugged::Repository.new(repo)
+    unless repo.branches.each_name(:local).sort.find { |b| b == branch }
+      raise ArgumentError, "no such branch in the repo: #{branch}"
+    end
+
+    walker = Rugged::Walker.new(repo)
+    walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE)
+    walker.push(repo.branches[branch].target)
+    walker.each do |commit|
+      if commit.message =~ regex
+        files = commit.diff(commit.parents.first).deltas.collect do |d|
+          d.old_file[:path]
+        end
+        fixes << Fix.new(commit.message.split("\n").first, commit.time, files)
+      end
+    end
+
+    hotspots = Hash.new(0)
+    fixes.each do |fix|
+      fix.files.each do |file|
+        
+        if File.extname(file).eql? fileExt
+        
+          # The timestamp used in the equation is normalized from 0 to 1, where
+          # 0 is the earliest point in the code base, and 1 is now (where now is
+          # when the algorithm was run). Note that the score changes over time
+          # with this algorithm due to the moving normalization; it's not meant
+          # to provide some objective score, only provide a means of comparison
+          # between one file and another at any one point in time
+          t = 1 - ((Time.now - fix.date).to_f / (Time.now - fixes.first.date))
+          hotspots[file] += 1/(1+Math.exp((-12*t)+12))
+        end
+      end
+    end
+
+    # filter out the files with very low scores
+    hotspots.each do |file, score|
+      if score <= ScoreThreshold
+        hotspots.delete(file)
+      end
+    end
+
+    spots = hotspots.sort_by {|k,v| v}.reverse.collect do |spot|
+      Spot.new(spot.first, sprintf('%.4f', spot.last))
+    end
+
+    return fixes, spots
+  end
+end

data/lib/bugspots/version.rb

@@ -0,0 +1,3 @@
+module Bugspots
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: MFOL-bugspots
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Xiaoming Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implementation of simple bug prediction hotspot heuristic
+email:
+- ming.cxm@gmail.com
+executables:
+- bugspots
+- git-bugspots
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/bugspots
+- bin/git-bugspots
+- bugspots.gemspec
+- lib/bugspots.rb
+- lib/bugspots/scanner.rb
+- lib/bugspots/version.rb
+homepage: https://github.com/cxm0000/MFOL-bugspots
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: MFOL-bugspots
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Implementation of simple bug prediction hotspot heuristic
+test_files: []