module Pantograph
  module Actions
    class ImportFromGitAction < Action
      def self.run(params)
        # this is implemented in the pant_file.rb
      end

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

      def self.description
        "Import another Pantfile from a remote git repository to use its lanes"
      end

      def self.details
        "This is useful if you have shared lanes across multiple apps and you want to store the Pantfile in a remote git repository."
      end

      def self.available_options
        [
          PantographCore::ConfigItem.new(key: :url,
                                       description: "The URL of the repository to import the Pantfile from",
                                       default_value: nil),
          PantographCore::ConfigItem.new(key: :branch,
                                       description: "The branch or tag to check-out on the repository",
                                       default_value: 'HEAD',
                                       optional: true),
          PantographCore::ConfigItem.new(key: :path,
                                       description: "The path of the Pantfile in the repository",
                                       default_value: 'pantograph/Pantfile',
                                       optional: true),
          PantographCore::ConfigItem.new(key: :version,
                                       description: "The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints",
                                       default_value: nil,
                                       is_string: false,
                                       optional: true)
        ]
      end

      def self.authors
        ["fabiomassimo", "KrauseFx", "Liquidsoul"]
      end

      def self.is_supported?(platform)
        true
      end

      def self.example_code
        [
          'import_from_git(
            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
            branch: "HEAD", # The branch to checkout on the repository
            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
            version: "~> 1.0.0" # The version to checkout on the repository. Optimistic match operator can be used to select the latest version within constraints.
          )',
          'import_from_git(
            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
            branch: "HEAD", # The branch to checkout on the repository
            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
            version: [">= 1.1.0", "< 2.0.0"] # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
          )'
        ]
      end

      def self.category
        :misc
      end
    end
  end
end