openproject/spec/lib/deprecated_alias_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2022 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'

describe DeprecatedAlias do
  let(:clazz) do
    Class.new do
      extend DeprecatedAlias

      def secret_key
        'happiness'
      end
      deprecated_alias :special_key, :secret_key
    end
  end

  subject(:object) { clazz.new }

  let(:deprecation_warning) do
    <<~MSG
      special_key is deprecated and will be removed in a future OpenProject version.

      Please use secret_key instead.

    MSG
  end

  before do
    expect(ActiveSupport::Deprecation).to receive(:warn)
      .with(deprecation_warning, an_instance_of(Array))
  end

  it 'aliases the method' do
    expect(object.special_key).to eq('happiness')
  end
end