Bundle dirspec to workaround pip options

http://stackoverflow.com/q/23014238/383405
https://bugs.launchpad.net/dirspec/+bug/1298163

README.rst

@@ -10,18 +10,12 @@ Installation
 ------------
 
 It is available on PyPI__, so you can install it using ``pip`` installer.
-Though you have to specify ``--allow-external`` and ``--allow-unverified``
-options (related issues: 1_, 2_).
 
 .. code-block:: console
 
-   $ pip install --allow-external dirspec \
-                 --allow-unverified dirspec \
-                 geofront-cli
+   $ pip install geofront-cli
 
 __ https://pypi.python.org/pypi/geofront-cli
-.. _1: http://stackoverflow.com/q/23014238/383405
-.. _2: https://bugs.launchpad.net/dirspec/+bug/1298163
 
 
 Getting started
@@ -133,6 +127,10 @@ To be released.
 
 - Added ``geofront-cli scp`` command.
 - Added the short option ``-S`` for ``--ssh``.
+- It becomes to no more depend on dirspec_.  Instead it's simply bundled
+  together.
+
+.. _dirspec: https://pypi.python.org/pypi/dirspec
 
 
 Version 0.2.0

dirspec/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""dirspec package."""

dirspec/basedir.py

@@ -0,0 +1,159 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011-2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""XDG Base Directory paths."""
+
+from __future__ import unicode_literals, print_function
+
+import os
+
+from dirspec.utils import (default_cache_home,
+                           default_config_path, default_config_home,
+                           default_data_path, default_data_home,
+                           get_env_path, unicode_path)
+
+__all__ = ['xdg_cache_home',
+           'xdg_config_home',
+           'xdg_data_home',
+           'xdg_config_dirs',
+           'xdg_data_dirs',
+           'load_config_paths',
+           'load_data_paths',
+           'load_first_config',
+           'save_config_path',
+           'save_data_path',
+           ]
+
+
+def get_xdg_cache_home():
+    """Get the path for XDG cache directory in user's HOME."""
+    return get_env_path('XDG_CACHE_HOME', default_cache_home)
+
+
+def get_xdg_config_home():
+    """Get the path for XDG config directory in user's HOME."""
+    return get_env_path('XDG_CONFIG_HOME', default_config_home)
+
+
+def get_xdg_data_home():
+    """Get the path for XDG data directory in user's HOME."""
+    return get_env_path('XDG_DATA_HOME', default_data_home)
+
+
+def get_xdg_config_dirs():
+    """Get the paths for the XDG config directories."""
+    result = [get_xdg_config_home()]
+    result.extend([x.encode('utf-8') for x in get_env_path(
+        'XDG_CONFIG_DIRS',
+        default_config_path).decode('utf-8').split(os.pathsep)])
+    return result
+
+
+def get_xdg_data_dirs():
+    """Get the paths for the XDG data directories."""
+    result = [get_xdg_data_home()]
+    result.extend([x.encode('utf-8') for x in get_env_path(
+        'XDG_DATA_DIRS',
+        default_data_path).decode('utf-8').split(os.pathsep)])
+    return result
+
+
+def load_config_paths(*resource):
+    """Iterator of configuration paths.
+
+    Return an iterator which gives each directory named 'resource' in
+    the configuration search path. Information provided by earlier
+    directories should take precedence over later ones (ie, the user's
+    config dir comes first).
+    """
+    resource = os.path.join(*resource)
+    assert not resource.startswith('/')
+    for config_dir in get_xdg_config_dirs():
+        path = os.path.join(config_dir, resource.encode('utf-8'))
+        # access the file system always with unicode
+        # to properly behave in some operating systems
+        if os.path.exists(unicode_path(path)):
+            yield path
+
+
+def load_data_paths(*resource):
+    """Iterator of data paths.
+
+    Return an iterator which gives each directory named 'resource' in
+    the stored data search path. Information provided by earlier
+    directories should take precedence over later ones.
+    """
+    resource = os.path.join(*resource)
+    assert not resource.startswith('/')
+    for data_dir in get_xdg_data_dirs():
+        path = os.path.join(data_dir, resource.encode('utf-8'))
+        # access the file system always with unicode
+        # to properly behave in some operating systems
+        if os.path.exists(unicode_path(path)):
+            yield path
+
+
+def load_first_config(*resource):
+    """Returns the first result from load_config_paths, or None if nothing
+    is found to load.
+    """
+    for path in load_config_paths(*resource):
+        return path
+    return None
+
+
+def save_config_path(*resource):
+    """Path to save configuration.
+
+    Ensure $XDG_CONFIG_HOME/<resource>/ exists, and return its path.
+    'resource' should normally be the name of your application. Use this
+    when SAVING configuration settings. Use the xdg_config_dirs variable
+    for loading.
+    """
+    resource = os.path.join(*resource)
+    assert not resource.startswith('/')
+    path = os.path.join(get_xdg_config_home(), resource.encode('utf-8'))
+    # access the file system always with unicode
+    # to properly behave in some operating systems
+    if not os.path.isdir(unicode_path(path)):
+        os.makedirs(unicode_path(path), 0o700)
+    return path
+
+
+def save_data_path(*resource):
+    """Path to save data.
+
+    Ensure $XDG_DATA_HOME/<resource>/ exists, and return its path.
+    'resource' should normally be the name of your application. Use this
+    when STORING a resource. Use the xdg_data_dirs variable for loading.
+    """
+    resource = os.path.join(*resource)
+    assert not resource.startswith('/')
+    path = os.path.join(get_xdg_data_home(), resource.encode('utf-8'))
+    # access the file system always with unicode
+    # to properly behave in some operating systems
+    if not os.path.isdir(unicode_path(path)):
+        os.makedirs(unicode_path(path), 0o700)
+    return path
+
+
+# pylint: disable=C0103
+xdg_cache_home = get_xdg_cache_home()
+xdg_config_home = get_xdg_config_home()
+xdg_data_home = get_xdg_data_home()
+
+xdg_config_dirs = [x for x in get_xdg_config_dirs() if x]
+xdg_data_dirs = [x for x in get_xdg_data_dirs() if x]
+# pylint: disable=C0103

dirspec/tests/__init__.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2011-2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3
+# as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+""""dirspec tests."""
+
+from __future__ import unicode_literals, print_function
+
+import os
+
+from operator import setitem
+from testtools.testcase import TestCase
+
+
+class BaseTestCase(TestCase):
+    """Base test case for dirspect tests."""
+
+    def assert_utf8_bytes(self, value):
+        """Check that 'value' is a bytes sequence encoded with utf-8."""
+        self.assertIsInstance(value, bytes)
+        try:
+            value.decode('utf-8')
+        except UnicodeError:
+            self.fail('%r should be a utf8 encoded string.' % value)
+
+    def tweak_env(self, envvar, value):
+        """Tweak the environment variable %var to %value.
+
+        Restore the old value when finished.
+        """
+        old_val = os.environ.get(envvar, None)
+
+        if old_val is None:
+            self.addCleanup(os.environ.pop, envvar, None)
+        else:
+            self.addCleanup(setitem, os.environ, envvar, old_val)
+        if value is None:
+            os.environ.pop(envvar, None)
+        else:
+            os.environ[envvar] = value