Module: Refine::Conditions::HasRefinements

Included in:
Condition
Defined in:
app/models/refine/conditions/has_refinements.rb

Instance Method Summary collapse

Instance Method Details

#apply_count_refinement(table:, input:, subquery:, instance:) ⇒ Object 



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/models/refine/conditions/has_refinements.rb', line 73

def apply_count_refinement(table:, input:, subquery:, instance:)
  condition = get_count_refinement_condition
  # We need to group by because we're going to be using a `having`
  # to get the count of records. Since we're using a where in for this
  # relationship subquery, we're only selecting the foreign key,
  # so we'll just group by that too.
  subquery.group(table[instance.foreign_key])

  # If user's input doesn't include the number 0, there is no complicated
  # joining
  if condition.input_could_include_zero?(input)
    # if the input DOES include 0 then we have to do a bit of extra work. If you were trying to get a list of
    # contacts that has i.e. 0 events, you can't query the events table b/c those contacts
    # don't have any record there.
    # Get a list of all contacts, left join in the count of events we're looking for, and coalesce nulls
    # to 0. That gives us a true count for every contact, even if the count is 0. Then we can use
    # the Numeric Condition as usual.
    # Wrap the existing subquery - subquery is an AREL Select manager and modified in place
    subquery.project((Arel.star.count).as("hs_refine_count_aggregate"))

    # The table that owns the relationship
    # TODO This is redundant
    parent_table = instance.active_record.arel_table
    parent_primary_key = instance.active_record.primary_key

    # SELECT "contacts"."id" FROM "contacts"
    outer_query = parent_table.project(parent_table[parent_primary_key.to_sym])

    callable_subquery =
      proc do |inner_query, primary_key, foreign_key|
        interim_table = inner_query.as("interim_table")
        outer_query.join(interim_table, Arel::Nodes::OuterJoin).on(interim_table[foreign_key.to_sym].eq(parent_table[primary_key.to_sym]))
      end

    filter.set_pending_relationship_subquery_wrapper(callable_subquery)

    condition.raw_attribute("coalesce(hs_refine_count_aggregate, 0)")

    node = condition.apply(input, table, nil)
    outer_query.where(node)
  else
    node = condition.apply(input, table, nil)
    # Modify the pending relationship subquery in place to be applied later
    # Remember, AREL in this instance has passed by reference so pending_relationship_subquery will be modified
    subquery.having(node)
    # Return nil case due to pending relationship subquery not yet being applied
    nil
  end
end

#apply_date_refinement(table, input) ⇒ Object 



69
70
71
 
# File 'app/models/refine/conditions/has_refinements.rb', line 69

def apply_date_refinement(table, input)
  get_date_refinement_condition.apply(input, table, nil)
end

#apply_refinements(input) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'app/models/refine/conditions/has_refinements.rb', line 33

def apply_refinements(input)
  if has_any_refinements? && !refinements_allowed?
    raise Errors::RelationshipError, I18n.t("refine.refine_blueprints.has_refinements.not_allowed")
  end

  instance = filter.get_pending_relationship_instance

  subquery_table = instance.klass.arel_table
  subquery = filter.get_pending_relationship_subquery

  if @date_refinement_proc
    nodes = apply_date_refinement(subquery_table, input[:date_refinement])
  end
  if @count_refinement_proc
    apply_count_refinement(table: subquery_table, input: input[:count_refinement], subquery: subquery, instance: instance)
  end
  nodes
end

#define_count_condition ⇒ Object 



29
30
31
 
# File 'app/models/refine/conditions/has_refinements.rb', line 29

def define_count_condition
  proc { NumericCondition.new("count_refinement") }
end

#define_date_condition(attribute:) ⇒ Object 



20
21
22
 
# File 'app/models/refine/conditions/has_refinements.rb', line 20

def define_date_condition(attribute:)
  proc { DateCondition.new("date_refinement").with_attribute(attribute).attribute_is_date_with_time }
end

#get_count_refinement_condition ⇒ Object 



132
133
134
135
136
137
138
139
 
# File 'app/models/refine/conditions/has_refinements.rb', line 132

def get_count_refinement_condition
  condition = @count_refinement_proc.call
  # Overwrite any passed in id's with count_refinement
  condition.id = "count_refinement"
  condition.is_refinement = true
  condition.raw_attribute("COUNT(*)")
  filter.instantiate_condition(condition)
end

#get_date_refinement_condition ⇒ Object 



123
124
125
126
127
128
129
130
 
# File 'app/models/refine/conditions/has_refinements.rb', line 123

def get_date_refinement_condition
  # Create the condition from the callable
  condition = @date_refinement_proc.call
  # Overwrite any passed in id's with date_refinement
  condition.id = "date_refinement"
  condition.is_refinement = true
  filter.instantiate_condition(condition)
end

#has_any_refinements? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'app/models/refine/conditions/has_refinements.rb', line 52

def has_any_refinements?
  !!(has_date_refinement? || has_count_refinement?)
end

#has_count_refinement? ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
 
# File 'app/models/refine/conditions/has_refinements.rb', line 56

def has_count_refinement?
  @count_refinement_proc
end

#has_date_refinement? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
 
# File 'app/models/refine/conditions/has_refinements.rb', line 60

def has_date_refinement?
  @date_refinement_proc
end

#refine_by_count(callable = nil) ⇒ Object 



24
25
26
27
 
# File 'app/models/refine/conditions/has_refinements.rb', line 24

def refine_by_count(callable = nil)
  @count_refinement_proc = callable.present? ? callable : define_count_condition
  self
end

#refine_by_date(callable = nil) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
 
# File 'app/models/refine/conditions/has_refinements.rb', line 8

def refine_by_date(callable = nil)
  # Developer can send in a string that represents the attribute or a proc that is a fully qualified class
  # If a callable is given and it is a string, we assume that is the desired attribute. Otherwise we use
  # the passed in callable. If no callable is given we create on based on standard date with time condition
  @date_refinement_proc = if callable.present?
    (callable.is_a? String) ? define_date_condition(attribute: callable) : callable
  else
    define_date_condition(attribute: "created_at")
  end
  self
end

#refine_by_filter(filter_condition) ⇒ Object 



3
4
5
6
 
# File 'app/models/refine/conditions/has_refinements.rb', line 3

def refine_by_filter(filter_condition)
  @filter_refinement_proc = proc { filter_condition }
  self
end

#refinements_allowed? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
67
 
# File 'app/models/refine/conditions/has_refinements.rb', line 64

def refinements_allowed?
  instance = filter.get_pending_relationship_instance
  (instance.is_a? ActiveRecord::Reflection::HasManyReflection) || (instance.is_a? ActiveRecord::Reflection::ThroughReflection)
end

#refinements_to_array ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'app/models/refine/conditions/has_refinements.rb', line 141

def refinements_to_array
  if is_refinement
    []
  else
    refinement_array = []
    if @date_refinement_proc
      refinement_array << get_date_refinement_condition.to_array
    end
    if @count_refinement_proc
      refinement_array << get_count_refinement_condition.to_array
    end
    refinement_array
  end
end