Merge pull request #8411 from Rylan12/license-rubocop
License style cleanup
This commit is contained in:
Mike McQuaid
GitHub
commit
79695b0ee5
@ -2232,7 +2232,18 @@ class Formula
|
||||
# <pre>license all_of: ["MIT", "GPL-2.0-only"]</pre>
|
||||
# <pre>license "GPL-2.0-only" => { with: "LLVM-exception" }</pre>
|
||||
# <pre>license :public_domain</pre>
|
||||
attr_rw :license
|
||||
def license(args = nil)
|
||||
if args.nil?
|
||||
@licenses
|
||||
else
|
||||
if args.is_a? Array
|
||||
# TODO: enable for next major/minor release
|
||||
# odeprecated "`license [...]`", "`license any_of: [...]`"
|
||||
args = { any_of: args }
|
||||
end
|
||||
@licenses = args
|
||||
end
|
||||
end
|
||||
|
||||
# @!attribute [w] homepage
|
||||
# The homepage for the software. Used by users to get more information
|
||||
|
||||
@ -254,6 +254,38 @@ module RuboCop
|
||||
end
|
||||
end
|
||||
|
||||
class LicenseArrays < FormulaCop
|
||||
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
||||
license_node = find_node_method_by_name(body_node, :license)
|
||||
return unless license_node
|
||||
|
||||
license = parameters(license_node).first
|
||||
return unless license.array_type?
|
||||
|
||||
problem "Use `license any_of: #{license.source}` instead of `license #{license.source}`"
|
||||
end
|
||||
|
||||
def autocorrect(node)
|
||||
lambda do |corrector|
|
||||
corrector.replace(node.source_range, "license any_of: #{parameters(node).first.source}")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
class Licenses < FormulaCop
|
||||
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
||||
license_node = find_node_method_by_name(body_node, :license)
|
||||
return unless license_node
|
||||
|
||||
license = parameters(license_node).first
|
||||
return unless license.hash_type?
|
||||
return unless license.each_descendant(:hash).count.positive?
|
||||
return if license.source.include?("\n")
|
||||
|
||||
problem "Split nested license declarations onto multiple lines"
|
||||
end
|
||||
end
|
||||
|
||||
class Miscellaneous < FormulaCop
|
||||
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
||||
# FileUtils is included in Formula
|
||||
|
||||
@ -579,6 +579,134 @@ describe RuboCop::Cop::FormulaAudit::ShellVariables do
|
||||
end
|
||||
end
|
||||
|
||||
describe RuboCop::Cop::FormulaAudit::LicenseArrays do
|
||||
subject(:cop) { described_class.new }
|
||||
|
||||
context "When auditing licenses" do
|
||||
it "allow license strings" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license "MIT"
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "allow license symbols" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license :public_domain
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "allow license hashes" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license any_of: ["MIT", "0BSD"]
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "require using :any_of instead of a license array" do
|
||||
expect_offense(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license ["MIT", "0BSD"]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^ Use `license any_of: ["MIT", "0BSD"]` instead of `license ["MIT", "0BSD"]`
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "corrects license arrays to hash with :any_of" do
|
||||
source = <<~RUBY
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license ["MIT", "0BSD"]
|
||||
end
|
||||
RUBY
|
||||
|
||||
corrected_source = <<~RUBY
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license any_of: ["MIT", "0BSD"]
|
||||
end
|
||||
RUBY
|
||||
|
||||
new_source = autocorrect_source(source)
|
||||
expect(new_source).to eq(corrected_source)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe RuboCop::Cop::FormulaAudit::Licenses do
|
||||
subject(:cop) { described_class.new }
|
||||
|
||||
context "When auditing licenses" do
|
||||
it "allow license strings" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license "MIT"
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "allow license symbols" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license :public_domain
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "allow license hashes" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license any_of: ["MIT", "0BSD"]
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "allow multiline nested license hashes" do
|
||||
expect_no_offenses(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license any_of: [
|
||||
"MIT",
|
||||
all_of: ["0BSD", "Zlib"],
|
||||
]
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
|
||||
it "require multiple lines for nested license hashes" do
|
||||
expect_offense(<<~RUBY)
|
||||
class Foo < Formula
|
||||
desc "foo"
|
||||
url 'https://brew.sh/foo-1.0.tgz'
|
||||
license any_of: ["MIT", all_of: ["0BSD", "Zlib"]]
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Split nested license declarations onto multiple lines
|
||||
end
|
||||
RUBY
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe RuboCop::Cop::FormulaAudit::Miscellaneous do
|
||||
subject(:cop) { described_class.new }
|
||||
|
||||
|
||||
@ -167,10 +167,6 @@ describe SPDX do
|
||||
expect(described_class.license_expression_to_string(any_of: ["MIT", "EPL-1.0+"])).to eq "MIT or EPL-1.0+"
|
||||
end
|
||||
|
||||
it "treats array as any_of:" do
|
||||
expect(described_class.license_expression_to_string(["MIT", "EPL-1.0+"])).to eq "MIT or EPL-1.0+"
|
||||
end
|
||||
|
||||
it "returns license and exception" do
|
||||
license_expression = { "MIT" => { with: "LLVM-exception" } }
|
||||
expect(described_class.license_expression_to_string(license_expression)).to eq "MIT with LLVM-exception"
|
||||
@ -237,7 +233,6 @@ describe SPDX do
|
||||
}
|
||||
}
|
||||
let(:any_of_license) { { any_of: ["MIT", "0BSD"] } }
|
||||
let(:license_array) { ["MIT", "0BSD"] }
|
||||
let(:all_of_license) { { all_of: ["MIT", "0BSD"] } }
|
||||
let(:nested_licenses) {
|
||||
{
|
||||
@ -278,14 +273,6 @@ describe SPDX do
|
||||
expect(described_class.licenses_forbid_installation?(any_of_license, multiple_forbidden)).to eq true
|
||||
end
|
||||
|
||||
it "allows installation when one of the array licenses is allowed" do
|
||||
expect(described_class.licenses_forbid_installation?(license_array, mit_forbidden)).to eq false
|
||||
end
|
||||
|
||||
it "forbids installation when none of the array licenses are allowed" do
|
||||
expect(described_class.licenses_forbid_installation?(license_array, multiple_forbidden)).to eq true
|
||||
end
|
||||
|
||||
it "forbids installation when one of the all_of licenses is allowed" do
|
||||
expect(described_class.licenses_forbid_installation?(all_of_license, mit_forbidden)).to eq true
|
||||
end
|
||||
|
||||
@ -83,8 +83,7 @@ module SPDX
|
||||
license_expression
|
||||
when :public_domain
|
||||
"Public Domain"
|
||||
when Hash, Array
|
||||
license_expression = { any_of: license_expression } if license_expression.is_a? Array
|
||||
when Hash
|
||||
expressions = []
|
||||
|
||||
if license_expression.keys.length == 1
|
||||
@ -135,8 +134,7 @@ module SPDX
|
||||
case license_expression
|
||||
when String, Symbol
|
||||
forbidden_licenses_include? license_expression.to_s, forbidden_licenses
|
||||
when Hash, Array
|
||||
license_expression = { any_of: license_expression } if license_expression.is_a? Array
|
||||
when Hash
|
||||
key = license_expression.keys.first
|
||||
case key
|
||||
when :any_of
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user