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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
# frozen_string_literal: true
# Licensee::Project represents an open source project on disk
# It is not used directly, but rather is extended by FSProject and GitProject
# depending on the type of file system access available
#
# Subclasses must implement the Files and LoadFile private methods
module Licensee
module Projects
class Project
attr_reader :detect_readme, :detect_packages
alias detect_readme? detect_readme
alias detect_packages? detect_packages
include Licensee::HashHelper
HASH_METHODS = %i[licenses matched_files].freeze
def initialize(detect_packages: false, detect_readme: false)
@detect_packages = detect_packages
@detect_readme = detect_readme
end
# Returns the matching License instance if a license can be detected
def license
return @license if defined? @license
@license = if licenses_without_copyright.count == 1 || lgpl?
licenses_without_copyright.first
elsif licenses_without_copyright.count > 1
Licensee::License.find('other')
end
end
# Returns an array of detected Licenses
def licenses
@licenses ||= matched_files.map(&:license).uniq
end
# Returns the ProjectFile used to determine the License
def matched_file
matched_files.first if matched_files.count == 1 || lgpl?
end
# Returns an array of matches LicenseFiles
def matched_files
@matched_files ||= project_files.select(&:license)
end
# Returns the LicenseFile used to determine the License
def license_file
license_files.first if license_files.count == 1 || lgpl?
end
def license_files
@license_files ||= if files.empty? || files.nil?
[]
else
files = find_files do |n|
Licensee::ProjectFiles::LicenseFile.name_score(n)
end
files = files.map do |file|
Licensee::ProjectFiles::LicenseFile.new(load_file(file), file)
end
prioritize_lgpl(files)
end
end
def readme_file
return unless detect_readme?
return @readme if defined? @readme
@readme = begin
content, file = find_file do |n|
Licensee::ProjectFiles::ReadmeFile.name_score(n)
end
content = Licensee::ProjectFiles::ReadmeFile.license_content(content)
return unless content && file
Licensee::ProjectFiles::ReadmeFile.new(content, file)
end
end
alias readme readme_file
def package_file
return unless detect_packages?
return @package_file if defined? @package_file
@package_file = begin
content, file = find_file do |n|
Licensee::ProjectFiles::PackageManagerFile.name_score(n)
end
return unless content && file
Licensee::ProjectFiles::PackageManagerFile.new(content, file)
end
end
private
def lgpl?
return false unless licenses.count == 2 && license_files.count == 2
license_files[0].lgpl? && license_files[1].gpl?
end
# Given a block, passes each filename to that block, and expects a numeric
# score in response. Returns an array of all files with a score > 0,
# sorted by file score descending
def find_files
return [] if files.empty? || files.nil?
found = files.map { |file| file.merge(score: yield(file[:name])) }
found.select! { |file| file[:score].positive? }
found.sort { |a, b| b[:score] <=> a[:score] }
end
# Given a block, passes each filename to that block, and expects a numeric
# score in response. Returns a hash representing the top scoring file
# or nil, if no file scored > 0
def find_file(&block)
return if files.empty? || files.nil?
file = find_files(&block).first
[load_file(file), file] if file
end
# Given an array of LicenseFiles, ensures LGPL is the first entry,
# if the first entry is otherwise GPL, and a valid LGPL file exists
#
# This is becaues LGPL actually lives in COPYING.lesser, alongside an
# otherwise GPL-licensed project, per the license instructions.
# See https://git.io/viwyK.
#
# Returns an array of LicenseFiles with LPGL first
def prioritize_lgpl(files)
return files if files.empty?
return files unless files.first.license&.gpl?
lesser = files.find_index(&:lgpl?)
files.unshift(files.delete_at(lesser)) if lesser
files
end
def project_files
@project_files ||= [license_files, readme, package_file].flatten.compact
end
# Returns an array of matches licenses, excluding the COPYRIGHT file
# which can often be ignored for purposes of determing dual licensing
def licenses_without_copyright
@licenses_without_copyright ||= matched_files.reject(&:copyright?).map(&:license).uniq
end
def files
raise 'Not implemented'
end
def load_file(_file)
raise 'Not implemented'
end
end
end
end
|
