cocoapods-binary-cache 0.1.1

data/lib/cocoapods-binary-cache/pod-binary/integration/validation.rb

@@ -0,0 +1,20 @@
+module Pod
+  class Installer
+    def validate_every_pod_only_have_one_form
+      multi_targets_pods = pod_targets
+        .group_by(&:pod_name)
+        .select do |_, targets|
+          is_multi_targets = targets.map { |t| t.platform.name }.uniq.count > 1
+          is_multi_forms = targets.map { |t| prebuilt_pod_targets.include?(t) }.uniq.count > 1
+          is_multi_targets && is_multi_forms
+        end
+      return if multi_targets_pods.empty?
+
+      warnings = "One pod can only be prebuilt or not prebuilt. These pod have different forms in multiple targets:\n"
+      warnings += multi_targets_pods
+        .map { |name, targets| "         #{name}: #{targets.map { |t| t.platform.name }}" }
+        .join("\n")
+      raise Informative, warnings
+    end
+  end
+end

data/lib/cocoapods-binary-cache/pod-binary/prebuild.rb

@@ -0,0 +1,224 @@
+require "fileutils"
+require_relative "../pod-rome/build_framework"
+require_relative "../prebuild_output/output"
+require_relative "helper/passer"
+require_relative "helper/target_checker"
+
+# patch prebuild ability
+module Pod
+  class PrebuildInstaller < Installer
+    def initialize(options)
+      super(options[:sandbox], options[:podfile], options[:lockfile])
+      @cache_validation = options[:cache_validation]
+    end
+
+    private
+
+    def local_manifest
+      @local_manifest ||= sandbox.manifest
+    end
+
+    # @return [Analyzer::SpecsState]
+    def prebuild_pods_changes
+      return nil if local_manifest.nil?
+
+      if @prebuild_pods_changes.nil?
+        changes = local_manifest.detect_changes_with_podfile(podfile)
+        @prebuild_pods_changes = Analyzer::SpecsState.new(changes)
+        # save the chagnes info for later stage
+        Pod::Prebuild::Passer.prebuild_pods_changes = @prebuild_pods_changes
+      end
+      @prebuild_pods_changes
+    end
+
+    def blacklisted?(name)
+      PodPrebuild::StateStore.excluded_pods.include?(name)
+    end
+
+    def cache_hit?(name)
+      @cache_validation.hit?(name)
+    end
+
+    def should_not_prebuild_vendor_pod(name)
+      return true if blacklisted?(name)
+      return false if Pod::Podfile::DSL.prebuild_all_vendor_pods
+
+      cache_hit?(name)
+    end
+
+    public
+
+    def prebuild_output
+      @prebuild_output ||= PodPrebuild::Output.new(sandbox)
+    end
+
+    # Build the needed framework files
+    def prebuild_frameworks!
+      UI.puts "Start prebuild_frameworks"
+
+      # build options
+      sandbox_path = sandbox.root
+      existed_framework_folder = sandbox.generate_framework_path
+      bitcode_enabled = Pod::Podfile::DSL.bitcode_enabled
+      targets = []
+
+      if Pod::Podfile::DSL.prebuild_all_vendor_pods
+        UI.puts "Rebuild all vendor frameworks"
+        targets = pod_targets
+      elsif !local_manifest.nil?
+        UI.puts "Update some frameworks"
+        changes = prebuild_pods_changes
+        added = changes.added
+        changed = changes.changed
+        unchanged = changes.unchanged
+
+        existed_framework_folder.mkdir unless existed_framework_folder.exist?
+        exsited_framework_pod_names = sandbox.exsited_framework_pod_names
+
+        # additions
+        missing = unchanged.reject { |pod_name| exsited_framework_pod_names.include?(pod_name) }
+
+        root_names_to_update = (added + changed + missing)
+        root_names_to_update += PodPrebuild::StateStore.cache_validation.missed
+
+        # transform names to targets
+        cache = []
+        targets = root_names_to_update.map do |pod_name|
+          tars = Pod.fast_get_targets_for_pod_name(pod_name, pod_targets, cache) || []
+          raise "There's no target named (#{pod_name}) in Pod.xcodeproj" if tars.empty?
+
+          tars
+        end.flatten
+
+        # add the dendencies
+        dependency_targets = targets.map(&:recursive_dependent_targets).flatten.uniq || []
+        targets = (targets + dependency_targets).uniq
+      else
+        UI.puts "Rebuild all frameworks"
+        targets = pod_targets
+      end
+
+      targets = targets.reject { |pod_target| should_not_prebuild_vendor_pod(pod_target.name) }
+      targets = targets.reject { |pod_target| sandbox.local?(pod_target.pod_name) } unless Podfile::DSL.dev_pods_enabled
+
+      # build!
+      Pod::UI.puts "Prebuild frameworks (total #{targets.count})"
+      Pod::UI.puts targets.map(&:name)
+
+      Pod::Prebuild.remove_build_dir(sandbox_path)
+      targets.each do |target|
+        unless target.should_build?
+          Pod::UI.puts "Skip prebuilding #{target.label} because of no source files".yellow
+          next
+        end
+
+        output_path = sandbox.framework_folder_path_for_target_name(target.name)
+        output_path.mkpath unless output_path.exist?
+        Pod::Prebuild.build(
+          sandbox_path,
+          target,
+          Pod::Podfile::DSL.prebuild_config,
+          output_path,
+          bitcode_enabled,
+          Pod::Podfile::DSL.custom_device_build_options,
+          Pod::Podfile::DSL.custom_simulator_build_options
+        )
+        collect_metadata(target, output_path)
+      end
+      Pod::Prebuild.remove_build_dir(sandbox_path)
+
+      # copy vendored libraries and frameworks
+      targets.each do |target|
+        root_path = sandbox.pod_dir(target.name)
+        target_folder = sandbox.framework_folder_path_for_target_name(target.name)
+
+        # If target shouldn't build, we copy all the original files
+        # This is for target with only .a and .h files
+        unless target.should_build?
+          Prebuild::Passer.target_names_to_skip_integration_framework << target.name
+          FileUtils.cp_r(root_path, target_folder, :remove_destination => true)
+          next
+        end
+
+        target.spec_consumers.each do |consumer|
+          file_accessor = Sandbox::FileAccessor.new(root_path, consumer)
+          lib_paths = file_accessor.vendored_frameworks || []
+          lib_paths += file_accessor.vendored_libraries
+          # @TODO dSYM files
+          lib_paths.each do |lib_path|
+            relative = lib_path.relative_path_from(root_path)
+            destination = target_folder + relative
+            destination.dirname.mkpath unless destination.dirname.exist?
+            FileUtils.cp_r(lib_path, destination, :remove_destination => true)
+          end
+        end
+      end
+
+      # save the pod_name for prebuild framwork in sandbox
+      targets.each do |target|
+        sandbox.save_pod_name_for_target target
+      end
+
+      # Remove useless files
+      # remove useless pods
+      all_needed_names = pod_targets.map(&:name).uniq
+      useless_target_names = sandbox.exsited_framework_target_names.reject do |name|
+        all_needed_names.include? name
+      end
+      useless_target_names.each do |name|
+        UI.puts "Remove: #{name}"
+        path = sandbox.framework_folder_path_for_target_name(name)
+        path.rmtree if path.exist?
+      end
+
+      if Podfile::DSL.dont_remove_source_code
+        # just remove the tmp files
+        path = sandbox.root + "Manifest.lock.tmp"
+        path.rmtree if path.exist?
+      else
+        # only keep manifest.lock and framework folder in _Prebuild
+        to_remain_files = ["Manifest.lock", File.basename(existed_framework_folder)]
+        to_delete_files = sandbox_path.children.reject { |file| to_remain_files.include?(File.basename(file)) }
+        to_delete_files.each { |file| file.rmtree if file.exist? }
+      end
+
+      updated_target_names = targets.map { |target| target.label.to_s }
+      deleted_target_names = useless_target_names
+      Pod::UI.puts "Targets to prebuild: #{updated_target_names}"
+      Pod::UI.puts "Targets to cleanup: #{deleted_target_names}"
+
+      prebuild_output.write_delta_file(updated_target_names, deleted_target_names)
+      prebuild_output.process_prebuilt_dev_pods
+    end
+
+    def clean_delta_file
+      prebuild_output.clean_delta_file
+    end
+
+    def collect_metadata(target, output_path)
+      metadata = PodPrebuild::Metadata.in_dir(output_path)
+      metadata.framework_name = target.framework_name
+      metadata.static_framework = target.static_framework?
+      resource_paths = target.resource_paths
+      metadata.resources = resource_paths.is_a?(Hash) ? resource_paths.values.flatten : resource_paths
+      metadata.resource_bundles = target
+        .file_accessors
+        .map { |f| f.resource_bundles.keys }
+        .flatten
+        .map { |name| "#{name}.bundle" }
+      metadata.build_settings = pods_project.targets
+        .detect { |native_target| native_target.name == target.name }
+        .build_configurations
+        .detect { |config| config.name == Pod::Podfile::DSL.prebuild_config }
+        .build_settings
+      metadata.save!
+    end
+
+    # patch the post install hook
+    old_method2 = instance_method(:run_plugins_post_install_hooks)
+    define_method(:run_plugins_post_install_hooks) do
+      old_method2.bind(self).call
+      prebuild_frameworks! if Pod.is_prebuild_stage && Pod::Podfile::DSL.prebuild_job?
+    end
+  end
+end

data/lib/cocoapods-binary-cache/pod-binary/prebuild_dsl.rb

@@ -0,0 +1,69 @@
+require_relative "tool/tool"
+
+module Pod
+  class Podfile
+    module DSL
+      def config_cocoapods_binary_cache(options)
+        apply_config = lambda do |config|
+          DSL.send("#{config}=", options[config]) unless options[config].nil?
+        end
+
+        apply_config.call(:prebuild_config)
+        apply_config.call(:prebuild_job)
+        apply_config.call(:prebuild_all) # TODO (thuyen): Revise this option
+        apply_config.call(:prebuild_all_vendor_pods)
+        apply_config.call(:excluded_pods)
+        apply_config.call(:dev_pods_enabled)
+        apply_config.call(:bitcode_enabled)
+        apply_config.call(:dont_remove_source_code)
+        apply_config.call(:custom_device_build_options)
+        apply_config.call(:custom_simulator_build_options)
+        apply_config.call(:save_cache_validation_to)
+        apply_config.call(:validate_prebuilt_settings)
+      end
+
+      @prebuild_config = "Debug"
+      @prebuild_job = false
+      @prebuild_all = false
+      @prebuild_all_vendor_pods = false
+      @excluded_pods = Set.new
+      @dev_pods_enabled = false
+      @bitcode_enabled = false
+      @dont_remove_source_code = false
+      @custom_device_build_options = []
+      @custom_simulator_build_options = []
+      @save_cache_validation_to = nil
+      # A proc to validate the provided build settings (per target) with the build settings of the prebuilt frameworks
+      # For example, in Podfile:
+      # -----------------------------------------------
+      #   validate_prebuilt_settings do |target|
+      #     settings = {}
+      #     settings["MACH_O_TYPE"] == "staticlib"
+      #     settings["SWIFT_VERSION"] == swift_version_of(target)
+      #     settings
+      #   end
+      # -----------------------------------------------
+      @validate_prebuilt_settings = nil
+
+      class << self
+        attr_accessor :prebuild_config
+        attr_accessor :prebuild_job
+        attr_accessor :prebuild_all
+        attr_accessor :prebuild_all_vendor_pods
+        attr_accessor :excluded_pods
+        attr_accessor :dev_pods_enabled
+        attr_accessor :bitcode_enabled
+        attr_accessor :dont_remove_source_code
+        attr_accessor :custom_device_build_options
+        attr_accessor :custom_simulator_build_options
+        attr_accessor :save_cache_validation_to
+        attr_accessor :validate_prebuilt_settings
+
+        alias prebuild_job? prebuild_job
+        alias prebuild_all? prebuild_all
+        alias prebuild_all_vendor_pods? prebuild_all_vendor_pods
+        alias dev_pods_enabled? dev_pods_enabled
+      end
+    end
+  end
+end

data/lib/cocoapods-binary-cache/pod-binary/prebuild_hook.rb

@@ -0,0 +1,11 @@
+require_relative "helper/passer"
+require_relative "helper/podfile_options"
+require_relative "helper/prebuild_sandbox"
+
+Pod::HooksManager.register("cocoapods-binary-cache", :pre_install) do |installer_context|
+  PodPrebuild::PreInstallHook.new(installer_context).run
+end
+
+Pod::HooksManager.register("cocoapods-binary-cache", :post_install) do |installer_context|
+  PodPrebuild::PostInstallHook.new(installer_context).run
+end

data/lib/cocoapods-binary-cache/pod-binary/tool/tool.rb

@@ -0,0 +1,12 @@
+# attr_accessor for class variable.
+# usage:
+#
+#   ```
+#   class Pod
+#       class_attr_accessor :is_prebuild_stage
+#   end
+#   ```
+#
+def class_attr_accessor(symbol)
+  self.class.send(:attr_accessor, symbol)
+end

data/lib/cocoapods-binary-cache/pod-rome/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Boris Bügling <boris@icculus.org>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/cocoapods-binary-cache/pod-rome/build_framework.rb

@@ -0,0 +1,247 @@
+require 'fourflusher'
+require 'xcpretty' # TODO (thuyen): Revise this dependency
+
+PLATFORMS = { 'iphonesimulator' => 'iOS',
+              'appletvsimulator' => 'tvOS',
+              'watchsimulator' => 'watchOS' }
+
+#  Build specific target to framework file
+#  @param [PodTarget] target
+#         a specific pod target
+#
+def build_for_iosish_platform(sandbox, 
+                              build_dir, 
+                              output_path,
+                              target, 
+                              configuration,
+                              device, 
+                              simulator,
+                              bitcode_enabled,
+                              custom_build_options = [], # Array<String>
+                              custom_build_options_simulator = [], # Array<String>
+                              enable_device_build = false
+                              )
+
+  deployment_target = target.platform.deployment_target.to_s
+  
+  target_label = target.label # name with platform if it's used in multiple platforms
+  Pod::UI.puts "Prebuilding #{target_label}..."
+  
+  other_options = []
+  # bitcode enabled
+  other_options += ['BITCODE_GENERATION_MODE=bitcode'] if bitcode_enabled
+  # make less arch to iphone simulator for faster build
+  custom_build_options_simulator += ['ARCHS=x86_64', 'ONLY_ACTIVE_ARCH=NO'] if simulator == 'iphonesimulator'
+
+  # paths
+  target_name = target.name # equals target.label, like "AFNeworking-iOS" when AFNetworking is used in multiple platforms.
+  module_name = target.product_module_name
+  device_framework_path = "#{build_dir}/#{configuration}-#{device}/#{target_name}/#{module_name}.framework"
+  simulator_framework_path = "#{build_dir}/#{configuration}-#{simulator}/#{target_name}/#{module_name}.framework"
+  simulator_target_products_path = "#{build_dir}/#{configuration}-#{simulator}/#{target_name}"
+
+  if !Dir.exist?(simulator_framework_path)
+    is_succeed, = xcodebuild(
+      sandbox,
+      target_label,
+      configuration,
+      simulator,
+      deployment_target,
+      other_options + custom_build_options_simulator
+    )
+    raise "Build simulator framework failed: #{target_label}" unless is_succeed
+  else
+    puts "Simulator framework already exist at: #{simulator_framework_path}"
+  end
+
+  unless enable_device_build
+    FileUtils.cp_r Dir["#{simulator_target_products_path}/*"], output_path
+    return
+  end
+
+  if !Dir.exist?(device_framework_path)
+    is_succeed, = xcodebuild(
+      sandbox,
+      target_label,
+      configuration,
+      device,
+      deployment_target,
+      other_options + custom_build_options
+    )
+    raise "Build device framework failed: #{target_label}" unless is_succeed
+  else
+    puts "Device framework already exist at: #{device_framework_path}"
+  end
+
+  device_binary = device_framework_path + "/#{module_name}"
+  simulator_binary = simulator_framework_path + "/#{module_name}"
+  return unless File.file?(device_binary) && File.file?(simulator_binary)
+  
+  # the device_lib path is the final output file path
+  # combine the binaries
+  tmp_lipoed_binary_path = "#{build_dir}/#{target_name}"
+  lipo_log = `lipo -create -output #{tmp_lipoed_binary_path} #{device_binary} #{simulator_binary}`
+  puts lipo_log unless File.exist?(tmp_lipoed_binary_path)
+  FileUtils.mv tmp_lipoed_binary_path, device_binary, :force => true
+  
+  # collect the swiftmodule file for various archs.
+  device_swiftmodule_path = device_framework_path + "/Modules/#{module_name}.swiftmodule"
+  simulator_swiftmodule_path = simulator_framework_path + "/Modules/#{module_name}.swiftmodule"
+  if File.exist?(device_swiftmodule_path)
+    FileUtils.cp_r simulator_swiftmodule_path + "/.", device_swiftmodule_path
+  end
+
+  # combine the generated swift headers
+  # (In xcode 10.2, the generated swift headers vary for each archs)
+  # https://github.com/leavez/cocoapods-binary/issues/58
+  simulator_generated_swift_header_path = simulator_framework_path + "/Headers/#{module_name}-Swift.h"
+  device_generated_swift_header_path = device_framework_path + "/Headers/#{module_name}-Swift.h"
+  if File.exist? simulator_generated_swift_header_path
+    device_header = File.read(device_generated_swift_header_path)
+    simulator_header = File.read(simulator_generated_swift_header_path)
+    # https://github.com/Carthage/Carthage/issues/2718#issuecomment-473870461
+    combined_header_content = %Q{
+#if TARGET_OS_SIMULATOR // merged by cocoapods-binary
+
+#{simulator_header}
+
+#else // merged by cocoapods-binary
+
+#{device_header}
+
+#endif // merged by cocoapods-binary
+}
+    File.write(device_generated_swift_header_path, combined_header_content.strip)
+  end
+
+  # handle the dSYM files
+  device_dsym = "#{device_framework_path}.dSYM"
+  if File.exist? device_dsym
+    # lipo the simulator dsym
+    simulator_dsym = "#{simulator_framework_path}.dSYM"
+    if File.exist? simulator_dsym
+      tmp_lipoed_binary_path = "#{output_path}/#{module_name}.draft"
+      lipo_log = `lipo -create -output #{tmp_lipoed_binary_path} #{device_dsym}/Contents/Resources/DWARF/#{module_name} #{simulator_dsym}/Contents/Resources/DWARF/#{module_name}`
+      puts lipo_log unless File.exist?(tmp_lipoed_binary_path)
+      FileUtils.mv tmp_lipoed_binary_path, "#{device_framework_path}.dSYM/Contents/Resources/DWARF/#{module_name}", :force => true
+    end
+    # move
+    FileUtils.mv device_dsym, output_path, :force => true
+  end
+
+  # output
+  output_path.mkpath unless output_path.exist?
+  FileUtils.mv device_framework_path, output_path, :force => true
+
+end
+
+def xcodebuild(sandbox, target, configuration, sdk='macosx', deployment_target=nil, other_options=[])
+  args = %W(-project #{sandbox.project_path.realdirpath} -scheme #{target} -configuration #{configuration} -sdk #{sdk} )
+  platform = PLATFORMS[sdk]
+  args += Fourflusher::SimControl.new.destination(:oldest, platform, deployment_target) unless platform.nil?
+  args += other_options
+
+  args_str = args.join(" ")
+  cmd = "xcodebuild #{args_str} 2>&1"
+  puts "xcodebuild command: #{cmd}"
+  log = `#{cmd}`
+
+  exit_code = $?.exitstatus  # Process::Status
+  is_succeed = (exit_code == 0)
+
+  if !is_succeed
+    begin
+        if log.include?('** BUILD FAILED **')
+            # use xcpretty to print build log
+            # 64 represent command invalid. http://www.manpagez.com/man/3/sysexits/
+            printer = XCPretty::Printer.new({:formatter => XCPretty::Simple, :colorize => 'auto'})
+            log.each_line do |line|
+              printer.pretty_print(line)
+            end
+        else
+            raise "shouldn't be handle by xcpretty"
+        end
+    rescue
+        puts log.red
+    end
+  end
+  [is_succeed, log]
+end
+
+
+
+module Pod
+  class Prebuild
+
+    # Build the frameworks with sandbox and targets
+    #
+    # @param  [String] sandbox_root_path
+    #         The sandbox root path where the targets project place
+    #
+    #         [PodTarget] target
+    #         The pod targets to build
+    #
+    #         [Pathname] output_path
+    #         output path for generated frameworks
+    #
+    def self.build(sandbox_root_path, target, configuration, output_path, bitcode_enabled = false, custom_build_options=[], custom_build_options_simulator=[])
+      return if target.nil?
+
+      sandbox_root = Pathname(sandbox_root_path)
+      sandbox = Pod::Sandbox.new(sandbox_root)
+      build_dir = self.build_dir(sandbox_root)
+
+      # -- build the framework
+      case target.platform.name
+      when :ios
+        build_for_iosish_platform(
+          sandbox,
+          build_dir,
+          output_path,
+          target,
+          configuration,
+          "iphoneos",
+          "iphonesimulator",
+          bitcode_enabled,
+          custom_build_options,
+          custom_build_options_simulator
+        )
+      when :osx
+        xcodebuild(
+          sandbox,
+          target.label,
+          configuration,
+          "macosx",
+          nil,
+          custom_build_options
+        )
+      # when :tvos then build_for_iosish_platform(sandbox, build_dir, target, 'appletvos', 'appletvsimulator')
+      when :watchos
+        build_for_iosish_platform(
+          sandbox,
+          build_dir,
+          output_path,
+          target,
+          configuration,
+          "watchos",
+          "watchsimulator",
+          true,
+          custom_build_options,
+          custom_build_options_simulator
+        )
+      else raise "Unsupported platform for '#{target.name}': '#{target.platform.name}'" end
+
+      raise Pod::Informative, "The build directory was not found in the expected location" unless build_dir.directory?
+    end
+
+    def self.remove_build_dir(sandbox_root)
+      path = build_dir(sandbox_root)
+      path.rmtree if path.exist?
+    end
+
+    def self.build_dir(sandbox_root)
+      sandbox_root.parent + "build"
+    end
+
+  end
+end