Skip to content

Commit

Permalink
Add LicenseRef and DocumentRef. Delete unused methods (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Ellis authored Aug 10, 2020
1 parent b590cd0 commit eb02506
Show file tree
Hide file tree
Showing 7 changed files with 724 additions and 794 deletions.
4 changes: 2 additions & 2 deletions exceptions.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"licenseListVersion": "3.8-126-gff8ed78",
"releaseDate": "2020-05-15",
"licenseListVersion": "3.10",
"releaseDate": "2020-08-03",
"exceptions": [
{
"reference": "./GCC-exception-2.0.html",
Expand Down
205 changes: 20 additions & 185 deletions lib/spdx.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,179 +9,6 @@

# Fuzzy matcher for licenses to SPDX standard licenses
module Spdx
def self.find(name)
name = name.strip
return nil if commercial?(name)
return nil if non_spdx?(name)

search(name)
end

def self.search(name)
lookup(name) ||
find_by_special_case(name) ||
closest(name)
end

def self.commercial?(name)
name.casecmp("commercial").zero?
end

def self.non_spdx?(name)
["standard pil license"].include? name.downcase
end

def self.lookup(name)
return false if name.nil?
return lookup_license(name) if license_exists?(name)

lowercase = licenses.keys.sort.find { |k| k.casecmp(name).zero? }
lookup_license(lowercase) if lowercase
end

def self.closest(name)
name.gsub!(/#{stop_words.join('|')}/i, "")
name.gsub!(/(\d)/, ' \1 ')
best_match = fuzzy_match(name)
return nil unless best_match

lookup(best_match) || find_by_name(best_match)
end

def self.matches(name, max_distance = 40)
names.map { |key| [key, Text::Levenshtein.distance(name, key)] }
.select { |arr| arr[1] <= max_distance }
.sort_by { |arr| arr[1] }
end

def self.fuzzy_match(name)
FuzzyMatch.new(names).find(name, must_match_at_least_one_word: true)
end

def self.stop_words
%w[version software the or right all]
end

def self.find_by_name(name)
match = licenses.find { |_k, v| v["name"] == name }
lookup(match[0]) if match
end

def self.find_by_special_case(name)
gpl = gpl_match(name)
return gpl if gpl

lookup(special_cases[name.downcase.strip])
end

def self.gpl_match(name)
match = name.match(/^(l|a)?gpl-?\s?_?v?(1|2|3)\.?(\d)?(\+)?$/i)
return unless match

lookup "#{match[1]}GPL-#{match[2]}.#{match[3] || 0}#{match[4]}"
end

def self.special_cases
{
"perl_5" => "Artistic-1.0-Perl",
"bsd3" => "BSD-3-Clause",
"bsd" => "BSD-3-Clause",
"bsd license" => "BSD-3-Clause",
"new bsd license" => "BSD-3-Clause",
"gnu gpl v2" => "GPL-2.0-only",
"gpl" => "GPL-2.0+",
"gpl-2 | gpl-3 [expanded from: gpl (≥ 2.0)]" => "GPL-2.0+",
"gpl-2 | gpl-3 [expanded from: gpl]" => "GPL-2.0+",
"gpl-2 | gpl-3 [expanded from: gpl (≥ 2)]" => "GPL-2.0+",
"gpl-2 | gpl-3" => "GPL-2.0+",
"gplv2 or later" => "GPL-2.0+",
"the gpl v3" => "GPL-3.0",
"gpl (≥ 3)" => "GPL-3.0+",
"mpl2.0" => "mpl-2.0",
"mpl1" => "mpl-1.0",
"mpl1.0" => "mpl-1.0",
"mpl1.1" => "mpl-1.1",
"mpl2" => "mpl-2.0",
"gnu lesser general public license" => "LGPL-2.1+",
"lgplv2 or later" => "LGPL-2.1+",
"gpl2 w/ cpe" => "GPL-2.0-with-classpath-exception",
"new bsd license (gpl-compatible)" => "BSD-3-Clause",
"public domain" => "Unlicense",
"cc0" => "CC0-1.0",
"artistic_2" => "Artistic-2.0",
"artistic_1" => "Artistic-1.0",
"alv2" => "Apache-2.0",
"asl" => "Apache-2.0",
"asl 2.0" => "Apache-2.0",
"mpl 2.0" => "MPL-2.0",
"publicdomain" => "Unlicense",
"unlicensed" => "Unlicense",
"psfl" => "Python-2.0",
"psf" => "Python-2.0",
"psf 2" => "Python-2.0",
"psf 2.0" => "Python-2.0",
"asl2" => "Apache-2.0",
"al2" => "Apache-2.0",
"aslv2" => "Apache-2.0",
"apache_2_0" => "Apache-2.0",
"apache_v2" => "Apache-2.0",
"zpl 1.1" => "ZPL-1.1",
"zpl 2.0" => "ZPL-2.0",
"zpl 2.1" => "ZPL-2.1",
"lgpl_2_1" => "LGPL-2.1",
"lgpl_v2_1" => "LGPL-2.1",
"lgpl version 3" => "LGPL-3.0",
"gnu lgpl v3+" => "LGPL-3.0",
"gnu lgpl" => "LGPL-2.1+",
"cc by-sa 4.0" => "CC-BY-SA-4.0",
"cc by-nc-sa 3.0" => "CC-BY-NC-SA-3.0",
"cc by-sa 3.0" => "CC-BY-SA-3.0",
"mpl v2.0" => "MPL-2.0",
"mplv2.0" => "MPL-2.0",
"mplv2" => "MPL-2.0",
"cpal v1.0" => "CPAL-1.0",
"cddl 1.0" => "CDDL-1.0",
"cddl 1.1" => "CDDL-1.1",
"epl" => "EPL-1.0",
"mit-license" => "MIT",
"(mit or x11)" => "MIT",
"iscl" => "ISC",
"wtf" => "WTFPL",
"2-clause bsdl" => "BSD-2-clause",
"3-clause bsdl" => "BSD-3-clause",
"2-clause bsd" => "BSD-2-clause",
"3-clause bsd" => "BSD-3-clause",
"bsd 3-clause" => "BSD-3-clause",
"bsd 2-clause" => "BSD-2-clause",
"two-clause bsd-style license" => "BSD-2-clause",
"bsd style" => "BSD-3-clause",
"cc0 1.0 universal (cc0 1.0) public domain dedication" => "CC0-1.0",
"common development and distribution license 1.0 (cddl-1.0)" => "CDDL-1.0",
"european union public licence 1.0 (eupl 1.0)" => "EUPL-1.0",
"european union public licence 1.1 (eupl 1.1)" => "EUPL-1.1",
"european union public licence 1.2 (eupl 1.2)" => "EUPL-1.2",
"vovida software license 1.0" => "VSL-1.0",
"w3c license" => "W3C",
"zlib/libpng license" => "zlib-acknowledgement",
"gnu general public license (gpl)" => "GPL-2.0+",
"gnu general public license v2 (gplv2)" => "GPL-2.0",
"gnu general public license v2 or later (gplv2+)" => "GPL-2.0+",
"gnu general public license v3 (gplv3)" => "GPL-3.0",
"gnu general public license v3 or later (gplv3+)" => "GPL-3.0+",
"gnu lesser general public license v2 (lgplv2)" => "LGPL-2.0",
"gnu lesser general public license v2 or later (lgplv2+)" => "LGPL-2.0+",
"gnu lesser general public license v3 (lgplv3)" => "LGPL-3.0",
"gnu lesser general public license v3 or later (lgplv3+)" => "LGPL-3.0+",
"gnu library or lesser general public license (lgpl)" => "LGPL-2.0+",
"netscape public License (npl)" => "NPL-1.1",
"apache software license" => "Apache-2.0",
"academic free license (afl)" => "AFL-3.0",
"gnu free documentation license (fdl)" => "GFDL-1.3",
"sun industry standards source license (sissl)" => "SISSL-1.2",
"zope public license" => "ZPL-2.1",
}
end

def self.names
(licenses.keys + licenses.map { |_k, v| v["name"] }).sort
end
Expand All @@ -190,6 +17,7 @@ def self.exceptions
unless defined?(@exceptions)
data = JSON.parse(File.read(File.expand_path("../exceptions.json", __dir__)))
@exceptions = {}

data["exceptions"].each do |details|
id = details.delete("licenseExceptionId")
@exceptions[id] = details
Expand All @@ -199,27 +27,18 @@ def self.exceptions
end

def self.license_exists?(id)
licenses.key?(id.to_s)
end

def self.lookup_license(id)
json = licenses[id.to_s]
Spdx::License.new(id.to_s, json["name"], json["isOsiApproved"]) if json
end

def self.lookup_exception(id)
json = exceptions[id.to_s]
Spdx::Exception.new(id.to_s, json["name"], json["isDeprecatedLicenseId"]) if json
licenses.key?(id.to_s) || licenses_downcase.key?(id.to_s.downcase)
end

def self.exception_exists?(id)
exceptions.key?(id.to_s)
exceptions.key?(id.to_s) || exceptions_downcase.key?(id.to_s.downcase)
end

def self.licenses
unless defined?(@licenses)
data = JSON.parse(File.read(File.expand_path("../licenses.json", __dir__)))
@licenses = {}

data["licenses"].each do |details|
id = details.delete("licenseId")
@licenses[id] = details
Expand All @@ -228,6 +47,22 @@ def self.licenses
@licenses
end

def self.licenses_downcase
unless defined?(@licenses_downcase)
@licenses_downcase = {}
licenses.keys.each { |key| @licenses_downcase[key.downcase] = key }
end
@licenses_downcase
end

def self.exceptions_downcase
unless defined?(@exceptions_downcase)
@exceptions_downcase = {}
exceptions.keys.each { |key| @exceptions_downcase[key.downcase] = key }
end
@exceptions_downcase
end

def self.valid_spdx?(spdx_string)
return false unless spdx_string.is_a?(String)

Expand Down
2 changes: 1 addition & 1 deletion lib/spdx/version.rb
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Spdx
VERSION = "2.0.12"
VERSION = "3.0.0"
end
9 changes: 9 additions & 0 deletions lib/spdx_grammar.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ def licenses
end
end

class UserDefinedLicense < Treetop::Runtime::SyntaxNode
end

class LicenseRef < Treetop::Runtime::SyntaxNode
end

class DocumentRef < Treetop::Runtime::SyntaxNode
end

class LicenseException < Treetop::Runtime::SyntaxNode
# TODO: actually do license exceptions
end
Expand Down
16 changes: 12 additions & 4 deletions lib/spdx_parser.treetop
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ grammar SpdxGrammar
end

rule body
( compound_expression / and / or / with / license )* <Body>
( compound_expression / and / or / with / license_ref / document_ref / license )* <Body>
end

rule and
Expand All @@ -25,11 +25,19 @@ grammar SpdxGrammar
end

rule license
[a-zA-Z0-9\-\+:\.]+ &{|seq| Spdx.license_exists?(seq.first.text_value) || Spdx.license_exists?(seq.first.text_value.delete_suffix('+')) } <License>
[a-zA-Z0-9\-\.\+]+ &{|seq| Spdx.license_exists?(seq.first.text_value) || Spdx.license_exists?(seq.first.text_value.delete_suffix('+')) } <License>
end

rule license_ref
"LicenseRef-" [a-zA-Z0-9\-\.]+ <LicenseRef>
end

rule document_ref
"DocumentRef-" [a-zA-Z0-9\-\.]+ ":" license_ref <DocumentRef>
end

rule license_exception
[a-zA-Z0-9\-\+:\.]+ &{|seq| Spdx.exception_exists?(seq.first.text_value) } <LicenseException>
[a-zA-Z0-9\-\.]+ &{|seq| Spdx.exception_exists?(seq.first.text_value) } <LicenseException>
end

rule reserve_words
Expand All @@ -48,4 +56,4 @@ grammar SpdxGrammar
[\s]+
end

end
end
Loading

0 comments on commit eb02506

Please sign in to comment.