BigW Consortium Gitlab

todos_finder.rb 3.09 KB
Newer Older
1
# TodosFinder
2
#
3
# Used to filter Todos by set of params
4 5 6 7 8 9 10
#
# Arguments:
#   current_user - which user use
#   params:
#     action_id: integer
#     author_id: integer
#     project_id; integer
11
#     state: 'pending' (default) or 'done'
12 13 14
#     type: 'Issue' or 'MergeRequest'
#

15
class TodosFinder
16
  NONE = '0'.freeze
17 18 19

  attr_accessor :current_user, :params

20
  def initialize(current_user, params = {})
21 22 23 24 25
    @current_user = current_user
    @params = params
  end

  def execute
26
    items = current_user.todos
27
    items = include_associations(items)
28
    items = by_action_id(items)
29
    items = by_action(items)
30 31 32
    items = by_author(items)
    items = by_state(items)
    items = by_type(items)
33 34 35
    # Filtering by project HAS TO be the last because we use
    # the project IDs yielded by the todos query thus far
    items = by_project(items)
36

Felipe Artur committed
37
    sort(items)
38 39 40 41
  end

  private

42 43 44 45 46 47 48 49 50 51 52
  def include_associations(items)
    return items unless params[:include_associations]

    items.includes(
      [
        target: { project: [:route, namespace: :route] },
        author: { namespace: :route },
      ]
    )
  end

53
  def action_id?
54
    action_id.present? && Todo::ACTION_NAMES.has_key?(action_id.to_i)
55 56 57 58 59 60
  end

  def action_id
    params[:action_id]
  end

61 62 63 64 65 66 67 68 69 70 71 72
  def to_action_id
    Todo::ACTION_NAMES.key(action.to_sym)
  end

  def action?
    action.present? && to_action_id
  end

  def action
    params[:action]
  end

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
  def author?
    params[:author_id].present?
  end

  def author
    return @author if defined?(@author)

    @author =
      if author? && params[:author_id] != NONE
        User.find(params[:author_id])
      else
        nil
      end
  end

  def project?
    params[:project_id].present?
  end

  def project
    return @project if defined?(@project)

    if project?
      @project = Project.find(params[:project_id])

98
      unless Ability.allowed?(current_user, :read_project, @project)
99 100 101 102 103 104 105 106 107
        @project = nil
      end
    else
      @project = nil
    end

    @project
  end

108 109
  def projects(items)
    item_project_ids = items.reorder(nil).select(:project_id)
110
    ProjectsFinder.new.execute(current_user, item_project_ids)
111 112
  end

113
  def type?
Douwe Maan committed
114
    type.present? && %w(Issue MergeRequest).include?(type)
115 116 117 118 119 120
  end

  def type
    params[:type]
  end

Felipe Artur committed
121 122 123 124
  def sort(items)
    params[:sort] ? items.sort(params[:sort]) : items.reorder(id: :desc)
  end

125 126 127 128 129 130 131 132
  def by_action(items)
    if action?
      items = items.where(action: to_action_id)
    end

    items
  end

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
  def by_action_id(items)
    if action_id?
      items = items.where(action: action_id)
    end

    items
  end

  def by_author(items)
    if author?
      items = items.where(author_id: author.try(:id))
    end

    items
  end

  def by_project(items)
    if project?
      items = items.where(project: project)
152 153 154
    else
      item_projects = projects(items)
      items = items.merge(item_projects).joins(:project)
155 156 157 158 159 160
    end

    items
  end

  def by_state(items)
161
    case params[:state].to_s
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    when 'done'
      items.done
    else
      items.pending
    end
  end

  def by_type(items)
    if type?
      items = items.where(target_type: type)
    end

    items
  end
end