openproject/spec/support/components/work_packages/relations.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 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 docs/COPYRIGHT.rdoc for more details.
#++

require 'support/components/ng_select_autocomplete_helpers'

module Components
  module WorkPackages
    class Relations
      include Capybara::DSL
      include RSpec::Matchers
      include ::Components::NgSelectAutocompleteHelpers

      attr_reader :work_package

      def initialize(work_package)
        @work_package = work_package
      end

      def find_row(relatable)
        page.find(".relation-row-#{relatable.id}")
      end

      def click_relation(relatable)
        SeleniumHubWaiter.wait
        page.find(".relation-row-#{relatable.id} .wp-relations--subject-field").click
      end

      def edit_relation_type(relatable, to_type:)
        row = find_row(relatable)
        SeleniumHubWaiter.wait
        row.find('.relation-row--type').click

        expect(row).to have_selector('select.inline-edit--field')
        row.find('.inline-edit--field option', text: to_type).select_option
      end

      def hover_action(relatable, action)
        retry_block do
          # Focus type edit to expose buttons
          span = page.find(".relation-row-#{relatable.id} .relation-row--type", wait: 20)
          scroll_to_element(span)
          page.driver.browser.action.move_to(span.native).perform

          # Click the corresponding action button
          SeleniumHubWaiter.wait
          row = find_row(relatable)
          case action
          when :delete
            row.find('.relation-row--remove-btn').click
          when :info
            row.find('.wp-relations--description-btn').click
          end
        end
      end

      def remove_relation(relatable)
        ## Delete relation
        hover_action(relatable, :delete)

        # Expect relation to be gone
        expect_no_relation(relatable)
      end

      def add_relation(type:, to:)
        # Open create form
        SeleniumHubWaiter.wait
        find('#relation--add-relation').click

        # Select relation type
        container = find('.wp-relations-create--form', wait: 10)

        # Labels to expect
        relation_label = I18n.t('js.relation_labels.' + type)

        select relation_label, from: 'relation-type--select'

        # Enter the query and select the child
        autocomplete = container.find(".wp-relations--autocomplete")
        select_autocomplete autocomplete,
                            results_selector: '.ng-dropdown-panel-items',
                            query: to.subject,
                            select_text: to.subject

        expect(page).to have_selector('.relation-group--header',
                                      text: relation_label.upcase,
                                      wait: 10)

        expect(page).to have_selector('.relation-row--type', text: to.type.name)

        expect(page).to have_selector('.wp-relations--subject-field', text: to.subject)

        ## Test if relation exist
        work_package.reload
        relation = work_package.relations.last
        expect(relation.label_for(work_package).to_s).to eq("label_#{type}")
        expect(relation.other_work_package(work_package).id).to eq(to.id)
      end

      def expect_relation(relatable)
        expect(relations_group).to have_selector('.wp-relations--subject-field', text: relatable.subject)
      end

      def expect_relation_by_text(text)
        expect(relations_group).to have_selector('.wp-relations--subject-field', text: text)
      end

      def expect_no_relation(relatable)
        expect(page).to have_no_selector('.wp-relations--subject-field', text: relatable.subject)
      end

      def add_parent(query, work_package)
        # Open the parent edit
        SeleniumHubWaiter.wait
        find('.wp-relation--parent-change').click

        # Enter the query and select the child
        SeleniumHubWaiter.wait
        autocomplete = find(".wp-relations--autocomplete")
        select_autocomplete autocomplete,
                            query: query,
                            results_selector: '.ng-dropdown-panel-items',
                            select_text: work_package.id
      end

      def expect_parent(work_package)
        expect(page).to have_selector '.wp-breadcrumb-parent',
                                      text: work_package.subject,
                                      wait: 10
      end

      def expect_no_parent
        expect(page).to have_no_selector '.wp-breadcrumb-parent', wait: 10
      end

      def remove_parent
        SeleniumHubWaiter.wait
        find('.wp-relation--parent-remove').click
      end

      def inline_create_child(subject_text)
        container = find('.wp-relations--children')
        scroll_to_and_click(container.find('.wp-inline-create-button-row .wp-inline-create--add-link'))

        subject = ::EditField.new(container, 'subject')
        subject.expect_active!
        subject.update subject_text
      end

      def openChildrenAutocompleter
        retry_block do
          next if page.has_selector?('.wp-relations--children .ng-input input')
          SeleniumHubWaiter.wait
          find('.wp-inline-create--reference-link', text: I18n.t('js.relation_buttons.add_existing_child')).click

          # Security check to be sure that the autocompleter has finished loading
          page.find '.wp-relations--children .ng-input input'
        end
      end

      def add_existing_child(work_package)
        # Enter the query and select the child
        autocomplete = page.find(".wp-relations--add-form .wp-relations--autocomplete")
        select_autocomplete autocomplete,
                            query: work_package.id,
                            results_selector: '.ng-dropdown-panel-items',
                            select_text: work_package.subject
      end

      def expect_child(work_package)
        container = find('wp-relations-hierarchy wp-children-query')

        within container do
          expect(page)
            .to have_selector('.wp-table--cell-td.subject', text: work_package.subject, wait: 10)
        end
      end

      def expect_not_child(work_package)
        page.within('wp-relations-tab .work-packages-embedded-view--container') do
          row = ".wp-row-#{work_package.id}-table"

          expect(page).to have_no_selector(row)
        end
      end

      def children_table
        ::Pages::EmbeddedWorkPackagesTable.new find('wp-relations-tab .work-packages-embedded-view--container')
      end

      def relations_group
        find('wp-relations-tab wp-relations-group')
      end

      def remove_child(work_package)
        page.within('.work-packages-embedded-view--container') do
          row = ".wp-row-#{work_package.id}-table"

          SeleniumHubWaiter.wait
          find(row).hover
          find("#{row} .wp-table-action--unlink").click
        end
      end
    end
  end
end