scinote-eln/scinote-web
1
1
Fork 0
mirror of https://github.com/scinote-eln/scinote-web.git synced 2025-02-05 14:41:53 +08:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1897 from jbargu/jg_sci_3646

Browse source 
[SCI-3646] Add paging functionality to external protocols
This commit is contained in:
Jure Grabnar 2019-07-08 13:06:19 +02:00 committed by GitHub
commit ae7da78bff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 101 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
app/assets/javascripts/protocols/external_protocols_tab.js
View file

@ -53,6 +53,14 @@ function setDefaultViewState() {
$('.list-wrapper').hide();
}
// Handle clicks on Load more protocols button
function applyClickCallbackOnShowMoreProtocols() {
$('.show-more-protocols-btn button').off('click').on('click', function() {
$('form.protocols-search-bar #page-id').val($(this).data('next-page-id'));
$('form.protocols-search-bar').submit();
});
}
// Apply AJAX callbacks onto the search box
function applySearchCallback() {
var timeout;
@ -75,20 +83,31 @@ function applySearchCallback() {
// Bind ajax calls on the form
$('form.protocols-search-bar').off('ajax:success').off('ajax:error')
.bind('ajax:success', function(evt, data, status, xhr) {
if (data.html) {
.bind('ajax:success', function(evt, data) {
if (data.page_id > 1) {
// Remove old load more button since we will append a new one
$('.show-more-protocols-btn').remove();
$('.list-wrapper').append(data.html);
} else if (data.html) {
resetPreviewPanel();
$('.empty-text').hide();
$('.list-wrapper').show();
$('.list-wrapper').html(data.html);
applyClickCallbackOnProtocolCards();
initLoadProtocolModalPreview();
$('.list-wrapper').scrollTo(0);
} else {
setDefaultViewState();
}
// Reset page id after every request
$('form.protocols-search-bar #page-id').val(1);
// Apply all callbacks on new elements
applyClickCallbackOnProtocolCards();
applyClickCallbackOnShowMoreProtocols();
initLoadProtocolModalPreview();
})
.bind("ajax:error", function(evt, xhr, status, error) {
.bind('ajax:error', function(evt, xhr) {
setDefaultViewState();
console.log(xhr.responseText);

5
app/assets/stylesheets/protocol_management.scss
View file

@ -196,6 +196,11 @@
padding-right: 0;
}
.show-more-protocols-btn {
margin-bottom: 5px;
margin-top: 5px;
}
}
.protocol-preview-panel {

3
app/controllers/external_protocols_controller.rb
View file

@ -15,7 +15,8 @@ class ExternalProtocolsController < ApplicationController
html: render_to_string(
partial: 'protocol_importers/list_of_protocol_cards.html.erb',
locals: { protocols: service_call.protocols_list, show_import_button: show_import_button }
)
),
page_id: service_call.protocols_list[:pagination][:current_page]
}
else
render json: { errors: service_call.errors }, status: 400

4
app/services/protocol_importers/search_protocols_service.rb
View file

@ -41,9 +41,7 @@ module ProtocolImporters
@errors[:invalid_params][:key] = 'Key cannot be empty' if @query_params[:key].blank?
# try if page id is ok
if @query_params[:page_id] && !@query_params[:page_id].to_i.positive?
@errors[:invalid_params][:page_id] = 'Page needs to be positive'
end
@errors[:invalid_params][:page_id] = 'Page needs to be positive' if @query_params[:page_id]&.to_i&.negative?
# try if endpints exists
@errors[:invalid_params][:source_endpoint] = 'Wrong source endpoint' unless endpoint_name&.is_a?(String)

5
app/utilities/protocol_importers/protocols_io/v3/api_client.rb
View file

@ -46,10 +46,11 @@ module ProtocolImporters
response = with_handle_network_errors do
sort_mappings = CONSTANTS[:sort_mappings]
query = CONSTANTS.dig(:endpoints, :protocols, :default_query_params)
.stringify_keys
.merge(query_params.except(:sort_by))
if sort_mappings[query_params[:sort_by]&.to_sym]
query = query.merge(sort_mappings[query_params[:sort_by].to_sym])
query = query.merge(sort_mappings[query_params[:sort_by].to_sym].stringify_keys)
end
self.class.get('/protocols', query: query)
@ -95,7 +96,7 @@ module ProtocolImporters
when 1219
raise ProtocolImporters::ProtocolsIO::V3::UnauthorizedError.new(:token_expires), error_message
else
raise ProtocolImporters::ProtocolsIO::V3::Error.new(e.class), error_message
raise ProtocolImporters::ProtocolsIO::V3::Error.new(:api_response_error), response.parsed_response
end
end
end

9
app/utilities/protocol_importers/protocols_io/v3/protocol_normalizer.rb
View file

@ -73,6 +73,7 @@ module ProtocolImporters
def normalize_list(client_data)
# client_data is HttpParty ApiReponse object
protocols_hash = client_data.parsed_response.with_indifferent_access[:items]
pagination = client_data.parsed_response.with_indifferent_access[:pagination]
normalized_data = {}
normalized_data[:protocols] = protocols_hash.map do |e|
@ -87,6 +88,14 @@ module ProtocolImporters
uri: e[:uri]
}
end
# Parse pagination
normalized_data[:pagination] = {
current_page: pagination[:current_page],
total_pages: pagination[:total_pages],
page_size: pagination[:page_size]
}
normalized_data
rescue StandardError => e
raise ProtocolImporters::ProtocolsIO::V3::NormalizerError.new(e.class.to_s.downcase.to_sym), e.message

9
app/views/protocol_importers/_list_of_protocol_cards.html.erb
View file

@ -2,3 +2,12 @@
<%= render partial: 'protocol_importers/protocol_card',
locals: { protocol: protocol, show_import_button: show_import_button } %>
<% end %>
<% if protocols[:pagination][:current_page] + 1 <= protocols[:pagination][:total_pages] %>
<div class='show-more-protocols-btn text-center'>
<button class='btn btn-default'
data-next-page-id='<%= protocols[:pagination][:current_page] + 1 %>'>
<%= t('protocol_importers.show_more_button.title') %>
</button>
</div>
<% end %>

36
app/views/protocol_importers/_protocol_card.html.erb
View file

@ -1,25 +1,25 @@
<div class='protocol-card'
data-id='<%= protocol[:id] %>'
data-protocol-source='<%= protocol[:source] %>'
data-url='<%= team_build_external_protocol_path(current_team.id,) %>'
data-show-url='<%= team_show_external_protocol_path(current_team.id) %>'
data-show-protocol-id='<%= protocol[:uri] %>'>
<p class='protocol-title'><%= protocol[:title] %></p>
data-id='<%= protocol[:id] %>'
data-protocol-source='<%= protocol[:source] %>'
data-url='<%= team_build_external_protocol_path(current_team.id,) %>'
data-show-url='<%= team_show_external_protocol_path(current_team.id) %>'
data-show-protocol-id='<%= protocol[:uri] %>'>
<p class='protocol-title'><%= protocol[:title] %></p>
<div class='row'>
<div class='row col-md-12 info-line'>
<%= l(Time.at(protocol[:created_on]).to_datetime, format: :full_date) %> • <%= protocol[:authors] %>
</div>
<div class='row'>
<div class='row col-md-12 info-line'>
<%= l(Time.at(protocol[:created_on]).to_datetime, format: :full_date) %> • <%= protocol[:authors] %>
</div>
<div class='row'>
<div class='col-md-6 info-line'>
<%= t('protocol_importers.card.views_and_steps', nr_of_views: protocol[:nr_of_views], nr_of_steps: protocol[:nr_of_steps]) %>
</div>
<div class='col-md-6 info-line'>
<div class='row'>
<div class='col-md-6 info-line'>
<%= t('protocol_importers.card.views_and_steps', nr_of_views: protocol[:nr_of_views], nr_of_steps: protocol[:nr_of_steps]) %>
</div>
<div class='col-md-6 info-line'>
<% if show_import_button %>
<button type="button" class='external-import-btn btn btn-primary pull-right'><%= t('protocol_importers.card.import_button_text') %></button>
<% end %>
</div>
</div>
</div>
</div>
</div>
</div>
</div>

1
app/views/protocols/index/_external_protocols_tab.html.erb
View file

@ -10,6 +10,7 @@
class: 'protocolsio-logo' %>
<span class='protocolsio-title'><%= t('protocols.index.external_protocols.protocolsio_title') %></span>
<%= hidden_field_tag 'protocol_source', 'protocolsio/v3' %>
<%= hidden_field_tag 'page_id', 1, id: 'page-id' %>
</div>
<div class='input-group'>

2
config/initializers/constants.rb
View file

@ -231,7 +231,7 @@ class Constants
key: '',
order_field: :activity,
order_dir: :desc,
page_size: 10,
page_size: 50,
page_id: 1,
fields: 'id,title,authors,created_on,uri,stats'
}

2
config/locales/protocols/en.yml
View file

@ -5,6 +5,8 @@ en:
card:
views_and_steps: '%{nr_of_views} views • %{nr_of_steps} steps'
import_button_text: 'Import...'
show_more_button:
title: 'Show more protocols'
templates:
amount:
title: 'Amount'

22
spec/controllers/external_protocols_controller_spec.rb
View file

@ -15,8 +15,8 @@ describe ExternalProtocolsController, type: :controller do
team_id: team.id,
key: 'search_string',
protocol_source: 'protocolsio/v3',
page_id: 1,
page_size: 10,
page_id: 2,
page_size: 50,
order_field: 'activity',
order_dir: 'desc'
}
@ -24,10 +24,21 @@ describe ExternalProtocolsController, type: :controller do
let(:action) { get :index, params: params }
let(:valid_search_response) do
{
protocols: [],
pagination: {
current_page: 2,
total_pages: 6,
page_size: 10
}
}
end
before do
service = double('success_service')
allow(service).to(receive(:succeed?)).and_return(true)
allow(service).to(receive(:protocols_list)).and_return({})
allow(service).to(receive(:protocols_list)).and_return(valid_search_response)
allow_any_instance_of(ProtocolImporters::SearchProtocolsService).to(receive(:call)).and_return(service)
end
@ -42,6 +53,11 @@ describe ExternalProtocolsController, type: :controller do
action
expect(JSON.parse(response.body)).to have_key('html')
end
it 'contains page_id in the response' do
action
expect(JSON.parse(response.body)['page_id']).to eq 2
end
end
describe 'GET show' do

7
spec/fixtures/files/protocol_importers/normalized_list.json vendored
View file

@ -100,5 +100,10 @@
"nr_of_views": 33,
"uri": "SN-Maintenance-Medium-for-Synechococcus-c9hz35"
}
]
],
"pagination": {
"current_page": 1,
"total_pages": 6,
"page_size": 10
}
}

2
spec/services/protocol_importers/search_protocols_service_spec.rb
View file

@ -72,7 +72,7 @@ describe ProtocolImporters::SearchProtocolsService do
.and_return(normalized_list))
end
it 'returns an error when params are invalid' do
it 'returns normalized list' do
expect(service_call.protocols_list).to be == normalized_list
end
end