move Backlog scope into WorkPackage scope

Author: ulferts

modules/backlogs/app/controllers/backlogs/backlog_controller.rb

@@ -79,7 +79,7 @@ def load_backlogs
                                .order_by_position
                                .group_by(&:sprint_id)
       @active_sprint_ids = @sprints.select(&:active?).map(&:id)
-      @inbox_work_packages = Backlog.inbox_for(project: @project)
+      @inbox_work_packages = WorkPackage.backlogs_inbox_for(project: @project)
     end
   end
 end

modules/backlogs/app/controllers/backlogs/inbox_controller.rb

@@ -40,7 +40,7 @@ def menu
       backlog_items_scope = if OpenProject::FeatureDecisions.backlog_buckets_active? && @work_package.backlog_bucket_id
                               @work_package.backlog_bucket.work_packages
                             else
-                              Backlog.inbox_for(project: @project)
+                              WorkPackage.backlogs_inbox_for(project: @project)
                             end
 
       max_position = backlog_items_scope.maximum(:position) || 0
@@ -99,7 +99,7 @@ def load_work_package
     end
 
     def replace_inbox_component_via_turbo_stream
-      inbox_work_packages = Backlog.inbox_for(project: @project)
+      inbox_work_packages = WorkPackage.backlogs_inbox_for(project: @project)
       backlog_buckets = if OpenProject::FeatureDecisions.backlog_buckets_active?
                           Agile::BacklogBucket.for_project(@project)
                         end

modules/backlogs/app/controllers/backlogs/work_packages_controller.rb

@@ -125,7 +125,7 @@ def moved_to_inbox
       render_success_flash_message_via_turbo_stream(
         message: I18n.t(:notice_successful_move, from: @sprint.name, to: I18n.t(:label_inbox))
       )
-      inbox_work_packages = Backlog.inbox_for(project: @project)
+      inbox_work_packages = WorkPackage.backlogs_inbox_for(project: @project)
       backlog_buckets = if OpenProject::FeatureDecisions.backlog_buckets_active?
                           Agile::BacklogBucket.for_project(@project)
                         end

modules/backlogs/app/models/backlog.rb …rk_packages/scopes/backlogs_inbox_for.rbmodules/backlogs/app/models/backlog.rb renamed to modules/backlogs/app/models/work_packages/scopes/backlogs_inbox_for.rb modules/backlogs/app/models/backlog.rb renamed to modules/backlogs/app/models/work_packages/scopes/backlogs_inbox_for.rb

@@ -1,4 +1,6 @@
-#-- copyright
+# frozen_string_literal: true
+
+# -- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
 #
@@ -24,37 +26,26 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 # See COPYRIGHT and LICENSE files for more details.
-#++
-
-class Backlog
-  extend ActiveModel::Naming
-
-  attr_accessor :sprint, :stories
-
-  delegate :id, to: :sprint, prefix: true
+# ++
 
-  def self.inbox_for(project:)
-    inbox_condition = if OpenProject::FeatureDecisions.backlog_buckets_active?
-                        { sprint_id: nil, backlog_bucket_id: nil }
-                      else
-                        { sprint_id: nil }
-                      end
+module WorkPackages::Scopes::BacklogsInboxFor
+  extend ActiveSupport::Concern
 
-    WorkPackage
-      .visible
-      .with_status_open
-      .where(project:, **inbox_condition)
-      .includes(:type)
-      .order_by_position
-      .order(WorkPackage.arel_table[:id].asc)
-  end
-
-  def initialize(sprint:, stories:)
-    @sprint = sprint
-    @stories = stories
-  end
+  class_methods do
+    def backlogs_inbox_for(project:)
+      inbox_condition = if OpenProject::FeatureDecisions.backlog_buckets_active?
+                          { sprint_id: nil, backlog_bucket_id: nil }
+                        else
+                          { sprint_id: nil }
+                        end
 
-  def to_key
-    [sprint_id]
+      WorkPackage
+        .visible
+        .with_status_open
+        .where(project:, **inbox_condition)
+        .includes(:type)
+        .order_by_position
+        .order(WorkPackage.arel_table[:id].asc)
+    end
   end
 end

modules/backlogs/lib/open_project/backlogs/patches/work_package_patch.rb

@@ -47,6 +47,8 @@ module OpenProject::Backlogs::Patches::WorkPackagePatch
     belongs_to :sprint, optional: true
 
     include OpenProject::Backlogs::List
+
+    scopes :backlogs_inbox_for
   end
 
   module ClassMethods

modules/backlogs/spec/models/backlog_spec.rb

@@ -0,0 +1,71 @@
+# 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 WorkPackages::Scopes::BacklogsInboxFor do
+  let(:project) { create(:project) }
+  let(:open_status) { create(:status, is_closed: false) }
+  let(:closed_status) { create(:status, is_closed: true) }
+  let(:sprint) { create(:sprint, project:) }
+
+  before { login_as create(:admin) }
+
+  subject(:inbox) { WorkPackage.backlogs_inbox_for(project:) }
+
+  describe ".backlogs_inbox_for" do
+    it "returns work packages with no sprint assigned and open status" do
+      inbox_wp = create(:work_package, project:, status: open_status)
+      create(:work_package, project:, status: closed_status)
+      create(:work_package, project:, status: open_status, sprint:)
+
+      expect(inbox).to contain_exactly(inbox_wp)
+    end
+
+    it "excludes work packages from other projects" do
+      create(:work_package, status: open_status)
+      own_wp = create(:work_package, project:, status: open_status)
+
+      expect(inbox).to contain_exactly(own_wp)
+    end
+
+    it "orders by position ascending, falling back to id for unpositioned items" do
+      wp1 = create(:work_package, project:, status: open_status, position: 2)
+      wp2 = create(:work_package, project:, status: open_status, position: 1)
+      wp3 = create(:work_package, project:, status: open_status, position: nil)
+      wp4 = create(:work_package, project:, status: open_status, position: nil)
+
+      wp3.update_column(:position, nil)
+      wp4.update_column(:position, nil)
+
+      expect(inbox).to eq([wp2, wp1, wp3, wp4])
+    end
+  end
+end