From 212367c1c0d9feec2d741f37c81a92c5834b83f0 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sun, 1 Nov 2020 12:26:18 -0500 Subject: [PATCH] requirements: reword error messages for consistency also add formatting to download URLs --- .../extend/os/linux/requirements/osxfuse_requirement.rb | 2 +- .../extend/os/mac/requirements/osxfuse_requirement.rb | 4 ++++ .../extend/os/mac/requirements/x11_requirement.rb | 2 +- Library/Homebrew/requirement.rb | 2 +- Library/Homebrew/requirements/arch_requirement.rb | 2 +- Library/Homebrew/requirements/java_requirement.rb | 2 +- Library/Homebrew/requirements/linux_requirement.rb | 2 +- Library/Homebrew/requirements/macos_requirement.rb | 8 ++++---- Library/Homebrew/requirements/x11_requirement.rb | 2 +- Library/Homebrew/test/java_requirement_spec.rb | 2 +- .../test/requirements/osxfuse_requirement_spec.rb | 2 +- 11 files changed, 17 insertions(+), 13 deletions(-) diff --git a/Library/Homebrew/extend/os/linux/requirements/osxfuse_requirement.rb b/Library/Homebrew/extend/os/linux/requirements/osxfuse_requirement.rb index 1a2ed81272..1f4d2ce132 100644 --- a/Library/Homebrew/extend/os/linux/requirements/osxfuse_requirement.rb +++ b/Library/Homebrew/extend/os/linux/requirements/osxfuse_requirement.rb @@ -21,7 +21,7 @@ class OsxfuseRequirement < Requirement end def message - msg = "libfuse is required to install this formula.\n" + msg = "libfuse is required for this software.\n" if libfuse_formula_exists? <<~EOS #{msg}Run `brew install libfuse` to install it. diff --git a/Library/Homebrew/extend/os/mac/requirements/osxfuse_requirement.rb b/Library/Homebrew/extend/os/mac/requirements/osxfuse_requirement.rb index bdf2d9e933..3ae4716a47 100644 --- a/Library/Homebrew/extend/os/mac/requirements/osxfuse_requirement.rb +++ b/Library/Homebrew/extend/os/mac/requirements/osxfuse_requirement.rb @@ -21,4 +21,8 @@ class OsxfuseRequirement < Requirement ENV.append_path "HOMEBREW_INCLUDE_PATHS", "/usr/local/include/osxfuse" end end + + def message + "FUSE for macOS is required for this software. #{super}" + end end diff --git a/Library/Homebrew/extend/os/mac/requirements/x11_requirement.rb b/Library/Homebrew/extend/os/mac/requirements/x11_requirement.rb index 647c485b73..8b64a4ce00 100644 --- a/Library/Homebrew/extend/os/mac/requirements/x11_requirement.rb +++ b/Library/Homebrew/extend/os/mac/requirements/x11_requirement.rb @@ -17,6 +17,6 @@ class X11Requirement < Requirement end def message - "XQuartz #{min_version} (or newer) is required to install this formula. #{super}" + "XQuartz #{min_version} (or newer) is required for this software. #{super}" end end diff --git a/Library/Homebrew/requirement.rb b/Library/Homebrew/requirement.rb index 9d228c3cfd..1f10e4aee7 100644 --- a/Library/Homebrew/requirement.rb +++ b/Library/Homebrew/requirement.rb @@ -48,7 +48,7 @@ class Requirement if download s += <<~EOS You can download from: - #{download} + #{Formatter.url(download)} EOS end s diff --git a/Library/Homebrew/requirements/arch_requirement.rb b/Library/Homebrew/requirements/arch_requirement.rb index 7157b5e7e4..e05e71645e 100644 --- a/Library/Homebrew/requirements/arch_requirement.rb +++ b/Library/Homebrew/requirements/arch_requirement.rb @@ -24,7 +24,7 @@ class ArchRequirement < Requirement end def message - "This formula requires an #{@arch} architecture." + "The #{@arch} architecture is required for this software." end def inspect diff --git a/Library/Homebrew/requirements/java_requirement.rb b/Library/Homebrew/requirements/java_requirement.rb index 1c91bf5a52..3edab63aa8 100644 --- a/Library/Homebrew/requirements/java_requirement.rb +++ b/Library/Homebrew/requirements/java_requirement.rb @@ -39,7 +39,7 @@ class JavaRequirement < Requirement def message version_string = " #{@version}" if @version - s = "Java#{version_string} is required to install this formula.\n" + s = "Java#{version_string} is required for this software.\n" s += suggestion s end diff --git a/Library/Homebrew/requirements/linux_requirement.rb b/Library/Homebrew/requirements/linux_requirement.rb index a744caeab6..1a0e496282 100644 --- a/Library/Homebrew/requirements/linux_requirement.rb +++ b/Library/Homebrew/requirements/linux_requirement.rb @@ -10,6 +10,6 @@ class LinuxRequirement < Requirement satisfy(build_env: false) { OS.linux? } def message - "Linux is required." + "Linux is required for this software." end end diff --git a/Library/Homebrew/requirements/macos_requirement.rb b/Library/Homebrew/requirements/macos_requirement.rb index e8d9411a3a..c00750b9a2 100644 --- a/Library/Homebrew/requirements/macos_requirement.rb +++ b/Library/Homebrew/requirements/macos_requirement.rb @@ -41,11 +41,11 @@ class MacOSRequirement < Requirement end def message(type: :formula) - return "macOS is required." unless version_specified? + return "macOS is required for this software." unless version_specified? case @comparator when ">=" - "macOS #{@version.pretty_name} or newer is required." + "macOS #{@version.pretty_name} or newer is required for this software." when "<=" case type when :formula @@ -59,10 +59,10 @@ class MacOSRequirement < Requirement else if @version.respond_to?(:to_ary) *versions, last = @version.map(&:pretty_name) - return "macOS #{versions.join(", ")} or #{last} is required." + return "macOS #{versions.join(", ")} or #{last} is required for this software." end - "macOS #{@version.pretty_name} is required." + "macOS #{@version.pretty_name} is required for this software." end end diff --git a/Library/Homebrew/requirements/x11_requirement.rb b/Library/Homebrew/requirements/x11_requirement.rb index d758c771c1..4418f2f8ef 100644 --- a/Library/Homebrew/requirements/x11_requirement.rb +++ b/Library/Homebrew/requirements/x11_requirement.rb @@ -39,7 +39,7 @@ class X11Requirement < Requirement end def message - "X11 is required to install this formula, either Xorg #{min_version} or " \ + "X11 is required for this software, either Xorg #{min_version} or " \ "xdpyinfo #{min_xdpyinfo_version}, or newer. #{super}" end diff --git a/Library/Homebrew/test/java_requirement_spec.rb b/Library/Homebrew/test/java_requirement_spec.rb index 4998f4176b..673de6ac34 100644 --- a/Library/Homebrew/test/java_requirement_spec.rb +++ b/Library/Homebrew/test/java_requirement_spec.rb @@ -12,7 +12,7 @@ describe JavaRequirement do end describe "#message" do - its(:message) { is_expected.to match(/Java is required to install this formula./) } + its(:message) { is_expected.to match(/Java is required for this software./) } end describe "#inspect" do diff --git a/Library/Homebrew/test/requirements/osxfuse_requirement_spec.rb b/Library/Homebrew/test/requirements/osxfuse_requirement_spec.rb index 4b9632a389..faa1b6e7f4 100644 --- a/Library/Homebrew/test/requirements/osxfuse_requirement_spec.rb +++ b/Library/Homebrew/test/requirements/osxfuse_requirement_spec.rb @@ -44,7 +44,7 @@ describe OsxfuseRequirement do describe "#message" do it "prompts for installation of 'libfuse' on Linux", :needs_linux do - expect(requirement.message).to match("libfuse is required to install this formula") + expect(requirement.message).to match("libfuse is required for this software") end it "prompts for installation of 'osxFuse' on macOS", :needs_macos do