Модуль: SPDX Закрытый
- Определено в:
- utils/spdx.rb
Обзор
Этот модуль является частью закрытого API. Этот модуль можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого модуля, поскольку он может быть удалён или изменён без предупреждения.
Вспомогательный модуль для обновления данных о лицензиях SPDX.
Краткое описание констант свернуть
- DATA_PATH =
Эта константа является частью закрытого API. Эту константу можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.
T.let((HOMEBREW_DATA_PATH/"spdx").freeze, Pathname)
- API_URL =
Эта константа является частью закрытого API. Эту константу можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.
"https://api.github.com/repos/spdx/license-list-data/releases/latest"- LICENSEREF_PREFIX =
Эта константа является частью закрытого API. Эту константу можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.
"LicenseRef-Homebrew-"- ALLOWED_LICENSE_SYMBOLS =
Эта константа является частью закрытого API. Эту константу можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.
[ :public_domain, :cannot_represent, ].freeze
- LicenseExpression =
Эта константа является частью закрытого API. Эту константу можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.
T.type_alias do T.any( String, Symbol, T::Hash[T.any(String, Symbol), T.anything], ) end
Краткое описание методов класса свернуть
- .deprecated_license?(license) ⇒ Boolean закрытый
- .download_latest_license_data!(to: DATA_PATH) ⇒ void закрытый
- .exception_data ⇒ Hash{String => T.untyped} закрытый
- .forbidden_licenses_include?(license, forbidden_licenses) ⇒ Boolean закрытый
- .latest_tag ⇒ String закрытый
- .license_data ⇒ Hash{String => T.untyped} закрытый
- .license_expression_to_string(license_expression, bracket: false, hash_type: nil) ⇒ String? закрытый
- .license_version_info(license) ⇒ Array<([String, Symbol])>, Array<(String, [String, nil], Boolean)> закрытый
- .licenses_forbid_installation?(license_expression, forbidden_licenses) ⇒ Boolean закрытый
- .parse_license_expression(license_expression) ⇒ Array<(Array<String, Symbol>, Array<String>)> закрытый
- .string_to_license_expression(string) ⇒ LicenseExpression? закрытый
- .valid_license?(license) ⇒ Boolean закрытый
- .valid_license_exception?(exception) ⇒ Boolean закрытый
Подробное описание методов класса
.deprecated_license?(license) ⇒ Boolean
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
94 95 96 97 98 99 100 101 102 | # File 'utils/spdx.rb', line 94 def deprecated_license?(license) return false if ALLOWED_LICENSE_SYMBOLS.include? license return false unless valid_license?(license) license = license.to_s.delete_suffix "+" license_data["licenses"].none? do |spdx_license| spdx_license["licenseId"].downcase == license.downcase && !spdx_license["isDeprecatedLicenseId"] end end |
.download_latest_license_data!(to: DATA_PATH) ⇒ void
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
Этот метод возвращает неопределённое значение.
36 37 38 39 40 | # File 'utils/spdx.rb', line 36 def download_latest_license_data!(to: DATA_PATH) data_url = "https://raw.githubusercontent.com/spdx/license-list-data/refs/tags/#{latest_tag}/json/" Utils::Curl.curl_download("#{data_url}licenses.json", to: to/"spdx_licenses.json") Utils::Curl.curl_download("#{data_url}exceptions.json", to: to/"spdx_exceptions.json") end |
.exception_data ⇒ Hash{String => T.untyped}
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
25 26 27 28 | # File 'utils/spdx.rb', line 25 def exception_data @exception_data ||= T.let(JSON.parse((DATA_PATH/"spdx_exceptions.json").read), T.nilable(T::Hash[String, T.untyped])) end |
.forbidden_licenses_include?(license, forbidden_licenses) ⇒ Boolean
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | # File 'utils/spdx.rb', line 256 def forbidden_licenses_include?(license, forbidden_licenses) return true if forbidden_licenses.key? license name, version, = license_version_info license forbidden_licenses.each_value do |license_info| forbidden_name, forbidden_version, forbidden_or_later = *license_info next if forbidden_name != name return true if forbidden_or_later && forbidden_version <= version return true if forbidden_version == version end false end |
.latest_tag ⇒ String
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
31 32 33 | # File 'utils/spdx.rb', line 31 def latest_tag @latest_tag ||= T.let(GitHub::API.open_rest(API_URL)["tag_name"], T.nilable(String)) end |
.license_data ⇒ Hash{String => T.untyped}
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, так как он может быть удалён или изменён без предупреждения.
20 21 22 | # File 'utils/spdx.rb', line 20 def license_data @license_data ||= T.let(JSON.parse((DATA_PATH/"spdx_licenses.json").read), T.nilable(T::Hash[String, T.untyped])) end |
.license_expression_to_string(license_expression, bracket: false, hash_type: nil) ⇒ String?
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.
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 | # File 'utils/spdx.rb', line 118 def license_expression_to_string(license_expression, bracket: false, hash_type: nil) case license_expression when String license_expression when Symbol LICENSEREF_PREFIX + license_expression.to_s.tr("_", "-") when Hash expressions = [] if license_expression.keys.length == 1 hash_type = license_expression.keys.first if hash_type.is_a? String expressions.push "#{hash_type} WITH #{license_expression[hash_type][:with]}" else expressions += license_expression[hash_type].map do |license| license_expression_to_string license, bracket: true, hash_type: end end else bracket = false license_expression.each do |expression| expressions.push license_expression_to_string([expression].to_h, bracket: true) end end operator = if hash_type == :any_of " OR " else " AND " end if bracket "(#{expressions.join operator})" else expressions.join operator end end end |
.license_version_info(license) ⇒ Array<([String, Symbol])>, Array<(String, [String, nil], Boolean)>
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.
213 214 215 216 217 218 219 220 221 222 223 224 225 | # File 'utils/spdx.rb', line 213 def license_version_info(license) return [license] if ALLOWED_LICENSE_SYMBOLS.include? license match = license.match(/-(?<version>[0-9.]+)(?:-.*?)??(?<or_later>\+|-only|-or-later)?$/) return [license] if match.blank? license_name = license.to_s.split(match[0].to_s).first or_later = match["or_later"].present? && %w[+-or-later].include?(match["or_later"]) # [name, version, later versions allowed?] # e.g. GPL-2.0-or-later --> ["GPL", "2.0", true] [license_name, match["version"], or_later] end |
.licenses_forbid_installation?(license_expression, forbidden_licenses) ⇒ Boolean
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. По возможности сторонним разработчикам следует избегать использования этого метода, поскольку он может быть удалён или изменён без предупреждения.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | # File 'utils/spdx.rb', line 231 def licenses_forbid_installation?(license_expression, forbidden_licenses) case license_expression when String, Symbol forbidden_licenses_include? license_expression, forbidden_licenses when Hash key = license_expression.keys.first return false if key.nil? case key when :any_of license_expression[key].all? { |license| licenses_forbid_installation? license, forbidden_licenses } when :all_of license_expression[key].any? { |license| licenses_forbid_installation? license, forbidden_licenses } else forbidden_licenses_include? key, forbidden_licenses end end end |
.parse_license_expression(license_expression) ⇒ Array<(Array<String, Symbol>, Array<String>)>
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.
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 | # File 'utils/spdx.rb', line 56 def parse_license_expression(license_expression) licenses = T.let([], T::Array[T.any(String, Symbol)]) exceptions = T.let([], T::Array[String]) case license_expression when String, Symbol licenses.push license_expression when Hash, Array if license_expression.is_a? Hash license_expression = license_expression.filter_map do |key, value| if key.is_a? String licenses.push key exceptions.push value[:with] next end value end end license_expression.each do |license| sub_license, sub_exception = parse_license_expression license licenses += sub_license exceptions += sub_exception end end [licenses, exceptions] end |
.string_to_license_expression(string) ⇒ LicenseExpression?
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | # File 'utils/spdx.rb', line 166 def string_to_license_expression(string) return if string.blank? result = string result_type = nil and_parts = string.split(/ and (?![^(]*\))/i) if and_parts.length > 1 result = and_parts result_type = :all_of else or_parts = string.split(/ or (?![^(]*\))/i) if or_parts.length > 1 result = or_parts result_type = :any_of end end if result_type result.map! do |part| part = part[1..-2] if part[0] == "(" && part[-1] == ")" string_to_license_expression(part) end { result_type => result } else with_parts = string.split(/ with /i, 2) if with_parts.length > 1 { with_parts.first => { with: with_parts.second } } else return result unless result.start_with?(LICENSEREF_PREFIX) license_sym = result.delete_prefix(LICENSEREF_PREFIX).downcase.tr("-", "_").to_sym ALLOWED_LICENSE_SYMBOLS.include?(license_sym) ? license_sym : result end end end |
.valid_license?(license) ⇒ Boolean
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.
86 87 88 89 90 91 | # File 'utils/spdx.rb', line 86 def valid_license?(license) return ALLOWED_LICENSE_SYMBOLS.include? license if license.is_a? Symbol license = license.delete_suffix "+" license_data["licenses"].any? { |spdx_license| spdx_license["licenseId"].downcase == license.downcase } end |
.valid_license_exception?(exception) ⇒ Boolean
Этот метод является частью закрытого API. Этот метод можно использовать только в репозитории Homebrew/brew. Сторонним разработчикам по возможности не следует использовать этот метод, поскольку он может быть удалён или изменён без предупреждения.
105 106 107 108 109 | # File 'utils/spdx.rb', line 105 def valid_license_exception?(exception) exception_data["exceptions"].any? do |spdx_exception| spdx_exception["licenseExceptionId"].downcase == exception.downcase && !spdx_exception["isDeprecatedLicenseId"] end end |
© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/SPDX.html