Class: GraphQL::Client::QueryResult

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/client/query_result.rb

Overview

A QueryResult struct wraps data returned from a GraphQL response.

Wrapping the JSON-like Hash allows access with nice Ruby accessor methods rather than using ‘obj` access.

Wrappers also limit field visibility to fragment definitions.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(*args) ⇒ Object 



207
208
209
210
211
 
# File 'lib/graphql/client/query_result.rb', line 207

def method_missing(*args)
  super
rescue NoMethodError => e
  raise NoMethodError, "undefined method `#{e.name}' for #{inspect}"
end

Class Attribute Details

.fields ⇒ Object (readonly)

Returns the value of attribute fields.



108
109
110
 
# File 'lib/graphql/client/query_result.rb', line 108

def fields
  @fields
end

.source_node ⇒ Object (readonly)

Returns the value of attribute source_node.



106
107
108
 
# File 'lib/graphql/client/query_result.rb', line 106

def source_node
  @source_node
end

.type ⇒ Object (readonly)

Returns the value of attribute type.



104
105
106
 
# File 'lib/graphql/client/query_result.rb', line 104

def type
  @type
end

Instance Attribute Details

#__typename ⇒ Object (readonly) Also known as: typename

Returns the value of attribute __typename.



189
190
191
 
# File 'lib/graphql/client/query_result.rb', line 189

def __typename
  @__typename
end

#data ⇒ Object (readonly) Also known as: to_h

Returns the value of attribute data.



186
187
188
 
# File 'lib/graphql/client/query_result.rb', line 186

def data
  @data
end

#errors ⇒ Object (readonly)

Public: Return errors associated with data.

Returns Errors collection.



184
185
186
 
# File 'lib/graphql/client/query_result.rb', line 184

def errors
  @errors
end

Class Method Details

.[](name) ⇒ Object 



110
111
112
 
# File 'lib/graphql/client/query_result.rb', line 110

def [](name)
  fields[name]
end

.cast(obj, errors = Errors.new) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/graphql/client/query_result.rb', line 123

def self.cast(obj, errors = Errors.new)
  case obj
  when Hash
    new(obj, errors)
  when self
    obj
  when QueryResult
    spreads = Set.new(self.spreads(obj.class.source_node).map(&:name))

    unless spreads.include?(source_node.name)
      raise TypeError, "couldn't cast #{obj.inspect} to #{inspect}"
    end
    cast(obj.to_h, obj.errors)
  when Array
    List.new(obj.each_with_index.map { |e, idx| cast(e, errors.filter_by_path(idx)) }, errors)
  when NilClass
    nil
  else
    raise TypeError, obj.class.to_s
  end
end

.define(name:, source_node:, fields: {}, type: nil) ⇒ Object

Internal



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/graphql/client/query_result.rb', line 43

def self.define(name:, source_node:, fields: {}, type: nil)
  Class.new(self) do
    @name = name
    @type = type
    @source_node = source_node
    @fields = {}

    fields.each do |field, klass|
      @fields[field.to_sym] = klass

      send :attr_reader, field

      # Convert GraphQL camelcase to snake case: commitComments -> commit_comments
      field_alias = ActiveSupport::Inflector.underscore(field)
      send :alias_method, field_alias, field if field != field_alias

      class_eval <<-RUBY, __FILE__, __LINE__
        def #{field_alias}?
          #{field_alias} ? true : false
        end
      RUBY

      next unless field == "edges"
      class_eval <<-RUBY, __FILE__, __LINE__
        def each_node
          return enum_for(:each_node) unless block_given?
          edges.each { |edge| yield edge.node }
          self
        end
      RUBY
    end

    assigns = fields.map do |field, klass|
      if klass
        <<-RUBY
          @#{field} = self.class.fields[:#{field}].cast(@data["#{field}"], @errors.filter_by_path("#{field}"))
        RUBY
      else
        <<-RUBY
          @#{field} = @data["#{field}"]
        RUBY
      end
    end

    if @type && @type.is_a?(GraphQL::ObjectType)
      assigns.unshift "@__typename = self.class.type.name"
    end

    class_eval <<-RUBY, __FILE__, __LINE__
      def initialize(data, errors = Errors.new)
        @data = data
        @errors = errors

        #{assigns.join("\n")}
        freeze
      end
    RUBY
  end
end

.inspect ⇒ Object 



119
120
121
 
# File 'lib/graphql/client/query_result.rb', line 119

def self.inspect
  "#<#{name} fields=#{@fields.keys.inspect}>"
end

.name ⇒ Object 



115
116
117
 
# File 'lib/graphql/client/query_result.rb', line 115

def self.name
  @name || super || GraphQL::Client::QueryResult.name
end

.new(obj, *args) ⇒ Object 



159
160
161
162
163
164
165
166
 
# File 'lib/graphql/client/query_result.rb', line 159

def self.new(obj, *args)
  case obj
  when Hash
    super
  else
    cast(obj, *args)
  end
end

.spreads(node) ⇒ Object

Internal



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/graphql/client/query_result.rb', line 146

def self.spreads(node)
  node.selections.flat_map do |selection|
    case selection
    when Language::Nodes::FragmentSpread
      selection
    when Language::Nodes::InlineFragment
      spreads(selection)
    else
      []
    end
  end
end

.wrap(node, name: nil, types: {}) ⇒ Object

Internal: Get QueryResult class for result of query.

Returns subclass of QueryResult or nil.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/graphql/client/query_result.rb', line 20

def self.wrap(node, name: nil, types: {})
  fields = {}

  node.selections.each do |selection|
    case selection
    when Language::Nodes::FragmentSpread
      nil
    when Language::Nodes::Field
      field_name = selection.alias || selection.name
      field_klass = nil
      field_klass = wrap(selection, name: "#{name}[:#{field_name}]", types: types) if selection.selections.any?
      fields[field_name] ? fields[field_name] |= field_klass : fields[field_name] = field_klass
    when Language::Nodes::InlineFragment
      wrap(selection, name: name, types: types).fields.each do |fragment_name, klass|
        fields[fragment_name.to_s] ? fields[fragment_name.to_s] |= klass : fields[fragment_name.to_s] = klass
      end
    end
  end

  define(name: name, source_node: node, fields: fields, type: types[node] && types[node].unwrap)
end

.|(other) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/graphql/client/query_result.rb', line 168

def self.|(other)
  new_fields = fields.dup
  other.fields.each do |name, value|
    if new_fields[name]
      new_fields[name] |= value
    else
      new_fields[name] = value
    end
  end
  # TODO: Picking first source node seems error prone
  define(name: self.name, source_node: source_node, fields: new_fields)
end

Instance Method Details

#inspect ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/graphql/client/query_result.rb', line 192

def inspect
  ivars = self.class.fields.keys.map do |sym|
    value = instance_variable_get("@#{sym}")
    if value.is_a?(QueryResult)
      "#{sym}=#<#{value.class.name}>"
    else
      "#{sym}=#{value.inspect}"
    end
  end
  buf = "#<#{self.class.name}".dup
  buf << " " << ivars.join(" ") if ivars.any?
  buf << ">"
  buf
end

#respond_to_missing?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/graphql/client/query_result.rb', line 213

def respond_to_missing?(*args)
  super
end