Merge branch 'develop' into stdout-segment

Author: Buck Ryan

CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changes
 
+2018-04-22 (version 0.5.4)
+
+* Reverted fix for
+  ([#249](https://github.com/b-ryan/powerline-shell/issues/249)) because it
+  caused issues on Mac.
+
+2018-04-21 (version 0.5.3)
+
+* New theme! (gruvbox)
+  ([@monicaycli](https://github.com/b-ryan/powerline-shell/pull/388))
+
+2018-04-21 (version 0.5.2)
+
+* Fix hostname colorize bug
+  ([@comagnaw](https://github.com/b-ryan/powerline-shell/issues/353))
+* Fix issue with prompt bleeding behavior
+  ([@bytebeast](https://github.com/b-ryan/powerline-shell/issues/249))
+* Better error message when config file cannot be decoded (Closes
+  [#371](https://github.com/b-ryan/powerline-shell/issues/371))
+
+2018-04-13 (version 0.5.1)
+
+* Fix Python 3 compatibility of `git_stash` segment
+
+2018-04-10 (version 0.5.0)
+
+* Patch environment for VCS subprocesses rather than generating a new one
+* Fix `cwd` segment so it respects `max_depth` configuration
+* Fix Ruby segment for Python 3 compatibility
+  ([@Blue-Dog-Archolite](https://github.com/b-ryan/powerline-shell/pull/366))
+* Configuration is now expected to be at
+  `~/.config/powerline-shell/config.json` ([@emansije and
+  @kc9jud](https://github.com/b-ryan/powerline-shell/pull/334))
+* New `git_stash` segment
+  ([@apinkney97](https://github.com/b-ryan/powerline-shell/pull/379))
+
+2018-02-19 (version 0.4.9)
+
+* Fix root user segment
+  ([@TiGR](https://github.com/b-ryan/powerline-shell/pull/362))
+* Fixes and enhancements for SVN segment
+  ([@emansije](https://github.com/b-ryan/powerline-shell/pull/349))
+
 2018-01-29 (version 0.4.8)
 
 * Bring back the ability to create custom themes

README.md

@@ -1,16 +1,19 @@
 # A Powerline style prompt for your shell
 
-A [Powerline](https://github.com/Lokaltog/vim-powerline) like prompt for Bash,
-ZSH, Fish, and tcsh:
+A beautiful and useful prompt generator for Bash, ZSH, Fish, and tcsh:
 
-![MacVim+Solarized+Powerline+CtrlP](https://raw.github.com/banga/powerline-shell/master/bash-powerline-screenshot.png)
+![MacVim+Solarized+Powerline+CtrlP](https://raw.github.com/b-ryan/powerline-shell/master/bash-powerline-screenshot.png)
 
 - Shows some important details about the git/svn/hg/fossil branch (see below)
 - Changes color if the last command exited with a failure code
 - If you're too deep into a directory tree, shortens the displayed path with an ellipsis
 - Shows the current Python [virtualenv](http://www.virtualenv.org/) environment
 - It's easy to customize and extend. See below for details.
 
+The generated prompts are designed to resemble
+[powerline](https://github.com/powerline/powerline), but otherwise this project
+has no relation to powerline.
+
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
@@ -50,7 +53,7 @@ following symbols:
 - `✎` -- a file has been modified (but not staged for commit, in git)
 - `✔` -- a file is staged for commit (git) or added for tracking
 - `✼` -- a file has conflicts
-- `❓` -- a file is untracked
+- `?` -- a file is untracked
 
 Each of these will have a number next to it if more than one file matches.
 
@@ -63,7 +66,7 @@ with an option `show_symbol` set to `true` (see
 
 This script uses ANSI color codes to display colors in a terminal. These are
 notoriously non-portable, so may not work for you out of the box, but try
-setting your $TERM to `xterm-256color`, because that works for me.
+setting your $TERM to `xterm-256color`.
 
 - Patch the font you use for your terminal: see
   [powerline-fonts](https://github.com/Lokaltog/powerline-fonts)
@@ -88,7 +91,7 @@ install for just your user, if you'd like. But you may need to fiddle with your
 - Or, install from the git repository:
 
 ```
-git clone https://github.com/banga/powerline-shell
+git clone https://github.com/b-ryan/powerline-shell
 cd powerline-shell
 python setup.py install
 ```
@@ -155,14 +158,14 @@ alias precmd 'set prompt="`powerline-shell --shell tcsh $?`"'
 ### Config File
 
 Powerline-shell is customizable through the use of a config file. This file is
-expected to be located at `~/.powerline-shell.json`. You can generate the
-default config at this location using:
+expected to be located at `~/.config/powerline-shell/config.json`. You can
+generate the default config at this location using:
 
 ```
 powerline-shell --generate-config > ~/.powerline-shell.json
 ```
 
-(You can see an example config file
+(As an example, my config file is located here:
 [here](https://github.com/b-ryan/dotfiles/blob/master/home/powerline-shell.json))
 
 ### Adding, Removing and Re-arranging segments
@@ -184,6 +187,7 @@ are:
 - `env` - See [Generic Segments](#generic-segments)
 - `fossil` - Details about the current Fossil repo.
 - `git` - Details about the current Git repo.
+- `git_stash` - Number of stashes in the current Git repo.
 - `hg` - Details about the current Mercurial repo.
 - `hostname` - Current machine's hostname.
 - `jobs` - Number of background jobs currently running.
@@ -337,6 +341,6 @@ requirements in `requirements-dev.txt`.
 
 ## Troubleshooting
 
-See the [FAQ](https://github.com/banga/powerline-shell/wiki/FAQ). If you
+See the [FAQ](https://github.com/b-ryan/powerline-shell/wiki/FAQ). If you
 continue to have issues, please open an
-[issue](https://github.com/banga/powerline-shell/issues/new).
+[issue](https://github.com/b-ryan/powerline-shell/issues/new).

powerline_shell/__init__.py

@@ -114,7 +114,9 @@ def fgcolor(self, code):
     def bgcolor(self, code):
         return self.color('48', code)
 
-    def append(self, content, fg, bg, separator=None, separator_fg=None):
+    def append(self, content, fg, bg, separator=None, separator_fg=None, sanitize=True):
+        if self.args.shell == "bash" and sanitize:
+            content = re.sub(r"([`$])", r"\\\1", content)
         self.segments.append((content, fg, bg,
             separator if separator is not None else self.separator,
             separator_fg if separator_fg is not None else bg))
@@ -129,16 +131,12 @@ def draw(self):
 
     def draw_segment(self, idx):
         segment = self.segments[idx]
-        if self.args.shell == "bash":
-            sanitized = re.sub(r"([`$])", r"\\\1", segment[0])
-        else:
-            sanitized = segment[0]
         next_segment = self.segments[idx + 1] if idx < len(self.segments)-1 else None
 
         return ''.join((
             self.fgcolor(segment[1]),
             self.bgcolor(segment[2]),
-            sanitized,
+            segment[0],
             self.bgcolor(next_segment[2]) if next_segment else self.reset,
             self.fgcolor(segment[4]),
             segment[3]))
@@ -148,6 +146,7 @@ def find_config():
     for location in [
         "powerline-shell.json",
         "~/.powerline-shell.json",
+        os.path.join(os.environ.get("XDG_CONFIG_HOME", "~/.config"), "powerline-shell", "config.json"),
     ]:
         full = os.path.expanduser(location)
         if os.path.exists(full):
@@ -203,7 +202,12 @@ def main():
     config_path = find_config()
     if config_path:
         with open(config_path) as f:
-            config = json.loads(f.read())
+            try:
+                config = json.loads(f.read())
+            except Exception as e:
+                warn("Config file ({0}) could not be decoded! Error: {1}"
+                     .format(config_path, e))
+                config = DEFAULT_CONFIG
     else:
         config = DEFAULT_CONFIG
 

powerline_shell/color_compliment.py

@@ -10,6 +10,7 @@
 
 
 def getOppositeColor(r,g,b):
+    r, g, b = [x/255.0 for x in [r, g, b]] # convert to float before getting hls value
     hls = rgb_to_hls(r,g,b)
     opp = list(hls[:])
     opp[0] = (opp[0]+0.2)%1 # shift hue (a.k.a. color)

powerline_shell/segments/bzr.py

@@ -1,23 +1,11 @@
-import os
 import subprocess
-from ..utils import RepoStats, ThreadedSegment
-
-
-def get_PATH():
-    """Normally gets the PATH from the OS. This function exists to enable
-    easily mocking the PATH in tests.
-    """
-    return os.getenv("PATH")
-
-
-def bzr_subprocess_env():
-    return {"PATH": get_PATH()}
+from ..utils import RepoStats, ThreadedSegment, get_subprocess_env
 
 
 def _get_bzr_branch():
     p = subprocess.Popen(['bzr', 'nick'],
                          stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-                         env=bzr_subprocess_env())
+                         env=get_subprocess_env())
     branch = p.communicate()[0].decode("utf-8").rstrip('\n')
     return branch
 
@@ -47,7 +35,7 @@ def build_stats():
     try:
         p = subprocess.Popen(['bzr', 'status'],
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-                             env=bzr_subprocess_env())
+                             env=get_subprocess_env())
     except OSError:
         # Popen will throw an OSError if bzr is not found
         return (None, None)

powerline_shell/segments/cwd.py

@@ -58,10 +58,6 @@ def add_cwd_segment(powerline):
         cwd = cwd.decode("utf-8")
     cwd = replace_home_dir(cwd)
 
-    if powerline.segment_conf("cwd", "mode") == 'plain':
-        powerline.append(' %s ' % (cwd,), powerline.theme.CWD_FG, powerline.theme.PATH_BG)
-        return
-
     names = split_path_into_names(cwd)
 
     full_cwd = powerline.segment_conf("cwd", "full_cwd", False)
@@ -84,6 +80,12 @@ def add_cwd_segment(powerline):
         # displayed, so chop everything else off
         names = names[-1:]
 
+    elif powerline.segment_conf("cwd", "mode") == "plain":
+        joined = os.path.sep.join(names)
+        powerline.append(" %s " % (joined,), powerline.theme.CWD_FG,
+                         powerline.theme.PATH_BG)
+        return
+
     for i, name in enumerate(names):
         is_last_dir = (i == len(names) - 1)
         fg, bg = get_fg_bg(powerline, name, is_last_dir)

powerline_shell/segments/fossil.py

@@ -1,17 +1,6 @@
 import os
 import subprocess
-from ..utils import RepoStats, ThreadedSegment
-
-
-def get_PATH():
-    """Normally gets the PATH from the OS. This function exists to enable
-    easily mocking the PATH in tests.
-    """
-    return os.getenv("PATH")
-
-
-def fossil_subprocess_env():
-    return {"PATH": get_PATH()}
+from ..utils import RepoStats, ThreadedSegment, get_subprocess_env
 
 
 def _get_fossil_branch():
@@ -49,7 +38,7 @@ def build_stats():
     try:
         subprocess.Popen(['fossil'], stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE,
-                         env=fossil_subprocess_env()).communicate()
+                         env=get_subprocess_env()).communicate()
     except OSError:
         # Popen will throw an OSError if fossil is not found
         return (None, None)

powerline_shell/segments/git.py

@@ -1,28 +1,6 @@
 import re
 import subprocess
-import os
-from ..utils import RepoStats, ThreadedSegment
-
-
-def get_PATH():
-    """Normally gets the PATH from the OS. This function exists to enable
-    easily mocking the PATH in tests.
-    """
-    return os.getenv("PATH")
-
-
-def git_subprocess_env():
-    return {
-        # LANG is specified to ensure git always uses a language we are expecting.
-        # Otherwise we may be unable to parse the output.
-        "LANG": "C",
-
-        # https://github.com/milkbikis/powerline-shell/pull/126
-        "HOME": os.getenv("HOME"),
-
-        # https://github.com/milkbikis/powerline-shell/pull/153
-        "PATH": get_PATH(),
-    }
+from ..utils import RepoStats, ThreadedSegment, get_git_subprocess_env
 
 
 def parse_git_branch_info(status):
@@ -33,7 +11,7 @@ def parse_git_branch_info(status):
 def _get_git_detached_branch():
     p = subprocess.Popen(['git', 'describe', '--tags', '--always'],
                          stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-                         env=git_subprocess_env())
+                         env=get_git_subprocess_env())
     detached_ref = p.communicate()[0].decode("utf-8").rstrip('\n')
     if p.returncode == 0:
         branch = u'{} {}'.format(RepoStats.symbols['detached'], detached_ref)
@@ -63,7 +41,7 @@ def build_stats():
     try:
         p = subprocess.Popen(['git', 'status', '--porcelain', '-b'],
                              stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-                             env=git_subprocess_env())
+                             env=get_git_subprocess_env())
     except OSError:
         # Popen will throw an OSError if git is not found
         return (None, None)

powerline_shell/segments/git_stash.py

@@ -0,0 +1,34 @@
+import subprocess
+from ..utils import RepoStats, ThreadedSegment, get_git_subprocess_env
+
+
+def get_stash_count():
+    try:
+        p = subprocess.Popen(['git', 'stash', 'list'],
+                             stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+                             env=get_git_subprocess_env())
+    except OSError:
+        return 0
+
+    pdata = p.communicate()
+    if p.returncode != 0:
+        return 0
+
+    return pdata[0].count(b'\n')
+
+
+class Segment(ThreadedSegment):
+    def run(self):
+        self.stash_count = get_stash_count()
+
+    def add_to_powerline(self):
+        self.join()
+        if not self.stash_count:
+            return
+
+        bg = self.powerline.theme.GIT_STASH_BG
+        fg = self.powerline.theme.GIT_STASH_FG
+
+        sc = self.stash_count if self.stash_count > 1 else ''
+        stash_str = u' {}{} '.format(sc, RepoStats.symbols['stash'])
+        self.powerline.append(stash_str, fg, bg)

powerline_shell/segments/hg.py

@@ -1,24 +1,12 @@
-import os
 import subprocess
-from ..utils import RepoStats, ThreadedSegment
-
-
-def get_PATH():
-    """Normally gets the PATH from the OS. This function exists to enable
-    easily mocking the PATH in tests.
-    """
-    return os.getenv("PATH")
-
-
-def hg_subprocess_env():
-    return {"PATH": get_PATH()}
+from ..utils import RepoStats, ThreadedSegment, get_subprocess_env
 
 
 def _get_hg_branch():
     p = subprocess.Popen(["hg", "branch"],
                          stdout=subprocess.PIPE,
                          stderr=subprocess.PIPE,
-                         env=hg_subprocess_env())
+                         env=get_subprocess_env())
     branch = p.communicate()[0].decode("utf-8").rstrip('\n')
     return branch
 
@@ -46,7 +34,7 @@ def build_stats():
         p = subprocess.Popen(["hg", "status"],
                              stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE,
-                             env=hg_subprocess_env())
+                             env=get_subprocess_env())
     except OSError:
         # Will be thrown if hg cannot be found
         return None, None