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

Move `Project.workspace_type` validation from contract to model

Christophe Bliardbd3aa2a03171
diff --git a/app/contracts/projects/create_contract.rb b/app/contracts/projects/create_contract.rb
index cabb674b91d..1cc02437b87 100644
--- a/app/contracts/projects/create_contract.rb
+++ b/app/contracts/projects/create_contract.rb
@@ -30,9 +30,9 @@
module Projects
class CreateContract < BaseContract
- attribute :workspace_type do
- validate_workspace_type_included
- end
+ # TODO: differentiate on allowed types based on permissions.
+ # Permissions will need to be added: project, program, portfolio.
+ attribute :workspace_type
include AdminWritableTimestamps
@@ -50,12 +50,6 @@ module Projects
protected
- def validate_workspace_type_included
- # TODO: differentiate on allowed types based on permissions.
- # Permissions will need to be added: project, program, portfolio.
- errors.add(:workspace_type, :blank) if model.workspace_type.nil?
- end
-
def collect_available_custom_field_attributes
model.all_visible_custom_fields.map(&:attribute_name)
end
diff --git a/app/models/project.rb b/app/models/project.rb
index 786c3c686cc..e033cba919e 100644
--- a/app/models/project.rb
+++ b/app/models/project.rb
@@ -52,7 +52,7 @@ class Project < ApplicationRecord
project: "project",
program: "program",
portfolio: "portfolio"
- }
+ }, validate: true
has_many :members, -> {
# TODO: check whether this should
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 397584b8fc1..0521d10694b 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -1146,6 +1146,7 @@ en:
types: "Types"
versions: "Versions"
work_packages: "Work Packages"
+ workspace_type: "Workspace type"
project_custom_field:
is_required: "Required for all projects"
custom_field_section: Section
diff --git a/spec/contracts/projects/create_contract_spec.rb b/spec/contracts/projects/create_contract_spec.rb
index a10016e3f20..bca29ff381e 100644
--- a/spec/contracts/projects/create_contract_spec.rb
+++ b/spec/contracts/projects/create_contract_spec.rb
@@ -81,7 +81,7 @@ RSpec.describe Projects::CreateContract do
context "if workspace_type is nil" do
let(:project_workspace_type) { nil }
- it_behaves_like "contract is invalid", workspace_type: %i(blank)
+ it_behaves_like "contract is invalid", workspace_type: %i[inclusion]
end
context "if workspace type is 'project'" do
@@ -102,6 +102,12 @@ RSpec.describe Projects::CreateContract do
it_behaves_like "contract is valid"
end
+ context "if workspace type is 'invalid type'" do
+ let(:project_workspace_type) { "invalid type" }
+
+ it_behaves_like "contract is invalid", workspace_type: %i[inclusion]
+ end
+
describe "permissions" do
shared_examples "can write" do
let(:value) { 1 }
diff --git a/spec/models/project_spec.rb b/spec/models/project_spec.rb
index 1852d2bacd9..47dc30aa1f6 100644
--- a/spec/models/project_spec.rb
+++ b/spec/models/project_spec.rb
@@ -32,6 +32,7 @@ require "spec_helper"
RSpec.describe Project do
include BecomeMember
+
shared_let(:admin) { create(:admin) }
let(:active) { true }
@@ -185,6 +186,18 @@ RSpec.describe Project do
end
end
+ describe "workspace_type" do
+ it "is set to nil by default, to force having errors when it has not been set" do
+ # Would it make sense to have "project" as default value?
+ project = described_class.new
+ expect(project.workspace_type).to be_nil
+ end
+
+ it "must be one of the allowed values: #{described_class.workspace_types.keys}" do
+ expect(project).to validate_inclusion_of(:workspace_type).in_array(%w[project program portfolio])
+ end
+ end
+
describe "#types_used_by_work_packages" do
let(:project) { create(:project_with_types) }
let(:type) { project.types.first }