codefumes_harvester 0.1.3 → 0.1.4

data/History.txt

@@ -1,3 +1,12 @@
+== 0.1.5 / 09-13-09
+
+* Renamed harvest_repo_metrics -> bin/cf_harvest_repo_metrics
+
+== 0.1.4 / 09-13-09
+
+* Moved feedback printing from publish_data! out to CLI#execute
+* Renamed #local_revision_identifier to #local_commit_identifier
+
 == 0.1.3 / 09-12-09
 
 * Cached commit stats when building Payload hash to prevent Grit::Git::GitTimeout exceptions

data/Manifest.txt

@@ -1,17 +1,19 @@
 History.txt
 Manifest.txt
-PostInstall.txt
 README.txt
 Rakefile
-bin/harvest_repo_metrics
+bin/cf_harvest_repo_metrics
+lib/cf_harvest_repo_metrics/cli.rb
 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/cf_harvest_repo_metrics/cli_spec.rb
 spec/codometer_harvester/harvester_spec.rb
 spec/codometer_harvester/source_control_spec.rb
-spec/harvest_repo_metrics_cli_spec.rb
+spec/fixtures/sample_project_dirs/no_scm/description
+spec/spec.opts
 spec/spec_helper.rb
 tasks/codefumes.rake
+tasks/rspec.rake

data/README.txt

@@ -1,7 +1,10 @@
 = codefumes_harvester
 
 * http://codefumes.rubyforge.org/codefumes_harvester
-* http://codefumes.com
+* Wiki: https://github.com/cosyn/codefumes_harvester/wikis
+* Repository: https://github.com/cosyn/codefumes_harvester
+* Official CodeFumes.com gems: http://codefumes.rubyforge.org
+* Website: http://www.codefumes.com
 
 == DESCRIPTION:
 

data/Rakefile

@@ -1,5 +1,7 @@
 %w[rubygems rake rake/clean fileutils rubigen hoe].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/codefumes_harvester'
+
+$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
+require 'lib/codefumes_harvester'
 
 begin
   require "hanna/rdoctask"
@@ -16,8 +18,11 @@ end
 $hoe = Hoe.spec('codefumes_harvester') do
   self.rubyforge_name = 'codefumes'
   self.summary        = "Tools for sending repository history and metrics to CodeFumes.com"
-  self.extra_deps     = [['codefumes','>= 0.1.2'],['mojombo-grit','>= 1.1.1']]
-  self.extra_dev_deps = [['mojombo-chronic', ">= 0.3.0"],['jscruggs-metric_fu', ">= 1.1.5"]]
+  self.extra_deps     = [['codefumes','>= 0.1.3'],['mojombo-grit','>= 1.1.1']]
+  self.extra_dev_deps = [['jscruggs-metric_fu', ">= 1.1.5"],
+                         ['mojombo-chronic', ">= 0.3.0"],
+                         ['rubigen', ">= 1.5.2"]
+                        ]
   developer('Tom Kersten', 'tom.kersten@cosyntech.com')
   developer('Joe Banks', 'freemarmoset@gmail.com')
 end

data/bin/{harvest_repo_metrics → cf_harvest_repo_metrics}

@@ -4,7 +4,6 @@
 #  Copyright (c) 2009. All rights reserved.
 
 require File.expand_path(File.dirname(__FILE__) + "/../lib/codefumes_harvester")
+require File.expand_path(File.dirname(__FILE__) + "/../lib/cf_harvest_repo_metrics/cli")
 
-require "harvest_repo_metrics/cli"
-
-HarvestRepoMetric::CLI.execute(STDOUT, ARGV)
+CfHarvestRepoMetrics::CLI.execute(STDOUT, ARGV)

data/lib/{harvest_repo_metrics → cf_harvest_repo_metrics}/cli.rb

@@ -1,9 +1,6 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-  
 require 'optparse'
 
-module HarvestRepoMetric
+module CfHarvestRepoMetrics
   # Class by the +harvest_metric+ script for command line parsing and
   # delegation to the Harvester class.
   class CLI
@@ -15,11 +12,18 @@ module HarvestRepoMetric
       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
+      if (results = harvester.publish_data!) == false
         stdout.puts "Error saving project...please try again or file a bug report."
         exit(1)
+      else
+        if results.empty?
+          stdout.puts "Local repository is in sync with server. No updates posted."
+        else
+          puts "Successfully saved #{results[:successful_count]} of #{results[:total_count]} payloads."
+          stdout.puts "Project saved to CodeFumes.com. Visit #{harvester.short_uri}"
+        end
+        puts "Exiting."
+        puts
       end
     end
 
@@ -52,6 +56,12 @@ module HarvestRepoMetric
             opts.on("-n", "--name [PROJECT_NAME]",
                       "Name of project."
                       ) {|name| @options[:name] = name}
+            opts.on("-l", "--local",
+                      "Send requests to localhost. (Testing/Development)"
+                      ) { CodeFumes::API.mode(:local) }
+            opts.on("-t", "--test",
+                      "Send requests to test.codefumes.com. (Testing/Development)"
+                      ) { CodeFumes::API.mode(:test) }
             opts.parse!(cl_arguments)
           end
         rescue Errno::ENOTDIR
@@ -60,4 +70,4 @@ module HarvestRepoMetric
         end
       end
   end
-end
+end

data/lib/codefumes_harvester.rb

@@ -9,7 +9,7 @@ require 'codefumes_harvester/quick_metric'
 include CodeFumesHarvester
 
 module CodeFumesHarvester
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
   LIB_ROOT = File.dirname(__FILE__)
 end
 

data/lib/codefumes_harvester/harvester.rb

@@ -34,22 +34,19 @@ module CodeFumesHarvester
     # synchronizes the repository's commit history, and prints the
     # results to STDOUT.
     #
-    # Returns +true+ if the process succeeded.
+    # Returns a Hash containing the keys :successful_count and :total_count
+    # if the process succeeded and updates were posted to the server with
+    # their associated values.
+    #
+    # Returns and empty Hash if the local repository is in sync with the
+    # server and no updates were posted.
     #
     # 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
+        generate_and_save_payload || {}
       else
         false
       end

data/lib/codefumes_harvester/quick_metric.rb

@@ -8,7 +8,7 @@ module CodeFumesHarvester
     # Returns +false+ if the request failed.
     def self.save(custom_attributes, repository_path = './')
       repo = SourceControl.new(repository_path)
-      commit = {:identifier => repo.local_revision_identifier,
+      commit = {:identifier => repo.local_commit_identifier,
                 :custom_attributes => custom_attributes
                }
       content = {:commits => [commit]}

data/lib/codefumes_harvester/source_control.rb

@@ -83,9 +83,9 @@ module CodeFumesHarvester
       CodeFumes::ConfigFile.options_for_project(public_key)[:private_key]
     end
 
-    # Returns the current revision identifier of the underlying
+    # Returns the current commit identifier of the underlying
     # repository ('HEAD' of the supplied branch in git parlance).
-    def local_revision_identifier(branch_name = "master")
+    def local_commit_identifier(branch_name = "master")
       raise ArgumentError, "nil branch name supplied" if branch_name.nil?
       @repository.get_head(branch_name).commit.sha
     end

data/spec/{harvest_repo_metrics_cli_spec.rb → cf_harvest_repo_metrics/cli_spec.rb}

@@ -1,10 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'harvest_repo_metrics/cli'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'cf_harvest_repo_metrics/cli'
 
-describe HarvestRepoMetric::CLI, "execute" do
+describe CfHarvestRepoMetrics::CLI, "execute" do
   before(:each) do
     @stdout_io = StringIO.new
-    HarvestRepoMetric::CLI.execute(@stdout_io, ["-p", GIT_FIXTURE_REPO_PATH])
+    CfHarvestRepoMetrics::CLI.execute(@stdout_io, ["-p", GIT_FIXTURE_REPO_PATH])
     @stdout_io.rewind
     @stdout = @stdout_io.read
   end
@@ -23,4 +23,4 @@ describe HarvestRepoMetric::CLI, "execute" do
   it "creates a .codefumes_config file" do
     File.exist?(CodeFumes::ConfigFile.path).should be_true
   end
-end
+end

data/spec/codometer_harvester/source_control_spec.rb

@@ -41,7 +41,7 @@ describe SourceControl do
       @repository = SourceControl.new(git_repo_path)
     end
 
-    it "returns the identifer (sha/revision #) of the first commit" do
+    it "returns the identifer (sha/commit #) of the first commit" do
       @repository.initial_commit_identifier.should == "a8b3e73fc5e4bc46bbdf5c1cab38cb2ce47ba2d0"
     end
   end
@@ -175,14 +175,14 @@ describe SourceControl do
     end
   end
 
-  describe "local_revision_identifier" do
+  describe "local_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 current revision identifier for the local repository" do
-      @repository.local_revision_identifier.should == "7dc0e73fea4625204b7c1e6a48e9a57025be4d7e"
+    it "returns the current commit identifier for the local repository" do
+      @repository.local_commit_identifier.should == "7dc0e73fea4625204b7c1e6a48e9a57025be4d7e"
     end
   end
 

data/spec/fixtures/sample_project_dirs/no_scm/description

@@ -0,0 +1,4 @@
+This is a directory put in place for testing with various
+parts of the CodometerHarvester gem which depend on a
+directory that is not under any sort of source code
+management system.

data/spec/spec.opts

@@ -0,0 +1 @@
--format specdoc
+--colour

data/tasks/codefumes.rake

@@ -1,7 +1,7 @@
 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")
+    harvest_repo_metrics_executable = File.expand_path(File.dirname(__FILE__) + "/../bin/cf_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}"

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: codefumes_harvester
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Tom Kersten
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-12 00:00:00 -05:00
+date: 2010-02-20 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.2
+        version: 0.1.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: mojombo-grit
@@ -33,6 +33,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.1.1
     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: mojombo-chronic
   type: :development
@@ -44,14 +54,14 @@ dependencies:
         version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: jscruggs-metric_fu
+  name: rubigen
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.5
+        version: 1.5.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -61,41 +71,47 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.5.0
     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].
+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
 - freemarmoset@gmail.com
 executables: 
-- harvest_repo_metrics
+- cf_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
+- bin/cf_harvest_repo_metrics
+- lib/cf_harvest_repo_metrics/cli.rb
 - 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/cf_harvest_repo_metrics/cli_spec.rb
 - spec/codometer_harvester/harvester_spec.rb
 - spec/codometer_harvester/source_control_spec.rb
-- spec/harvest_repo_metrics_cli_spec.rb
+- spec/fixtures/sample_project_dirs/no_scm/description
+- spec/spec.opts
 - spec/spec_helper.rb
 - tasks/codefumes.rake
+- tasks/rspec.rake
 has_rdoc: true
 homepage: http://codefumes.rubyforge.org/codefumes_harvester
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -117,9 +133,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: codefumes
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Tools for sending repository history and metrics to CodeFumes.com
 test_files: []
 

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-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.
-
-