factorylabs-cargo 0.0.2.6

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.2 2009-04-24
+
+* 1 major enhancement:
+  * setup gem in github
+  * create streamlined commands (hack, pack, ship, yank)
+  
+== 0.0.1 2009-04-21
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/cargo
+bin/hack
+bin/pack
+bin/ship
+bin/yank
+files/cargo.user.js
+files/cargo.png
+lib/cargo.rb
+lib/cargo/cargo_server.rb
+lib/cargo/command_helpers.rb
+script/console
+script/destroy
+script/generate
+spec/cargo_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,121 @@
+== 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 currently in alpha and has no tests (eeek!)
+
+== FEATURES:
+
+* Commands to streamline git usage.
+* Server/userscript integration with Pivotal Tracker (and growlnotify).
+
+== SYNOPSIS:
+
+=== 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).
+
+=== 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] $
+  
+* pack (switch to master and merge branch)
+   cargo[git:fix_issue_1234] $ pack
+   Switched to branch "master"
+   cargo[git:master] $ git status
+   On branch master
+   Your branch is ahead of 'origin/master' by 7 commits.
+   
+   nothing to commit (working directory clean)
+   cargo[git:master] $
+
+* ship (switch to master and merge branch push to remote origin, delete topic branch)
+   cargo[git:fix_issue_1234] $ ship
+   Switched to branch "master"
+   Counting objects: 60, done.
+   Compressing objects: 100% (45/45), done.
+   Writing objects: 100% (46/46), 16.92 KiB, done.
+   Total 46 (delta 23), reused 0 (delta 0)
+   To git@github.com:factorylabs/cargo.git
+     41e9cfb..b51cba0  master -> master
+   cargo[git:master] $ git branch
+   * master
+   cargo[git:master] $
+  
+* yank (rebase current branch with latest from master)
+   cargo[git:fix_issue_1234] $ yank
+   Switched to branch "master"
+   From git@github.com:factorylabs/cargo
+   * branch            master     -> FETCH_HEAD
+   Switched to branch "fix_issue_1234"
+   Current branch fix_issue_1234 is up to date.
+   cargo[git:fix_issue_1234] $
+  
+== REQUIREMENTS:
+
+The Cargo server and userscript integration for pivotal tracker requires one of
+the following setups:
+
+* Firefox 3.0.9+, and the Greasemonkey plugin that can be found at https://addons.mozilla.org/en-US/firefox/addon/748
+
+Future support will include:
+
+* Nightly Build of WebKit (OS X r42858)+, and GreaseKit that can be found at http://8-p.info/greasekit/
+
+* Fluid support should be coming with the next public update of Safari.
+
+== INSTALL:
+
+sudo gem install factorylabs-cargo --source=http://gems.github.com  
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Factory Design Labs
+
+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,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/cargo'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('cargo', Cargo::VERSION) do |p|
+  p.developer('Factory Design Labs', 'interactive@factorylabs.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = ""
+  p.rubyforge_name       = p.name
+  p.extra_deps           = [
+    ['rack', '>= 0.9.1'],
+  ]
+  p.extra_dev_deps        = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  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.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/cargo

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "#{File.dirname(__FILE__)}/../lib/cargo/cargo_server.rb"

data/bin/hack

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/../lib/cargo/command_helpers.rb"
+
+
+git_freshen_master
+
+if ARGV.empty?
+  total = `git branch`.scan("story").size
+  if total == 0
+    default = "story"
+  else
+    default = "story_#{total + 1}"
+  end
+  name = Readline.readline "Topic name (#{default}): "
+  if name.strip.empty?
+    name = default
+  end
+else
+  name = ARGV[0]
+end
+
+if ARGV.length > 1
+  story_number = ARGV[1]
+else
+  story_number = Readline.readline "Story number (optional): "
+end
+
+unless story_number.strip.empty?
+  name = "#{name}-#{story_number}"
+end
+
+cmd "git checkout -b #{name}"

data/bin/pack

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/../lib/cargo/command_helpers.rb"
+
+git_merge_with_master

data/bin/ship

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/../lib/cargo/command_helpers.rb"
+
+branch = git_branch
+git_merge_with_master(branch)
+cmd "git push origin master"
+cmd "git branch -d #{branch}"

data/bin/yank

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require "#{File.dirname(__FILE__)}/../lib/cargo/command_helpers.rb"
+
+branch = git_branch
+git_freshen_master
+cmd "git checkout #{branch}"
+stash_if_dirty
+cmd "git rebase master"
+apply_stash_if_was_dirty

data/files/cargo.user.js

@@ -0,0 +1,94 @@
+// ==UserScript==
+// @name        cargo
+// @description Hijacks story stage changed events and sends an XHR request to your local cargo server that will create a new git branch when you start a story, and tries to commit that branch when you mark it as finished.
+// @include     http://www.pivotaltracker.com/projects/*
+// @author      Factory Design Labs
+// ==/UserScript==
+
+GARGO_SERVER = 'http://localhost:8081';
+CARGO_ASK_FIRST = true;
+
+Cargo = {
+  gm: true,
+  
+  initialize: function() {
+    // make th script work with both GreaseKit and Greasemonkey
+    if (typeof(unsafeWindow) == 'undefined') {
+      this.gm = false;
+      window.unsafeWindow = window;
+    }
+    this.hijackActions();
+  },
+  
+  hijackActions: function() {
+    unsafeWindow.Cargo = this;
+    var takeOverFunction = function() {
+      PerformStoryAction.prototype.signalSuccessFromServer =
+      PerformStoryAction.prototype.signalSuccessFromServer.wrap(
+        function(oldMethod) {
+          Cargo.performedStoryAction(this.story);
+          oldMethod();
+        }
+      );
+    }
+    
+    if (this.gm) location.href = "javascript:(" + takeOverFunction + ")()";
+    else takeOverFunction();
+  },
+  
+  performedStoryAction: function(story) {
+    var state = story.getCurrentState()
+
+    var params = {
+      id: story.getId(),
+      initials: (story.getOwnedBy()) ? story.getOwnedBy().initials : '',
+      name: story.getName(),
+      story_type: story.getStoryType()._displayName,
+      description: story.getDescription()
+    }
+
+    switch (state.toString()) {
+    case 'started':
+      if ((CARGO_ASK_FIRST) ? confirm("Create a working branch?") : true) {
+        this.request('start', params);
+      }
+      break;
+    case 'finished':
+      if ((CARGO_ASK_FIRST) ? confirm("Commit your working branch?") : true) {
+        this.request('finish', params);
+      }
+      break;
+    }
+  },
+
+  request: function(action, params) {
+    setTimeout(function() {
+      var method = 'POST';
+      var url = [GARGO_SERVER, action].join('/');
+      var headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
+      var data = unsafeWindow.Object.toQueryString(params);
+      
+      if (Cargo.gm) {
+        GM_xmlhttpRequest({method: method, headers: headers, url: url, data: data,
+          onerror: function() { alert("Error: Cargo server isn't started?"); },
+          onload: function(response) {
+            Cargo.debug(response);
+          }
+        });
+      } else {
+        new Ajax.Request(url, {method: method, parameters: params,
+          onFailure: function() { alert("Error: Cargo server isn't started?"); },
+          onSuccess: function(response) {
+            Cargo.debug(response);
+          }
+        });
+      }
+    }, 0);
+  },
+  
+  debug: function() {
+    if (unsafeWindow.console && unsafeWindow.console.info) unsafeWindow.console.info(arguments);
+  }
+};
+
+Cargo.initialize();

data/lib/cargo/cargo_server.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rack'
+require 'cargo'
+require "#{File.dirname(__FILE__)}/command_helpers.rb"
+
+puts "=> Starting Cargo #{Cargo::VERSION} on http://0.0.0.0:8081"
+puts "=> Ctrl-C to shutdown server"
+puts "** Cargo listening at 0.0.0.0:8081"
+
+class CargoServer
+  def call(env)
+    if env['REQUEST_METHOD'] == 'OPTIONS'
+      [200, {
+        'Access-Control-Allow-Origin' => '*', # TODO get this working with restrictions
+        'Access-Control-Allow-Methods' => 'GET, OPTIONS',
+        'Access-Control-Allow-Headers' => 'X-Prototype-Version, X-Requested-With, Accept',
+        'Access-Control-Max-Age' => '1728000',
+        'Access-Control' => 'allow <*>'
+        }, '']
+    else
+      req = Rack::Request.new(env)
+      puts req.path_info
+      case req.path_info
+
+      when '/start' # start a story
+        puts `hack #{escape(req['name'])[0..30]} #{req['id']}`
+        notify("Starting Story", "Starting story '#{req['name']}' [#{req['id']}]", 0)
+        
+        [200, { 'Content-Type' => 'application/json; charset=utf-8'},
+          "{success: 'starting story'}"]
+
+      when '/finish' # finish a story
+        branch = git_branch
+        story_id = branch.split('-').last
+        if story_id == req['id']
+          puts `ship`
+          notify("Finishing Story", "Finishing story '#{req['name']}' [#{req['id']}]", 0)
+        else
+          notify("Story id doesn't match current branch", "Story id doesn't match current branch '#{branch}' [#{req['id']}]", 1)
+        end
+        
+        [200, {'Content-Type' => 'application/json; charset=utf-8'},
+          "{success: 'finishing story'}"]
+
+      when '/cargo.user.js' # send the user script file
+        [200, {'Content-Type' => 'text/javascript'},
+          File.read("#{File.dirname(__FILE__)}/../../files/cargo.user.js")]
+
+      else # handle everything else like a 404
+        [404, {'Content-Type' => 'text/html'}, '404 Not Found']
+
+      end
+    end
+  end
+  
+  def escape(name)
+    name.gsub!(/\W+/, ' ') # all non-word chars to spaces
+    name.strip!            # ohh la la
+    name.downcase!         #
+    name.gsub!(/\ +/, '_')
+  end
+
+  def notify(title, message, priority)
+    puts message
+    system "growlnotify -n Cargo --image #{File.dirname(__FILE__)}/../../files/cargo.png -p #{priority} -m #{message} #{title}"
+  end
+end
+
+Rack::Handler::Mongrel.run CargoServer.new, :Port => 8081

data/lib/cargo/command_helpers.rb

@@ -0,0 +1,61 @@
+require 'readline'
+
+def git_branch
+  `git branch | grep "*"`.strip[2..-1]
+end
+
+def is_branch_dirty?
+  status = `git status`
+  /\#\s+modified\:/ =~ status  
+end
+
+def git_checkout(branch)
+  cmd "git checkout #{branch}"
+end
+
+def stash_if_dirty
+  if is_branch_dirty?
+    cmd "git stash"
+  end
+end
+
+def apply_stash_if_was_dirty
+  stash_list = `git stash list`
+  if /stash\@\{\d\}\:/ =~ stash_list
+    cmd "git stash pop"
+  end
+end
+
+def git_merge_with_master(branch=git_branch)
+  git_checkout "master"
+  cmd "git merge #{branch}"
+end
+
+def git_freshen_master
+  git_checkout "master"
+  cmd "git pull origin master"
+end
+
+def cmd(input)
+  result = `#{input}`
+  puts result
+  if $?.exitstatus > 0
+    puts "Cargo (#{input}) failed, exiting. [#{$?.exitstatus}]"
+    exit 1
+  end
+  result
+end
+
+def compare_git_ver
+  m = /git version (\d+).(\d+).(\d+)/.match(`git version`.strip)
+  return true  if m[1].to_i > 1
+  return false if m[1].to_i < 1
+  return true  if m[2].to_i > 5
+  return false if m[2].to_i < 5
+  return true  if m[3].to_i >= 3
+  return false
+end
+
+def check_git_ver
+  raise "Invalid git version, use at least 1.5.3" unless compare_git_ver
+end

data/lib/cargo.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Cargo
+  VERSION = '0.0.2.6'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/cargo.rb'}"
+puts "Loading cargo gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/cargo_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'cargo'

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

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: factorylabs-cargo
+version: !ruby/object:Gem::Version 
+  version: 0.0.2.6
+platform: ruby
+authors: 
+- Factory Design Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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 currently in alpha and has no tests (eeek!)
+email: 
+- interactive@factorylabs.com
+executables: 
+- cargo
+- hack
+- pack
+- ship
+- yank
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/cargo
+- bin/hack
+- bin/pack
+- bin/ship
+- bin/yank
+- files/cargo.user.js
+- files/cargo.png
+- lib/cargo.rb
+- lib/cargo/cargo_server.rb
+- lib/cargo/command_helpers.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/cargo_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://www.factorylabs.com/images/cargo.png
+post_install_message: ""
+rdoc_options: 
+- --main
+- README.rdoc
+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: 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
+test_files: []
+