@ pallets-eco#26 | Should support route generation configuration for dashifying method names

Author: hoatle

docs/index.rst

@@ -513,7 +513,7 @@ view method in your `FlaskView` like this::
 `FlaskView` will generate a route like this:
 
 ============ ================================
-**rule**      /some/my_view/
+**rule**      /root/my_view/
 **endpoint**  SomeView:my_view
 **method**    GET
 ============ ================================
@@ -541,6 +541,25 @@ too. If you were to define another view like this::
     parameters, so if you want or need them you'll need to define the
     route yourself using the `@route` decorator.
 
+Sometimes that you need to use `my-view` instead of default `my_view` generated route, you can
+use `method_dashified` attribute when defining the view class or when registering the view with the
+app. For example::
+
+    class SomeView(FlaskView):
+        route_base = "root"
+        method_dashified = True
+
+        def my_view(self):
+            return "Check out my view!"
+
+`FlaskView` will generate a route like this:
+
+============ ================================
+**rule**      /root/my-view/
+**endpoint**  SomeView:my_view
+**method**    GET
+============ ================================
+
 
 Decorating Tips
 ---------------

flask_classful.py

@@ -52,6 +52,7 @@ class FlaskView(object):
     route_base = None
     route_prefix = None
     trailing_slash = True
+    method_dashified = False # TODO(hoatle): make True as default instead, this is not a compatible change
     special_methods = {
         "get": ["GET"],
         "put": ["PUT"],
@@ -63,7 +64,7 @@ class FlaskView(object):
 
     @classmethod
     def register(cls, app, route_base=None, subdomain=None, route_prefix=None,
-                 trailing_slash=None):
+                 trailing_slash=None, method_dashified=None):
         """Registers a FlaskView class for use with a specific instance of a
         Flask app. Any methods not prefixes with an underscore are candidates
         to be routed and will have routes registered when this method is
@@ -81,6 +82,10 @@ def register(cls, app, route_base=None, subdomain=None, route_prefix=None,
         :param route_prefix: A prefix to be applied to all routes registered
                              for this class. Precedes route_base. Overrides
                              the class' route_prefix if it has been set.
+        :param trailing_slash: An option to put trailing slashes at the end of routes
+                               without parameters.
+        :param method_dashified: An option to dashify method name from some_route to /some-route/
+                                 route instead of default /some_route/
         """
 
         if cls is FlaskView:
@@ -104,6 +109,10 @@ def register(cls, app, route_base=None, subdomain=None, route_prefix=None,
             cls.orig_trailing_slash = cls.trailing_slash
             cls.trailing_slash = trailing_slash
 
+        if method_dashified is not None:
+            cls.orig_method_dashified = cls.method_dashified
+            cls.method_dashified = method_dashified
+
         members = get_interesting_members(FlaskView, cls)
 
         for name, value in members:
@@ -137,6 +146,8 @@ def register(cls, app, route_base=None, subdomain=None, route_prefix=None,
                     app.add_url_rule(rule, route_name, proxy, methods=methods, subdomain=subdomain)
 
                 else:
+                    if cls.method_dashified is True:
+                        name = _dashify_underscore(name)
                     route_str = '/{0!s}/'.format(name)
                     if not cls.trailing_slash:
                         route_str = route_str.rstrip('/')
@@ -157,6 +168,10 @@ def register(cls, app, route_base=None, subdomain=None, route_prefix=None,
             cls.trailing_slash = cls.orig_trailing_slash
             del cls.orig_trailing_slash
 
+        if hasattr(cls, "orig_method_dashified"):
+            cls.method_dashified = cls.orig_method_dashified
+            del cls.orig_method_dashified
+
     @classmethod
     def parse_options(cls, options):
         """Extracts subdomain and endpoint values from the options dict and returns
@@ -315,17 +330,11 @@ def get_route_base(cls):
 
     @classmethod
     def default_route_base(cls):
-        first_cap_re = re.compile('(.)([A-Z][a-z]+)')
-        all_cap_re = re.compile('([a-z0-9])([A-Z])')
-
-        def dashify(name): #TODO(hoatle): refactor this
-            s1 = first_cap_re.sub(r'\1-\2', name)
-            return all_cap_re.sub(r'\1-\2', s1).lower()
 
         if cls.__name__.endswith("View"):
-            route_base = dashify(cls.__name__[:-4])
+            route_base = _dashify_uppercase(cls.__name__[:-4])
         else:
-            route_base = dashify(cls.__name__)
+            route_base = _dashify_uppercase(cls.__name__)
 
         return route_base
 
@@ -340,6 +349,18 @@ def build_route_name(cls, method_name):
         return cls.__name__ + ":{0!s}".format(method_name)
 
 
+def _dashify_uppercase(name):
+    """convert somethingWithUppercase into something-with-uppercase"""
+    first_cap_re = re.compile('(.)([A-Z][a-z]+)') # better to define this once
+    all_cap_re = re.compile('([a-z0-9])([A-Z])')
+    s1 = first_cap_re.sub(r'\1-\2', name)
+    return all_cap_re.sub(r'\1-\2', s1).lower()
+
+def _dashify_underscore(name):
+    """convert something_with_underscore into something-with-underscore"""
+    return '-'.join(re.split('_', name))
+
+
 def get_interesting_members(base_class, cls):
     """Returns a list of methods that can be routed to"""
 

test_classful/test_method_dashified.py

@@ -0,0 +1,51 @@
+import json
+from flask import Flask
+from flask_classful import FlaskView, route
+from nose.tools import eq_
+
+
+class DashifiedDefaultView(FlaskView):
+
+    def some_route(self):
+        return "some route"
+
+
+class DashifiedAttributeView(FlaskView):
+    method_dashified = True
+
+    def another_route(self):
+        return "another route"
+
+class DashifiedAttributeOverrideView(FlaskView):
+    method_dashified = True
+
+    def yet_another_route(self):
+        return "yet another route"
+
+
+app = Flask('test-app')
+DashifiedDefaultView.register(app, method_dashified=True)
+DashifiedAttributeView.register(app)
+DashifiedAttributeOverrideView.register(app, method_dashified=False)
+client = app.test_client()
+
+
+def test_original_method_dashifield():
+    eq_(False, DashifiedDefaultView.method_dashified)
+    eq_(True, DashifiedAttributeView.method_dashified)
+    eq_(True, DashifiedAttributeOverrideView.method_dashified)
+
+
+def test_some_route():
+    resp = client.get('/dashified-default/some-route/')
+    eq_(b"some route", resp.data)
+
+
+def test_another_route():
+    resp = client.get('/dashified-attribute/another-route/')
+    eq_(b"another route", resp.data)
+
+
+def test_yet_another_route():
+    resp = client.get('/dashified-attribute-override/yet_another_route/')
+    eq_(b"yet another route", resp.data)

test_classful_py3/test_type_hints.py

@@ -1,5 +1,3 @@
-import sys
-
 import json
 from flask import Flask
 from flask_classful import FlaskView, route