Merge branch 'release/18.0.0'

Author: felliott

CHANGELOG

@@ -2,6 +2,15 @@
 ChangeLog
 *********
 
+18.0.0 (2018-10-11)
+===================
+- UPDATE: MFR is now following the CalVer (https://calver.org/) versioning scheme to match the
+OSF.  All new versions will use the `YY.MINOR.MICRO` format.
+- Fix: Move Hypothes.is toolbar toggle button down, so that it doesn't block the pdf.js controls on
+tiny mobile screens.
+- Fix: Don't crash when the image exporter receives a misformatted dimensions argument.
+- Fix: Show informative errors to users when a tabular file rendering action fails.
+
 0.27.1 (2018-07-25)
 ===================
 - Feature: Tell Keen analytics to strip ip on upload.

mfr/extensions/image/export.py

@@ -18,12 +18,14 @@ def __init__(self, *args, **kwargs):
 
     def export(self):
         parts = self.format.split('.')
-        type = parts[-1].lower()
-        max_size = [int(x) for x in parts[0].split('x')] if len(parts) == 2 else None
+        image_type = parts[-1].lower()
+        max_size = {'w': None, 'h': None}
+        if len(parts) == 2:
+            max_size['w'], max_size['h'] = [int(size) for size in parts[0].split('x')]
         self.metrics.merge({
-            'type': type,
-            'max_size_w': max_size[0],
-            'max_size_h': max_size[1],
+            'type': image_type,
+            'max_size_w': max_size['w'],
+            'max_size_h': max_size['h'],
         })
         try:
             if self.ext in ['.psd']:
@@ -36,13 +38,14 @@ def export(self):
             else:
                 image = Image.open(self.source_file_path)
 
-            if max_size:
+            # Only resize when both dimensions are available
+            if max_size.get('w') and max_size.get('h'):
                 # resize the image to the w/h maximum specified
-                ratio = min(max_size[0] / image.size[0], max_size[1] / image.size[1])
+                ratio = min(max_size['w'] / image.size[0], max_size['h'] / image.size[1])
                 self.metrics.add('ratio', ratio)
                 if ratio < 1:
-                    image = image.resize((round(image.size[0] * ratio),
-                                          round(image.size[1] * ratio)), Image.ANTIALIAS)
+                    size_tuple = (round(image.size[0] * ratio), round(image.size[1] * ratio))
+                    image = image.resize(size_tuple, Image.ANTIALIAS)
 
             # Mode 'P' is for paletted images. They must be converted to RGB before exporting to
             # jpeg, otherwise Pillow will throw an error.  This is a temporary workaround, as the
@@ -53,22 +56,22 @@ def export(self):
 
             # handle transparency
             # from https://github.com/python-pillow/Pillow/issues/2609
-            if image.mode in ('RGBA', 'RGBa', 'LA') and type in ['jpeg', 'jpg']:
+            if image.mode in ('RGBA', 'RGBa', 'LA') and image_type in ['jpeg', 'jpg']:
                 # JPEG has no transparency, so anything that was transparent gets changed to
                 # EXPORT_BACKGROUND_COLOR. Default is white.
                 background = Image.new(image.mode[:-1], image.size, EXPORT_BACKGROUND_COLOR)
                 background.paste(image, image.split()[-1])
                 image = background
 
-            image.save(self.output_file_path, type)
+            image.save(self.output_file_path, image_type)
             image.close()
 
         except (UnicodeDecodeError, IOError, FileNotFoundError, OSError) as err:
-            name, extension = os.path.splitext(os.path.split(self.source_file_path)[-1])
+            os.path.splitext(os.path.split(self.source_file_path)[-1])
             raise exceptions.PillowImageError(
                 'Unable to export the file as a {}, please check that the '
-                'file is a valid image.'.format(type),
-                export_format=type,
+                'file is a valid image.'.format(image_type),
+                export_format=image_type,
                 detected_format=imghdr.what(self.source_file_path),
                 original_exception=err,
                 code=400,

mfr/extensions/pdf/templates/viewer.mako

@@ -40,9 +40,8 @@ http://sourceforge.net/adobe/cmap/wiki/License/
 
     % if enable_hypothesis:
     <style>
-      body.show-hypothesis #toolbarViewer {
-        position: relative;
-        margin-right: 36px;
+      body.show-hypothesis .annotator-frame {
+        margin-top: 32px;
       }
     </style>
     % endif

mfr/extensions/tabular/render.py

@@ -110,20 +110,22 @@ def _populate_data(self, fp, ext):
         """
         function_preference = settings.LIBS.get(ext.lower())
 
-        for function in function_preference:
+        for populate_func in function_preference:
             try:
-                imported = function()
+                imported = populate_func()
             except ImportError:
                 pass
             else:
-                self._renderer_tabular_metrics['importer'] = function.__name__
+                self._renderer_tabular_metrics['importer'] = populate_func.__name__
                 try:
                     return imported(fp)
-                except (KeyError, ValueError):
+                except (KeyError, ValueError) as err:
+                    logger.error('WB has encountered an unexpected error '
+                                 'when trying to render a tabular file: {}'.format(err))
                     raise exceptions.UnexpectedFormattingError(
                         'Unexpected formatting error.',
                         extension=self.metadata.ext,
-                        formatting_function=str(function),
+                        formatting_function=str(populate_func),
                     )
 
         # this will only occur if function_preference is an empty set

mfr/providers/osf/provider.py

@@ -73,7 +73,7 @@ async def metadata(self):
             metadata_response = await self._make_request(
                 'HEAD',
                 download_url,
-                headers={settings.MFR_ACTION_HEADER: self.action or ''}
+                headers=({settings.MFR_ACTION_HEADER: self.action} if self.action else None)
             )
             response_code = metadata_response.status
             response_reason = metadata_response.reason

mfr/version.py

@@ -1 +1 @@
-__version__ = '0.27.1'
+__version__ = '18.0.0'

tasks.py

@@ -49,11 +49,27 @@ def flake(ctx):
 
 
 @task
-def test(ctx, verbose=False):
+def test(ctx, verbose=False, nocov=False, extension=None, path=None):
+    """Run full or customized tests for MFR.
+    :param ctx: the ``invoke`` context
+    :param verbose: the flag to increase verbosity
+    :param nocov: the flag to disable coverage
+    :param extension: limit the tests to the given extension only
+    :param path: limit the tests to the given path only
+    :return: None
+    """
     flake(ctx)
-    cmd = 'py.test --cov-report term-missing --cov mfr tests'
-    if verbose:
-        cmd += ' -v'
+    # `--extension=` and `--path=` are mutually exclusive options
+    assert not (extension and path)
+    if path:
+        path = '/{}'.format(path) if path else ''
+    elif extension:
+        path = '/extensions/{}/'.format(extension) if extension else ''
+    else:
+        path = ''
+    coverage = ' --cov-report term-missing --cov mfr' if not nocov else ''
+    verbose = '-v' if verbose else ''
+    cmd = 'py.test{} tests{} {}'.format(coverage, path, verbose)
     ctx.run(cmd, pty=True)