graphql-dsl 1.0.0

data/lib/graphql/dsl/nodes/containers/directive.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Container for directive
+    class Directive
+      ##
+      # @return [String, Symbol, nil] directive name
+      attr_reader :name
+
+      ##
+      # @return [Hash] arguments
+      attr_reader :arguments
+
+      ##
+      # Create directive container
+      #
+      # @param name [String, Symbol] directive name
+      # @param arguments [Hash] arguments
+      def initialize(name, arguments = {})
+        raise Error, 'Variable name must be specified' if name.nil? || name.empty?
+
+        @name = name
+        @arguments = arguments
+      end
+
+      class << self
+        ##
+        # Create directive container from argument value
+        #
+        # @param value [] argument value
+        #
+        # @return [Directive] directive container
+        def from(value)
+          case value
+          when Directive then value
+          when Symbol, String then new(value)
+          else
+            raise Error.new('Unsupported format of directive', class: value.class.name, value: value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/containers/variable_definition.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Container for variable definition
+    class VariableDefinition
+      ##
+      # @return [String, Symbol, nil] variable type
+      attr_reader :type
+
+      ##
+      # @return [Object, nil] default value of variable
+      attr_reader :default
+
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :directives
+
+      ##
+      # Create variable definition container
+      #
+      # @param type [String, Symbol] variable type
+      # @param default [Object, nil] default value
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      def initialize(type, default = UNDEFINED, directives = [])
+        raise Error, 'Variable type must be specified' if type.nil? || type.empty?
+
+        @type = type
+        @default = default
+        @directives = directives.map { |directive| Directive.from(directive) }
+      end
+
+      class << self
+        ##
+        # Create variable definition container from argument value
+        #
+        # @param value [] argument value
+        #
+        # @return [VariableDefinition] variable definition container
+        def from(value)
+          case value
+          when VariableDefinition then value
+          when Symbol, String then new(value)
+          else
+            raise Error.new('Unsupported format of variable definition', class: value.class.name, value: value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/executable_document.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Executable document GraphQL node
+    class ExecutableDocument < Node
+      ##
+      # Create executable document
+      #
+      # @param block [Proc] declare DSL for operations
+      def initialize(&block)
+        super(nil, &block)
+      end
+
+      ##
+      # Create GraphQL query operation
+      #
+      # @param name [String, Symbol, nil] query name
+      # @param variable_definitions [Hash] variable definitions
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      #
+      # @return [void]
+      def query(name = nil, variable_definitions = {}, directives = [], &block)
+        @__nodes << Operation.new(:query, name, variable_definitions, directives, &block)
+      end
+
+      ##
+      # Create GraphQL mutation operation
+      #
+      # @param name [String, Symbol, nil] mutation name
+      # @param variable_definitions [Hash] variable definitions
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      #
+      # @return [void]
+      def mutation(name = nil, variable_definitions = {}, directives = [], &block)
+        @__nodes << Operation.new(:mutation, name, variable_definitions, directives, &block)
+      end
+
+      ##
+      # Create GraphQL subscription operation
+      #
+      # @param name [String, Symbol, nil] subscription name
+      # @param variable_definitions [Hash] variable definitions
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      #
+      # @return [void]
+      def subscription(name = nil, variable_definitions = {}, directives = [], &block)
+        @__nodes << Operation.new(:subscription, name, variable_definitions, directives, &block)
+      end
+
+      ##
+      # Create GraphQL fragment operation
+      #
+      # @param name [String, Symbol] fragment name
+      # @param type [String, Symbol] fragment type or interface
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      #
+      # @return [void]
+      def fragment(name, type, directives = [], &block)
+        @__nodes << FragmentOperation.new(name, type, directives, &block)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/field.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Field GraphQL node
+    class Field < Node
+      include SelectionSet
+
+      ##
+      # @return [String, Symbol, nil] field alias
+      attr_reader :__alias
+
+      ##
+      # @return [Hash] list of filed arguments
+      attr_reader :__arguments
+
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :__directives
+
+      ##
+      # Create field
+      #
+      # @param field_name [String, Symbol] field name
+      # @param field_alias [String, Symbol, nil] field alias
+      # @param arguments [Hash] field arguments
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      def initialize(field_name, field_alias = nil, arguments = {}, directives = [], &block)
+        @__alias = field_alias
+        @__arguments = arguments
+        @__directives = directives.map { |directive| Directive.from(directive) }
+
+        super(field_name, &block)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/fragment_operation.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Fragment operation GraphQL node
+    class FragmentOperation < Node
+      include SelectionSet
+
+      ##
+      # @return [String, Symbol] fragment type or interface
+      attr_reader :__type
+
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :__directives
+
+      ##
+      # Create fragment operation
+      #
+      # @param name [String, Symbol] fragment name
+      # @param type [String, Symbol] fragment type or interface
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      def initialize(name, type, directives = [], &block)
+        raise Error, '`name` must be specified' if name.nil? || name.empty?
+        raise Error, '`type` must be specified' if type.nil? || type.empty?
+
+        @__type = type
+        @__directives = directives.map { |directive| Directive.from(directive) }
+
+        super(name, &block)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/fragment_spread.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Fragment spread GraphQL node
+    class FragmentSpread < Node
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :__directives
+
+      ##
+      # Create fragment spread
+      #
+      # @param name [String, Symbol] fragment name
+      # @param directives [Array<Hash, Array, Directive>] list of directives
+      def initialize(name, directives = [])
+        @__directives = directives.map { |directive| Directive.from(directive) }
+
+        super(name)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/inline_fragment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Inline fragment GraphQL node
+    class InlineFragment < Node
+      include SelectionSet
+
+      ##
+      # @return [String, Symbol, nil] inline fragment type or interface
+      attr_reader :__type
+
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :__directives
+
+      ##
+      # Create inline fragment
+      #
+      # @param type [String, Symbol, nil] fragment type
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      def initialize(type = nil, directives = [], &block)
+        raise Error, 'Sub-fields must be specified for inline fragment' if block.nil?
+
+        @__type = type
+        @__directives = directives.map { |directive| Directive.from(directive) }
+
+        super(nil, &block)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/mixins/selection_set.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # This mixin help to reuse selections sets
+    module SelectionSet
+      ##
+      # Declare new GraphQL field
+      #
+      # This method can help to avoid name collisions i.e. +__field(:object_id)+
+      #
+      # @param name [String, Symbol] field name
+      # @param __alias [String, Symbol, nil] field alias
+      # @param __directives [Array] list of directives
+      # @param arguments [Hash] field arguments
+      # @param block [Proc] declare sub-fields
+      #
+      # @return [void]
+      #
+      # @example Declare fields use __field method (i.e. use GraphQL query)
+      #   query = GraphQL::DSL.query {
+      #     __field(:field1, id: 1) {
+      #       __field(:subfield1, id: 1)
+      #       __field(:subfield2, id: 2)
+      #     }
+      #   }
+      #
+      # @example Declare fields use DSL (i.e. use GraphQL query)
+      #   query = GraphQL::DSL.query {
+      #     field1 id: 1 {
+      #       subfield1 id: 1
+      #       subfield2 id: 2
+      #     }
+      #   }
+      def __field(name, __alias: nil, __directives: [], **arguments, &block) # rubocop:disable Lint/UnderscorePrefixedVariableName
+        @__nodes << Field.new(name, __alias, arguments, __directives, &block)
+      end
+
+      ###
+      # Insert GraphQL fragment
+      #
+      # @param name [String, Symbol] fragment name
+      # @param __directives [Array] list of directives
+      #
+      # @return [void]
+      #
+      # @example Insert fragment with +fragment1+ name
+      #   query = GraphQL::DSL.query {
+      #     field1 id: 1 {
+      #       __fragment :fragment1
+      #     }
+      #   }
+      def __fragment(name, __directives: []) # rubocop:disable Lint/UnderscorePrefixedVariableName
+        @__nodes << FragmentSpread.new(name, __directives)
+      end
+
+      ###
+      # Insert GraphQL inline fragment
+      #
+      # @param type [String, Symbol, nil] fragment type
+      # @param __directives [Array] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      #
+      # @return [void]
+      def __inline_fragment(type, __directives: [], &block) # rubocop:disable Lint/UnderscorePrefixedVariableName
+        @__nodes << InlineFragment.new(type, __directives, &block)
+      end
+
+      private
+
+      ##
+      # Allow to respond to method missing at any case.
+      def respond_to_missing?(_method_name, _include_private = false)
+        true
+      end
+
+      ##
+      # Declare new GraphQL field
+      #
+      # @example Declare fields (i.e. use GraphQL query)
+      #   query = GraphQL::DSL.query {
+      #     items {
+      #       id
+      #       title
+      #     }
+      #   }
+      #
+      #   puts query.to_gql
+      #   # {
+      #   #   items
+      #   #   {
+      #   #      id
+      #   #      title
+      #   #   }
+      #   # }
+      #
+      # @see #__field
+      def method_missing(name, *args, &block)
+        arguments = args.empty? ? {} : args[0]
+
+        __field(name, **arguments, &block)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/node.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # @abstract Base class for all GraphQL DSL nodes
+    class Node
+      ##
+      # @return [String, Symbol, nil] node name
+      attr_reader :__name
+
+      # @return [Array<Node>] list of sub-nodes
+      attr_reader :__nodes
+
+      ##
+      # Create node
+      #
+      # @param name [String, Symbol, nil] node name
+      # @param block [Proc] declare  DSL for sub-nodes
+      def initialize(name = nil, &block)
+        @__name = name
+        @__nodes = []
+
+        instance_eval(&block) if block
+      end
+
+      ##
+      # Generate GraphQL query
+      #
+      # @param level [Integer] indent level
+      # @param formatter [Formatter] GraphQL query formatter
+      #
+      # @return [String] GraphQL query string
+      def to_gql(level = 0, formatter = Formatter.new)
+        formatter.format_node(self, level)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/nodes/operation.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Operation GraphQL node
+    class Operation < Node
+      include SelectionSet
+
+      ##
+      # @return [Symbol] operation type (see {#initialize})
+      attr_reader :__operation_type
+
+      ##
+      # @return [Hash<Symbol, VariableDefinition>] variable definitions
+      attr_reader :__variable_definitions
+
+      ##
+      # @return [Array<Directive>] list of directives
+      attr_reader :__directives
+
+      ##
+      # Create operation (query, mutation, subscription)
+      #
+      # @param operation_type [Symbol] operation type
+      # @option operation_type [Symbol] :query query operation
+      # @option operation_type [Symbol] :mutation mutation operation
+      # @option operation_type [Symbol] :subscription subscription operation
+      # @param name [String, Symbol, nil] operation name
+      # @param variable_definitions [Hash] variable definitions
+      # @param directives [Array<Directive, Hash, Array>] list of directives
+      # @param block [Proc] declare DSL for sub-fields
+      def initialize(operation_type, name = nil, variable_definitions = {}, directives = [], &block)
+        variable_definitions.each do |variable_name, _|
+          raise Error, 'Variable name must be specified' if variable_name.nil? || variable_name.empty?
+        end
+
+        @__operation_type = operation_type
+        @__variable_definitions = variable_definitions.transform_values do |variable_definition|
+          VariableDefinition.from(variable_definition)
+        end
+        @__directives = directives.map { |directive| Directive.from(directive) }
+
+        super(name, &block)
+      end
+
+      ##
+      # Declare operation variable
+      #
+      # @param name [Symbol, String] variable name
+      # @param type [Symbol, String] variable type
+      # @param directives [Array<Directive, Hash, Array>] variable directives
+      # @param default [Object] variable default value
+      #
+      # @return [void]
+      def __var(name, type, default: UNDEFINED, directives: [])
+        @__variable_definitions[name] = VariableDefinition.new(type, default, directives)
+      end
+    end
+  end
+end

data/lib/graphql/dsl/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Gem version
+    VERSION = '1.0.0'
+  end
+end