From 26bdccd80f4de07b2799eadc7ac64789cd56bcd7 Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Tue, 29 Nov 2016 05:57:43 -0500 Subject: [PATCH 1/4] Revert "Fix key selection for build level keys" This reverts commit 60bcc58852a1c7a9f92a9c274f70adbe6b87cea4. --- main/src/main/scala/sbt/internal/Act.scala | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/main/src/main/scala/sbt/internal/Act.scala b/main/src/main/scala/sbt/internal/Act.scala index 91d272dad..35dc55aca 100644 --- a/main/src/main/scala/sbt/internal/Act.scala +++ b/main/src/main/scala/sbt/internal/Act.scala @@ -78,16 +78,11 @@ object Act { selectFromValid(ss filter isValid(data), default) } def selectFromValid(ss: Seq[ParsedKey], default: Parser[ParsedKey])(implicit show: Show[ScopedKey[_]]): Parser[ParsedKey] = - selectByTask(selectByConfig(ss)) partition isBuildKey match { - case (_, Seq(single)) => success(single) - case (Seq(single), Seq()) => success(single) - case (Seq(), Seq()) => default - case (buildKeys, projectKeys) => failure("Ambiguous keys: " + showAmbiguous(keys(buildKeys ++ projectKeys))) + selectByTask(selectByConfig(ss)) match { + case Seq() => default + case Seq(single) => success(single) + case multi => failure("Ambiguous keys: " + showAmbiguous(keys(multi))) } - private def isBuildKey(parsed: ParsedKey): Boolean = parsed.key.scope.project match { - case Select(_: BuildReference) => true - case _ => false - } private[this] def keys(ss: Seq[ParsedKey]): Seq[ScopedKey[_]] = ss.map(_.key) def selectByConfig(ss: Seq[ParsedKey]): Seq[ParsedKey] = ss match { @@ -315,4 +310,4 @@ object Act { final object Omitted extends ParsedAxis[Nothing] final class ParsedValue[T](val value: T) extends ParsedAxis[T] def value[T](t: Parser[T]): Parser[ParsedAxis[T]] = t map { v => new ParsedValue(v) } -} +} \ No newline at end of file From 39ad8cfb7d16b2b9c372e9d81be605b9afb4e59c Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Tue, 29 Nov 2016 05:59:18 -0500 Subject: [PATCH 2/4] Revert "Unspecified project axis means current project or its build" This reverts commit 4fea604759100950bad1a296758c018787c3fd19. --- main/src/test/scala/ParseKey.scala | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/main/src/test/scala/ParseKey.scala b/main/src/test/scala/ParseKey.scala index 6f1430d65..60bb17a7d 100644 --- a/main/src/test/scala/ParseKey.scala +++ b/main/src/test/scala/ParseKey.scala @@ -31,7 +31,7 @@ object ParseKey extends Properties("Key parser test") { parseExpected(structure, string, expected, mask) } - property("An unspecified project axis resolves to the current project or the build of the current project") = + property("An unspecified project axis resolves to the current project") = forAllNoShrink(structureDefinedKey) { (skm: StructureKeyMask) => import skm.{ structure, key } @@ -43,7 +43,7 @@ object ParseKey extends Properties("Key parser test") { ("Current: " + structure.current) |: parse(structure, string) { case Left(err) => false - case Right(sk) => sk.scope.project == Select(structure.current) || sk.scope.project == Select(BuildRef(structure.current.build)) + case Right(sk) => sk.scope.project == Select(structure.current) } } From 4ea2a99c3b6300bf465d7cdf07dcb336c068b9a2 Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Tue, 29 Nov 2016 05:59:33 -0500 Subject: [PATCH 3/4] Revert "Completion for build-level keys" This reverts commit e35f9bb11ef851590811e1bccfcb082b8a27fecf. --- main/src/main/scala/sbt/internal/Act.scala | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/main/src/main/scala/sbt/internal/Act.scala b/main/src/main/scala/sbt/internal/Act.scala index 35dc55aca..c8e3660c0 100644 --- a/main/src/main/scala/sbt/internal/Act.scala +++ b/main/src/main/scala/sbt/internal/Act.scala @@ -49,22 +49,12 @@ object Act { new ParsedKey(makeScopedKey(proj, conf, task, extra, key), mask) } - val projectKeys = - for { - rawProject <- optProjectRef(index, current) - proj = resolveProject(rawProject, current) - confAmb <- config(index configs proj) - partialMask = ScopeMask(rawProject.isExplicit, confAmb.isExplicit, false, false) - } yield taskKeyExtra(proj, confAmb, partialMask) - - val build = Some(BuildRef(current.build)) - val buildKeys = - for { - confAmb <- config(index configs build) - partialMask = ScopeMask(false, confAmb.isExplicit, false, false) - } yield taskKeyExtra(build, confAmb, partialMask) - - buildKeys combinedWith projectKeys map (_.flatten) + for { + rawProject <- optProjectRef(index, current) + proj = resolveProject(rawProject, current) + confAmb <- config(index configs proj) + partialMask = ScopeMask(rawProject.isExplicit, confAmb.isExplicit, false, false) + } yield taskKeyExtra(proj, confAmb, partialMask) } def makeScopedKey(proj: Option[ResolvedReference], conf: Option[String], task: Option[AttributeKey[_]], extra: ScopeAxis[AttributeMap], key: AttributeKey[_]): ScopedKey[_] = ScopedKey(Scope(toAxis(proj, Global), toAxis(conf map ConfigKey.apply, Global), toAxis(task, Global), extra), key) From 569e19d03c705f8e1c4e7a78d2f444bfda17313e Mon Sep 17 00:00:00 2001 From: Eugene Yokota Date: Wed, 30 Nov 2016 02:33:05 -0500 Subject: [PATCH 4/4] Add build-level keys to the tab completion Fixes #2460 Fixes #2851 Ref #2707, #2708, #2469 Unlike the previous attempts at fixing the handling of build-level keys, this change does not change the main parsing logic, which uses `getKey` to retrieve the key from the key map. The fact that shell worked pre-0.13.11 means that the parsing was ok. What this changes is just the "example" keys supplied to the parser so the tab completion works. --- main/src/main/scala/sbt/internal/Act.scala | 11 ++++++- notes/0.13.14/buildlevelkey.md | 9 ++++++ .../sbt-test/actions/completions/build.sbt | 29 +++++++++++++++++++ .../completions/project/FooPlugin.scala | 15 ++++++++++ sbt/src/sbt-test/actions/completions/test | 1 + 5 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 notes/0.13.14/buildlevelkey.md create mode 100644 sbt/src/sbt-test/actions/completions/build.sbt create mode 100644 sbt/src/sbt-test/actions/completions/project/FooPlugin.scala create mode 100644 sbt/src/sbt-test/actions/completions/test diff --git a/main/src/main/scala/sbt/internal/Act.scala b/main/src/main/scala/sbt/internal/Act.scala index c8e3660c0..6be991063 100644 --- a/main/src/main/scala/sbt/internal/Act.scala +++ b/main/src/main/scala/sbt/internal/Act.scala @@ -134,7 +134,16 @@ object Act { token(ID !!! "Expected key" examples dropHyphenated(keys)) flatMap { keyString => getKey(keyMap, keyString, idFun) } - keyParser(index.keys(proj, conf, task)) + // Fixes sbt/sbt#2460 and sbt/sbt#2851 + // The parser already accepts build-level keys. + // This queries the key index so tab completion will list the build-level keys. + val buildKeys: Set[String] = + proj match { + case Some(ProjectRef(uri, id)) => index.keys(Some(BuildRef(uri)), conf, task) + case _ => Set() + } + val keys: Set[String] = index.keys(proj, conf, task) ++ buildKeys + keyParser(keys) } def getKey[T](keyMap: Map[String, AttributeKey[_]], keyString: String, f: AttributeKey[_] => T): Parser[T] = diff --git a/notes/0.13.14/buildlevelkey.md b/notes/0.13.14/buildlevelkey.md new file mode 100644 index 000000000..e5ee44518 --- /dev/null +++ b/notes/0.13.14/buildlevelkey.md @@ -0,0 +1,9 @@ +### Bug fixes + +- Fixes regressions in sbt 0.13.11 - 0.13.13 that processed build-level keys incorrectly. [#2851][2851]/[#2460][2460] by [@eed3si9n] + + [#2851]: https://github.com/sbt/sbt/issues/2851 + [#2460]: https://github.com/sbt/sbt/issues/2460 + [@eed3si9n]: https://github.com/eed3si9n + [@dwijnand]: https://github.com/dwijnand + [@Duhemm]: https://github.com/Duhemm diff --git a/sbt/src/sbt-test/actions/completions/build.sbt b/sbt/src/sbt-test/actions/completions/build.sbt new file mode 100644 index 000000000..072ab22e7 --- /dev/null +++ b/sbt/src/sbt-test/actions/completions/build.sbt @@ -0,0 +1,29 @@ +import complete.{ Completion, Completions, DefaultParsers, Parser } +import DefaultParsers._ +import Command.applyEffect +import CommandUtil._ + +lazy val root = (project in file(".")). + enablePlugins(FooPlugin). + settings( + commands += checkCompletionsCommand + ) + +// This checks the tab completion lists build-level keys +def checkCompletionsCommand = Command.make("checkCompletions")(completionsParser) +def completionsParser(state: State) = + { + val notQuoted = (NotQuoted ~ any.*) map { case (nq, s) => (nq +: s).mkString } + val quotedOrUnquotedSingleArgument = Space ~> (StringVerbatim | StringEscapable | notQuoted) + applyEffect(token(quotedOrUnquotedSingleArgument ?? "" examples ("", " ")))(runCompletions(state)) + } +def runCompletions(state: State)(input: String): State = { + val xs = Parser.completions(state.combinedParser, input, 9).get map { + c => if (c.isEmpty) input else input + c.append + } map { c => + c.replaceAll("\n", " ") + } + println(xs) + assert(xs == Set("myTask")) + state +} diff --git a/sbt/src/sbt-test/actions/completions/project/FooPlugin.scala b/sbt/src/sbt-test/actions/completions/project/FooPlugin.scala new file mode 100644 index 000000000..092417875 --- /dev/null +++ b/sbt/src/sbt-test/actions/completions/project/FooPlugin.scala @@ -0,0 +1,15 @@ +import sbt._ +import syntax._ + +object FooPlugin extends AutoPlugin { + override def trigger = noTrigger + object autoImport { + val myTask = taskKey[Unit]("My task") + } + + import autoImport._ + + override def buildSettings = super.buildSettings ++ Seq( + myTask := println("Called my task") + ) +} diff --git a/sbt/src/sbt-test/actions/completions/test b/sbt/src/sbt-test/actions/completions/test new file mode 100644 index 000000000..942db912e --- /dev/null +++ b/sbt/src/sbt-test/actions/completions/test @@ -0,0 +1 @@ +> checkCompletions my