Contents

# frozen_string_literal: true
module Licensed
  module Git
    class << self
      # Returns whether git commands are available
      def available?
        @git ||= Licensed::Shell.tool_available?("git")
      end

      def git_repo?
        return false unless available?
        !Licensed::Shell.execute("git", "status", allow_failure: true).empty?
      end

      # Returns the root of the current git repository
      # or nil if not in a git repository.
      def repository_root
        return unless git_repo?
        Licensed::Shell.execute("git", "rev-parse", "--show-toplevel")
      end

      # Returns the most recent git SHA for a file or directory
      # or nil if SHA is not available
      #
      # descriptor - file or directory to retrieve latest SHA for
      def version(descriptor)
        return unless git_repo? && descriptor
        Licensed::Shell.execute("git", "rev-list", "-1", "HEAD", "--", descriptor, allow_failure: true)
      end

      # Returns the commit date for the provided SHA as a timestamp
      #
      # sha - commit sha to retrieve date
      def commit_date(sha)
        return unless git_repo? && sha
        Licensed::Shell.execute("git", "show", "-s", "-1", "--format=%ct", sha)
      end

      # Returns the files in the git repository from `git ls-files --recurse-submodules`
      def files
        return unless git_repo?
        output = Licensed::Shell.execute("git", "ls-files", "--full-name", "--recurse-submodules")
        output.lines.map(&:strip)
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
licensed-1.4.0	lib/licensed/git.rb