module Pantograph
  module Actions
    class GitSubmoduleUpdateAction < Action
      def self.run(params)
        commands = ["git submodule update"]
        commands += ["--init"] if params[:init]
        commands += ["--recursive"] if params[:recursive]
        Actions.sh(commands.join(' '))
      end

      #####################################################
      # @!group Documentation
      #####################################################

      def self.description
        "Executes a git submodule command"
      end

      def self.available_options
        [
          PantographCore::ConfigItem.new(key: :recursive,
           description: "Should the submodules be updated recursively",
           type: Boolean,
           default_value: false),
          PantographCore::ConfigItem.new(key: :init,
           description: "Should the submodules be initiated before update",
           type: Boolean,
           is_string: false,
           default_value: false)
        ]
      end

      def self.output
      end

      def self.return_value
      end

      def self.authors
        ["braunico"]
      end

      def self.is_supported?(platform)
        return true
      end

      def self.category
        :source_control
      end
    end
  end
end