apple_frameworks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88a784f4579a6fe0d1c01d20cee23743ff51987026fe70102a34f3b2a568e6ff
+  data.tar.gz: b98904da83eb50018c769c6443d7149da20ac759d551ab6f83b4c8259742e53d
+SHA512:
+  metadata.gz: 60ddf21feb22a51447f0f22c11b820783424716037047737c13f400f6fc096ac2a15a6dafb69f2acceb10bba7957b828420c45adb40613c634996c7706d6ad1e
+  data.tar.gz: aeebac5804a5d7d08df84018c1fb1073cdf9ce226e76d87a3cb80a43137e8578613eecef1f119e0929ae44cac923490878e9bb5cde36d451023094b88264c4cd

data/lib/apple_frameworks/framework.rb

@@ -0,0 +1,96 @@
+module AppleFrameworks
+  # Creates an Apple (iOS or macOS) Framework from an existing library (`.a`
+  # file).
+  #
+  # The Framework is built up with a directory structure:
+  #
+  # ```
+  # LibraryName.Framework
+  #   Info.plist
+  #   library_name (the actual dynamic lib)
+  #   Headers
+  #     library_name
+  #       (all the headers)
+  # ```
+  #
+  class Framework
+    # - parameter framework_name: The name of the resulting framework.
+    # - parameter parent_directory: The directory in which to create the
+    #   framework.
+    # - parameter library: The library itself; the `.a` file.
+    # - parameter headers_directory: The directory which includes the headers.
+    #   Normally located in the `include/` directory.
+    #
+    def initialize(framework_name, parent_directory, library, headers_directory)
+      @framework_name = framework_name
+      @parent_directory = parent_directory
+      @library = library
+      @headers_directory = headers_directory
+
+      @framework_directory = File.join(
+        @parent_directory,
+        "#{@framework_name}.framework"
+      )
+    end
+
+    # Generates the `.framework` bundle.
+    #
+    def build
+      create_directories
+      copy_lib
+      copy_headers
+      generate_plist
+    end
+
+    private
+
+    def create_directories
+      if File.directory?(@framework_directory)
+        raise "Framework already exists"
+      end
+
+      if File.file?(@framework_directory)
+        raise "File already exists at Framework destination"
+      end
+
+      FileUtils.mkdir_p(File.join(@framework_directory, "Headers"))
+    end
+
+    def copy_lib
+      FileUtils.cp(@library, File.join(@framework_directory, @framework_name))
+    end
+
+    def copy_headers
+      FileUtils.cp_r(File.join(@headers_directory), File.join(@framework_directory, "Headers", @framework_name))
+    end
+
+    def generate_plist
+      filepath = File.join(@framework_directory, "Info.plist")
+
+      plist_contents = <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>CFBundleName</key>
+          <string>#{@framework_name}</string>
+          <key>CFBundleDevelopmentRegion</key>
+          <string>en</string>
+          <key>CFBundleInfoDictionaryVersion</key>
+          <string>6.0</string>
+          <key>CFBundlePackageType</key>
+          <string>FMWK</string>
+          <key>CFBundleIdentifier</key>
+          <string>#{@framework_name}.#{@framework_name}</string>
+          <key>CFBundleExecutable</key>
+          <string>#{@framework_name}</string>
+          <key>CFBundleVersion</key>
+          <string>1</string>
+        </dict>
+        </plist>
+      XML
+
+      File.open(filepath, "w") { |file| file.puts(plist_contents) }
+    end
+  end
+end

data/lib/apple_frameworks/version.rb

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

data/lib/apple_frameworks/xcframework.rb

@@ -0,0 +1,92 @@
+module AppleFrameworks
+  # Creates an Apple (iOS or macOS) XCFramework from a set of existing
+  # frameworks (`.framework`).
+  #
+  # XCFramework as a concept is newer than Frameworks. It was introduced due to
+  # targets supporting more architectures. For example iOS Simulator now
+  # supports the same architecture as iOS itself (arm64). Previously a Fat or
+  # Universal Library could contain both x64 and arm64 architectures, thereby
+  # supporting both simulator and real devices, but with the Fat format this
+  # isn't possible anymore for arm64 and arm64. Enter XCFramework which simply
+  # contains many frameworks of the same library but for different targets and
+  # architectures.
+  #
+  # To create a `.framework` from a `.a` library, see
+  # `AppleFrameworks::Framework`.
+  #
+  # The XCFramework is built up with a directory structure, including each
+  # Framework for each individual target:
+  #
+  # ```
+  # LibraryName.XCFramework
+  #   Info.plist
+  #   ios-arm64
+  #     LibraryName.framework
+  #   ios-x86_64-simulator
+  #     LibraryName.framework
+  # ```
+  #
+  # Note: Binaries with multiple platforms are not supported by Xcode.
+  #
+  class XCFramework
+    class BuildUsingXcodeFailure < StandardError; end
+
+    # - parameter framework_name: The name of the resulting XCFramework.
+    # - parameter parent_directory: The directory in which to create the
+    #   framework.
+    # - parameter framework_paths: An array of paths to the `.framework`
+    #   bundles.
+    #
+    def initialize(framework_name, parent_directory, framework_paths)
+      @framework_name = framework_name
+      @framework_paths = framework_paths
+      @parent_directory = parent_directory
+
+      @framework_directory = File.join(
+        @parent_directory,
+        "#{@framework_name}.xcframework"
+      )
+    end
+
+    # Uses the `xcodebuild -create-xcframework` command to create the
+    # XCFramework.
+    #
+    # Note: this will require Xcode and its command line tools to be installed.
+    #
+    def build_using_xcode
+      validations
+
+      framework_args = @framework_paths
+        .map { |path| "-framework #{path}" }
+        .join(" ")
+
+      FileUtils.mkdir_p(@parent_directory)
+      output_path = File.join(@parent_directory, "#{@framework_name}.xcframework")
+      output_args = "-output #{output_path}"
+
+      logfile = Tempfile.new(['xcframework', '.log'])
+
+      cmd = "xcodebuild -create-xcframework #{framework_args} #{output_args}"
+
+      system("#{cmd} >#{logfile.path} 2>&1") ||
+        raise(BuildUsingXcodeFailure.new(File.read(logfile).strip))
+    ensure
+      if logfile
+        logfile.close
+        logfile.delete
+      end
+    end
+
+    private
+
+    def validations
+      if File.directory?(@framework_directory)
+        raise "XCFramework already exists"
+      end
+
+      if File.file?(@framework_directory)
+        raise "File already exists at XCFramework destination"
+      end
+    end
+  end
+end

data/lib/apple_frameworks.rb

@@ -0,0 +1,6 @@
+require "digest"
+require "tempfile"
+
+require "apple_frameworks/version"
+require "apple_frameworks/framework"
+require "apple_frameworks/xcframework"

data/spec/framework_spec.rb

@@ -0,0 +1,110 @@
+RSpec.describe AppleFrameworks::Framework do
+  let(:framework_name) { "framework_name" }
+  let(:parent_directory) { Bundler.root.join("tmp", "framework_name") }
+  let(:library) { Bundler.root.join("spec", "fixtures", "fake.a") }
+  let(:headers_directory) { Bundler.root.join("spec", "fixtures", "headers") }
+  let(:described_instance) { described_class.new(framework_name, parent_directory, library, headers_directory) }
+
+  describe "#build" do
+    subject { described_instance.build }
+    before { FileUtils.rm_rf(parent_directory) }
+    after { FileUtils.rm_rf(parent_directory) }
+
+    context "when there is already a framework in the parent_directory" do
+      before do
+        FileUtils.mkdir_p(File.join(parent_directory, "#{framework_name}.framework"))
+
+        expect(File.directory?(parent_directory))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("Framework already exists")
+      end
+    end
+
+    context "when there is a file at the target parent_directory" do
+      before do
+        FileUtils.mkdir_p(parent_directory)
+        FileUtils.touch(File.join(parent_directory, "#{framework_name}.framework"))
+
+        expect(File.file?(File.join(parent_directory, "#{framework_name}.framework")))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("File already exists at Framework destination")
+      end
+    end
+
+    context "when there isn't a directory at parent_directory" do
+      before do
+        expect(File.directory?(parent_directory))
+          .to eq(false)
+      end
+
+      it "creates the directory" do
+        subject
+
+        expect(File.directory?(parent_directory))
+          .to eq(true)
+      end
+
+      it "copies the library" do
+        subject
+
+        expected_library_path = File.join(parent_directory, "#{framework_name}.framework", framework_name)
+        a = Digest::MD5.hexdigest(File.read(library))
+        b = Digest::MD5.hexdigest(File.read(expected_library_path))
+
+        expect(a).to eq(b)
+      end
+
+      it "copies the headers" do
+        subject
+
+        a1 = File.join(headers_directory, "a.h")
+        b1 = File.join(headers_directory, "b.h")
+
+        a2 = File.join(parent_directory, "#{framework_name}.framework", "Headers", framework_name, "a.h")
+        b2 = File.join(parent_directory, "#{framework_name}.framework", "Headers", framework_name, "b.h")
+
+        expect(File.read(a1)).to eq(File.read(a2))
+        expect(File.read(b1)).to eq(File.read(b2))
+      end
+
+      it "creates a plist" do
+        subject
+
+        path = File.join(parent_directory, "#{framework_name}.framework", "Info.plist")
+
+        expected_contents = <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+          <plist version="1.0">
+          <dict>
+            <key>CFBundleName</key>
+            <string>framework_name</string>
+            <key>CFBundleDevelopmentRegion</key>
+            <string>en</string>
+            <key>CFBundleInfoDictionaryVersion</key>
+            <string>6.0</string>
+            <key>CFBundlePackageType</key>
+            <string>FMWK</string>
+            <key>CFBundleIdentifier</key>
+            <string>framework_name.framework_name</string>
+            <key>CFBundleExecutable</key>
+            <string>framework_name</string>
+            <key>CFBundleVersion</key>
+            <string>1</string>
+          </dict>
+          </plist>
+        XML
+
+        expect(File.read(path)).to eq(expected_contents)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "apple_frameworks"
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.filter_run_when_matching :focus
+end

data/spec/xcframework_spec.rb

@@ -0,0 +1,118 @@
+RSpec.describe AppleFrameworks::XCFramework do
+  let(:framework_name) { "framework_name" }
+  let(:parent_directory) { Bundler.root.join("tmp", "framework_name") }
+  let(:framework_paths) do
+    [Bundler.root.join("spec", "fixtures" , "fake.framework")]
+  end
+  let(:described_instance) { described_class.new(framework_name, parent_directory, framework_paths) }
+
+  describe "#build_using_xcode" do
+    subject { described_instance.build_using_xcode }
+    before { FileUtils.rm_rf(parent_directory) }
+    after { FileUtils.rm_rf(parent_directory) }
+
+    context "when there is already a framework in the parent_directory" do
+      before do
+        FileUtils.mkdir_p(File.join(parent_directory, "#{framework_name}.xcframework"))
+
+        expect(File.directory?(parent_directory))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("XCFramework already exists")
+      end
+    end
+
+    context "when there is a file at the target parent_directory" do
+      before do
+        FileUtils.mkdir_p(parent_directory)
+        FileUtils.touch(File.join(parent_directory, "#{framework_name}.xcframework"))
+
+        expect(File.file?(File.join(parent_directory, "#{framework_name}.xcframework")))
+          .to eq(true)
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error("File already exists at XCFramework destination")
+      end
+    end
+
+    context "when there is an error from xcodebuild" do
+      let(:framework_paths) do
+        []
+      end
+
+      it "raises an error" do
+        expect { subject }
+          .to raise_error(
+            AppleFrameworks::XCFramework::BuildUsingXcodeFailure,
+            "error: at least one framework or library must be specified."
+          )
+      end
+    end
+
+    context "when there isn't a directory at parent_directory" do
+      before do
+        expect(File.directory?(parent_directory))
+          .to eq(false)
+      end
+
+      it "creates the directory" do
+        subject
+
+        expect(File.directory?(parent_directory))
+          .to eq(true)
+      end
+
+      it "copies the frameworks" do
+        subject
+
+        framework_library_path = Bundler.root.join("spec", "fixtures" , "fake.framework", "fake")
+        xcframework_library_path = File.join(parent_directory, "#{framework_name}.xcframework", "macos-arm64", "fake.framework", "fake")
+        a = Digest::MD5.hexdigest(File.read(framework_library_path))
+        b = Digest::MD5.hexdigest(File.read(xcframework_library_path))
+
+        expect(a).to eq(b)
+      end
+
+      it "creates a plist" do
+        subject
+
+        path = File.join(parent_directory, "#{framework_name}.xcframework", "Info.plist")
+
+        expected_contents = <<~XML
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+          <plist version="1.0">
+          <dict>
+            <key>AvailableLibraries</key>
+            <array>
+              <dict>
+                <key>LibraryIdentifier</key>
+                <string>macos-arm64</string>
+                <key>LibraryPath</key>
+                <string>fake.framework</string>
+                <key>SupportedArchitectures</key>
+                <array>
+                  <string>arm64</string>
+                </array>
+                <key>SupportedPlatform</key>
+                <string>macos</string>
+              </dict>
+            </array>
+            <key>CFBundlePackageType</key>
+            <string>XFWK</string>
+            <key>XCFrameworkFormatVersion</key>
+            <string>1.0</string>
+          </dict>
+          </plist>
+        XML
+
+        expect(File.read(path).gsub("\t", "  ")).to eq(expected_contents)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: apple_frameworks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Inkpen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creation of .framework and .xcframework for iOS and/or macOS libraries
+email:
+- dan2552@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/apple_frameworks.rb
+- lib/apple_frameworks/framework.rb
+- lib/apple_frameworks/version.rb
+- lib/apple_frameworks/xcframework.rb
+- spec/framework_spec.rb
+- spec/spec_helper.rb
+- spec/xcframework_spec.rb
+homepage: https://github.com/Dan2552/apple_frameworks
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Creation of .framework and .xcframework for iOS and/or macOS libraries
+test_files: []