Merge pull request #67 from keyan/kp_extensions_glob_matching

Extensions glob matching

Author: modocache

README.md

@@ -48,7 +48,8 @@ Options (all optional) include:
       *before* which we should stop exploring, or a percentage of the way
       through, just before which to end.
     --extensions
-      A comma-delimited list of file extensions to process.
+      A comma-delimited list of file extensions to process. Also supports Unix
+      pattern matching.
     --include-extensionless
       If set, this will check files without an extension, along with any
       matching file extensions passed in --extensions

codemod/base.py

@@ -20,6 +20,7 @@
 
 
 import argparse
+import fnmatch
 import os
 import re
 import sys
@@ -49,7 +50,8 @@ def is_extensionless(path):
 def matches_extension(path, extension):
     """
     Returns True if path has the given extension, or if
-    the last path component matches the extension.
+    the last path component matches the extension. Supports
+    Unix glob matching.
 
     >>> matches_extension("./www/profile.php", "php")
     True
@@ -66,19 +68,29 @@ def matches_extension(path, extension):
     else:
         # If the is an extension, drop the leading period and
         # compare it to the extension.
-        return ext[1:] == extension
+        return fnmatch.fnmatch(ext[1:], extension)
 
 
-def path_filter(extensions=None, exclude_paths=None):
+def path_filter(extensions, exclude_paths=None):
     """
-    Returns a function (useful as the path_filter field of a Query instance)
-    that returns True iff the path it is given has an extension one of the
-    file extensions specified in `extensions`, an array of strings.
+    Returns a function that returns True if a filepath is acceptable.
+
+    @param extensions     An array of strings. Specifies what file
+                          extensions should be accepted by the
+                          filter. If None, we default to the Unix glob
+                          `*` and match every file extension.
+    @param exclude_paths  An array of strings which represents filepaths
+                          that should never be accepted by the filter.
+
+    @return function      A filter function that will only return True
+                          when a filepath is acceptable under the above
+                          conditions.
 
     >>> map(path_filter(extensions=['js', 'php']),
     ...     ['./profile.php', './q.jjs'])
     [True, False]
-    >>> map(path_filter(exclude_paths=['html']),
+    >>> map(path_filter(extensions=['*'],
+    ...                 exclude_paths=['html']),
     ...     ['./html/x.php', './lib/y.js'])
     [False, True]
     >>> map(path_filter(extensions=['js', 'BUILD']),
@@ -88,11 +100,9 @@ def path_filter(extensions=None, exclude_paths=None):
     exclude_paths = exclude_paths or []
 
     def the_filter(path):
-        if extensions:
-            if not any(
-                matches_extension(path, extension) for extension in extensions
-            ):
-                return False
+        if not any(matches_extension(path, extension)
+                   for extension in extensions):
+            return False
         if exclude_paths:
             for excluded in exclude_paths:
                 if path.startswith(
@@ -917,9 +927,11 @@ def _parse_command_line():
                              'or a percentage of the way through, '
                              'just before which to end.')
 
-    parser.add_argument('--extensions', action='store', type=str,
+    parser.add_argument('--extensions', action='store',
+                        default='*', type=str,
                         help='A comma-delimited list of file extensions '
-                             'to process.')
+                             'to process. Also supports Unix pattern '
+                             'matching.')
     parser.add_argument('--include-extensionless', action='store_true',
                         help='If set, this will check files without '
                         'an extension, along with any matching file '
@@ -950,12 +962,6 @@ def _parse_command_line():
 
     arguments = parser.parse_args()
 
-    if (
-        arguments.extensions is None
-    ) and (arguments.include_extensionless is False):
-        parser.print_usage()
-        sys.exit(0)
-
     yes_to_all = arguments.accept_all
 
     query_options = {}
@@ -969,12 +975,12 @@ def _parse_command_line():
     query_options['root_directory'] = arguments.d
     query_options['inc_extensionless'] = arguments.include_extensionless
 
-    if arguments.extensions is not None or arguments.exclude_paths is not None:
-        query_options['path_filter'] = (
-            path_filter(extensions=arguments.extensions.split(',')
-                        if arguments.extensions is not None else None,
-                        exclude_paths=arguments.exclude_paths.split(',')
-                        if arguments.exclude_paths is not None else None))
+    if arguments.exclude_paths is not None:
+        exclude_paths = arguments.exclude_paths.split(',')
+    else:
+        exclude_paths = None
+    query_options['path_filter'] = path_filter(arguments.extensions.split(','),
+                                               exclude_paths)
 
     options = {}
     options['query'] = Query(**query_options)