Contents

# 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 :repository, :revision

      class InvalidRepository < ArgumentError; end

      def initialize(repo, revision: nil, **args)
        @repository = if repo.is_a? Rugged::Repository
          repo
        else
          Rugged::Repository.new(repo)
        end

        @revision = revision
        super(**args)
      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

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
licensee-9.11.0	lib/licensee/projects/git_project.rb
licensee-9.10.1	lib/licensee/projects/git_project.rb
licensee-9.10.0	lib/licensee/projects/git_project.rb
licensee-9.9.4	lib/licensee/projects/git_project.rb
licensee-9.9.3	lib/licensee/projects/git_project.rb