trellish 0.0.15 → 0.0.18

data/README.md

@@ -1,6 +1,6 @@
 # Trellish
 
-Trellish is used to finish a Trello card. It does everything necessary to move a development card from the In Progress list to the QA list.
+Trellish is used to start and finish a Trello card. It does everything necessary to move a development card from "Next up" to "In Progress" when you start work on a card and again from "In Progress" to "QA" when you finish a card.
 
 ## Installation
 
@@ -16,9 +16,9 @@ Or install it yourself as:
 
     $ gem install trellish
 
-## Usage
+## Setup
 
-Create a trellish.yml file in your current directory or home directory. Set it up like this:
+Create a `./trellish.yml`, `~/trellish.yml` or `~/.trellish` file with the contents of [trellish.example.yml](trellish/blob/master/trellish.example.yml). Set it up like this:
 
 1. Sign in to Trello and go to https://trello.com/1/appKey/generate.
 1. Copy "Key" from that page to trello\_api\_key.
@@ -28,18 +28,49 @@ Create a trellish.yml file in your current directory or home directory. Set it u
 1. Run: `curl -u 'username' -d '{"scopes":["repo"],"note":"Trellish"}' https://api.github.com/authorizations`
 1. Copy the token parameter from the response to github\_oauth\_token.
 
-`git checkout` the topic branch for the card you are finishing. Then do this:
+Optionally, Trellish can announce the starting and finishing of cards on 37signal's [Campfire](http://campfirenow.com/). To enable this:
+
+1. Sign in to Campfire and go to your "my info" page. You can find the link in the upper-right corner.
+1. Copy your subdomain name to campfire\_subdomain.
+1. Copy your API authentication token to campfire\_token.
+1. Specify the room name in campfire\_room.
+
+## Usage
+
+By default, Trellish expects a Trello board named `Current` with 3 lists: `Next up`, `In progress`, and `QA`. You can change these defaults using the Trellish config file.
+
+To start work on a card:
+
+    trellish start [Trello card id or URL]
+
+This will:
+
+- move the card from `Next up` to `In progress`,
+- add you as a member,
+- create a local git branch named using your git initials and the card's title.
+
+If you don't provide a card id or URL on the command line, trellish shows you the cards in `Next up` and prompts you to select one, like so:
+
+    Select a card:
+    1. BUG: crash adding a comment
+    2. users can select an avatar
+    3. add iPad integration tests
+    >
+
+When you're done working on a card, finish it using:
 
-    trellish https://trello.com/c/a3Wbcde4
+    trellish finish [Trello card id or URL]
 
-or alternately:
+Like:
 
-    trellish a3Wbcde4
+    trellish finish https://trello.com/c/a3Wbcde4
+    trellish finish a3Wbcde4
+    trellish finish
 
 This will:
 
-- create a pull request to merge your topic branch into master
-- add a link to the pull request to the beginning of the card description
+- create a pull request to merge your topic branch into master (with a description linking back to the card)
+- add a link to the pull request from the card's description
 - remove everyone from the card
 - move the card to the QA list
 

data/bin/trellish

@@ -1,32 +1,46 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
+require 'readline'
 require 'trellish'
 require 'trellish/card'
 require 'yaml'
 
-if ARGV[0].nil?
-  Trellish.logger.error "Please provide a Trello card id or URL."
-  exit
-end
+# process config file
 
-config_file = if File.exists?('trellish.yml')
-              YAML.load(File.read('trellish.yml'))
-            elsif File.exists?(File.expand_path('~/trellish.yml'))
-              YAML.load(File.read(File.expand_path('~/trellish.yml')))
-            end
+config_paths = %w(trellish.yml ~/trellish.yml ~/.trellish)
+config_filepath = config_paths.collect { |e| File.expand_path(e) }.find { |e| File.exists?(e) }
+config_file = YAML.load(File.read(config_filepath)) if config_filepath
 
 unless config_file
-  Trellish.logger.error "Could not locate trellish.yml file in current directory or home directory."
+  Trellish.logger.error "Could not locate your settings in ./trellish.yml, ~/trellish.yml, or ~/.trellish"
   exit
 end
 
-Trellish.configure(
-  trello_api_key: config_file['trello_api_key'],
-  trello_oauth_secret: config_file['trello_oauth_secret'],
-  trello_oauth_token: config_file['trello_oauth_token'],
-  github_oauth_token: config_file['github_oauth_token'],
-  git_base_branch: config_file['git_base_branch'] || 'master',
-  qa_list_name: config_file['qa_list_name'] || 'QA')
+Trellish.configure(config_file)
+
+# parse command-line arguments
+
+case ARGV[0]
 
-card = Trellish::Card.new(ARGV[0])
-card.finish
+when 'start'
+  card =
+    if ARGV[1]
+      Trellish::Card.new(ARGV[1])
+    else
+      Trellish::Card.select_from_list(Trellish.config[:next_up_list_name], false)
+    end
+  puts %Q(Starting card “#{card.name}”)
+  card.start
+
+when 'finish'
+  card =
+    if ARGV[1]
+      Trellish::Card.new(ARGV[1])
+    else
+      Trellish::Card.select_from_list(Trellish.config[:in_progress_list_name], true)
+    end
+  puts %Q(Finishing card “#{card.name}”)
+  card.finish
+
+end

data/lib/trellish.rb

@@ -12,8 +12,14 @@ module Trellish
     trello_oauth_secret: 'TRELLO_OAUTH_SECRET',
     trello_oauth_token: 'TRELLO_OAUTH_TOKEN',
     github_oauth_token: 'GITHUB_OAUTH_TOKEN',
-    git_base_branch: 'GIT_BASE_BRANCH',
-    qa_list_name: 'QA'
+    git_base_branch: 'master',
+    board_name: 'Current',
+    next_up_list_name: 'Next up',
+    in_progress_list_name: 'In progress',
+    qa_list_name: 'QA',
+    campfire_subdomain: nil,
+    campfire_token: nil,
+    campfire_room: nil
   }
 
   @valid_config_keys = @config.keys

data/lib/trellish/auth.rb

@@ -8,7 +8,11 @@ module Trellish
 
     Trello::Authorization.const_set :AuthPolicy, OAuthPolicy
 
+    @@member = nil
+
     def self.authorize
+      return @@member if @@member
+
       OAuthPolicy.consumer_credential = OAuthCredential.new(
         Trellish.config[:trello_api_key],
         Trellish.config[:trello_oauth_secret])
@@ -17,7 +21,8 @@ module Trellish
       # Test that the user is authorized
       begin
         member_id = Trello::Token.find(OAuthPolicy.token.key).member_id
-        Member.find(member_id)
+        @@member = Member.find(member_id)
+        @@member
       rescue
         Trellish.logger.error "Unable to authorize access to Trello API."
         exit

data/lib/trellish/campfire.rb

@@ -0,0 +1,24 @@
+require 'tinder'
+
+module Trellish
+  module Campfire
+
+    def announce(message)
+      room.speak message if room
+    end
+
+    private
+
+    def room
+      @room ||=
+        if [:campfire_subdomain, :campfire_token, :campfire_room].all? { |s| Trellish.config[s] }
+          campfire = Tinder::Campfire.new Trellish.config[:campfire_subdomain], :token => Trellish.config[:campfire_token]
+          campfire.rooms.find { |room| room.name == Trellish.config[:campfire_room] }
+        end
+    rescue
+      Trellish.logger.error "Unable to access Campfire. Is your subdomain, token, and room name correct?"
+      exit
+    end
+
+  end
+end

data/lib/trellish/card.rb

@@ -1,41 +1,130 @@
+# encoding: utf-8
+
+require 'trellish/campfire'
 require 'trellish/git'
 
 module Trellish
   class Card
     include Trello
     include Trellish::Git
+    include Trellish::Campfire
+
+    def self.select_from_list(list_name, assigned_to_me = false)
+      me = Trellish::Auth.authorize
+      boards = me.boards(filter: :open)
+      current_board = boards.find { |board| board.name == Trellish.config[:board_name] }
+      if current_board.nil?
+        Trellish.logger.error "Unable to find a board named `#{Trellish.config[:board_name]}`."
+        exit
+      end
+
+      list = current_board.lists.find { |list| list.name == list_name }
+      if list.nil?
+        Trellish.logger.error "Unable to find a list named `#{list_name}` on board `#{Trellish.config[:board_name]}`."
+        exit
+      end
+
+      cards = list.cards
+
+      if assigned_to_me
+        cards = cards.find_all { |card| card.member_ids.include?(me.id) }
+      end
+
+      case cards.length
+      when 0
+        if assigned_to_me
+          Trellish.logger.error "There are no cards assigned to you in the list `#{list_name}`"
+        else
+          Trellish.logger.error "There are no cards in the list `#{list_name}`"
+        end
+        exit
+      when 1
+        index = 0
+      else
+        puts "\nSelect a card:"
+        cards.each_with_index { |card, index| puts "#{index+1}. #{card.name}" }
+        index = Readline.readline("> ")
+        exit if index.blank?
+        index = index.to_i - 1
+      end
+
+      Trellish::Card.new( cards[index].id )
+    end
 
     def initialize(card_id_or_url)
       @member = Trellish::Auth.authorize
       @card = Trello::Card.find(parse_card_id(card_id_or_url))
     end
 
+    def add_me_as_member
+      @card.add_member(@member) unless @card.member_ids.include?(@member.id)
+    end
+
     def add_pull_request_link
-      @card.description = "[Pull Request] (#{github_pull_request_url})\n\n#{@card.description}"
-      @card.save
+      # Unfortunately, changing the card's description changes the card's URL, which breaks
+      # the link from the pull request, and our announcements to Campfire. Instead, add
+      # a comment to the pull request.
+      # @card.description = "[Pull Request](#{github_pull_request_url})\n\n#{@card.description}"
+      # @card.update!
+      message = "Pull request is at #{github_pull_request_url}"
+      @card.add_comment message
+    end
+
+    def create_local_branch
+      branch_name = "#{git_user_initials}-#{short_name}"
+      git_create_local_branch(branch_name)
     end
 
     def finish
+      if !current_git_branch_is_up_to_date?
+        finish = Readline.readline("Your remote branch isn’t up-to-date. Finish anyway? [y,N] ")
+        exit unless ['y','yes'].include?(finish.strip.downcase)
+      end
+
       add_pull_request_link
       remove_all
       move_to_qa
+      announce %Q([Trellish] Finished card “#{@card.name}” #{@card.url}. The pull request is at #{github_pull_request_url})
     end
 
     def move_to_qa
-      qa_list = @card.board.lists.find { |list| list.name == Trellish.config[:qa_list_name] }
-      if qa_list
-        @card.move_to_list(qa_list)
-      else
-        Trellish.logger.warn "Unable to move card to #{Trellish.config[:qa_list_name]} list. No list named #{Trellish.config[:qa_list_name]} found."
-      end
+      move_to_list(Trellish.config[:qa_list_name])
+    end
+
+    def move_to_in_progress
+      move_to_list(Trellish.config[:in_progress_list_name])
+    end
+
+    def name
+      @card.name
     end
 
     def remove_all
       @card.remove_all_members
     end
 
+    def short_name
+      name.strip.downcase.tr(' ','-').gsub(/[^0-9A-Za-z\-]/, '')[0..30]
+    end
+
+    def start
+      move_to_in_progress
+      add_me_as_member
+      create_local_branch
+      announce %Q([Trellish] Starting card “#{@card.name}” #{@card.url})
+    end
+
     private
 
+    def move_to_list(list_name)
+      list = @card.board.lists.find { |list| list.name == list_name }
+      if list
+        @card.move_to_list(list)
+      else
+        Trellish.logger.warn "Unable to move card to #{list_name} list. No list named #{list_name} found."
+      end
+    end
+
     def parse_card_id(card_id_or_url)
       card_id_or_url.match(/[A-Za-z0-9]*$/)[0]
     end

data/lib/trellish/git.rb

@@ -3,10 +3,6 @@ require 'faraday'
 module Trellish
   module Git
 
-    def current_git_branch
-      @current_git_branch ||= `cat .git/head`.split('/').last.strip
-    end
-
     def github_pull_request_url
       return @github_pull_request_url if @github_pull_request_url
       conn = Faraday.new(:url => 'https://api.github.com', :ssl => {:ca_file => '/System/Library/OpenSSL/certs/ca-certificates.crt'}) do |faraday|
@@ -20,7 +16,8 @@ module Trellish
           req.headers['Authorization'] = "token #{Trellish.config[:github_oauth_token]}"
           req.body = {
             title: @card.name,
-            base: Trellish.config[:git_base_branch],
+            body: "[Trello card](#{@card.url})",
+            base: git_base_branch,
             head: "#{git_repository_owner}:#{current_git_branch}"
           }.to_json
         end
@@ -43,8 +40,65 @@ module Trellish
       @git_repository_owner ||= matches[1]
     end
 
+    def git_create_local_branch(branch_name)
+      `git checkout -b #{branch_name} #{git_base_branch}`
+    rescue
+      Trellish.logger.warn "Failed to create a local git branch named #{branch_name}."
+    end
+
+    def current_git_branch_is_up_to_date?
+      git_remote_up_to_date?(current_git_branch)
+    end
+
+    def git_user_initials
+      return @user_initials if @user_initials
+      username = presence(`git config github.user`) || presence(`git config user.email`) || presence(`whoami`)
+      @user_initials = username[0..2]
+    end
+
+    private
+
+    def current_git_branch
+      @current_git_branch ||= `cat #{git_dir}/head`.split('/').last.strip
+    end
+
+    def git_base_branch
+      Trellish.config[:git_base_branch]
+    end
+
+    def git_dir
+      return @git_dir if @git_dir
+      path = `git rev-parse --git-dir`.strip
+      if path[/^fatal/]
+        Trellish.logger.error "Failed to find your git repository."
+        exit
+      end
+      @git_dir = path
+    end
+
+    def git_hash_for_ref(ref)
+      `git show-ref --hash #{ref}`.strip
+    end
+
+    def git_remote_up_to_date?(local_branch_name)
+      remote_branch_name = git_remote_branch_for_local_branch(local_branch_name)
+
+      local_hash = git_hash_for_ref("heads/#{local_branch_name}")
+      remote_hash = git_hash_for_ref("remotes/#{remote_branch_name}")
+
+      local_hash == remote_hash
+    end
+
+    def git_remote_branch_for_local_branch(local_branch_name)
+      `git for-each-ref --format='%(upstream:short)' refs/heads/#{local_branch_name}`.strip
+    end
+
     def matches
-      @matches ||= matches = remote_url.match(%r|^git@github.com:([^/]*)\/([^\.]*)\.git$|)
+      @matches ||= remote_url.match(%r|^git@github.com:([^/]*)\/([^\.]*)\.git$|)
+    end
+
+    def presence(s)
+      s.strip if s && !s.strip.empty?
     end
 
     def remote_url

data/lib/trellish/version.rb

@@ -1,3 +1,3 @@
 module Trellish
-  VERSION = "0.0.15"
+  VERSION = "0.0.18"
 end

data/trellish.example.yml

@@ -18,5 +18,15 @@ github_oauth_token: numbers_and_letters_and_stuff
 # The branch you want your changes merged into
 git_base_branch: master
 
-# Name of your QA list in Trello
+# Name of your Trello board
+board_name: Current
+
+# Names of your Next up, In progress, and QA lists in Trello
+next_up_list_name: Next up
+in_progress_list_name: In progress
 qa_list_name: QA
+
+# Campfire subdomain, room & your token
+campfire_subdomain: subdomain
+campfire_token: 1111111111111111111111111111111111111111
+campfire_room: Development

data/trellish.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'oauth2', '>=0.7.0'
   gem.add_dependency 'ruby-trello-wgibbs', '>=0.4.4'
+  gem.add_dependency 'tinder', '>=1.9.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trellish
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: tinder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.1
 description: Create a pull request, put link to it on the card, remove everyone and
   move the card to the QA list
 email:
@@ -61,6 +77,7 @@ files:
 - bin/trellish
 - lib/trellish.rb
 - lib/trellish/auth.rb
+- lib/trellish/campfire.rb
 - lib/trellish/card.rb
 - lib/trellish/git.rb
 - lib/trellish/version.rb