From 88b2e9201536b89e9f4ec7245b234e5ff5e819b5 Mon Sep 17 00:00:00 2001 From: Roland Walker Date: Sat, 15 Nov 2014 10:57:57 -0500 Subject: [PATCH] DSL: add stanza `stage_only` (new `caskroom_only`) `caskroom_only` was never documented. Its original purpose was obsoleted in #4865, and its use has been recently been reduced to two Casks. This PR * continues the rationalization of naming by changing `caskroom_only` to `stage_only`. "stage" is the verb for "make a copy under the caskroom directory" * documents `stage_only` * adds tests for `stage_only` * validates the argument to `stage_only` * gives sensible output in `brew cask info` for `stage_only` Casks * enforces that `stage_only` cannot coexist with any activatable artifacts `caskroom_only` is still supported for backward compatibility, but should be removed before 0.50.0. --- doc/CASK_LANGUAGE_REFERENCE.md | 2 + doc/cask_language_deltas.md | 1 + lib/cask/artifact.rb | 4 +- .../{caskroom_only.rb => stage_only.rb} | 4 +- lib/cask/cli/info.rb | 3 +- lib/cask/cli/internal_stanza.rb | 2 +- lib/cask/dsl.rb | 52 ++++++++++++++----- test/cask/dsl_test.rb | 14 +++++ .../invalid/invalid-stage-only-conflict.rb | 10 ++++ test/support/Casks/stage-only.rb | 9 ++++ 10 files changed, 81 insertions(+), 20 deletions(-) rename lib/cask/artifact/{caskroom_only.rb => stage_only.rb} (62%) create mode 100644 test/support/Casks/invalid/invalid-stage-only-conflict.rb create mode 100644 test/support/Casks/stage-only.rb diff --git a/doc/CASK_LANGUAGE_REFERENCE.md b/doc/CASK_LANGUAGE_REFERENCE.md index 248579876725..a4c74465f3c6 100644 --- a/doc/CASK_LANGUAGE_REFERENCE.md +++ b/doc/CASK_LANGUAGE_REFERENCE.md @@ -119,6 +119,7 @@ Each Cask must declare one or more *artifacts* (i.e. something to install) | `container :type =>` | no | a symbol to override container-type autodetect. may be one of: `:air`, `:bz2`, `:cab`, `:dmg`, `:generic_unar`, `:gzip`, `:otf`, `:pkg`, `:rar`, `:seven_zip`, `:sit`, `:tar`, `:ttf`, `:xar`, `:zip`, `:naked`. (example [parse.rb](../Casks/parse.rb)) | `tags` | no | a list of key-value pairs for Cask annotation. Not free-form. (see also [Tags Stanza Details](#tags-stanza-details)) | `gpg` | no | *stub: not yet functional.* (see also [GPG Stanza Details](#gpg-stanza-details)) +| `stage_only` | no | `true`. Assert that the Cask contains no activatable artifacts. ## Legacy Stanzas @@ -136,6 +137,7 @@ The following stanzas are no longer in use. | `install` | an obsolete alternative to `pkg` | `link` | an obsolete alternative to `artifact` | `no_checksum` | an obsolete alternative to `sha256 :no_check` +| `caskroom_only` | an obsolete alternative to `stage_only` ## Legacy Forms diff --git a/doc/cask_language_deltas.md b/doc/cask_language_deltas.md index dd94062c722c..a20bdc5f0e3a 100644 --- a/doc/cask_language_deltas.md +++ b/doc/cask_language_deltas.md @@ -50,6 +50,7 @@ This notice will be removed for the final form.** * `installer :script` * `license` * `suite` + * `stage_only` * `tags` * `uninstall :rmdir` * `uninstall :trash` diff --git a/lib/cask/artifact.rb b/lib/cask/artifact.rb index dec0437d82e7..16bdd92534ab 100644 --- a/lib/cask/artifact.rb +++ b/lib/cask/artifact.rb @@ -20,7 +20,7 @@ module Cask::Artifact; end require 'cask/artifact/widget' require 'cask/artifact/service' require 'cask/artifact/suite' -require 'cask/artifact/caskroom_only' +require 'cask/artifact/stage_only' require 'cask/artifact/input_method' require 'cask/artifact/internet_plugin' require 'cask/artifact/screen_saver' @@ -46,7 +46,7 @@ def self.artifacts Cask::Artifact::Font, Cask::Artifact::Widget, Cask::Artifact::Service, - Cask::Artifact::CaskroomOnly, + Cask::Artifact::StageOnly, Cask::Artifact::Binary, Cask::Artifact::InputMethod, Cask::Artifact::InternetPlugin, diff --git a/lib/cask/artifact/caskroom_only.rb b/lib/cask/artifact/stage_only.rb similarity index 62% rename from lib/cask/artifact/caskroom_only.rb rename to lib/cask/artifact/stage_only.rb index 1bd68d1328ee..b1f0d6a0a842 100644 --- a/lib/cask/artifact/caskroom_only.rb +++ b/lib/cask/artifact/stage_only.rb @@ -1,6 +1,6 @@ -class Cask::Artifact::CaskroomOnly < Cask::Artifact::Base +class Cask::Artifact::StageOnly < Cask::Artifact::Base def self.artifact_dsl_key - :caskroom_only + :stage_only end def install_phase diff --git a/lib/cask/cli/info.rb b/lib/cask/cli/info.rb index 4df244cdd09f..8313f3fb1403 100644 --- a/lib/cask/cli/info.rb +++ b/lib/cask/cli/info.rb @@ -56,7 +56,8 @@ def self.artifact_info(cask) if cask.artifacts[type].length > 0 retval = "#{Tty.blue}==>#{Tty.white} Contents#{Tty.reset}\n" unless retval.length > 0 cask.artifacts[type].each do |artifact| - retval.concat " #{artifact.first} (#{type.to_s})\n" + activatable_item = type == :stage_only ? '' : artifact.first + retval.concat " #{activatable_item} (#{type.to_s})\n" end end end diff --git a/lib/cask/cli/internal_stanza.rb b/lib/cask/cli/internal_stanza.rb index 2a671cbf0f94..26ed7df6080a 100644 --- a/lib/cask/cli/internal_stanza.rb +++ b/lib/cask/cli/internal_stanza.rb @@ -36,7 +36,7 @@ class Cask::CLI::InternalStanza < Cask::CLI::InternalUseBase :internet_plugin, :screen_saver, :pkg, - :caskroom_only, + :stage_only, :nested_container, :uninstall, :postflight, diff --git a/lib/cask/dsl.rb b/lib/cask/dsl.rb index 693a9facbb76..19242327da0c 100644 --- a/lib/cask/dsl.rb +++ b/lib/cask/dsl.rb @@ -225,15 +225,50 @@ def self.ordinary_artifact_types :internet_plugin, :screen_saver, :pkg, + :stage_only, ] end - installable_artifact_types = ordinary_artifact_types - installable_artifact_types.push :caskroom_only + def self.activatable_artifact_types + @@activatable_artifact_types ||= [:installer, *ordinary_artifact_types] - [:stage_only] + end - installable_artifact_types.each do |type| + ordinary_artifact_types.each do |type| define_method(type) do |*args| + if type == :stage_only and args != [true] + raise CaskInvalidError.new(self.title, "'stage_only' takes a single argument: true") + end artifacts[type] << args + if artifacts.key?(:stage_only) and + artifacts.keys.count > 1 and + ! (artifacts.keys & Cask::DSL::ClassMethods.activatable_artifact_types).empty? + raise CaskInvalidError.new(self.title, "'stage_only' must be the only activatable artifact") + end + end + end + + # todo transitional removeme + define_method(:caskroom_only) do |*args| + if args != [true] + raise CaskInvalidError.new(self.title, "'caskroom_only' takes a single argument: true") + end + artifacts[:stage_only] << args + if artifacts.key?(:stage_only) and + artifacts.keys.count > 1 and + ! (artifacts.keys & Cask::DSL::ClassMethods.activatable_artifact_types).empty? + raise CaskInvalidError.new(self.title, "'caskroom_only' must be the only activatable artifact") + end + end + + def installer(*args) + if args.empty? + return artifacts[:installer] + end + begin + artifacts[:installer] << Cask::DSL::Installer.new(*args) + raise "'stage_only' must be the only activatable artifact" if artifacts.key?(:stage_only) + rescue StandardError => e + raise CaskInvalidError.new(self.title, e) end end @@ -262,17 +297,6 @@ def self.ordinary_artifact_types end end - def installer(*args) - if args.empty? - return artifacts[:installer] - end - begin - artifacts[:installer] << Cask::DSL::Installer.new(*args) - rescue StandardError => e - raise CaskInvalidError.new(self.title, e) - end - end - attr_reader :sums def hash_name(hash_type) diff --git a/test/cask/dsl_test.rb b/test/cask/dsl_test.rb index e8ef685bc6e5..149324a7cab6 100644 --- a/test/cask/dsl_test.rb +++ b/test/cask/dsl_test.rb @@ -295,4 +295,18 @@ def caveats; <<-EOS.undent }.must_raise(CaskInvalidError) end end + + describe "stage_only stanza" do + it "allows stage_only stanza to be specified" do + cask = Cask.load('stage-only') + cask.artifacts[:stage_only].first.must_equal [true] + end + + it "prevents specifying stage_only with other activatables" do + err = lambda { + invalid_cask = Cask.load('invalid/invalid-stage-only-conflict') + }.must_raise(CaskInvalidError) + err.message.must_include "'stage_only' must be the only activatable artifact" + end + end end diff --git a/test/support/Casks/invalid/invalid-stage-only-conflict.rb b/test/support/Casks/invalid/invalid-stage-only-conflict.rb new file mode 100644 index 000000000000..402689819a56 --- /dev/null +++ b/test/support/Casks/invalid/invalid-stage-only-conflict.rb @@ -0,0 +1,10 @@ +class InvalidStageOnlyConflict < TestCask + version '2.61' + sha256 'd26d7481cf1229f879c05e11cbdf440d99db6d6342f26c73d8ba7861b975532f' + + url TestHelper.local_binary_url('transmission-2.61.dmg') + homepage 'http://example.com/invalid-stage-only-conflict' + + stage_only true + app 'Transmission.app' +end diff --git a/test/support/Casks/stage-only.rb b/test/support/Casks/stage-only.rb new file mode 100644 index 000000000000..c5683e0cae3e --- /dev/null +++ b/test/support/Casks/stage-only.rb @@ -0,0 +1,9 @@ +class StageOnly < TestCask + version '2.61' + sha256 'd26d7481cf1229f879c05e11cbdf440d99db6d6342f26c73d8ba7861b975532f' + + url TestHelper.local_binary_url('transmission-2.61.dmg') + homepage 'http://example.com/stage-only' + + stage_only true +end