Sha256: 51cb28f37e6f43c9870590c31b00705db4e8e364c89431979a99e4f97154cc26

Contents?: true

Size: 1.52 KB

Versions: 16

Compression:

Stored size: 1.52 KB

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

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

      # Returns true if a git repository is found, false otherwise
      def git_repo?
        !repository_root.to_s.empty?
      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

16 entries across 16 versions & 1 rubygems

Version Path
licensed-2.8.0 lib/licensed/git.rb
licensed-2.7.0 lib/licensed/git.rb
licensed-2.6.2 lib/licensed/git.rb
licensed-2.6.1 lib/licensed/git.rb
licensed-2.6.0 lib/licensed/git.rb
licensed-2.5.0 lib/licensed/git.rb
licensed-2.4.0 lib/licensed/git.rb
licensed-2.3.2 lib/licensed/git.rb
licensed-2.3.1 lib/licensed/git.rb
licensed-2.3.0 lib/licensed/git.rb
licensed-2.2.0 lib/licensed/git.rb
licensed-2.1.0 lib/licensed/git.rb
licensed-2.0.1 lib/licensed/git.rb
licensed-2.0.0 lib/licensed/git.rb
licensed-1.5.2 lib/licensed/git.rb
licensed-1.5.1 lib/licensed/git.rb