cocoapods-util 0.0.11

data/lib/cocoapods-util/package/helper/pod_utils.rb

@@ -0,0 +1,126 @@
+module Pod
+  class Command
+    class Util < Command
+      class Package < Util
+        private
+
+        def build_static_sandbox
+          static_sandbox_root = Pathname.new(config.sandbox_root)
+          Sandbox.new(static_sandbox_root)
+        end
+
+        def install_pod(platform_name, sandbox)
+          podfile = podfile_from_spec(
+            @path,
+            @spec.name,
+            platform_name,
+            @spec.deployment_target(platform_name),
+            @subspecs,
+            @spec_sources,
+            @use_modular_headers,
+            @dependency_config
+          )
+
+          static_installer = Installer.new(sandbox, podfile)
+          static_installer.install!
+
+          unless static_installer.nil?
+            # default build settings
+            default_build_settings = Hash.new
+            default_build_settings["CLANG_MODULES_AUTOLINK"] = "NO"
+            default_build_settings["GCC_GENERATE_DEBUGGING_SYMBOLS"] = "YES" # 生成Debug编译信息
+            default_build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"] = "arm64" unless @xcframework # 非xcframework排除ios simulator 64位架构
+            default_build_settings["EXCLUDED_ARCHS[sdk=appletvsimulator*]"] = "arm64" unless @xcframework # 非xcframework排除tvos simulator 64位架构
+            default_build_settings["BUILD_LIBRARY_FOR_DISTRIBUTION"] = "YES" # 编译swift生成swiftinterface文件
+            
+            # merge user setting
+            default_build_settings.merge!(@build_settings) unless @build_settings.empty?
+
+            static_installer.pods_project.targets.each do |target|
+              target.build_configurations.each do |config|
+                default_build_settings.each { |key, value| config.build_settings[key.to_s] = value.to_s }
+              end
+            end
+            static_installer.pods_project.save
+          end
+
+          static_installer
+        end
+
+        def podfile_from_spec(path, spec_name, platform_name, deployment_target, subspecs, sources, use_modular_headers, dependency_config)
+          options = {}
+          if path
+            if @local
+              options[:path] = path
+            else
+              options[:podspec] = path
+            end
+          end
+          options[:subspecs] = subspecs if subspecs
+          Pod::Podfile.new do
+            sources.each { |s| source s }
+            platform(platform_name, deployment_target)
+            pod(spec_name, options) unless dependency_config.keys.include?(spec_name)
+            
+            dependency_config.each do |name, config|
+              dependency_options = {}
+              config.each do |key, value|
+                dependency_options[key.to_sym] = value
+              end
+              pod(name, dependency_options)
+            end
+
+            use_modular_headers! if use_modular_headers
+            install!('cocoapods',
+                    :integrate_targets => false,
+                    :deterministic_uuids => false)
+
+            target('packager') do
+              inherit! :complete
+            end
+          end
+        end
+
+        def binary_only?(spec)
+          deps = spec.dependencies.map { |dep| spec_with_name(dep.name) }
+          [spec, *deps].each do |specification|
+            %w(vendored_frameworks vendored_libraries).each do |attrib|
+              if specification.attributes_hash[attrib]
+                return true
+              end
+            end
+          end
+
+          false
+        end
+
+        def spec_with_name(name)
+          return if name.nil?
+
+          set = Pod::Config.instance.sources_manager.search(Dependency.new(name))
+          return nil if set.nil?
+
+          set.specification.root
+        end
+
+        def spec_with_path(path)
+          return if path.nil? || !Pathname.new(path).exist?
+
+          @path = Pathname.new(path).expand_path
+
+          if @path.directory?
+            help! @path + ': is a directory.'
+            return
+          end
+
+          unless ['.podspec', '.json'].include? @path.extname
+            help! @path + ': is not a podspec.'
+            return
+          end
+
+          Specification.from_file(@path)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-util/package/package.rb

@@ -0,0 +1,177 @@
+require 'cocoapods-util/package/helper/pod_utils'
+require 'cocoapods-util/package/helper/builder'
+require 'cocoapods-util/package/helper/framework'
+
+require 'tmpdir'
+require 'json'
+
+module Pod
+  class Command
+    class Util < Command
+        class Package < Util
+            self.summary = '通过podspec编译静态库（library/framework/xcframework）'
+            self.description = "本插件属于在cocoapods-packager的基础上做的修改，支持编译swift。另外支持use_modular_headers!、排除模拟器、排除特定架构、编译xcframework等。"
+            self.arguments = [
+              CLAide::Argument.new('NAME', true),
+              CLAide::Argument.new('SOURCE', false)
+            ]
+    
+            def self.options
+              [
+                ['--force',     'Overwrite existing files.'],
+                ['--library',   'Generate static library.'],
+                ['--framework',   'Generate static framework.'],
+                ['--xcframework',   'Generate static xcframework.'],
+                ['--local',     'Use local state rather than published versions.'],
+                ['--configuration', 'Build the specified configuration (e.g. Debug). Defaults to Release'],
+                ['--subspecs', 'Only include the given subspecs'],
+                ['--spec-sources=private,https://github.com/CocoaPods/Specs.git', 'The sources to pull dependent ' \
+                  'pods from (defaults to https://github.com/CocoaPods/Specs.git)'],
+                ['--exclude-sim', '排除模拟器架构，仅编译真机对应的架构。'],
+                ['--use-modular-headers', '开启use_modular_headers!'],
+                ['--dependency-config={}', '依赖的pod文件配置，为一个json dictionary，可以配置branch、tag、source源等。配置方式：{"PodA":{"git":"xxx","branch":"xxx"},"PodB":{"source":"xxx"}}'],
+                ['--contains-resources', '生成的framework中是否包含bundle文件，默认不把bundle文件放到framework中。'],
+                ['--platforms=ios,osx,watchos,tvos,all', '选择编译的平台架构，默认`all`，编译全部平台。'],
+                ['--build-settings={}', 'xcode build_settings。{"EXCLUDED_ARCHS[sdk=iphonesimulator*]":"arm64"}']
+              ]
+            end
+    
+            def initialize(argv)
+              @framework = argv.flag?('framework')
+              @xcframework = argv.flag?('xcframework')
+              @library = argv.flag?('library')
+              @local = argv.flag?('local', false)
+              @package_type = if @xcframework
+                                :static_xcframework
+                              elsif @framework
+                                :static_framework
+                              elsif @library
+                                :static_library
+                              else
+                                :static_library
+                              end
+              @force = argv.flag?('force')
+              @exclude_sim = argv.flag?('exclude-sim', false)
+              @use_modular_headers = argv.flag?('use-modular-headers', false)
+              @name = argv.shift_argument
+              @source = argv.shift_argument
+              @spec_sources = argv.option('spec-sources', 'https://github.com/CocoaPods/Specs.git').split(',')
+    
+              subspecs = argv.option('subspecs')
+              @subspecs = subspecs.split(',') unless subspecs.nil?
+    
+              @framework_contains_resources = argv.flag?('contains-resources', false)
+              @platforms = argv.option('platforms', 'all')
+              @build_settings = JSON.parse(argv.option('build-settings', '{}'))
+    
+              dependency_config = argv.option('dependency-config', '{}')
+              @dependency_config = JSON.parse(dependency_config)
+    
+              @config = argv.option('configuration', 'Release')
+    
+              @source_dir = Dir.pwd
+              @is_spec_from_path = false
+              @spec = spec_with_path(@name)
+              @is_spec_from_path = true if @spec
+              @spec ||= spec_with_name(@name)
+              super
+            end
+    
+            def validate!
+              super
+              help! 'A podspec name or path is required.' unless @spec
+              help! '--local option can only be used when a local `.podspec` path is given.' if @local && !@is_spec_from_path
+              help! '编译静态库.a不允许设置包含resources' if !(@framework || @xcframework) && @framework_contains_resources
+            end
+    
+            def run
+              if @spec.nil?
+                help! 'Unable to find a podspec with path or name.'
+                return
+              end
+    
+              target_dir, work_dir = create_working_directory
+              return if target_dir.nil?
+              build_package
+    
+              `mv "#{work_dir}" "#{target_dir}"`
+              Dir.chdir(@source_dir)
+            end
+    
+            private
+    
+            def build_in_sandbox(platform)
+              config.installation_root  = Pathname.new(Dir.pwd)
+              config.sandbox_root       = 'Pods'
+    
+              static_sandbox = build_static_sandbox()
+              static_installer = install_pod(platform.name, static_sandbox)
+    
+              begin
+                perform_build(platform, static_sandbox, static_installer)
+              ensure # in case the build fails; see Builder#xcodebuild.
+                Pathname.new(config.sandbox_root).rmtree
+                FileUtils.rm_f('Podfile.lock')
+                # clean build
+                FileUtils.rm_rf('build')
+              end
+            end
+    
+            def build_package
+              platforms = @platforms.split(',')
+              all_platforms = platforms.include?('all')
+              @spec.available_platforms.each do |platform|
+                if all_platforms || platforms.include?(platform.name.to_s)
+                  build_in_sandbox(platform)
+                end
+              end
+            end
+    
+            def create_target_directory
+              target_dir = "#{@source_dir}/#{@spec.name}-#{@spec.version}"
+              if File.exist? target_dir
+                if @force
+                  Pathname.new(target_dir).rmtree
+                else
+                  UI.puts "Target directory '#{target_dir}' already exists."
+                  return nil
+                end
+              end
+              target_dir
+            end
+    
+            def create_working_directory
+              target_dir = create_target_directory
+              return if target_dir.nil?
+    
+              work_dir = Dir.tmpdir + '/cocoapods-' + Array.new(8) { rand(36).to_s(36) }.join
+              UI.puts "work_dir: #{work_dir}" if @verbose
+              Pathname.new(work_dir).mkdir
+              Dir.chdir(work_dir)
+    
+              [target_dir, work_dir]
+            end
+    
+            def perform_build(platform, static_sandbox, static_installer)
+              static_sandbox_root = config.sandbox_root.to_s
+    
+              builder = Pod::Builder.new(
+                platform,
+                static_installer,
+                @source_dir,
+                static_sandbox_root,
+                static_sandbox.public_headers.root,
+                @spec,
+                @config,
+                @exclude_sim,
+                @framework_contains_resources,
+                @verbose
+              )
+    
+              builder.build(@package_type)
+            end
+        end
+    end
+  end
+end
+

data/lib/cocoapods-util/user_interface/build_failed_report.rb

@@ -0,0 +1,15 @@
+module Pod
+  module UserInterface
+    module BuildFailedReport
+      class << self
+        def report(command, output)
+          <<-EOF
+Build command failed: #{command}
+Output:
+#{output.map { |line| "    #{line}" }.join}
+          EOF
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-util/xcframework/xcframework.rb

@@ -0,0 +1,66 @@
+require 'cocoapods-util/xcframework/xcramework_build.rb'
+
+module Pod
+    class Command
+      class Util < Command
+          class XCFramework < Util
+              self.summary = '根据传入framework在同目录下生成xcframework'
+              self.description = <<-DESC
+              根据传入framework在同目录下生成xcframework
+              DESC
+              self.command = 'xcframework'
+              self.arguments = [
+                CLAide::Argument.new('FRAMEWORK_PATH', true)
+              ]
+      
+              def self.options
+                [
+                  ['--force',   '覆盖已经存在的文件'],
+                  ['--create-swiftinterface', '有编译swift文件的framework，如果不包含swiftinterface则无法生成xcframework。
+                    设置该参数会生成一个swiftinterface文件解决create失败的问题。']
+                ]
+              end
+      
+              def initialize(argv)
+                @file_path = argv.shift_argument
+                @force = argv.flag?('force')
+                @create_swiftinterface = argv.flag?('create-swiftinterface')
+                super
+              end
+      
+              def validate!
+                super
+                help! '必须传入framework路径或名称.' unless @file_path
+              end
+      
+              def run
+                # 获取真实路径，~ 为进程所有者的主目录
+                @file_path = File.expand_path(@file_path)
+                if !File.exist?(@file_path) || !(@file_path =~ /\.framework$/)
+                  help! "路径不存在或传入的路径不是framework文件"
+                  return
+                end
+
+                source_dir = File.dirname(@file_path)
+                framework_name = File.basename(@file_path, ".framework")
+
+                target_dir = "#{source_dir}/#{framework_name}.xcframework"
+                if File.exist?(target_dir)
+                  if @force
+                    Pathname.new(target_dir).rmtree
+                  else
+                    help! "#{target_dir}已经存在，使用`--force`可以覆盖已有文件"
+                  end
+                end
+                
+                builder = XCFrameworkBuilder.new(
+                  framework_name,
+                  source_dir,
+                  @create_swiftinterface
+                )
+                builder.build_static_xcframework
+              end
+          end
+      end
+    end
+  end

data/lib/cocoapods-util/xcframework/xcramework_build.rb

@@ -0,0 +1,133 @@
+module Pod
+    class XCFrameworkBuilder
+        def initialize(name, source_dir, create_swiftinterface)
+            @name = name
+            @source_dir = source_dir
+            @create_swiftinterface = create_swiftinterface
+        end
+
+        def build_static_xcframework
+            framework_path = "#{@source_dir}/#{@name}.framework"
+            # 可执行文件名称
+            lib_file = "#{@name}"
+            # 可执行文件完整路径
+            lib_path = "#{framework_path}/#{lib_file}"
+            # 可执行文件不存在，退出
+            unless File.exist? lib_path
+                UI.puts("没有找到可执行文件，请检查输入的framework")
+                return nil
+            end
+            # 如果可执行文件为软链接类型，获取realpath
+            if File.ftype(lib_path) == 'link'
+                lib_file = File.readlink(lib_path) 
+                lib_path = "#{framework_path}/#{lib_file}"
+            end
+
+            framework_paths = Array.new
+            # 获取可执行文件的支持架构
+            archs = `lipo -archs #{lib_path}`.split
+            os_archs = sim_archs = []
+            if archs.empty?
+                UI.puts "framework文件中没有检查到任何编译架构，请使用`lipo -info`或`lipo -archs`检查文件支持的架构。"
+                return
+            elsif archs.count == 1
+                framework_paths += [framework_path]
+            else
+                platform = `strings #{lib_path} | grep -E -i '/Platforms/.*\.platform/' | head -n 1`.chomp!
+                if platform =~ /iPhone[^\.]*\.platform/ # iphoneos iphonesimulator
+                    os_archs = archs & ['arm64', 'armv7', 'armv7s']
+                    sim_archs = archs & ['i386', 'x86_64']
+                elsif platform =~ /MacOSX.platform/ # macosx
+                    os_archs = ['arm64', 'x86_64']
+                elsif platform =~ /Watch[^\.]*\.platform/ # watchos watchsimulator
+                    os_archs = archs & ['armv7k', 'arm64_32']
+                    sim_archs = archs & ['arm64', 'i386', 'x86_64']
+                elsif platform =~ /AppleTV[^\.]*\.platform/ # appletvos appletvsimulator
+                    os_archs = archs & ['arm64']
+                    sim_archs = archs & ['x86_64'] # 'arm64' 'x86_64'
+                else
+                    os_archs = archs & ['arm64', 'armv7', 'armv7s']
+                    sim_archs = archs & ['i386', 'x86_64']
+                end
+            end
+    
+            # 1. remove os/simulator paths
+            clean_intermediate_path
+
+            # 2. copy os framework
+            if os_archs.count > 0
+                path = Pathname.new("#{@source_dir}/#{os_target_path}")
+                path.mkdir unless path.exist?
+                `cp -a #{framework_path} #{path}/`
+        
+                fwk_path = "#{path}/#{@name}.framework"
+                framework_paths += ["#{fwk_path}"]
+                `lipo -extract #{os_archs.join(' -extract ')} "#{fwk_path}/#{lib_file}" -output "#{fwk_path}/#{lib_file}"`
+            end
+            # 3. copy simulation framework
+            if sim_archs.count > 0
+                path = Pathname.new("#{@source_dir}/#{simulator_target_path}")
+                path.mkdir unless path.exist?
+                `cp -a #{framework_path} #{path}/`
+
+                fwk_path = "#{path}/#{@name}.framework"
+                framework_paths += ["#{fwk_path}"]
+                `lipo -extract #{sim_archs.join(' -extract ')} "#{fwk_path}/#{lib_file}" -output "#{fwk_path}/#{lib_file}"`
+            end
+
+            # 4. generate xcframework
+            begin
+                generate_xcframework(framework_paths)
+            ensure # in case the create-xcframework fails; remove the temp directory.
+                clean_intermediate_path
+            end
+        end
+
+        def generate_xcframework(framework_paths)
+            UI.puts("Generate #{@name}.xcframework")
+
+            framework_paths.each { |framework_path|
+                # check_swiftmodule
+                swiftmodule_path = Dir.glob("#{framework_path}/Modules/*.swiftmodule").first
+                unless swiftmodule_path.nil?
+                    if Dir.glob("#{swiftmodule_path}/*.swiftinterface").empty?
+                        unless @create_swiftinterface
+                            UI.puts "Framework中包含swiftmodule文件，但是没有swiftinterface，无法创建xcframework，请检查Framework文件。或者使用`--create-swiftinterface`参数"
+                            return
+                        end
+                        arm_swiftinterface = Pathname.new("#{swiftmodule_path}/arm.swiftinterface")
+                        File.new(arm_swiftinterface, "w+").close
+                    end
+                end
+            }
+
+            # build xcframework
+            command = "xcodebuild -create-xcframework -framework #{framework_paths.join(' -framework ')} -output #{@source_dir}/#{@name}.xcframework 2>&1"
+            output = `#{command}`.lines.to_a
+            result = $?
+            # show error
+            if result.exitstatus != 0
+                puts UI::BuildFailedReport.report(command, output)
+                Process.exit
+            end
+            UI.puts("Generate #{@name}.xcframework succees")
+        end
+
+        private
+        def clean_intermediate_path
+            [os_target_path, simulator_target_path].each do |path|
+                file_path = "#{@source_dir}/#{path}"
+                if File.exist? file_path
+                    FileUtils.rm_rf(file_path)
+                end
+            end
+        end
+
+        def os_target_path
+            "#{@name}_temp_os"
+        end
+        def simulator_target_path
+            "#{@name}_temp_simulator"
+        end
+    end
+end

data/lib/cocoapods-util.rb

@@ -0,0 +1 @@
+require 'cocoapods-util/gem_version'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,3 @@
+require 'cocoapods-util/command'
+require 'cocoapods-util/user_interface/build_failed_report.rb'
+require 'cocoapods-util/CocoapodsUtilHook.rb'

data/spec/command/util_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Util do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ util }).should.be.instance_of Command::Util
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#