config-files-api/config_files_api_grub2

View on GitHub
lib/cfa/grub2/grub_cfg.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

require "cfa/base_model"

module CFA
  module Grub2
    # Represents generated grub configuration at /boot/grub2/grub.cfg
    # Main features:
    #
    # - List of generated sections including translations
    class GrubCfg < BaseModel
      PATH = "/boot/grub2/grub.cfg"

      # @private only internal parser
      class Parser
        def self.parse(string)
          submenu = []
          string.lines.each_with_object([]) do |line, result|
            case line
            when /menuentry\s+'/ then result << parse_entry(line, submenu)
            when /^\s*}\s*\n/ then submenu.pop
            when /submenu\s+'/
              submenu.push(line[/\s*submenu\s+'([^']+)'.*/, 1])
            end
          end
        end

        def self.serialize(_string)
          raise NotImplementedError,
            "Serializing not implemented, use grub2 generator"
        end

        def self.empty
          []
        end

        def self.parse_entry(line, submenu)
          entry = line[/\s*menuentry\s+'([^']+)'.*/, 1]
          submenu.push(entry)
          {
            title: entry,
            path:  submenu.join(">")
          }
        end
        private_class_method :parse_entry
      end

      def initialize(file_handler: nil)
        super(Parser, PATH, file_handler: file_handler)
      end

      # @return [Array<String>] sections from grub.cfg in order as they appear
      # @deprecated use instead boot_entries
      def sections
        data.map { |p| p[:title] }
      end

      # @return [Array<Hash>] return boot entries containing `title:` as shown
      # on screen and `path:` whole path usable for grub2-set-default including
      # also submenu part of path
      # @note Some entries are not in fact bootable, such as the
      # "run snaper rollback" hint-only entry on SUSE. They are ignored.
      # As a hack, they are recognized by double quote delimiters while the
      # regular entries use single quotes.
      def boot_entries
        data
      end
    end
  end
end