ppl 3.0.0 → 4.0.3

data/gh-pages/_posts/2013-03-16-1.15.0.md

@@ -0,0 +1,28 @@
+---
+title: 1.15.0
+summary: Color output added
+date: 2013-03-16
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.15.0.html
+---
+
+This adds support for colourised output to most ppl commands. The following
+commands are affected by this change:
+
+* [age](/documentation/configuration/color_age)
+* [bday](/documentation/configuration/color_bday)
+* [email](/documentation/configuration/color_email)
+* [ls](/documentation/configuration/color_ls)
+* [name](/documentation/configuration/color_name)
+* [nick](/documentation/configuration/color_nick)
+* [org](/documentation/configuration/color_org)
+* [phone](/documentation/configuration/color_phone)
+* [post](/documentation/configuration/color_post)
+* [url](/documentation/configuration/color_url)
+
+Internally, this release depends on two new gems:
+
+* [morphine](https://github.com/bkeepers/morphine)
+* [colored](https://github.com/defunkt/colored)

data/gh-pages/_posts/2013-03-16-coloured-output-released.md

@@ -0,0 +1,27 @@
+---
+title: Coloured Output Released
+date: 2013-03-16
+layout: news
+section: news
+categories: [news]
+---
+
+It's been about a month since the last release, but that's not because of any
+lack of internal activity. Today marks the release of support for git-style
+coloured output, configurable in `~/.pplconfig`.
+
+This has taken a while to achieve just because I wanted to take my time over it
+and try to really get it right the first time. Some refactoring was necessary in
+order to get config data into the code responsible for formatting output, but
+hopefully the resulting usage of the
+[morphine](https://github.com/bkeepers/morphine) dependency injection container
+should reduce such code churn in future.
+
+In other news, the [UTF-8 bug](https://github.com/hnrysmth/ppl/issues/17) mentioned
+in [last month's update](/news/two-months-in/) should be gone soon. I've spoken
+to the maintainer of vpim about it, and [his
+response](http://rubyforge.org/pipermail/vpim-talk/2013/000185.html) was
+positive. Apparently vpim just doesn't quite support Ruby 1.9.1's String class
+yet, but will do soon.
+
+

data/gh-pages/_posts/2013-04-10-ruby-2.0-compatibility.md

@@ -0,0 +1,28 @@
+---
+title: Ruby 2.0 Compatibility
+date: 2013-04-10
+layout: news
+section: news
+categories: [news]
+---
+
+The latest version of ppl is available now, and it's one of those tiny,
+pointless-sounding ones: `1.15.1`. This release is all about Ruby 2.0
+compatibility.  A recent issue reported on GitHub by
+[@pigmonkey](https://github.com/pigmonkey) brought to my attention that vpim,
+ppl's underlying vCard library, [doesn't work at all in Ruby
+2.0](https://github.com/hnrysmth/ppl/issues/19).
+
+    invalid multibyte escape: /^\xFF\xFE/
+
+This is all better now, and ppl works as well in Ruby 2.0 as it does in the
+1.9.\* range. This was a bit of a seismic change behind the scenes, and it
+almost seems misleading to increment only the patch version number.
+
+Essentially, I forked vpim in order to get this done. While this is an
+unexpected turn of events, it does mean I'm now quite well-placed to fix its
+UTF-8 issues myself instead of depending on the mercy of upstream. By the way,
+if you're interested in helping with this, go take a look at
+[greencard](https://github.com/hnrysmth/greencard). It's vpim stripped down to just
+the vCard functionality used by ppl. Go fork it!
+

data/gh-pages/_posts/2013-04-11-1.15.1.md

@@ -0,0 +1,13 @@
+---
+title: 1.15.1
+summary: Ruby 2.0 support
+date: 2013-04-11
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.15.1.html
+---
+
+Heralding support for Ruby 2.0 and beyond, this version of ppl also sees the
+replacement of the vpim gem dependency with greencard. See the [news
+post](/news/ruby-2.0-compatibility/) for more details.

data/gh-pages/_posts/2013-04-12-1.16.0.md

@@ -0,0 +1,22 @@
+---
+title: 1.16.0
+summary: Mutt integration tweaks
+date: 2013-04-12
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.16.0.html
+---
+
+With a couple of tweaks to the way ppl handles mutt queries, `1.16.0` should be
+a nice improvement for anybody using ppl to autocomplete email addresses in the
+mail client that "just sucks less".
+
+* Added missing functionality to the [mutt](/documentation/commands/mutt)
+  command enabling it to output *all* of a contact's matching email addresses
+  instead of just the first.
+* Added the `-i` flag to the [mutt](/documentation/commands/mutt) command
+  enabling it to perform case-insensitive search of the address book.
+
+Many thanks to [@pigmonkey](https://github.com/pigmonkey) on GitHub for the
+cooperation that made this release happen.

data/gh-pages/_posts/2013-04-14-1.17.0.md

@@ -0,0 +1,15 @@
+---
+title: 1.17.0
+summary: UTF-8 support
+date: 2013-04-14
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.17.0.html
+---
+
+This is a peculiar version in that it doesn't change any code in ppl itself, but
+simultaneously fixes a really major issue that's been affecting it. All this
+version does is to increment the greencard gem dependency version number to a
+version that copes with UTF-8 input. It's a *tiny* change, but it's a major
+improvement.

data/gh-pages/_posts/2013-04-14-1.17.1.md

@@ -0,0 +1,20 @@
+---
+title: 1.17.1
+summary: Mutt integration tweaks
+date: 2013-04-14
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.17.1.html
+---
+
+Two fairly minor issues are fixed in this version. The first is a tweak to the
+output of the [mutt](/documentation/commands/mutt) command, improving the
+[understandability and usefulness of the user-facing
+text](https://github.com/hnrysmth/ppl/issues/20#issuecomment-16302428). The second is
+a bit of output sanitisation to help out people unlucky enough to have an
+address book where some of the contacts' fields contain `^M` [carriage return
+characters](https://github.com/hnrysmth/ppl/issues/27).
+
+* Tweaked the output of the [mutt](/documentation/commands/mutt) command
+* Add output sanitisation removing all `^M` characters from all output

data/gh-pages/_posts/2013-04-14-1.17.2.md

@@ -0,0 +1,13 @@
+---
+title: 1.17.2
+summary: Fix for minor release bugs
+date: 2013-04-14
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.17.2.html
+---
+
+An embarrassing "quick follow-up" release, this unbreaks a couple of things that
+1.17.1 broke. Displaying the "Contact '%s' not found" message has been fixed, as
+has the command list help text displayed by `ppl` and `ppl help`.

data/gh-pages/_posts/2013-04-15-sync-alias.md

@@ -0,0 +1,31 @@
+---
+title: Sync Alias
+date: 2013-04-15
+layout: tip
+categories: [tips]
+permalink: /documentation/tips/sync-alias
+author_name: hnrysmth
+author_url: http://henrysmith.org/
+---
+
+If your ppl address book is cloned on multiple computers, you're probably
+accustomed to using [pull](/documentation/commands/pull/) and
+[push](/documentation/commands/pull/) to synchronise your data using Git. If so,
+that's great. You're making the most of ppl's core functionality. But you could
+probably be making more of its convenience-oriented features.
+
+ppl allows you to configure [aliases](/documentation/configuration/alias/) as
+shorcuts for often-used commands, or as a way of composing commands together.
+Here's an alias called `sync` which does the latter.
+
+    sync = !ppl pull origin master && ppl push origin master
+
+This allows you to execute `git pull origin master` and then `git push origin
+master` in your address book directory by simply entering `ppl sync`. For most
+users, this probably automates the entire synchronisation process.
+
+Bear in mind that this alias will only work if you keep your contacts on the
+`master` branch and have a remote called `origin`. If your setup is more complex
+than that, you may have to get creative with your aliases to achieve this level
+of laziness.
+

data/gh-pages/_posts/2013-04-15-utf8-fixed-and-more.md

@@ -0,0 +1,37 @@
+---
+title: UTF-8 Fixed And More
+date: 2013-04-15
+layout: news
+section: news
+categories: [news]
+---
+
+Over the weekend, in an uncharacteristically late night of coding, I finally put
+an end to that UTF-8 issue that had been preventing the [use of ppl with
+non-ASCII characters](https://github.com/hnrysmth/ppl/issues/17) such as ß or ñ. My
+apologies to anyone who wanted to try ppl and couldn't during the *two entire
+months* that issue sat open. If it's any consolation, fixing it gave me many
+headaches.
+
+Even though it's only been a few days since the previous news post, there has
+been a lot of progress in that time, thanks largely to the involvement and
+encouragement of [@pigmonkey](https://github.com/pigmonkey) and
+[@shushcat](https://github.com/shushcat) on GitHub. Some good refinements to the
+[mutt integration](/documentation/integration/mutt/) have already made it into
+recent versions of ppl, and there's some good discussion happening about what
+needs doing to keep improving ppl in the near future.
+
+The [documentation](/documentation) has had some much-needed attention invested
+in it, too. A few bits and pieces have been tidied up, and a couple of entirely
+new sections have been added as well. The [Integration
+Guide](/documentation/integration/bash/) covers the growing number of ways of
+using ppl with other software, and the [Tips Section](documentation/tips/)
+should prove to be a good catch-all place for helpful advice about using ppl.
+
+Contributions are welcome, so get in touch if you spot any mistakes, have any
+tips to contribute, or know of any tools for integrating ppl into other
+software. Big thanks to everyone for your input so far. Shout out to
+[@alexGschaider](https://github.com/axelGschaider),
+[@matthewp](https://github.com/matthewp/), and
+[@storge](https://github.com/storge) for their help as well.
+

data/gh-pages/_posts/2013-04-16-1.18.0.md

@@ -0,0 +1,15 @@
+---
+title: 1.18.0
+summary: ppl completion added
+date: 2013-04-16
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.18.0.html
+---
+
+With the intention of streamlining the integration process with
+[Bash](/documentation/integration/bash), and
+[ZSH](/documentation/integration/zsh), this release adds the
+[completion](/documentation/commands/completion) command. This new command
+simply outputs the chosen shell autocompletion function to stdout.

data/gh-pages/_posts/2013-04-16-set-up-color-output.md

@@ -0,0 +1,47 @@
+---
+title: Set Up Color Output
+date: 2013-04-16
+layout: tip
+categories: [tips]
+permalink: /documentation/tips/set-up-color-output
+author_name: hnrysmth
+author_url: http://henrysmith.org/
+---
+
+ppl provides a system for configuring the output of many of its commands in a
+way that's almost identical to git's color output configuration. While not an
+essential piece of functionality, a small amount of color can go a long way
+towards improving your experience using ppl.
+
+Personally, I try to rein in the temptation to go to town and assign a color to
+absolutely everything. My `~/.pplconfig` simply colorizes all contact IDs in all
+output, highlighting them in cyan to maximize their visibility.
+
+<pre><code>$ ppl ls</code>
+<code><span style="color: #2AA198;">alice:</span>  Alice  alice@example.org</code>
+<code><span style="color: #2AA198;">bob:</span>    Bob    bob@example.org</code>
+<code><span style="color: #2AA198;">eve:</span>    Eve    eve@example.org</code></pre>
+
+Configuring ppl to colorize the output of ls like in the above example is
+extremely easy, and will be especially familiar to you if you're already used to
+configuring git. Here are the exact config file contents necesssary to show
+contact IDs in cyan in the output of [ppl ls](/documentation/commands/ls).
+
+    [color]
+        ls = true
+
+    [color "ls"]
+        id = cyan
+
+Simply add the above to your `~/.pplconfig`, run `ppl ls`, and you should see
+contact IDs in cyan. If not, double-check whether you're running an up-to-date
+version of ppl. This feature has been supported since `1.15.0`, making it only
+about a month old at the time of writing.
+
+Now that you know the basic gist of how to configure color, you'll probably be
+glad to know that there's some fairly extensive [reference documentation for this
+functionality](/documentation/configuration/color), including a [list of
+supported colors](/documentation/configuration/color/#list_of_supported_colors)
+and an example for each command which shows the [full list of configurable text
+elements](/documentation/configuration/color_ls).
+

data/gh-pages/_posts/2013-04-19-1.19.0.md

@@ -0,0 +1,13 @@
+---
+title: 1.19.0
+summary: ppl scrape added
+date: 2013-04-19
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.19.0.html
+---
+
+Following a [feature request](https://github.com/hnrysmth/ppl/issues/23) on GitHub,
+this release adds the [scrape](/documentation/commands/scrape) command for
+automatically adding contacts to an address book from an email message.

data/gh-pages/_posts/2013-04-19-1.20.0.md

@@ -0,0 +1,15 @@
+---
+title: 1.20.0
+summary: ppl nick --no-color added
+date: 2013-04-19
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.20.0.html
+---
+
+In order to fix a [compatibility issue with OS
+X](https://github.com/hnrysmth/ppl/issues/22#issuecomment-16622923), the usage of sed
+to strip ANSI color escape codes in the autocompletion functions has been
+replaced with a `--no-color` option which has been added to [ppl
+nick](/documentation/commands/nick).

data/gh-pages/_posts/2013-04-20-1.21.0.md

@@ -0,0 +1,16 @@
+---
+title: 1.21.0
+summary: ppl phone --type added
+date: 2013-04-20
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.21.0.html
+---
+
+Further increasing the expressiveness of ppl's commands, this release brings the
+`--type` option to [ppl phone](/documentation/commands/phone). With this option,
+the vCard format's `TYPE` parameter in the `TEL` field is now exposed to users.
+This allows you to label phone numbers in a way that doesn't [break
+compatibility with other
+software](https://github.com/hnrysmth/ppl/issues/24#issuecomment-16623136).

data/gh-pages/_posts/2013-04-20-1.22.0.md

@@ -0,0 +1,14 @@
+---
+title: 1.22.0
+summary: Noticeable performance optimization
+date: 2013-04-20
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.22.0.html
+---
+
+In this version of ppl, one particularly egregious performance issue has been
+fixed. Upgrading is *highly* recommended. Even if you haven't noticed any
+problems worth complaining about, you should hopefully enjoy quite a boost with
+this new version.

data/gh-pages/_posts/2013-04-20-1.22.1.md

@@ -0,0 +1,13 @@
+---
+title: 1.22.1
+summary: Fix minor output formatting bug
+date: 2013-04-20
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.22.1.html
+---
+
+This version simply fixes a minor bug in the outputting format code, which was
+introduced in `1.21.0`. Nothing serious, but a warning sign that I need to slow
+myself down and perhaps look at automating more of the testing process.

data/gh-pages/_posts/2013-04-21-1.22.2.md

@@ -0,0 +1,15 @@
+---
+title: 1.22.2
+summary: Fix for broken --delete option
+date: 2013-04-21
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.22.2.html
+---
+
+See the [Bash integration guide](/documentation/integration/bash) for details of
+how to install the updated completion function to your system.  Another bugfix
+release, fixing the [broken `--delete`
+option](https://github.com/hnrysmth/ppl/issues/33) of [`ppl
+phone`](/documentation/commands/phone).

data/gh-pages/_posts/2013-04-21-1.23.0.md

@@ -0,0 +1,35 @@
+---
+title: 1.23.0
+summary: Bash completion enhancements
+date: 2013-04-21
+layout: changelog
+section: development
+categories: [changelog]
+permalink: /development/changelog/1.23.0.html
+---
+
+Unusually for a ppl release, this one doesn't add any new core functionality or
+fix any bugs. Instead, this release is solely an update to the [Bash
+integration](/documentation/integration/bash/). The following improvements have
+been made to the bash completion.
+
+* It now returns command name suggestions much more quickly
+* It can autocomplete email addresses for use with [`ppl
+  email`](/documentation/commands/email)
+* It can autocomplete nicknames for use with [`ppl
+  nick`](/documentation/commands/nick)
+* It can autocomplete organizations for use with [`ppl
+  org`](/documentation/commands/org)
+* It can autocomplete phone numbers for use with [`ppl
+  phone`](/documentation/commands/phone)
+* It can autocomplete URLs for use with [`ppl url`](/documentation/commands/url)
+* It can autocomplete git remotes for use with
+  [`pull`](/documentation/commands/pull) and
+  [`push`](/documentation/commands/push)
+
+For example, if you're attempting to amend the `--type` of a contact's phone
+number, you can now enter `ppl phone adam 071<Tab>` and Bash will autocomplete
+the rest of the phone number.
+
+See the [Bash integration guide](/documentation/integration/bash) for details of
+how to install the updated completion function to your system.