File: git_project.rb

package info (click to toggle)
ruby-licensee 9.15.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,244 kB
  • sloc: xml: 10,130; ruby: 5,012; makefile: 9
file content (80 lines) | stat: -rw-r--r-- 2,086 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# frozen_string_literal: true

# Git-based project
#
# Analyze a given (bare) Git repository for license information
#
# Project files for this project type will contain the following keys:
#  :name - the file's path relative to the repo root
#  :oid  - the file's OID

autoload :Rugged, 'rugged'

module Licensee
  module Projects
    class GitProject < Licensee::Projects::Project
      attr_reader :revision

      class InvalidRepository < ArgumentError; end

      def initialize(repo, revision: nil, **args)
        @raw_repo = repo
        @revision = revision

        raise InvalidRepository if repository.head_unborn?

        super(**args)
      end

      def repository
        @repository ||= if @raw_repo.is_a? Rugged::Repository
                          @raw_repo
                        else
                          Rugged::Repository.new(@raw_repo)
                        end
      rescue Rugged::OSError, Rugged::RepositoryError
        raise InvalidRepository
      end

      def close
        repository.close
      end

      private

      def commit
        @commit ||= if revision
                      repository.lookup(revision)
                    else
                      repository.last_commit
                    end
      end

      MAX_LICENSE_SIZE = 64 * 1024

      # Retrieve a file's content from the Git database
      #
      # file - the file hash, including the file's OID
      #
      # Returns a string representing the file's contents
      def load_file(file)
        data, = Rugged::Blob.to_buffer(repository, file[:oid], MAX_LICENSE_SIZE)
        data
      end

      # Returns an array of hashes representing the project's files.
      # Hashes will have the the following keys:
      #  :name - the file's path relative to the repo root
      #  :oid  - the file's OID
      def files
        @files ||= files_from_tree(commit.tree)
      end

      def files_from_tree(tree, dir = '.')
        tree.select { |e| e[:type] == :blob }.map do |entry|
          entry.merge(dir: dir)
        end.compact
      end
    end
  end
end