gqli 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 972ad0f4a3e57ffe7e87a9492805b5d206ff0825ac335dbbf4a24b4981aed375
-  data.tar.gz: d60e39618526584c5291bfe1fa050e1639cc458e01d1038bb62e88693764c833
+  metadata.gz: 546f032ddd8089b8c2709b097dfcf42eedbfaa244fa487aed9d35240530c5a22
+  data.tar.gz: acbdf1e8755552a48a08085764dae8b53877a95e13e9cef1b875d58c3a5a4912
 SHA512:
-  metadata.gz: 40b7e0a94c6c543993131280bb00dc56e9d7600c9dc698970f66ccb3ff67613820c35199d60f74d7c2ec75417f52bd73ce528b9263193b70ed7e5a6498bc835f
-  data.tar.gz: 00c23e2e51019bcf85a608507062d0fb46662b008674e09c546aa6151bedbb45d3c4098fd0e7fcc247d39794d96315003544429a9dd097dda172bec6ee2f36d1
+  metadata.gz: 9220a899f2fa1acbcdef297b7dc86a3fd6480017e7dc004fe5f3ead83c10c4f1087eb9b37b3d74e9a7b89592191026ba22baa4f9740eb56c6293ec844f367788
+  data.tar.gz: 31ab9c1aeaa34d692bc5f0fd85066d58cb6f6f4625fa8b6b3800d73a1dee0b17fe03acdecee9551d2cc4bf19c4d9627d88ca9954aa791a3733ee3aacdaf090db

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## v0.5.0
+### Added
+* Add Enum support.
+
 ## v0.4.0
 ### Added
 * Add directive support.

data/README.md

@@ -319,6 +319,34 @@ query = GQLi::DSL.query {
 
 The difference is that by using the native implementation, in case of the condition not being met, the node will be completely not included in the outgoing query.
 
+### Enums
+
+[Enums](https://graphql.org/learn/schema/#enumeration-types) are a list of predefined values that are defined on the type system level.
+Since Ruby doesn't have built-in Enums that can be translated directly into GraphQL Enums, we created the `__enum` helper that you can use within your queries to transform
+your values into an Enum value.
+
+```ruby
+query = GQLi::DSL.query {
+  catCollection(order: __enum('lives_ASC')) {
+    items {
+      name
+    }
+  }
+}
+```
+
+This will render to:
+
+```graphql
+query {
+  catCollection(order: lives_ASC) {
+    items {
+      name
+    }
+  }
+}
+```
+
 ## Yet to be implemented
 
 * Mutation queries

data/lib/gqli/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './enum_value'
+
 module GQLi
   # Base class for GraphQL type wrappers
   class Base
@@ -28,6 +30,11 @@ module GQLi
       @__nodes << Node.new(name, params, __depth + 1, &block)
     end
 
+    # Creates an EnumType value
+    def __enum(value)
+      EnumValue.new(value)
+    end
+
     protected
 
     def __clone_nodes(node_container)

data/lib/gqli/dsl.rb

@@ -2,6 +2,7 @@
 
 require_relative './query'
 require_relative './fragment'
+require_relative './enum_value'
 
 module GQLi
   # GraphQL-like DSL methods
@@ -20,6 +21,13 @@ module GQLi
       Fragment.new(name, on, &block)
     end
 
+    # Creates a EnumValue object
+    #
+    # Can be used at a class level
+    def self.enum(value)
+      EnumValue.new(value)
+    end
+
     # Creates a Query object
     #
     # Can be used at an instance level
@@ -33,5 +41,12 @@ module GQLi
     def fragment(name, on, &block)
       Fragment.new(name, on, &block)
     end
+
+    # Creates a EnumValue object
+    #
+    # Can be used at an instance level
+    def enum(value)
+      EnumValue.new(value)
+    end
   end
 end

data/lib/gqli/enum_value.rb

@@ -11,7 +11,7 @@ module GQLi
 
     # Serializes the enum value to string
     def to_s
-      value
+      value.to_s
     end
   end
 end

data/lib/gqli/validation.rb

@@ -115,28 +115,32 @@ module GQLi
     end
 
     def value_type_error(is_type, should_be, for_arg)
-      fail "Value is '#{is_type}', but should be '#{should_be}' for '#{for_arg}'"
+      should_be = should_be.kind == 'ENUM' ? 'Enum' : should_be.name
+      additional_message = '. Wrap the value with `__enum`.' if should_be == 'Enum'
+
+      fail "Value is '#{is_type}', but should be '#{should_be}' for '#{for_arg}'#{additional_message}"
     end
 
     def validate_value_for_type(arg_type, value, for_arg)
       case value
-      when ::String
-        unless arg_type.name == 'String' || arg_type.kind == 'ENUM' || arg_type.name == 'ID'
-          value_type_error('String, Enum or ID', arg_type.name, for_arg)
-        end
-        if arg_type.kind == 'ENUM' && !arg_type.enumValues.map(&:name).include?(value)
+      when EnumValue
+        if arg_type.kind == 'ENUM' && !arg_type.enumValues.map(&:name).include?(value.to_s)
           fail "Invalid value for Enum '#{arg_type.name}' for '#{for_arg}'"
         end
+      when ::String
+        unless arg_type.name == 'String' || arg_type.name == 'ID'
+          value_type_error('String or ID', arg_type, for_arg)
+        end
       when ::Integer
-        value_type_error('Integer', arg_type.name, for_arg) unless arg_type.name == 'Int'
+        value_type_error('Integer', arg_type, for_arg) unless arg_type.name == 'Int'
       when ::Float
-        value_type_error('Float', arg_type.name, for_arg) unless arg_type.name == 'Float'
+        value_type_error('Float', arg_type, for_arg) unless arg_type.name == 'Float'
       when ::Hash
         validate_hash_value(arg_type, value, for_arg)
       when true, false
-        value_type_error('Boolean', arg_type.name, for_arg) unless arg_type.name == 'Boolean'
+        value_type_error('Boolean', arg_type, for_arg) unless arg_type.name == 'Boolean'
       else
-        value_type_error(value.class.name, arg_type.name, for_arg)
+        value_type_error(value.class.name, arg_type, for_arg)
       end
     end
 

data/lib/gqli/version.rb

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

data/spec/lib/gqli/client_spec.rb

@@ -26,6 +26,24 @@ describe GQLi::Client do
 
   let(:dsl) { GQLi::DSL }
 
+  describe 'query can call the client to execute' do
+    subject { client }
+
+    it '#__execute' do
+      vcr('catCollection') {
+        expect(
+          dsl.query {
+            catCollection {
+              items {
+                name
+              }
+            }
+          }.__execute(subject).data
+        ).not_to be_empty
+      }
+    end
+  end
+
   context 'validations enabled' do
     subject { client }
 

data/spec/lib/gqli/dsl_spec.rb

@@ -20,6 +20,7 @@ describe GQLi::DSL do
             someField
           }
         GRAPHQL
+        expect(query.to_gql).to eq query.to_s
       end
 
       it 'can create a query with a name' do
@@ -50,6 +51,15 @@ describe GQLi::DSL do
         GRAPHQL
       end
     end
+
+    describe '::enum' do
+      it 'can create an enum value' do
+        enum_value = subject.enum('foo')
+
+        expect(enum_value).to be_a GQLi::EnumValue
+        expect(enum_value.to_s).to eq 'foo'
+      end
+    end
   end
 
   describe 'instance level methods' do
@@ -97,6 +107,15 @@ describe GQLi::DSL do
         GRAPHQL
       end
     end
+
+    describe '#enum does the same as ::enum' do
+      it 'can create an enum value' do
+        enum_value = subject.enum('foo')
+
+        expect(enum_value).to be_a GQLi::EnumValue
+        expect(enum_value.to_s).to eq 'foo'
+      end
+    end
   end
 
   describe 'node DSL' do
@@ -259,5 +278,25 @@ describe GQLi::DSL do
         }
       GRAPHQL
     end
+
+    it '__enum can create EnumType values' do
+      query = subject.query {
+        catCollection(order: __enum('lives_ASC')) {
+          items {
+            name
+          }
+        }
+      }
+
+      expect(query.to_gql).to eq <<~GRAPHQL
+        query {
+          catCollection(order: lives_ASC) {
+            items {
+              name
+            }
+          }
+        }
+      GRAPHQL
+    end
   end
 end

data/spec/lib/gqli/introspection_spec.rb

@@ -153,7 +153,59 @@ describe GQLi::Introspection do
       validation = subject.validate(query)
       expect(validation.valid?).to be_falsey
       expect(validation.errors).not_to be_empty
-      expect(validation.errors.map(&:to_s)).to include("Value is 'String, Enum or ID', but should be 'Int' for 'limit'")
+      expect(validation.errors.map(&:to_s)).to include("Value is 'String or ID', but should be 'Int' for 'limit'")
+    end
+
+    describe 'enum values' do
+      it 'can create a query with an enum as a filter and validations should not fail' do
+        query = dsl.query {
+          catCollection(order: __enum('lives_ASC')) {
+            items {
+              name
+            }
+          }
+        }
+
+        expect(subject.valid?(query)).to be_truthy
+
+        validation = subject.validate(query)
+        expect(validation.valid?).to be_truthy
+        expect(validation.errors).to be_empty
+      end
+
+      it 'fails when enum value is not provided properly' do
+        query = dsl.query {
+          catCollection(order: 'lives_ASC') {
+            items {
+              name
+            }
+          }
+        }
+
+        expect(subject.valid?(query)).to be_falsey
+
+        validation = subject.validate(query)
+        expect(validation.valid?).to be_falsey
+        expect(validation.errors).not_to be_empty
+        expect(validation.errors.map(&:to_s)).to include("Value is 'String or ID', but should be 'Enum' for 'order'. Wrap the value with `__enum`.")
+      end
+
+      it 'fails when enum value is not provided properly and is not a string' do
+        query = dsl.query {
+          catCollection(order: 1) {
+            items {
+              name
+            }
+          }
+        }
+
+        expect(subject.valid?(query)).to be_falsey
+
+        validation = subject.validate(query)
+        expect(validation.valid?).to be_falsey
+        expect(validation.errors).not_to be_empty
+        expect(validation.errors.map(&:to_s)).to include("Value is 'Integer', but should be 'Enum' for 'order'. Wrap the value with `__enum`.")
+      end
     end
 
     describe 'directives' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gqli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http