xccache 0.0.1a2 → 0.0.1a3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8478aeb0498b7eaa2e6c231f65cf65421d247958a30b2cfca0750e0d8b0603e9
-  data.tar.gz: 4f5266ef2925ce5ca1b06596da4b6aa879c53926eaf2a460638b912187f9316b
+  metadata.gz: 2f65f29ba5115620a4f02708c9bffea0dc76d03665970232a580c22f6659df51
+  data.tar.gz: 7e98a3268e17d0198762c31d631b6e27516e3d4e2e851c5aeeaf33de28e2b5fa
 SHA512:
-  metadata.gz: 78daeec82245936d646cfe0f8f5d8ea1e82d2d851333aa8523a010e8a78c257d7fadbbb3fed8a1a88bdd59a57070843c87330ad79e5bab5f3dc6e9774623b420
-  data.tar.gz: d9f4e5ba9057726fd4a6679ba7014b8c444cd195c7481f36c2f66f59bedefd5d409d473420016869bf327951b4ccfc3e42799bfc8a4709b5244476d10ef306ba
+  metadata.gz: 80d8a6b25273bcbb2ebbb6a7985d1a092caae35beaa60ba49b1b8e6a3c626196dd9c9d5397dde9391d228c8e5e9fa26e13bf5135542425efa18ffafb8cbc7746
+  data.tar.gz: 821e59573bf41ca862db69118e60d5f9a16a4d338a900760063fd97e885fdf4bf88ae3d7792db11c10ac3a38d7546929c6117527ee4f6d72c70cfde506452d6c

data/lib/xccache/assets/templates/cachemap.html.template

@@ -39,6 +39,7 @@
             <div class="info">Target: <span class="value target">TBU</span></div>
             <div class="info">Checksum: <span class="value checksum">TBU</span></div>
             <div class="info">Binary: <a class="value binary" href="">TBU</a></div>
+            <div class="info"><p class="others">TBU</p></div>
           </div>
         </section>
       </div>

data/lib/xccache/assets/templates/cachemap.js.template

@@ -1,10 +1,15 @@
-// MARK: GENERATED
-// ------------------------------------------------
-graph = JSON.parse(`
+const graph = JSON.parse(`
 <%= json %>
 `);
+
 // ------------------------------------------------
 
+const COLORS = {
+  'hit': '#339966',
+  'missed': '#ff6f00',
+  'ignored': '#888',
+  'NA': '#888',
+}
 const cy = cytoscape({
   container: $('#cy'),
   elements: ([...graph.nodes, ...graph.edges]).map(x => ({data: x})),
@@ -18,7 +23,8 @@ const cy = cytoscape({
         'text-halign': 'center',
         'font-size': '14px',
         'shape': 'roundrectangle',
-        'width': (e) => Math.max(50, e.id().split("/")[1].length * 8),
+        'width': (e) => Math.max(50, e.id().split('/')[1].length * 8),
+        'background-color': (e) => COLORS[e.data('cache') || 'NA'],
       }
     },
     {
@@ -29,26 +35,12 @@ const cy = cytoscape({
         'border-color': '#333',
       }
     },
-    {
-      selector: 'node[cache="hit"]',
-      style: {'background-color': '#339966'}
-    },
-    {
-      selector: 'node[cache="missed"]',
-      style: {'background-color': '#ff6f00'}
-    },
     {
       selector: 'node[type="agg"]',
       style: {
         'background-color': '#333',
       }
     },
-    {
-      selector: 'node[cache="ignored"]',
-      style: {
-        'background-color': '#888',
-      }
-    },
     {
       selector: 'edge',
       style: {
@@ -56,14 +48,13 @@ const cy = cytoscape({
         'target-arrow-shape': 'triangle',
         'curve-style': 'bezier',
         'line-color': '#ccc',
-        // 'line-color': e => e.target().style('background-color') || '#999',
-        'target-arrow-color': e => e.style('line-color'),
+        'target-arrow-color': '#ccc',
       }
     },
   ],
   layout: {
     name: 'fcose',
-    animationDuration: 300,
+    animationDuration: 200,
     nodeRepulsion: 10000,
     idealEdgeLength: 120,
     gravity: 0.25,
@@ -71,24 +62,34 @@ const cy = cytoscape({
 });
 
 cy.on('select', 'node', function(event) {
-  $('.node-info').css('display', 'block');
   const node = event.target;
-  const info = $('.node-info .info');
-  info.find('.target').html(node.id());
-  info.find('.checksum').html(node.data('checksum') || 'NA');
-  info.find('.binary')
-    .html((node.data('binary') || 'NA').split('/').slice(-1))
-    .attr({'href': node.data('binary') || ''});
-
-  // Mark neighbor as focused, dim others
-  const focused = node.neighborhood().add(node);
-  focused.animate({style: {'opacity': 1}, duration: 200});
-  cy.elements().not(focused).animate({style: {'opacity': 0.15}, duration: 200});
+  node.displayDetails();
+  node.neighborhood().add(node).focus();
 });
 
 cy.on('tap', function(event) {
   if (event.target == cy) {
     $('.node-info').css('display', 'none');
-    cy.elements().animate({style: {'opacity': 1}});
+    cy.elements().animateStyle({'opacity': 1, 'line-color': '#ccc', 'target-arrow-color': '#ccc'});
   }
 });
+
+// -----------------------------------------------------------------
+
+cytoscape('collection', 'animateStyle', function(style) {
+  this.animate({style: style, duration: 200, easing: 'ease-out'})
+});
+cytoscape('collection', 'focus', function() {
+  this.animateStyle({'opacity': 1, 'line-color': '#666', 'target-arrow-color': '#666'});
+  cy.elements().not(this).animateStyle({'opacity': 0.15, 'line-color': '#ccc', 'target-arrow-color': '#ccc'});
+});
+cytoscape('collection', 'displayDetails', function() {
+  $('.node-info').css('display', 'block');
+  const info = $('.node-info .info');
+  info.find('.target').html(this.id());
+  info.find('.checksum').html(this.data('checksum') || 'NA');
+  info.find('.binary')
+    .html((this.data('binary') || 'NA').split('/').slice(-1))
+    .attr({'href': this.data('binary') || ''});
+  info.find('.others').html(`Node degree: ${this.degree()} (${this.indegree()} in, ${this.outdegree()} out)`);
+});

data/lib/xccache/assets/templates/cachemap.style.css.template

@@ -67,9 +67,11 @@ a:hover { color: #339966; }
 .node-info {
   display: none;
 }
+.metadata .info {
+  font-size: 10px;
+}
 .info {
   color: #888;
-  font-size: 10px;
 }
 .info .value {
   color: #666;

data/lib/xccache/assets/templates/framework.modulemap.template

@@ -1,5 +1,5 @@
 framework module <%= module_name %> {
-  umbrella header "<%= module_name %>-umbrella.h"
+  umbrella header "<%= target %>-umbrella.h"
 
   export *
   module * { export * }

data/lib/xccache/assets/templates/resource_bundle_accessor.m.template

@@ -1,16 +1,16 @@
 #import <Foundation/Foundation.h>
 
-@interface BundleFinder : NSObject
+@interface BundleFinder_<%= module_name %> : NSObject
 @end
 
-@implementation BundleFinder
+@implementation BundleFinder_<%= module_name %>
 @end
 
 NSBundle* <%= module_name %>_SWIFTPM_MODULE_BUNDLE() {
   NSString *bundleName = @"<%= pkg %>_<%= target %>";
   NSArray<NSURL *> *candidates = @[
     NSBundle.mainBundle.resourceURL,
-    [NSBundle bundleForClass:[BundleFinder class]].resourceURL,
+    [NSBundle bundleForClass:[BundleFinder_<%= module_name %> class]].resourceURL,
     NSBundle.mainBundle.bundleURL,
     [NSBundle.mainBundle.bundleURL URLByAppendingPathComponent:@"Frameworks/<%= target %>.framework"]
   ];

data/lib/xccache/assets/templates/umbrella.Package.swift.template

@@ -40,6 +40,7 @@ enum XCCache {
   @MainActor
   struct Config {
     static let pkgDir = URL(filePath: #filePath).deletingLastPathComponent()
+    static let repoDir = URL.homeDirectory.appending(path: ".xccache/default")
     // NOTE: Do NOT change `binariesDir` to `static let`
     // Somehow, incremental resolution doesnt work causing the `binaryExist` wrongly cached
     static var binariesDir: URL { pkgDir.appending(path: "binaries") }
@@ -55,7 +56,7 @@ enum XCCache {
 
     var spm: PackageDescription.Package {
       let regularTargets = targets.map(\.spm)
-      let binaryTargets = targets.flatMap(\.flattenDeps).unique(by: \.name).compactMap(\.spmBinaryTarget)
+      let binaryTargets = targets.flatMap(\.flattenRegularDeps).unique(by: \.name).compactMap(\.spmBinaryTarget)
       return .init(
         name: "xccache",
         platforms: PLATFORMS,
@@ -80,29 +81,54 @@ enum XCCache {
       .library(name: name, targets: [name])
     }
     var spm: PackageDescription.Target {
-      .target(name: name, dependencies: flattenDeps.map(\.spm), path: ".Sources/\(name)")
+      .target(
+        name: name,
+        dependencies: flattenRegularDeps.map(\.spm),
+        path: ".Sources/\(name)",
+        swiftSettings: [
+          .unsafeFlags(macroFlags),
+        ]
+      )
     }
     var flattenDeps: [Dependency] { deps.flatMap(\.toBinariesIfOk).unique(by: \.name) }
+    var flattenRegularDeps: [Dependency] { flattenDeps.filter(\.regular) }
+    var macroFlags: [String] { flattenDeps.filter(\.macroBinary).flatMap(\.macroFlags) }
   }
 
   // MARK: Dependency
   @MainActor
   class Dependency {
     let name: String
+    let bareName: String
+    let binaryURL: URL
     let binary: Bool
-    private let bareName: String
+    let macro: Bool
+    var regular: Bool { !macro }
+    var regularBinary: Bool { binary && regular }
+    var macroBinary: Bool { binary && macro }
 
     init(_ name: String) {
       self.name = name
-      self.bareName = name.basename.withoutExtenstion
-      self.binary = name.hasSuffix(".binary") && Config.binariesDir.appending(path: "\(bareName)/\(bareName).xcframework").exist
+      self.bareName = String(name.basename.split(separator: ".")[0])
+      self.macro = name.contains(".macro")
+      self.binaryURL = if macro {
+        Config.binariesDir.appending(path: "\(bareName)/\(bareName).macro").readlink()
+      } else {
+        Config.binariesDir.appending(path: "\(bareName)/\(bareName).xcframework").readlink()
+      }
+      self.binary = name.hasSuffix(".binary") && binaryURL.exist
+    }
+
+    var macroFlags: [String] {
+      ["-load-plugin-executable", "\(binaryURL.path())#\(bareName)"]
     }
+
     var spm: PackageDescription.Target.Dependency {
       if binary { return .byName(name: name) }
       return .product(name: bareName, package: name.slug)
     }
     var spmBinaryTarget: PackageDescription.Target? {
-      binary ? .binaryTarget(name: name, path: "binaries/\(bareName)/\(bareName).xcframework") : nil
+      regularBinary ? .binaryTarget(name: name, path: "binaries/\(bareName)/\(bareName).xcframework") : nil
     }
   }
 
@@ -129,7 +155,17 @@ func parseJSON<T>(_ content: String) throws -> T {
 }
 
 extension URL {
-  var exist: Bool { FileManager.default.fileExists(atPath: path()) }
+  var basename: String { lastPathComponent }
+  var exist: Bool { FileManager.default.fileExists(atPath: readlink().path()) }
+  /// Resolve symlinks recursively, equivalent to `readlink -f` in bash
+  func readlink() -> URL {
+    var prev = self, cur = resolvingSymlinksInPath()
+    while prev != cur {
+      prev = cur
+      cur = cur.resolvingSymlinksInPath()
+    }
+    return cur
+  }
 }
 
 extension String {

data/lib/xccache/cache/cachemap.rb

@@ -12,7 +12,11 @@ module XCCache
       end
 
       def manifest_data
-        raw["manifest"] ||= { "targets" => {}, "deps" => {} }
+        raw["manifest"] ||= {
+          "targets" => {},
+          "deps" => {},
+          "macros" => {},
+        }
       end
 
       def missed?(name)
@@ -24,23 +28,15 @@ module XCCache
       end
 
       def stats
-        describe = proc do |type|
-          count = get_cache_data(type).count
-          total_count = [cache_data.count, 1].max
-          percent = (count * 100 / total_count).to_i
-          "#{percent}% (#{count}/#{total_count})"
+        %i[hit missed ignored].to_h do |type|
+          count, total_count = get_cache_data(type).count, cache_data.count
+          percent = total_count.positive? ? (count.to_f * 100 / total_count).round : 0
+          [type, "#{percent}% (#{count}/#{total_count})"]
         end
-        {
-          :hit => describe.call(:hit),
-          :missed => describe.call(:missed),
-          :ignored => describe.call(:ignored),
-        }
       end
 
       def print_stats
-        hit = get_cache_data(:hit)
-        missed = get_cache_data(:missed)
-        ignored = get_cache_data(:ignored)
+        hit, missed, ignored = %i[hit missed ignore].map { |type| get_cache_data(type) }
         total_count = cache_data.count
         UI.message <<~DESC
           -------------------------------------------------------------------
@@ -53,7 +49,7 @@ module XCCache
       end
 
       def get_cache_data(type)
-        cache_data.select { |k, v| !k.end_with?(".xccache") && v == type }.keys
+        cache_data.select { |_, v| v == type }.keys
       end
     end
   end

data/lib/xccache/command/base.rb

@@ -0,0 +1,29 @@
+require "xccache/installer"
+
+module XCCache
+  class Command
+    class Options
+      SDK = ["--sdk=foo,bar", "SDKs (iphonesimulator, iphoneos, etc.)"].freeze
+      CONFIG = ["--config=foo", "Configuration (debug, release)"].freeze
+      SKIP_RESOLVING_DEPENDENCIES = [
+        "--skip-resolving-dependencies", "Skip resolving package dependencies",
+      ].freeze
+      MERGE_SLICES = [
+        "--merge-slices/--no-merge-slices",
+        "Whether to merge with existing slices/sdks in the xcframework (default: true)",
+      ].freeze
+      LIBRARY_EVOLUTION = [
+        "--library-evolution/--no-library-evolution",
+        "Whether to enable library evolution (build for distribution) (default: false)",
+      ].freeze
+
+      def self.install_options
+        [SDK, SKIP_RESOLVING_DEPENDENCIES]
+      end
+
+      def self.build_options
+        install_options + [CONFIG, MERGE_SLICES, LIBRARY_EVOLUTION]
+      end
+    end
+  end
+end

data/lib/xccache/command/build.rb

@@ -1,4 +1,5 @@
 require "xccache/installer"
+require_relative "base"
 
 module XCCache
   class Command
@@ -6,10 +7,9 @@ module XCCache
       self.summary = "Build packages to xcframeworks"
       def self.options
         [
-          ["--sdk=iphonesimulator", "SDKs to build (comma separated)"],
+          *Options.build_options,
           ["--integrate/no-integrate", "Whether to integrate after building target (default: true)"],
           ["--recursive", "Whether to build their recursive targets if cache-missed (default: false)"],
-          ["--skip-resolving-dependencies", "Skip resolving package dependencies"],
         ].concat(super)
       end
       self.arguments = [
@@ -19,16 +19,22 @@ module XCCache
       def initialize(argv)
         super
         @targets = argv.arguments!
-        @sdk = argv.option("sdk")
         @should_integrate = argv.flag?("integrate", true)
-        @recursive = argv.flag?("recursive", false)
       end
 
       def run
-        installer = Installer::Build.new(targets: @targets, sdk: @sdk, recursive: @recursive, **@install_options)
+        installer = Installer::Build.new(
+          ctx: self,
+          targets: @targets,
+        )
         installer.install!
+
         # Reuse umbrella_pkg from previous installers
-        Installer::Use.new(umbrella_pkg: installer.umbrella_pkg, **@install_options).install! if @should_integrate
+        return unless @should_integrate
+        Installer::Use.new(
+          ctx: self,
+          umbrella_pkg: installer.umbrella_pkg,
+        ).install!
       end
     end
   end

data/lib/xccache/command/pkg/build.rb

@@ -7,8 +7,7 @@ module XCCache
         self.summary = "Build a Swift package into an xcframework"
         def self.options
           [
-            ["--sdk=foo,bar", "Sdk (iphonesimulator, iphoneos, etc.)"],
-            ["--config=foo", "Configuration (debug, release)"],
+            *Options.build_options,
             ["--out=foo", "Output directory for the xcframework"],
             ["--checksum/no-checksum", "Whether to include checksum to the binary name"],
           ].concat(super)
@@ -20,8 +19,6 @@ module XCCache
         def initialize(argv)
           super
           @targets = argv.arguments!
-          @sdk = argv.option("sdk")
-          @config = argv.option("config")
           @out_dir = argv.option("out")
           @include_checksum = argv.flag?("checksum")
         end
@@ -30,11 +27,10 @@ module XCCache
           pkg = SPM::Package.new
           pkg.build(
             targets: @targets,
-            sdk: @sdk,
             config: @config,
             out_dir: @out_dir,
             checksum: @include_checksum,
-            skip_resolve: @skip_resolving_dependencies,
+            **@build_options,
           )
         end
       end

data/lib/xccache/command/pkg.rb

@@ -1,3 +1,4 @@
+require_relative "base"
 require "xccache/command/pkg/build"
 
 module XCCache

data/lib/xccache/command/remote/pull.rb

@@ -0,0 +1,15 @@
+require "xccache/spm"
+
+module XCCache
+  class Command
+    class Remote < Command
+      class Pull < Remote
+        self.summary = "Pulling cache to local"
+
+        def run
+          storage.pull
+        end
+      end
+    end
+  end
+end

data/lib/xccache/command/remote/push.rb

@@ -0,0 +1,15 @@
+require "xccache/spm"
+
+module XCCache
+  class Command
+    class Remote < Command
+      class Push < Remote
+        self.summary = "Pushing cache to remote"
+
+        def run
+          storage.push
+        end
+      end
+    end
+  end
+end

data/lib/xccache/command/remote.rb

@@ -0,0 +1,39 @@
+require_relative "base"
+require "xccache/storage"
+require "xccache/command/remote/pull"
+require "xccache/command/remote/push"
+
+module XCCache
+  class Command
+    class Remote < Command
+      self.abstract_command = true
+      self.summary = "Working with remote cache"
+      def self.options
+        [
+          ["--branch=foo", "Cache branch (if using git) (default: main)"],
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        super
+        @branch = argv.option("branch", "main")
+      end
+
+      def storage
+        @storage ||= create_storage
+      end
+
+      private
+
+      def create_storage
+        remote_config = config.remote_config
+        if (remote = remote_config["git"])
+          return GitStorage.new(branch: @branch, remote: remote)
+        elsif (s3_config = remote_config["s3"])
+          return S3Storage.new(uri: s3_config["uri"], creds_path: s3_config["creds"])
+        end
+        Storage.new
+      end
+    end
+  end
+end

data/lib/xccache/command/rollback.rb

@@ -1,4 +1,5 @@
 require "xccache/installer"
+require_relative "base"
 
 module XCCache
   class Command
@@ -6,7 +7,7 @@ module XCCache
       self.summary = "Roll back prebuilt cache for packages"
 
       def run
-        Installer::Rollback.new.install!
+        Installer::Rollback.new(ctx: self).install!
       end
     end
   end

data/lib/xccache/command/use.rb

@@ -1,4 +1,5 @@
 require "xccache/installer"
+require_relative "base"
 
 module XCCache
   class Command
@@ -6,12 +7,12 @@ module XCCache
       self.summary = "Use prebuilt cache for packages"
       def self.options
         [
-          ["--skip-resolving-dependencies", "Skip resolving package dependencies"],
+          *Options.install_options,
         ].concat(super)
       end
 
       def run
-        Installer::Use.new(**@install_options).install!
+        Installer::Use.new(ctx: self).install!
       end
     end
   end

data/lib/xccache/command.rb

@@ -1,5 +1,6 @@
 require "claide"
 require "xccache/core/config"
+require "xccache/swift/sdk"
 
 module XCCache
   class Command < CLAide::Command
@@ -10,11 +11,26 @@ module XCCache
     self.default_subcommand = "use"
     self.summary = "xccache - a build caching tool"
 
+    attr_reader :install_options, :build_options
+
     def initialize(argv)
       super
       config.verbose = verbose unless verbose.nil?
-      @skip_resolving_dependencies = argv.flag?("skip-resolving-dependencies")
-      @install_options = { :skip_resolving_dependencies => @skip_resolving_dependencies }
+      @install_options = {
+        :sdks => str_to_sdks(argv.option("sdk")),
+        :skip_resolving_dependencies => argv.flag?("skip-resolving-dependencies"),
+      }
+      @build_options = {
+        **@install_options,
+        :config => argv.option("config"),
+        :recursive => argv.flag?("recursive"),
+        :merge_slices => argv.flag?("merge-slices", true),
+        :library_evolution => argv.flag?("library-evolution"),
+      }
+    end
+
+    def str_to_sdks(str)
+      (str || config.default_sdk).split(",").map { |s| Swift::Sdk.new(s) }
     end
   end
 end

data/lib/xccache/core/config.rb

@@ -16,6 +16,10 @@ module XCCache
     attr_accessor :verbose
     alias verbose? verbose
 
+    # To distinguish if it's within an installation, or standalone like `xccache pkg build`
+    attr_accessor :in_installation
+    alias in_installation? in_installation
+
     def sandbox
       @sandbox = Dir.prepare("xccache").expand_path
     end
@@ -24,8 +28,20 @@ module XCCache
       @spm_sandbox ||= Dir.prepare(sandbox / "packages").expand_path
     end
 
-    def spm_binaries_frameworks_dir
-      @spm_binaries_frameworks_dir ||= Dir.prepare(spm_umbrella_sandbox / "binaries")
+    def spm_local_pkgs_dir
+      @spm_local_pkgs_dir ||= Dir.prepare(spm_sandbox / "local")
+    end
+
+    def spm_xcconfig_dir
+      @spm_xcconfig_dir ||= Dir.prepare(spm_sandbox / "xcconfigs")
+    end
+
+    def spm_repo_dir
+      @spm_repo_dir ||= Dir.prepare(Pathname("~/.xccache/default").expand_path)
+    end
+
+    def spm_binaries_dir
+      @spm_binaries_dir ||= Dir.prepare(spm_umbrella_sandbox / "binaries")
     end
 
     def spm_build_dir
@@ -62,6 +78,10 @@ module XCCache
       projects.flat_map(&:targets)
     end
 
+    def remote_config
+      raw["remote"] || {}
+    end
+
     def ignore_list
       raw["ignore"] || []
     end
@@ -78,5 +98,13 @@ module XCCache
     def ignore_build_errors?
       raw["ignore_build_errors"]
     end
+
+    def keep_pkgs_in_project?
+      raw["keep_pkgs_in_project"]
+    end
+
+    def default_sdk
+      raw["default_sdk"] || "iphonesimulator"
+    end
   end
 end

data/lib/xccache/core/git.rb

@@ -6,14 +6,22 @@ module XCCache
       @root = Pathname(root)
     end
 
+    def run(*args, **kwargs)
+      Sh.run("git -C #{root}", *args, **kwargs)
+    end
+
     def sha
       run("rev-parse --short HEAD", capture: true, log_cmd: false)[0].strip
     end
 
-    private
+    def clean?
+      status("--porcelain", capture: true, log_cmd: false)[0].empty?
+    end
 
-    def run(cmd, options = {})
-      Sh.run("git -C #{root} #{cmd}", options)
+    %i[checkout fetch pull push clean add commit branch remote switch status].each do |name|
+      define_method(name) do |*args, **kwargs|
+        run(name, *args, **kwargs)
+      end
     end
   end
 end