brew/Library/Homebrew/cask/artifact/abstract_flight_block.rb

52 lines
1.2 KiB
Ruby
Raw Normal View History

rubocop: Use `Sorbet/StrictSigil` as it's better than comments - Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
2024-08-12 10:30:59 +01:00
# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
require "cask/artifact/abstract_artifact"
2016-08-18 22:11:42 +03:00
2018-09-06 08:29:14 +02:00
module Cask
2016-09-24 13:52:43 +02:00
module Artifact
2020-08-19 10:23:41 +02:00
# Abstract superclass for block artifacts.
class AbstractFlightBlock < AbstractArtifact
def self.dsl_key
super.to_s.sub(/_block$/, "").to_sym
2016-09-24 13:52:43 +02:00
end
def self.uninstall_dsl_key
dsl_key.to_s.prepend("uninstall_").to_sym
2016-09-24 13:52:43 +02:00
end
attr_reader :directives
def initialize(cask, **directives)
super(cask)
@directives = directives
2016-09-24 13:52:43 +02:00
end
def install_phase(**)
abstract_phase(self.class.dsl_key)
2016-09-24 13:52:43 +02:00
end
def uninstall_phase(**)
abstract_phase(self.class.uninstall_dsl_key)
2016-09-24 13:52:43 +02:00
end
2022-08-25 02:52:40 -04:00
def summarize
directives.keys.map(&:to_s).join(", ")
end
2016-09-24 13:52:43 +02:00
private
def class_for_dsl_key(dsl_key)
namespace = self.class.name.to_s.sub(/::.*::.*$/, "")
self.class.const_get("#{namespace}::DSL::#{dsl_key.to_s.split("_").map(&:capitalize).join}")
end
2016-09-24 13:52:43 +02:00
def abstract_phase(dsl_key)
return if (block = directives[dsl_key]).nil?
2018-09-17 02:45:00 +02:00
class_for_dsl_key(dsl_key).new(cask).instance_eval(&block)
2016-09-24 13:52:43 +02:00
end
2016-08-18 22:11:42 +03:00
end
end
end