bugspots 0.1.0 → 0.1.1

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rbenv-version

data/README.md

@@ -10,15 +10,15 @@ Point bugspots at any git repo and it will identify the hotspots for you.
 
 ```
 $> gem install bugspots
-$> git bugspots /path/to/repo
-$> git bugspots . # (in current git directory)
+$> bugspots /path/to/repo
+$> git bugspots (in root of current git project, --help for options)
 ```
 
 ## Results
 
 ```
 $> cd /your/git/repo
-$> git bugspots .
+$> git bugspots -d 500
 
   .. example output .. 
 

data/bin/bugspots

@@ -0,0 +1,71 @@
+#!/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'
+
+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 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"
+
+puts "Scanning #{ARGV[0]} repo".foreground(:green)
+
+begin
+  fixes, spots = Bugspots.scan(ARGV[0], options[:branch], 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 Grit::InvalidGitRepositoryError
+  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

@@ -1,61 +1,7 @@
 #!/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'
-
-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 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, ie: "fixes,closed"') do |words|
-    options[:words] = words
-  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"
-
-puts "Scanning #{ARGV[0]} repo".foreground(:green)
-
-fixes, spots = Bugspots.scan(ARGV[0], options[:branch], options[:depth], options[:words])
-
-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)
+if ARGV.empty? or not Dir.exists? ARGV[0]
+  ARGV.unshift Dir.pwd
 end
 
-puts "\n"
-puts "\tHotspots:".foreground(:green).underline
-spots.each do |spot|
-  puts "\t\t#{spot.score}".foreground(:red) + " - #{spot.file}".foreground(:yellow)
-end
+exec("bugspots #{ARGV.join(' ')}")

data/lib/bugspots/scanner.rb

@@ -5,19 +5,19 @@ module Bugspots
   Fix = Struct.new(:message, :date, :files)
   Spot = Struct.new(:file, :score)
 
-  def self.scan(repo, branch = "master", depth = 500, words = nil)
+  def self.scan(repo, branch = "master", depth = 500, regex = nil)
     repo = Grit::Repo.new(repo)
+    unless repo.branches.find { |e| e.name == branch }
+      raise ArgumentError, "no such branch in the repo: #{branch}"
+    end
     fixes = []
 
-    if words
-      message_matchers = /#{words.split(',').join('|')}/
-    else
-      message_matchers = /fix(es|ed)?|close(s|d)?/i
-    end
+    regex ||= /fix(es|ed)?|close(s|d)?/i
 
+    tree = repo.tree(branch)
     repo.commits(branch, depth).each do |commit|  
-      if commit.message =~ message_matchers
-        files = commit.stats.files.map {|s| s.first}    
+      if commit.message =~ regex
+        files = commit.stats.files.map {|s| s.first}.select{ |s| tree/s }    
         fixes << Fix.new(commit.short_message, commit.date, files)
       end
     end

data/lib/bugspots/version.rb

@@ -1,3 +1,3 @@
 module Bugspots
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bugspots
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000 Z
+date: 2012-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &2156994600 !ruby/object:Gem::Requirement
+  requirement: &2153130800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156994600
+  version_requirements: *2153130800
 - !ruby/object:Gem::Dependency
   name: rainbow
-  requirement: &2156992780 !ruby/object:Gem::Requirement
+  requirement: &2153129280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,11 +32,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156992780
+  version_requirements: *2153129280
 description: Implementation of simple bug prediction hotspot heuristic
 email:
 - ilya@igvita.com
 executables:
+- bugspots
 - git-bugspots
 extensions: []
 extra_rdoc_files: []
@@ -45,6 +46,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/bugspots
 - bin/git-bugspots
 - bugspots.gemspec
 - lib/bugspots.rb