cocoapods-binary-ht 1.0.0

data/lib/command/config.rb

@@ -0,0 +1,215 @@
+require_relative "../cocoapods-binary-ht/helper/json"
+
+module PodPrebuild
+  def self.config
+    PodPrebuild::Config.instance
+  end
+
+  class Config # rubocop:disable Metrics/ClassLength
+    attr_accessor :dsl_config, :cli_config
+
+    def initialize(path)
+      @deprecated_config = File.exist?(path) ? PodPrebuild::JSONFile.new(path).data : {}
+      @dsl_config = {}
+      @cli_config = {}
+      @detected_config = {}
+    end
+
+    def self.instance
+      @instance ||= new("PodBinaryCacheConfig.json")
+    end
+
+    def reset!
+      @deprecated_config = {}
+      @dsl_config = {}
+      @cli_config = {}
+    end
+
+    def cache_repo
+      @cache_repo ||= cache_repo_config["remote"]
+    end
+
+    def local_cache?
+      cache_repo.nil?
+    end
+
+    def cache_path
+      @cache_path ||= File.expand_path(cache_repo_config["local"])
+    end
+
+    def prebuild_sandbox_path
+      @dsl_config[:prebuild_sandbox_path] || @deprecated_config["prebuild_path"] || "_Prebuild"
+    end
+
+    def prebuild_delta_path
+      @dsl_config[:prebuild_delta_path] || @deprecated_config["prebuild_delta_path"] || "_Prebuild_delta/changes.json"
+    end
+
+    def manifest_path(in_cache: false)
+      root_dir(in_cache) + "/Manifest.lock"
+    end
+
+    def root_dir(in_cache)
+      in_cache ? cache_path : prebuild_sandbox_path
+    end
+
+    def generated_frameworks_dir(in_cache: false)
+      root_dir(in_cache) + "/GeneratedFrameworks"
+    end
+
+    def prebuilt_path(path: nil)
+      p = Pathname.new(path.nil? ? "_Prebuilt" : "_Prebuilt/#{path}")
+      p = p.sub_ext(".xcframework") if xcframework? && p.extname == ".framework"
+      p.to_s
+    end
+
+    def validate_dsl_config
+      inapplicable_options = @dsl_config.keys - applicable_dsl_config
+      return if inapplicable_options.empty?
+
+      message = <<~HEREDOC
+        [WARNING] The following options (in `config_cocoapods_binary_cache`) are not correct: #{inapplicable_options}.
+        Available options: #{applicable_dsl_config}.
+        Check out the following doc for more details
+          https://github.com/pandaleecn/cocoapods-binary-ht/blob/master/docs/configure_cocoapods_binary_cache.md
+      HEREDOC
+
+      Pod::UI.puts message.yellow
+    end
+
+    def prebuild_config
+      @cli_config[:prebuild_config] || @dsl_config[:prebuild_config] || "Debug"
+    end
+
+    def prebuild_job?
+      @cli_config[:prebuild_job] || @dsl_config[:prebuild_job]
+    end
+
+    def prebuild_all_pods?
+      @cli_config[:prebuild_all_pods] || @dsl_config[:prebuild_all_pods]
+    end
+
+    def excluded_pods
+      ((@dsl_config[:excluded_pods] || Set.new) + (@detected_config[:excluded_pods] || Set.new)).to_set
+    end
+
+    def dev_pods_enabled?
+      @dsl_config[:dev_pods_enabled]
+    end
+
+    def bitcode_enabled?
+      @dsl_config[:bitcode_enabled]
+    end
+
+    def device_build_enabled?
+      @dsl_config[:device_build_enabled]
+    end
+
+    def xcframework?
+      @dsl_config[:xcframework]
+    end
+
+    def disable_dsym?
+      @dsl_config[:disable_dsym]
+    end
+
+    def dont_remove_source_code?
+      @dsl_config[:dont_remove_source_code]
+    end
+
+    def xcodebuild_log_path
+      @dsl_config[:xcodebuild_log_path]
+    end
+
+    def build_args
+      @dsl_config[:build_args]
+    end
+
+    def save_cache_validation_to
+      @dsl_config[:save_cache_validation_to]
+    end
+
+    def validate_prebuilt_settings
+      @dsl_config[:validate_prebuilt_settings]
+    end
+
+    def prebuild_code_gen
+      @dsl_config[:prebuild_code_gen]
+    end
+
+    def strict_diagnosis?
+      @dsl_config[:strict_diagnosis]
+    end
+
+    def silent_build?
+      @dsl_config[:silent_build]
+    end
+
+    def targets_to_prebuild_from_cli
+      @cli_config[:prebuild_targets] || []
+    end
+
+    def update_detected_prebuilt_pod_names!(value)
+      @detected_config[:prebuilt_pod_names] = value
+    end
+
+    def update_detected_excluded_pods!(value)
+      @detected_config[:excluded_pods] = value
+    end
+
+    def prebuilt_pod_names
+      @detected_config[:prebuilt_pod_names] || Set.new
+    end
+
+    def tracked_prebuilt_pod_names
+      prebuilt_pod_names - excluded_pods
+    end
+
+    private
+
+    def applicable_dsl_config
+      [
+        :cache_repo,
+        :prebuild_sandbox_path,
+        :prebuild_delta_path,
+        :prebuild_config,
+        :prebuild_job,
+        :prebuild_all_pods,
+        :excluded_pods,
+        :dev_pods_enabled,
+        :bitcode_enabled,
+        :device_build_enabled,
+        :xcframework,
+        :disable_dsym,
+        :dont_remove_source_code,
+        :xcodebuild_log_path,
+        :build_args,
+        :save_cache_validation_to,
+        :validate_prebuilt_settings,
+        :prebuild_code_gen,
+        :strict_diagnosis,
+        :silent_build
+      ]
+    end
+
+    def cache_repo_config
+      @cache_repo_config ||= begin
+        repo = @cli_config[:repo] || "default"
+        config_ = @dsl_config[:cache_repo] || {}
+        if config_[repo].nil?
+          message = <<~HEREDOC
+            [Deprecated] Configs in `PodBinaryCacheConfig.json` are deprecated.
+            Declare option `cache_repo` in `config_cocoapods_binary_cache` instead.
+            Check out the following doc for more details
+              https://github.com/pandaleecn/cocoapods-binary-ht/blob/master/docs/configure_cocoapods_binary_cache.md
+          HEREDOC
+          Pod::UI.puts message.yellow
+        end
+        config_[repo] || {
+          "remote" => @deprecated_config["cache_repo"] || @deprecated_config["prebuilt_cache_repo"],
+          "local" => @deprecated_config["cache_path"] || "~/.cocoapods-binary-ht/prebuilt-frameworks"
+        }
+      end
+    end
+  end
+end

data/lib/command/executor/base.rb

@@ -0,0 +1,37 @@
+module PodPrebuild
+  class CommandExecutor
+    def initialize(options)
+      @config = options[:config]
+      prepare_cache_dir
+    end
+
+    def installer
+      @installer ||= begin
+        pod_config = Pod::Config.instance
+        Pod::Installer.new(pod_config.sandbox, pod_config.podfile, pod_config.lockfile)
+      end
+    end
+
+    def use_local_cache?
+      @config.cache_repo.nil?
+    end
+
+    def prepare_cache_dir
+      FileUtils.mkdir_p(@config.cache_path) if @config.cache_path
+    end
+
+    def git(cmd, options = {})
+      comps = ["git"]
+      comps << "-C" << @config.cache_path unless options[:cache_repo] == false
+      comps << cmd
+      comps << "&> /dev/null" if options[:ignore_output]
+      comps << "|| true" if options[:can_fail]
+      cmd = comps.join(" ")
+      raise "Fail to run command '#{cmd}'" unless system(cmd)
+    end
+
+    def git_clone(cmd, options = {})
+      git("clone #{cmd}", options.merge(:cache_repo => false))
+    end
+  end
+end

data/lib/command/executor/fetcher.rb

@@ -0,0 +1,67 @@
+require "parallel"
+require_relative "base"
+require_relative "../helper/zip"
+
+module PodPrebuild
+  class CacheFetcher < CommandExecutor
+    attr_reader :cache_branch
+
+    def initialize(options)
+      super(options)
+      @cache_branch = options[:cache_branch]
+    end
+
+    def run
+      Pod::UI.step("Fetching cache") do
+        if @config.local_cache?
+          print_message_for_local_cache(@config.cache_path)
+        else
+          fetch_remote_cache(@config.cache_repo, @cache_branch, @config.cache_path)
+        end
+        unzip_cache
+      end
+    end
+
+    private
+
+    def print_message_for_local_cache(cache_dir)
+      Pod::UI.puts "You're using local cache at: #{cache_dir}.".yellow
+      message = <<~HEREDOC
+        To enable remote cache (with a git repo), add the `remote` field to the repo config in the `cache_repo` option.
+        For more details, check out this doc:
+          https://github.com/pandaleecn/cocoapods-binary-ht/blob/master/docs/configure_cocoapods_binary_cache.md#cache_repo-
+      HEREDOC
+      Pod::UI.puts message
+    end
+
+    def fetch_remote_cache(repo, branch, dest_dir)
+      Pod::UI.puts "Fetching cache from #{repo} (branch: #{branch})".green
+      if Dir.exist?(dest_dir + "/.git")
+        git("fetch origin #{branch}")
+        git("checkout -f FETCH_HEAD", ignore_output: true)
+        git("branch -D #{branch}", ignore_output: true, can_fail: true)
+        git("checkout -b #{branch}")
+      else
+        FileUtils.rm_rf(dest_dir)
+        git_clone("--depth=1 --branch=#{branch} #{repo} #{dest_dir}")
+      end
+    end
+
+    def unzip_cache
+      Pod::UI.puts "Unzipping cache: #{@config.cache_path} -> #{@config.prebuild_sandbox_path}".green
+      FileUtils.rm_rf(@config.prebuild_sandbox_path)
+      FileUtils.mkdir_p(@config.prebuild_sandbox_path)
+
+      if File.exist?(@config.manifest_path(in_cache: true))
+        FileUtils.cp(
+          @config.manifest_path(in_cache: true),
+          @config.manifest_path
+        )
+      end
+      zip_paths = Dir[@config.generated_frameworks_dir(in_cache: true) + "/*.zip"]
+      Parallel.each(zip_paths, in_threads: 8) do |path|
+        ZipUtils.unzip(path, to_dir: @config.generated_frameworks_dir)
+      end
+    end
+  end
+end

data/lib/command/executor/prebuilder.rb

@@ -0,0 +1,61 @@
+require_relative "base"
+require_relative "fetcher"
+require_relative "pusher"
+
+module PodPrebuild
+  class CachePrebuilder < CommandExecutor
+    attr_reader :repo_update, :fetcher, :pusher
+
+    def initialize(options)
+      super(options)
+      @repo_update = options[:repo_update]
+      @fetcher = PodPrebuild::CacheFetcher.new(options) unless options[:no_fetch]
+      @pusher = PodPrebuild::CachePusher.new(options) if options[:push_cache]
+    end
+
+    def run
+      @fetcher&.run
+      prebuild
+      changes = PodPrebuild::JSONFile.new(@config.prebuild_delta_path)
+      return if changes.empty?
+
+      sync_cache(changes)
+      @pusher&.run
+    end
+
+    private
+
+    def prebuild
+      Pod::UI.step("Installation") do
+        installer.repo_update = @repo_update
+        installer.install!
+      end
+    end
+
+    def sync_cache(changes)
+      Pod::UI.step("Syncing cache") do
+        FileUtils.cp(@config.manifest_path, @config.manifest_path(in_cache: true))
+        clean_cache(changes["deleted"])
+        zip_to_cache(changes["updated"])
+      end
+    end
+
+    def zip_to_cache(pods_to_update)
+      FileUtils.mkdir_p(@config.generated_frameworks_dir(in_cache: true))
+      pods_to_update.each do |pod|
+        Pod::UI.puts "- Update cache: #{pod}"
+        ZipUtils.zip(
+          "#{@config.generated_frameworks_dir}/#{pod}",
+          to_dir: @config.generated_frameworks_dir(in_cache: true)
+        )
+      end
+    end
+
+    def clean_cache(pods_to_delete)
+      pods_to_delete.each do |pod|
+        Pod::UI.puts "- Clean up cache: #{pod}"
+        FileUtils.rm_rf("#{@config.generated_frameworks_dir(in_cache: true)}/#{pod}.zip")
+      end
+    end
+  end
+end

data/lib/command/executor/pusher.rb

@@ -0,0 +1,35 @@
+require_relative "base"
+
+module PodPrebuild
+  class CachePusher < CommandExecutor
+    attr_reader :cache_branch
+
+    def initialize(options)
+      super(options)
+      @cache_branch = options[:cache_branch]
+    end
+
+    def run
+      Pod::UI.step("Pushing cache") do
+        if @config.local_cache?
+          print_message_for_local_cache
+        else
+          commit_and_push_cache
+        end
+      end
+    end
+
+    private
+
+    def print_message_for_local_cache
+      Pod::UI.puts "Skip pushing cache as you're using local cache".yellow
+    end
+
+    def commit_and_push_cache
+      commit_message = "Update prebuilt cache"
+      git("add .")
+      git("commit -m '#{commit_message}'")
+      git("push origin #{@cache_branch}")
+    end
+  end
+end

data/lib/command/executor/visualizer.rb

@@ -0,0 +1,23 @@
+require_relative "base"
+require_relative "../../cocoapods-binary-ht/dependencies_graph/dependencies_graph"
+
+module PodPrebuild
+  class Visualizer < CommandExecutor
+    def initialize(options)
+      super(options)
+      @lockfile = options[:lockfile]
+      @open = options[:open]
+      @output_dir = options[:output_dir]
+      @devpod_only = options[:devpod_only]
+      @max_deps = options[:max_deps]
+    end
+
+    def run
+      FileUtils.mkdir_p(@output_dir)
+      graph = DependenciesGraph.new(lockfile: @lockfile, devpod_only: @devpod_only, max_deps: @max_deps)
+      output_path = "#{@output_dir}/graph.png"
+      graph.write_graphic_file(output_path: output_path)
+      system("open #{@output_path}") if @open
+    end
+  end
+end

data/lib/command/fetch.rb

@@ -0,0 +1,22 @@
+require_relative "executor/fetcher"
+
+module Pod
+  class Command
+    class Binary < Command
+      class Fetch < Binary
+        self.arguments = [CLAide::Argument.new("CACHE-BRANCH", false)]
+        def initialize(argv)
+          super
+          @fetcher = PodPrebuild::CacheFetcher.new(
+            config: prebuild_config,
+            cache_branch: argv.shift_argument || "master"
+          )
+        end
+
+        def run
+          @fetcher.run
+        end
+      end
+    end
+  end
+end

data/lib/command/helper/zip.rb

@@ -0,0 +1,20 @@
+module PodPrebuild
+  module ZipUtils
+    def self.zip(path, to_dir: nil)
+      basename = File.basename(path)
+      out_path = to_dir.nil? ? "#{basename}.zip" : "#{to_dir}/#{basename}.zip"
+      cmd = []
+      cmd << "cd" << File.dirname(path)
+      cmd << "&& zip -r --symlinks" << out_path << basename
+      cmd << "&& cd -"
+      `#{cmd.join(" ")}`
+    end
+
+    def self.unzip(path, to_dir: nil)
+      cmd = []
+      cmd << "unzip -nq" << path
+      cmd << "-d" << to_dir unless to_dir.nil?
+      `#{cmd.join(" ")}`
+    end
+  end
+end

data/lib/command/prebuild.rb

@@ -0,0 +1,47 @@
+require_relative "executor/prebuilder"
+require_relative "../cocoapods-binary-ht/pod-binary/prebuild_dsl"
+
+module Pod
+  class Command
+    class Binary < Command
+      class Prebuild < Binary
+        attr_reader :prebuilder
+
+        self.arguments = [CLAide::Argument.new("CACHE-BRANCH", false)]
+        def self.options
+          [
+            ["--config", "Config (Debug, Test...) to prebuild"],
+            ["--repo-update", "Update pod repo before installing"],
+            ["--no-fetch", "Do not perform a cache fetch beforehand"],
+            ["--push", "Push cache to repo upon completion"],
+            ["--all", "Prebuild all binary pods regardless of cache validation"],
+            ["--targets", "Targets to prebuild. Use comma (,) to specify a list of targets"]
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          super
+          prebuild_all_pods = argv.flag?("all")
+          prebuild_targets = argv.option("targets", "").split(",")
+          update_cli_config(
+            :prebuild_job => true,
+            :prebuild_all_pods => prebuild_all_pods,
+            :prebuild_config => argv.option("config")
+          )
+          update_cli_config(:prebuild_targets => prebuild_targets) unless prebuild_all_pods
+          @prebuilder = PodPrebuild::CachePrebuilder.new(
+            config: prebuild_config,
+            cache_branch: argv.shift_argument || "master",
+            repo_update: argv.flag?("repo-update"),
+            no_fetch: argv.flag?("fetch") == false,
+            push_cache: argv.flag?("push")
+          )
+        end
+
+        def run
+          @prebuilder.run
+        end
+      end
+    end
+  end
+end

data/lib/command/push.rb

@@ -0,0 +1,22 @@
+require_relative "executor/pusher"
+
+module Pod
+  class Command
+    class Binary < Command
+      class Push < Binary
+        self.arguments = [CLAide::Argument.new("CACHE-BRANCH", false)]
+        def initialize(argv)
+          super
+          @pusher = PodPrebuild::CachePusher.new(
+            config: prebuild_config,
+            cache_branch: argv.shift_argument || "master"
+          )
+        end
+
+        def run
+          @pusher.run
+        end
+      end
+    end
+  end
+end

data/lib/command/visualize.rb

@@ -0,0 +1,34 @@
+require_relative "executor/visualizer"
+
+module Pod
+  class Command
+    class Binary < Command
+      class Viz < Binary
+        self.arguments = [CLAide::Argument.new("OUTPUT-DIR", false)]
+        def self.options
+          [
+            ["--open", "Open the graph upon completion"],
+            ["--devpod_only", "Only include development pod"],
+            ["--max_deps", "Only include pod with number of dependencies <= max_deps"]
+          ]
+        end
+
+        def initialize(argv)
+          super
+          @visualizer = PodPrebuild::Visualizer.new(
+            config: prebuild_config,
+            lockfile: config.lockfile,
+            output_dir: argv.shift_argument || ".",
+            open: argv.flag?("open"),
+            devpod_only: argv.flag?("devpod_only"),
+            max_deps: argv.option("max_deps")
+          )
+        end
+
+        def run
+          @visualizer.run
+        end
+      end
+    end
+  end
+end