codefumes_harvester 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 09-08-09
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/harvest_repo_metrics
+lib/codefumes_harvester.rb
+lib/codefumes_harvester/errors.rb
+lib/codefumes_harvester/harvester.rb
+lib/codefumes_harvester/quick_metric.rb
+lib/codefumes_harvester/source_control.rb
+lib/harvest_repo_metrics/cli.rb
+spec/codometer_harvester/harvester_spec.rb
+spec/codometer_harvester/source_control_spec.rb
+spec/harvest_repo_metrics_cli_spec.rb
+spec/spec_helper.rb
+tasks/codefumes.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on codometer-harvester, see http://codometer-harvester.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,114 @@
+= codefumes-harvester
+
+* http://codefumes.com
+* http://cf-harvester.rubyforge.org/rdoc
+
+== DESCRIPTION:
+
+CodeFumesHarvester provides a set of high-level tools for gathering
+history and common metrics from a local repository and sending them to
+CodeFumes.com[http://codefumes.com].
+
+== FEATURES/PROBLEMS:
+
+=== Features
+
+* Executable +harvest_repo_metrics+ script which gathers a repository's
+  commit lineage
+* Rake tasks for grabbing content from metric_fu (coverage,
+  lines of 'code code' vs 'test code' ratio).
+* QuickMetric class which can be used to link a custom attribute to the
+  current repository commit identifier of a code base to a CodeFumes
+  project.  This makes it trivial to send up custom attributes from
+  scripts, rake tasks, or even the console, if desired.
+
+=== Problems / Things to Note
+* The only supported SCM right now is git.  We know this sucks. Adding
+  in other SCMs shouldn't be hard, and is planned. It's just not done
+  yet.
+
+== SYNOPSIS:
+
+=== Associating a repository to a CodeFumes.com project
+
+  # Use +harvest_repo_metrics+ to create a project on CodeFumes.com
+  # In your terminal (not IRB):
+
+  # If you don't care what the public key of your project is:
+  $ harvest_repo_metrics
+    => results in a project URI similar to: http://codefumes.com/p/uPnf
+
+  # If you want to customize the public_key of your project:
+  $ harvest_repo_metrics -k my_custom_key
+    => results in a project URI of: http://codefumes.com/p/my_custom_key
+       (assuming it was not already taken)
+
+  # If you are on another machine and want to update that project,
+  # you can pass both the public & private keys of the project for
+  # authentication:
+  $ harvest_repo_metrics -k my_custom_key -a some-generated-private-key
+
+
+=== Sending up custom metrics using QuickMetric
+
+  # Send up your own data and associate it with the current commit
+  # (HEAD, in git parlance) of your current directory.  This makes the
+  # (bold) assumption that the repository is already set up as a CodeFumes
+  # project, and that you want to link the data provided to the current
+  # commit only (think 'rake task' and 'build server').
+  #
+  # An IRB example:
+  > require 'codefumes_harvester'
+  > QuickMetric.save(:name_of_metric => "some value")
+  => true   # returns +false+ if it failed
+  ...that's all
+
+=== Sending up coverage info from metric_fu output
+  # Assuming you have run 'rake metrics:all'
+  $ rake cf:metric_fu:coverage
+
+=== Sending up lines of code code / lines of test code ratio
+
+  # This is only on Rails projects, I believe
+  $ rake cf:metric_fu:loc_lot_stats
+
+
+== REQUIREMENTS:
+
+* +codefumes+ gem
+
+== INSTALL:
+
+From RubyForge:
+
+  sudo gem install codefumes-harvester
+
+Or, from Github:
+
+  sudo gem install cosyn-codefumes-harvester
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,40 @@
+%w[rubygems rake rake/clean fileutils rubigen hoe].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/codefumes_harvester'
+
+begin
+  require "hanna/rdoctask"
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+# Load in the harvester ane metric_fu gems if available so we can collect metrics
+begin
+  require "metric_fu"
+rescue LoadError
+end
+
+$hoe = Hoe.spec('codefumes_harvester') do |p|
+  p.developer('Cosyn Technologies', 'tom.kersten@cosyntech.com')
+  p.rubyforge_name       = 'codefumes'
+  p.extra_deps         = [
+     ['codefumes','>= 0.1.0'],
+     ['mojombo-grit','>= 1.1.1']
+   ]
+  p.extra_dev_deps = [
+    ['mojombo-chronic', ">= 0.3.0"],
+    ['jscruggs-metric_fu', ">= 1.1.5"]
+  ]
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  #path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  #p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.remote_rdoc_dir = ''
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+# load /tasks/*.rake, except for the codefumes.rake file, that will be
+# done in lib/codefumes_harvester.rb (the task_defined? method didn't seem
+# to catch it)
+# TODO: Find out what is/was being done wrong that this is necessary
+Dir['tasks/**/*.rake'].each { |t| load t unless t[/codefumes.rake/]}
+
+task :default => [:spec]

data/bin/harvest_repo_metrics

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-9-2.
+#  Copyright (c) 2009. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/codefumes_harvester")
+
+require "harvest_repo_metrics/cli"
+
+HarvestRepoMetric::CLI.execute(STDOUT, ARGV)

data/lib/codefumes_harvester.rb

@@ -0,0 +1,22 @@
+require 'grit'
+require 'rake'
+require 'codefumes'
+require 'codefumes_harvester/harvester'
+require 'codefumes_harvester/source_control'
+require 'codefumes_harvester/errors'
+require 'codefumes_harvester/quick_metric'
+
+include CodeFumesHarvester
+
+module CodeFumesHarvester
+  VERSION = '0.1.0'
+  LIB_ROOT = File.dirname(__FILE__)
+end
+
+# Shamelessly borrowed from metric_fu setup (http://metric-fu.rubyforge.org/)
+unless Rake::Task.task_defined? "cf:store_repo_metrics"
+  # Load the rakefile so users of the gem get the default cf tasks
+  # This makes a rash assumption that if you have the 'store_repo_metrics'
+  # task, all others will be defined...and that if you don't, you want them all.
+  load File.join(CodeFumesHarvester::LIB_ROOT, '..', 'tasks', 'codefumes.rake')
+end

data/lib/codefumes_harvester/errors.rb

@@ -0,0 +1,6 @@
+module CodeFumesHarvester
+  module Errors #:nodoc:
+    class UnsupportedScmToolError < StandardError #:nodoc:
+    end
+  end
+end

data/lib/codefumes_harvester/harvester.rb

@@ -0,0 +1,110 @@
+module CodeFumesHarvester
+  # Simple class responsible for creating a project on the CodeFumes
+  # website, storing project information in the CodeFumes config file,
+  # and synchronizing a repository's commit history with CodeFumes.com.
+  #
+  # NOTE: Technically this can be used by anything (obviously), but it
+  # was written with the intention of being used with the
+  # +harvest_repo_metrics+ script, and is essentially geared for that
+  # scenario.
+  class Harvester
+    attr_reader :path
+    DEFAULT_PATH = './' #:nodoc:
+
+    # Accepts the following options:
+    # * +:path+ - the path of the repository to gather information from
+    #   (Defaults to './').
+    # * +:public_key+ - Sets the public key of the project. This
+    #   property will be read from the CodeFumes config file if on
+    #   exists for the repository supplied at +:path+.
+    # * +:private_key+ - Sets the private key of the project. This
+    #   property will be read from the CodeFumes config file if on
+    #   exists for the repository supplied at +:path+.
+    # * +:name+ - Sets the name of the project on the CodeFumes site
+    def initialize(passed_in_options = {})
+      options = passed_in_options.dup
+      @path = File.expand_path(options.delete(:path) || DEFAULT_PATH)
+      @repository = initialize_repository
+      options.merge!(:public_key => options[:public_key] || @repository.public_key)
+      options.merge!(:private_key => options[:private_key] || @repository.private_key)
+      @project = initialize_project(options)
+    end
+
+    # Creates or updates a project information on the CodeFumes site,
+    # synchronizes the repository's commit history, and prints the
+    # results to STDOUT.
+    #
+    # Returns +true+ if the process succeeded.
+    #
+    # Returns +false+ if the process failed.
+    def publish_data!
+      if @project.save
+        store_public_key_in_repository
+        update_codefumes_config_file
+        payload_results = generate_and_save_payload
+        if payload_results.nil?
+          puts "Local repository is in sync with server. No updates posted."
+        else
+          puts "Successfully saved #{payload_results[:successful_count]} of #{payload_results[:total_count]} payloads."
+        end
+        puts "Exiting."
+        puts
+        true
+      else
+        false
+      end
+    end
+
+    # Returns the CodeFumes public key of the project that is located
+    # at the supplied path.
+    def public_key
+      @project.public_key
+    end
+
+    # Returns the CodeFumes private key of the project that is located
+    # at the supplied path.
+    def private_key
+      @project.private_key
+    end
+
+    # Returns the CodeFumes 'short uri' of the project that is located
+    # at the supplied path. The 'short uri' is similar to a Tiny URL for
+    # a project.
+    def short_uri
+      @project.short_uri
+    end
+
+    private
+      def initialize_repository
+        begin
+          SourceControl.new(@path)
+        rescue Grit::InvalidGitRepositoryError
+          raise Errors::UnsupportedScmToolError
+        end
+      end
+
+      def initialize_project(options = {})
+        options = CodeFumes::ConfigFile.options_for_project(options[:public_key]).merge(options)
+        CodeFumes::Project.new(options)
+      end
+      
+      def store_public_key_in_repository
+        @repository.store_public_key(@project.public_key)
+      end
+
+      def update_codefumes_config_file
+        CodeFumes::ConfigFile.save_project(@project)
+      end
+
+      def generate_and_save_payload
+        payload = @repository.payload(CodeFumes::Commit.latest_identifier(public_key), "HEAD")
+        if payload.empty?
+          nil
+        else
+          payloads = CodeFumes::Payload.prepare(:public_key => public_key, :private_key => private_key, :content => payload)
+          successful_requests = payloads.select {|payload| payload.save == true}
+          {:successful_count => successful_requests.size, :total_count => payloads.size}
+        end
+      end
+  end
+end

data/lib/codefumes_harvester/quick_metric.rb

@@ -0,0 +1,19 @@
+module CodeFumesHarvester
+  class QuickMetric
+    # Associates a Hash of +custom_attributes+ with the current commit
+    # identifier of the repository located at +repository_path+.
+    #
+    # Returns +true+ if the request succeeded.
+    #
+    # Returns +false+ if the request failed.
+    def self.save(custom_attributes, repository_path = './')
+      repo = SourceControl.new(repository_path)
+      commit = {:identifier => repo.local_revision_identifier,
+                :custom_attributes => custom_attributes
+               }
+      content = {:commits => [commit]}
+      payload_set = CodeFumes::Payload.prepare(:public_key => repo.public_key, :private_key => repo.private_key, :content => content)
+      payload_set.reject {|payload| payload.save}.empty?
+    end
+  end
+end

data/lib/codefumes_harvester/source_control.rb

@@ -0,0 +1,132 @@
+module CodeFumesHarvester
+  # Defines the contract between CodeFumes and any local source control
+  # management system (SCM).
+  #
+  # *NOTE:* Git is currently the only supported SCM. We look
+  # forward to changing this soon.
+  class SourceControl
+    SUPPORTED_SCMS_AND_DETECTORS = {:git => '.git'} #:nodoc:
+
+    # Sets up a SourceControl object to read content from the repository
+    # located at +path+.
+    def initialize(path)
+      @repository = Grit::Repo.new(path)
+    end
+
+    # Returns a serialized Hash containing a single +:commits+ key
+    # associated with an Array of serialized commit information, ready
+    # to be sent to the CodeFumes service.
+    def payload_between(from = initial_commit_identifier, to = "HEAD")
+      start_commit = from || initial_commit_identifier
+      end_commit = to || "HEAD"
+      new_commits = commits_between(start_commit, end_commit)
+      new_commits.empty? ? {} : {:commits => new_commits}
+    end
+    alias :payload :payload_between
+
+    # Returns the first commit identifier of a repository's history.
+    def initial_commit_identifier
+      initial_commit.sha
+    end
+
+    # Returns an array of 'symbolized' executable names for all
+    # supported SCMs.
+    #
+    # The names are returned as symbols.
+    def self.supported_systems
+      SUPPORTED_SCMS_AND_DETECTORS.keys
+    end
+
+    # Accepts command-line executable name of SCM and returns whether it
+    # is a supported SCM or not. +tool_cli_name+ should be the
+    # name of the executable, not the 'full name' of the application
+    # (ex: 'svn' not 'subversion').
+    #
+    # Returns +true+ if the SCM is supported
+    #
+    # Returns +false+ if the SCM is not supported.
+    def self.supported_system?(tool_cli_name)
+      SUPPORTED_SCMS_AND_DETECTORS.keys.include?(tool_cli_name.to_sym)
+    end
+
+    # Stores the public_key of the project associated with the
+    # underlying local repository.  This will not be necessary
+    # with all SCMs.
+    #
+    # For example, in a git repository, this method will store a
+    # +codefumes+ key in the +.git/config+ file.  This value can be used
+    # as a lookup key for other tools to use in conjunction with the
+    # CodeFumes config file (see CodeFumes::Config) to interact with a
+    # CodeFumes project.
+    def store_public_key(public_key)
+      @repository.config["codefumes.public-key"] = public_key
+    end
+
+    # Removes any association to the CodeFumes service which would have
+    # been added using the +store_public_key+ method.
+    #
+    # This method does not remove anything from the user's global
+    # CodeFumes config file.
+    def unlink_from_codefumes!
+      @repository.git.config({}, "--remove-section", "codefumes")
+    end
+
+    # Returns the public key of the project associated with this
+    # repository.
+    def public_key
+      @repository.config["codefumes.public-key"]
+    end
+
+    # Returns the private key of the project assciated with this
+    # repository.
+    def private_key
+      CodeFumes::ConfigFile.options_for_project(public_key)[:private_key]
+    end
+
+    # Returns the current revision identifier of the underlying
+    # repository ('HEAD' of the supplied branch in git parlance).
+    def local_revision_identifier(branch_name = "master")
+      raise ArgumentError, "nil branch name supplied" if branch_name.nil?
+      @repository.get_head(branch_name).commit.sha
+    end
+
+    # Returns the full path of the underlying repository.
+    def path
+      @repository.path
+    end
+
+    private
+      def initial_commit
+        @repository.log.last
+      end
+
+      # Returns Array of serialized commit data. Each item in the Array
+      # contains attributes of a single commit.
+      def commits_between(from, to, including_from_commit = false)
+        commit_list = @repository.commits_between(from,to)
+
+        if including_from_commit == true || from == initial_commit_identifier
+          commit_list = [initial_commit] + commit_list
+        end
+
+        commit_list.map do |commit|
+          {
+            :identifier => commit.sha,
+            :author_name => commit.author.name,
+            :author_email => commit.author.email,
+            :committer_name => commit.committer.name,
+            :committer_email => commit.committer.email,
+            :authored_at => commit.authored_date,
+            :committed_at => commit.committed_date,
+            :message => commit.message,
+            :short_message => commit.short_message,
+            :parent_identifiers => commit.parents.map(&:sha).join(','),
+            :line_additions => commit.stats.additions,
+            :line_deletions => commit.stats.deletions,
+            :line_total => commit.stats.deletions,
+            :affected_file_count => commit.stats.files.count
+          }
+        end.reverse
+      end
+  end
+end

data/lib/harvest_repo_metrics/cli.rb

@@ -0,0 +1,63 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+require 'optparse'
+
+module HarvestRepoMetric
+  # Class by the +harvest_metric+ script for command line parsing and
+  # delegation to the Harvester class.
+  class CLI
+    include CodeFumesHarvester
+
+    # Parses command-line options passed into +harvest_repo_metrics+
+    # and sends data collected to CodeFumes website.
+    def self.execute(stdout, arguments=[])
+      parse_command_line_options!(stdout, arguments)
+      harvester = Harvester.new(@options)
+
+      if harvester.publish_data!
+        stdout.puts "Project saved to CodeFumes.com. Visit #{harvester.short_uri}"
+      else
+        stdout.puts "Error saving project...please try again or file a bug report."
+        exit(1)
+      end
+    end
+
+    private
+      def self.parse_command_line_options!(stdout, cl_arguments)
+        @options = {}
+        begin
+          OptionParser.new do |opts|
+            opts.banner = <<-BANNER.gsub(/^          /,'')
+              Tool used to upload code & repository statistics to
+              the CodeFumes website.
+
+              Usage: #{File.basename($0)} [options]
+
+              Options are:
+            BANNER
+            opts.separator ""
+            opts.on("-k", "--project_key [PROJECT_KEY]",
+                      "The public CodeFumes API key for this project."
+                      ) {|public_key| @options[:public_key] = public_key}
+            opts.on("-a", "--access_key [PROJECT_PRIVATE_KEY]",
+                      "The private CodeFumes API access key for this project."
+                      ) {|private_key| @options[:private_key] = private_key}
+            opts.on("-p", "--path [REPOSITORY_PATH]",
+                      "The local path to the directory containing this project's code."
+                      ) {|path| @options[:path] = Dir.new(File.expand_path(path)).path}
+            opts.on("-h", "--help",
+                      "Show this help message."
+                      ) { stdout.puts opts; exit }
+            opts.on("-n", "--name [PROJECT_NAME]",
+                      "Name of project."
+                      ) {|name| @options[:name] = name}
+            opts.parse!(cl_arguments)
+          end
+        rescue Errno::ENOTDIR
+          stdout.puts "Path supplied is not a directory. Please supply a path to a directory containing your project."
+          exit
+        end
+      end
+  end
+end

data/spec/codometer_harvester/harvester_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Harvester do
+  before(:each) do
+    this_files_dir = File.dirname(__FILE__)
+    @no_scm_path  = "#{this_files_dir}/../fixtures/sample_project_dirs/no_scm"
+    @git_scm_path = "#{this_files_dir}/../fixtures/sample_project_dirs/git_repository"
+  end
+
+  describe "initialization" do
+    context "with a path to a directory that is using the git SCM tool" do
+      before(:each) do
+        @repository = Grit::Repo.new(@git_scm_path)
+        @project = CodeFumes::Project.new
+        Grit::Repo.stub!(:new).with(File.expand_path(@git_scm_path)).and_return(@repository)
+        CodeFumes::Project.stub!(:new).and_return(@project)
+      end
+
+      def initialize_with_git
+        Harvester.new(:path => @git_scm_path)
+      end
+
+      it "creates a new Grit::Repo instance" do
+        Grit::Repo.should_receive(:new).with(File.expand_path(@git_scm_path)).and_return(@repository)
+        initialize_with_git
+      end
+
+      it "creates a new CodeFumes::Project instance" do
+        CodeFumes::Project.should_receive(:new).and_return(@project)
+        initialize_with_git
+      end
+    end
+
+    context "with a path to a directory that is not using a supported SCM" do
+      it "raises an error" do
+        lambda {Harvester.new(:path => @no_scm_path)}.should raise_error(Errors::UnsupportedScmToolError)
+      end
+    end
+  end
+
+  describe "path" do
+    it "returns the full path to a project" do
+      harvester = Harvester.new(:path => @git_scm_path)
+      harvester.path.should == File.expand_path(@git_scm_path)
+    end
+  end
+
+  describe "publish_data!" do
+    before(:each) do
+      @harvester = Harvester.new(:path => @git_scm_path)
+      @payload = mock("CodeFumes::Payload instance", :save => true)
+      CodeFumes::Payload.stub!(:new).and_return(@payload)
+    end
+
+    it "initializes a new Payload object" do
+      payload_params = {:public_key => anything(), :private_key => anything(), :content => anything()}
+      CodeFumes::Payload.should_receive(:new).with(payload_params).and_return(@payload)
+      @harvester.publish_data!
+    end
+
+    it "saves the Payload to the website" do
+      @payload.should_receive(:save).and_return(true)
+      @harvester.publish_data!
+    end
+
+    it "updates the config file's project information" do
+      CodeFumes::ConfigFile.should_receive(:save_project)
+      @harvester.publish_data!
+    end
+  end
+end

data/spec/codometer_harvester/source_control_spec.rb

@@ -0,0 +1,199 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SourceControl do
+  after(:each) do
+    SourceControl.new(GIT_FIXTURE_REPO_PATH).unlink_from_codefumes!
+    unless CodeFumes::ConfigFile.path == File.expand_path('~/.codefumes_config')
+      File.delete(CodeFumes::ConfigFile.path) if File.exists?(CodeFumes::ConfigFile.path)
+    end
+  end
+
+  describe "creation" do
+    context "with a path to a directory that is not a git repository" do
+      it "raises an error" do
+        invalid_path = File.dirname(__FILE__)
+        lambda {SourceControl.new(invalid_path)}.should raise_error(Grit::InvalidGitRepositoryError)
+      end
+    end
+  end
+
+  describe "supported_systems" do
+    it "includes :git" do
+      SourceControl.supported_systems.should include(:git)
+    end
+  end
+
+  describe "supported_system?" do
+    SourceControl.supported_systems.each do |scm_tool|
+      it "returns true for the string '#{scm_tool.to_s}'" do
+        SourceControl.supported_system?(scm_tool.to_s)
+      end
+
+      it "returns true for the symbol ':#{scm_tool.to_s}'" do
+        SourceControl.supported_system?(scm_tool.to_sym)
+      end
+    end
+  end
+
+  describe "initial_commit_identifier" do
+    before(:each) do
+      git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @repository = SourceControl.new(git_repo_path)
+    end
+
+    it "returns the identifer (sha/revision #) of the first commit" do
+      @repository.initial_commit_identifier.should == "a8b3e73fc5e4bc46bbdf5c1cab38cb2ce47ba2d0"
+    end
+  end
+
+  describe "payload_between" do
+    before(:each) do
+      git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @repository = SourceControl.new(git_repo_path)
+    end
+
+    it "returns a Hash containing the key ':commits'" do
+      @repository.payload_between.keys.should include(:commits)
+    end
+
+    it "is aliased to 'payload'" do
+      @repository.payload_between.keys.should == @repository.payload.keys
+      # FIXME: Improve this...not a complete test. Object ids getting in the way
+      @repository.payload_between[:commits].each_with_index do |commit, index|
+        commit[:identifier].should == @repository.payload[:commits][index][:identifier]
+      end
+    end
+
+    it "returns the commits in the same order a standard 'log view' of the repository would" do
+      first_commit = @repository.payload_between[:commits].last
+      first_commit[:identifier].should == "a8b3e73fc5e4bc46bbdf5c1cab38cb2ce47ba2d0"
+    end
+
+    context "the ':commits' key returned" do
+      context "contains a list of data for each commit" do
+        before(:each) do
+          @first_commit = @repository.payload_between[:commits].last
+        end
+
+        it "contains 'id', which is the 'sha' of the commit" do
+          @first_commit[:identifier].should == "a8b3e73fc5e4bc46bbdf5c1cab38cb2ce47ba2d0"
+        end
+
+        it "contains 'author', which points to the 'email' & the 'name' of the commit (in a Hash)" do
+          @first_commit[:author_email].should == "tkersten@obtiva.com"
+          @first_commit[:author_name].should == "Tom Kersten"
+        end
+
+        it "contains 'committer', which points to the 'email' & the 'name' of the commit (in a Hash)" do
+          @first_commit[:committer_email].should == "tkersten@obtiva.com"
+          @first_commit[:committer_name].should == "Tom Kersten"
+        end
+
+        it "contains 'message', which holds the full message of the commit" do
+          @first_commit[:message].should == "Initial commit with description of directory"
+        end
+
+        it "contains 'short_message', which holds the first line of the message of the commit" do
+          @first_commit[:short_message].should == "Initial commit with description of directory"
+        end
+
+        it "contains 'committed_date' of the commit" do
+          @first_commit[:committed_at].should == Chronic.parse("Sat May 09 08:52:14 -0500 2009")
+        end
+
+        it "contains 'authored_date' of the commit" do
+          @first_commit[:authored_at].should == Chronic.parse("Sat May 09 08:52:14 -0500 2009")
+        end
+
+        it "contains 'parent_commits' of the commit" do
+          @first_commit[:parent_identifiers].should_not be_nil
+        end
+
+        it "contains a 'line_additions' key" do
+          @first_commit[:line_additions].should_not be_nil
+        end
+
+        it "contains an 'line_deletions' key" do
+          @first_commit[:line_deletions].should_not be_nil
+        end
+
+        it "contains an 'line_total' key" do
+          @first_commit[:line_total].should_not be_nil
+        end
+
+        it "contains a 'affected_file_count' key" do
+          @first_commit[:affected_file_count].should_not be_nil
+        end
+      end
+    end
+
+    context "when 'from' is specified but the value is nil" do
+      it "defaults to the initial commit identifier of the repository" do
+        @repository.should_receive(:commits_between).with("a8b3e73fc5e4bc46bbdf5c1cab38cb2ce47ba2d0", anything()).and_return([])
+        @repository.payload_between(nil, "something")
+      end
+    end
+
+    context "when 'to' is specified but the value is nil" do
+      it "defaults to the 'HEAD' commit identifier of the repository" do
+        @repository.should_receive(:commits_between).with(anything(), "HEAD").and_return([])
+        @repository.payload_between("something", nil)
+      end
+    end
+
+    context "when there is no new information to send up" do
+      it "returns an empty object" do
+        @repository.payload_between("HEAD", "HEAD").should be_empty
+      end
+    end
+  end
+
+  describe "public_key=" do
+    before(:each) do
+      git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @public_key = "public_key_specified"
+      @repository = SourceControl.new(git_repo_path)
+      @project = CodeFumes::Project.new(:public_key => @public_key)
+    end
+
+    it "stores the supplied public key in the SCM tool's repository-specific configuration" do
+      @repository.store_public_key(@public_key)
+      @repository.public_key.should == @public_key
+    end
+  end
+
+  describe "public_key" do
+    before(:each) do
+      @public_key = "original_value"
+      git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @repository = SourceControl.new(git_repo_path)
+      @repository.store_public_key(@public_key)
+    end
+
+    it "returns the current value of 'codometer.public_key' from the repository-specific configuration" do
+      @repository.public_key.should == @public_key
+    end
+  end
+
+  describe "local_revision_identifier" do
+    before(:each) do
+      git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @repository = SourceControl.new(git_repo_path)
+    end
+
+    it "returns the current revision identifier for the local repository" do
+      @repository.local_revision_identifier.should == "7dc0e73fea4625204b7c1e6a48e9a57025be4d7e"
+    end
+  end
+
+  describe "path" do
+    before(:each) do
+      @git_repo_path = File.expand_path(File.dirname(__FILE__) + '/../fixtures/sample_project_dirs/git_repository')
+      @repository = SourceControl.new(@git_repo_path)
+    end
+
+    it "returns the full path to the .git directory of the repository" do
+      @repository.path.should == @git_repo_path + '/.git'
+    end
+  end
+end

data/spec/harvest_repo_metrics_cli_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'harvest_repo_metrics/cli'
+
+describe HarvestRepoMetric::CLI, "execute" do
+  before(:each) do
+    @stdout_io = StringIO.new
+    HarvestRepoMetric::CLI.execute(@stdout_io, ["-p", GIT_FIXTURE_REPO_PATH])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+
+  after(:each) do
+    unless CodeFumes::ConfigFile.path == File.expand_path('~/.codefumes_config')
+      File.delete(CodeFumes::ConfigFile.path)
+      SourceControl.new(GIT_FIXTURE_REPO_PATH).unlink_from_codefumes!
+    end
+  end
+
+  it "prints out the path of the project" do
+    @stdout.should =~ /Project saved/
+  end
+
+  it "creates a .codefumes_config file" do
+    File.exist?(CodeFumes::ConfigFile.path).should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+
+gem 'ruby-debug'
+require 'ruby-debug'
+require 'chronic'
+
+begin
+  require 'spec/autorun'
+rescue LoadError
+  gem 'rspec'
+  require 'spec/autorun'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'codefumes_harvester'
+
+GIT_FIXTURE_REPO_PATH = File.expand_path(File.dirname(__FILE__) + "/fixtures/sample_project_dirs/git_repository")
+ENV['CODEFUMES_CONFIG_FILE'] = File.expand_path(File.dirname(__FILE__) + '/sample_codefumes_config.tmp')
+CodeFumes::API.mode(:test)

data/tasks/codefumes.rake

@@ -0,0 +1,66 @@
+namespace :cf do
+  desc "Send scm metrics to Codefumes.com"
+  task :store_repo_metrics, [:public_key, :private_key] do |tsk, args|
+    harvest_repo_metrics_executable = File.expand_path(File.dirname(__FILE__) + "/../bin/harvest_repo_metrics")
+    options = args.public_key.nil? ? "" : "-k #{args.public_key}"
+    options += args.private_key.nil? ? "" : " -a #{args.private_key}"
+    sh "#{harvest_repo_metrics_executable} #{options}"
+  end
+
+
+  namespace :metric_fu do
+    desc "Collect commit's overall code coverage statistic from metric_fu output"
+    task :coverage do |tsk, args|
+      err_msg = "No 'rcov' section found in '#{file_path}'"
+      puts rcov_section.nil? ? err_msg : save(:coverage => rcov_section[:global_percent_run])
+    end
+
+    desc "Collect current commit's \"lines of code\" & \"lines of test\" metrics from metric_fu output"
+    task :loc_lot_stats do |tsk, args|
+      if stats_section.nil?
+        puts "No 'line stats' section found in '#{file_path}'"
+      else
+        metrics = {:code_lines_of_code => stats_section[:codeLOC],
+                   :test_lines_of_code => stats_section[:testLOC],
+                   :code_to_test_ratio => "1:#{stats_section[:code_to_test_ratio]}"
+                  }
+        puts save(metrics)
+      end
+    end
+
+    def file_path
+      @file_path ||= File.expand_path('tmp/metric_fu/report.yml')
+    end
+
+    def marshalled_mf_report
+      return  @marshalled_content unless @marshalled_content.nil?
+
+      unless File.exists?(file_path)
+        raise "No report.yml file.  Has 'rake metrics:all' been run yet?"
+      end
+      @marshalled_content = File.open(file_path) {|f| YAML.load(f)}
+    end
+
+    def rcov_section
+      @rcov_section ||= marshalled_mf_report[:rcov]
+    end
+
+    def stats_section
+      @stats_section ||= marshalled_mf_report[:stats]
+    end
+
+    def save(custom_attributes_hash)
+      nil_value_attributes = custom_attributes_hash.select {|name, value| value.nil?}
+      unless nil_value_attributes.empty?
+        return "No value supplied for the attributes: #{nil_value_attributes.keys.join(', ')}"
+      end
+
+      metric_names = custom_attributes_hash.keys.join(', ')
+      if QuickMetric.save(custom_attributes_hash)
+        "Successfully saved metric(s): #{metric_names}"
+      else
+        "Error saving metric(s): #{metric_names}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: codefumes_harvester
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cosyn Technologies
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: codefumes
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mojombo-grit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mojombo-chronic
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jscruggs-metric_fu
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: CodeFumesHarvester provides a set of high-level tools for gathering history and common metrics from a local repository and sending them to CodeFumes.com[http://codefumes.com].
+email: 
+- tom.kersten@cosyntech.com
+executables: 
+- harvest_repo_metrics
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- bin/harvest_repo_metrics
+- lib/codefumes_harvester.rb
+- lib/codefumes_harvester/errors.rb
+- lib/codefumes_harvester/harvester.rb
+- lib/codefumes_harvester/quick_metric.rb
+- lib/codefumes_harvester/source_control.rb
+- lib/harvest_repo_metrics/cli.rb
+- spec/codometer_harvester/harvester_spec.rb
+- spec/codometer_harvester/source_control_spec.rb
+- spec/harvest_repo_metrics_cli_spec.rb
+- spec/spec_helper.rb
+- tasks/codefumes.rake
+has_rdoc: true
+homepage: http://codefumes.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: codefumes
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: CodeFumesHarvester provides a set of high-level tools for gathering history and common metrics from a local repository and sending them to CodeFumes.com[http://codefumes.com].
+test_files: []
+