codefumes 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,29 @@
+=== NEXT
+
+NEW FEATURES:
+* Added --exec flag to 'fumes build' command to simplify incorporating
+  into an existing build server setup
+  * Expects your build command an argument to --exec and wraps that
+    command with the 'start' and (appropriate) 'finished' commands for
+    the specified build (assumes your build command uses an exit status
+    of '0' as a successful build, and anything else as a failure)
+    Example:
+      $ fumes build --exec="bundle install && rake db:migrate && rake spec" build-name
+      # Issues 'fumes build --start build-name'
+      # Issues "bundle install && rake db:migrate && rake spec"
+
+      # ...if the command exited with a status of '0'
+      # Issues 'fumes build --finished="successful" build-name'
+
+      # ...if the command exited with a non-zero status
+      # Issues 'fumes build --finished="failed" build-name'
+
+BUG FIXES/UPDATES:
+* Fixed error when no build name was specified with the '--start',
+  '--finished', or '--exec' options to 'fumes build'
+* Corrected output from "fumes help build" to be in sync with expected usage
+* Updated links in README
+
 === 0.3.0 / 2010-09-12
 
 NEW FEATURES:

data/Manifest.txt

@@ -60,5 +60,6 @@ spec/fixtures/project_update.xml
 spec/fixtures/sample_project_dirs/no_scm/description
 spec/spec.opts
 spec/spec_helper.rb
+tasks/contributor_tasks.rb
 tasks/cucumber.rake
 tasks/rspec.rake

data/README.txt

@@ -1,9 +1,8 @@
 = codefumes
 
-* http://codefumes.rubyforge.org/codefumes
+* http://cosyn.github.com/codefumes
 * Wiki: https://github.com/cosyn/codefumes/wikis
 * Repository: https://github.com/cosyn/codefumes
-* Official CodeFumes.com gems: http://codefumes.rubyforge.org/
 * Website: http://www.codefumes.com
 
 == DESCRIPTION:
@@ -44,6 +43,8 @@ other libraries & and applications.
 
 == SYNOPSIS:
 
+=== In your own Ruby code:
+
   require 'codefumes'
 
   # Creating & finding a CodeFumes project
@@ -57,6 +58,13 @@ other libraries & and applications.
   c.identifier    # => git commit SHA (svn support coming soon)
   c.short_message # => commit message
 
+  # Build Management
+  # QuickBuild grabs local commit head & current time to start build
+  QuickBuild.start('build-name-here')
+
+  # QuickBuild grabs local commit head & current time to finish build
+  QuickBuild.finish('build-name-here', 'successful')
+
   # Custom attributes associated with a commit
   c.custom_attributes[:coverage] # => "80"
 
@@ -64,6 +72,26 @@ other libraries & and applications.
   content = Payload.prepare(payload_content)
   content.each {|chunk| chunk.save}
 
+
+=== From the command line:
+
+  $ fumes sync  # <- synchronizes local repository with CodeFumes.com
+  $ fumes build --start ie7
+  $ fumes build --finish=successful ie7
+  $ fumes build --status --all
+
+  # Link to your CodeFumes account
+  $ fumes api-key [your-api-key]
+  $ fumes claim
+
+  # Release the project (unlink from your account)
+  $ fumes release
+
+  # Delete the project entirely from CodeFumes.com
+  $ fumes delete
+
+See 'fumes --help' for more information on available commands and options.
+
 == REQUIREMENTS:
 
 * httparty (0.4.3)
@@ -81,5 +109,10 @@ From Gemcutter:
 
 Refer to the LICENSE file
 
-== Contributors
+== Contributors (sorted alphabetically)
+
+* Dan Nawara
 * Joe Banks
+* Joseph Leddy
+* Leah Welty-Rieger
+* Roy Kolak

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler'
 Bundler.setup
 
-%w[hoe rake rake/clean fileutils].each { |f| require f }
+%w[hoe rake rake/clean fileutils tasks/contributor_tasks].each { |f| require f }
 
 $LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
 require 'lib/codefumes'
@@ -35,6 +35,8 @@ $hoe = Hoe.spec('codefumes') do
   developer('Tom Kersten', 'tom.kersten@codefumes.com')
 end
 
+ContributorTasks.new
+
 Dir['tasks/**/*.rake'].each { |t| load t}
 
 task :default => [:spec]

data/bin/fumes

@@ -155,35 +155,35 @@ command :open do |c|
   end
 end
 
-desc "Set/read the build status of a project"
+arg_name "(build_name | -a/--all)"
+desc "Set & retrieve the build status of a project"
 command :build do |c|
   c.desc 'Start the specified build'
-  c.default_value false
   c.switch [:start]
 
   c.desc 'Mark the specified build with the supplied result'
-  c.arg_name "successful-or-failure"
+  c.arg_name "successful-or-failed"
   c.default_value nil
   c.flag [:finished]
 
   c.desc 'Retrieve the build status of the specified build'
-  c.default_value false
   c.switch [:status, :s]
 
   c.desc 'Retrieve the the status of all builds associated with the latest commit'
   c.default_value false
   c.switch [:all, :a]
 
+  c.desc 'Wrap the specified shell command with build start & finished commands (uses exit code of "0" as "success")'
+  c.arg_name "shell-command-to-execute"
+  c.default_value nil
+  c.flag [:exec]
+
+  # TODO: refactor this...some smelly stuff here
   c.action do |global_options, options, args|
     project_public_key = options[:public_key] || SourceControl.new('./').public_key
     build_name = args.first
 
-    if build_name.nil? && options[:status] && !options[:all]
-      puts "You must specify a build name or the --all/-a switch."
-      raise Errors::InvalidCommandSyntax
-    end
-
-    if options[:status]
+    if checking_build_status?(options)
       puts "Retrieving build status for '#{project_public_key}' project..."
       project = Project.find(project_public_key)
       commit = Commit.latest(project)
@@ -199,17 +199,27 @@ command :build do |c|
           puts "\t'#{build.name}' build: #{build.state}"
         end
       end
-    elsif options[:start] || options[:finished]
+    elsif updating_build_state?(options)
       new_status = options[:finished] ? options[:finished] : "started"
       msg = "Setting '#{build_name}' build status to '#{new_status}'"
 
       issue_project_commands(msg, [project_public_key]) do |project|
         if options[:start] && QuickBuild.start(build_name)
-          puts "'#{build_name}' build successfully marked as '#{new_status}'"
+          puts "Success!"
         elsif options[:finished] && QuickBuild.finish(build_name, options[:finished])
-          puts "'#{build_name}' build successfully marked as '#{new_status}'"
+          puts "Success!"
+        else
+          puts "BUILD STATUS UPDATE REQUEST FAILED!"
         end
       end
+    elsif options[:exec]
+      commands[:build].execute(global_options, {:start => true}, build_name)
+
+      puts "Executing: '#{options[:exec]}'..."
+      build_result = system(options[:exec]) ? "successful" : "failed"
+
+      commands[:build].execute(global_options, {:finished => build_result}, build_name)
+      raise(Errors::RetainFailedBuildState) if build_result == "failed"
     else
       commands[:help].execute(global_options, options, ['build'])
     end
@@ -221,10 +231,39 @@ pre do |global,command,options,args|
     print_api_mode_notification
   end
 
-  if issuing_build_command?(command) && multiple_build_states?(options)
-    puts "Specifying multiple states in the same command is not allowed"
-    raise CodeFumes::Errors::InvalidCommandSyntax
+  if issuing_build_command?(command)
+    unless actionable_flag_specified?(options)
+      commands[:help].execute(global, options, ['build'])
+      raise Errors::InvalidCommandSyntax
+    end
+
+    if !options[:status] && !build_name_specified?(args)
+      puts options.inspect
+      puts "You must include a build name with the '--start', '--finished', and '--exec' flags."
+      raise Errors::InvalidCommandSyntax
+    end
+
+    if options[:status] && (!build_name_specified?(args) && !scoped_to_all_builds?(options))
+      puts "You must specify a build name or the --all/-a switch."
+      raise Errors::InvalidCommandSyntax
+    end
+
+    if options[:exec] && (options[:start] || options[:finished])
+      option_specified = options[:start] ? "start" : "finished"
+      puts "Specifying both the '--exec' and the '--#{option_specified}' flags in the same command"
+      puts "is neither necessary nor supported."
+      puts ""
+      puts "If you use the same command but omit the '--#{option_specified}' flag, you should be "
+      puts "set ('--exec' takes care of '--#{option_specified}' for you)."
+      raise Errors::InvalidCommandSyntax
+    end
+
+    if multiple_build_states?(options)
+      puts "Specifying multiple states in the same command is not allowed"
+      raise CodeFumes::Errors::InvalidCommandSyntax
+    end
   end
+
   true
 end
 
@@ -277,6 +316,9 @@ on_error do |exception|
     when Errors::InvalidCommandSyntax
       puts "Exiting..."
       exit(ExitCodes::INVALID_COMMAND_SYNTAX)
+    when Errors::RetainFailedBuildState
+      puts "Exiting..."
+      exit(ExitCodes::STANDARD_BUILD_FAILURE)
     when RuntimeError
       # allow default handler to take over when invalid arguments are passed in
     else

data/features/managing_project_build_status.feature

@@ -9,7 +9,6 @@ Feature: Managing a project's build status
     And I cd to "project_1/"
     When I run "#{@bin_path}/fumes build --start ie7"
     Then the output should contain "Setting 'ie7' build status to 'started'"
-    And the output should contain "'ie7' build successfully marked as 'started'"
     And the exit status should be "SUCCESS"
 
   Scenario: Setting a project build status to 'failure'
@@ -18,7 +17,6 @@ Feature: Managing a project's build status
     And I run "#{@bin_path}/fumes build --start ie7"
     When I run "#{@bin_path}/fumes build --finished=failed ie7"
     Then the output should contain "Setting 'ie7' build status to 'failed'"
-    And the output should contain "'ie7' build successfully marked as 'failed'"
     And the exit status should be "SUCCESS"
 
   Scenario: Setting a project build status to an invalid state
@@ -60,4 +58,46 @@ Feature: Managing a project's build status
     When I run "#{@bin_path}/fumes build"
     Then the output should contain "build [options]"
     Then the output should contain "Options:"
+    And the exit status should be "INVALID_COMMAND_SYNTAX"
+
+  Scenario: Wrapping a successful build command with build start & stop information
+    Given I have cloned and synchronized 1 project
+    And I cd to "project_1/"
+    And I run "#{@bin_path}/fumes build --exec='ls ./' ie7"
+    Then the output should contain "Executing: 'ls ./'"
+    And the output should contain "Setting 'ie7' build status to 'started'"
     And the exit status should be "SUCCESS"
+
+  Scenario: Wrapping a failing build command with build start & stop information
+    Given I have cloned and synchronized 1 project
+    And I cd to "project_1/"
+    And I run "#{@bin_path}/fumes build --exec='lr ./' ie7"
+    Then the output should contain "Executing: 'lr ./'"
+    And the output should contain "Setting 'ie7' build status to 'started'"
+    And the exit status should be "STANDARD_BUILD_FAILURE"
+
+  Scenario: Specifying --start AND --exec in the same command
+    Given I have cloned and synchronized 1 project
+    And I cd to "project_1/"
+    And I run "#{@bin_path}/fumes build --start --exec='lr ./' ie7"
+    Then the output should contain "'--exec' and the '--start' flags"
+    And the output should not contain "Executing: 'lr ./'"
+    And the output should not contain "Setting 'ie7' build status to 'started'"
+    And the exit status should be "INVALID_COMMAND_SYNTAX"
+
+  Scenario: Specifying --finished AND --exec in the same command
+    Given I have cloned and synchronized 1 project
+    And I cd to "project_1/"
+    And I run "#{@bin_path}/fumes build --finished='failed' --exec='lr ./' ie7"
+    Then the output should contain "'--exec' and the '--finished' flags"
+    And the output should not contain "Executing: 'lr ./'"
+    And the output should not contain "Setting 'ie7' build status to 'started'"
+    And the exit status should be "INVALID_COMMAND_SYNTAX"
+
+  Scenario: Starting a build for a project without specifying a build name
+    Given I have cloned and synchronized 1 project
+    And I cd to "project_1/"
+    When I run "#{@bin_path}/fumes build --start"
+    Then the output should contain "include a build name"
+    And the output should not contain "build status to 'started'"
+    And the exit status should be "INVALID_COMMAND_SYNTAX"

data/lib/codefumes.rb

@@ -12,5 +12,5 @@ require 'codefumes/source_control.rb'
 include CodeFumes::API
 
 module CodeFumes
-  VERSION = '0.3.0' unless defined?(CodeFumes::VERSION)
+  VERSION = '0.4.0' unless defined?(CodeFumes::VERSION)
 end

data/lib/codefumes/cli_helpers.rb

@@ -14,6 +14,27 @@ module CodeFumes
       command && command.name.to_sym == :build
     end
 
+    def build_name_specified?(args)
+      !args.first.nil?
+    end
+
+    def actionable_flag_specified?(options)
+      actionable_flags = [:finished, :status, :start, :exec]
+      !actionable_flags.select {|flag| options[flag]}.empty?
+    end
+
+    def updating_build_state?(options)
+      !!(options[:start] || options[:finished])
+    end
+
+    def checking_build_status?(options)
+      !!(options[:status])
+    end
+
+    def scoped_to_all_builds?(options)
+      options[:all]
+    end
+
     def issue_project_commands(message, public_keys, &block)
       public_keys.each do |public_key|
         print "#{message}...'#{public_key}': "

data/lib/codefumes/errors.rb

@@ -12,6 +12,9 @@ module CodeFumes
     class InvalidCommandSyntax < StandardError #:nodoc:
     end
 
+    class RetainFailedBuildState < StandardError #:nodoc:
+    end
+
     class NoUserApiKeyError < ArgumentError #:nodoc:
     end
 

data/lib/codefumes/exit_codes.rb

@@ -9,6 +9,7 @@ module CodeFumes
     MISSING_DEPENDENCY         = 6
     INVALID_BUILD_STATE        = 7
     INVALID_COMMAND_SYNTAX     = 8
+    STANDARD_BUILD_FAILURE     = 9
     UNKNOWN                    = 100
   end
 end

data/tasks/contributor_tasks.rb

@@ -0,0 +1,64 @@
+require 'rake'
+require 'rake/tasklib'
+
+class ContributorTasks < Rake::TaskLib
+  def initialize
+    define
+  end
+
+  def define
+    desc "Update contributors list in README"
+    task :update_contributors do
+      if new_contributors?
+        puts "New contributors!"
+        new_contributors.each {|name| puts "- #{name}"}
+        puts ""
+
+        print "Updating the 'Contributors' section of README..."
+
+        File.open("README.txt", "w+") do |file|
+          file.puts readme_without_contributors_section
+          file.puts "== Contributors (sorted alphabetically)"
+          file.puts ""
+          committers.each {|name| file.puts "* #{name}"}
+        end
+        puts "done!"
+      else
+        puts "No new contributors."
+      end
+    end
+  end
+
+  private
+    def all_committers
+      all_names = `git shortlog -s |cut -s -f2`
+      all_names.gsub!(/\sand\s/, "\n").split("\n").uniq!.sort!
+    end
+
+    def committers
+      excluded_committers = ["Tom Kersten", "Leah Rieger"]
+      @committers ||= all_committers - excluded_committers
+    end
+
+    def readme_file_contents
+      @readme_contents ||= `cat README.txt`
+    end
+
+    def existing_contributors
+      existing_contributors = readme_file_contents[/== Contributors(.|\n)*/].strip.split("\n* ")
+      existing_contributors.shift # remove "Contributors..." line
+      existing_contributors
+    end
+
+    def new_contributors
+      @new_contributors ||= committers - existing_contributors
+    end
+
+    def new_contributors?
+      !new_contributors.empty?
+    end
+
+    def readme_without_contributors_section
+      readme_file_contents.sub(/== Contributors(.|\n)*/, '')
+    end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codefumes
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tom Kersten
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 -05:00
+date: 2010-10-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -297,10 +297,11 @@ files:
 - spec/fixtures/sample_project_dirs/no_scm/description
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/contributor_tasks.rb
 - tasks/cucumber.rake
 - tasks/rspec.rake
 has_rdoc: true
-homepage: http://codefumes.rubyforge.org/codefumes
+homepage: http://cosyn.github.com/codefumes
 licenses: []
 
 post_install_message: