Support applications installing more than 1 binary (#342)

Author: SeanTAllen

.release-notes/multiple-binary.md

@@ -0,0 +1,9 @@
+## Support applications installing more than 1 binary
+
+The original design of ponyup was that you would install an application such as ponyc that in turn contained a single binary that shared the same name.
+
+We recently started including the Pony language server in the distribution with ponyc. Ponyup could install the distribution but would only install into the user's PATH the ponyc binary.
+
+We've added support for application distributions to contain more than one binary that will be linked into the user's PATH.
+
+The practical implication is that when you install a ponyc distribution that also contains `pony-lsp`, both `ponyc` and `pony-lsp` will be available via your PATH.

cmd/main.pony

@@ -98,7 +98,7 @@ actor Main is PonyupNotify
     let pkg =
       try
         Packages.from_fragments(
-          command.arg("package").string(),
+          Packages.application_from_string(command.arg("package").string())?,
           chan(0)?,
           try chan(1)? else "latest" end,
           platform.string().split("-"))?
@@ -118,7 +118,7 @@ actor Main is PonyupNotify
     let pkg =
       try
         Packages.from_fragments(
-          command.arg("package").string(),
+          Packages.application_from_string(command.arg("package").string())?,
           chan(0)?,
           try chan(1)? else "latest" end,
           platform.string().split("-"))?
@@ -136,7 +136,7 @@ actor Main is PonyupNotify
   be default(ponyup: Ponyup, command: Command val, ponyup_dir: FilePath) =>
     let platform = command.arg("platform").string()
     try
-      Packages.from_fragments("", "", "", platform.split("-"))?
+      Packages.platform_os()?
     else
       log(Err, "invalid platform identifier: " + platform)
       return

cmd/packages.pony

@@ -1,14 +1,65 @@
+class val Binary
+  let name: String
+  let required: Bool
+
+  new val create(n: String, req: Bool = true) =>
+    name = n
+    required = req
+
+trait val Application
+  fun name(): String
+  fun binaries(): Array[Binary] val
+
+primitive CorralApplication is Application
+  fun name(): String => "corral"
+  fun binaries(): Array[Binary] val => [Binary("corral")]
+
+primitive PonycApplication is Application
+  fun name(): String => "ponyc"
+  fun binaries(): Array[Binary] val => [
+    Binary("ponyc")
+    Binary("pony-lsp", false)
+  ]
+
+primitive PonyupApplication is Application
+  fun name(): String => "ponyup"
+  fun binaries(): Array[Binary] val => [Binary("ponyup")]
+
+primitive ChangelogToolApplication is Application
+  fun name(): String => "changelog-tool"
+  fun binaries(): Array[Binary] val => [Binary("changelog-tool")]
+
+primitive StableApplication is Application
+  fun name(): String => "stable"
+  fun binaries(): Array[Binary] val => [Binary("stable")]
 
 primitive Packages
-  fun apply(): Array[String] box =>
+  fun apply(): Array[Application] box =>
     ifdef windows then
-      ["corral"; "ponyc"; "ponyup"]
+      [CorralApplication; PonycApplication; PonyupApplication]
     else
-      ["changelog-tool"; "corral"; "ponyc"; "ponyup"; "stable"]
+      [
+        CorralApplication
+        PonycApplication
+        PonyupApplication
+        ChangelogToolApplication
+        StableApplication
+      ]
     end
 
+  fun application_from_string(name: String): Application ? =>
+    match name
+    | "ponyc" => PonycApplication
+    | "corral" => CorralApplication
+    | "ponyup" => PonyupApplication
+    | "changelog-tool" => ChangelogToolApplication
+    | "stable" => StableApplication
+    else
+      error
+    end
+     
   fun from_fragments(
-    name: String,
+    application: Application,
     channel: String,
     version: String,
     platform: Array[String] box)
@@ -46,12 +97,12 @@ primitive Packages
         if i == (platform'.size() - 1) then distro = field end
       end
     end
-    if (name == "ponyc") and platform_requires_distro(os) then
+    if (application.name() == "ponyc") and platform_requires_distro(os) then
       if distro is None then error end
     else
       distro = None
     end
-    Package._create(name, channel, version, (cpu, os, distro))
+    Package._create(application, channel, version, (cpu, os, distro))
 
   fun from_string(str: String): Package ? =>
     let fragments = str.split("-")
@@ -60,8 +111,9 @@ primitive Packages
       fragments.delete(1)?
       fragments(0)? = "changelog-tool"
     end
+
     from_fragments(
-      fragments(0)?,
+      application_from_string(fragments(0)?)?,
       fragments(1)?,
       fragments(2)?,
       (consume fragments).slice(3))?
@@ -84,7 +136,7 @@ primitive Packages
     end
 
 class val Package is Comparable[Package box]
-  let name: String
+  let application: Application
   let channel: String
   let version: String
   let cpu: CPU
@@ -93,24 +145,27 @@ class val Package is Comparable[Package box]
   let selected: Bool
 
   new val _create(
-    name': String,
+    application': Application,
     channel': String,
     version': String,
     platform': (CPU, OS, Distro),
     selected': Bool = false)
   =>
-    name = name'
+    application = application'
     channel = channel'
     version = version'
     (cpu, os, distro) = platform'
     selected = selected'
 
+  fun name(): String =>
+    application.name()
+  
   fun update_version(version': String, selected': Bool = false): Package =>
-    _create(name, channel, version', (cpu, os, distro), selected')
+    _create(application, channel, version', (cpu, os, distro), selected')
 
   fun platform(): String iso^ =>
     let str = "-".join([cpu; os].values())
-    match (name == "ponyc", distro)
+    match (application.name() == "ponyc", distro)
     | (true, let distro_name: String) => str.append("-" + distro_name)
     end
     str
@@ -122,7 +177,7 @@ class val Package is Comparable[Package box]
     string() <= other.string()
 
   fun string(): String iso^ =>
-    "-".join([name; channel; version; platform()].values())
+    "-".join([application.name(); channel; version; platform()].values())
 
 type CPU is ((AMD64 | ARM64) & _CPU)
 interface val _CPU is (Equatable[_OS] & Stringable)

cmd/ponyup.pony

@@ -58,11 +58,6 @@ actor Ponyup
       return
     end
 
-    if not Packages().contains(pkg.name, {(a, b) => a == b }) then
-      _notify.log(Err, "unknown package: " + pkg.name)
-      return
-    end
-
     if _lockfile.contains(pkg) then
       _notify.log(Info, pkg.string() + " is up to date")
       return
@@ -175,15 +170,15 @@ actor Ponyup
     end
 
     _notify.log(Info, " ".join(
-      [ "selecting"; pkg; "as default for"; pkg.name
+      [ "selecting"; pkg; "as default for"; pkg.name()
       ].values()))
 
     var pkg' =
       try
         var p = pkg
         if p.version == "latest" then
           var latest = ""
-          for installed in local_packages(p.name).values() do
+          for installed in local_packages(p.name()).values() do
             if (installed.channel == p.channel) and (installed.version > latest)
             then latest = installed.version
             end
@@ -211,48 +206,63 @@ actor Ponyup
       end
 
     ifdef windows then
-      let link_rel: String = Path.sep().join(["bin"; pkg'.name].values())
-        + ".exe"
-      let bin_rel: String = Path.sep().join([pkg'.string(); link_rel].values())
+      for binary in pkg'.application.binaries().values() do
+        let link_rel: String = Path.sep().join(["bin"; binary.name].values())
+          + ".exe"
+        let bin_rel: String = Path.sep().join([pkg'.string(); link_rel].values())
 
-      try
-        let bin_path = _root.join(bin_rel)?
-        _notify.log(Info, " bin: " + bin_path.path)
+        try
+          let bin_path = _root.join(bin_rel)?
+         _notify.log(Info, " bin: " + bin_path.path)
 
-        let link_dir = _root.join("bin")?
-        if not link_dir.exists() then link_dir.mkdir() end
+          let link_dir = _root.join("bin")?
+          if not link_dir.exists() then link_dir.mkdir() end
 
-        let link_path = link_dir.join(pkg'.name + ".bat")?
-        _notify.log(Info, "link: " + link_path.path)
+          let link_path = link_dir.join(binary.name + ".bat")?
+          _notify.log(Info, "link: " + link_path.path)
 
-        if link_path.exists() then link_path.remove() end
-        with file = File.create(link_path) do
-          file.print("@echo off")
-          file.print("\"" + bin_path.path + "\" %*")
+          if link_path.exists() then link_path.remove() end
+          // It is ok for optional binaries to not exist. If they don't then
+          // we just skip them.
+          if (not binary.required) and (not bin_path.exists()) then
+            _notify.log(Info, "optional binary isn't in package. skipping.")
+            continue
+          end
+          with file = File.create(link_path) do
+            file.print("@echo off")
+            file.print("\"" + bin_path.path + "\" %*")
+          end
+        else
+          _notify.log(Err, "failed to create link batch file(s)")
         end
-      else
-        _notify.log(Err, "failed to create link batch file")
       end
-
     else
-      let link_rel: String = "/".join(["bin"; pkg'.name].values())
-      let bin_rel: String = "/".join([pkg'.string(); link_rel].values())
+      for binary in pkg'.application.binaries().values() do
+        let link_rel: String = "/".join(["bin"; binary.name].values())
+        let bin_rel: String = "/".join([pkg'.string(); link_rel].values())
 
-      try
-        let bin_path = _root.join(bin_rel)?
-        _notify.log(Info, " bin: " + bin_path.path)
+        try
+          let bin_path = _root.join(bin_rel)?
+         _notify.log(Info, " bin: " + bin_path.path)
 
-        let link_dir = _root.join("bin")?
-        if not link_dir.exists() then link_dir.mkdir() end
+          let link_dir = _root.join("bin")?
+          if not link_dir.exists() then link_dir.mkdir() end
 
-        let link_path = link_dir.join(pkg'.name)?
-        _notify.log(Info, "link: " + link_path.path)
+          let link_path = link_dir.join(binary.name)?
+          _notify.log(Info, "link: " + link_path.path)
 
-        if link_path.exists() then link_path.remove() end
-        if not bin_path.symlink(link_path) then error end
-      else
-        _notify.log(Err, "failed to create symbolic link")
-        return
+          if link_path.exists() then link_path.remove() end
+          // It is ok for optional binaries to not exist. If they don't then
+          // we just skip them.
+          if (not binary.required) and (not bin_path.exists()) then
+            _notify.log(Info, "optional binary isn't in package. skipping.")
+            continue
+          end
+          if not bin_path.symlink(link_path) then error end
+        else
+          _notify.log(Err, "failed to create symbolic link(s)")
+          return
+        end
       end
     end
 
@@ -432,17 +442,17 @@ class LockFile
       let pkg = Packages.from_string(fields(0)?)?
       let selected = try fields(1)? == "*" else false end
 
-      let entry = _entries.get_or_else(pkg.name, LockFileEntry)
+      let entry = _entries.get_or_else(pkg.name(), LockFileEntry)
       if selected then
         entry.selection = entry.packages.size()
       end
       entry.packages.push(pkg)
-      _entries(pkg.name) = entry
+      _entries(pkg.name()) = entry
     end
 
   fun contains(pkg: Package): Bool =>
     if pkg.version == "latest" then return false end
-    let entry = _entries.get_or_else(pkg.name, LockFileEntry)
+    let entry = _entries.get_or_else(pkg.name(), LockFileEntry)
     entry.packages.contains(pkg, {(a, b) => a.string() == b.string() })
 
   fun selection(pkg_name: String): (Package | None) =>
@@ -452,12 +462,12 @@ class LockFile
     end
 
   fun ref add_package(pkg: Package) =>
-    let entry = _entries.get_or_else(pkg.name, LockFileEntry)
+    let entry = _entries.get_or_else(pkg.name(), LockFileEntry)
     entry.packages.push(pkg)
-    _entries(pkg.name) = entry
+    _entries(pkg.name()) = entry
 
   fun ref select(pkg: Package) ? =>
-    let entry = _entries(pkg.name)?
+    let entry = _entries(pkg.name())?
     entry.selection = entry.packages.find(
       pkg where predicate = {(a, b) => a.string() == b.string() })?