kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
3.7 KiB
117 lines
3.7 KiB
#-- encoding: UTF-8
|
|
|
|
#-- copyright
|
|
# OpenProject is an open source project management software.
|
|
# Copyright (C) 2012-2020 the OpenProject GmbH
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License version 3.
|
|
#
|
|
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
# Copyright (C) 2006-2017 Jean-Philippe Lang
|
|
# Copyright (C) 2010-2013 the ChiliProject Team
|
|
#
|
|
# 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.
|
|
#
|
|
# See docs/COPYRIGHT.rdoc for more details.
|
|
#++
|
|
|
|
# Other than the Roar based representers of the api v3, this
|
|
# representer is only responsible for transforming a query's
|
|
# attributes into a hash which in turn can be used e.g. to be displayed
|
|
# in a url
|
|
|
|
module API
|
|
module V3
|
|
module Queries
|
|
class QueryParamsRepresenter
|
|
def initialize(query)
|
|
self.query = query
|
|
end
|
|
|
|
##
|
|
# To json hash outputs the hash to be parsed to the frontend http
|
|
# which contains a reference to the columns array as columns[].
|
|
# This will match the Rails +to_query+ output
|
|
def to_json
|
|
to_h(column_key: 'columns[]'.to_sym).to_json
|
|
end
|
|
|
|
##
|
|
# Output as query params used for directly using in URL queries.
|
|
# Outputs columns[]=A,columns[]=B due to Rails query output.
|
|
def to_url_query(merge_params: {})
|
|
to_h
|
|
.merge(merge_params.symbolize_keys)
|
|
.to_query
|
|
end
|
|
|
|
def to_h(column_key: :columns)
|
|
p = default_hash
|
|
|
|
p[:showHierarchies] = query.show_hierarchies
|
|
p[:showSums] = query.display_sums?
|
|
p[:groupBy] = query.group_by if query.group_by?
|
|
p[:sortBy] = sort_criteria_to_v3 if query.sorted?
|
|
p[column_key] = columns_to_v3 unless query.has_default_columns?
|
|
|
|
# an empty filter param is also relevant as this would mean to not apply
|
|
# the default filter (status - open)
|
|
p[:filters] = filters_to_v3
|
|
|
|
p
|
|
end
|
|
|
|
def self_link
|
|
if query.project
|
|
api_v3_paths.work_packages_by_project(query.project.id)
|
|
else
|
|
api_v3_paths.work_packages
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def columns_to_v3
|
|
query.column_names.map { |name| convert_to_v3(name) }
|
|
end
|
|
|
|
def sort_criteria_to_v3
|
|
converted = query.sort_criteria.map { |first, last| [convert_to_v3(first), last] }
|
|
|
|
JSON::dump(converted)
|
|
end
|
|
|
|
def filters_to_v3
|
|
converted = query.filters.map do |filter|
|
|
{ convert_to_v3(filter.name) => { operator: filter.operator, values: filter.values } }
|
|
end
|
|
|
|
JSON::dump(converted)
|
|
end
|
|
|
|
def convert_to_v3(attribute)
|
|
::API::Utilities::PropertyNameConverter.from_ar_name(attribute).to_sym
|
|
end
|
|
|
|
def default_hash
|
|
{ offset: 1, pageSize: Setting.per_page_options_array.first }
|
|
end
|
|
|
|
attr_accessor :query
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|