From 39c6f7d6fbaba464798751c2c42f8f881da00e80 Mon Sep 17 00:00:00 2001 From: apainintheneck Date: Sun, 5 Feb 2023 20:54:15 -0800 Subject: [PATCH] Stop including `*flight` block source in cask API Originally we were going to try and load the *flight blocks from the API but we ended up going with downloading the caskfile for the subset of casks that need this functionality for consisty's sake. This reverts the following commits from most recent to oldest: - ffc74a51fb32b66a4cd8bc41dbd076dd23d9100e - e5616e94fe42505434c330be35eeafef2739944f - d1490c3d5c087d00f2bca1787cce331202b195c5 - 7ca5a5d9a71a73f21bbb8555a38048f027bee89b - 2d5d132713d0701d02d5ff33e9918812d13d2a83 It also changes how *flight blocks are handled in `.to_h`. Essentially, when *flight blocks exist they are just included as a hash of the artifact to nil to indicate that they exist. More information isn't necessary since we don't evaluate the current source code in the *flight artifacts that we get from the API. --- .gitignore | 1 + Library/Homebrew/Gemfile | 1 - Library/Homebrew/Gemfile.lock | 1 - .../cask/artifact/abstract_flight_block.rb | 6 - Library/Homebrew/cask/cask.rb | 3 +- Library/Homebrew/cask/cask_loader.rb | 6 +- Library/Homebrew/test/cask/cask_spec.rb | 48 ------ .../fixtures/cask/Casks/conditional-flight.rb | 21 --- .../method_source-1.0.0/lib/method_source.rb | 141 ---------------- .../lib/method_source/code_helpers.rb | 154 ------------------ .../lib/method_source/source_location.rb | 138 ---------------- .../lib/method_source/version.rb | 3 - 12 files changed, 4 insertions(+), 519 deletions(-) delete mode 100644 Library/Homebrew/test/support/fixtures/cask/Casks/conditional-flight.rb delete mode 100644 Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source.rb delete mode 100644 Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/code_helpers.rb delete mode 100644 Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/source_location.rb delete mode 100644 Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/version.rb diff --git a/.gitignore b/.gitignore index 5e75c73cdf..05579c2c25 100644 --- a/.gitignore +++ b/.gitignore @@ -111,6 +111,7 @@ **/vendor/bundle/ruby/*/gems/jaro_winkler-*/ **/vendor/bundle/ruby/*/gems/json-*/ **/vendor/bundle/ruby/*/gems/json_schemer-*/ +**/vendor/bundle/ruby/*/gems/method_source-*/ **/vendor/bundle/ruby/*/gems/mime-types-data-*/ **/vendor/bundle/ruby/*/gems/mime-types-*/ **/vendor/bundle/ruby/*/gems/mini_portile2-*/ diff --git a/Library/Homebrew/Gemfile b/Library/Homebrew/Gemfile index 5a9525327b..1a5f5d8383 100644 --- a/Library/Homebrew/Gemfile +++ b/Library/Homebrew/Gemfile @@ -15,7 +15,6 @@ end gem "bootsnap", require: false gem "byebug", require: false gem "json_schemer", require: false -gem "method_source", require: false gem "minitest", require: false gem "parallel_tests", require: false gem "ronn", require: false diff --git a/Library/Homebrew/Gemfile.lock b/Library/Homebrew/Gemfile.lock index a0ff62888e..0e7d0a836b 100644 --- a/Library/Homebrew/Gemfile.lock +++ b/Library/Homebrew/Gemfile.lock @@ -233,7 +233,6 @@ DEPENDENCIES did_you_mean json_schemer mechanize - method_source minitest parallel_tests parlour diff --git a/Library/Homebrew/cask/artifact/abstract_flight_block.rb b/Library/Homebrew/cask/artifact/abstract_flight_block.rb index 64e4d727bf..eccdb10cab 100644 --- a/Library/Homebrew/cask/artifact/abstract_flight_block.rb +++ b/Library/Homebrew/cask/artifact/abstract_flight_block.rb @@ -36,12 +36,6 @@ module Cask directives.keys.map(&:to_s).join(", ") end - def to_h - require "method_source" - - directives.transform_values(&:source) - end - private def class_for_dsl_key(dsl_key) diff --git a/Library/Homebrew/cask/cask.rb b/Library/Homebrew/cask/cask.rb index 0a2e9c3c83..ead2b69214 100644 --- a/Library/Homebrew/cask/cask.rb +++ b/Library/Homebrew/cask/cask.rb @@ -313,7 +313,8 @@ module Cask artifacts.map do |artifact| case artifact when Artifact::AbstractFlightBlock - artifact.to_h + # Only indicate whether this block is used as we don't load it from the API + { artifact.summarize => nil } when Artifact::Relocated # Don't replace the Homebrew prefix in the source path since the source could include /usr/local source, *args = artifact.to_args diff --git a/Library/Homebrew/cask/cask_loader.rb b/Library/Homebrew/cask/cask_loader.rb index 7dba19805c..39240df11a 100644 --- a/Library/Homebrew/cask/cask_loader.rb +++ b/Library/Homebrew/cask/cask_loader.rb @@ -301,11 +301,7 @@ module Cask json_cask[:artifacts].each do |artifact| key = artifact.keys.first - if FLIGHT_STANZAS.include?(key) - instance_eval(artifact[key]) - else - send(key, *artifact[key]) - end + send(key, *artifact[key]) end caveats json_cask[:caveats] if json_cask[:caveats].present? diff --git a/Library/Homebrew/test/cask/cask_spec.rb b/Library/Homebrew/test/cask/cask_spec.rb index e11a3e4c9b..a6c563d012 100644 --- a/Library/Homebrew/test/cask/cask_spec.rb +++ b/Library/Homebrew/test/cask/cask_spec.rb @@ -265,46 +265,6 @@ describe Cask::Cask, :cask do } JSON } - let(:expected_flight_variations) { - <<~JSON - { - "arm64_big_sur": { - "artifacts": [ - { - "preflight": " preflight do\\n puts \\"preflight on Big Sur\\"\\n end\\n" - }, - { - "uninstall_postflight": " uninstall_postflight do\\n puts \\"uninstall_postflight on Big Sur\\"\\n end\\n" - } - ] - }, - "big_sur": { - "artifacts": [ - { - "preflight": " preflight do\\n puts \\"preflight on Big Sur\\"\\n end\\n" - }, - { - "uninstall_postflight": " uninstall_postflight do\\n puts \\"uninstall_postflight on Big Sur\\"\\n end\\n" - } - ] - }, - "catalina": { - "artifacts": [ - { - "preflight": " preflight do\\n puts \\"preflight on Catalina or older\\"\\n end\\n" - } - ] - }, - "mojave": { - "artifacts": [ - { - "preflight": " preflight do\\n puts \\"preflight on Catalina or older\\"\\n end\\n" - } - ] - } - } - JSON - } before do # Use a more limited symbols list to shorten the variations hash @@ -340,13 +300,5 @@ describe Cask::Cask, :cask do expect(h).to be_a(Hash) expect(JSON.pretty_generate(h["variations"])).to eq expected_sha256_variations.strip end - - it "returns the correct variations hash for a cask with conditional flight blocks" do - c = Cask::CaskLoader.load("conditional-flight") - h = c.to_hash_with_variations - - expect(h).to be_a(Hash) - expect(JSON.pretty_generate(h["variations"])).to eq expected_flight_variations.strip - end end end diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/conditional-flight.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/conditional-flight.rb deleted file mode 100644 index ea49b82c11..0000000000 --- a/Library/Homebrew/test/support/fixtures/cask/Casks/conditional-flight.rb +++ /dev/null @@ -1,21 +0,0 @@ -cask "conditional-flight" do - version "1.2.3" - sha256 "67cdb8a02803ef37fdbf7e0be205863172e41a561ca446cd84f0d7ab35a99d94" - - url "file://#{TEST_FIXTURE_DIR}/cask/caffeine/#{platform}/#{version}/#{arch}.zip" - homepage "https://brew.sh/" - - on_big_sur do - preflight do - puts "preflight on Big Sur" - end - uninstall_postflight do - puts "uninstall_postflight on Big Sur" - end - end - on_catalina :or_older do - preflight do - puts "preflight on Catalina or older" - end - end -end diff --git a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source.rb b/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source.rb deleted file mode 100644 index 7d16c3b5b4..0000000000 --- a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source.rb +++ /dev/null @@ -1,141 +0,0 @@ -# (C) John Mair (banisterfiend) 2011 -# MIT License - -direc = File.dirname(__FILE__) - -require "#{direc}/method_source/version" -require "#{direc}/method_source/source_location" -require "#{direc}/method_source/code_helpers" - -module MethodSource - extend MethodSource::CodeHelpers - - # An Exception to mark errors that were raised trying to find the source from - # a given source_location. - # - class SourceNotFoundError < StandardError; end - - # Helper method responsible for extracting method body. - # Defined here to avoid polluting `Method` class. - # @param [Array] source_location The array returned by Method#source_location - # @param [String] method_name - # @return [String] The method body - def self.source_helper(source_location, name=nil) - raise SourceNotFoundError, "Could not locate source for #{name}!" unless source_location - file, line = *source_location - - expression_at(lines_for(file), line) - rescue SyntaxError => e - raise SourceNotFoundError, "Could not parse source for #{name}: #{e.message}" - end - - # Helper method responsible for opening source file and buffering up - # the comments for a specified method. Defined here to avoid polluting - # `Method` class. - # @param [Array] source_location The array returned by Method#source_location - # @param [String] method_name - # @return [String] The comments up to the point of the method. - def self.comment_helper(source_location, name=nil) - raise SourceNotFoundError, "Could not locate source for #{name}!" unless source_location - file, line = *source_location - - comment_describing(lines_for(file), line) - end - - # Load a memoized copy of the lines in a file. - # - # @param [String] file_name - # @param [String] method_name - # @return [Array] the contents of the file - # @raise [SourceNotFoundError] - def self.lines_for(file_name, name=nil) - @lines_for_file ||= {} - @lines_for_file[file_name] ||= File.readlines(file_name) - rescue Errno::ENOENT => e - raise SourceNotFoundError, "Could not load source for #{name}: #{e.message}" - end - - # @deprecated — use MethodSource::CodeHelpers#complete_expression? - def self.valid_expression?(str) - complete_expression?(str) - rescue SyntaxError - false - end - - # @deprecated — use MethodSource::CodeHelpers#expression_at - def self.extract_code(source_location) - source_helper(source_location) - end - - # This module is to be included by `Method` and `UnboundMethod` and - # provides the `#source` functionality - module MethodExtensions - - # We use the included hook to patch Method#source on rubinius. - # We need to use the included hook as Rubinius defines a `source` - # on Method so including a module will have no effect (as it's - # higher up the MRO). - # @param [Class] klass The class that includes the module. - def self.included(klass) - if klass.method_defined?(:source) && Object.const_defined?(:RUBY_ENGINE) && - RUBY_ENGINE =~ /rbx/ - - klass.class_eval do - orig_source = instance_method(:source) - - define_method(:source) do - begin - super - rescue - orig_source.bind(self).call - end - end - - end - end - end - - # Return the sourcecode for the method as a string - # @return [String] The method sourcecode as a string - # @raise SourceNotFoundException - # - # @example - # Set.instance_method(:clear).source.display - # => - # def clear - # @hash.clear - # self - # end - def source - MethodSource.source_helper(source_location, defined?(name) ? name : inspect) - end - - # Return the comments associated with the method as a string. - # @return [String] The method's comments as a string - # @raise SourceNotFoundException - # - # @example - # Set.instance_method(:clear).comment.display - # => - # # Removes all elements and returns self. - def comment - MethodSource.comment_helper(source_location, defined?(name) ? name : inspect) - end - end -end - -class Method - include MethodSource::SourceLocation::MethodExtensions - include MethodSource::MethodExtensions -end - -class UnboundMethod - include MethodSource::SourceLocation::UnboundMethodExtensions - include MethodSource::MethodExtensions -end - -class Proc - include MethodSource::SourceLocation::ProcExtensions - include MethodSource::MethodExtensions -end - diff --git a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/code_helpers.rb b/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/code_helpers.rb deleted file mode 100644 index ccf054a32a..0000000000 --- a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/code_helpers.rb +++ /dev/null @@ -1,154 +0,0 @@ -module MethodSource - - module CodeHelpers - # Retrieve the first expression starting on the given line of the given file. - # - # This is useful to get module or method source code. - # - # @param [Array, File, String] file The file to parse, either as a File or as - # @param [Integer] line_number The line number at which to look. - # NOTE: The first line in a file is - # line 1! - # @param [Hash] options The optional configuration parameters. - # @option options [Boolean] :strict If set to true, then only completely - # valid expressions are returned. Otherwise heuristics are used to extract - # expressions that may have been valid inside an eval. - # @option options [Integer] :consume A number of lines to automatically - # consume (add to the expression buffer) without checking for validity. - # @return [String] The first complete expression - # @raise [SyntaxError] If the first complete expression can't be identified - def expression_at(file, line_number, options={}) - options = { - :strict => false, - :consume => 0 - }.merge!(options) - - lines = file.is_a?(Array) ? file : file.each_line.to_a - - relevant_lines = lines[(line_number - 1)..-1] || [] - - extract_first_expression(relevant_lines, options[:consume]) - rescue SyntaxError => e - raise if options[:strict] - - begin - extract_first_expression(relevant_lines) do |code| - code.gsub(/\#\{.*?\}/, "temp") - end - rescue SyntaxError - raise e - end - end - - # Retrieve the comment describing the expression on the given line of the given file. - # - # This is useful to get module or method documentation. - # - # @param [Array, File, String] file The file to parse, either as a File or as - # a String or an Array of lines. - # @param [Integer] line_number The line number at which to look. - # NOTE: The first line in a file is line 1! - # @return [String] The comment - def comment_describing(file, line_number) - lines = file.is_a?(Array) ? file : file.each_line.to_a - - extract_last_comment(lines[0..(line_number - 2)]) - end - - # Determine if a string of code is a complete Ruby expression. - # @param [String] code The code to validate. - # @return [Boolean] Whether or not the code is a complete Ruby expression. - # @raise [SyntaxError] Any SyntaxError that does not represent incompleteness. - # @example - # complete_expression?("class Hello") #=> false - # complete_expression?("class Hello; end") #=> true - # complete_expression?("class 123") #=> SyntaxError: unexpected tINTEGER - def complete_expression?(str) - old_verbose = $VERBOSE - $VERBOSE = nil - - catch(:valid) do - eval("BEGIN{throw :valid}\n#{str}") - end - - # Assert that a line which ends with a , or \ is incomplete. - str !~ /[,\\]\s*\z/ - rescue IncompleteExpression - false - ensure - $VERBOSE = old_verbose - end - - private - - # Get the first expression from the input. - # - # @param [Array] lines - # @param [Integer] consume A number of lines to automatically - # consume (add to the expression buffer) without checking for validity. - # @yield a clean-up function to run before checking for complete_expression - # @return [String] a valid ruby expression - # @raise [SyntaxError] - def extract_first_expression(lines, consume=0, &block) - code = consume.zero? ? "" : lines.slice!(0..(consume - 1)).join - - lines.each do |v| - code << v - return code if complete_expression?(block ? block.call(code) : code) - end - raise SyntaxError, "unexpected $end" - end - - # Get the last comment from the input. - # - # @param [Array] lines - # @return [String] - def extract_last_comment(lines) - buffer = "" - - lines.each do |line| - # Add any line that is a valid ruby comment, - # but clear as soon as we hit a non comment line. - if (line =~ /^\s*#/) || (line =~ /^\s*$/) - buffer << line.lstrip - else - buffer.replace("") - end - end - - buffer - end - - # An exception matcher that matches only subsets of SyntaxErrors that can be - # fixed by adding more input to the buffer. - module IncompleteExpression - GENERIC_REGEXPS = [ - /unexpected (\$end|end-of-file|end-of-input|END_OF_FILE)/, # mri, jruby, ruby-2.0, ironruby - /embedded document meets end of file/, # =begin - /unterminated (quoted string|string|regexp|list) meets end of file/, # "quoted string" is ironruby - /can't find string ".*" anywhere before EOF/, # rbx and jruby - /missing 'end' for/, /expecting kWHEN/ # rbx - ] - - RBX_ONLY_REGEXPS = [ - /expecting '[})\]]'(?:$|:)/, /expecting keyword_end/ - ] - - def self.===(ex) - return false unless SyntaxError === ex - case ex.message - when *GENERIC_REGEXPS - true - when *RBX_ONLY_REGEXPS - rbx? - else - false - end - end - - def self.rbx? - RbConfig::CONFIG['ruby_install_name'] == 'rbx' - end - end - end -end diff --git a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/source_location.rb b/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/source_location.rb deleted file mode 100644 index 76298697b2..0000000000 --- a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/source_location.rb +++ /dev/null @@ -1,138 +0,0 @@ -module MethodSource - module ReeSourceLocation - # Ruby enterprise edition provides all the information that's - # needed, in a slightly different way. - def source_location - [__file__, __line__] rescue nil - end - end - - module SourceLocation - module MethodExtensions - if Proc.method_defined? :__file__ - include ReeSourceLocation - - elsif defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/ - require 'java' - - # JRuby version source_location hack - # @return [Array] A two element array containing the source location of the method - def source_location - to_java.source_location(Thread.current.to_java.getContext()) - end - else - - - def trace_func(event, file, line, id, binding, classname) - return unless event == 'call' - set_trace_func nil - - @file, @line = file, line - raise :found - end - - private :trace_func - - # Return the source location of a method for Ruby 1.8. - # @return [Array] A two element array. First element is the - # file, second element is the line in the file where the - # method definition is found. - def source_location - if @file.nil? - args =[*(1..(arity<-1 ? -arity-1 : arity ))] - - set_trace_func method(:trace_func).to_proc - call(*args) rescue nil - set_trace_func nil - @file = File.expand_path(@file) if @file && File.exist?(File.expand_path(@file)) - end - [@file, @line] if @file - end - end - end - - module ProcExtensions - if Proc.method_defined? :__file__ - include ReeSourceLocation - - elsif defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/ - - # Return the source location for a Proc (Rubinius only) - # @return [Array] A two element array. First element is the - # file, second element is the line in the file where the - # proc definition is found. - def source_location - [block.file.to_s, block.line] - end - else - - # Return the source location for a Proc (in implementations - # without Proc#source_location) - # @return [Array] A two element array. First element is the - # file, second element is the line in the file where the - # proc definition is found. - def source_location - self.to_s =~ /@(.*):(\d+)/ - [$1, $2.to_i] - end - end - end - - module UnboundMethodExtensions - if Proc.method_defined? :__file__ - include ReeSourceLocation - - elsif defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/ - require 'java' - - # JRuby version source_location hack - # @return [Array] A two element array containing the source location of the method - def source_location - to_java.source_location(Thread.current.to_java.getContext()) - end - - else - - - # Return the source location of an instance method for Ruby 1.8. - # @return [Array] A two element array. First element is the - # file, second element is the line in the file where the - # method definition is found. - def source_location - klass = case owner - when Class - owner - when Module - method_owner = owner - Class.new { include(method_owner) } - end - - # deal with immediate values - case - when klass == Symbol - return :a.method(name).source_location - when klass == Integer - return 0.method(name).source_location - when klass == TrueClass - return true.method(name).source_location - when klass == FalseClass - return false.method(name).source_location - when klass == NilClass - return nil.method(name).source_location - end - - begin - Object.instance_method(:method).bind(klass.allocate).call(name).source_location - rescue TypeError - - # Assume we are dealing with a Singleton Class: - # 1. Get the instance object - # 2. Forward the source_location lookup to the instance - instance ||= ObjectSpace.each_object(owner).first - Object.instance_method(:method).bind(instance).call(name).source_location - end - end - end - end - end -end diff --git a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/version.rb b/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/version.rb deleted file mode 100644 index 22f52de940..0000000000 --- a/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/method_source-1.0.0/lib/method_source/version.rb +++ /dev/null @@ -1,3 +0,0 @@ -module MethodSource - VERSION = '1.0.0'.freeze -end