jro_apps/redmine Commit - r14882:e1aa18b33388

Handle search pagination with the REST API (#6277)....

Jean-Philippe Lang -

r14882:e1aa18b33388

parent child

Context file:

r14882:e1aa18b33388

Collapse all files

app/controllers/search_controller.rb +12 -4

             # Redmine - project management software
             # Copyright (C) 2006-2016  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class SearchController < ApplicationController
               before_filter :find_optional_project
               accept_api_auth :index
               def index
                 @question = params[:q] || ""
                 @question.strip!
                 @all_words = params[:all_words] ? params[:all_words].present? : true
                 @titles_only = params[:titles_only] ? params[:titles_only].present? : false
                 @search_attachments = params[:attachments].presence || '0'
                 @open_issues = params[:open_issues] ? params[:open_issues].present? : false
+                case params[:format]
+                when 'xml', 'json'
+                  @offset, @limit = api_offset_and_limit
+                else
+                  @offset = nil
+                  @limit = Setting.search_results_per_page.to_i
+                  @limit = 10 if @limit == 0
+                end
                 # quick jump to an issue
                 if (m = @question.match(/^#?(\d+)$/)) && (issue = Issue.visible.find_by_id(m[1].to_i))
                   redirect_to issue_path(issue)
                   return
                 end
                 projects_to_search =
                   case params[:scope]
                   when 'all'
                     nil
                   when 'my_projects'
                     User.current.projects
                   when 'subprojects'
                     @project ? (@project.self_and_descendants.active.to_a) : nil
                   else
                     @project
                   end
                 @object_types = Redmine::Search.available_search_types.dup
                 if projects_to_search.is_a? Project
                   # don't search projects
                   @object_types.delete('projects')
                   # only show what the user is allowed to view
                   @object_types = @object_types.select {|o| User.current.allowed_to?("view_#{o}".to_sym, projects_to_search)}
                 end
                 @scope = @object_types.select {|t| params[t]}
                 @scope = @object_types if @scope.empty?
                 fetcher = Redmine::Search::Fetcher.new(
                   @question, User.current, @scope, projects_to_search,
                   :all_words => @all_words, :titles_only => @titles_only, :attachments => @search_attachments, :open_issues => @open_issues,
                   :cache => params[:page].present?
                 )
                 if fetcher.tokens.present?
                   @result_count = fetcher.result_count
                   @result_count_by_type = fetcher.result_count_by_type
                   @tokens = fetcher.tokens
-                  per_page = Setting.search_results_per_page.to_i
+                  @result_pages = Paginator.new @result_count, @limit, params['page']
-                  per_page = 10 if per_page == 0
+                  @offset ||= @result_pages.offset
-                  @result_pages = Paginator.new @result_count, per_page, params['page']
+                  @results = fetcher.results(@offset, @result_pages.per_page)
-                  @results = fetcher.results(@result_pages.offset, @result_pages.per_page)
                 else
                   @question = ""
                 end
                 respond_to do |format|
                   format.html { render :layout => false if request.xhr? }
                   format.api  { @results ||= []; render :layout => false }
                 end
               end
             private
               def find_optional_project
                 return true unless params[:id]
                 @project = Project.find(params[:id])
                 check_project_privacy
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

app/views/search/index.api.rsb +1 -1

-            api.array :results do
+            api.array :results, api_meta(:total_count => @result_count, :offset => @offset, :limit => @limit) do
               @results.each do |result|
                 api.result do
                   api.id          result.id
                   api.title       result.event_title
                   api.type        result.event_type
                   api.url         url_for(result.event_url(:only_path => false))
                   api.description result.event_description
                   api.datetime    result.event_datetime
                 end
               end
             end

test/integration/api_test/search_test.rb +18 0

             # Redmine - project management software
             # Copyright (C) 2006-2016  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../../test_helper', __FILE__)
             class Redmine::ApiTest::SearchTest < Redmine::ApiTest::Base
               fixtures :projects, :projects_trackers,
                        :enabled_modules, :roles, :users, :members, :member_roles,
                        :issues, :trackers, :issue_statuses, :enumerations,
                        :workflows,
                        :custom_fields, :custom_values,
                        :custom_fields_projects, :custom_fields_trackers,
                        :repositories, :changesets
               test "GET /search.xml should return xml content" do
                 get '/search.xml'
                 assert_response :success
                 assert_equal 'application/xml', @response.content_type
               end
               test "GET /search.json should return json content" do
                 get '/search.json'
                 assert_response :success
                 assert_equal 'application/json', @response.content_type
                 json = ActiveSupport::JSON.decode(response.body)
                 assert_kind_of Hash, json
                 assert_kind_of Array, json['results']
               end
               test "GET /search.xml without query strings should return empty results" do
                 get '/search.xml', :q => '', :all_words => ''
                 assert_response :success
                 assert_equal 0, assigns(:results).size
               end
               test "GET /search.xml with query strings should return results" do
                 get '/search.xml', :q => 'recipe subproject commit', :all_words => ''
                 assert_response :success
                 assert_not_empty(assigns(:results))
                 assert_select 'results[type=array]' do
                   assert_select 'result', :count => assigns(:results).count
                   assigns(:results).size.times.each do |i|
                     assert_select 'result' do
                       assert_select 'id',          :text => assigns(:results)[i].id.to_s
                       assert_select 'title',       :text => assigns(:results)[i].event_title
                       assert_select 'type',        :text => assigns(:results)[i].event_type
                       assert_select 'url',         :text => url_for(assigns(:results)[i].event_url(:only_path => false))
                       assert_select 'description', :text => assigns(:results)[i].event_description
                       assert_select 'datetime'
                     end
                   end
                 end
               end
+              test "GET /search.xml should paginate" do
+                issue = (0..10).map {Issue.generate! :subject => 'search_with_limited_results'}.reverse.map(&:id)
+                get '/search.json', :q => 'search_with_limited_results', :limit => 4
+                json = ActiveSupport::JSON.decode(response.body)
+                assert_equal 11, json['total_count']
+                assert_equal 0, json['offset']
+                assert_equal 4, json['limit']
+                assert_equal issue[0..3], json['results'].map {|r| r['id']}
+                get '/search.json', :q => 'search_with_limited_results', :offset => 8, :limit => 4
+                json = ActiveSupport::JSON.decode(response.body)
+                assert_equal 11, json['total_count']
+                assert_equal 8, json['offset']
+                assert_equal 4, json['limit']
+                assert_equal issue[8..10], json['results'].map {|r| r['id']}
+              end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages