# Copyright 2011-2025, The Trustees of Indiana University and Northwestern
#   University.  Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed
#   under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
#   CONDITIONS OF ANY KIND, either express or implied. See the License for the
#   specific language governing permissions and limitations under the License.
# ---  END LICENSE_HEADER BLOCK  ---

module OptionalExample
  RSpec.configure do |config|
    config.after do |example|
      if example.metadata[:optional] && (RSpec::Core::Pending::PendingExampleFixedError === example.display_exception)
        ex = example.display_exception
        example.display_exception = nil
        example.execution_result.pending_exception = ex
      end
    end
  end

  def optional(message)
    RSpec.current_example.metadata[:optional] = true
    pending(message)
  end
end
