yast/yast-yast2

# Copyright (c) [2020] SUSE LLC
#
# All Rights Reserved.
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of version 2 of the GNU General Public License as published
# by the Free Software Foundation.
#
# 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, contact SUSE LLC.
#
# To contact SUSE LLC about this file by physical or electronic mail, you may
# find current contact information at www.suse.com.

require "forwardable"

module Installation
  module AutoinstIssues
    # List of AutoYaST problems
    #
    # @example Registering some partition problems
    #   section = PartitionSection.new({})
    #   list = List.new
    #   list.add(Y2Storage::AutoinstIssues::MissingRoot)
    #   list.add(Y2Storage::AutoinstIssues::InvalidValue,
    #             section, :size, "auto")
    #   list.empty? #=> false
    # @example Iterating through the list of problems
    #   list.map(&:severity) #=> [:warn]
    #
    # @example Adding a problem with additional arguments
    #   fd_section = Y2Firewall::AutoinstProfile::FirewallSection.new()
    #   AutoInstall.issues_list.add(
    #     ::Installation::AutoinstIssues::InvalidValue,
    #     fd_section, "FW_DEV_INT", "1",
    #     _("Is not supported anymore."))
    #
    class List
      include Enumerable
      extend Forwardable

      def_delegators :@items, :each, :empty?, :<<

      # Constructor
      def initialize
        @items = []
      end

      # Add a problem to the list
      #
      # The type of the problem is class of the regarding issue
      # e.g.: `MissingRoot`
      #
      # If a given type of problem requires some additional arguments, they
      # should be added when calling this method. See the next example.
      #
      # @example Adding a problem with additional arguments
      #   fd_section = Y2Firewall::AutoinstProfile::FirewallSection.new()
      #   AutoInstall.issues_list.add(
      #     ::Installation::AutoinstIssues::InvalidValue,
      #     fd_section, "FW_DEV_INT", "1",
      #     _("Is not supported anymore."))
      #
      # @param klass      [Class] Issue class
      # @param extra_args [Array] Additional arguments for the given problem
      # @return [Array<Issue>] List of problems
      def add(klass, *extra_args)
        self << klass.new(*extra_args)
      end

      # Determine whether any of the problem on the list is fatal
      #
      # @return [Boolean] true if any of them is a fatal problem
      def fatal?
        any?(&:fatal?)
      end

      # Returns an array containing registered problems
      #
      # @return [Array<Issue>] List of problems
      def to_a
        @items
      end
    end
  end
end