Renaming order -> order_by (and fixing assert_not_orderable())

Author: adamcharnock

graphene/contrib/django/filter/filterset.py

@@ -25,7 +25,7 @@ def filter(self, qs, value):
         return super(GlobalIDMultipleChoiceFilter, self).filter(qs, gids)
 
 
-ORDER_BY_FIELD = getattr(settings, 'GRAPHENE_ORDER_BY_FIELD', 'order')
+ORDER_BY_FIELD = getattr(settings, 'GRAPHENE_ORDER_BY_FIELD', 'order_by')
 
 
 GRAPHENE_FILTER_SET_OVERRIDES = {

graphene/contrib/django/resolvers.py

@@ -36,8 +36,8 @@ def make_query(self):
         return query
 
     def get_filter_kwargs(self):
-        ignore = ['first', 'last', 'before', 'after', 'order']
+        ignore = ['first', 'last', 'before', 'after', 'order_by']
         return {k: v for k, v in self.args.items() if k not in ignore}
 
     def get_order(self):
-        return self.args.get('order', None)
+        return self.args.get('order_by', None)

graphene/contrib/django/tests/filter/test_fields.py

@@ -34,7 +34,7 @@ class Meta:
 
 
 def assert_arguments(field, *arguments):
-    ignore = ('after', 'before', 'first', 'last', 'order')
+    ignore = ('after', 'before', 'first', 'last', 'orderBy')
     actual = [
         name
         for name in field.arguments.arguments.keys()
@@ -48,12 +48,12 @@ def assert_arguments(field, *arguments):
 
 
 def assert_orderable(field):
-    assert 'order' in field.arguments.arguments.keys(), \
+    assert 'orderBy' in field.arguments.arguments.keys(), \
         'Field cannot be ordered'
 
 
 def assert_not_orderable(field):
-    assert 'order' in field.arguments.arguments.keys(), \
+    assert 'orderBy' not in field.arguments.arguments.keys(), \
         'Field can be ordered'
 
 
@@ -107,7 +107,7 @@ def test_filter_explicit_filterset_not_orderable():
 
 def test_filter_shortcut_filterset_extra_meta():
     field = DjangoFilterConnectionField(ArticleNode, extra_filter_meta={
-        'ordering': True
+        'order_by': True
     })
     assert_orderable(field)
 

graphene/contrib/django/tests/filter/test_resolvers.py

@@ -64,7 +64,7 @@ def test_filter_order():
     resolver = FilterConnectionResolver(ArticleNode,
                                         filterset_class=ArticleFilter)
     resolved = resolver(inst=article, args={
-        'order': 'headline'
+        'order_by': 'headline'
     }, info=None)
     assert 'WHERE' not in str(resolved.query)
     assert 'ORDER BY' in str(resolved.query)
@@ -76,7 +76,7 @@ def test_filter_order_not_available():
     resolver = FilterConnectionResolver(ReporterNode,
                                         filterset_class=ReporterFilter)
     resolved = resolver(inst=reporter, args={
-        'order': 'last_name'
+        'order_by': 'last_name'
     }, info=None)
     assert 'WHERE' not in str(resolved.query)
     assert 'ORDER BY' not in str(resolved.query)

graphene/contrib/django/tests/test_resolvers.py

@@ -51,7 +51,7 @@ def test_simple_order():
     reporter = Reporter(id=1, first_name='Cookie Monster')
     resolver = SimpleQuerySetConnectionResolver(ReporterNode)
     resolved = resolver(inst=reporter, args={
-        'order': 'last_name'
+        'order_by': 'last_name'
     }, info=None)
     assert 'WHERE' not in str(resolved.query)
     assert 'ORDER BY' in str(resolved.query)

graphene/contrib/django/utils.py

@@ -45,7 +45,8 @@ def get_filtering_args_from_filterset(filterset_class, type):
         args[name] = field_type
 
     # Also add the 'order_by' field
-    args[filterset_class.order_by_field] = Argument(String)
+    if filterset_class._meta.order_by:
+        args[filterset_class.order_by_field] = Argument(String)
     return args