Tuesday, December 30, 2014

Productivity Tools

There are several tools that I use daily to help improve my productivity not only as a developer, but also as a regular computer user. I think it is important to share these types of tools, interesting tidbits, or libraries on a weekly basis because there are just so many new things being created all the time.

For example, I went to a few Ruby on Rails meetups and the first item on the agenda was always "Sharing of Tools and Tips"; here people would share new Ruby gems they had discovered or even share their experiences in solving a recent problem. Another great example is the Ruby Rogues Podcast where after every show, each speaker has picks that they share with the group; these picks aren't always technical, but it's a great way to be cognizant of what is out there. At my current job, we have tech talks every Thursday, but before we start, I reserve 10-15 minutes for sharing of tools and tips or just anything that people found interesting for the week. Usually atleast one thing of interest comes from it, and I think just that makes the entire exercise worth it.

Here are my picks:

1. BetterSnapTool

Ever need to compare two windows side by side, but find it a pain to resize and arrange them all the time? BetterSnapTool makes this simple, and can snap windows to any side you want with just a keyboard shortcut. You can also define custom hotspots where if you drag a window to it, it will resize that window to a custom size that you previously specified. This is a paid tool, but I know that there are probably similar tools that are free.

2. Alfred

Alfred allows you to do a lot of things from your fingertips. With a keyboard shortcut, it launches a spotlight like prompt that lets you search for files, launch applications, and even do arithmetic. I have to admit, I have been using this a lot less lately because the new spotlight in Mac OS X Yosemite is quite good. But I use to use this to launch all my development apps after logging in. You can also launch gmail straight from the prompt. I haven't explored this yet, but there is a PowerPack that you can purchase that allows you to define custom workflows. For example, I could define a development workflow, and it would allow me to launch all of my developer applications with one keyboard shortcut.

I've built a lot of bad habits when using computers since I was young; I use to sit at the computer for 8-12+ hours straight and not take breaks. This has caused me a lot of eye and hand problems as I grew older, and I learned that it is REALLY important to take regular breaks from the computer. This tool helps remind me to take 10 second breaks, every 20 minutes, and 10 minute breaks every 60 minutes. This is all customizable as well. An important exercise I learned from my optometrist is the 20/20 rule, which is every 20 minutes, take a 20 second break and look at something atleast 20 feet away.

A little more heavy weight than the default Notes app, but I like it because I can type up notes for a presentation on my laptop, and then access these same notes on my phone during the presentation. You can also categorize your notes in to notebooks, which has been useful because I create a lot of notes.

4. zsh and the oh-my-zsh plugin

I've mostly just used bash shell since it is the default on Mac OS X, but I recently decided to try zsh because I've heard a lot about it. There are a few nice features in zsh that bash doesn't have, but I wouldn't say anything ground breaking. To list a few:
  • Inline glob expansion: For example, type rm *.pdf and then hit tab.
  • Interactive path expansion: Type cd /u/l/b and hit tab.
  • Customizable prompt configuration options.
What I enjoy the most is what the oh-my-zsh plugin offers. The plugin basically offers a nice way to manage your zsh configuration, but it comes a ton of built in plugins and themes. I mainly just use a theme and a git plugin (which can probably be done in bash too with aliases), but it is still definitely worth checking out. I am sure that I am only scratching the surface. Here is my zsh config if you would like to take a look.

5. Animated Tabs for Chrome

Lastly, I wanted to show an anti-productivity tool that I use quite often in Chrome. Usually I'll want to search for something, so I'll open a new Chrome tab and then I'll see some funny animated gif and then forget what I was doing and even what I was searching for. Although this interrupts my productivity during the day, sometimes it is nice to take a little break and laugh :).

Here are a few other tools that have been recommended to me by colleagues, but I just haven't had a chance to check them out yet:
  • Fluid App
  • Caffeine - Prevent computer from going in to screensaver or turning the display off on battery. This is useful for Skype calls or meetings where you're watching someone else's screen but not interacting with your computer.
  • Dash - For local copies of documentation for various platforms and libraries. Its nice having a local and searchable copy.
  • LastPass - For account management
  • Pauses - An alternative to Timeout
  • Flycut - Clipboard manager
  • Filedart - Speedy file sharing

Saturday, November 15, 2014

Git Merge Workflow on Github

How to Merge Code

Below is a guide that I wrote for a recent project explaining a git merge workflow on Github. Often times, when you develop a new feature, you will create a new branch off of master called a feature branch. On the feature branch, you might have many commits to save your progress, or when you complete certain milestones of that feature. Once you finish the feature, you will want to merge this branch back to the master branch. However, you might not want all your commits to show up in the git log history because they were only for development purposes. We can overcome this issue by using a feature of git called interactive rebasing which allows you to squash certain commits and customize the commits that will eventually show up once the branch is merged to master. I have described the steps to achieve this outcome below.

Table of Contents


This guide explains how to develop and commit your code using git and GitHub. A developer should create a feature branch when developing new code. In the feature branch, a developer may commit multiple times during development including making changes based on comments from a code review. When development is completed and the feature branch is ready to be merged in to the master branch, the developer should squash the commits in to one, so that the git log history is kept clean.

Detailed Steps

1. On the `master` branch, `git pull` to make sure your code is up to date.

2. Create a feature branch `git checkout -b name-of-feature-branch`. Note, you will automatically be switched to this new feature branch you are creating.

3. Write code and develop your feature.

4. `git commit` your code. Note, this step may be performed as many times as you prefer during development in order to maintain a history of your code changes.

5. Once development is completed (and all your code is committed), we should make sure that our code is up to date with the latest `master` branch. On your feature branch, `git rebase master` will ensure that your branch is up to date and your code is compatible with the latest `master`. Also this step ensures that your commits are at the top, which is critical for the next steps. Note that, during the rebase, you may encounter merge conflicts that will need to be resolved.

6. Now we need to push our code to GitHub. `git push origin name-of-feature-branch` (while on the name-of-feature-branch branch) to push the branch to GitHub.

7. In GitHub, create a pull request for the name-of-feature-branch branch and assign someone to review your code.

8. If the reviewer makes comments or suggestions, please address them by asking for clarification and/or committing the changes. The reviewer also needs to give approval on whether or not the code is ready to be merged.

9. Once the code is ready to be merged, it is time to squash your commits. Note, this doesn't apply if you only have one commit to merge, and in that case you can just merge your pull request on GitHub. First we need to know at what point your branch and master diverge. This is required as you only want to squash your commits.

10. To do this run `git merge-base master `. This command should spit out a commit hash such as _918310dca623fac2d46198324814695c4726017e_. You will then use this hash to tell git "_squash the commits from this point on_".

11. Once you have your merge base commit run `git rebase -i `, for example: `git rebase -i 918310dca623fac2d46198324814695c4726017e`.

12. Your text editor should popup and you should see your commits with the word `pick` in front of them. For all commits except the first one, change `pick` to `squash` or `s`, which will squash all of these commits in to one. Now save and quit your text editor.

13. Another text editor window should pop up now, and here you can enter the commit message you would like to show up. This commit contains all of your commits squashed together.

14. In order for this to work with your existing GitHub pull request (because we are rewriting the git log history), we need to `git push origin name-of-feature-branch -f`, which forces the push to overwrite the git log history in that pull request.

15. You should see that on your GitHub pull request, the history should only contain the one commit that you squashed.

16. Press the Merge button, and don't forget to delete your remote feature branch!

Additional Reading

Tuesday, August 19, 2014

Coding Styles and Standards

One of the main reasons for having coding standards is to keep your code readable by everyone. By enforcing standards and formatting, the code base becomes consistent, and anyone can easily understand the structure of the code because he will be more familiar with what to expect. It is also very useful when a new developer joins the team because once he is familiar with the patterns, he will be able to easily read the existing code, which results in a more pleasant experience.
In this example, I will define coding standards for an iOS project (which uses Objective-C). We will take advantage of the fact that code formatting can be automated in XCode by using a plugin. The coding style that I chose is based on the Chromium style guide, but I made a few modifications, which can be found in the `.clang-format` file. Feel free to make changes as you see fit; All of the options are defined here LLVM Coding Standards.
1. Install Alcatraz, the package manager for XCode.
`curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh`
2. Select `Package Manager` from the `Window` menu and search for `ClangFormat` and install that plugin.
3. Select `Clang Format` from the `Edit` menu, and click on `File`. This will load formatting settings from the `.clang-format` file that is located in the repository.
4. When you want to format a file, go to the `Clang Format` menu and select `Format File in Focus`. You can also enable `Enable Format on Save` to have the plugin automatically format the file when you save it. You can also bind formatting to a keyboard shortcut, refer to the ClangFormat homepage for more options.

Additional Standards

The automatic code formatter does not implement all the standards we would like to follow. There are some standards that need to be enforced by the developer himself because they can't be automated. Please refer to https://github.com/paulsfds/objective-c-style-guide to see some examples.

Other Languages

Coding standards are universal and there exists some popular ones for other languages. I would also suggest searching on Google for popular standards for your favorite language. Also, many well established companies such as Google have their own coding standards that are available to the public. Here are a few popular ones to take a look at:
What are your favorite coding styles and standards?

Monday, February 3, 2014

Upgrading Your iPhone App to iOS 7: The New Status Bar

Hi everyone,

It's been a while since I last blogged. I've been neglecting my blog posting duties, but I hope to start posting more here this year. I've picked up iOS development in the meanwhile, so I'll be posting some posts on that topic in addition to the usual Ruby on Rails ones.

I'll start with this post that I wrote for work: http://blog.grio.com/2013/10/upgrading-your-iphone-app-to-ios-7-the-new-status-bar.html