Merge branch 'feat/sort'

kjdev · kjdev · commit e5dedb00b71b · 2021-11-26T11:30:54.000+09:00
diff --git a/README.md b/README.md
@@ -126,6 +126,7 @@ Get filtering result of the load string.
 * flags
 
   - `Jq::RAW` is raw output
+  - `Jq::SORT` is object with the keys in sorted order
 
 **Return Values:**
 
@@ -165,6 +166,7 @@ Get filtering result of the JSON string.
 * flags
 
   - `Jq::RAW` is raw output
+  - `Jq::SORT` is object with the keys in sorted order
 
 **Return Values:**
 
@@ -193,6 +195,7 @@ Get filtering result of the JSON file.
 * flags
 
   - `Jq::RAW` is raw output
+  - `Jq::SORT` is object with the keys in sorted order
 
 **Return Values:**
 
@@ -204,10 +207,10 @@ Returns the result value, or FALSE on error.
 
 ```php
 $jq = Jq\Input::fromString('{"name": "jq", "version": "0.1.0"}');
-print_r($jq->filter('.', JQ::RAW));
+print_r($jq->filter('.', Jq::RAW));
 echo PHP_EOL;
-echo 'NAME: ', $jq->filter('.name', JQ::RAW), PHP_EOL;
-echo 'VERSION: ', $jq->filter('.version', JQ::RAW), PHP_EOL;
+echo 'NAME: ', $jq->filter('.name', Jq::RAW), PHP_EOL;
+echo 'VERSION: ', $jq->filter('.version', Jq::RAW), PHP_EOL;
 ```
 
 The above example will output:
@@ -224,7 +227,7 @@ VERSION: 0.1.0
 $text = '{"name": "jq", "version": "0.1.0"}';
 print_r(Jq\Run::fromString($text, '.'));
 echo 'NAME: ', Jq\Run::fromString($text, '.name'), PHP_EOL;
-echo 'VERSION: ', Jq\Run::fromString($text, '.version', JQ::RAW), PHP_EOL;
+echo 'VERSION: ', Jq\Run::fromString($text, '.version', Jq::RAW), PHP_EOL;
 ```
 
 The above example will output:
diff --git a/jq.c b/jq.c
@@ -39,7 +39,8 @@ ZEND_INI_END()
 #define PHP_JQ_NS "Jq"
 
 enum {
-    PHP_JQ_OPT_RAW = 1
+    PHP_JQ_OPT_RAW = 1,
+    PHP_JQ_OPT_SORT = 2,
 };
 
 static zend_class_entry *zend_jq_exception_ce;
@@ -121,7 +122,7 @@ static int php_jq_load_file(jv *var, const char *file)
     return SUCCESS;
 }
 
-static void php_jv_dump(zval **return_value, jv x)
+static void php_jv_dump(zval **return_value, jv x, int flags)
 {
     switch (jv_get_kind(x)) {
         default:
@@ -170,7 +171,7 @@ static void php_jv_dump(zval **return_value, jv x)
                 jv value = jv_array_get(jv_copy(x), i);
                 if (jv_is_valid(value)) {
                     zval zv, *p = &zv;
-                    php_jv_dump(&p, value);
+                    php_jv_dump(&p, value, flags);
                     zend_hash_next_index_insert_new(Z_ARRVAL_P(*return_value),
                                                     &zv);
                 } else {
@@ -186,24 +187,40 @@ static void php_jv_dump(zval **return_value, jv x)
                 break;
             }
 
+            jv keyset = jv_null();
             while (1) {
                 jv key, value;
                 zval zv, *p = &zv;
                 zend_string *jv_key;
 
-                if (first) {
-                    i = jv_object_iter(x);
+                if (flags & PHP_JQ_OPT_SORT) {
+                    if (first) {
+                        keyset = jv_keys(jv_copy(x));
+                        i = 0;
+                    } else {
+                        i++;
+                    }
+                    if (i >= jv_array_length(jv_copy(keyset))) {
+                        jv_free(keyset);
+                        break;
+                    }
+                    key = jv_array_get(jv_copy(keyset), i);
+                    value = jv_object_get(jv_copy(x), jv_copy(key));
                 } else {
-                    i = jv_object_iter_next(x, i);
-                }
-                if (!jv_object_iter_valid(x, i)) {
-                    break;
-                }
+                    if (first) {
+                        i = jv_object_iter(x);
+                    } else {
+                        i = jv_object_iter_next(x, i);
+                    }
+                    if (!jv_object_iter_valid(x, i)) {
+                        break;
+                    }
 
-                key = jv_object_iter_key(x, i);
-                value = jv_object_iter_value(x, i);
+                    key = jv_object_iter_key(x, i);
+                    value = jv_object_iter_value(x, i);
+                }
 
-                php_jv_dump(&p, value);
+                php_jv_dump(&p, value, flags);
 
                 jv_key = zend_string_init(jv_string_value(key),
                                           jv_string_length_bytes(jv_copy(key)),
@@ -230,18 +247,22 @@ static void php_jq_filter(zval **return_value, jq_state *jq, jv json, int flags)
         int multiple = 0;
         while (1) {
             zval zv, *p = &zv;
-            if (flags == PHP_JQ_OPT_RAW) {
+            if (flags & PHP_JQ_OPT_RAW) {
                 if (jv_get_kind(result) == JV_KIND_STRING) {
                     ZVAL_STRING(&zv, jv_string_value(result));
                 } else {
-                    jv dump = jv_dump_string(result, 0);
+                    int dump_flags = 0;
+                    if (flags & PHP_JQ_OPT_SORT) {
+                        dump_flags = JV_PRINT_SORTED;
+                    }
+                    jv dump = jv_dump_string(result, dump_flags);
                     if (jv_is_valid(dump)) {
                         ZVAL_STRING(&zv, jv_string_value(dump));
                     }
                     jv_free(dump);
                 }
             } else {
-                php_jv_dump(&p, result);
+                php_jv_dump(&p, result, flags);
             }
 
             if (!jv_is_valid(result = jq_next(jq))) {
@@ -684,6 +705,7 @@ ZEND_MINIT_FUNCTION(jq)
 
     /* class constant */
     PHP_JQ_CLASS_CONST_LONG(RAW, PHP_JQ_OPT_RAW);
+    PHP_JQ_CLASS_CONST_LONG(SORT, PHP_JQ_OPT_SORT);
 
     /* ini */
     ZEND_INIT_MODULE_GLOBALS(jq, zend_jq_init_globals, NULL);
diff --git a/tests/sort.phpt b/tests/sort.phpt
@@ -0,0 +1,109 @@
+--TEST--
+sort
+--SKIPIF--
+--FILE--
+<?php
+use Jq\Input;
+use Jq\Run;
+
+$text = '{"c":"3", "a":"1", "b":{"2":{"z":"12", "y":"11", "x":"10"}}}';
+
+$jq = Jq\Input::fromString($text);
+
+echo "== default\n";
+print_r($jq->filter('.'));
+echo "== sort\n";
+print_r($jq->filter('.', Jq::SORT));
+
+echo "== raw\n";
+echo $jq->filter('.', Jq::RAW), PHP_EOL;
+echo "== raw|sort\n";
+echo $jq->filter('.', Jq::RAW|Jq::SORT), PHP_EOL;
+
+echo "== run\n";
+print_r(Run::fromString($text, '.'));
+echo "== run sort\n";
+print_r(Run::fromString($text, '.', Jq::SORT));
+
+echo "== run raw\n";
+echo Run::fromString($text, '.', Jq::RAW), PHP_EOL;
+echo "== run raw|sort\n";
+echo Run::fromString($text, '.', Jq::RAW|Jq::SORT), PHP_EOL;
+
+--EXPECTF--
+== default
+Array
+(
+    [c] => 3
+    [a] => 1
+    [b] => Array
+        (
+            [2] => Array
+                (
+                    [z] => 12
+                    [y] => 11
+                    [x] => 10
+                )
+
+        )
+
+)
+== sort
+Array
+(
+    [a] => 1
+    [b] => Array
+        (
+            [2] => Array
+                (
+                    [x] => 10
+                    [y] => 11
+                    [z] => 12
+                )
+
+        )
+
+    [c] => 3
+)
+== raw
+{"c":"3","a":"1","b":{"2":{"z":"12","y":"11","x":"10"}}}
+== raw|sort
+{"a":"1","b":{"2":{"x":"10","y":"11","z":"12"}},"c":"3"}
+== run
+Array
+(
+    [c] => 3
+    [a] => 1
+    [b] => Array
+        (
+            [2] => Array
+                (
+                    [z] => 12
+                    [y] => 11
+                    [x] => 10
+                )
+
+        )
+
+)
+== run sort
+Array
+(
+    [a] => 1
+    [b] => Array
+        (
+            [2] => Array
+                (
+                    [x] => 10
+                    [y] => 11
+                    [z] => 12
+                )
+
+        )
+
+    [c] => 3
+)
+== run raw
+{"c":"3","a":"1","b":{"2":{"z":"12","y":"11","x":"10"}}}
+== run raw|sort
+{"a":"1","b":{"2":{"x":"10","y":"11","z":"12"}},"c":"3"}
