Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Add a name filter to versions

Oliver Günther328ba0a2cf7b
diff --git a/app/models/queries/versions.rb b/app/models/queries/versions.rb
index 633cc3157ec..7c2a4c1c3ac 100644
--- a/app/models/queries/versions.rb
+++ b/app/models/queries/versions.rb
@@ -31,6 +31,7 @@
module Queries::Versions
::Queries::Register.register(VersionQuery) do
filter Filters::SharingFilter
+ filter Filters::NameFilter
order Orders::DefaultOrder
end
diff --git a/app/models/queries/versions/filters/name_filter.rb b/app/models/queries/versions/filters/name_filter.rb
new file mode 100644
index 00000000000..135d46dc54f
--- /dev/null
+++ b/app/models/queries/versions/filters/name_filter.rb
@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 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-2013 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 COPYRIGHT and LICENSE files for more details.
+#++
+
+class Queries::Versions::Filters::NameFilter < Queries::Versions::Filters::VersionFilter
+ def type
+ :string
+ end
+
+ def where
+ case operator
+ when "="
+ ["LOWER(versions.name) IN (?)", sql_value]
+ when "!"
+ ["LOWER(versions.name) NOT IN (?)", sql_value]
+ when "~", "**"
+ ["LOWER(versions.name) LIKE ?", "%#{sql_value}%"]
+ when "!~"
+ ["LOWER(versions.name) NOT LIKE ?", "%#{sql_value}%"]
+ end
+ end
+
+ def human_name
+ I18n.t(:label_name)
+ end
+
+ def self.key
+ :name
+ end
+
+ private
+
+ def sql_value
+ case operator
+ when "=", "!"
+ values.map { |val| self.class.connection.quote_string(val.downcase) }.join(",")
+ when "**", "~", "!~"
+ values.first.downcase
+ end
+ end
+end
diff --git a/docs/api/apiv3/paths/versions.yml b/docs/api/apiv3/paths/versions.yml
index 7e36aa043cf..fda14b13f28 100644
--- a/docs/api/apiv3/paths/versions.yml
+++ b/docs/api/apiv3/paths/versions.yml
@@ -8,6 +8,7 @@ get:
Currently supported filters are:
+ sharing: filters versions by how they are shared within the server (*none*, *descendants*, *hierarchy*, *tree*, *system*).
+ + name: filters versions by their name.
example: '[{ "sharing": { "operator": "*", "values": ["system"] }" }]'
in: query
name: filters
diff --git a/spec/models/queries/versions/filters/name_filter_spec.rb b/spec/models/queries/versions/filters/name_filter_spec.rb
new file mode 100644
index 00000000000..ddca1a56065
--- /dev/null
+++ b/spec/models/queries/versions/filters/name_filter_spec.rb
@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) 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-2013 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 COPYRIGHT and LICENSE files for more details.
+#++
+
+require "spec_helper"
+
+RSpec.describe Queries::Versions::Filters::NameFilter do
+ include_context "filter tests"
+ let(:values) { ["A name"] }
+ let(:model) { Version }
+
+ it_behaves_like "basic query filter" do
+ let(:class_key) { :name }
+ let(:human_name) { "Name" }
+ let(:type) { :string }
+ let(:model) { Version }
+
+ describe "#allowed_values" do
+ it "is nil" do
+ expect(instance.allowed_values).to be_nil
+ end
+ end
+ end
+end