Welcome to mirror list, hosted at ThFree Co, Russian Federation.

offset_header_builder.rb « pagination « gitlab « lib - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 32089e40932d501ad969270f2f7a43076c4efeee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# frozen_string_literal: true

module Gitlab
  module Pagination
    class OffsetHeaderBuilder
      attr_reader :request_context, :per_page, :page, :next_page, :prev_page, :total, :total_pages

      delegate :params, :header, :request, to: :request_context

      def initialize(request_context:, per_page:, page:, next_page:, prev_page: nil, total:, total_pages:)
        @request_context = request_context
        @per_page = per_page
        @page = page
        @next_page = next_page
        @prev_page = prev_page
        @total = total
        @total_pages = total_pages
      end

      def execute(exclude_total_headers: false, data_without_counts: false)
        header 'X-Per-Page',    per_page.to_s
        header 'X-Page',        page.to_s
        header 'X-Next-Page',   next_page.to_s
        header 'X-Prev-Page',   prev_page.to_s
        header 'Link',          pagination_links(data_without_counts)

        return if exclude_total_headers || data_without_counts

        header 'X-Total',       total.to_s
        header 'X-Total-Pages', total_pages.to_s
      end

      private

      def pagination_links(data_without_counts)
        [].tap do |links|
          links << %(<#{page_href(page: prev_page)}>; rel="prev") if prev_page
          links << %(<#{page_href(page: next_page)}>; rel="next") if next_page
          links << %(<#{page_href(page: 1)}>; rel="first")

          links << %(<#{page_href(page: total_pages)}>; rel="last") unless data_without_counts
        end.join(', ')
      end

      def base_request_uri
        @base_request_uri ||= URI.parse(request.url).tap do |uri|
          uri.host = Gitlab.config.gitlab.host
          uri.port = Gitlab.config.gitlab.port
        end
      end

      def build_page_url(query_params:)
        base_request_uri.tap do |uri|
          uri.query = query_params
        end.to_s
      end

      def page_href(next_page_params = {})
        query_params = params.merge(**next_page_params, per_page: params[:per_page]).to_query

        build_page_url(query_params: query_params)
      end
    end
  end
end