Class: Queries::Query::Filter

Inherits:
Queries::Query show all
Includes:
Concerns::Users
Defined in:
lib/queries/query/filter.rb

Overview

Overview

This class manages params and nesting of filter queries.

Each inheriting class defines a PARAMS variable. Each concern defines ‘self.params`. Together these two lists are used to compose a list of acceptable params, dynamically, based on the nature of the nested queries.

Test coverage is currently in /spec/lib/queries/otu/filter_spec.rb.

!! When adding a new query tests do some linting of parameters, constants etc. Run them early and often !!

Constant Summary collapse

SUBQUERIES =

!! SUBQUERIES is cross-referenced in app/views/javascript/vue/components/radials/filter/links/*.js models. !! When you add a reference here, ensure corresponding js model is aligned. There are tests that will catch if they are not.

For example: github.com/SpeciesFileGroup/taxonworks/app/javascript/vue/components/radials/filter/constants/queryParam.js github.com/SpeciesFileGroup/taxonworks/app/javascript/vue/components/radials/filter/constants/filterLinks.js github.com/SpeciesFileGroup/taxonworks/app/javascript/vue/components/radials/filter/links/CollectionObject.js

You may also need a reference in app/javascript/vue/routes/routes.js app/javascript/vue/components/radials/linker/links

This is read as :to <- [:from1, from2…] ].

!! If you add a ‘def <model>_query_facet“ to a filter you will get warnings if that !! model is not referencened in this constant.

{
  asserted_distribution: [:source, :otu, :biological_association, :taxon_name, :dwc_occurrence],
  biological_association: [:source, :collecting_event, :otu, :collection_object, :field_occurrence, :taxon_name, :asserted_distribution], # :field_occurrence
  biological_associations_graph: [:biological_association, :source],
  collecting_event: [:source, :collection_object, :field_occurrence, :biological_association, :otu, :image, :taxon_name, :dwc_occurrence],
  collection_object: [:source, :loan, :otu, :taxon_name, :collecting_event, :biological_association, :extract, :image, :observation, :dwc_occurrence],
  content: [:source, :otu, :taxon_name, :image],
  controlled_vocabulary_term: [:data_attribute],
  data_attribute: [:collection_object, :collecting_event, :field_occurrence, :taxon_name, :otu],
  dwc_occurrence: [:asserted_distribution, :collection_object, :collecting_event, :field_occurrence],
  depiction: [:image],
  descriptor: [:source, :observation, :otu],
  extract: [:source, :otu, :collection_object, :observation],
  field_occurrence: [:collecting_event, :otu, :biological_association, :dwc_occurrence], # [:source, :otu, :collecting_event, :biological_association, :observation, :taxon_name, :extract],
  image: [:content, :collection_object, :collecting_event, :otu, :observation, :source, :taxon_name ],
  loan: [:collection_object, :otu],
  observation: [:collection_object, :descriptor, :image, :otu, :source, :taxon_name],
  otu: [:asserted_distribution, :biological_association, :collection_object, :dwc_occurrence, :field_occurrence, :collecting_event, :content, :descriptor, :extract, :image, :loan, :observation, :source, :taxon_name ],
  person: [],
  source: [:asserted_distribution,  :biological_association, :collecting_event, :collection_object, :content, :descriptor, :extract, :image, :observation, :otu, :taxon_name],
  taxon_name: [:asserted_distribution, :biological_association, :collection_object, :collecting_event, :image, :otu, :source ]
}.freeze
FILTER_QUERIES =

We could consider ‘.safe_constantize` to make this a f(n), but we’d have to have a list somewhere else anyways to further restrict allowed classes.

{
  asserted_distribution_query: '::Queries::AssertedDistribution::Filter',
  biological_association_query: '::Queries::BiologicalAssociation::Filter',
  biological_associations_graph_query: '::Queries::BiologicalAssociationsGraph::Filter',
  collecting_event_query: '::Queries::CollectingEvent::Filter',
  collection_object_query: '::Queries::CollectionObject::Filter',
  content_query: '::Queries::Content::Filter',
  controlled_vocabulary_term_query: '::Queries::ControlledVocabularyTerm::Filter',
  data_attribute_query: '::Queries::DataAttribute::Filter',
  depiction_query: '::Queries::Depiction::Filter',
  descriptor_query: '::Queries::Descriptor::Filter',
  document_query: '::Queries::Document::Filter',
  dwc_occurrence_query: '::Queries::DwcOccurrence::Filter',
  extract_query: '::Queries::Extract::Filter',
  field_occurrence_query: '::Queries::FieldOccurrence::Filter',
  image_query: '::Queries::Image::Filter',
  loan_query: '::Queries::Loan::Filter',
  observation_query: '::Queries::Observation::Filter',
  otu_query: '::Queries::Otu::Filter',
  person_query: '::Queries::Person::Filter',
  source_query: '::Queries::Source::Filter',
  taxon_name_query: '::Queries::TaxonName::Filter',
}.freeze

Instance Attribute Summary collapse

Attributes inherited from Queries::Query

#query_string, #terms

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Queries::Query

#alphabetic_strings, #alphanumeric_strings, base_name, #base_name, #base_query, #build_terms, #cached_facet, #end_wildcard, #levenshtein_distance, #match_ordered_wildcard_pieces_in_cached, #no_terms?, referenced_klass, #referenced_klass, #referenced_klass_except, #referenced_klass_intersection, #referenced_klass_union, #start_and_end_wildcard, #start_wildcard, #table, #wildcard_pieces

Constructor Details

#initialize(query_params) ⇒ Filter

Returns a new instance of Filter.



255
256
257
258
259
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
290
291
292
293
294
295
 
# File 'lib/queries/query/filter.rb', line 255

def initialize(query_params)

  # Reference to query_params, i.e. always permitted
  @api = boolean_param(query_params, :api)

  @recent = boolean_param(query_params, :recent)
  @recent_target = query_params[:recent_target]

  @object_global_id = query_params[:object_global_id]

  @venn = query_params[:venn]
  @venn_mode = query_params[:venn_mode]

  # !! This is the *only* place Current.project_id should be seen !! It's still not the best
  # way to implement this, but we use it to optimize the scope of sub/nested-queries efficiently.
  # Ideally we'd have a global class param that stores this that all Filters would have access to,
  # rather than an instance variable.
  @project_id = query_params[:project_id] || Current.project_id

  @paginate = boolean_param(query_params, :paginate)
  @per = query_params[:per]
  @page = query_params[:page]

  @order_by = query_params[:order_by]

  # After this point, if you started with ActionController::Parameters,
  # then all values have been explicitly permitted.
  if query_params.kind_of?(Hash)
    @params = query_params
  elsif query_params.kind_of?(ActionController::Parameters)
    @params = deep_permit(query_params).to_hash.deep_symbolize_keys
  elsif query_params.nil?
    @params = {}
  else
    raise TaxonWorks::Error, "can not initialize filter with #{query_params.class.name}"
  end

  set_identifier_params(params)
  set_nested_queries(params)
  set_user_dates(params)
end

Instance Attribute Details

#api ⇒ Object

Returns Boolean When true api_except_params is applied and other restrictions are placed:

- :venn param is ignored
- is_public=true is applied.

Returns:

  • Boolean When true api_except_params is applied and other restrictions are placed:

    - :venn param is ignored
- is_public=true is applied



221
222
223
 
# File 'lib/queries/query/filter.rb', line 221

def api
  @api
end

#asserted_distribution_query ⇒ Query::AssertedDistributionn::Filter?

Returns:

  • (Query::AssertedDistributionn::Filter, nil) 


149
150
151
 
# File 'lib/queries/query/filter.rb', line 149

def asserted_distribution_query
  @asserted_distribution_query
end

#biological_association_query ⇒ Query::BiologicalAssociation::Filter?

Returns:

  • (Query::BiologicalAssociation::Filter, nil) 


152
153
154
 
# File 'lib/queries/query/filter.rb', line 152

def biological_association_query
  @biological_association_query
end

#biological_associations_graph_query ⇒ Query::BiologicalAssociationsGraph::Filter?

Returns:

  • (Query::BiologicalAssociationsGraph::Filter, nil) 


155
156
157
 
# File 'lib/queries/query/filter.rb', line 155

def biological_associations_graph_query
  @biological_associations_graph_query
end

#collecting_event_query ⇒ Query::CollectingEvent::Filter?

Returns:

  • (Query::CollectingEvent::Filter, nil) 


164
165
166
 
# File 'lib/queries/query/filter.rb', line 164

def collecting_event_query
  @collecting_event_query
end

#collection_object_query ⇒ Query::TaxonName::Filter?

Returns:

  • (Query::TaxonName::Filter, nil) 


161
162
163
 
# File 'lib/queries/query/filter.rb', line 161

def collection_object_query
  @collection_object_query
end

#content_query ⇒ Query::Content::Filter?

Returns:

  • (Query::Content::Filter, nil) 


167
168
169
 
# File 'lib/queries/query/filter.rb', line 167

def content_query
  @content_query
end

#controlled_vocabulary_term_query ⇒ Query::ControlledVocabularyTerm::Filter?

Returns:

  • (Query::ControlledVocabularyTerm::Filter, nil) 


158
159
160
 
# File 'lib/queries/query/filter.rb', line 158

def controlled_vocabulary_term_query
  @controlled_vocabulary_term_query
end

#data_attribute_query ⇒ Query::DataAttribute::Filter?

Returns:

  • (Query::DataAttribute::Filter, nil) 


170
171
172
 
# File 'lib/queries/query/filter.rb', line 170

def data_attribute_query
  @data_attribute_query
end

#depiction_query ⇒ Query::Depiction::Filter?

Returns:

  • (Query::Depiction::Filter, nil) 


176
177
178
 
# File 'lib/queries/query/filter.rb', line 176

def depiction_query
  @depiction_query
end

#descriptor_query ⇒ Query::Descriptor::Filter?

Returns:

  • (Query::Descriptor::Filter, nil) 


173
174
175
 
# File 'lib/queries/query/filter.rb', line 173

def descriptor_query
  @descriptor_query
end

#document_query ⇒ Query::Document::Filter?

Returns:

  • (Query::Document::Filter, nil) 


179
180
181
 
# File 'lib/queries/query/filter.rb', line 179

def document_query
  @document_query
end

#dwc_occurrence_query ⇒ Query::DwcOccurrence::Filter?

Returns:

  • (Query::DwcOccurrence::Filter, nil) 


182
183
184
 
# File 'lib/queries/query/filter.rb', line 182

def dwc_occurrence_query
  @dwc_occurrence_query
end

#extract_query ⇒ Query::Extract::Filter?

Returns:

  • (Query::Extract::Filter, nil) 


197
198
199
 
# File 'lib/queries/query/filter.rb', line 197

def extract_query
  @extract_query
end

#field_occurrence_query ⇒ Query::TaxonName::Filter?

Returns:

  • (Query::TaxonName::Filter, nil) 


185
186
187
 
# File 'lib/queries/query/filter.rb', line 185

def field_occurrence_query
  @field_occurrence_query
end

#image_query ⇒ Query::Image::Filter?

Returns:

  • (Query::Image::Filter, nil) 


188
189
190
 
# File 'lib/queries/query/filter.rb', line 188

def image_query
  @image_query
end

#loan_query ⇒ Query::Loan::Filter?

Returns:

  • (Query::Loan::Filter, nil) 


203
204
205
 
# File 'lib/queries/query/filter.rb', line 203

def loan_query
  @loan_query
end

#object_global_id ⇒ Array

Locally these look like gid://taxon-works/Otu/1 Using a global id is equivalent to using <model>_id. I.e. it simply restricts the filter to those matching Model#id.

!! If any global id model name does not match the current filter, then then facet is completely rejected.

Returns:

  • (Array) 


144
145
146
 
# File 'lib/queries/query/filter.rb', line 144

def object_global_id
  @object_global_id
end

#observation_query ⇒ Query::Observation::Filter?

Returns:

  • (Query::Observation::Filter, nil) 


200
201
202
 
# File 'lib/queries/query/filter.rb', line 200

def observation_query
  @observation_query
end

#order_by ⇒ Object

Supported values:

* `match_identifiers` - sort by the order of the identifiers in provided

!! Does not sub-sort

Parameters:

  • order_by (String, Symbol) —

    the kind of sort to apply.

Returns:

  • symbol must match a existing parameter name (used to check if values provided)



244
245
246
 
# File 'lib/queries/query/filter.rb', line 244

def order_by
  @order_by
end

#otu_query ⇒ Query::Otu::Filter?

Returns:

  • (Query::Otu::Filter, nil) 


194
195
196
 
# File 'lib/queries/query/filter.rb', line 194

def otu_query
  @otu_query
end

#page ⇒ Object

Returns Integer, nil required if paginate == true.

Returns:

  • Integer, nil required if paginate == true



126
127
128
 
# File 'lib/queries/query/filter.rb', line 126

def page
  @page
end

#paginate ⇒ Object

Apply pagination within Filter scope

true - apply per and page
false, nil - ignored



122
123
124
 
# File 'lib/queries/query/filter.rb', line 122

def paginate
  @paginate
end

#params ⇒ Object (readonly)

!! Using setters directly on query parameters will not alter this variable !! !! This is used strictly during the permission process of ActionController::Parameters !!

Returns:

  • Hash the parsed/permitted params

    that were used to on initialize() only!!



251
252
253
 
# File 'lib/queries/query/filter.rb', line 251

def params
  @params
end

#per ⇒ Object

Returns Integer, nil paginate must equal true page must be !nil?.

Returns:

  • Integer, nil paginate must equal true page must be !nil?



131
132
133
 
# File 'lib/queries/query/filter.rb', line 131

def per
  @per
end

#person_query ⇒ Query::Person::Filter?

Returns:

  • (Query::Person::Filter, nil) 


206
207
208
 
# File 'lib/queries/query/filter.rb', line 206

def person_query
  @person_query
end

#project_id ⇒ Array

Parameters:

  • project_id (Array, Integer)

Returns:

  • (Array) 


117
118
119
 
# File 'lib/queries/query/filter.rb', line 117

def project_id
  @project_id
end

#recent ⇒ Object

Returns Boolean Applies an order on updated.

Returns:

  • Boolean Applies an order on updated.



210
211
212
 
# File 'lib/queries/query/filter.rb', line 210

def recent
  @recent
end

#recent_target ⇒ Object

Returns symbol :created_at, :updated_at defaults to :updated_at if blank.

Returns:

  • symbol :created_at, :updated_at defaults to :updated_at if blank



214
215
216
 
# File 'lib/queries/query/filter.rb', line 214

def recent_target
  @recent_target
end

#taxon_name_query ⇒ Query::TaxonName::Filter?

Returns:

  • (Query::TaxonName::Filter, nil) 


191
192
193
 
# File 'lib/queries/query/filter.rb', line 191

def taxon_name_query
  @taxon_name_query
end

#venn ⇒ Object

Returns String A JSON full URL containing the base string for a query.

Returns:

  • String A JSON full URL containing the base string for a query



225
226
227
 
# File 'lib/queries/query/filter.rb', line 225

def venn
  @venn
end

#venn_mode ⇒ Object

Returns Symbol one of :a, :ab, :b defaults to :ab

:a :ab  :b

( A ( B ) C ).

Returns:

  • Symbol one of :a, :ab, :b defaults to :ab

    :a :ab  :b

    ( A ( B ) C )



231
232
233
 
# File 'lib/queries/query/filter.rb', line 231

def venn_mode
  @venn_mode
end

Class Method Details

.annotator_params ⇒ Object

to be merged into included params

Returns:

  • Array, nil a [:a, :b, []] formatted Array



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/queries/query/filter.rb', line 410

def self.annotator_params
  h = nil
  if i = included_annotator_facets
    # Setup with the first
    a = i.shift
    h = a.params

    if !h.last.kind_of?(Hash)
      h << {}
    end

    c = h.last

    # Now do the rest
    i.each do |j|
      p = j.params

      if p.last.kind_of?(Hash)
        c.merge!(p.pop)
      end

      h = p + h
    end
  end
  h
end

.api_except_params ⇒ Object

Any params set here, and in corresponding subclasses will not be permitted when api: true is present



403
404
405
 
# File 'lib/queries/query/filter.rb', line 403

def self.api_except_params
  [:venn, :venn_mode]
end

.api_excluded_params ⇒ Object 



437
438
439
440
441
 
# File 'lib/queries/query/filter.rb', line 437

def self.api_excluded_params
  [
    # if there are things like created_by_id that we deem universally out they go here
  ] + api_except_params
end

.base_filter(params) ⇒ Filter?

Returns the class of filter that is referenced at the base of this parameter set.

Returns:

  • (Filter, nil) —

    the class of filter that is referenced at the base of this parameter set



333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/queries/query/filter.rb', line 333

def self.base_filter(params)
  if s = base_query_name(params)
    t = s.gsub('_query', '').to_sym

    if SUBQUERIES.include?(t)
      k = t.to_s.camelcase
      return "Queries::#{k}::Filter".constantize
    else
      return nil
    end
  else
    nil
  end
end

.base_query_name(params) ⇒ Object 



357
358
359
 
# File 'lib/queries/query/filter.rb', line 357

def self.base_query_name(params)
  params.keys.select{|s| s =~ /\A.+_query\z/}.first
end

.base_query_to_h(params) ⇒ Object

base_query, as params, like ‘{}` This sanitizes params.

Returns:

  • the params use to instantiate the full



364
365
366
 
# File 'lib/queries/query/filter.rb', line 364

def self.base_query_to_h(params)
  return { base_query_name(params) => instantiated_base_filter(params).params }
end

.included_annotator_facets ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/queries/query/filter.rb', line 368

def self.included_annotator_facets
  f = [
    ::Queries::Concerns::Users
  ]

  if referenced_klass.annotates?
    f.push ::Queries::Concerns::Polymorphic if self < ::Queries::Concerns::Polymorphic
  else
    # TODO There is room for an AlternateValue concern here
    f.push ::Queries::Concerns::Attributes if self < ::Queries::Concerns::Attributes
    f.push ::Queries::Concerns::Citations if self < ::Queries::Concerns::Citations
    f.push ::Queries::Concerns::Confidences if self < ::Queries::Concerns::Confidences
    f.push ::Queries::Concerns::Containable if self < ::Queries::Concerns::Containable
    f.push ::Queries::Concerns::DataAttributes if self < ::Queries::Concerns::DataAttributes
    f.push ::Queries::Concerns::DateRanges if self < ::Queries::Concerns::DateRanges
    f.push ::Queries::Concerns::Depictions if self < ::Queries::Concerns::Depictions
    f.push ::Queries::Concerns::Identifiers if self < ::Queries::Concerns::Identifiers
    f.push ::Queries::Concerns::Notes if self < ::Queries::Concerns::Notes
    f.push ::Queries::Concerns::Protocols if self < ::Queries::Concerns::Protocols
    f.push ::Queries::Concerns::Tags if self < ::Queries::Concerns::Tags
  end

  f
end

.instantiated_base_filter(params) ⇒ Object

An instiatied filter, with params set, for params with patterns like ‘otu_query={}`



349
350
351
352
353
354
355
 
# File 'lib/queries/query/filter.rb', line 349

def self.instantiated_base_filter(params)
  if s = base_filter(params)
    s.new(params[base_query_name(params)])
  else
    nil
  end
end

.inverted_subqueries ⇒ Hash

Returns only referenced in specs.

Returns:

  • (Hash) —

    only referenced in specs



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/queries/query/filter.rb', line 74

def self.inverted_subqueries
  r = {}
  SUBQUERIES.each do |k,v|
    v.each do |m|
      if r[m]
        r[m].push k
      else
        r[m] = [k]
      end
    end
  end
  r
end

.params ⇒ Object

Returns Array merges ‘[:a, []]` into [:a].

Returns:

  • Array merges ‘[:a, []]` into [:a]



395
396
397
398
399
 
# File 'lib/queries/query/filter.rb', line 395

def self.params
  a = self::PARAMS.dup
  b = a.pop.keys
  (a + b).uniq
end

.query_name ⇒ Object 



64
65
66
 
# File 'lib/queries/query/filter.rb', line 64

def self.query_name
  base_name + '_query'
end

Instance Method Details

#all(nil_empty = false) ⇒ ActiveRecord::Relation

See /lib/queries/ARCHITECTURE.md for additional explanation.

TODO: consider “true” for default, changing to false on controller Filter calls

Parameters:

  • nil_empty (Boolean) (defaults to: false) —

    If true then if there are no clauses return nil not .all

Returns:

  • (ActiveRecord::Relation) 


742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/queries/query/filter.rb', line 742

def all(nil_empty = false)

  # TODO: should turn off/on project_id here on nil empty?

  a = all_and_clauses
  b = all_merge_clauses

  # TODO: do not consider project_id alone a parameter on nil_empty

  # Limited use within the UI because project_id is set
  return nil if nil_empty && a.nil? && b.nil?

  # !! Do not apply `.distinct here`

  q = nil
  if a && b
    q = b.where(a)
  elsif a
    q = referenced_klass.where(a)
  elsif b
    q = b
  else
    q = referenced_klass.all
  end

  if venn_mode && venn && !api
    q = apply_venn(q)
  end

  # TODO: collides with recent, and needs isolation/generic application
  # probably through native .order() use.
  # Order in general likely belongs outside the scope of filters, but
  # see this param use, where we depend on the incoming values
  #
  # See spec/lib/queries/otu/filter_spec.rb for tests

  # See lib/queries/concerns/identifiers.rb
  if order_by
    q = match_identifier_order_by(q)
  end

  if recent
    q = referenced_klass.from(q.all, table.name).order(recent_target => :desc)
  end

  if api
    if referenced_klass.column_names.include?('is_public')
      q = q.where(is_public: [nil, true])
    end
  end

  if paginate
    if order_by
      q = q.page(page).per(per)
    else
      q = q.order(:id).page(page).per(per)
    end
  end

  # TODO: canonically address whether or not to use `.distinct` at this point, we should be able to, however
  # some incoming queries may have joins/group/etc. alone?! I.e. why can't we?

  q
end

#all_and_clauses ⇒ ActiveRecord::Relation?

Returns:

  • (ActiveRecord::Relation, nil) 


665
666
667
668
669
670
671
672
673
674
 
# File 'lib/queries/query/filter.rb', line 665

def all_and_clauses
  clauses = target_and_clauses
  return nil if clauses.empty?

  a = clauses.shift
  clauses.each do |b|
    a = a.and(b)
  end
  a
end

#all_merge_clauses ⇒ Scope?

Of interest, the previous native ‘merge()` (and `and()“) make things complicated:

For example a.merge(b) != b.merge(a) in some cases. This is because certain clauses are tossed without warning (notably ‘.from()`). See:

We presently use SQL with INTERSECTION to combine facets.

Returns:

  • (Scope, nil) 


696
697
698
699
700
701
702
 
# File 'lib/queries/query/filter.rb', line 696

def all_merge_clauses
  clauses = merge_clauses + annotator_merge_clauses
  clauses.compact!

  return nil if clauses.empty?
  referenced_klass_intersection(clauses)
end

#and_clauses ⇒ Object

Defined in inheriting classes



660
661
662
 
# File 'lib/queries/query/filter.rb', line 660

def and_clauses
  []
end

#annotator_and_clauses ⇒ Object 



637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/queries/query/filter.rb', line 637

def annotator_and_clauses
  a = []
  self.class.included_annotator_facets.each do |c|
    if c.respond_to?(:and_clauses)
      c.and_clauses.each do |f|
        if v = send(f)
          a.push v
        end
      end
    end
  end
  a
end

#annotator_merge_clauses ⇒ Object 



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
 
# File 'lib/queries/query/filter.rb', line 618

def annotator_merge_clauses
  a = []

  # !! Interesting `.compact` removes #<ActiveRecord::Relation []>,
  # so patterns that us collect.flatten.compact return empty,
  #  `.present?` fails as well, so verbose loops here
  self.class.included_annotator_facets.each do |c|
    if c.respond_to?(:merge_clauses)
      next if c.name == 'Queries::Concerns::Identifiers' && no_identifier_clauses
      c.merge_clauses.each do |f|
        if v = send(f)
          a.push v
        end
      end
    end
  end
  a
end

#apply_venn(query) ⇒ Object 



704
705
706
 
# File 'lib/queries/query/filter.rb', line 704

def apply_venn(query)
  Queries.venn(query, venn_query.all, venn_mode)
end

#attribute_exact_facet(attribute = nil) ⇒ Object

params attribute [Symbol]

 a facet for use when params include `author`, and `exact_author` pattern combinations
 See queries/source/filter.rb for example use
 See /spec/lib/queries/source/filter_spec.rb
!! Whitespace (e.g. tabs, newlines) is ignored when exact is used !!!



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/queries/query/filter.rb', line 599

def attribute_exact_facet(attribute = nil)
  a = attribute.to_sym
  return nil if send(a).blank?
  if send("exact_#{a}".to_sym)

    # TODO: Think we need to handle ' and '

    v = send(a)
    v.gsub!(/\s+/, ' ')
    v = ::Regexp.escape(v)
    v.gsub!(/\\\s+/, '\s*') # spaces are escaped, but we need to expand them in case we dont' get them caught
    v = '^\s*' + v + '\s*$'

    table[a].matches_regexp(v)
  else
    table[a].matches('%' + send(a).strip.gsub(/\s+/, '%') + '%')
  end
end

#deep_permit(params) ⇒ Object

Returns ActionController::Parameters.

Returns:

  • ActionController::Parameters



539
540
541
 
# File 'lib/queries/query/filter.rb', line 539

def deep_permit(params)
  p = params.permit( permitted_params(params.to_unsafe_hash))
end

#merge_clauses ⇒ Object

Defined in inheriting classes



681
682
683
 
# File 'lib/queries/query/filter.rb', line 681

def merge_clauses
  []
end

#model_id_facet ⇒ Object

Returns id= facet, automatically added to all queries. Over-ridden in some base classes.



570
571
572
573
574
 
# File 'lib/queries/query/filter.rb', line 570

def model_id_facet
  m = (base_name + '_id').to_sym
  return nil if send(m).empty?
  table[:id].in(send(m))
end

#object_global_id_facet ⇒ Object 



581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/queries/query/filter.rb', line 581

def object_global_id_facet
  return nil if object_global_id.empty?
  ids = []
  object_global_id.each do |i|
    g = GlobalID.parse(i)
    # If any global_ids do not reference this Class, abort
    return nil unless g.model_class.base_class.name == referenced_klass.name
    ids.push g.model_id
  end

  table[:id].in(ids)
end

#only_project? ⇒ Boolean

Returns Boolean true - the only param pasted is ‘project_id` !! Note that this is the default for all queries, it is set on iniitializea false - there are no params at ALL or at least one that is not `project_id`.

Returns:

  • (Boolean) —

    Boolean true - the only param pasted is ‘project_id` !! Note that this is the default for all queries, it is set on iniitializea false - there are no params at ALL or at least one that is not `project_id`



730
731
732
 
# File 'lib/queries/query/filter.rb', line 730

def only_project?
  (project_id_facet && target_and_clauses.size == 1 && all_merge_clauses.nil?) ? true : false
end

#permitted_params(hsh) ⇒ Object

This method is a preprocessor that discovers, by finding the nested subqueries, which params should be permitted. It is used to build a permitable profile of parameters.

That profile is then used in the actual .permit() call.

An alternate solution, first tried, is to permit the params directly during inspection for subqueries. This also would work, however there are some nice benefits to having a profile of the allowed params available as an Array, for example we can use it for API documentation a little easier(?!).

In essence what we needed was for ActionController::Parameters to be able to accumulate (remember) all permitted params (not just their actual data) over multiple .permit() calls. If we had that, then we could do something like params.permitted_params => Array after multiple calls like params.permit(:a), params.permit(:b).

any parameter set for the query.

Returns:

  • Array like [:a,:b, :c, []]



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/queries/query/filter.rb', line 464

def permitted_params(hsh)
  h = self.class::PARAMS.deep_dup
  h.unshift(:per)
  h.unshift(:page)
  h.unshift(:paginate)

  if !h.last.kind_of?(Hash)
    h << {}
  end

  c = h.last # a {}

  if n = self.class.annotator_params
    c.merge!(n.pop)
    h = n + h
  end

  b = subquery_vector(hsh)

  parent = self.class

  while !b.empty?
    a = b.shift

    next unless SUBQUERIES[parent.base_name.to_sym].include?( a.to_s.gsub('_query', '').to_sym )

    q = FILTER_QUERIES[a].safe_constantize
    p = q::PARAMS.deep_dup

    p.unshift(:per)
    p.unshift(:page)
    p.unshift(:paginate)

    if !p.last.kind_of?(Hash)
      p << {}
    end

    if n = q.annotator_params
      p.last.merge!(n.pop)
      p = n + p
    end

    c[a] = p

    c = p.last

    parent = q
  end

  if api
    self.class.api_excluded_params.each do |a|
      h.delete_if{|k,v| a == k}
      h.last.delete_if{|k,v| a == k }
    end
  end

  h
end

#process_url_into_params(url) ⇒ Object 



326
327
328
 
# File 'lib/queries/query/filter.rb', line 326

def process_url_into_params(url)
  Rack::Utils.parse_nested_query(url)
end

#project_id_facet ⇒ Object 



576
577
578
579
 
# File 'lib/queries/query/filter.rb', line 576

def project_id_facet
  return nil if project_id.empty?
  table[:project_id].in(project_id)
end

#query_name ⇒ Object 



68
69
70
 
# File 'lib/queries/query/filter.rb', line 68

def query_name
  self.class.query_name
end

#set_nested_queries(params) ⇒ Object

TODO: when a nesting problem is found we need to flag the query as invalid

Returns:

  • True



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/queries/query/filter.rb', line 547

def set_nested_queries(params)

  if n = params.select{|k, p| k.to_s =~ /_query/ }
    return nil if n.keys.count != 1 # !!! can't have multiple nested queries inside one level !!! This lets us eliminate infinite loops at the cost of expressiveness?!

    query_name = n.first.first

    return nil unless SUBQUERIES[base_name.to_sym].include?( query_name.to_s.gsub('_query', '').to_sym ) # must be registered

    query_params = n.first.last

    q = FILTER_QUERIES[query_name].safe_constantize.new(query_params)

    # assign to @<model>_query
    v = send("#{query_name}=".to_sym, q)
  end

  true
end

#shared_and_clauses ⇒ Object 



651
652
653
654
655
656
657
 
# File 'lib/queries/query/filter.rb', line 651

def shared_and_clauses
  [
    project_id_facet,
    model_id_facet,
    object_global_id_facet,
  ]
end

#subquery_vector(hsh) ⇒ Array of Symbol

Since queries nest linearly we don’t need to recursion.

Returns:

  • (Array of Symbol) —

    all queries, in nested order



527
528
529
530
531
532
533
534
535
 
# File 'lib/queries/query/filter.rb', line 527

def subquery_vector(hsh)
  result = []
  while !hsh.keys.select{|k| k =~ /_query/}.empty?
    a = hsh.keys.select{|k| k =~ /_query/}
    result += a
    hsh = hsh[a.first]
  end
  result.map(&:to_sym)
end

#target_and_clauses ⇒ Object 



676
677
678
 
# File 'lib/queries/query/filter.rb', line 676

def target_and_clauses
  [and_clauses + annotator_and_clauses + shared_and_clauses].flatten.compact
end

#venn_query ⇒ Object 



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/queries/query/filter.rb', line 708

def venn_query
  u = ::Addressable::URI.parse(venn).query
  # Brackets may be multi-encoded
  t = nil
  i = 0
  max = 10
  while t != u && i < max
    t = u
    u = Addressable::URI.unencode(t)
    i += 1
  end

  p = ::Rack::Utils.parse_nested_query(u) # nested supports brackets

  a = ActionController::Parameters.new(p)

  self.class.new(a)
end