graphql-dsl 1.0.0

data/lib/graphql/dsl.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module DSL
+    ##
+    # Create executable GraphQL document
+    #
+    # @param block [Proc] declare DSL for operations
+    #
+    # @return [ExecutableDocument] executable GraphQL document
+    #
+    # @example Create executable document with several queries
+    #  executable_document = GraphQL::DSL.executable_document {
+    #    query(:sheep) {
+    #      animal(type: :sheep) {
+    #        __fragment :animal
+    #      }
+    #    }
+    #
+    #    query(:she_goats) {
+    #      animal(type: :she_goat) {
+    #        __fragment :animal
+    #      }
+    #    }
+    #
+    #    fragment(:animal, :Animal) {
+    #      name
+    #      age
+    #    }
+    #  }
+    #
+    #  puts executable_document.to_gql
+    #  # query sheep
+    #  # {
+    #  #   animal(type: "sheep")
+    #  #   {
+    #  #     ...animal
+    #  #   }
+    #  # }
+    #  #
+    #  # query she_goats
+    #  # {
+    #  #   animal(type: "she_goat")
+    #  #   {
+    #  #     ...animal
+    #  #   }
+    #  # }
+    #  #
+    #  # fragment animal on Animal
+    #  # {
+    #  #   name
+    #  #   age
+    #  # }
+    def executable_document(&block)
+      ExecutableDocument.new(&block)
+    end
+
+    module_function :executable_document
+
+    ##
+    # Create GraphQL query operation
+    #
+    # @param name [String, Symbol, nil] query name
+    # @param variable_definitions [Hash] variable definitions
+    # @param directives [Array] list of directives
+    # @param block [Proc] declare DSL for sub-fields
+    #
+    # @return [Operation] GraphQL query
+    #
+    # @example Create query
+    #   query = GraphQL::DSL.query(:sheep) {
+    #     animal(type: :sheep) {
+    #       name
+    #       age
+    #     }
+    #   }
+    #
+    #   puts query.to_gql
+    #   # query sheep
+    #   # {
+    #   #   animal(type: "sheep")
+    #   #   {
+    #   #     name
+    #   #     age
+    #   #   }
+    #   # }
+    def query(name = nil, variable_definitions = {}, directives = [], &block)
+      Operation.new(:query, name, variable_definitions, directives, &block)
+    end
+
+    module_function :query
+
+    ##
+    # Create GraphQL mutation operation
+    #
+    # @param name [String, Symbol, nil] mutation name
+    # @param variable_definitions [Hash] variable definitions
+    # @param directives [Array] list of directives
+    # @param block [Proc] declare DSL for sub-fields
+    #
+    # @return [Operation] GraphQL mutation
+    #
+    # @example Create mutation
+    #   mutation = GraphQL::DSL.mutation(:create_sheep) {
+    #     createSheep(name: 'Milly', age: 5) {
+    #       id
+    #       name
+    #       age
+    #     }
+    #   }
+    #
+    #   puts mutation.to_gql
+    #   # mutation create_sheep
+    #   # {
+    #   #   createSheep(name: "Milly", age: 5)
+    #   #   {
+    #   #     id
+    #   #     name
+    #   #     age
+    #   #   }
+    #   # }
+    def mutation(name = nil, variable_definitions = {}, directives = [], &block)
+      Operation.new(:mutation, name, variable_definitions, directives, &block)
+    end
+
+    module_function :mutation
+
+    ##
+    # Create GraphQL subscription operation
+    #
+    # @param name [String, Symbol, nil] subscription name
+    # @param variable_definitions [Hash] variable definitions
+    # @param directives [Array] list of directives
+    # @param block [Proc] declare DSL for sub-fields
+    #
+    # @return [Operation] GraphQL subscription
+    #
+    # @example Create subscription
+    #   subscription = GraphQL::DSL.subscription(:sheep_jumps) {
+    #     animal(type: :sheep) {
+    #       id
+    #       name
+    #       age
+    #     }
+    #   }
+    #
+    #   puts subscription.to_gql
+    #   # subscription sheep_jumps
+    #   # {
+    #   #   animal(type: "sheep")
+    #   #   {
+    #   #     id
+    #   #     name
+    #   #     age
+    #   #   }
+    #   # }
+    def subscription(name = nil, variable_definitions = {}, directives = [], &block)
+      Operation.new(:subscription, name, variable_definitions, directives, &block)
+    end
+
+    module_function :subscription
+
+    ##
+    # Create GraphQL fragment operation
+    #
+    # @param name [String, Symbol] fragment name
+    # @param type [String, Symbol] fragment type or interface
+    # @param directives [Array] list of directives
+    # @param block [Proc] declare DSL for sub-fields
+    #
+    # @return [FragmentOperation] GraphQL fragment
+    #
+    # @example Create fragment
+    #   fragment = GraphQL::DSL.fragment(:animal, :Animal) {
+    #     id
+    #     name
+    #     age
+    #   }
+    #
+    #   puts fragment.to_gql
+    #   # fragment animal on Animal
+    #   # {
+    #   #   id
+    #   #   name
+    #   #   age
+    #   # }
+    def fragment(name, type, directives = [], &block)
+      FragmentOperation.new(name, type, directives, &block)
+    end
+
+    module_function :fragment
+
+    # @!group Refinement Method Summary
+
+    ##
+    # @!method directive(name, **arguments)
+    # @!scope class
+    #
+    # Create GraphQL directive
+    #
+    # @param name [String, Symbol] directive name
+    # @param arguments [Hash] arguments
+    #
+    # @return Directive
+    refine Kernel do
+      def directive(name, **arguments)
+        Directive.new(name, **arguments)
+      end
+    end
+
+    ##
+    # @!method variable(type, default = UNDEFINED, *directives)
+    # @!scope class
+    #
+    # Create GraphQL variable
+    #
+    # @param type [String, Symbol] variable type
+    # @param default [Object, nil] default value
+    # @param directives [Array<Directive, Hash, Array>] list of directives
+    #
+    # @return VariableDefinition
+    refine Kernel do
+      def variable(type, default = UNDEFINED, *directives)
+        VariableDefinition.new(type, default, directives)
+      end
+    end
+
+    # @!endgroup
+  end
+end

data/lib/graphql-dsl.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'graphql_dsl'

data/lib/graphql_dsl.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'graphql/dsl'
+require 'graphql/dsl/constants'
+require 'graphql/dsl/error'
+require 'graphql/dsl/formatter/formatter'
+require 'graphql/dsl/formatter/arguments'
+require 'graphql/dsl/formatter/directives'
+require 'graphql/dsl/formatter/executable_document'
+require 'graphql/dsl/formatter/field'
+require 'graphql/dsl/formatter/fragment_operation'
+require 'graphql/dsl/formatter/fragment_spread'
+require 'graphql/dsl/formatter/inline_fragment'
+require 'graphql/dsl/formatter/operation'
+require 'graphql/dsl/formatter/values'
+require 'graphql/dsl/formatter/variable_definitions'
+require 'graphql/dsl/nodes/containers/directive'
+require 'graphql/dsl/nodes/containers/variable_definition'
+require 'graphql/dsl/nodes/mixins/selection_set'
+require 'graphql/dsl/nodes/node'
+require 'graphql/dsl/nodes/executable_document'
+require 'graphql/dsl/nodes/field'
+require 'graphql/dsl/nodes/fragment_operation'
+require 'graphql/dsl/nodes/fragment_spread'
+require 'graphql/dsl/nodes/inline_fragment'
+require 'graphql/dsl/nodes/operation'
+require 'graphql/dsl/version'
+
+##
+# Base module for GraphQL DSL gem
+module GraphQL
+  ##
+  # GraphQL DSL entry-point
+  module DSL
+  end
+end

data/tasks/readme/update.rake

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module ReadmeUpdater # rubocop:disable Style/Documentation
+  module_function
+
+  README_FILE = 'README.md'
+
+  VERSION_REGEXP = /gem 'graphql-dsl', '~> .+'/.freeze
+
+  RUBY_CODE_BLOCK = /
+    (?<ruby_block>
+      \p{Blank}*```ruby\n
+        (?<ruby_code>
+          # lines between ``` separators
+          (?:(?!\p{Blank}*```\n)[^\n]*\n)*?
+        )
+      \p{Blank}*```\n
+    )
+  /x.freeze
+
+  GRAPHQL_CODE_BLOCK = /
+    (?<graphql_block>
+      \p{Blank}*```graphql\n
+        (?<graphql_code>
+          # lines between ``` separators
+          (?:(?!\p{Blank}*```\n)[^\n]*\n)*?
+        )
+      \p{Blank}*```\n
+    )
+  /x.freeze
+
+  NONCOLLAPSABLE_EXAMPLE_REGEXP = /
+    (?<before>
+      #{RUBY_CODE_BLOCK}
+
+      \p{Blank}*\n
+    )
+
+    #{GRAPHQL_CODE_BLOCK}
+    (?<after>)
+  /x.freeze
+
+  COLLAPSABLE_EXAMPLE = %r{
+    (?<before>
+      #{RUBY_CODE_BLOCK}
+
+      \p{Blank}*\n
+
+      \p{Blank}*<details>\n
+      \p{Blank}*<summary>\w+?</summary>\n
+
+      \p{Blank}*\n
+    )
+
+    #{GRAPHQL_CODE_BLOCK}
+
+    (?<after>
+      \p{Blank}*</details>\n
+    )
+  }x.freeze
+
+  EXAMPLES_REGEXPS = [
+    NONCOLLAPSABLE_EXAMPLE_REGEXP,
+    COLLAPSABLE_EXAMPLE,
+  ].freeze
+
+  # FYI: lambda required to avoid restrictions of Ruby refinements i.e. impossible to call `module_eval`
+  # with refinement inside from method but possible from lambda.
+  EXECUTE_EXAMPLE_CODE = lambda do |example_code|
+    mod = Module.new do
+      extend GraphQL::DSL
+
+      def self.puts(obj)
+        "#{obj}\n"
+      end
+    end
+
+    mod.module_eval(example_code)
+  end
+
+  def update
+    readme = File.read(README_FILE)
+    readme = update_version(readme)
+    readme = update_examples(readme)
+
+    File.write(README_FILE, readme)
+  end
+
+  def check
+    original_readme = File.read(README_FILE)
+    updated_readme = update_version(original_readme)
+    updated_readme = update_examples(updated_readme)
+
+    return unless original_readme != updated_readme
+
+    abort 'Required update of README.md file. Run `rake readme:update` to update it.'
+  end
+
+  def update_version(readme)
+    readme.gsub(VERSION_REGEXP) do
+      "gem 'graphql-dsl', '~> #{GraphQL::DSL::VERSION}'"
+    end
+  end
+
+  def update_examples(readme)
+    EXAMPLES_REGEXPS.reduce(readme) do |str, regexp|
+      str.gsub(regexp) do
+        before_code = Regexp.last_match(:before)
+        after_code = Regexp.last_match(:after)
+        ruby_code = Regexp.last_match(:ruby_code)
+        graphql_block = Regexp.last_match(:graphql_block)
+
+        ruby_code_result = EXECUTE_EXAMPLE_CODE.call(ruby_code)
+
+        format_example(ruby_code_result, before_code, after_code, graphql_block)
+      end
+    end
+  end
+
+  def format_example(ruby_code_result, before_code, after_code, graphql_block)
+    indent = graphql_block[/\A\s*/]
+
+    [
+      before_code,
+      "```graphql\n".gsub(/^/, indent),
+      ruby_code_result.gsub(/^/, indent),
+      "```\n".gsub(/^/, indent),
+      after_code,
+    ].compact.join
+  end
+end
+
+namespace :readme do
+  desc 'Update README.md file (i.e. examples queries, etc.)'
+  task :update do
+    ReadmeUpdater.update
+  end
+
+  desc 'Check required changes of README.md file'
+  task :check do
+    ReadmeUpdater.check
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: graphql-dsl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maxim Dobryakov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ruby DSL for GraphQL
+email:
+- maxim.dobryakov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-dsl.gemspec
+- lib/graphql-dsl.rb
+- lib/graphql/dsl.rb
+- lib/graphql/dsl/constants.rb
+- lib/graphql/dsl/error.rb
+- lib/graphql/dsl/formatter/arguments.rb
+- lib/graphql/dsl/formatter/directives.rb
+- lib/graphql/dsl/formatter/executable_document.rb
+- lib/graphql/dsl/formatter/field.rb
+- lib/graphql/dsl/formatter/formatter.rb
+- lib/graphql/dsl/formatter/fragment_operation.rb
+- lib/graphql/dsl/formatter/fragment_spread.rb
+- lib/graphql/dsl/formatter/inline_fragment.rb
+- lib/graphql/dsl/formatter/operation.rb
+- lib/graphql/dsl/formatter/values.rb
+- lib/graphql/dsl/formatter/variable_definitions.rb
+- lib/graphql/dsl/nodes/containers/directive.rb
+- lib/graphql/dsl/nodes/containers/variable_definition.rb
+- lib/graphql/dsl/nodes/executable_document.rb
+- lib/graphql/dsl/nodes/field.rb
+- lib/graphql/dsl/nodes/fragment_operation.rb
+- lib/graphql/dsl/nodes/fragment_spread.rb
+- lib/graphql/dsl/nodes/inline_fragment.rb
+- lib/graphql/dsl/nodes/mixins/selection_set.rb
+- lib/graphql/dsl/nodes/node.rb
+- lib/graphql/dsl/nodes/operation.rb
+- lib/graphql/dsl/version.rb
+- lib/graphql_dsl.rb
+- tasks/readme/update.rake
+homepage: https://github.com/maxd/graphql-dsl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/maxd/graphql-dsl
+  source_code_uri: https://github.com/maxd/graphql-dsl
+  changelog_uri: https://github.com/maxd/graphql-dsl/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: GraphQL DSL
+test_files: []