openproject/spec/support/matchers/be_html_eql.rb

#-- encoding: UTF-8
#-- 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.
#++

::RSpec::Matchers.define :be_html_eql do |expected|
  def path
    @path
  end

  def html(html)
    Nokogiri::HTML(html)
  end

  match do |actual|
    @actual = if path
                html(actual).css(path)
              else
                actual
              end

    raise "Path specified is missing (#{path.inspect})" if path && @actual.empty?

    EquivalentXml.equivalent?(self.actual, expected, {})
  end

  chain :at_path do |path|
    @path = path
  end

  chain :within_path do |path|
    @path = path + ' > *'
  end

  should_message = ->(actual) do
    ['expected:', expected.to_s, 'got:', actual.to_s].join("\n")
  end

  should_not_message = ->(actual) do
    ['expected:', actual.to_s, 'not to be equivalent to:', expected.to_s].join("\n")
  end

  failure_message &should_message
  failure_message_when_negated &should_not_message
end