Minor style fixes after array/map support

Author: Totktonada

README.md

@@ -52,10 +52,9 @@ sharded using tarantool/shard module.
 User should distinguish between Object and Map types. Both of them consists of
 keys and values but there are some important differences.
 
-While Object is a GraphQL
-built-in type, Map is a scalar-based type. In case of Object-based type
-all key-value pairs are set during type definition and values may have
-different types (as defined in the schema).
+While Object is a GraphQL built-in type, Map is a scalar-based type. In case of
+Object-based type all key-value pairs are set during type definition and values
+may have different types (as defined in the schema).
 
 In contrast, set of valid Map keys is not defined in the schema, any key-value
 pair is valid despite name of the key while value has schema-determined type
@@ -64,8 +63,8 @@ pair is valid despite name of the key while value has schema-determined type
 Map-based types should be queried as a scalar type, not as an object type
 (because map's keys are not part of the schema).
 
+The following example works:
 
-This works
 ```
 {
     …
@@ -74,7 +73,8 @@ This works
 }
 ```
 
-This doesn't work
+The following example doesn't work:
+
 ```
 {
     …
@@ -84,6 +84,7 @@ This doesn't work
     …
 }
 ```
+
 ## Run tests
 
 ```
@@ -94,7 +95,7 @@ make test
 
 ## Requirements
 
-* For use: tarantool, lulpeg, >=tarantool/shard-1.1-91-gfa88bf8 (optional), 
+* For use: tarantool, lulpeg, >=tarantool/shard-1.1-91-gfa88bf8 (optional),
   tarantool/avro-schema.
 * For test (additionally to 'for use'): python 2.7, virtualenv, luacheck.
 * For building apidoc (additionally to 'for use'): ldoc.

graphql/tarantool_graphql.lua

@@ -85,8 +85,7 @@ local types_map = types.scalar({
     description = 'Map is a dictionary with string keys and values of ' ..
         'arbitrary but same among all values type',
     serialize = function(value) return value end,
-    parseValue = function(value)return value end,
-    -- node == ast
+    parseValue = function(value) return value end,
     parseLiteral = function(node)
         if node.kind == 'Map' then
             return node.value
@@ -129,10 +128,11 @@ end
 
 --- Non-recursive version of the @{gql_type} function that returns
 --- InputObject instead of Object.
+---
 --- An error will be raised if avro_schema type is 'record'
---- and its' fields are not scalar type because currently
---- triple nesting level (record with record as a field - ok,
---- record with record which has inside another level - not ok).
+--- and its' fields have non-scalar types. So triple nesting level is not
+--- supported (record with record as a field - ok, record with record which
+--- has inside an another level - not ok).
 local function gql_argument_type(avro_schema)
     assert(avro_schema ~= nil,
         'avro_schema must not be nil')
@@ -267,7 +267,7 @@ end
 ---
 --- XXX As it is not clear now what to do with complex types inside arrays
 --- (just pass to results or allow to use filters), only scalar arrays
---- is allowed for now.
+--- is allowed for now. Note: map is considered scalar.
 gql_type = function(state, avro_schema, collection, collection_name)
     assert(type(state) == 'table',
         'state must be a table, got ' .. type(state))
@@ -424,11 +424,13 @@ gql_type = function(state, avro_schema, collection, collection_name)
             'values must not be nil in map avro schema')
         assert(type(avro_schema.values) == 'table'
             or type(avro_schema.values) == 'string',
-            ('avro_schema.values must be a table or a string,' ..
+            ('avro_schema.values must be a table or a string, ' ..
             'got %s (avro_schema %s)'):format(type(avro_schema.values),
             json.encode(avro_schema)))
 
+        -- validate avro schema format inside 'values'
         gql_type(state, avro_schema.values)
+
         local gql_map = types_map
         return avro_t == 'map' and types.nonNull(gql_map) or gql_map
     else

test/local/array_and_map_space_accessor.test.lua

@@ -30,27 +30,22 @@ local utils = require('graphql.utils')
 
 -- build accessor and graphql schemas
 -- ----------------------------------
-local accessor
-utils.show_trace(
-function()
-    accessor = graphql.accessor_space.new({
+local accessor = utils.show_trace(function()
+    return graphql.accessor_space.new({
         schemas = schemas,
         collections = collections,
         service_fields = service_fields,
         indexes = indexes,
     })
-end
-)
+end)
 
-local gql_wrapper
-utils.show_trace(function()
-    gql_wrapper = graphql.new({
+local gql_wrapper = utils.show_trace(function()
+    return graphql.new({
         schemas = schemas,
         collections = collections,
         accessor = accessor,
     })
-end
-)
+end)
 
 -- run queries
 -- -----------

test/local/simple_avro_array.test.lua

@@ -6,7 +6,6 @@ local fio = require('fio')
 package.path = fio.abspath(debug.getinfo(1).source:match("@?(.*/)")
     :gsub('/./', '/'):gsub('/+$', '')) .. '/../../?.lua' .. ';' .. package.path
 
-
 local json = require('json')
 local yaml = require('yaml')
 local graphql = require('graphql')
@@ -20,8 +19,8 @@ local schemas = json.decode([[{
             { "name": "user_id", "type": "string" },
             { "name": "favorite_food", "type": {"type": "array", "items": "string"} }
         ]
-        }
-    }]])
+    }
+}]])
 
 local collections = json.decode([[{
     "user_collection": {
@@ -95,3 +94,4 @@ utils.show_trace(function()
     print(('RESULT\n%s'):format(yaml.encode(result)))
 end)
 
+os.exit()

test/local/simple_avro_map.test.lua

@@ -74,11 +74,11 @@ local gql_wrapper_simple_accessor
 local query_with_map
 utils.show_trace(function()
     gql_wrapper_simple_accessor = graphql.new({
-    -- class_name:class mapping
+        -- class_name:class mapping
         schemas = schemas,
-    -- collection_{schema_name=..., connections=...} mapping
+        -- collection_{schema_name=..., connections=...} mapping
         collections = collections,
-    -- :select() and :list_args() provider
+        -- :select() and :list_args() provider
         accessor = simple_accessor,
     })
 
@@ -90,13 +90,13 @@ utils.show_trace(function()
             }
         }
     ]]
-
-end
-)
+end)
 
 utils.show_trace(function()
     local variables_2 = { user_id = 'def' }
     local gql_query_2 = gql_wrapper_simple_accessor:compile(query_with_map)
     local result = gql_query_2:execute(variables_2)
     print(('RESULT\n%s'):format(yaml.encode(result)))
 end)
+
+os.exit()