cocoapods-jxedt 0.0.9

data/lib/cocoapods-jxedt/binary/helper/podfile_options.rb

@@ -0,0 +1,116 @@
+require_relative './target_definition'
+
+module Pod
+    class Podfile
+      class TargetDefinition
+        # Returns the names of pod targets explicitly declared as prebuilt in Podfile using `:binary => true`.
+        def explicit_prebuild_pod_names
+          names = @explicit_prebuild_pod_names || []
+          names += parent.explicit_prebuild_pod_names if !parent.nil? && parent.is_a?(TargetDefinition)
+          names
+        end
+
+        def reject_prebuild_pod_names
+          names = @reject_prebuild_pod_names || []
+          names += parent.reject_prebuild_pod_names if !parent.nil? && parent.is_a?(TargetDefinition)
+          names
+        end
+
+        def explicit_header_search_pod_names
+          names = @explicit_header_search_pod_names || []
+          names += parent.explicit_header_search_pod_names if !parent.nil? && parent.is_a?(TargetDefinition)
+          names
+        end
+
+        def reject_header_search_pod_names
+          names = @reject_header_search_pod_names || []
+          names += parent.reject_header_search_pod_names if !parent.nil? && parent.is_a?(TargetDefinition)
+          names
+        end
+      end
+    end
+end
+
+module Pod
+    class Installer
+      # Returns the names of pod targets detected as prebuilt, including
+      # those declared in Podfile and their dependencies
+      def prebuild_pod_names
+        prebuilt_pod_targets.map(&:name).to_set
+      end
+  
+      # Returns the pod targets detected as prebuilt, including
+      # those declared in Podfile and their dependencies
+      def prebuilt_pod_targets
+        @prebuilt_pod_targets ||= begin
+          explicit_prebuild_pod_names = aggregate_targets.flat_map { |target| 
+            target.target_definition.explicit_prebuild_pod_names
+          }.uniq
+
+          reject_prebuild_pod_names = aggregate_targets.flat_map { |target| 
+            target.target_definition.reject_prebuild_pod_names 
+          }.uniq
+          
+          available_pod_names = []
+          check_sandbox = Jxedt::Sandbox.from_sandbox(self.sandbox)
+          available_pod_names = check_sandbox.target_paths.map {|path| path.basename.to_s }
+          if Jxedt.config.all_binary_enabled?
+            explicit_prebuild_pod_names = available_pod_names
+          else
+            explicit_prebuild_pod_names = (explicit_prebuild_pod_names & available_pod_names).uniq
+          end
+          explicit_prebuild_pod_names -= reject_prebuild_pod_names
+          
+          targets = pod_targets.select { |target| 
+            explicit_prebuild_pod_names.include?(target.pod_name)
+          }
+          targets = targets.reject { |target| sandbox.local?(target.pod_name) } unless Jxedt.config.dev_pods_enabled?
+          targets.reject! { |target| Jxedt.config.excluded_pods.include?(target.pod_name) }
+          targets.map { |target| target.use_binary = true }
+          targets
+        end
+      end
+    end
+end
+
+module Pod
+  class Target
+    attr_accessor :use_binary
+
+    def frame_header_search_paths_enable?
+      return false if reject_header_search_pod_names.include? self.name
+      return true if explicit_header_search_pod_names.include? self.name
+      self.use_binary && Jxedt.config.framework_header_search_enabled?
+    end
+
+    def explicit_header_search_pod_names
+      @explicit_header_search_pod_names ||= begin
+        target_definitions.flat_map { |target_definition|
+          target_definition.explicit_header_search_pod_names
+        }.uniq
+      end
+    end
+
+    def reject_header_search_pod_names
+      @reject_header_search_pod_names ||= begin
+        target_definitions.flat_map { |target_definition|
+          target_definition.reject_header_search_pod_names
+        }.uniq
+      end
+    end
+  end
+end
+
+module Pod
+  class Lockfile
+    def spec_checksums_hash_key(name)
+      # git分支或commit依赖的组件的checksum值是用podspec文件做的hash，hash可能不变，所以有commitid时校验commitid
+      checkout_options = self.internal_data["CHECKOUT OPTIONS"] || {}
+      checksum = checkout_options[name][:commit] unless checkout_options[name].nil?
+      return checksum unless checksum.nil?
+
+      checksums_hash = self.internal_data["SPEC CHECKSUMS"]
+      return checksums_hash[name] if checksums_hash.include?("#{name}")
+    end
+  end
+end

data/lib/cocoapods-jxedt/binary/helper/prebuild_sandbox.rb

@@ -0,0 +1,18 @@
+module Pod
+  class PrebuildSandbox < Sandbox
+    # [String] standard_sandbox_path
+    def self.from_standard_sandbox_path(path)
+      prebuild_sandbox_path = Pathname.new(path).realpath
+      new(prebuild_sandbox_path)
+    end
+
+    def self.from_standard_sandbox(sandbox)
+      from_standard_sandbox_path(sandbox.root)
+    end
+
+    def project_path
+        super
+        # root + 'Pods.xcodeproj'
+    end
+  end
+end

data/lib/cocoapods-jxedt/binary/helper/target_definition.rb

@@ -0,0 +1,34 @@
+module Pod
+    class Podfile
+      class TargetDefinition
+        def detect_prebuilt_pod(name, requirements)
+          options = requirements.last || {}
+
+          # prebuild
+          @explicit_prebuild_pod_names ||= []
+          @reject_prebuild_pod_names ||= []
+          @explicit_prebuild_pod_names << Specification.root_name(name) if options.is_a?(Hash) && options[:binary]
+          @reject_prebuild_pod_names << Specification.root_name(name) if options.is_a?(Hash) && options.include?(:binary) && !options[:binary]
+          
+          # header search path
+          @explicit_header_search_pod_names ||= []
+          @reject_header_search_pod_names ||= []
+          @explicit_header_search_pod_names << Specification.root_name(name) if options.is_a?(Hash) && options[:framework_header_search]
+          @reject_header_search_pod_names << Specification.root_name(name) if options.is_a?(Hash) && options.include?(:framework_header_search) && !options[:framework_header_search]
+
+          options.delete(:binary) if options.is_a?(Hash)
+          options.delete(:framework_header_search) if options.is_a?(Hash)
+          requirements.pop if options.empty?
+        end
+  
+        # ---- patch method ----
+        # We want modify `store_pod` method, but it's hard to insert a line in the
+        # implementation. So we patch a method called in `store_pod`.
+        original_parse_inhibit_warnings = instance_method(:parse_inhibit_warnings)
+        define_method(:parse_inhibit_warnings) do |name, requirements|
+          detect_prebuilt_pod(name, requirements)
+          original_parse_inhibit_warnings.bind(self).call(name, requirements)
+        end
+      end
+    end
+end

data/lib/cocoapods-jxedt/binary/hooks/CocoapodsJxedtHook.rb

@@ -0,0 +1,25 @@
+require_relative '../helper/target_definition'
+
+module CocoapodsJxedtHook
+    Pod::HooksManager.register('cocoapods-jxedt', :pre_install) do |installer_context, _|
+        require_relative 'pre_install'
+        Jxedt::PreInstall.new(installer_context).run
+    end
+
+    Pod::HooksManager.register('cocoapods-jxedt', :pre_integrate) do |context, _|
+        
+    end
+
+    Pod::HooksManager.register('cocoapods-jxedt', :post_install) do |context, _|
+        require_relative 'post_install'
+        Jxedt::PostInstall.new(context).run
+    end
+
+    Pod::HooksManager.register('cocoapods-jxedt', :post_integrate) do |context, _|
+
+    end
+    
+    Pod::HooksManager.register('cocoapods-jxedt', :source_provider) do |context, _|
+
+    end
+end

data/lib/cocoapods-jxedt/binary/hooks/post_install.rb

@@ -0,0 +1,35 @@
+module Jxedt
+    class PostInstall
+        def initialize(installer_context)
+            @installer_context = installer_context
+        end
+
+        def run
+            # check binary switch
+            return unless Jxedt.config.binary_switch?
+            
+            require_relative '../helper/prebuild_sandbox'
+
+            # :post_install过程校验两次`pod install`的值
+            validate_pod_checksum unless @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
+        end
+
+        def validate_pod_checksum            
+            original_installer = ObjectSpace.each_object(Pod::Installer).reject {|installer| installer.sandbox.is_a?(Pod::PrebuildSandbox) }.first
+            return if original_installer.nil?
+
+            check_result = original_installer.lockfile == @installer_context.sandbox.source_lockfile
+            unless check_result
+                validation_failed = []
+                lockfile = original_installer.lockfile
+                source_lockfile = @installer_context.sandbox.source_lockfile
+                lockfile.internal_data["SPEC CHECKSUMS"].each_key { |name| 
+                    value1 = lockfile.spec_checksums_hash_key(name)
+                    value2 = source_lockfile.spec_checksums_hash_key(name)
+                    validation_failed << name if value1.nil? || value2.nil? || value1 != value2
+                }
+                Pod::UI.warn "Lockfile文件校验失败，请检查Pod组件: #{validation_failed}"
+            end
+        end
+    end
+end

data/lib/cocoapods-jxedt/binary/hooks/pre_install.rb

@@ -0,0 +1,61 @@
+module Pod
+    class Sandbox
+        attr_accessor :source_lockfile
+    end
+end
+
+module Jxedt
+    class PreInstall
+        include ObjectSpace
+
+        def initialize(installer_context)
+            @installer_context = installer_context
+        end
+
+        def run
+            # check binary switch
+            return unless Jxedt.config.binary_switch?
+
+            # [Check Environment]
+            podfile = @installer_context.podfile
+            podfile.target_definition_list.each do |target_definition|
+                raise STDERR.puts "[!] Cocoapods-binary requires `use_frameworks!`".red if not target_definition.uses_frameworks?
+            end
+
+            require_relative '../helper/prebuild_sandbox'
+
+            # 如果是Pod::PrebuildSandbox类则直接返回
+            return if @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
+
+            # 获取原始的installer对象，必须先获取对象
+            original_installer = ObjectSpace.each_object(Pod::Installer).first
+            sandbox = Pod::PrebuildSandbox.from_standard_sandbox(@installer_context.sandbox)
+            source_installer = Pod::Installer.new(sandbox, @installer_context.podfile, @installer_context.lockfile)
+            # 设置原始的installer携带的参数
+            source_installer.update = original_installer.update
+            source_installer.repo_update =  original_installer.repo_update
+            # 执行install
+            source_installer.install!
+
+            # 保存首次`pod install`的lockfile结果，用来验证二进制文件和后面做结果校验
+            @installer_context.sandbox.source_lockfile = sandbox.source_lockfile = source_installer.lockfile
+
+            require_relative '../helper/podfile_options'
+            require_relative '../prebuild'
+
+            # prebuild_job
+            log_section "🚀  Prebuild frameworks" if Jxedt.config.prebuild_job?
+            Jxedt::Prebuild.new(source_installer).build if Jxedt.config.prebuild_job?
+
+            log_section "🤖  Resume pod installation"
+            require_relative '../targets/pod_target'
+            require_relative '../Intergation'
+        end
+
+        def log_section(message)
+            Pod::UI.puts "-----------------------------------------"
+            Pod::UI.puts message
+            Pod::UI.puts "-----------------------------------------"
+        end
+    end
+end

data/lib/cocoapods-jxedt/binary/main.rb

@@ -0,0 +1,3 @@
+require_relative 'config'
+require_relative 'podfile_dsl'
+require_relative 'hooks/CocoapodsJxedtHook'

data/lib/cocoapods-jxedt/binary/pod-room/xcodebuild_command.rb

@@ -0,0 +1,265 @@
+require_relative "xcodebuild_raw"
+
+module Jxedt
+  class XcodebuildCommand # rubocop:disable Metrics/ClassLength
+    def initialize(options)
+      @options = options
+      case options[:targets][0].platform.name
+      when :ios
+        @options[:device] = "iphoneos"
+        @options[:simulator] = "iphonesimulator"
+      when :tvos
+        @options[:device] = "appletvos"
+        @options[:simulator] = "appletvsimulator"
+      when :watchos
+        @options[:device] = "watchos"
+        @options[:simulator] = "watchsimulator"
+      end
+      @build_args = make_up_build_args(options[:args] || {})
+    end
+
+    def run
+      sdks.each { |sdk| build_for_sdk(sdk) }
+
+      targets.each do |target|
+        if Jxedt.config.xcframework?
+          create_xcframework(target)
+        elsif sdks.count > 1
+          create_fat_framework(target)
+        else
+          collect_output(target, Dir[target_products_dir_of(target, sdks[0]) + "/*"])
+        end
+      end
+    end
+
+    private
+
+    def sdks
+      @sdks ||= begin
+        sdks_ = []
+        sdks_ << simulator if build_types.include?(:simulator)
+        sdks_ << device if build_types.include?(:device)
+        sdks_
+      end
+    end
+
+    def preferred_sdk
+      @preferred_sdk ||= sdks.include?(device) ? device : sdks[0]
+    end
+
+    def build_types
+      @build_types ||= begin
+        types = []
+        types << :simulator if simulator_build_enabled?
+        types << :device if device_build_enabled?
+        types
+      end
+    end
+
+    def make_up_build_args(args)
+      # Note: The build arguments explicitly passed from config_cocoapods_binary_cache
+      # should be preceded by the default arguments so that they could take higher priority
+      # when there are argument collisions in the xcodebuild command.
+      # For ex. `xcodebuild AN_ARG=1 AN_ARG=2` should use `AN_ARG=2` instead.
+      args_ = args.clone
+      args_[:default] ||= []
+      args_[:simulator] ||= []
+      args_[:device] ||= []
+      args_[:default].prepend("BITCODE_GENERATION_MODE=bitcode") if bitcode_enabled?
+      args_[:default].prepend("DEBUG_INFORMATION_FORMAT=dwarf") if disable_dsym?
+    #   args_[:simulator].prepend("ARCHS=x86_64", "ONLY_ACTIVE_ARCH=NO") if simulator == "iphonesimulator"
+    #   args_[:device].prepend("ONLY_ACTIVE_ARCH=NO")
+      args_[:simulator] += args_[:default]
+      args_[:device] += args_[:default]
+      args_
+    end
+
+    def build_for_sdk(sdk)
+      Jxedt::XcodebuildCommand.xcodebuild(
+        sandbox: sandbox,
+        scheme: scheme,
+        targets: targets.map(&:label),
+        configuration: configuration,
+        sdk: sdk,
+        deployment_target: targets.map { |t| t.platform.deployment_target }.max.to_s,
+        log_path: log_path(sdk),
+        args: sdk == simulator ? @build_args[:simulator] : @build_args[:device]
+      )
+    end
+
+    def create_xcframework(target)
+      non_framework_paths = Dir[target_products_dir_of(target, preferred_sdk) + "/*"] \
+        - [framework_path_of(target, preferred_sdk)] \
+        - dsym_paths_of(target, preferred_sdk) \
+        - bcsymbolmap_paths_of(target, preferred_sdk)
+      collect_output(target, non_framework_paths)
+
+      output = "#{output_path(target)}/#{target.product_module_name}.xcframework"
+      FileUtils.rm_rf(output)
+
+      cmd = ["xcodebuild", "-create-xcframework", "-allow-internal-distribution"]
+
+      # for each sdk, the order of params must be -framework then -debug-symbols
+      # to prevent duplicated file error when copying dSYMs
+      sdks.each do |sdk|
+        cmd << "-framework" << framework_path_of(target, sdk).shellescape
+
+        unless disable_dsym?
+          dsyms = dsym_paths_of(target, sdk)
+          cmd += dsyms.map { |dsym| "-debug-symbols #{dsym.shellescape}" }
+        end
+
+        if bitcode_enabled?
+          bcsymbolmaps = bcsymbolmap_paths_of(target, sdk)
+          cmd += bcsymbolmaps.map { |bcsymbolmap| "-debug-symbols #{bcsymbolmap.shellescape}" }
+        end
+      end
+
+      cmd << "-output" << output
+
+      Pod::UI.puts "- Create xcframework: #{target}".magenta unless Jxedt.config.silent_build?
+      Pod::UI.puts_indented "$ #{cmd.join(' ')}" unless Jxedt.config.silent_build?
+
+      `#{cmd.join(" ")}`
+    end
+
+    def create_fat_framework(target)
+      # When merging contents of `simulator` & `device`, prefer contents of `device` over `simulator`
+      # https://github.com/grab/cocoapods-binary-cache/issues/25
+      collect_output(target, Dir[target_products_dir_of(target, device) + "/*"])
+
+      merge_framework_binary(target)
+      merge_framework_dsym(target)
+      merge_swift_headers(target)
+      merge_swift_modules(target)
+    end
+
+    def merge_framework_binary(target)
+      merge_contents(target, "/#{target.product_module_name}", &method(:create_fat_binary))
+    end
+
+    def merge_framework_dsym(target)
+      merge_contents(
+        target,
+        ".dSYM/Contents/Resources/DWARF/#{target.product_module_name}",
+        &method(:create_fat_binary)
+      )
+    end
+
+    def merge_swift_headers(target)
+      merge_contents(target, "/Headers/#{target.product_module_name}-Swift.h") do |options|
+        merged_header = <<~HEREDOC
+          #if TARGET_OS_SIMULATOR // merged by cocoapods-binary
+          #{File.read(options[:simulator])}
+          #else // merged by cocoapods-binary
+          #{File.read(options[:device])}
+          #endif // merged by cocoapods-binary
+        HEREDOC
+        File.write(options[:output], merged_header.strip)
+      end
+    end
+
+    def merge_swift_modules(target)
+      merge_contents(target, "/Modules/#{target.product_module_name}.swiftmodule") do |options|
+        # Note: swiftmodules of `device` were copied beforehand,
+        # here, we only need to copy swiftmodules of `simulator`
+        FileUtils.cp_r(options[:simulator] + "/.", options[:output])
+      end
+    end
+
+    def merge_contents(target, path_suffix, &merger)
+      simulator_, device_, output_ = [
+        framework_path_of(target, simulator),
+        framework_path_of(target, device),
+        "#{output_path(target)}/#{target.product_module_name}.framework"
+      ].map { |p| p + path_suffix }
+      return unless File.exist?(simulator_) && File.exist?(device_)
+
+      merger.call(simulator: simulator_, device: device_, output: output_)
+    end
+
+    def create_fat_binary(options)
+      cmd = ["lipo", " -create"]
+      cmd << "-output" << options[:output]
+      cmd << options[:simulator].shellescape << options[:device].shellescape
+      `#{cmd.join(" ")}`
+    end
+
+    def collect_output(target, paths)
+      FileUtils.mkdir_p(output_path(target))
+      paths = [paths] unless paths.is_a?(Array)
+      paths.each do |path|
+        FileUtils.rm_rf(File.join(output_path(target), File.basename(path)))
+        FileUtils.cp_r(path, output_path(target))
+      end
+    end
+
+    def target_products_dir_of(target, sdk)
+      "#{build_dir}/#{configuration}-#{sdk}/#{target.name}"
+    end
+
+    def framework_path_of(target, sdk)
+      "#{target_products_dir_of(target, sdk)}/#{target.product_module_name}.framework"
+    end
+
+    def dsym_paths_of(target, sdk)
+      Dir["#{target_products_dir_of(target, sdk)}/*.dSYM"]
+    end
+
+    def bcsymbolmap_paths_of(target, sdk)
+      Dir["#{target_products_dir_of(target, sdk)}/*.bcsymbolmap"]
+    end
+
+    def sandbox
+      @options[:sandbox]
+    end
+
+    def build_dir
+      @options[:build_dir]
+    end
+
+    def output_path(target)
+      "#{@options[:output_path]}/#{target.label}"
+    end
+
+    def scheme
+      @options[:scheme]
+    end
+
+    def targets
+      @options[:targets]
+    end
+
+    def configuration
+      @options[:configuration] || "Release"
+    end
+
+    def bitcode_enabled?
+      @options[:bitcode_enabled]
+    end
+
+    def device_build_enabled?
+      @options[:device_build_enabled] || @options[:device_build_enabled].nil?
+    end
+
+    def simulator_build_enabled?
+      @options[:simulator_build_enabled] || false
+    end
+
+    def device
+      @options[:device] || "iphoneos"
+    end
+
+    def simulator
+      @options[:simulator] || "iphonesimulator"
+    end
+
+    def disable_dsym?
+      @options[:disable_dsym]
+    end
+
+    def log_path(sdk)
+      @options[:log_path].nil? ? nil : "#{@options[:log_path]}_#{sdk}"
+    end
+  end
+end

data/lib/cocoapods-jxedt/binary/pod-room/xcodebuild_raw.rb

@@ -0,0 +1,68 @@
+require "fourflusher"
+
+module Jxedt
+  class XcodebuildCommand
+    PLATFORM_OF_SDK = {
+        "iphonesimulator" => "iOS",
+        "iphoneos" => "iOS",
+        "appletvsimulator" => "tvOS",
+        "appletvos" => "tvOS",
+        "watchsimulator" => "watchOS",
+        "watchos" => "watchOS"
+    }.freeze
+  
+    DESTINATION_OF_SDK = {
+        "iphoneos" => "\"generic/platform=iOS\"",
+        "iphonesimulator" => "\"generic/platform=iOS Simulator\""
+    }.freeze
+
+    def self.xcodebuild(options)
+      sdk = options[:sdk] || "iphoneos"
+      targets = options[:targets] || [options[:target]]
+      platform = PLATFORM_OF_SDK[sdk]
+
+      cmd = ["xcodebuild"]
+      cmd << "-project" << options[:sandbox].project_path.realdirpath.shellescape
+      targets.each { |target| cmd << "-target" << target }
+      cmd << "-configuration" << options[:configuration].shellescape
+      cmd << "-sdk" << sdk
+      if DESTINATION_OF_SDK.key?(sdk)
+        cmd << "-destination" << DESTINATION_OF_SDK[sdk]
+      else
+        unless platform.nil?
+          cmd << Fourflusher::SimControl.new.destination(:oldest, platform, options[:deployment_target])
+        end
+      end
+      cmd += options[:args] if options[:args]
+      cmd += "clean" if options[:clean_build]
+      cmd << "build"
+
+      if options[:log_path].nil?
+        cmd << "2>&1"
+      else
+        FileUtils.mkdir_p(File.dirname(options[:log_path]))
+        cmd << "> #{options[:log_path].shellescape}"
+      end
+      cmd = cmd.join(" ")
+
+      Pod::UI.puts_indented "$ #{cmd}" unless Jxedt.config.silent_build?
+
+      log = `#{cmd}`
+      return if $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
+
+      begin
+        require "xcpretty" # TODO (thuyen): Revise this dependency
+        # 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
+      rescue
+        Pod::UI.puts log.red
+      ensure
+        raise "Fail to build targets: #{targets}"
+      end
+    end
+  end
+end

data/lib/cocoapods-jxedt/binary/podfile_dsl.rb

@@ -0,0 +1,26 @@
+module Pod    
+    class Podfile
+        module DSL
+            def all_binary!
+                Jxedt.config.dsl_config.merge!({'all_binary': true})
+            end
+
+            def binary_dir(dir=nil)
+                Jxedt.config.dsl_config.merge!({'binary_dir': dir})
+            end
+
+            def binary_switch(enabled=true)
+                Jxedt.config.dsl_config.merge!({'binary_switch': enabled})
+            end
+
+            def framework_header_search_enabled!
+                Jxedt.config.dsl_config.merge!({'framework_header_search_enabled': true})
+            end
+
+            def cocoapods_jxedt_config(options)
+                Jxedt.config.dsl_config.merge!(options)
+                Jxedt.config.validate_dsl_config
+            end
+        end
+    end
+end