factorylabs-cargo 0.0.2.7 → 0.0.2.8

data/README.rdoc

@@ -2,50 +2,43 @@
 
 http://www.factorylabs.com/images/cargo.png
 
-Cargo is a set of tools to help streamline using git.  The type of tools and
-usage vary, but they represent a process that we've adapted to streamline our
-workflow.
+Cargo is a set of tools to help streamline using git and Pivotal Tracker for agile development. Starting a story creates 
+a new branch and finishing a story merges the branch back into master.  This can be done either with browser integration or a set of command line tools.
 
-More features will be added.  Pivotal integration on git wrapper commands and
-other features are on the unofficial list.
+More features will be added.  This is still alpha software
 
-This is still alpha
-
-== FEATURES:
-
-* Commands to streamline git usage.
-* Server/userscript integration with Pivotal Tracker (and growlnotify).
+== INSTALL:
 
-== SYNOPSIS:
+    sudo gem install factorylabs-cargo --source=http://gems.github.com  
 
-=== Cargo Server:
-  
-* cargo (runs the cargo server that listens for incoming events)
-   cargo[git:master] $ cargo
-   => Starting Cargo 0.0.2 on http://0.0.0.0:8081
-   => Ctrl-C to shutdown server
-   ** Cargo listening at 0.0.0.0:8081
+== Setup:
 
-To install the userscript in either Firefox, or the nightly build of WebKit
-(requirements outlined below) browse to http://localhost:8081/cargo.user.js
+    echo "api_key: YOUR_PIVOTAL_TRACKER_API_KEY"  > ~/.cargo.yml
+    echo "project: PIVOTAL_TRACKER_PROJECT_ID"  > RAILS_ROOT/.cargo.yml (optional hack will prompt for project if it isn't configured)
 
-If you have the proper setup (Greasemonkey / GreaseKit) you'll be prompted to
-install the user script.  Once installed you'll be asked when starting a story
-if a branch should be created automatically, and asked if you'd like your
-changes committed when finishing a story (prompting is configurable).
+== SYNOPSIS:
 
 === Git Wrapper Commands:
 
-* hack (update master create a topic branch)
-   cargo[git:master] $ hack
-   Already on "master"
-   From git@github.com:factorylabs/cargo
-   * branch            master     -> FETCH_HEAD
-   Topic name (story): fix_issue
-   Story number (optional): 1234
-   Switched to a new branch "fix_issue_1234"
-   cargo[git:fix_issue_1234] $
-  
+* hack (start a new story and create a branch for that story)
+    use hack from the command line at the root of your project
+    call it with a story id or with no arguments it will pull the 
+    unstarted stories from the Tracker project and allow you to choose one
+
+    hack will start the story via the Pivotal Tracker API and start a new
+    branch with the story name and id
+    cargo[git:master] $ hack
+    Already on "master"
+    From git@github.com:factorylabs/cargo
+    * branch            master     -> FETCH_HEAD
+    Fetching tracker stories
+    Choose a story
+    1) 'Keyword search' issues
+    2) 'Detail view' issues
+    Enter story number: [Type # Here]
+    Switched to a new branch "keyword_search_issues-1234"
+    cargo[git:keyword_search_issues-1234] $
+
 * pack (switch to master and merge branch)
    cargo[git:fix_issue_1234] $ pack
    Switched to branch "master"
@@ -56,7 +49,7 @@ changes committed when finishing a story (prompting is configurable).
    nothing to commit (working directory clean)
    cargo[git:master] $
 
-* ship (switch to master and merge branch push to remote origin, delete topic branch)
+* ship (switch to master and merge branch push to remote origin, delete topic branch, mark story as finished)
    cargo[git:fix_issue_1234] $ ship
    Switched to branch "master"
    Counting objects: 60, done.
@@ -67,6 +60,7 @@ changes committed when finishing a story (prompting is configurable).
      41e9cfb..b51cba0  master -> master
    cargo[git:master] $ git branch
    * master
+   Marking story as finished
    cargo[git:master] $
   
 * yank (rebase current branch with latest from master)
@@ -78,6 +72,22 @@ changes committed when finishing a story (prompting is configurable).
    Current branch fix_issue_1234 is up to date.
    cargo[git:fix_issue_1234] $
   
+=== Cargo Server:
+  
+* cargo (runs the cargo server that listens for incoming events)
+   cargo[git:master] $ cargo
+   => Starting Cargo 0.0.2 on http://0.0.0.0:8081
+   => Ctrl-C to shutdown server
+   ** Cargo listening at 0.0.0.0:8081
+
+To install the userscript in either Firefox, or the nightly build of WebKit
+(requirements outlined below) browse to http://localhost:8081/cargo.user.js
+
+If you have the proper setup (Greasemonkey / GreaseKit) you'll be prompted to
+install the user script.  Once installed you'll be asked when starting a story
+if a branch should be created automatically, and asked if you'd like your
+changes committed when finishing a story (prompting is configurable).
+
 == REQUIREMENTS:
 
 The Cargo server and userscript integration for pivotal tracker requires one of
@@ -91,14 +101,6 @@ Future support will include:
 
 * Fluid support should be coming with the next public update of Safari.
 
-== INSTALL:
-
-    sudo gem install factorylabs-cargo --source=http://gems.github.com  
-
-== Setup:
-
-    echo "api_key: YOUR_PIVOTAL_TRACKER_API_KEY"  > ~/.cargo.yml
-
 == LICENSE:
 
 (The MIT License)

data/lib/cargo.rb

@@ -3,7 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   
 
 module Cargo
-  VERSION = '0.0.2.7'
+  VERSION = '0.0.2.8'
 
   class Error < RuntimeError
   end

data/lib/cargo/commands/hack.rb

@@ -27,7 +27,7 @@ module Cargo
       
       def fetch_stories
         puts "Fetching tracker stories"
-        stories = current_project.stories('state:unstarted')
+        stories = current_project.stories('state:unstarted')[0..10]
         puts "Choose a story"
         stories.each_with_index do |story, i|
           puts "#{i+1}) #{story.name}"

data/lib/cargo/commands/ship.rb

@@ -12,6 +12,7 @@ module Cargo
       end
       
       def finish_story(story_id)
+        puts 'Marking story as finished'
         story = Pickler::Tracker::Story.new(@current_project,@current_project.tracker.get_xml("/projects/#{@current_project.id}/stories/#{story_id}")["story"])      
         story.finish!
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: factorylabs-cargo
 version: !ruby/object:Gem::Version 
-  version: 0.0.2.7
+  version: 0.0.2.8
 platform: ruby
 authors: 
 - Factory Design Labs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -07:00
+date: 2009-05-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: http://www.factorylabs.com/images/cargo.png  Cargo is a set of tools to help streamline using git.  The type of tools and usage vary, but they represent a process that we've adapted to streamline our workflow.  More features will be added.  Pivotal integration on git wrapper commands and other features are on the unofficial list.  This is still alpha
+description: http://www.factorylabs.com/images/cargo.png  Cargo is a set of tools to help streamline using git and Pivotal Tracker for agile development. Starting a story creates  a new branch and finishing a story merges the branch back into master.  This can be done either with browser integration or a set of command line tools.  More features will be added.  This is still alpha software
 email: 
 - interactive@factorylabs.com
 executables: 
@@ -116,7 +116,7 @@ rubyforge_project: cargo
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: http://www.factorylabs.com/images/cargo.png  Cargo is a set of tools to help streamline using git
+summary: http://www.factorylabs.com/images/cargo.png  Cargo is a set of tools to help streamline using git and Pivotal Tracker for agile development
 test_files: 
 - test/base_test.rb
 - test/config_test.rb