Module: Graphiform::Core::ClassMethods

Defined in:
lib/graphiform/core.rb

Instance Method Summary collapse

Instance Method Details

#flush_pending_filters! ⇒ Object 



328
329
330
331
332
333
334
335
336
 
# File 'lib/graphiform/core.rb', line 328

def flush_pending_filters!
  return if @graphiform_pending_filters.nil? || @graphiform_pending_filters.empty?

  pending = @graphiform_pending_filters
  @graphiform_pending_filters = []
  pending.each do |(name, identifier, options)|
    graphql_add_scopes_to_filter(name, identifier, **options)
  end
end

#flush_pending_groupings! ⇒ Object 



348
349
350
351
352
353
354
355
356
 
# File 'lib/graphiform/core.rb', line 348

def flush_pending_groupings!
  return if @graphiform_pending_groupings.nil? || @graphiform_pending_groupings.empty?

  pending = @graphiform_pending_groupings
  @graphiform_pending_groupings = []
  pending.each do |(name, identifier, options)|
    graphql_field_to_grouping(name, identifier, **options)
  end
end

#flush_pending_sorts! ⇒ Object 



338
339
340
341
342
343
344
345
346
 
# File 'lib/graphiform/core.rb', line 338

def flush_pending_sorts!
  return if @graphiform_pending_sorts.nil? || @graphiform_pending_sorts.empty?

  pending = @graphiform_pending_sorts
  @graphiform_pending_sorts = []
  pending.each do |(name, identifier, options)|
    graphql_field_to_sort(name, identifier, **options)
  end
end

#graphiform_pending_filters ⇒ Object

— Pending queues for lazy filter/sort/grouping wiring ————-

graphql_readable_field pushes entries here instead of immediately invoking add_scope_def_to_filter / graphql_field_to_sort / graphql_field_to_grouping. The queues are drained the first time the corresponding builder is accessed.



316
317
318
 
# File 'lib/graphiform/core.rb', line 316

def graphiform_pending_filters
  @graphiform_pending_filters ||= []
end

#graphiform_pending_groupings ⇒ Object 



324
325
326
 
# File 'lib/graphiform/core.rb', line 324

def graphiform_pending_groupings
  @graphiform_pending_groupings ||= []
end

#graphiform_pending_sorts ⇒ Object 



320
321
322
 
# File 'lib/graphiform/core.rb', line 320

def graphiform_pending_sorts
  @graphiform_pending_sorts ||= []
end

#graphql_base_resolver ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/graphiform/core.rb', line 151

def graphql_base_resolver
  unless defined? @base_resolver
    @base_resolver = Helpers.get_const_or_create(demodulized_name, ::Resolvers) do
      Class.new(::Resolvers::BaseResolver) do
        attr_reader :value

        class << self
          attr_accessor :addon_resolve_blocks
        end

        def self.addon_resolve(&block)
          @addon_resolve_blocks ||= []
          @addon_resolve_blocks << block
        end

        def resolve(**args)
          @value = base_resolve(**args)

          if self.class.addon_resolve_blocks.present? && !self.class.addon_resolve_blocks.empty?
            self.class.addon_resolve_blocks.each do |addon_resolve_block|
              @value = instance_exec(**args, &addon_resolve_block)
            end
          end

          @value
        end

        def apply_built_ins(where: nil, sort: nil, group: nil, **)
          @value = Graphiform::ScopeComposer.compose(@value, where: where, sort: sort, group: group)
        end

        # Default resolver - meant to be overridden
        def base_resolve(**)
          object
        end
      end
    end

    local_graphql_filter = graphql_filter
    local_graphql_sort = graphql_sort
    local_graphql_grouping = graphql_grouping

    model = self
    @base_resolver.class_eval do
      unless respond_to?(:model)
        define_method :model do
          model
        end
      end

      argument :where, local_graphql_filter, required: false
      argument :sort, local_graphql_sort, required: false unless local_graphql_sort.own_arguments.empty?
      argument :group, local_graphql_grouping, required: false unless local_graphql_grouping.own_arguments.empty?
    end
  end

  @base_resolver
end

#graphql_connection ⇒ Object 



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/graphiform/core.rb', line 140

def graphql_connection
  connection_name = "#{demodulized_name}Connection"
  Helpers.get_const_or_create(connection_name, ::Types) do
    edge_type = graphql_edge
    Class.new(::Types::BaseConnection) do
      graphql_name connection_name
      edge_type(edge_type)
    end
  end
end

#graphql_connection_query ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/graphiform/core.rb', line 225

def graphql_connection_query
  Helpers.get_const_or_create(demodulized_name, ::Resolvers::ConnectionQueries) do
    connection_type = graphql_connection
    Class.new(graphql_base_resolver) do
      type connection_type, null: false

      def base_resolve(**args)
        @value = model.all
        apply_built_ins(**args)
      end
    end
  end
end

#graphql_create_association_resolver(association_def, resolver_type, null: true, skip_dataloader: false) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/graphiform/core.rb', line 277

def graphql_create_association_resolver(association_def, resolver_type, null: true, skip_dataloader: false, **)
  Class.new(::Resolvers::BaseResolver) do
    type resolver_type, null: null

    define_method :resolve do |*|
      skip_dataloader ||= !Helpers.dataloader_support?(dataloader, association_def)
      return object.public_send(association_def.name) if skip_dataloader

      dataloader.with(
        Graphiform::PreloaderSource,
        association_def.name,
        klass: association_def.klass,
        scope: association_def.scope
      ).load(object)
    end
  end
end

#graphql_create_enum(enum_name) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/graphiform/core.rb', line 295

def graphql_create_enum(enum_name)
  enum_name = enum_name.to_s
  enum_options = defined_enums[enum_name] || {}

  enum_class_name = "#{demodulized_name}#{enum_name.pluralize.capitalize}"
  Helpers.get_const_or_create(enum_class_name, ::Enums) do
    Class.new(::Enums::BaseEnum) do
      enum_options.each_key do |key|
        value key
      end
    end
  end
end

#graphql_create_resolver(method_name, resolver_type = graphql_type, read_prepare: nil, read_resolve: nil, null: true, skip_dataloader: false) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/graphiform/core.rb', line 239

def graphql_create_resolver(method_name, resolver_type = graphql_type, read_prepare: nil, read_resolve: nil, null: true, skip_dataloader: false, **)
  Class.new(graphql_base_resolver) do
    type resolver_type, null: null

    define_method :base_resolve do |**args|
      @value = object

      association_def = @value.association(method_name)&.reflection

      skip_dataloader ||=
        !association_def ||
        !Helpers.dataloader_support?(dataloader, association_def) ||
        read_resolve ||
        read_prepare ||
        args[:group]

      if skip_dataloader
        @value = instance_exec(@value, context, &read_resolve) if read_resolve
        @value = @value.public_send(method_name) if !read_resolve && @value.respond_to?(method_name)
        @value = instance_exec(@value, context, &read_prepare) if read_prepare

        apply_built_ins(**args)
      else
        dataloader
          .with(
            Graphiform::PreloaderSource,
            association_def.name,
            klass: association_def.klass,
            scope: association_def.scope,
            where: args[:where],
            sort: args[:sort],
          )
          .load(@value)
      end
    end
  end
end

#graphql_edge ⇒ Object 



131
132
133
134
135
136
137
138
 
# File 'lib/graphiform/core.rb', line 131

def graphql_edge
  Helpers.get_const_or_create("#{demodulized_name}Edge", ::Types) do
    node_type = graphql_type
    Class.new(::Types::BaseEdge) do
      node_type(node_type)
    end
  end
end

#graphql_filter ⇒ Object 



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
 
# File 'lib/graphiform/core.rb', line 44

def graphql_filter
  unless defined? @filter
    local_demodulized_name = demodulized_name
    model_class = self
    @filter = Helpers.get_const_or_create(local_demodulized_name, ::Inputs::Filters) do
      Class.new(::Inputs::Filters::BaseFilter) do
        graphql_name "#{local_demodulized_name}Filter"

        define_singleton_method(:arguments) do |context = nil|
          model_class.send(:flush_pending_filters!)
          super(context)
        end

        define_singleton_method(:own_arguments) do
          model_class.send(:flush_pending_filters!)
          super()
        end
      end
    end
    @filter.class_eval do
      argument_class Graphiform.configuration[:argument_class] if Graphiform.configuration[:argument_class].present?
    end
    Helpers.add_unless_exists(@filter, 'OR')  { @filter.class_eval { argument 'OR',  [self], required: false } }
    Helpers.add_unless_exists(@filter, 'AND') { @filter.class_eval { argument 'AND', [self], required: false } }
  end

  flush_pending_filters!
  @filter
end

#graphql_grouping ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/graphiform/core.rb', line 102

def graphql_grouping
  unless defined? @graphql_grouping
    local_demodulized_name = demodulized_name
    model_class = self
    @graphql_grouping = Helpers.get_const_or_create(local_demodulized_name, ::Inputs::Groupings) do
      Class.new(::Inputs::Groupings::BaseGrouping) do
        graphql_name "#{local_demodulized_name}Grouping"
        argument_class Graphiform.configuration[:argument_class] if Graphiform.configuration[:argument_class].present?

        define_singleton_method(:arguments) do |context = nil|
          model_class.send(:flush_pending_groupings!)
          super(context)
        end

        define_singleton_method(:own_arguments) do
          model_class.send(:flush_pending_groupings!)
          super()
        end
      end
    end
    @graphql_grouping.class_eval do
      argument_class Graphiform.configuration[:argument_class] if Graphiform.configuration[:argument_class].present?
    end
  end

  flush_pending_groupings!
  @graphql_grouping
end

#graphql_input ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/graphiform/core.rb', line 29

def graphql_input
  unless defined? @graphql_input
    local_demodulized_name = demodulized_name
    @graphql_input = Helpers.get_const_or_create(local_demodulized_name, ::Inputs) do
      Class.new(::Inputs::BaseInput) do
        graphql_name "#{local_demodulized_name}Input"
      end
    end
    @graphql_input.class_eval do
      argument_class Graphiform.configuration[:argument_class] if Graphiform.configuration[:argument_class].present?
    end
  end
  @graphql_input
end

#graphql_query ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/graphiform/core.rb', line 210

def graphql_query
  Helpers.get_const_or_create(demodulized_name, ::Resolvers::Queries) do
    local_graphql_type = graphql_type
    Class.new(graphql_base_resolver) do
      type local_graphql_type, null: true

      def base_resolve(**args)
        @value = model.all
        apply_built_ins(**args)
        @value.take
      end
    end
  end
end

#graphql_sort ⇒ Object 



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
 
# File 'lib/graphiform/core.rb', line 74

def graphql_sort
  unless defined? @graphql_sort
    local_demodulized_name = demodulized_name
    model_class = self
    @graphql_sort = Helpers.get_const_or_create(local_demodulized_name, ::Inputs::Sorts) do
      Class.new(::Inputs::Sorts::BaseSort) do
        graphql_name "#{local_demodulized_name}Sort"

        define_singleton_method(:arguments) do |context = nil|
          model_class.send(:flush_pending_sorts!)
          super(context)
        end

        define_singleton_method(:own_arguments) do
          model_class.send(:flush_pending_sorts!)
          super()
        end
      end
    end
    @graphql_sort.class_eval do
      argument_class Graphiform.configuration[:argument_class] if Graphiform.configuration[:argument_class].present?
    end
  end

  flush_pending_sorts!
  @graphql_sort
end

#graphql_type ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/graphiform/core.rb', line 14

def graphql_type
  unless defined? @graphql_type
    local_demodulized_name = demodulized_name
    @graphql_type = Helpers.get_const_or_create(local_demodulized_name, ::Types) do
      Class.new(::Types::BaseObject) do
        graphql_name local_demodulized_name
      end
    end
    @graphql_type.class_eval do
      field_class Graphiform.configuration[:field_class] if Graphiform.configuration[:field_class].present?
    end
  end
  @graphql_type
end