Module: Queries::Concerns::Identifiers

Extended by:
ActiveSupport::Concern
Includes:
Helpers
Included in:
Query, Query::Autocomplete, Repository::Autocomplete
Defined in:
lib/queries/concerns/identifiers.rb

Overview

Helpers for queries that reference Identifier

TODO: Some of this is only for autocomplete !! See anything refencing terms, query_string

These queries are impacted by Shared::Containable. When Containable identifiers have to match, potentially targets directly, and indirectly through virtual containers.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

#boolean_param

Class Method Details

.merge_clausesObject



153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/queries/concerns/identifiers.rb', line 153

def self.merge_clauses
  [
    :global_identifiers_facet,
    :identifier_between_facet,
    :identifier_facet,
    :identifier_namespace_facet,
    :identifier_type_facet,
    :identifiers_facet,
    :local_identifiers_facet,
    :match_identifiers_facet,
  ]
end

.paramsObject



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/queries/concerns/identifiers.rb', line 15

def self.params
  [
    :identifier,
    :identifier_end,
    :identifier_exact,
    :identifier_start,
    :identifier_type,
    :identifiers,
    :local_identifiers,
    :global_identifiers,
    :match_identifiers,
    :match_identifiers_delimiter,
    :match_identifiers_type,
    :namespace_id,
    identifier_type: [],
  ]
end

Instance Method Details

#autocomplete_identifier_cached_exactObject

Autocomplete for tables referencing identifiers See lib/queries/identifiers/autocomplete for autocomplete for identifiers

May need to alter base query here



410
411
412
# File 'lib/queries/concerns/identifiers.rb', line 410

def autocomplete_identifier_cached_exact
  referenced_klass.joins(:identifiers).where(with_identifier_cached.to_sql)
end

#autocomplete_identifier_cached_likeObject



418
419
420
# File 'lib/queries/concerns/identifiers.rb', line 418

def autocomplete_identifier_cached_like
  referenced_klass.joins(:identifiers).where(with_identifier_cached_wildcarded.to_sql)
end

#autocomplete_identifier_identifier_exactObject



414
415
416
# File 'lib/queries/concerns/identifiers.rb', line 414

def autocomplete_identifier_identifier_exact
  referenced_klass.joins(:identifiers).where(with_identifier_identifier.to_sql)
end

#autocomplete_identifier_matching_cached_anywhereObject



422
423
424
# File 'lib/queries/concerns/identifiers.rb', line 422

def autocomplete_identifier_matching_cached_anywhere
  referenced_klass.joins(:identifiers).where(with_identifier_cached_wildcarded.to_sql)
end

#autocomplete_identifier_matching_cached_fragments_anywhereObject



426
427
428
# File 'lib/queries/concerns/identifiers.rb', line 426

def autocomplete_identifier_matching_cached_fragments_anywhere
  referenced_klass.joins(:identifiers).where(with_identifier_cached_like_fragments.to_sql)
end

#betweenObject



166
167
168
169
170
171
172
173
174
# File 'lib/queries/concerns/identifiers.rb', line 166

def between
  Arel::Nodes::Between.new(
    identifier_table[:cached_numeric_identifier],
    Arel::Nodes::And.new(
      [ Arel::Nodes::SqlLiteral.new(identifier_start),
        Arel::Nodes::SqlLiteral.new(identifier_end) ]
    )
  )
end

#global_identifiers_facetObject

TODO: Simplify local/global copy-pasta



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/queries/concerns/identifiers.rb', line 292

def global_identifiers_facet
  return nil if global_identifiers.nil?
  a = nil

  if global_identifiers
    a = referenced_klass.joins(:identifiers).where("identifiers.type ILIKE 'Identifier::Global%'").distinct
  else
    i = ::Identifier.arel_table[:identifier_object_id].eq(table[:id]).and(
      ::Identifier.arel_table[:identifier_object_type].eq( table.name.classify.to_s )
    )
    a = referenced_klass.where.not(::Identifier::Local.where(i).arel.exists)
  end

  # TODO: this logic can almost certainly be simplified.  Test coverage is decent for attempts to do so.
  if referenced_klass.is_containable?
    c = referenced_klass_union([a, global_identifiers_container_match ].compact)

    @global_identifiers = !local_identifiers
    except = global_identifiers_container_match
    @global_identifiers = !local_identifiers

    if except
      return referenced_klass.from('(' + c.to_sql + " EXCEPT #{except.to_sql}) as #{table.name}")
    else
      return referenced_klass.from('(' + c.to_sql + ") as #{table.name}")
    end
  end

  a
end

#identifier_between_facetObject



358
359
360
361
362
363
364
365
366
367
368
# File 'lib/queries/concerns/identifiers.rb', line 358

def identifier_between_facet
  return nil if @identifier_start.blank?
  @identifier_end = @identifier_start if @identifier_end.blank?

  w = between
  w = w.and(identifier_table[:namespace_id].eq(namespace_id)) if namespace_id # TODO: redundant with namespace facet likely

  a = referenced_klass.joins(:identifiers).where(w)
  a = referenced_klass_union([a, identifier_between_container_match]) if referenced_klass.is_containable?
  a
end

#identifier_facetObject



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/queries/concerns/identifiers.rb', line 323

def identifier_facet
  return nil if identifier.blank?

  q = referenced_klass.joins(:identifiers)

  w = identifier_exact ?
    identifier_table[:cached].eq(identifier) :
    identifier_table[:cached].matches('%' + identifier.to_s + '%')

  w = w.and(identifier_table[:namespace_id].eq(namespace_id)) if namespace_id
  a = q.where(w)

  a = referenced_klass_union([a, identifier_container_match]) if referenced_klass.is_containable?
  a
end

#identifier_namespace_facetObject



349
350
351
352
353
354
355
356
# File 'lib/queries/concerns/identifiers.rb', line 349

def identifier_namespace_facet
  return nil if namespace_id.blank?
  q = referenced_klass.joins(:identifiers)
  a = q.where(identifier_table[:namespace_id].eq(namespace_id))

  a = referenced_klass_union([a, identifier_namespace_container_match ]) if referenced_klass.is_containable?
  a
end

#identifier_tableArel::Table

Returns:

  • (Arel::Table)


149
150
151
# File 'lib/queries/concerns/identifiers.rb', line 149

def identifier_table
  ::Identifier.arel_table
end

#identifier_type_facetObject



339
340
341
342
343
344
345
346
347
# File 'lib/queries/concerns/identifiers.rb', line 339

def identifier_type_facet
  return nil if identifier_type.empty?
  q = referenced_klass.joins(:identifiers)
  w = identifier_table[:type].in(identifier_type)
  a = q.where(w)

  a = referenced_klass_union([a, identifier_type_container_match ]) if referenced_klass.is_containable?
  a
end

#identifiers_facetObject



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/queries/concerns/identifiers.rb', line 208

def identifiers_facet
  return nil if identifiers.nil?
  a = nil
  if identifiers
    a = referenced_klass.joins(:identifiers).distinct
  else
    a = referenced_klass.where.missing(:identifiers).distinct
  end

  if referenced_klass.is_containable?
    c = referenced_klass_union([a, identifiers_container_match ])
    @identifiers = !identifiers
    except = identifiers_container_match
    @identifiers = !identifiers

    return referenced_klass.from('(' + c.to_sql + " EXCEPT #{except.to_sql}) as #{table.name}")
  end

  a
end

#identifiers_to_matchObject

Returns Array.

Returns:

  • Array



177
178
179
180
181
182
183
# File 'lib/queries/concerns/identifiers.rb', line 177

def identifiers_to_match
  ids = match_identifiers.strip.split(match_identifiers_delimiter).flatten.map(&:strip).uniq
  if match_identifiers_type == 'internal'
    ids = ids.select{|i| i =~ /^\d+$/}
  end
  ids
end

#local_identifiers_facetObject



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/queries/concerns/identifiers.rb', line 260

def local_identifiers_facet
  return nil if local_identifiers.nil?
  a = nil

  if local_identifiers
    a = referenced_klass.joins(:identifiers).where("identifiers.type ILIKE 'Identifier::Local%'").distinct
  else
    i = ::Identifier.arel_table[:identifier_object_id].eq(table[:id]).and(
      ::Identifier.arel_table[:identifier_object_type].eq( table.name.classify.to_s )
    )
    a = referenced_klass.where.not(::Identifier::Local.where(i).arel.exists)
  end

  # TODO: this logic can almost certainly be simplified.  Test coverage is decent for attempts to do so.
  if referenced_klass.is_containable?
    c = referenced_klass_union([a, local_identifiers_container_match ].compact)

    @local_identifiers = !local_identifiers
    except = local_identifiers_container_match
    @local_identifiers = !local_identifiers

    if except
      return referenced_klass.from('(' + c.to_sql + " EXCEPT #{except.to_sql}) as #{table.name}")
    else
      return referenced_klass.from('(' + c.to_sql + ") as #{table.name}")
    end
  end

  a
end

#match_identifiers_facetObject



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/queries/concerns/identifiers.rb', line 185

def match_identifiers_facet
  return nil if match_identifiers.blank?
  ids = identifiers_to_match

  return nil if ids.empty?

  a = nil

  case match_identifiers_type
  when 'internal'
    a = referenced_klass.where(id: ids)
  when 'identifier'
    a = referenced_klass.joins(:identifiers).where(identifiers: {cached: ids})
  when 'dwc_occurrence_id'
    a = referenced_klass.joins(:identifiers).where(identifiers: {cached: ids, type: 'Identifier::Global::Uuid::TaxonworksDwcOccurrence' })
  else
    return nil
  end

  a = referenced_klass_union([a, match_identifiers_container_match ]) if referenced_klass.is_containable?
  a
end

#set_identifier_params(params) ⇒ Object



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/queries/concerns/identifiers.rb', line 132

def set_identifier_params(params)

  @global_identifiers = boolean_param(params, :global_identifiers)
  @identifier = params[:identifier]
  @identifier_end = params[:identifier_end]
  @identifier_exact = boolean_param(params, :identifier_exact)
  @identifier_start = params[:identifier_start]
  @identifier_type = params[:identifier_type]
  @identifiers = boolean_param(params, :identifiers)
  @local_identifiers = boolean_param(params, :local_identifiers)
  @match_identifiers = params[:match_identifiers]
  @match_identifiers_delimiter = params[:match_identifiers_delimiter]
  @match_identifiers_type = params[:match_identifiers_type]
  @namespace_id = params[:namespace_id]
end

#with_identifier_cachedArel::Nodes::Equality

Returns:

  • (Arel::Nodes::Equality)


376
377
378
# File 'lib/queries/concerns/identifiers.rb', line 376

def with_identifier_cached
  identifier_table[:cached].eq(query_string)
end

#with_identifier_cached_like_fragmentsArel::Nodes::Grouping

Returns:

  • (Arel::Nodes::Grouping)


397
398
399
400
401
# File 'lib/queries/concerns/identifiers.rb', line 397

def with_identifier_cached_like_fragments
  a = [ start_and_end_wildcard ]
  a = a + wildcard_wrapped_integers
  identifier_table[:cached].matches_any(a)
end

#with_identifier_cached_wildcard_endArel::Nodes::Equality

Returns:

  • (Arel::Nodes::Equality)


385
386
387
# File 'lib/queries/concerns/identifiers.rb', line 385

def with_identifier_cached_wildcard_end
  identifier_table[:cached].matches(end_wildcard)
end

#with_identifier_cached_wildcardedArel::Nodes::Equality

Returns:

  • (Arel::Nodes::Equality)


390
391
392
# File 'lib/queries/concerns/identifiers.rb', line 390

def with_identifier_cached_wildcarded
  identifier_table[:cached].matches(start_and_end_wildcard)
end

#with_identifier_identifierArel::Nodes::Equality

Returns:

  • (Arel::Nodes::Equality)


371
372
373
# File 'lib/queries/concerns/identifiers.rb', line 371

def with_identifier_identifier
  identifier_table[:identifier].eq(query_string)
end

#with_identifier_wildcard_endObject



380
381
382
# File 'lib/queries/concerns/identifiers.rb', line 380

def with_identifier_wildcard_end
  identifier_table[:identifier].matches(end_wildcard)
end