chore(release): 0.6.7

The Frameworks folder is the recommended location to store shared
libraries within macOS application bundles. Previously we stored them in
Contents/MacOS/lib.

Latest nightly builds already store all *.eln files under the Frameworks
folder, so it seemed like a good time to make the change with the
library bundler/embedder too.

CHANGELOG.md

@@ -2,6 +2,38 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.6.7](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.6...v0.6.7) (2021-07-02)
+
+
+### Features
+
+* **bundle:** move bundled shared libraries to Contents/Frameworks ([5c722e3](https://github.com/jimeh/build-emacs-for-macos/commit/5c722e36c571aa7bf558b7f210c011f12d8d8a1c))
+
+### [0.6.6](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.5...v0.6.6) (2021-07-01)
+
+### [0.6.5](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.4...v0.6.5) (2021-07-01)
+
+
+### Bug Fixes
+
+* **native_comp:** improve handling of *.eln files in .app bundle ([9019e73](https://github.com/jimeh/build-emacs-for-macos/commit/9019e73d606f0379f988f46d6008770f8f3f7a51))
+
+### [0.6.4](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.3...v0.6.4) (2021-06-30)
+
+### [0.6.3](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.2...v0.6.3) (2021-06-29)
+
+
+### Bug Fixes
+
+* **patches:** correctly set ref when loading a build plan YAML ([99aa76b](https://github.com/jimeh/build-emacs-for-macos/commit/99aa76b3985195c310a20bafa19a8c7a4c8558fd))
+
+### [0.6.2](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.1...v0.6.2) (2021-06-29)
+
+
+### Bug Fixes
+
+* **native_comp:** patch Emacs.pdmp for customized native-lisp paths ([23b8236](https://github.com/jimeh/build-emacs-for-macos/commit/23b8236e0a66fb09810e8422bedf02f7192a53e4))
+
 ### [0.6.1](https://github.com/jimeh/build-emacs-for-macos/compare/v0.6.0...v0.6.1) (2021-06-28)
 
 

build-emacs-for-macos

@@ -11,6 +11,7 @@ require 'net/http'
 require 'optparse'
 require 'pathname'
 require 'time'
+require 'tmpdir'
 require 'uri'
 require 'yaml'
 
@@ -117,9 +118,10 @@ class Build
   def load_plan(filename)
     plan = YAML.safe_load(File.read(filename), [:Time])
 
+    @ref = plan.dig('source', 'ref')
     @meta = {
       sha: plan.dig('source', 'commit', 'sha'),
-      ref: plan.dig('source', 'ref'),
+      ref: @ref,
       date: plan.dig('source', 'commit', 'date')
     }
 
@@ -411,20 +413,17 @@ class Build
     contents_dir = File.join(app, 'Contents')
 
     FileUtils.cd(contents_dir) do
-      # Skip creation of symlinks if *.eln files are located under
-      # Resources/native-lisp. Emacs is capable of finding lisp sources and
-      # *.eln cache files without symlinks.
-      return if Dir['Resources/native-lisp/**/*.eln'].any?
-
-      info 'Creating symlinks within Emacs.app needed for native-comp'
-
-      FileUtils.ln_s('Resources/lisp', 'lisp') unless File.exist?('lisp')
-
       source = Dir['MacOS/libexec/emacs/**/eln-cache',
                    'MacOS/lib/emacs/**/native-lisp'].first
 
-      if source.nil?
-        err 'Failed to find native-lisp cache directory for symlink creation.'
+      # Skip creation of symlinks if *.eln files are not located in a location
+      # known to be used by builds which need symlinks and other tweaks.
+      return if source.nil?
+
+      info 'Creating symlinks within Emacs.app needed for native-comp'
+
+      if !File.exist?('lisp') && File.exist?('Resources/lisp')
+        FileUtils.ln_s('Resources/lisp', 'lisp')
       end
 
       # Check for folder name containing two dots (.), as this causes Apple's
@@ -434,10 +433,9 @@ class Build
       # The workaround for now is to rename the folder replacing the dots with
       # hyphens (-), and create the native-lisp symlink pointing to the new
       # location.
-      if source.match(%r{/.+\..+\..+/})
-        # Dig deeper into native-lisp directory
-        eln_dir = File.dirname(Dir[File.join(source, '**', '*.eln')].first)
+      eln_dir = File.dirname(Dir[File.join(source, '**', '*.eln')].first)
 
+      if eln_dir.match(%r{/.+\..+\..+/})
         base = File.basename(eln_dir)
         parent = File.dirname(eln_dir)
 
@@ -454,6 +452,13 @@ class Build
           parent = File.dirname(parent)
         end
 
+        eln_parts = eln_dir.match(
+          %r{/(\d+\.\d+\.\d+)/native-lisp/(\d+\.\d+\.\d+-\w+)(?:/.+)?$}i
+        )
+        if eln_parts
+          patch_dump_native_lisp_paths(app, eln_parts[1], eln_parts[2])
+        end
+
         # Find native-lisp directory again after it has been renamed.
         source = Dir['MacOS/libexec/emacs/**/eln-cache',
                      'MacOS/lib/emacs/**/native-lisp'].first
@@ -468,6 +473,29 @@ class Build
     end
   end
 
+  def patch_dump_native_lisp_paths(app, emacs_version, eln_version)
+    sanitized_emacs_version = emacs_version.gsub('.', '-')
+    sanitized_eln_version = eln_version.gsub('.', '-')
+
+    contents_dir = File.join(app, 'Contents')
+    FileUtils.cd(contents_dir) do
+      filename = Dir['MacOS/Emacs.pdmp', 'MacOS/libexec/Emacs.pdmp'].first
+      err "no Emacs.pdmp file found in #{app}" unless filename
+      info 'patching Emacs.pdmp to point at new native-lisp paths'
+
+      content = File.read(filename, mode: 'rb').gsub(
+        "lib/emacs/#{emacs_version}/native-lisp/#{eln_version}/",
+        "lib/emacs/#{sanitized_emacs_version}/" \
+        "native-lisp/#{sanitized_eln_version}/"
+      ).gsub(
+        "../native-lisp/#{eln_version}/",
+        "../native-lisp/#{sanitized_eln_version}/"
+      )
+
+      File.open(filename, 'w') { |f| f.write(content) }
+    end
+  end
+
   def add_cli_helper(app)
     source = File.join(__dir__, 'helper', 'emacs-cli.bash')
     target = File.join(app, 'Contents', 'MacOS', 'bin', 'emacs')
@@ -708,8 +736,6 @@ class AbstractEmbedder
     @app = app
   end
 
-  private
-
   def invocation_dir
     File.join(app, 'Contents', 'MacOS')
   end
@@ -719,7 +745,7 @@ class AbstractEmbedder
   end
 
   def lib_dir
-    File.join(invocation_dir, 'lib')
+    File.join(app, 'Contents', 'Frameworks')
   end
 end
 
@@ -875,15 +901,15 @@ class GccLibEmbedder < AbstractEmbedder
   end
 
   def target_dir
-    File.join(invocation_dir, gcc_info.relative_lib_dir)
+    File.join(lib_dir, gcc_info.relative_lib_dir)
   end
 
   def source_darwin_dir
-    File.join(invocation_dir, gcc_info.relative_darwin_lib_dir)
+    File.join(lib_dir, gcc_info.relative_darwin_lib_dir)
   end
 
   def target_darwin_dir
-    File.join(invocation_dir, gcc_info.sanitized_relative_darwin_lib_dir)
+    File.join(lib_dir, gcc_info.sanitized_relative_darwin_lib_dir)
   end
 
   def source_dir
@@ -939,7 +965,21 @@ class GccInfo
   def sanitized_relative_darwin_lib_dir
     @sanitized_relative_darwin_lib_dir ||= File.join(
       File.dirname(relative_darwin_lib_dir),
-      File.basename(relative_darwin_lib_dir).split('.').first
+      File.basename(relative_darwin_lib_dir).gsub('.', '_')
+    )
+  end
+
+  def app_bundle_relative_lib_dir
+    @app_bundle_relative_lib_dir ||= relative_dir(
+      File.join(embedder.lib_dir, relative_lib_dir),
+      embedder.invocation_dir
+    )
+  end
+
+  def app_bundle_relative_darwin_lib_dir
+    @app_bundle_relative_darwin_lib_dir ||= relative_dir(
+      File.join(embedder.lib_dir, sanitized_relative_darwin_lib_dir),
+      embedder.invocation_dir
     )
   end
 
@@ -986,6 +1026,10 @@ class GccInfo
 
   private
 
+  def embedder
+    @embedder ||= AbstractEmbedder.new(Dir.mktmpdir(['Emacs', '.app']))
+  end
+
   def relative_dir(path, root)
     Pathname.new(path).relative_path_from(Pathname.new(root)).to_s
   end

patches/native-comp-env-setup.diff.erb

@@ -1,8 +1,8 @@
 diff --git a/lisp/emacs-lisp/comp.el b/lisp/emacs-lisp/comp.el
-index 8c638312b0..87af889ef4 100644
+index 638d4b274c..2599211936 100644
 --- a/lisp/emacs-lisp/comp.el
 +++ b/lisp/emacs-lisp/comp.el
-@@ -4215,6 +4215,52 @@ native-compile-async
+@@ -4224,6 +4224,52 @@ native-compile-async
    (let ((load (not (not load))))
      (native--compile-async files recursively load selector)))
  
@@ -16,10 +16,10 @@ index 8c638312b0..87af889ef4 100644
 +           (devtools-dir
 +            "/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib")
 +           (gcc-dir (expand-file-name
-+                     "<%= relative_lib_dir %>"
++                     "<%= app_bundle_relative_lib_dir %>"
 +                     invocation-directory))
 +           (darwin-dir (expand-file-name
-+                        "<%= sanitized_relative_darwin_lib_dir %>"
++                        "<%= app_bundle_relative_darwin_lib_dir %>"
 +                        invocation-directory))
 +           (lib-paths (list)))
 +

pkg/cask/update.go

@@ -42,11 +42,11 @@ type UpdateOptions struct {
 	// BuildsRepo is the GitHub repository containing binary releases.
 	BuildsRepo *repository.Repository
 
-	// TapRepo is the GitHub repository to update the cask formula in.
+	// TapRepo is the GitHub repository to update the casks in.
 	TapRepo *repository.Repository
 
-	// Ref is the git ref to apply cask formula updates on top of. Default
-	// branch will be used if empty.
+	// Ref is the git ref to apply cask updates on top of. Default branch will
+	// be used if empty.
 	Ref string
 
 	// OutputDir specifies a directory to write cask files to. When set, tap
@@ -56,10 +56,10 @@ type UpdateOptions struct {
 
 	// Force update will ignore the outdated live check flag, and process all
 	// casks regardless. But it will only update the cask in question if the
-	// resulting output cask formula is different.
+	// resulting output cask is different.
 	Force bool
 
-	// TemplatesDir is the directory where cask formula templates are located.
+	// TemplatesDir is the directory where cask templates are located.
 	TemplatesDir string
 
 	LiveChecks []*LiveCheck
@@ -150,7 +150,7 @@ func (s *Updater) putFile(
 	content []byte,
 ) (bool, error) {
 	parent := filepath.Dir(filename)
-	s.logger.Info("processing formula update",
+	s.logger.Info("processing cask update",
 		"output-directory", parent, "cask", chk.Cask, "file", filename,
 	)
 
@@ -164,18 +164,18 @@ func (s *Updater) putFile(
 		return false, err
 	}
 
-	infoMsg := "creating formula"
+	infoMsg := "creating cask"
 
 	if !os.IsNotExist(err) {
-		infoMsg = "updating formula"
+		infoMsg = "updating cask"
 		if bytes.Equal(existingContent, content) {
 			s.logger.Info(
-				"skip update: no change to cask formula content",
+				"skip update: no change to cask content",
 				"cask", chk.Cask, "file", filename,
 			)
 
 			s.logger.Debug(
-				"formula content",
+				"cask content",
 				"file", filename, "content", string(content),
 			)
 
@@ -198,7 +198,7 @@ func (s *Updater) putFile(
 	)
 
 	s.logger.Debug(
-		"formula content",
+		"cask content",
 		"file", filename, "content", string(content),
 	)
 
@@ -218,7 +218,7 @@ func (s *Updater) putRepoFile(
 	filename string,
 	content []byte,
 ) (bool, error) {
-	s.logger.Info("processing formula update",
+	s.logger.Info("processing cask update",
 		"tap-repo", repo.Source, "cask", chk.Cask, "file", filename,
 	)
 	repoContent, _, resp, err := s.gh.Repositories.GetContents(
@@ -264,12 +264,12 @@ func (s *Updater) createRepoFile(
 	diff := fmt.Sprint(gotextdiff.ToUnified(filename, filename, "", edits))
 
 	s.logger.Info(
-		"creating formula",
+		"creating cask",
 		"cask", chk.Cask, "version", chk.Version.Latest, "file", filename,
 		"diff", diff,
 	)
 	s.logger.Debug(
-		"formula content",
+		"cask content",
 		"file", filename, "content", string(content),
 	)
 	contResp, _, err := s.gh.Repositories.CreateFile(
@@ -307,7 +307,7 @@ func (s *Updater) updateRepoFile(
 
 	if existingContent == string(content) {
 		s.logger.Info(
-			"skip update: no change to formula content",
+			"skip update: no change to cask content",
 			"cask", chk.Cask, "file", filename,
 		)
 
@@ -329,12 +329,12 @@ func (s *Updater) updateRepoFile(
 	))
 
 	s.logger.Info(
-		"updating formula",
+		"updating cask",
 		"cask", chk.Cask, "version", chk.Version.Latest, "file", filename,
 		"diff", diff,
 	)
 	s.logger.Debug(
-		"formula content",
+		"cask content",
 		"file", filename, "content", string(content),
 	)
 

pkg/cli/cask.go

@@ -23,7 +23,7 @@ func caskCmd() *cli2.Command {
 
 	return &cli2.Command{
 		Name:  "cask",
-		Usage: "manage Homebrew Cask formula",
+		Usage: "manage Homebrew Casks",
 		Flags: []cli2.Flag{
 			&cli2.StringFlag{
 				Name:    "builds-repository",
@@ -101,7 +101,7 @@ func caskUpdateCmd() *cli2.Command {
 				Name:    "force",
 				Aliases: []string{"f"},
 				Usage: "force update file even if livecheck has it marked " +
-					"as not outdated (does not force update if formula " +
+					"as not outdated (does not force update if cask " +
 					"content is unchanged)",
 				Value: false,
 			},

pkg/sign/emacs.go

@@ -117,42 +117,24 @@ func signCLIHelper(ctx context.Context, appBundle string, opts *Options) error {
 }
 
 // elnFiles finds all native-compilation *.eln files within a Emacs.app bundle,
-// based on expected paths they might be stored in.
+// excluding any *.eln which should be automatically located by codesign when
+// signing the Emacs.app bundle itself with the --deep flag. Essentially this
+// only returns *.eln files which must be individually signed before signing the
+// app bundle itself.
 func elnFiles(emacsApp string) ([]string, error) {
-	dirs := []string{
-		// Current *.eln location.
-		filepath.Join(emacsApp, "Contents", "Resources", "native-lisp"),
-		// Legacy *.eln location.
-		filepath.Join(emacsApp, "Contents", "MacOS", "lib", "emacs"),
-	}
-
 	var files []string
-	walkDirFunc := func(path string, _d fs.DirEntry, _err error) error {
-		if strings.HasSuffix(path, ".eln") {
+	walkDirFunc := func(path string, d fs.DirEntry, _err error) error {
+		if d.Type().IsRegular() && strings.HasSuffix(path, ".eln") &&
+			!strings.Contains(path, ".app/Contents/Frameworks/") {
 			files = append(files, path)
 		}
 
 		return nil
 	}
 
-	for _, dir := range dirs {
-		fi, err := os.Stat(dir)
-		if err != nil {
-			if os.IsNotExist(err) {
-				continue
-			}
-
-			return nil, err
-		}
-
-		if !fi.IsDir() {
-			continue
-		}
-
-		err = filepath.WalkDir(dir, walkDirFunc)
-		if err != nil {
-			return nil, err
-		}
+	err := filepath.WalkDir(filepath.Join(emacsApp, "Contents"), walkDirFunc)
+	if err != nil {
+		return nil, err
 	}
 
 	return files, nil