Merge pull request #7 from jirikuncar/tests-and-improvements

File storage tests

docs/index.rst

@@ -7,6 +7,10 @@ Welcome to Flask-Collect's documentation.
 
 .. == description ==
 .. _description:
+
+Flask-Collect
+-------------
+
 .. automodule:: flask.ext.collect
 
 .. == badges ==

flask_collect/__init__.py

@@ -1,19 +1,13 @@
 # -*- coding: utf-8 -*-
 """
-    Flask-Collect
-    =============
-
-    Flack-Collect is simply application for collect static files in Flask_
-    project.
-    Serve static files with Flask_ -- bad idea for production, with this you
-    will can collect them in one command.
-
-    This extension checks application blueprints for static files and copy it
-    to specific folder (saves related paths).
+**Flask-Collect** is an extension for Flask that helps collecting static files.
 
+Serving static files with *Flask* -- bad idea for production, this tool will
+help you collect them in one command. It checks application and blueprints for
+static files and copy them to specific folder (saves related paths).
 """
 
-from .collect import Collect # noqa
+from .collect import Collect  # noqa
 
 __author__ = "Kirill Klenov <horneds@gmail.com>"
 __license__ = "BSD"

flask_collect/collect.py

@@ -1,23 +1,27 @@
 # coding: utf-8
 
+"""Define *Flask* extension."""
+
 from flask._compat import string_types
 from werkzeug.utils import import_string
 from os import path as op
 
 
-class Collect:
+class Collect(object):
 
-    """This class is used for integration to one or more Flask applications.
+    """Extension object for integration to one or more Flask applications.
 
     :param app: Flask application
 
-    ::
+    .. code-block:: python
 
         app = Flask(__name__)
         collect = Collect(app)
 
     The second possibility is to create the object once and configure the
-    application later to support it::
+    application later to support it:
+
+    .. code-block:: python
 
         collect = Collect()
         ...
@@ -26,6 +30,8 @@ class Collect:
     """
 
     def __init__(self, app=None):
+        """Initilize the extension object."""
+        self.app = None
         self.static_root = None
         self.static_url = None
         self.storage = None
@@ -35,13 +41,11 @@ def __init__(self, app=None):
             self.init_app(app)
 
     def init_app(self, app):
-        """This callback can be used to initialize an application for the
-        use with this collect setup.
+        """Initialize an application for the use with this collect setup.
 
         See :ref:`configuration`.
 
         :param app: Flask application
-
         """
         if not hasattr(app, 'extensions'):
             app.extensions = dict()
@@ -67,12 +71,13 @@ def init_app(self, app):
         self.blueprints = app.blueprints
 
     def init_script(self, manager):
-        """This callback can be used to initialize collect scripts with
-        `Flask-Script`_ manager instance.
+        """Initialize collect scripts with `Flask-Script`_ manager instance.
 
         :param manager: `Flask-Script`_ manager
 
-        This added manager collect command: ::
+        This added manager collect command:
+
+        .. code-block:: console
 
             $ ./manage.py collect -h
             usage: ./manage.py collect [-h] [-v]
@@ -84,10 +89,9 @@ def init_script(self, manager):
             -v, --verbose
 
         .. _Flask-Script: http://packages.python.org/Flask-Script/
-
         """
         def collect(verbose=True):
-            """ Collect static from blueprints. """
+            """Collect static from blueprints."""
             return self.collect(verbose=verbose)
 
         manager.command(collect)
@@ -96,7 +100,6 @@ def collect(self, verbose=False):
         """Collect static files from blueprints.
 
         :param verbose: Show debug information.
-
         """
         mod = import_string(self.storage)
         cls = getattr(mod, 'Storage')

flask_collect/storage/__init__.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Flask-Collect.
+# Copyright (C) 2012 Kirill Klenov.
+# Copyright (C) 2014 CERN.
+#
+# Flask-Collect is free software; you can redistribute it and/or modify it
+# under the terms of the Revised BSD License; see LICENSE file for
+# more details.
+
+"""File storage definitions."""

flask_collect/storage/base.py

@@ -1,22 +1,33 @@
-""" Abstract Storage. """
+# -*- coding: utf-8 -*-
+#
+# This file is part of Flask-Collect.
+# Copyright (C) 2012, 2013 Kirill Klenov.
+# Copyright (C) 2014 CERN.
+#
+# Flask-Collect is free software; you can redistribute it and/or modify it
+# under the terms of the Revised BSD License; see LICENSE file for
+# more details.
+
+"""Abstract File Storage."""
+
 from __future__ import print_function
 
 from os import path as op, walk
 
 
-class BaseStorage():
+class BaseStorage(object):
 
-    """ Base class for storages. """
+    """Base class for storages."""
 
     def __init__(self, collect, verbose=False):
+        """Initialize base storage."""
         self.verbose = verbose
         self.collect = collect
 
     def __iter__(self):
-        """ Seek static files and result full and relative paths.
+        """Seek static files and result full and relative paths.
 
         :return generator: Walk files
-
         """
         app_and_blueprints = self.collect.filter(
             [self.collect.app] + list(self.collect.blueprints.values()))
@@ -26,16 +37,18 @@ def __iter__(self):
                     for f in files:
                         fpath = op.join(root, f)
                         opath = op.relpath(fpath, bp.static_folder.rstrip('/'))
-                        if bp.static_url_path and self.collect.static_url and \
-                                bp.static_url_path.startswith(
-                                    op.join(self.collect.static_url, '')): # noqa
+                        relative = (bp.static_url_path and
+                                    self.collect.static_url and
+                                    bp.static_url_path.startswith(op.join(
+                                        self.collect.static_url, '')))  # noqa
+                        if relative:
                             opath = op.join(
                                 op.relpath(
                                     bp.static_url_path,
                                     self.collect.static_url), opath)
                         yield bp, fpath, opath
 
     def log(self, msg):
-        """ Log message. """
+        """Log message."""
         if self.verbose:
             print(msg)

flask_collect/storage/file.py

@@ -1,3 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Flask-Collect.
+# Copyright (C) 2012, 2014 Kirill Klenov.
+# Copyright (C) 2014 CERN.
+#
+# Flask-Collect is free software; you can redistribute it and/or modify it
+# under the terms of the Revised BSD License; see LICENSE file for
+# more details.
+
+"""Copy files from all static folders to root folder."""
+
 from os import path as op, makedirs
 from shutil import copy
 
@@ -6,7 +18,10 @@
 
 class Storage(BaseStorage):
 
+    """Storage that copies static files."""
+
     def run(self):
+        """Collect static files from blueprints."""
         self.log("Collect static from blueprints.")
         destination_list = set()
         for bp, f, o in self:
@@ -16,8 +31,11 @@ def run(self):
                 makedirs(destination_dir)
             if destination in destination_list:
                 self.log("{0} already copied".format(destination))
-            if not op.exists(destination) or op.getmtime(destination) < op.getmtime(f):
+            elif not op.exists(destination) or \
+                    op.getmtime(destination) < op.getmtime(f):
                 copy(f, destination)
                 self.log(
-                    "Copied: [%s] '%s'" % (bp.name, op.join(self.collect.static_url, destination)))
-            destination_list.add(destination)
+                    "Copied: [%s] '%s'" % (
+                        bp.name,
+                        op.join(self.collect.static_url, destination)))
+                destination_list.add(destination)

flask_collect/storage/link.py

@@ -29,18 +29,23 @@ def run(self):
         """
         self.log("Collect static from blueprints")
         skipped, total = 0, 0
+        destination_list = set()
         for bp, f, o in self:
             destination = os.path.join(self.collect.static_root, o)
             destination_dir = os.path.dirname(destination)
             if not os.path.exists(destination_dir):
                 os.makedirs(destination_dir)
 
-            if not os.path.exists(destination):
+            if destination in destination_list:
+                self.log("{0} already linked".format(destination))
+                skipped += 1
+            elif not os.path.exists(destination):
                 # the path is a link, but points to invalid location
                 if os.path.islink(destination):
                     os.remove(destination)
                 os.symlink(f, destination)
                 self.log("{0}:{1} symbolink link created".format(bp.name, o))
+                destination_list.add(destination)
             else:
                 skipped += 1
             total += 1

flask_collect/storage/test.py

@@ -1,7 +1,22 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Flask-Collect.
+# Copyright (C) 2012, 2013 Kirill Klenov.
+# Copyright (C) 2014 CERN.
+#
+# Flask-Collect is free software; you can redistribute it and/or modify it
+# under the terms of the Revised BSD License; see LICENSE file for
+# more details.
+
+"""List files from all static folders."""
+
 from .base import BaseStorage
 
 
 class Storage(BaseStorage):
 
+    """Dummy storage engine."""
+
     def run(self):
+        """List all file paths."""
         return [f for f in self]