cocoapods-pack 1.0.0

data/lib/cocoapods-pack/spec_generator.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+#
+#  Copyright 2021 Square, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+require 'cocoapods-pack/gem_version'
+require 'set'
+require 'digest'
+
+class SpecGenerator
+  ROOT_ATTRIBUTES = %w[name version summary license authors homepage description social_media_url
+                       docset_url documentation_url screenshots frameworks libraries requires_arc
+                       deployment_target xcconfig pod_target_xcconfig user_target_xcconfig source vendored_frameworks
+                       vendored_libraries resource_bundles resources preserve_paths cocoapods_version swift_versions].freeze
+  PLATFORM_ATTRIBUTES = %w[frameworks libraries requires_arc xcconfig pod_target_xcconfig user_target_xcconfig].freeze
+
+  attr_reader :podspec_path, :platforms, :artifact_repo_url
+
+  def initialize(source_podspec, artifact_repo_url, zip_output_path)
+    @podspec_path = source_podspec
+    @artifact_repo_url = artifact_repo_url
+    @zip_output_path = zip_output_path
+    @platforms = []
+  end
+
+  def generate_ruby_string
+    root_attributes = hash_to_dsl(@podspec_path.attributes_hash.merge('source' => artifact_repo_hash), ROOT_ATTRIBUTES)
+    sections = [root_attributes]
+    sections << dependency_section
+    sections.push(*platforms_sections)
+    sections_str = sections.reject(&:empty?).map do |section|
+      section.map { |lines| lines + "\n" }.join('')
+    end.join("\n")
+    "#{header}\n#{open}\n#{sections_str}#{close}\n"
+  end
+
+  def generate
+    Pod::Specification.from_string(generate_ruby_string, "#{@podspec_path.name}.podspec")
+  end
+
+  def add_platform(platform, executable_name)
+    @platforms << [platform, executable_name]
+  end
+
+  private
+
+  def platform_spec(platform, executable_name, has_one_platform)
+    ordered_keys = %w[platform source_files header_mappings_dir module_map vendored_frameworks vendored_libraries]
+    platform_attributes_hash = @podspec_path.attributes_hash[platform.name.to_s] || {}
+    platform_vendored_frameworks = Array(platform_attributes_hash['vendored_frameworks'])
+    platform_vendored_libraries = Array(platform_attributes_hash['vendored_libraries'])
+    hash = platform_spec_hash(platform.name, executable_name, platform_vendored_frameworks, platform_vendored_libraries)
+    platform_prefix = "#{platform.name}."
+    platform_section = []
+    unless has_one_platform
+      version = platform.deployment_target ? platform.deployment_target.version : nil
+      platform_section << spec_line('deployment_target', version, platform_prefix)
+    end
+    platform_section.push(*hash_to_dsl(hash, ordered_keys, platform_prefix))
+    platform_section.push(*hash_to_dsl(platform_attributes_hash, PLATFORM_ATTRIBUTES, platform_prefix)) if platform_attributes_hash
+    platform_section
+  end
+
+  def platform_spec_hash(platform_name, product_name, vendored_frameworks, vendored_libraries)
+    {
+      'vendored_frameworks' => ["#{platform_name}/#{product_name}"] + vendored_frameworks,
+      'vendored_libraries' => vendored_libraries
+    }
+  end
+
+  def platforms_sections
+    ret = []
+    has_one_platform = (@platforms.size == 1)
+    if has_one_platform
+      platform, = @platforms.first
+      ret << [spec_line('platform', platform_spec_line(platform))]
+    end
+    ret.push(*@platforms.map { |p, e| platform_spec(p, e, has_one_platform) })
+    ret
+  end
+
+  def dependency_section
+    @podspec_path.dependencies.map { |dependency| dependency_line(dependency) }
+  end
+
+  def platform_spec_line(platform)
+    return [platform.symbolic_name] unless platform.deployment_target
+
+    [platform.symbolic_name, platform.deployment_target.to_s]
+  end
+
+  def header
+    "# Generated by cocoapods-pack #{CocoapodsPack::VERSION} - Do not manually modify."
+  end
+
+  def open
+    'Pod::Spec.new do |s|'
+  end
+
+  def close
+    'end'
+  end
+
+  def artifact_repo_hash
+    { http: artifact_repo_url, sha256: Digest::SHA2.file(@zip_output_path).hexdigest }
+  end
+
+  def str(str)
+    "'#{str.gsub(/\n/, '\n')}'"
+  end
+
+  def hash_to_dsl(hash, ordered_keys, extra_prefix = '')
+    ret = []
+    ordered_keys.each do |k|
+      v = hash[k]
+      ret << spec_line(k, v, extra_prefix) unless v.nil? || v == []
+    end
+    ret
+  end
+
+  def spec_line(key, value, extra_prefix = '')
+    ['  ', 's.', extra_prefix, key.to_s, ' = ', value_of(value)].join('')
+  end
+
+  def dependency_line(dependency)
+    name = dependency.name
+    reqstr = dependency.requirement.as_list.map { |s| value_of(s) }.join(', ')
+    ['  ', 's.dependency ', value_of(name), ', ', reqstr].join('')
+  end
+
+  def value_of(value)
+    return str(quote_quotes(value)) if value.is_a?(String)
+    return value.map { |x| value_of(x) }.join(', ') if value.is_a?(Array)
+
+    quote_quotes(value.inspect)
+  end
+
+  def quote_quotes(str)
+    str.gsub(/'/, "\\\\'")
+  end
+end

data/lib/cocoapods-pack/xcode_builder.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+#
+#  Copyright 2021 Square, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+require 'cocoapods-pack/env_parser'
+require 'English'
+
+class XcodeBuilder
+  include EnvParser
+  attr_reader :xcodeproject_path, :xcodebuild_outdir, :user_interface
+
+  class BuildError < StandardError; end
+  private :user_interface
+
+  def initialize(xcodeproject_path, xcodebuild_opts, xcodebuild_outdir, user_interface, verbose = false)
+    @xcodeproject_path = xcodeproject_path
+    @xcodebuild_opts = xcodebuild_opts
+    @xcodebuild_outdir = xcodebuild_outdir
+    @user_interface = user_interface
+    @verbose = verbose
+  end
+
+  def build(platform, target, xcodebuild_args = nil)
+    return build_ios(target, xcodebuild_args) if platform == :ios
+    return build_osx(target, xcodebuild_args) if platform == :osx
+    return build_watchos(target, xcodebuild_args) if platform == :watchos
+    return build_tvos(target, xcodebuild_args) if platform == :tvos
+
+    raise "Unknown platform: '#{platform}'"
+  end
+
+  def build_settings(platform, target, type = nil)
+    return build_ios_settings(target, type) if platform == :ios
+    return build_watchos_settings(target, type) if platform == :watchos
+    return build_tvos_settings(target, type) if platform == :tvos
+
+    build_osx_settings(target) if platform == :osx
+  end
+
+  private
+
+  def verbose?
+    @verbose
+  end
+
+  def build_ios(target, xcodebuild_args)
+    user_interface.puts "\nBuilding #{target} for iOS...\n".yellow
+    run(create_build_command(target, ios_sim_args, xcodebuild_args, :simulator))
+    run(create_build_command(target, ios_device_args, xcodebuild_args, :device))
+    user_interface.puts 'iOS build successful.'.green << "\n\n"
+  end
+
+  def build_osx(target, xcodebuild_args)
+    user_interface.puts "\nBuilding #{target} for macOS...\n".yellow
+    run(create_build_command(target, macos_args, xcodebuild_args))
+    user_interface.puts 'macOS build successful.'.green << "\n\n"
+  end
+
+  def build_watchos(target, xcodebuild_args)
+    user_interface.puts "\nBuilding #{target} for watchOS...\n".yellow
+    run(create_build_command(target, watchos_sim_args, xcodebuild_args, :simulator))
+    run(create_build_command(target, watchos_device_args, xcodebuild_args, :device))
+    user_interface.puts 'watchOS build successful.'.green << "\n\n"
+  end
+
+  def build_tvos(target, xcodebuild_args)
+    user_interface.puts "\nBuilding #{target} for tvOS...\n".yellow
+    run(create_build_command(target, tvos_sim_args, xcodebuild_args, :simulator))
+    run(create_build_command(target, tvos_device_args, xcodebuild_args, :device))
+    user_interface.puts 'tvOS build successful.'.green << "\n\n"
+  end
+
+  def build_ios_settings(target, type)
+    type_args = args_for_ios_type(type)
+    command = create_build_command(target, type_args, '-showBuildSettings', type)
+    parse_build_settings(command)
+  end
+
+  def build_osx_settings(target)
+    parse_build_settings(create_build_command(target, macos_args, '-showBuildSettings'))
+  end
+
+  def build_watchos_settings(target, type)
+    type_args = args_for_watchos_type(type)
+    command = create_build_command(target, type_args, '-showBuildSettings', type)
+    parse_build_settings(command)
+  end
+
+  def build_tvos_settings(target, type)
+    type_args = args_for_tvos_type(type)
+    command = create_build_command(target, type_args, '-showBuildSettings', type)
+    parse_build_settings(command)
+  end
+
+  def parse_build_settings(command)
+    parse_env(run(command))
+  end
+
+  def args_for_ios_type(type)
+    return ios_device_args if type == :device
+    return ios_sim_args if type == :simulator
+
+    raise "Unknown type for iOS: '#{type}'"
+  end
+
+  def args_for_watchos_type(type)
+    return watchos_device_args if type == :device
+    return watchos_sim_args if type == :simulator
+
+    raise "Unknown type for watchOS: '#{type}'"
+  end
+
+  def args_for_tvos_type(type)
+    return tvos_device_args if type == :device
+    return tvos_sim_args if type == :simulator
+
+    raise "Unknown type for tvOS: '#{type}'"
+  end
+
+  def run(command)
+    user_interface.puts command if verbose?
+    output, process_status = shellout(command)
+    user_interface.puts output if verbose?
+    return output if process_status.success?
+
+    warn output
+    raise BuildError, "Failed to execute '#{command}'. Exit status: #{process_status.exitstatus}"
+  end
+
+  def shellout(command)
+    output = `#{command}`
+    [output, $CHILD_STATUS]
+  end
+
+  def create_build_command(target, sdk_args, xcodebuild_args, type = nil)
+    args = [base_args(target), sdk_args]
+    args << xcodebuild_args if !xcodebuild_args.nil? && !xcodebuild_args.strip.empty?
+    args << @xcodebuild_opts unless @xcodebuild_opts.nil?
+    args << 'archive'
+    archive_path = +"-archivePath #{xcodebuild_outdir}/#{target}"
+    archive_path << "-#{type}" if type
+    archive_path << '.xcarchive'
+    args << archive_path
+    args.join(' ')
+  end
+
+  def base_args(target)
+    "xcodebuild ONLY_ACTIVE_ARCH=NO SKIP_INSTALL=NO BUILD_LIBRARY_FOR_DISTRIBUTION=YES -project #{@xcodeproject_path}" \
+      " -scheme \"#{target}\" -configuration Release EXCLUDED_SOURCE_FILE_NAMES=*-dummy.m"
+  end
+
+  def ios_sim_args
+    '-destination "generic/platform=iOS Simulator"'
+  end
+
+  def ios_device_args
+    '-destination "generic/platform=iOS"'
+  end
+
+  def macos_args
+    '-destination "generic/platform=macOS"'
+  end
+
+  def watchos_sim_args
+    '-destination "generic/platform=watchOS Simulator"'
+  end
+
+  def watchos_device_args
+    '-destination "generic/platform=watchOS"'
+  end
+
+  def tvos_sim_args
+    '-destination "generic/platform=tvOS Simulator"'
+  end
+
+  def tvos_device_args
+    '-destination "generic/platform=tvOS"'
+  end
+end

data/lib/cocoapods-pack/zip_file_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+#
+#  Copyright 2021 Square, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+require 'zip'
+
+class ZipFileGenerator
+  def initialize(input_dir, output_file)
+    @input_dir = input_dir
+    @output_file = output_file
+  end
+
+  def write(&skip_filter_block)
+    entries = Dir.entries(@input_dir)
+    entries.delete('.')
+    entries.delete('..')
+    begin
+      io = Zip::File.open(@output_file, Zip::File::CREATE)
+      write_entries(entries, '', io, &skip_filter_block)
+    ensure
+      io.close
+    end
+  end
+
+  private
+
+  def write_entries(entries, path, io, &skip_filter_block)
+    entries.each do |e|
+      zip_file_path = path == '' ? e : File.join(path, e)
+      disk_file_path = File.join(@input_dir, zip_file_path)
+      if File.directory?(disk_file_path)
+        io.mkdir(zip_file_path)
+        subdir = Dir.entries(disk_file_path)
+        subdir.delete('.')
+        subdir.delete('..')
+        write_entries(subdir, zip_file_path, io, &skip_filter_block)
+      elsif skip_filter_block.nil? || !yield(disk_file_path)
+        io.get_output_stream(zip_file_path) { |f| f.write(IO.binread(disk_file_path)) }
+      end
+    end
+  end
+end

data/lib/cocoapods_pack.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#
+#  Copyright 2021 Square, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+require 'cocoapods-pack/gem_version'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#
+#  Copyright 2021 Square, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+require 'cocoapods-pack/command'

data/local_pod.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cocoapods'
+require 'cocoapods-pack/command'
+
+load Gem.bin_path('cocoapods', 'pod')

data/packMySample.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -o errexit
+set -o pipefail
+set -o nounset
+set -o xtrace
+
+rm -rf out/
+bundle exec ruby local_pod.rb pack --verbose --allow-warnings samples/MySample/MySample.podspec --out-dir=out https://example.com --no-repo-update $@

data/samples/CLIConsumer/CLIConsumer/dummy.swift

@@ -0,0 +1 @@
+import Foundation

data/samples/CLIConsumer/CLIConsumer/main.m

@@ -0,0 +1,10 @@
+@import Foundation;
+@import MySample;
+
+int main(int argc, const char * argv[]) {
+    @autoreleasepool {
+        NSString* str = MySample.new.print;
+        printf("%s", [[@"Calling MySample: " stringByAppendingFormat: @"%@\n", str]  UTF8String]);
+    }
+    return 0;
+}