integrity_metrics 0.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg/*
+*.log

data/CHANGELOG

@@ -0,0 +1,3 @@
+= 0.1.x
+Extracted from a modified Integrity installation into which report_card had been wedged,
+and extended to support template overrides.

data/README.md

@@ -0,0 +1,32 @@
+# integrity_metrics
+
+This is an integrity plugin that automatically runs metrics on each build after it has been tested. 
+It is based on [report_card](https://github.com/thoughtbot/report_card) but doesn't require a 
+separate site, configuration or cron job. 
+
+Report_card seems to have been abandoned but this works with the current version of integrity (v22).
+
+## Installation
+
+in integrity's Gemfile:
+
+	gem "integrity_metrics"
+
+in integrity's init.rb:
+
+	require 'integrity_metrics'
+
+and in the configure block, optionally:
+
+	c.metrics_directory = "metrics"
+	
+## Usage
+
+Metrics will be calculated automatically on the completion of each build. Metric_fu saves its output to files 
+in metrics_directory/:project/output/, so we redirect from /:project/metrics to those static files. You may need 
+to make sure that your webserver does the right thing with static html files and other assets, but it probably does.
+
+## Copyright
+
+Copyright (c) 2010 William Ross for spanner. Released under the same terms as Ruby and/or Integrity.
+Portions based on report_card: copyright unstated but presumably Nick Quaranto/Thoughtbot.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "integrity_metrics"
+    gem.summary = %Q{Post-build metrics for integrity}
+    gem.description = %Q{Integrates metric_fu into integrity so that metrics are run on every build.}
+    gem.email = "will@spanner.org"
+    gem.homepage = "http://github.com/spanner/integrity_metrics"
+    gem.authors = ["William Ross"]
+    gem.add_dependency "metric_fu"
+  	gem.add_dependency "reek"
+  	gem.add_dependency "roodi"
+  	gem.add_dependency "Saikuro"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "integrity_metrics #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/integrity_metrics.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{integrity_metrics}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["William Ross"]
+  s.date = %q{2010-11-19}
+  s.description = %q{Integrates metric_fu into integrity so that metrics are run on every build.}
+  s.email = %q{will@spanner.org}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "integrity_metrics.gemspec",
+     "lib/integrity/grader.rb",
+     "lib/integrity/metrics_extensions.rb",
+     "lib/integrity_metrics.rb",
+     "test/acceptance/acceptance_helper.rb",
+     "test/acceptance/integrity_metrics_test.rb",
+     "views/_build_info.haml"
+  ]
+  s.homepage = %q{http://github.com/spanner/integrity_metrics}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Post-build metrics for integrity}
+  s.test_files = [
+    "test/acceptance/acceptance_helper.rb",
+     "test/acceptance/integrity_metrics_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<metric_fu>, [">= 0"])
+      s.add_runtime_dependency(%q<reek>, [">= 0"])
+      s.add_runtime_dependency(%q<roodi>, [">= 0"])
+      s.add_runtime_dependency(%q<Saikuro>, [">= 0"])
+    else
+      s.add_dependency(%q<metric_fu>, [">= 0"])
+      s.add_dependency(%q<reek>, [">= 0"])
+      s.add_dependency(%q<roodi>, [">= 0"])
+      s.add_dependency(%q<Saikuro>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<metric_fu>, [">= 0"])
+    s.add_dependency(%q<reek>, [">= 0"])
+    s.add_dependency(%q<roodi>, [">= 0"])
+    s.add_dependency(%q<Saikuro>, [">= 0"])
+  end
+end
+

data/lib/integrity/grader.rb

@@ -0,0 +1,83 @@
+require 'metric_fu'
+
+module Integrity
+  class Grader
+    # Adapted from report_card to apply metric_fu to each just-completed build.
+    # Reports are saved to /metrics/:project/output
+    # and previous data stored in /metrics/:project/report.yml.
+    # Everything else is standard metric_fu.
+    
+    def self.grade(_build, data_directory, report_directory, logger)
+      new(_build, data_directory, report_directory, logger).grade
+    end
+
+    def initialize(build, data_directory, report_directory, logger)
+      @build = build
+      @data_directory = data_directory
+      @report_directory = report_directory || "metrics"
+      @logger = logger
+    end
+    
+    def grade
+      start
+      configure
+      generate
+      wrapup
+    end
+    
+    def start
+      @logger.info "Build metrics for #{@build.project.name}"
+      ENV['CC_BUILD_ARTIFACTS'] = File.join("../../public/", @report_directory, @build.project.permalink)
+      @old_dir = Dir.getwd
+      Dir.chdir directory
+    end
+    
+    def directory
+      @directory ||= @data_directory.join(@build.id.to_s)
+    end
+
+    def configure
+      MetricFu::Configuration.run do |config|
+        config.reset
+        config.template_class = AwesomeTemplate
+        config.file_globs_to_ignore = ['lib/generators/**/*']
+        config.code_dirs << 'vendor/extensions'
+        config.rcov = { :test_files => ['test/**/*_test.rb', 'spec/**/*_spec.rb'    ],
+                        :rcov_opts  => ["--sort coverage",
+                        "--no-html",
+                        "--text-coverage",
+                        "--no-color",
+                        "--profile",
+                        "--rails",
+                        "--include test",
+                        "--exclude /gems/,/usr/local/lib/site_ruby/1.8/,spec"]}
+      end
+      MetricFu.report.instance_variable_set(:@report_hash, {})
+    end
+
+    def generate
+      begin
+        MetricFu.metrics.each { |metric| MetricFu.report.add(metric) }
+        MetricFu.graphs.each  { |graph| MetricFu.graph.add(graph, :bluff) }
+        MetricFu.report.save_output(MetricFu.report.to_yaml, MetricFu.base_directory, 'report.yml')
+        MetricFu.report.save_output(MetricFu.report.to_yaml, MetricFu.data_directory, "#{Time.now.strftime("%Y%m%d")}.yml")
+        MetricFu.report.save_templatized_report
+        MetricFu.graph.generate
+        @success = true
+      rescue Exception => e
+        @logger.error "Problem generating the reports: #{e}"
+        @success = false
+      end
+    end
+    
+    def wrapup
+      Dir.chdir @old_dir
+    end
+
+    def success?
+      @success
+    end
+        
+  end
+end
+

data/lib/integrity/metrics_extensions.rb

@@ -0,0 +1,76 @@
+module Integrity
+  module AppExt
+    # Interferes with haml rendering to give priority to extension templates.
+    # Crudely done here in preparation for a more general solution in Integrity.
+    
+    def haml(template, options = {}, locals = {})
+      options[:views] = extension_view_path if extension_template_exists?(:haml, template) 
+      super(template, options, locals)
+    end
+    
+    def extension_template_exists?(engine, template)
+      File.exist?(File.join(extension_view_path, "#{template}.#{engine}"))
+    end
+    
+    def extension_view_path
+      File.join(File.dirname(__FILE__), '/../../views')
+    end
+  end
+  
+  module BuilderExt
+    # Inserts metrics into the build execution sequence between complete and notify.
+    
+    def self.included(base)
+      base.class_eval {
+        include InstanceMethods
+        alias_method_chain :complete, :metrics
+      }
+    end
+    
+    module InstanceMethods
+      def complete_with_metrics
+        complete_without_metrics
+        metrics
+      end
+    
+      def metrics
+        @build.grade
+      end
+    end
+  end
+  
+  module BuildExt
+    # Adds a #grade call structured very similarly to #build.
+
+    def grade
+      Grader.grade(self, Integrity.config.directory, Integrity.config.metrics_directory, Integrity.logger)
+    end    
+  end
+  
+  module ConfigExt
+    # Supports the configuration of metric paths and (later) options.
+
+    def self.included(base)
+      base.class_eval {
+        attr_reader :metrics_directory
+      }
+    end
+
+    def metrics_directory=(dir)
+      @metrics_directory = Pathname(dir)
+    end
+  end
+  
+  module MetricsHelpers
+    # Adds url helpers for metrics addresses.
+    
+    def metrics_url(project)
+      project_url(project, 'metrics')
+    end
+
+    def metrics_path(project, *path)
+      project_path(project, 'metrics')
+    end
+  end
+end
+

data/lib/integrity_metrics.rb

@@ -0,0 +1,23 @@
+require "integrity/grader"
+require "integrity/metrics_extensions"
+
+module IntegrityMetrics
+  def self.registered(app)
+    Integrity::App.send :include, Integrity::AppExt
+    Integrity::Configuration.send :include, Integrity::ConfigExt
+    Integrity::Build.send :include, Integrity::BuildExt
+    Integrity::Builder.send :include, Integrity::BuilderExt
+
+    app.helpers Integrity::MetricsHelpers
+
+    app.get "/:project/metrics" do
+      login_required unless current_project.public?
+      metrics_directory = Integrity.config.metrics_directory || "metrics"
+      redirect "/#{metrics_directory}/#{current_project.permalink}/output/index.html"
+    end
+    
+    Integrity.logger.info "Metrics loaded"
+  end
+end
+
+Integrity::App.register IntegrityMetrics

data/test/acceptance/acceptance_helper.rb

@@ -0,0 +1,150 @@
+$:.unshift File.dirname(__FILE__) + "/../lib", File.dirname(__FILE__)
+
+require "rubygems"
+
+require "test/unit"
+require "rr"
+require "mocha"
+require "dm-sweatshop"
+require "webrat/sinatra"
+
+gem "jeremymcanally-context"
+gem "jeremymcanally-matchy"
+gem "jeremymcanally-pending"
+require "context"
+require "matchy"
+require "pending"
+
+require "integrity"
+require "integrity/notifier/test/fixtures"
+
+begin
+  require "ruby-debug"
+  require "redgreen"
+rescue LoadError
+end
+
+module TestHelper
+  def ignore_logs!
+    Integrity.config[:log] = "/tmp/integrity.test.log"
+  end
+
+  def capture_stdout
+    output = StringIO.new
+    $stdout = output
+    yield
+    $stdout = STDOUT
+    output
+  end
+
+  def silence_warnings
+    $VERBOSE, v = nil, $VERBOSE
+    yield
+  ensure
+    $VERBOSE = v
+  end
+end
+
+class Test::Unit::TestCase
+  class << self
+    alias_method :specify, :test
+  end
+
+  include RR::Adapters::TestUnit
+  include Integrity
+  include TestHelper
+
+  before(:all) do
+    DataMapper.setup(:default, "sqlite3::memory:")
+
+    require "integrity/migrations"
+  end
+
+  before(:each) do
+    [Project, Build, Commit, Notifier].each{ |i| i.auto_migrate_down! }
+    capture_stdout { Integrity.migrate_db }
+    Notifier.available.clear
+    Integrity.instance_variable_set(:@config, nil)
+  end
+
+  after(:each) do
+    capture_stdout { Integrity::Migrations.migrate_down! }
+  end
+end
+
+gem "foca-storyteller"
+require "storyteller"
+
+module AcceptanceHelper
+  include FileUtils
+
+  def export_directory
+    File.dirname(__FILE__) + "/../../exports"
+  end
+
+  def enable_auth!
+    Integrity.config[:use_basic_auth]      = true
+    Integrity.config[:admin_username]      = "admin"
+    Integrity.config[:admin_password]      = "test"
+    Integrity.config[:hash_admin_password] = false
+  end
+
+  def login_as(user, password)
+    def AcceptanceHelper.logged_in; true; end
+    basic_auth user, password
+    visit "/login"
+    Integrity::App.before { login_required if AcceptanceHelper.logged_in }
+  end
+
+  def log_out
+    def AcceptanceHelper.logged_in; false; end
+    @_webrat_session = Webrat::SinatraSession.new(self)
+  end
+
+  def disable_auth!
+    Integrity.config[:use_basic_auth] = false
+  end
+
+  def set_and_create_export_directory!
+    FileUtils.rm_r(export_directory) if File.directory?(export_directory)
+    FileUtils.mkdir(export_directory)
+    Integrity.config[:export_directory] = export_directory
+  end
+
+  def setup_log!
+    log_file = Pathname(File.dirname(__FILE__) + "/../../integrity.log")
+    log_file.delete if log_file.exist?
+    Integrity.config[:log] = log_file
+  end
+end
+
+class Test::Unit::AcceptanceTestCase < Test::Unit::TestCase
+  include AcceptanceHelper
+  include Test::Storyteller
+  include Webrat::Methods
+  include Webrat::Matchers
+  include Webrat::HaveTagMatcher
+
+  Webrat::Methods.delegate_to_session :response_code
+
+  def app
+    Integrity::App
+  end
+
+  before(:all) do
+    app.set(:environment, :test)
+  end
+
+  before(:each) do
+    # ensure each scenario is run in a clean sandbox
+    Integrity.config[:base_uri] = "http://www.example.com"
+    enable_auth!
+    setup_log!
+    set_and_create_export_directory!
+    log_out
+  end
+
+  after(:each) do
+    rm_r export_directory if File.directory?(export_directory)
+  end
+end

data/test/acceptance/integrity_metrics_test.rb

@@ -0,0 +1,71 @@
+# Unclear how to get ahold of Integrity's test helpers externally. For now,
+# I've been copying this into an unpacked version of Integrity and running it
+# there.
+
+require File.dirname(__FILE__) + "/acceptance_helper"
+require 'integrity/integritray'
+
+class MetricsTest < Test::Unit::AcceptanceTestCase
+  include Integrity::Helpers::Urls
+
+  story <<-EOS
+    As a user,
+    I want to assess the code quality of my projects
+  EOS
+
+  scenario "projects.xml has a tag representing my project" do
+    project = Project.gen(:integrity, :public => true, :commits => 2.of { Commit.gen(:successful)})
+    commit = project.last_commit
+    visit "/projects.xml"
+
+    assert_have_tag("projects")
+    assert_have_tag("projects/project[@name='Integrity']")
+    assert_have_tag("projects/project[@lastbuildlabel='#{commit.short_identifier}']")
+    assert_have_tag("projects/project[@weburl='#{project_url(project)}']")
+    assert_have_tag("projects/project[@category='#{project.branch}']")
+    assert_have_tag("projects/project[@activity='Sleeping']")
+    assert_have_tag("projects/project[@lastbuildstatus='Success']")
+  end
+  
+  scenario "projects.xml has a tag representing my pending project" do
+    project = Project.gen(:integrity, :public => true, :commits => 2.of { Commit.gen(:pending)})
+    commit = project.last_commit
+    visit "/projects.xml"
+
+    assert_have_tag("projects")
+    assert_have_tag("projects/project[@name='Integrity']")
+    assert_have_tag("projects/project[@lastbuildlabel='#{commit.short_identifier}']")
+    assert_have_tag("projects/project[@weburl='#{project_url(project)}']")
+    assert_have_tag("projects/project[@category='#{project.branch}']")
+    assert_have_tag("projects/project[@activity='Building']")
+    assert_have_tag("projects/project[@lastbuildstatus='Success']")
+  end
+  
+  scenario "projects.xml has a tag representing my failed project" do
+    project = Project.gen(:integrity, :public => true, :commits => 2.of { Commit.gen(:failed)})
+    commit = project.last_commit
+    visit "/projects.xml"
+
+    assert_have_tag("projects")
+    assert_have_tag("projects/project[@name='Integrity']")
+    assert_have_tag("projects/project[@lastbuildlabel='#{commit.short_identifier}']")
+    assert_have_tag("projects/project[@weburl='#{project_url(project)}']")
+    assert_have_tag("projects/project[@category='#{project.branch}']")
+    assert_have_tag("projects/project[@activity='Sleeping']")
+    assert_have_tag("projects/project[@lastbuildstatus='Failure']")
+  end
+
+  scenario "projects.xml has a tag representing my unbuilt project" do
+    project = Project.gen(:integrity, :public => true)
+    commit = project.last_commit
+    puts commit.inspect
+    visit "/projects.xml"
+
+    assert_have_tag("projects")
+    assert_have_tag("projects/project[@name='Integrity']")
+    assert_have_tag("projects/project[@weburl='#{project_url(project)}']")
+    assert_have_tag("projects/project[@category='#{project.branch}']")
+    assert_have_no_tag("projects/project[@activity]")
+    assert_have_no_tag("projects/project[@lastbuildstatus]")
+  end
+end

data/views/_build_info.haml

@@ -0,0 +1,35 @@
+%h1&= build.human_status
+
+%form{ :action => build_path(build), :method => :post }
+  %p.submit
+    %button{ :type => :submit, :title => "Rebuild this commit" }<
+      Rebuild
+
+%blockquote
+  %p&= build.message
+  %p.meta<
+    %span.who<
+      &== by: #{build.author}
+    |
+    %span.when{ :title => build.committed_at }<
+      &= pretty_date build.committed_at
+    - if build.project.github?
+      |
+      %span.github<
+        %a{ :href => github_commit_url(build) } view on GitHub
+    |
+    - if build.completed?
+      %span.metrics<
+        %a{ :href => metrics_url(build.project) } metrics
+
+- if build.completed?
+  %h2
+    Metrics
+    
+  %h2
+    Build Output
+    %a{:href => build_path(build, :raw)} (raw)
+
+  %pre.output
+    :preserve
+      #{bash_color_codes h(build.output)}

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: integrity_metrics
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- William Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: metric_fu
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: Saikuro
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Integrates metric_fu into integrity so that metrics are run on every build.
+email: will@spanner.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- CHANGELOG
+- README.md
+- Rakefile
+- VERSION
+- integrity_metrics.gemspec
+- lib/integrity/grader.rb
+- lib/integrity/metrics_extensions.rb
+- lib/integrity_metrics.rb
+- test/acceptance/acceptance_helper.rb
+- test/acceptance/integrity_metrics_test.rb
+- views/_build_info.haml
+has_rdoc: true
+homepage: http://github.com/spanner/integrity_metrics
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Post-build metrics for integrity
+test_files: 
+- test/acceptance/acceptance_helper.rb
+- test/acceptance/integrity_metrics_test.rb