Rakefile

#
# Copyright (c) 2017-2020 PSPDFKit GmbH. All rights reserved.
#
# The PDFXKit is licensed with a modified BSD license. Please see License for
# details. This notice may not be removed from this file.
#
# General Guidelines
# ------------------
#
# Try to avoid file and directory names containing *spaces*.
#
# On the other hand, *quote* every file and directory reference when passing
# it to a command if the reference *might* contain a space.
#
# Avoid encapsulating parts of the build script into functions. As a rule of
# thumb: no function other than `run` should call a shell command (exception:
# generic one-liners to check something for example) and no function should
# call the `run` function itself, `run` is only intended to be used at the task
# level.
#
# Keep intermediate results. If you need to modify a previous result, copy it
# first. This will ease debugging if something goes wrong and allows you to
# comment out certain stages of the script to save time when working on it.
#
# When working within a deep-ish path, consider cd-ing into the directory first.
# You have to do this for each run call, simply prepend your actual command
# with something like `cd some/deep/directory/; ...`. Do *not* change the
# working directory for the whole script though (using Ruby's `File.chdir` &
# friends).

# Naming Conventions: Constants
# -----------------------------
#
# * A directory name is suffixed with `_DIRECTORY`
# * A file's base name constant is suffixed with `_NAME`
# * A file's full name including extension is suffixed with `_FILE`
# * A full file or directory path (absolute & relative) is suffixed with `_PATH`
# * A directory path should *not* end with a slash `/`
#
# Try to avoid full path constants because it becomes really difficult to read
# and understand the build script, i.e. what file or directory is referenced or
# created and where.

require 'rubygems'

# --------------------------------------------------------------- Options ------

NAME = ENV['name'] || ""
DIRECTORY = File.expand_path(ENV['directory'] || "Build")
VERBOSE = ENV['verbose'] || false

# ------------------------------------------------------------- Constants ------

XCODE_FLAGS = "-configuration Release -scheme PDFXKit archive SKIP_INSTALL=NO"
ARCHIVE_PATH_SIMULATOR = "\"#{DIRECTORY}\"/Xcode/Archives/PDFXKit.framework-ios-arm64_x86_64-simulator.xcarchive"
ARCHIVE_PATH_DEVICE = "\"#{DIRECTORY}\"/Xcode/Archives/PDFXKit.framework-ios-arm64.xcarchive"
ARCHIVE_PATH_MAC_CATALYST = "\"#{DIRECTORY}\"/Xcode/Archives/PDFXKit.framework-ios-x86_64-maccatalyst.xcarchive"

# ---------------------------------------------------------------- Colors ------

TERMINAL = STDOUT.tty?

BOLD = TERMINAL ? "\x1B[0;1m" : ""
RESET = TERMINAL ? "\x1B[0m" : ""

BLACK = TERMINAL ? "\x1B[0;30m" : ""; RED = TERMINAL ? "\x1B[0;31m" : ""; GREEN = TERMINAL ? "\x1B[0;32m" : ""; YELLOW = TERMINAL ? "\x1B[0;33m" : ""; BLUE = TERMINAL ? "\x1B[0;34m" : ""; MAGENTA = TERMINAL ? "\x1B[0;35m" : ""; CYAN = TERMINAL ? "\x1B[0;36m" : ""; WHITE = TERMINAL ? "\x1B[0;37m" : ""
BLACK_BRIGHT = TERMINAL ? "\x1B[1;30m" : ""; RED_BRIGHT = TERMINAL ? "\x1B[1;31m" : ""; GREEN_BRIGHT = TERMINAL ? "\x1B[1;32m" : ""; YELLOW_BRIGHT = TERMINAL ? "\x1B[1;33m" : ""; BLUE_BRIGHT = TERMINAL ? "\x1B[1;34m" : ""; MAGENTA_BRIGHT = TERMINAL ? "\x1B[1;35m" : ""; CYAN_BRIGHT = TERMINAL ? "\x1B[1;36m" : ""; WHITE_BRIGHT = TERMINAL ? "\x1B[1;37m" : ""

OK = GREEN + "OK" + RESET
FAILED = RED + "FAILED" + RESET
SKIPPED = YELLOW + "SKIPPED" + RESET

ERROR = RED + "Error:" + RESET
WARNING = YELLOW + "Warning:" + RESET

# ----------------------------------------------------------------- Tasks ------

desc "Archive PDFXKit (simulator)"
task 'compile:simulator' => [:prepare] do
  tell "Archiving PSPDFKit (simulator)"
  run "xcrun xcodebuild -destination 'generic/platform=iOS Simulator' -archivePath #{ARCHIVE_PATH_SIMULATOR} #{XCODE_FLAGS}", :time => true, :quiet => true
end

desc "Archive PDFXKit (device)"
task 'compile:device' => [:prepare] do
  tell "Archiving PSPDFKit (device)"
  run "xcrun xcodebuild -destination 'generic/platform=iOS' -archivePath #{ARCHIVE_PATH_DEVICE} #{XCODE_FLAGS}", :time => true, :quiet => true
end

desc "Archive PDFXKit (Mac Catalyst)"
task 'compile:catalyst' => [:prepare] do
  tell "Archiving PSPDFKit (Mac Catalyst)"
  run "xcrun xcodebuild -destination 'platform=macOS,arch=x86_64,variant=Mac Catalyst' -archivePath #{ARCHIVE_PATH_MAC_CATALYST} #{XCODE_FLAGS}", :time => true, :quiet => true
end

desc "Creating the PDFXKit XCFramework"
task :compile  => ['clean', 'compile:simulator', 'compile:device', 'compile:catalyst'] do
  tell "Creating the PDFXKit XCFramework"
  uuids = uuid("#{ARCHIVE_PATH_DEVICE}/Products/Library/Frameworks/PDFXKit.framework/PDFXKit")
  uuid = uuids["arm64"]
  bcsymbolmap = "#{uuid}.bcsymbolmap"
  run "xcodebuild -create-xcframework -framework #{ARCHIVE_PATH_SIMULATOR}/Products/Library/Frameworks/PDFXKit.framework -debug-symbols #{ARCHIVE_PATH_SIMULATOR}/dSYMs/PDFXKit.framework.dSYM -framework #{ARCHIVE_PATH_DEVICE}/Products/Library/Frameworks/PDFXKit.framework -debug-symbols #{ARCHIVE_PATH_DEVICE}/dSYMs/PDFXKit.framework.dSYM -debug-symbols #{ARCHIVE_PATH_DEVICE}/BCSymbolMaps/#{bcsymbolmap} -framework #{ARCHIVE_PATH_MAC_CATALYST}/Products/Library/Frameworks/PDFXKit.framework -debug-symbols #{ARCHIVE_PATH_MAC_CATALYST}/dSYMs/PDFXKit.framework.dSYM -output #{DIRECTORY}/PDFXKit.xcframework"
end

desc "show help"
task :help do
  run "rake -T", :silent => true
end

task :clean do
  tell "Cleaning"
  run "rm -rf #{DIRECTORY}", :log => false
end

task :prepare do
  tell "Preparing"
  run "mkdir -p #{DIRECTORY}", :log => false
end

# ----------------------------------------------------------- Functions ------

def assert(condition, message = "")
  unless condition
    puts message + "\n\n"
    exit 1
  end
end

def check(condition)
  unless condition
    puts FAILED
    exit 1
  end
end

def run(command, options = {})
  system_options = {}
  system_options[:out] = File::NULL if options[:quiet] && !VERBOSE
  system_options[:err] = File::NULL if options[:quiet] && !VERBOSE

  success = false

  duration = measure do
    success = system("set -e; set -u; set -o pipefail; #{command}", system_options)
    check success unless options[:survive]
  end

  puts "Finished in #{duration}" if options[:time]
  success
end

def uuid(binary)
  # dwarfdump output:
  # UUID: 9EF74434-5B52-377F-BE1F-10D2C4F66BD1 (arm64) Build/Xcode/Archives/PDFXKit.framework-ios-arm64.xcarchive/Products/Library/Frameworks/PDFXKit.framework/PDFXKit
  dwarfdump = %x[dwarfdump -u #{binary}].lines
  uuids = dwarfdump.map { |line| line.split[1] }
  archs = dwarfdump.map do |line|
    archs = line.split[2]
    # Remove brackets by removing first and last character
    archs[1..-2]
  end

  # Use architectures as keys and UUIDs as values
  Hash[archs.zip(uuids)]
end

def put(string)
  print(string)
  STDOUT.flush
end

def log(message)
  puts message if VERBOSE
end

def tell(message)
  puts "#{BLUE}==>#{RESET} #{WHITE}#{message}#{RESET}"
end

def ask(message)
  put message + " [y/n] "
  answer = STDIN.getc
  puts "\n"
  %w[y n].include?(answer) ? answer : ask(message)
end

def read(file_path)
  File.open(file_path, "r", &:read)
end

def write(file_path, string)
  log "Writing file: #{file_path}"
  File.open(file_path, "w") { |file| file.write string }
end

def replace(string, with:, in:)
  file_path = binding.local_variable_get(:in)
  content = read file_path
  content.gsub!(string, with)
  write file_path, content
end

def measure
  start_time = Time.new
  yield
  end_time = Time.new
  duration(end_time - start_time)
end

def duration(total_seconds)
  hours = (total_seconds / 60.0 / 60.0).floor
  minutes = (total_seconds / 60.0 - hours * 60.0).floor
  seconds = (total_seconds - hours * 60.0 * 60.0 - minutes * 60.0).round

  duration = "#{seconds} seconds"
  duration = "#{minutes} minutes, #{duration}" if minutes.positive? || hours.positive?
  duration = "#{hours} hours, #{duration}" if hours.positive?

  duration
end

def invoke(task, *arguments)
  Rake::Task[task].invoke(*arguments)
end