Add obtain-work command

The command replaces the existing `pull` command. In addition to existing
logic, it allows
- checkouting of remote branches
- using pattern matching for branches allocation

`43` error code is introduced to handle logical constraints.

#10

docs/commands.md

@@ -150,8 +150,23 @@ git branch --delete --force __eg
 git push origin --delete <remote-branch-name>
 ```
 
-# `pull`
-Downloads new updates for a local branch.
+# `obtain-work`
+Checkouts a local or remote branch matching against a pattern. It looks for local branches first, then for remotes ones.
+If there are more then 1 matching branch, execution stops with a corresponding error message.
+
+```bash
+usage: git elegant obtain-work <pattern>
+```
+
+A sequence of original `git` commands:
+```bash
+# if a local branch matches a pattern
+git checkout <branch name>
+git pull
+# if no local matches, seek through remotes
+git fetch --all
+git checkout <branch name>
+```
 
 # `clear-local`
 Removes all local branches which don't have remote tracking branches.

docs/index.md

@@ -25,5 +25,6 @@ it may face its own errors and raises them as
 
 - `0` - a successful execution
 - `42` - a philosophical constraint
+- `43` - a logical constraint
 - `45` - a required parameter is empty
 - `46` - an unknown command

libexec/git-elegant-clear-local

@@ -2,7 +2,7 @@
 set -e
 
 default() {
-    git elegant pull $MASTER
+    git elegant obtain-work ${MASTER}
     local cmd="git branch -lvv | grep gone | awk {'print \$1'}"
     __loop "git branch -d" $(eval "$cmd") || \
         (

libexec/git-elegant-commands

@@ -9,7 +9,7 @@ default() {
     echo "save-work"
     echo "deliver-work"
     echo "accept-work"
-    echo "pull"
+    echo "obtain-work"
     echo "clear-local"
     echo "commands"
 }

libexec/git-elegant-obtain-work

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+set -e
+
+--up-to-one-branch(){
+    local BRANCHES=(${@})
+    if [[ ${#BRANCHES[@]} > 1 ]]; then
+        echo "The following branches are found:"
+        for branch in ${BRANCHES[@]}; do
+            echo " - ${branch}"
+        done
+        box "Please re-run the command with concrete branch name from the list above!"
+        exit 43
+    fi
+}
+
+default() {
+    local PATTERN=${1}
+    _error-if-empty "${PATTERN}" "Please provide a branch name or its part."
+    local LOCAL_BRANCHES=($(git for-each-ref --format='%(refname:strip=2)' refs/heads/* | grep "${PATTERN}"))
+    --up-to-one-branch ${LOCAL_BRANCHES[@]}
+    if [[ ${#LOCAL_BRANCHES[@]} = 1 ]]; then
+        boxtee git checkout ${LOCAL_BRANCHES[0]}
+        boxtee git pull
+    else
+        boxtee git fetch --all
+        local REMOTE_BRANCHES=($(git for-each-ref --format='%(refname:strip=3)' refs/remotes/** | grep "${PATTERN}"))
+        --up-to-one-branch ${REMOTE_BRANCHES[@]}
+        if [[ ${#REMOTE_BRANCHES[@]} = 1 ]]; then
+            boxtee git checkout ${REMOTE_BRANCHES[0]}
+        else
+            box "There are no either remove or local branches which match '${PATTERN}' pattern."
+            exit 43
+        fi
+    fi
+}

libexec/git-elegant-start-work

@@ -4,7 +4,7 @@ set -e
 default() {
     _error-if-empty "$1" "Please give a name for the new branch."
     status=$(boxtee git stash save elegant-git)
-    git elegant pull $MASTER
+    git elegant obtain-work ${MASTER}
     boxtee git checkout -b "$1"
 
     if [[ "$status" =~ "Saved working directory" ]]; then

tests/git-elegant-clear-local.bats

@@ -6,7 +6,7 @@ load addons-fake
 
 setup() {
     fake-pass git "branch -lvv" "first [gone]"
-    fake-pass git "elegant pull master"
+    fake-pass git "elegant obtain-work master"
     fake-pass git "branch -d first"
 }
 

tests/git-elegant-commands.bats

@@ -16,7 +16,7 @@ teardown() {
         "save-work"
         "deliver-work"
         "accept-work"
-        "pull"
+        "obtain-work"
         "clear-local"
         "commands"
     )

tests/git-elegant-obtain-work.bats

@@ -0,0 +1,61 @@
+#!/usr/bin/env bats
+
+load addons-common
+load addons-fake
+
+teardown() {
+    clean-fake
+}
+
+@test "'obtain-work': raise 45 error if branch name pattern in not set" {
+    check git-elegant obtain-work
+    [[ "$status" -eq 45 ]]
+    [[ "${lines[@]}" =~ "Please provide a branch name or its part." ]]
+}
+
+@test "'obtain-work': use found local branch when given pattern matches only one local branch" {
+    fake-pass git "for-each-ref --format='%(refname:strip=2)' refs/heads/*" "master\nfoo"
+    fake-pass git "checkout foo"
+    fake-pass git pull
+
+    check git-elegant obtain-work fo
+    [[ "$status" -eq 0 ]]
+}
+
+@test "'obtain-work': raise 43 error when given pattern matches several local branches" {
+    fake-pass git "for-each-ref --format='%(refname:strip=2)' refs/heads/*" "master\nfoo\nfo2\nfo3"
+
+    check git-elegant obtain-work fo
+    [[ "$status" -eq 43 ]]
+    [[ "${lines[@]}" =~ "Please re-run the command with concrete branch name from the list above!" ]]
+}
+
+@test "'obtain-work': use found remote branch when given pattern matches only one remote branch" {
+    fake-pass git "for-each-ref --format='%(refname:strip=2)' refs/heads/*"
+    fake-pass git "fetch --all"
+    fake-pass git "for-each-ref --format='%(refname:strip=3)' refs/remotes/**" "rremote\nmaster"
+    fake-pass git "checkout rremote"
+
+    check git-elegant obtain-work rr
+    [[ "$status" -eq 0 ]]
+}
+
+@test "'obtain-work': raise 43 error when given pattern matches several remote branches" {
+    fake-pass git "for-each-ref --format='%(refname:strip=2)' refs/heads/*"
+    fake-pass git "fetch --all"
+    fake-pass git "for-each-ref --format='%(refname:strip=3)' refs/remotes/**" "rremote\nmaster\nbarr"
+
+    check git-elegant obtain-work rr
+    [[ "$status" -eq 43 ]]
+    [[ "${lines[@]}" =~ "Please re-run the command with concrete branch name from the list above!" ]]
+}
+
+@test "'obtain-work': raise 43 error when given pattern matches zero remote branches" {
+    fake-pass git "for-each-ref --format='%(refname:strip=2)' refs/heads/*"
+    fake-pass git "fetch --all"
+    fake-pass git "for-each-ref --format='%(refname:strip=3)' refs/remotes/**" "rremote\nmaster\nbarr"
+
+    check git-elegant obtain-work aa
+    [[ "$status" -eq 43 ]]
+    [[ "${lines[@]}" =~ "There are no either remove or local branches which match 'aa' pattern." ]]
+}

tests/git-elegant-start-work.bats

@@ -4,7 +4,7 @@ load addons-common
 load addons-fake
 
 setup() {
-    fake-pass git "elegant pull master"
+    fake-pass git "elegant obtain-work master"
     fake-pass git "checkout -b test-feature"
     fake-pass git "stash save elegant-git"
 }