bugwatch 0.1

data/bugwatch.gemspec

@@ -0,0 +1,74 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Gem::Specification.new do |s|
+  s.name = 'bugwatch'
+  s.version = '0.1'
+  s.date = '2012-02-13'
+
+  s.summary = 'bugwatch'
+  s.description = 'SCM history mining and code analysis platform'
+
+  s.authors = ['Jacob Richardson']
+  s.email = 'jacobr@groupon.com'
+
+  s.require_paths = %w[lib]
+
+  s.add_dependency('grit', '2.5.0')
+  s.add_dependency('ruby_parser', '~> 3.0.1')
+  s.add_dependency('rugged', '0.16.2')
+
+  # = MANIFEST =
+  s.files = %w[
+    bugwatch.gemspec
+    lib/bugwatch.rb
+    lib/bugwatch/adapters.rb
+    lib/bugwatch/analysis.rb
+    lib/bugwatch/attrs.rb
+    lib/bugwatch/churn.rb
+    lib/bugwatch/commit.rb
+    lib/bugwatch/complexity_score.rb
+    lib/bugwatch/diff.rb
+    lib/bugwatch/diff_parser.rb
+    lib/bugwatch/exception_data.rb
+    lib/bugwatch/exception_tracker.rb
+    lib/bugwatch/file_adapters/ruby_file_adapter.rb
+    lib/bugwatch/flog_score.rb
+    lib/bugwatch/import.rb
+    lib/bugwatch/method_parser.rb
+    lib/bugwatch/repo.rb
+    lib/bugwatch/ruby_complexity.rb
+    lib/bugwatch/tag.rb
+    lib/bugwatch/tree.rb
+    vendor/flog/lib/flog.rb
+  ]
+  # = MANIFEST =
+
+end

data/lib/bugwatch.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'rugged'
+require 'grit'
+
+require File.expand_path('../bugwatch/adapters', __FILE__)
+require File.expand_path('../bugwatch/analysis', __FILE__)
+require File.expand_path('../bugwatch/attrs', __FILE__)
+require File.expand_path('../bugwatch/complexity_score', __FILE__)
+require File.expand_path('../bugwatch/diff_parser', __FILE__)
+require File.expand_path('../bugwatch/ruby_complexity', __FILE__)
+require File.expand_path('../bugwatch/churn', __FILE__)
+require File.expand_path('../bugwatch/commit', __FILE__)
+require File.expand_path('../bugwatch/diff', __FILE__)
+require File.expand_path('../bugwatch/exception_data', __FILE__)
+require File.expand_path('../bugwatch/exception_tracker', __FILE__)
+require File.expand_path('../bugwatch/flog_score', __FILE__)
+require File.expand_path('../bugwatch/import', __FILE__)
+require File.expand_path('../bugwatch/method_parser', __FILE__)
+require File.expand_path('../bugwatch/repo', __FILE__)
+require File.expand_path('../bugwatch/tag', __FILE__)
+require File.expand_path('../bugwatch/tree', __FILE__)

data/lib/bugwatch/adapters.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'bugwatch/file_adapters/ruby_file_adapter'
+require 'bugwatch/ruby_complexity'
+
+module Bugwatch
+
+  Adapter = Struct.new(:file, :complexity)
+
+  @adapters = {
+      ruby: Adapter.new(RubyFileAdapter, RubyComplexity)
+  }
+
+  def self.add_adapter(name, file_adapter, complexity=nil)
+    @adapters.merge!(name => Adapter.new(file_adapter, complexity))
+  end
+
+  def self.adapters
+    @adapters
+  end
+
+end

data/lib/bugwatch/analysis.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Bugwatch
+
+  class Analysis
+
+    def initialize(repo, caching_strategy)
+      @repo = repo
+      @caching_strategy = caching_strategy
+    end
+
+    def analyze(*analyzers)
+      analyzers.each do |analyzer|
+        commits_to_analyze(analyzer).each do |commit_sha|
+          commit = @repo.commit(commit_sha)
+          analyzer.call(commit)
+          @caching_strategy.store_analysis(commit, analyzer.key)
+        end
+      end
+    end
+
+    private
+
+    def commits_to_analyze(analyzer)
+      @caching_strategy.imported - @caching_strategy.analyzed(analyzer.key)
+    end
+
+  end
+
+end

data/lib/bugwatch/attrs.rb

@@ -0,0 +1,64 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Bugwatch
+
+  module Attrs
+
+    def attrs(*attributes)
+      define_attr_reader(attributes) do |attr|
+        attr
+      end
+    end
+
+    def lazy_attrs(*attributes)
+      define_attr_reader(attributes) do |attr|
+        if attr.respond_to? :call
+          attr.call
+        else
+          attr
+        end
+      end
+    end
+
+    private
+
+    def define_attr_reader(attributes, &block)
+      attributes.each do |attribute|
+        define_method(attribute) do
+          data = instance_variable_get('@attributes') || {}
+          block.call(data[attribute])
+        end
+      end
+    end
+
+  end
+
+end

data/lib/bugwatch/churn.rb

@@ -0,0 +1,60 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Bugwatch
+
+  class Churn
+
+    DEFAULT_CHURN = 0
+
+    def initialize(commit_stats, file_adapter)
+      @commit_stats = commit_stats
+      @file_adapter = file_adapter
+    end
+
+    def score
+      calculate_churn(&@file_adapter.method(:analyzable_file?))
+    end
+
+    def test_score
+      calculate_churn(&@file_adapter.method(:test_file?))
+    end
+
+    private
+
+    def calculate_churn(&filter)
+      @commit_stats.select do |stat|
+        filter.call(stat.file)
+      end.map(&:total).reduce(:+) || DEFAULT_CHURN
+    end
+
+  end
+
+end

data/lib/bugwatch/commit.rb

@@ -0,0 +1,82 @@
+# Copyright (c) 2013, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Bugwatch
+
+  class Commit
+
+    include RubyFileAdapter
+    extend Attrs
+
+    Stats = Struct.new(:file, :additions, :deletions, :total)
+
+    def self.from_grit(grit)
+      author = grit.author
+      committer = grit.committer
+      stats = Enumerator.new {|y| grit.stats.files.each {|data| y << Stats.new(*data) } }
+      diffs = Enumerator.new {|y| grit.diffs.each {|diff| y << Diff.from_grit(diff) } }
+      tree = Tree.new(grit.tree)
+      new sha: grit.sha, message: grit.short_message, diffs: diffs, stats: stats, tree: tree,
+          author_name: author.name, author_email: author.email, authored_date: grit.authored_date,
+          committer_name: committer.name, committer_email: committer.email, committed_date: grit.committed_date
+    end
+
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    attrs :sha, :message, :diffs, :stats
+    attrs :author_name, :author_email, :authored_date
+    attrs :committer_name, :committer_email, :committed_date
+    lazy_attrs :tree
+
+    def files
+      @files ||= stats.map(&:file)
+    end
+
+    def complexity(lang=:ruby)
+      adapter = Bugwatch.adapters[lang]
+      adapter.complexity.new(diffs) if adapter && adapter.complexity
+    end
+
+    def churn(lang=:ruby)
+      adapter = Bugwatch.adapters[lang]
+      Churn.new(stats, adapter.file) if adapter
+    end
+
+    # TODO don't use grit blob
+    def identify(filename, line_number)
+      blob = tree / filename
+      blob ? MethodParser.find(blob.data, line_number..line_number) : {}
+    end
+
+  end
+
+end