admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #10175 from SeekingMeaning/ast-helper-cleanup

Browse Source 
utils/ast: cleanup
This commit is contained in:
Seeker 2020-12-31 08:08:36 -08:00 committed by GitHub
commit acf0ecc7b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 274 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Library/Homebrew/dev-cmd/bottle.rb
View File

@ -9,6 +9,7 @@ require "formula_versions"
require "cli/parser" require "cli/parser"
require "utils/inreplace" require "utils/inreplace"
require "erb" require "erb"
require "utils/ast"
BOTTLE_ERB = <<-EOS BOTTLE_ERB = <<-EOS
bottle do bottle do
@ -510,13 +511,12 @@ module Homebrew
output = bottle_output bottle output = bottle_output bottle
end end
puts output puts output
string = s.sub!(/ bottle do.+?end\n/m, output) Utils::AST.replace_bottle_stanza!(s.inreplace_string, output)
odie "Bottle block update failed!" unless string
else else
odie "--keep-old was passed but there was no existing bottle block!" if args.keep_old? odie "--keep-old was passed but there was no existing bottle block!" if args.keep_old?
puts output puts output
update_or_add = "add" update_or_add = "add"
Utils::Bottles.add_bottle_stanza!(s.inreplace_string, output) Utils::AST.add_bottle_stanza!(s.inreplace_string, output)
end end
end end

4
Library/Homebrew/dev-cmd/bump-revision.rb
View File

@ -52,9 +52,9 @@ module Homebrew
Utils::Inreplace.inreplace(formula.path) do |s| Utils::Inreplace.inreplace(formula.path) do |s|
s = s.inreplace_string s = s.inreplace_string
if current_revision.zero? if current_revision.zero?
Utils::AST.add_formula_stanza!(s, name: :revision, text: text) Utils::AST.add_formula_stanza!(s, :revision, text)
else else
Utils::AST.replace_formula_stanza!(s, name: :revision, replacement: text) Utils::AST.replace_formula_stanza!(s, :revision, text)
end end
end end
end end

260
Library/Homebrew/test/utils/ast_spec.rb
View File

@ -20,7 +20,7 @@ describe Utils::AST do
describe ".replace_formula_stanza!" do describe ".replace_formula_stanza!" do
it "replaces the specified stanza in a formula" do it "replaces the specified stanza in a formula" do
contents = initial_formula.dup contents = initial_formula.dup
described_class.replace_formula_stanza! contents, name: :license, replacement: "license :public_domain" described_class.replace_formula_stanza!(contents, :license, "license :public_domain")
expect(contents).to eq <<~RUBY expect(contents).to eq <<~RUBY
class Foo < Formula class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" url "https://brew.sh/foo-1.0.tar.gz"
@ -33,7 +33,7 @@ describe Utils::AST do
describe ".add_formula_stanza!" do describe ".add_formula_stanza!" do
it "adds the specified stanza to a formula" do it "adds the specified stanza to a formula" do
contents = initial_formula.dup contents = initial_formula.dup
described_class.add_formula_stanza! contents, name: :revision, text: "revision 1" described_class.add_formula_stanza!(contents, :revision, "revision 1")
expect(contents).to eq <<~RUBY expect(contents).to eq <<~RUBY
class Foo < Formula class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" url "https://brew.sh/foo-1.0.tar.gz"
@ -47,4 +47,260 @@ describe Utils::AST do
RUBY RUBY
end end
end end
describe ".add_bottle_stanza!" do
let(:bottle_output) do
<<~RUBY.chomp.indent(2)
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
RUBY
end
context "when `license` is a string" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license "MIT"
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license "MIT"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when `license` is a symbol" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license :cannot_represent
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license :cannot_represent
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when `license` is multiline" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license all_of: [
:public_domain,
"MIT",
"GPL-3.0-or-later" => { with: "Autoconf-exception-3.0" },
]
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license all_of: [
:public_domain,
"MIT",
"GPL-3.0-or-later" => { with: "Autoconf-exception-3.0" },
]
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when `head` is a string" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head "https://brew.sh/foo.git"
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head "https://brew.sh/foo.git"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `head`" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when `head` is a block" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head do
url "https://brew.sh/foo.git"
end
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
head do
url "https://brew.sh/foo.git"
end
end
RUBY
end
it "adds `bottle` before `head`" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when there is a comment on the same line" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" # comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" # comment
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after the comment" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when the next line is a comment" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after the comment" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
context "when the next line is blank and the one after it is a comment" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
# comment
end
RUBY
end
it "adds `bottle` before the comment" do
described_class.add_bottle_stanza!(formula_contents, bottle_output)
expect(formula_contents).to eq(new_contents)
end
end
end
end end

256
Library/Homebrew/test/utils/bottles/bottles_spec.rb
View File

@ -14,260 +14,4 @@ describe Utils::Bottles do
end end
end end
end end
describe "#add_bottle_stanza!" do
let(:bottle_output) do
<<~RUBY.chomp.indent(2)
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
RUBY
end
context "when `license` is a string" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license "MIT"
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license "MIT"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when `license` is a symbol" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license :cannot_represent
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license :cannot_represent
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when `license` is multiline" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license all_of: [
:public_domain,
"MIT",
"GPL-3.0-or-later" => { with: "Autoconf-exception-3.0" },
]
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
license all_of: [
:public_domain,
"MIT",
"GPL-3.0-or-later" => { with: "Autoconf-exception-3.0" },
]
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `license`" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when `head` is a string" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head "https://brew.sh/foo.git"
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head "https://brew.sh/foo.git"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after `head`" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when `head` is a block" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
head do
url "https://brew.sh/foo.git"
end
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
head do
url "https://brew.sh/foo.git"
end
end
RUBY
end
it "adds `bottle` before `head`" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when there is a comment on the same line" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" # comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz" # comment
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after the comment" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when the next line is a comment" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
end
RUBY
end
it "adds `bottle` after the comment" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
context "when the next line is blank and the one after it is a comment" do
let(:formula_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
# comment
end
RUBY
end
let(:new_contents) do
<<~RUBY.chomp
class Foo < Formula
url "https://brew.sh/foo-1.0.tar.gz"
bottle do
sha256 "f7b1fc772c79c20fddf621ccc791090bc1085fcef4da6cca03399424c66e06ca" => :sierra
end
# comment
end
RUBY
end
it "adds `bottle` before the comment" do
described_class.add_bottle_stanza! formula_contents, bottle_output
expect(formula_contents).to eq(new_contents)
end
end
end
end end

14
Library/Homebrew/utils/ast.rb
View File

@ -9,18 +9,26 @@ module Utils
class << self class << self
extend T::Sig extend T::Sig
def replace_formula_stanza!(formula_contents, name:, replacement:, type: nil) def replace_bottle_stanza!(formula_contents, bottle_output)
replace_formula_stanza!(formula_contents, :bottle, bottle_output.strip, type: :block_call)
end
def add_bottle_stanza!(formula_contents, bottle_output)
add_formula_stanza!(formula_contents, :bottle, "\n#{bottle_output.chomp}", type: :block_call)
end
def replace_formula_stanza!(formula_contents, name, replacement, type: nil)
processed_source, body_node = process_formula(formula_contents) processed_source, body_node = process_formula(formula_contents)
children = body_node.begin_type? ? body_node.children.compact : [body_node] children = body_node.begin_type? ? body_node.children.compact : [body_node]
stanza_node = children.find { |child| call_node_match?(child, name: name, type: type) } stanza_node = children.find { |child| call_node_match?(child, name: name, type: type) }
raise "Could not find #{name} stanza!" if stanza_node.nil? raise "Could not find #{name} stanza!" if stanza_node.nil?
tree_rewriter = Parser::Source::TreeRewriter.new(processed_source.buffer) tree_rewriter = Parser::Source::TreeRewriter.new(processed_source.buffer)
tree_rewriter.replace(stanza_node.source_range, replacement.strip) tree_rewriter.replace(stanza_node.source_range, replacement)
formula_contents.replace(tree_rewriter.process) formula_contents.replace(tree_rewriter.process)
end end
def add_formula_stanza!(formula_contents, name:, text:, type: nil) def add_formula_stanza!(formula_contents, name, text, type: nil)
processed_source, body_node = process_formula(formula_contents) processed_source, body_node = process_formula(formula_contents)
preceding_component = if body_node.begin_type? preceding_component = if body_node.begin_type?

8
Library/Homebrew/utils/bottles.rb
View File

@ -2,7 +2,6 @@
# frozen_string_literal: true # frozen_string_literal: true
require "tab" require "tab"
require "utils/ast"
module Utils module Utils
# Helper functions for bottles. # Helper functions for bottles.
@ -75,13 +74,6 @@ module Utils
contents contents
end end
def add_bottle_stanza!(formula_contents, bottle_output)
Utils::AST.add_formula_stanza!(formula_contents,
name: :bottle,
type: :block_call,
text: "\n#{bottle_output.chomp}")
end
end end
# Helper functions for bottles hosted on Bintray. # Helper functions for bottles hosted on Bintray.