BigW Consortium Gitlab

pagination.rb 1.68 KB
Newer Older
1 2 3 4
module API
  module Helpers
    module Pagination
      def paginate(relation)
5
        relation.page(params[:page]).per(params[:per_page]).tap do |data|
6 7 8 9 10 11 12 13
          add_pagination_headers(data)
        end
      end

      private

      def add_pagination_headers(paginated_data)
        header 'X-Total',       paginated_data.total_count.to_s
14
        header 'X-Total-Pages', total_pages(paginated_data).to_s
15 16 17 18 19 20 21 22 23 24 25 26 27 28
        header 'X-Per-Page',    paginated_data.limit_value.to_s
        header 'X-Page',        paginated_data.current_page.to_s
        header 'X-Next-Page',   paginated_data.next_page.to_s
        header 'X-Prev-Page',   paginated_data.prev_page.to_s
        header 'Link',          pagination_links(paginated_data)
      end

      def pagination_links(paginated_data)
        request_url = request.url.split('?').first
        request_params = params.clone
        request_params[:per_page] = paginated_data.limit_value

        links = []

29 30
        request_params[:page] = paginated_data.prev_page
        links << %(<#{request_url}?#{request_params.to_query}>; rel="prev") if request_params[:page]
31

32 33
        request_params[:page] = paginated_data.next_page
        links << %(<#{request_url}?#{request_params.to_query}>; rel="next") if request_params[:page]
34 35 36 37

        request_params[:page] = 1
        links << %(<#{request_url}?#{request_params.to_query}>; rel="first")

38
        request_params[:page] = total_pages(paginated_data)
39 40 41 42
        links << %(<#{request_url}?#{request_params.to_query}>; rel="last")

        links.join(', ')
      end
43 44 45 46 47

      def total_pages(paginated_data)
        # Ensure there is in total at least 1 page
        [paginated_data.total_pages, 1].max
      end
48 49 50
    end
  end
end