updates to project plugins:

- force projects to return unicode names and branches, or None
 - refactor ProjectMap to set project name from cfg file
 - pass configs to find_project() as dict from plugin's cfg section
 - clean up git project class

updates to config file:

 - rename ~/.wakatime.conf to ~/.wakatime.cfg
 - better error handling while parsing and getting configs
 - no longer need to set defaults when parsing config file
 - use configparser for python3 when python2 import fails

wakatime/projects/base.py

@@ -22,19 +22,19 @@ class BaseProject(object):
     be found for the current path.
     """
 
-    def __init__(self, path, settings):
+    def __init__(self, path, configs=None):
         self.path = path
-        self.settings = settings
+        self._configs = configs
 
-    def type(self):
+    def project_type(self):
         """ Returns None if this is the base class.
         Returns the type of project if this is a
         valid project.
         """
-        type = self.__class__.__name__.lower()
-        if type == 'baseproject':
-            type = None
-        return type
+        project_type = self.__class__.__name__.lower()
+        if project_type == 'baseproject':
+            project_type = None
+        return project_type
 
     def process(self):
         """ Processes self.path into a project and

wakatime/projects/git.py

@@ -25,35 +25,32 @@ log = logging.getLogger(__name__)
 class Git(BaseProject):
 
     def process(self):
-        self.config = self._find_config(self.path)
-        if self.config:
-            return True
-        return False
+        self.configFile = self._find_git_config_file(self.path)
+        return self.configFile is not None
 
     def name(self):
         base = self._project_base()
         if base:
-            return os.path.basename(base)
+            return unicode(os.path.basename(base))
         return None
 
     def branch(self):
-        branch = None
         base = self._project_base()
         if base:
             head = os.path.join(self._project_base(), '.git', 'HEAD')
             try:
-                with open(head) as f:
-                    branch = f.readline().strip().rsplit('/', 1)[-1]
+                with open(head) as fh:
+                    return unicode(fh.readline().strip().rsplit('/', 1)[-1])
             except IOError:
                 pass
-        return branch
-
-    def _project_base(self):
-        if self.config:
-            return os.path.dirname(os.path.dirname(self.config))
         return None
 
-    def _find_config(self, path):
+    def _project_base(self):
+        if self.configFile:
+            return os.path.dirname(os.path.dirname(self.configFile))
+        return None
+
+    def _find_git_config_file(self, path):
         path = os.path.realpath(path)
         if os.path.isfile(path):
             path = os.path.split(path)[0]
@@ -62,34 +59,4 @@ class Git(BaseProject):
         split_path = os.path.split(path)
         if split_path[1] == '':
             return None
-        return self._find_config(split_path[0])
-
-    def _parse_config(self):
-        sections = {}
-        try:
-            f = open(self.config, 'r')
-        except IOError as e:
-            log.exception("Exception:")
-        else:
-            with f:
-                section = None
-                for line in f.readlines():
-                    line = line.lstrip()
-                    if len(line) > 0 and line[0] == '[':
-                        section = line[1:].split(']', 1)[0]
-                        temp = section.split(' ', 1)
-                        section = temp[0].lower()
-                        if len(temp) > 1:
-                            section = ' '.join([section, temp[1]])
-                        sections[section] = {}
-                    else:
-                        try:
-                            (setting, value) = line.split('=', 1)
-                        except ValueError:
-                            setting = line.split('#', 1)[0].split(';', 1)[0]
-                            value = 'true'
-                        setting = setting.strip().lower()
-                        value = value.split('#', 1)[0].split(';', 1)[0].strip()
-                        sections[section][setting] = value
-                f.close()
-        return sections
+        return self._find_git_config_file(split_path[0])

wakatime/projects/projectmap.py

@@ -1,20 +1,16 @@
 # -*- coding: utf-8 -*-
 """
     wakatime.projects.projectmap
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    Information from ~/.waka-projectmap mapping folders (relative to home folder)
-    to project names
+    Use the ~/.wakatime.cfg file to define custom projects for folders.
 
-    :author: 3onyc
+    :copyright: (c) 2013 Alan Hamlett.
     :license: BSD, see LICENSE for more details.
 """
 
 import logging
 import os
-from functools import partial
-
-from ..packages import simplejson as json
 
 from .base import BaseProject
 
@@ -23,34 +19,36 @@ log = logging.getLogger(__name__)
 
 
 class ProjectMap(BaseProject):
+
     def process(self):
-        if not self.settings:
+        if not self._configs:
             return False
 
-        self.project = self._find_project()
-        return self.project != None
+        self.project = self._find_project(self.path)
 
-    def _find_project(self):
-        has_option = partial(self.settings.has_option, 'projectmap')
-        get_option = partial(self.settings.get, 'projectmap')
-        paths = self._path_generator()
+        return self.project is not None
 
-        projects = map(get_option, filter(has_option, paths))
-        return projects[0] if projects else None
+    def _find_project(self, path):
+        path = os.path.realpath(path)
+        if os.path.isfile(path):
+            path = os.path.split(path)[0]
+
+        if self._configs.get(path.lower()):
+            return self._configs.get(path.lower())
+        if self._configs.get('%s/' % path.lower()):
+            return self._configs.get('%s/' % path.lower())
+        if self._configs.get('%s\\' % path.lower()):
+            return self._configs.get('%s\\' % path.lower())
+
+        split_path = os.path.split(path)
+        if split_path[1] == '':
+            return None
+        return self._find_project(split_path[0])
 
     def branch(self):
         return None
 
     def name(self):
-        return self.project
-
-    def _path_generator(self):
-        """
-        Generates paths from the current directory up to the user's home folder
-        stripping anything in the path before the home path
-        """
-
-        path = self.path.replace(os.environ['HOME'], '')
-        while path != os.path.dirname(path):
-            yield path
-            path = os.path.dirname(path)
+        if self.project:
+            return unicode(self.project)
+        return None

wakatime/projects/subversion.py

@@ -30,13 +30,12 @@ class Subversion(BaseProject):
         return self._find_project_base(self.path)
 
     def name(self):
-        return self.info['Repository Root'].split('/')[-1]
+        return unicode(self.info['Repository Root'].split('/')[-1])
 
     def branch(self):
-        branch = None
         if self.base:
-            branch = os.path.basename(self.base)
-        return branch
+            unicode(os.path.basename(self.base))
+        return None
 
     def _get_info(self, path):
         info = OrderedDict()

wakatime/projects/wakatime.py

@@ -28,13 +28,12 @@ class WakaTime(BaseProject):
         return False
 
     def name(self):
-        project_name = None
         try:
             with open(self.config) as fh:
-                project_name = fh.readline().strip()
+                return unicode(fh.readline().strip())
         except IOError as e:
             log.exception("Exception:")
-        return project_name
+        return None
 
     def branch(self):
         return None