Merge branch 'develop'

Release kendall.0.4.2:
  * Performance improvements in status (updated to using gitpylib 0.4.2).
  * gl history is piped to less (updated to using gitpylib 0.4.2).
  * Output an error msg if the user provides a directory to file related ops.
  * Sort the files outputted by gl status so that it looks nicer.
  * Bug fixes.

Author: spderosso

README.md

@@ -1,46 +1,21 @@
 Gitless
 =======
 
-A version control system built on top of Git.
+Gitless is an experimental version control system built on top of Git. Many
+people complain that Git is hard to use. We think the problem lies deeper than
+the user interface, in the concepts underlying Git. Gitless is an experiment to
+see what happens if you put a simple veneer on an app that changes the
+underlying concepts. Because Gitless is implemented on top of Git (could be
+considered what Git pros call a 'porcelain' of Git), you can always fall
+back on Git. And of course your coworkers you share a repo with need never know
+that you're not a Git aficionado.
 
-This is under active development.
+More info, downloads and documentation @ [Gitless's website](
+    http://people.csail.mit.edu/sperezde/gitless "Gitless's website").
 
-More info, downloads and documentation @
-<http://people.csail.mit.edu/sperezde/gitless>.
 
-
-About
------
-
-Gitless is an experimental version control system built on top of Git. Keep in
-mind that Gitless might change in non-retrocompatible ways (so don't script
-around it just yet) as we seek to answer the fundamental question that drives
-this software project: if we were to challenge the very core concepts in
-version control systems, what would version control look like?
-
-In its current state, Gitless is a distributed version control system that
-supports all of the most commonly used Git features. We are missing some things
-like submodules and cherry-picking but these are coming soon (maybe; only if we
-don't find a superior, more robust way of achieving the same goal). Either way,
-since Gitless is implemented on top of Git (could be considered what Git
-pros call a 'porcelain' of Git) you can always fallback to the 'git' command to
-finish a task.
-
-Check out the documentation section to get started. If you are a novice user
-that never used any version control system the documentation should be enough to
-get you started. If you are a Git pro looking to see what's different from your
-beloved Git you'll be able to spot the differences by glancing through the
-documentation (section on Gitless vs. {Git, Mercurial} coming soon).
-
-
-Documentation
--------------
-
-TODO
-
-
-Installing
-----------
+Install
+-------
 
 Note that the installation **won't interfere** with your Git installation in any
 way, you can keep using Git, and switch between Git and Gitless seamleslly.
@@ -58,11 +33,17 @@ You should now be able to start executing the `gl` command.
 
 
 
-Contributing
-------------
+Contribute
+----------
 
 We only have two branches, `master` and `develop`. We code in `develop` and
 merge the changes onto `master` when the changes are stable and we're ready to
 cut a new release. So you'll find on `develop` the latest changes.
 
+We follow (to some extent) the [Google Python Style Guide](
+    http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
+    "Google Python Style Guide").
+Before contributing, take a few seconds to look at the style guide and the
+Gitless's code so that your edits are consistent with the codebase.
+
 To contribute: fork project, make changes, send pull request.

RELEASE_NOTES.md

@@ -2,6 +2,16 @@ Gitless's Release Notes
 =======================
 
 
+15th Jan 2014 - kendall.0.4.2
+-----------------------------
+
+* Performance improvements in status (updated to using gitpylib 0.4.2).
+* `gl history` is piped to less (updated to using gitpylib 0.4.2).
+* Output an error msg if the user provides a directory to file related ops.
+* Sort the files outputted by `gl status` so that it looks nicer.
+* Bug fixes.
+
+
 6th Dec 2013 - kendall.0.4.1
 ----------------------------
 
@@ -11,7 +21,7 @@ Gitless's Release Notes
 23rd Nov 2013 - kendall.0.4
 ---------------------------
 
-* Revamped gl diff.
+* Revamped `gl diff`.
 
 
 28th Oct 2013 - kendall.0.3
@@ -20,8 +30,8 @@ Gitless's Release Notes
 * General bug fixes.
 * UI improvements (made some messages more clear, consistent).
 * Allow the user to branch out from certain commit point.
-* Improvements in gl diff: now it outputs a message if the file is ignored or if
-  there are no diffs to show.
+* Improvements in `gl diff`: now it outputs a message if the file is ignored or
+  if there are no diffs to show.
 * pre-commit hooks now work fine.
 
 
@@ -35,18 +45,18 @@ Gitless's Release Notes
 ---------------------------
 
 * Support for files with spaces.
-* General improvements in the gl checkout command:
-    * Now the commit point is passed with the -cp flag (defaults to HEAD).
+* General improvements in the `gl checkout` command:
+    * Now the commit point is passed with the `-cp` flag (defaults to `HEAD`).
     * Fixed bug that made it impossible to checkout a file without specifying
       its full repo path.
     * Ask for confirmation by the user if there are uncommitted changes that
       could be overwritten by checkout.
-* General improvements in the gl diff command:
+* General improvements in the `gl diff` command:
     * Fixed bug that made it impossible to diff a deleted file.
     * Now if no arguments are given all tracked files with modifications are
       diffed.
-* Removed the gl rm command.
-* Now gl is the only command (in retrospect, having a "suite of commands" was
+* Removed the `gl rm` command.
+* Now `gl` is the only command (in retrospect, having a "suite of commands" was
   over-engineering, code is much simpler now).
 * Massive re-org of project.
 
@@ -57,8 +67,8 @@ Gitless's Release Notes
 * Minor improvements in output of commands.
 * Improvements in Makefile and added Python version checks.
 * Made case-sensitiveness consistent with FS.
-* Fixed bug that made it impossible to gl-track files under directories without
-  cd'ing first to that dir.
+* Fixed bug that made it impossible to `gl-track` files under directories
+  without cd'ing first to that dir.
 * Better support for evil branch names.
 * Before defaulting to using vim we now check to see if the user specified a
   value for Git's 'core.editor' config option or if the EDITOR env variable is

gitless/cli/file_cmd.py

@@ -5,6 +5,8 @@
 """Helper module for gl_{track, untrack, resolve}."""
 
 
+import os
+
 import pprint
 
 from gitless.core import file as file_lib
@@ -32,6 +34,9 @@ def f(args):
       if ret == file_lib.FILE_NOT_FOUND:
         pprint.err('Can\'t {} a non-existent file: {}'.format(subcmd, fp))
         success = False
+      elif ret == file_lib.FILE_IS_DIR:
+        pprint.dir_err_exp(fp, subcmd)
+        success = False
       elif ret is file_lib.FILE_ALREADY_UNTRACKED:
         pprint.err('File {} is already untracked'.format(fp))
         success = False

gitless/cli/gl.py

@@ -6,6 +6,7 @@
 
 
 import argparse
+import pkg_resources
 import traceback
 
 from gitless.core import repo as repo_lib
@@ -33,7 +34,7 @@
 INTERNAL_ERROR = 3
 NOT_IN_GL_REPO = 4
 
-GL_VERSION = 'kendall.0.2.1'
+GL_VERSION = 'GL Version: ' + pkg_resources.require('gitless')[0].version
 
 
 def main():

gitless/cli/gl_checkout.py

@@ -52,11 +52,14 @@ def _checkout_file(fp, cp):
     return False
 
   ret, out = file_lib.checkout(fp, cp)
-  if ret is file_lib.FILE_NOT_FOUND_AT_CP:
+  if ret == file_lib.FILE_NOT_FOUND_AT_CP:
     pprint.err('Checkout aborted')
     pprint.err('There\'s no file %s at %s' % (fp, cp))
     return False
-  elif ret is file_lib.SUCCESS:
+  elif ret == file_lib.FILE_IS_DIR:
+    pprint.dir_err_exp(fp, subcmd)
+    return False
+  elif ret == file_lib.SUCCESS:
     pprint.msg('File %s checked out sucessfully to its state at %s' % (fp, cp))
     return True
   else:

gitless/cli/gl_diff.py

@@ -41,22 +41,25 @@ def main(args):
   for fp in files:
     ret, (out, padding) = file_lib.diff(fp)
 
-    if ret is file_lib.FILE_NOT_FOUND:
+    if ret == file_lib.FILE_NOT_FOUND:
       pprint.err('Can\'t diff a non-existent file: {}'.format(fp))
       success = False
-    elif ret is file_lib.FILE_IS_UNTRACKED:
+    elif ret == file_lib.FILE_IS_UNTRACKED:
       pprint.err(
           'You tried to diff untracked file {}. It\'s probably a mistake. If '
           'you really care about changes in this file you should start '
           'tracking changes to it with gl track {}'.format(fp, fp))
       success = False
-    elif ret is file_lib.FILE_IS_IGNORED:
+    elif ret == file_lib.FILE_IS_IGNORED:
       pprint.err(
           'You tried to diff ignored file {}. It\'s probably a mistake. If '
           'you really care about changes in this file you should stop ignoring '
           'it by editing the .gigignore file'.format(fp))
       success = False
-    elif ret is file_lib.SUCCESS:
+    elif ret == file_lib.FILE_IS_DIR:
+      pprint.dir_err_exp(fp, 'diff')
+      success = False
+    elif ret == file_lib.SUCCESS:
       if not out:
         pprint.msg(
             'The working version of file {} is the same as its last '

gitless/cli/gl_remote.py

@@ -46,8 +46,8 @@ def _do_add(args):
     pprint.err_exp(
         'to get information about %s do gl remote show %s' % (rn, rn))
     pprint.err_exp(
-        'if you want to change the url for remote %s do gl rm %s, and then gl '
-        'add %s new_url' % (rn, rn, rn))
+        'if you want to change the url for remote %s do gl remote rm %s, and '
+        'then gl remote add %s new_url' % (rn, rn, rn))
     success = False
   elif ret is remote_lib.SUCCESS:
     pprint.msg('Remote added successfully')

gitless/cli/gl_status.py

@@ -42,9 +42,11 @@ def main(unused_args):
     elif f.type == file_lib.UNTRACKED:
       untracked_list.append(f)
   pprint.blank()
+  tracked_mod_list.sort(key=lambda f: f.fp)
   _print_tracked_mod_files(tracked_mod_list)
   pprint.blank()
   pprint.blank()
+  untracked_list.sort(key=lambda f: f.fp)
   _print_untracked_files(untracked_list)
   return True
 

gitless/cli/pprint.py

@@ -67,3 +67,8 @@ def conf_dialog(msg):
   sys.stdout.write('# %s. Do you wish to continue? (y/N)' % msg)
   user_input = raw_input(' ')
   return user_input and user_input[0].lower() == 'y'
+
+
+def dir_err_exp(fp, subcmd):
+  """Prints the dir error exp to stderr."""
+  err('{} is a directory. Can\'t {} a directory'.format(fp, subcmd))

gitless/core/file.py

@@ -26,11 +26,12 @@
 FILE_IS_IGNORED = 8
 FILE_NOT_IN_CONFLICT = 9
 FILE_ALREADY_RESOLVED = 10
+FILE_IS_DIR = 11
 
 # Possible Gitless's file types.
-TRACKED = 11
-UNTRACKED = 12
-IGNORED = 13
+TRACKED = 12
+UNTRACKED = 13
+IGNORED = 14
 
 # Possible diff output lines.
 DIFF_INFO = git_file.DIFF_INFO  # line carrying diff info for new hunk.
@@ -46,9 +47,11 @@ def track(fp):
     fp: the file path of the file to track.
 
   Returns:
-    FILE_NOT_FOUND, FILE_ALREADY_TRACKED, FILE_IN_CONFLICT, FILE_IS_IGNORED or
-    SUCCESS.
+    FILE_NOT_FOUND, FILE_IS_DIR, FILE_ALREADY_TRACKED, FILE_IN_CONFLICT,
+    FILE_IS_IGNORED or SUCCESS.
   """
+  if os.path.isdir(fp):
+    return FILE_IS_DIR
   f_st, s = _status(fp)
   if f_st == FILE_NOT_FOUND:
     return FILE_NOT_FOUND
@@ -81,9 +84,11 @@ def untrack(fp):
     fp: the file path of the file to untrack.
 
   Returns:
-    FILE_NOT_FOUND, FILE_ALREADY_UNTRACKED, FILE_IN_CONFLICT, FILE_IS_IGNORED or
-    SUCCESS.
+    FILE_NOT_FOUND, FILE_IS_DIR, FILE_ALREADY_UNTRACKED, FILE_IN_CONFLICT,
+    FILE_IS_IGNORED or SUCCESS.
   """
+  if os.path.isdir(fp):
+    return FILE_IS_DIR
   f_st, s = _status(fp)
   if f_st == FILE_NOT_FOUND:
     return FILE_NOT_FOUND
@@ -122,11 +127,13 @@ def diff(fp):
 
   Returns:
     a pair (result, out) where result is one of FILE_NOT_FOUND,
-    FILE_IS_UNTRACKED or SUCCESS and out is the output of the diff command in a
-    machine-friendly way: it's a tuple of the form
+    FILE_IS_UNTRACKED, FILE_IS_DIR or SUCCESS and out is the output of the diff
+    command in a machine-friendly way: it's a tuple of the form
     (list of namedtuples with fields 'line', 'status', 'old_line_number',
      'new_line_number', line number padding).
   """
+  if os.path.isdir(fp):
+    return (FILE_IS_DIR, (None, None))
   f_st, s = _status(fp)
   if f_st == git_status.FILE_NOT_FOUND:
     return (FILE_NOT_FOUND, (None, None))
@@ -157,9 +164,11 @@ def checkout(fp, cp='HEAD'):
     cp: the commit point at which to checkout the file (defaults to HEAD).
 
   Returns:
-    a pair (status, out) where status is one of FILE_NOT_FOUND_AT_CP or SUCCESS
-    and out is the content of fp at cp.
+    a pair (status, out) where status is one of FILE_IS_DIR,
+    FILE_NOT_FOUND_AT_CP or SUCCESS and out is the content of fp at cp.
   """
+  if os.path.isdir(fp):
+    return (FILE_IS_DIR, None)
   # "show" expects the full path with respect to the repo root.
   rel_fp = os.path.join(repo_lib.cwd(), fp)[1:]
   ret, out = git_file.show(rel_fp, cp)
@@ -236,7 +245,9 @@ def resolve(fp):
   if f_st.resolved:
     return FILE_ALREADY_RESOLVED
 
-  # In Git, to mark a file as resolved we have to add it.
+  # We don't use Git to keep track of resolved files, but just to make it feel
+  # like doing a resolve in Gitless is similar to doing a resolve in Git
+  # (i.e., add) we stage the file.
   git_file.stage(fp)
   # We add a file in the Gitless directory to be able to tell when a file has
   # been marked as resolved.
@@ -278,7 +289,17 @@ def _build_f_st(s, fp):
   elif s == git_status.TRACKED_MODIFIED:
     ret = FileStatus(fp, TRACKED, True, True, True, False, False)
   elif s == git_status.STAGED:
-    # Staged file don't exist in the lr for Gitless.
+    # A file could have been "gl track"ed and later ignored by adding a matching
+    # pattern in a .gitignore file. We consider this kind of file to still be a
+    # tracked file. This is consistent with the idea that tracked files can't
+    # be ignored.
+    # TODO(sperezde): address the following rough edge: the user could untrack
+    # a tracked file (one that was not committed before) and if it's matched by
+    # a .gitignore file it will be ignored. The same thing won't happen if an
+    # already committed file is untracked (due to how Gitless keeps track of
+    # these kind of files).
+
+    # Staged files don't exist in the lr for Gitless.
     ret = FileStatus(fp, TRACKED, False, True, True, False, False)
   elif s == git_status.ASSUME_UNCHANGED:
     # TODO(sperezde): detect whether it is modified or not?
@@ -287,15 +308,15 @@ def _build_f_st(s, fp):
     ret = FileStatus(fp, TRACKED, True, False, True, False, False)
   elif s == git_status.DELETED_STAGED:
     # This can only happen if the user did a rm of a new file. The file doesn't
-    # exist anymore for Gitless.
+    # exist as far as Gitless is concerned.
     git_file.unstage(fp)
     ret = None
   elif s == git_status.DELETED_ASSUME_UNCHANGED:
     ret = None
   elif s == git_status.IN_CONFLICT:
     wr = _was_resolved(fp)
     ret = FileStatus(fp, TRACKED, True, True, True, not wr, wr)
-  elif s == git_status.IGNORED or s == git_status.IGNORED_STAGED:
+  elif s == git_status.IGNORED:
     ret = FileStatus(fp, IGNORED, False, True, True, True, False)
   elif s == git_status.MODIFIED_MODIFIED:
     # The file was marked as resolved and then modified. To Gitless, this is