Class: GraphQL::Client::QueryResult

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

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



173
174
175
176
177
# File 'lib/graphql/client/query_result.rb', line 173

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

Class Attribute Details

.fieldsObject (readonly)

Returns the value of attribute fields.



90
91
92
# File 'lib/graphql/client/query_result.rb', line 90

def fields
  @fields
end

.source_nodeObject (readonly)

Returns the value of attribute source_node.



86
87
88
# File 'lib/graphql/client/query_result.rb', line 86

def source_node
  @source_node
end

Instance Attribute Details

#dataObject (readonly) Also known as: to_h

Returns the value of attribute data.



162
163
164
# File 'lib/graphql/client/query_result.rb', line 162

def data
  @data
end

Class Method Details

.cast(obj) ⇒ Object



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/graphql/client/query_result.rb', line 101

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

    unless spreads.include?(source_node.name)
      message = "couldn't cast #{obj.inspect} to #{inspect}\n\n"
      suggestion = "\n  ...#{name || 'YourFragment'} # SUGGESTION"
      message << GraphQL::Language::Generation.generate(obj.class.source_node).sub(/\n}$/, "#{suggestion}\n}")
      raise TypeError, message
    end
    cast(obj.to_h)
  when Array
    obj.map { |e| cast(e) }
  when NilClass
    nil
  else
    raise TypeError, obj.class.to_s
  end
end

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

Internal



32
33
34
35
36
37
38
39
40
41
42
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
# File 'lib/graphql/client/query_result.rb', line 32

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

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

      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, type|
      if type
        <<-RUBY
          @#{field} = self.class.fields[:#{field}].cast(@data["#{field}"])
        RUBY
      else
        <<-RUBY
          @#{field} = @data["#{field}"]
        RUBY
      end
    end

    class_eval <<-RUBY, __FILE__, __LINE__
      def initialize(data)
        @data = data
        #{assigns.join("\n")}
        freeze
      end
    RUBY
  end
end

.inspectObject



97
98
99
# File 'lib/graphql/client/query_result.rb', line 97

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

.nameObject



93
94
95
# File 'lib/graphql/client/query_result.rb', line 93

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

.new(obj) ⇒ Object



140
141
142
143
144
145
146
147
# File 'lib/graphql/client/query_result.rb', line 140

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

.spreads(node) ⇒ Object

Internal



127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/graphql/client/query_result.rb', line 127

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) ⇒ Object

Internal: Get QueryResult class for result of query.

Returns subclass of QueryResult or nil.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/graphql/client/query_result.rb', line 11

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

  node.selections.each do |selection|
    case selection
    when Language::Nodes::FragmentSpread
    when Language::Nodes::Field
      field_name = selection.alias || selection.name
      field_klass = selection.selections.any? ? wrap(selection, name: "#{name}.#{field_name}") : nil
      fields[field_name] ? fields[field_name] |= field_klass : fields[field_name] = field_klass
    when Language::Nodes::InlineFragment
      wrap(selection, name: name).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)
end

.|(other) ⇒ Object



149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/graphql/client/query_result.rb', line 149

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

#inspectObject



165
166
167
168
169
170
171
# File 'lib/graphql/client/query_result.rb', line 165

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

#respond_to_missing?(*args) ⇒ Boolean

Returns:

  • (Boolean)


179
180
181
# File 'lib/graphql/client/query_result.rb', line 179

def respond_to_missing?(*args)
  super
end