Issue 3967 - Create directories for mapped files

packager.py

 # coding: utf-8
 
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 # Note: These are the base functions common to all packagers, the actual
 # packagers are implemented in packagerGecko and packagerChrome.
 
 import sys
@@ skipping 76 matching lines @@
         self.includedFiles = includedFiles
         self.ignoredFiles = ignoredFiles
         self.process = process
 
     def __setitem__(self, key, value):
         if self.process:
             value = self.process(key, value)
         dict.__setitem__(self, key, value)
 
     def isIncluded(self, relpath):
+        return relpath.split('/')[0] in self.includedFiles
+
+    def isIgnored(self, relpath):

[Sebastian Noack, 2016/05/12 12:00:24]

Nit: New names should be lowercase.

         parts = relpath.split('/')
-        if not parts[0] in self.includedFiles:
-            return False
         for part in parts:
             if part in self.ignoredFiles:
-                return False
-        return True
+                return True
+        return False
 
     def read(self, path, relpath='', skip=()):
         if os.path.isdir(path):
             for file in os.listdir(path):
                 name = relpath + ('/' if relpath != '' else '') + file
-                if name not in skip and self.isIncluded(name):
+                if (name not in skip and
+                    self.isIncluded(name) and not self.isIgnored(name)):

[Sebastian Noack, 2016/05/12 12:00:24]

Nit: The indentation here isn't compliant with PEP-8, and not very readable,
since the last line of the condition is on the same indentation level as the
block body.

One way to fix that would be:

  if name not in skip and (self.isIncluded(name) and not
                           self.isIgnored(name)):

Or alternatively, you could use a temporary variable.

                     self.read(os.path.join(path, file), name, skip)
         else:
             with open(path, 'rb') as file:
                 if relpath in self:
                     print >>sys.stderr, 'Warning: File %s defined multiple times' % relpath
                 self[relpath] = file.read()
 
     def readMappedFiles(self, mappings):
         for item in mappings:
             target, source = item
 
-            # Make sure the file is inside an included directory
-            if '/' in target and not self.isIncluded(target):
-                continue
+            if '/' in target:
+                # Make sure the file isn't ignored
+                if self.isIgnored(target):
+                    continue
+                # Make sure the directory is included
+                if not self.isIncluded(target):
+                    self.includedFiles.add(target.split('/')[0])

[Sebastian Noack, 2016/05/12 12:00:24]

Why is it necessary to add it add the directory to includedFiles? It seems if we
just go ahead if the file isn't ignored everything would already work as
intended.

+
             parts = source.split('/')
             path = os.path.join(os.path.dirname(item.source), *parts)
             if os.path.exists(path):
                 self.read(path, target)
             else:
                 print >>sys.stderr, 'Warning: Mapped file %s doesn\'t exist' % source
 
     def preprocess(self, filenames, params={}):
         import jinja2
         env = jinja2.Environment()
 
         for filename in filenames:
             env.autoescape = os.path.splitext(filename)[1].lower() in ('.html', '.xml')
             template = env.from_string(self[filename].decode('utf-8'))
             self[filename] = template.render(params).encode('utf-8')
 
     def zip(self, outFile, sortKey=None):
         zip = zipfile.ZipFile(outFile, 'w', zipfile.ZIP_DEFLATED)
         names = self.keys()
         names.sort(key=sortKey)
         for name in names:
             zip.writestr(name, self[name])
         zip.close()
 
     def zipToString(self, sortKey=None):
         buffer = StringIO()
         self.zip(buffer, sortKey=sortKey)
         return buffer.getvalue()