gqli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a92aeb50f3395eeb402d70097e5a90b95f78c8ccf9971c92635f4423748a52b
-  data.tar.gz: 49d4f4186b14b60b38383e0436940049e6c489857854652daff112ec9e5f94d8
+  metadata.gz: 2d34056882c2b95aeff8c3c1ff8155c0ebe1018480085e3a00ab84653124fc51
+  data.tar.gz: b32f2fd8fe6acd08587e71e36d11d7aedde72e3b30e106a10e9de017a3d9c908
 SHA512:
-  metadata.gz: f1b611ab9b505ed267a4c0ecb943d357fc250f4221a07351b3b8ea5dd9968cba1d03aea84b64d9c727719cb1acc3f74aec12dda3f14b6f8ab82fd5aba786b23d
-  data.tar.gz: f314024396af8dab242f65136da3cd42248976824454ca105d84390902f8b974c6c0c776c4e76b2f7bc60853dcb8d88e09ad0787690d0fc087cfd6113f896050
+  metadata.gz: 55f5936ee3d57ca83373627034f70f081cc599358f24328017f3e97f25d7e97de247cf3ce4292ce2b68ff5435110b118d24f6273ab3001fcabeb5868f2d74733
+  data.tar.gz: fa00c085ab0f2bc8d669425b769e0a7699fe6065024d5c6768dfa78a5f1934347bd95bcd1981689a4d9b41473739568c33f55ca6fd276fcb182547a9a3f9f226

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 2.4.0
+  - 2.5.1
+  - 2.4.1
   - 2.3.1
-  - 2.2.1
 notifications:
   slack:
     secure: Zr3mKCiTb0vaTD4MPtTG8BbyYyErFuoxioM25QyrqePKVkDFeZC1MtGmg5klQQrJiWTKZPa/zB8NAHYkoUxg9I+z15JK0hYfz9KRubEpCrXCaqTC9Vzq88kJ3LN8YsTyBF66izaBH2KLsOfaJRxwplFzZqgpg4GG2DUBPtrGtes=

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## Unreleased
+
+## v0.2.0
+### Added
+* Added `__node` to be able to create nodes in case there's a name collision with a reserved keyword or a built-in method.
+
 ## v0.1.0
 
 Initial Release

data/README.md

@@ -146,7 +146,7 @@ puts response.query.to_gql
 puts
 puts "Response received"
 response.data.catCollection.items.each do |c|
-  puts "Name:    #{c.nam}e"
+  puts "Name:    #{c.name}"
   puts "Likes:   #{c.likes.join(", ")}"
   puts "Lives #: #{c.lives}"
   c.bestFriend.tap do |bf|
@@ -183,7 +183,7 @@ query {
 }
 
 Response received
-Name:    e
+Name:    Happy Cat
 Likes:   cheezburger
 Lives #: 1
 Best Friend:
@@ -261,6 +261,36 @@ end
 response = ContentfulClient.new.cats(5)
 ```
 
+### Dealing with name collisions
+
+By defining queries via a DSL, you may sometimes find that the fields you query for are also the names of built-in methods or reserved keywords of the language.
+
+To avoid collisions you can use the `__node` helper, for example:
+
+```ruby
+query = GQLi::DSL.query {
+  catCollection {
+    items {
+      sys {
+        __node('id')
+      }
+    }
+  }
+}
+```
+
+The helper method `__node`, can also receive arguments and have children nodes as expected from any other node declaration, for example:
+
+```
+query = GQLi::DSL.query {
+  __node('catCollection', limit: 5) {
+    items {
+      name
+    }
+  }
+}
+```
+
 ## Yet to be implemented
 
 * Mutation queries

data/lib/gqli/base.rb

@@ -20,7 +20,13 @@ module GQLi
     # Adds type match node
     def __on(type_name, &block)
       require_relative './node'
-      @__nodes << Node.new("... on #{type_name}", [], __depth + 1, &block)
+      @__nodes << Node.new("... on #{type_name}", {}, __depth + 1, &block)
+    end
+
+    # Adds children node into current node
+    def __node(name, params = {}, &block)
+      require_relative './node'
+      @__nodes << Node.new(name, params, __depth + 1, &block)
     end
 
     protected

data/lib/gqli/version.rb

@@ -3,5 +3,5 @@
 # GraphQL Client and DSL library
 module GQLi
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/lib/gqli/dsl_spec.rb

@@ -201,5 +201,49 @@ describe GQLi::DSL do
         }
       GRAPHQL
     end
+
+    it 'can use __node to define nodes that would collide otherwise' do
+      query = subject.query {
+        catCollection {
+          items {
+            sys {
+              __node('id')
+            }
+          }
+        }
+      }
+
+      expect(query.to_gql).to eq <<~GRAPHQL
+        query {
+          catCollection {
+            items {
+              sys {
+                id
+              }
+            }
+          }
+        }
+      GRAPHQL
+    end
+
+    it '__node can receive arguments and children nodes' do
+      query = subject.query {
+        __node('catCollection', limit: 1) {
+          items {
+            name
+          }
+        }
+      }
+
+      expect(query.to_gql).to eq <<~GRAPHQL
+        query {
+          catCollection(limit: 1) {
+            items {
+              name
+            }
+          }
+        }
+      GRAPHQL
+    end
   end
 end

data/usage.rb

@@ -88,7 +88,7 @@ puts response.query.to_gql
 puts
 puts "Response received"
 response.data.catCollection.items.each do |c|
-  puts "Name:    #{c.nam}e"
+  puts "Name:    #{c.name}"
   puts "Likes:   #{c.likes.join(", ")}"
   puts "Lives #: #{c.lives}"
   c.bestFriend.tap do |bf|

data/usage_introspection.rb

@@ -45,7 +45,7 @@ puts response.query.to_gql
 puts
 puts "Response received"
 response.data.catCollection.items.each do |c|
-  puts "Name:    #{c.nam}e"
+  puts "Name:    #{c.name}"
   puts "Likes:   #{c.likes.join(", ")}"
   puts "Lives #: #{c.lives}"
   c.bestFriend.tap do |bf|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gqli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http