GraphQL-Ruby Connection with Custom Arguments

custom_argument_connections.rb

# GraphQL-Ruby's connection system automatically adds first, last, after and before arguments. 
# If you don't want all of those, you have to disable the system with `connection: false`
# in the field definition, then re-enable it manually. 
#
# In this case, to create a field without the `last` argument, I created a custom subclass of `ConnectionExtension`
# which doesn't add any arguments. Then I add the specific arguments I want in the field definition. 
# (I could also add those arguments in `def apply` using `field.argument ...`.) 

require "bundler/inline"

gemfile do
  gem "graphql", "2.3.10"
end

class ExampleSchema < GraphQL::Schema
  class Thing < GraphQL::Schema::Object
    field :name, String
  end

  class ConnectionWithoutArgumentsExtension < GraphQL::Schema::Field::ConnectionExtension
    def apply
      # no-op -- don't add arguments
    end
  end

  class Query < GraphQL::Schema::Object
    field :things, Thing.connection_type, connection: false, extensions: [ConnectionWithoutArgumentsExtension] do
      argument :after, "String", "Returns the elements in the list that come after the specified cursor.", required: false
      argument :before, "String", "Returns the elements in the list that come before the specified cursor.", required: false
      argument :first, "Int", "Returns the first _n_ elements from the list.", required: false
    end

    def things
      [{name: "Abacus"}, {name: "Beach Ball"}, {name: "Costume"}, {name: "Dandelion"}]
    end
  end

  query(Query)
end


puts ExampleSchema.to_definition
###
# ...
#
# type Query {
#   things(
#     """
#     Returns the elements in the list that come after the specified cursor.
#     """
#     after: String

#     """
#     Returns the elements in the list that come before the specified cursor.
#     """
#     before: String

#     """
#     Returns the first _n_ elements from the list.
#     """
#     first: Int
#   ): ThingConnection
# }
#
# ...
###

pp ExampleSchema.execute("{ things(first: 2) { nodes { name } } }").to_h
# {"data"=>{"things"=>{"nodes"=>[{"name"=>"Abacus"}, {"name"=>"Beach Ball"}]}}}