apple_frameworks 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a784f4579a6fe0d1c01d20cee23743ff51987026fe70102a34f3b2a568e6ff
-  data.tar.gz: b98904da83eb50018c769c6443d7149da20ac759d551ab6f83b4c8259742e53d
+  metadata.gz: 2458b11ac8aa7472cacff84481f16d4b7ea95f6231353de7ae3faa0b33bc9a38
+  data.tar.gz: c77c610834c38fd433b16e89083e589d13fb44c92ac1adf9d710c0b9077ddd39
 SHA512:
-  metadata.gz: 60ddf21feb22a51447f0f22c11b820783424716037047737c13f400f6fc096ac2a15a6dafb69f2acceb10bba7957b828420c45adb40613c634996c7706d6ad1e
-  data.tar.gz: aeebac5804a5d7d08df84018c1fb1073cdf9ce226e76d87a3cb80a43137e8578613eecef1f119e0929ae44cac923490878e9bb5cde36d451023094b88264c4cd
+  metadata.gz: c23401f609cd5e7395eefdb38a132c21103adef7e603638028874a8e965628ecdb8fd5a45c364f20d4fd107ea28149c44e7dcc2e2f0b16353cd9270e5197828d
+  data.tar.gz: 89328d4e21ceba6ad978353a162a5a1802d734d66d905f009f73a001d20f858a91c2d110df89ce985beac5a341e730fb3cf6c141a251b049da27b626e7523324

data/lib/apple_frameworks/fat.rb

@@ -0,0 +1,56 @@
+module AppleFrameworks
+  # Creates "fat" or "universal" libraries by combining two builds of the same
+  # library with different architectures.
+  #
+  # Note: While it's possible (and used to be recommended) to make a fat library
+  # for multiple platforms (iOS simulator and device), it's no longer
+  # recommended to have these mixed in a single fat binary. For mixing
+  # platforms, use `XCFramework`.
+  #
+  class Fat
+    class CombineUsingLipoFailure < StandardError; end
+
+    # - parameter output_path: The path of the resulting library.
+    # - parameter library_paths: An array of paths to the static libraries
+    #   (`.a` files).
+    #
+    def initialize(output_path, library_paths)
+      @output_path = output_path
+      @library_paths = library_paths
+    end
+
+    # Uses the `lipo -create` command to combine two or more libraries into a
+    # single fat library.
+    #
+    def combine_using_lipo
+      validations
+
+      path_args = @library_paths.join(" ")
+
+      cmd = "lipo #{path_args} -create -output #{@output_path}"
+
+      logfile = Tempfile.new(['fat', '.log'])
+
+      system("#{cmd} >#{logfile.path} 2>&1") ||
+        raise(CombineUsingLipoFailure.new(File.read(logfile).strip.split(/\/.*\/lipo: /).last))
+    ensure
+      if logfile
+        logfile.close
+        logfile.delete
+      end
+    end
+
+    private
+
+
+    def validations
+      if File.directory?(@output_path)
+        raise "Directory already exists at Fat library output_path"
+      end
+
+      if File.file?(@output_path)
+        raise "File already exists at Fat library output_path"
+      end
+    end
+  end
+end

data/lib/apple_frameworks/framework.rb

@@ -7,7 +7,7 @@ module AppleFrameworks
   # ```
   # LibraryName.Framework
   #   Info.plist
-  #   library_name (the actual dynamic lib)
+  #   library_name (the actual static lib)
   #   Headers
   #     library_name
   #       (all the headers)

data/lib/apple_frameworks/version.rb

@@ -1,3 +1,3 @@
 module AppleFrameworks
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/apple_frameworks/xcframework.rb

@@ -26,8 +26,6 @@ module AppleFrameworks
   #     LibraryName.framework
   # ```
   #
-  # Note: Binaries with multiple platforms are not supported by Xcode.
-  #
   class XCFramework
     class BuildUsingXcodeFailure < StandardError; end
 
@@ -51,7 +49,15 @@ module AppleFrameworks
     # Uses the `xcodebuild -create-xcframework` command to create the
     # XCFramework.
     #
-    # Note: this will require Xcode and its command line tools to be installed.
+    # This will require Xcode and its command line tools to be installed.
+    #
+    # Xcode has a couple of notable annoyances:
+    #
+    # * Fat binaries with multiple platforms (e.g. a single binary containing
+    #   iOS simulator x64 and iOS arm64) are not supported.
+    # * To include multiple architectures of the same platform (e.g. iOS
+    #   simulator x64 and arm64), they first need to be combined as a Fat
+    #   binary.
     #
     def build_using_xcode
       validations

data/lib/apple_frameworks.rb

@@ -2,5 +2,6 @@ require "digest"
 require "tempfile"
 
 require "apple_frameworks/version"
+require "apple_frameworks/fat"
 require "apple_frameworks/framework"
 require "apple_frameworks/xcframework"

data/spec/fat_spec.rb

@@ -0,0 +1,79 @@
+RSpec.describe AppleFrameworks::Fat do
+  let(:output_path) { Bundler.root.join("tmp", "fat") }
+  let(:library_paths) do
+    [
+      Bundler.root.join("spec", "fixtures", "fake.a"),
+      Bundler.root.join("spec", "fixtures", "fake-x64.a")
+    ]
+  end
+  let(:described_instance) { described_class.new(output_path, library_paths) }
+
+  describe "#combine_using_lipo" do
+    subject { described_instance.combine_using_lipo }
+    before { FileUtils.rm_rf(output_path) }
+    after { FileUtils.rm_rf(output_path) }
+
+    context "when there is already a directory in the parent_directory" do
+      before do
+        FileUtils.mkdir_p(File.join(output_path))
+
+        expect(File.directory?(output_path))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("Directory already exists at Fat library output_path")
+      end
+    end
+
+    context "when there is a file at the target parent_directory" do
+      before do
+        FileUtils.mkdir_p(Bundler.root.join("tmp"))
+        FileUtils.touch(output_path)
+
+        expect(File.file?(output_path))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("File already exists at Fat library output_path")
+      end
+    end
+
+    context "when there is an error from lipo" do
+      let(:library_paths) do
+        ["doesnt_exist"]
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error(
+            AppleFrameworks::Fat::CombineUsingLipoFailure,
+            "can't open input file: doesnt_exist (No such file or directory)"
+          )
+      end
+    end
+
+    context "when there isn't a file or directory at output_path" do
+      before do
+        expect(File.directory?(output_path))
+          .to eq(false)
+
+        expect(File.file?(output_path))
+          .to eq(false)
+      end
+
+      it "creates the fat library" do
+        subject
+
+        expect(File.file?(output_path))
+          .to eq(true)
+
+        expect(`lipo -info #{output_path}`.strip)
+          .to end_with("are: x86_64 arm64")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apple_frameworks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Inkpen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -32,9 +32,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/apple_frameworks.rb
+- lib/apple_frameworks/fat.rb
 - lib/apple_frameworks/framework.rb
 - lib/apple_frameworks/version.rb
 - lib/apple_frameworks/xcframework.rb
+- spec/fat_spec.rb
 - spec/framework_spec.rb
 - spec/spec_helper.rb
 - spec/xcframework_spec.rb