cocoapods-binary-cache 0.1.6 → 0.1.11

data/lib/cocoapods-binary-cache/pod-rome/xcodebuild_raw.rb

@@ -1,43 +1,48 @@
 require "fourflusher"
 
-PLATFORM_OF_SDK = {
-  "iphonesimulator" => "iOS",
-  "appletvsimulator" => "tvOS",
-  "watchsimulator" => "watchOS"
-}.freeze
+module PodPrebuild
+  class XcodebuildCommand
+    PLATFORM_OF_SDK = {
+      "iphonesimulator" => "iOS",
+      "appletvsimulator" => "tvOS",
+      "watchsimulator" => "watchOS"
+    }.freeze
 
-def xcodebuild(options)
-  sdk = options[:sdk] || "iphonesimulator"
-  platform = PLATFORM_OF_SDK[sdk]
+    def self.xcodebuild(options)
+      sdk = options[:sdk] || "iphonesimulator"
+      targets = options[:targets] || [options[:target]]
+      platform = PLATFORM_OF_SDK[sdk]
 
-  cmd = ["xcodebuild"]
-  cmd << "-project" << options[:sandbox].project_path.realdirpath
-  cmd << "-scheme" << options[:target]
-  cmd << "-configuration" << options[:configuration]
-  cmd << "-sdk" << sdk
-  cmd << Fourflusher::SimControl.new.destination(:oldest, platform, options[:deployment_target]) unless platform.nil?
-  cmd += options[:args] if options[:args]
-  cmd << "2>&1"
-  cmd = cmd.join(" ")
-
-  puts "xcodebuild command: #{cmd}"
-  log = `#{cmd}`
+      cmd = ["xcodebuild"]
+      cmd << "-project" << options[:sandbox].project_path.realdirpath.shellescape
+      targets.each { |target| cmd << "-target" << target }
+      cmd << "-configuration" << options[:configuration]
+      cmd << "-sdk" << sdk
+      unless platform.nil?
+        cmd << Fourflusher::SimControl.new.destination(:oldest, platform, options[:deployment_target])
+      end
+      cmd += options[:args] if options[:args]
+      cmd << "build"
+      cmd << "2>&1"
+      cmd = cmd.join(" ")
 
-  succeeded = $?.exitstatus.zero?
-  unless succeeded
-    begin
-      raise "Unexpected error" unless log.include?("** BUILD FAILED **")
+      Pod::UI.puts_indented "$ #{cmd}"
+      log = `#{cmd}`
+      return if $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
 
-      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)
+      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
-    rescue
-      puts log.red
     end
   end
-  [succeeded, log]
 end

data/lib/cocoapods-binary-cache/prebuild_output/output.rb

@@ -8,7 +8,7 @@ module PodPrebuild
     end
 
     def prebuild_delta_path
-      @prebuild_delta_path ||= PodPrebuild::Config.instance.prebuild_delta_path
+      @prebuild_delta_path ||= PodPrebuild.config.prebuild_delta_path
     end
 
     def delta_dir
@@ -16,7 +16,7 @@ module PodPrebuild
     end
 
     def clean_delta_file
-      puts "Clean delta file: #{prebuild_delta_path}"
+      Pod::UI.message "Clean delta file: #{prebuild_delta_path}"
       FileUtils.rm_rf(prebuild_delta_path)
     end
 
@@ -24,14 +24,16 @@ module PodPrebuild
       FileUtils.mkdir_p dir unless File.directory?(dir)
     end
 
-    # Input 2 arrays of library names
-    def write_delta_file(updated, deleted)
+    def write_delta_file(options)
+      updated = options[:updated]
+      deleted = options[:deleted]
+
       if updated.empty? && deleted.empty?
         Pod::UI.puts "No changes in prebuild"
         return
       end
 
-      Pod::UI.puts "Write prebuild changes to: #{prebuild_delta_path}"
+      Pod::UI.message "Write prebuild changes to: #{prebuild_delta_path}"
       create_dir_if_needed(delta_dir)
       changes = PodPrebuild::JSONFile.new(prebuild_delta_path)
       changes["updated"] = updated

data/lib/cocoapods-binary-cache/state_store.rb

@@ -1,11 +1,21 @@
 module PodPrebuild
-  class StateStore
-    @excluded_pods = Set.new
-    @cache_validation = CacheValidationResult.new
+  def self.state
+    @state ||= State.new
+  end
+
+  class State
+    def initialize
+      @store = {
+        :cache_validation => CacheValidationResult.new
+      }
+    end
+
+    def update(data)
+      @store.merge!(data)
+    end
 
-    class << self
-      attr_accessor :excluded_pods
-      attr_accessor :cache_validation
+    def cache_validation
+      @store[:cache_validation]
     end
   end
 end

data/lib/command/binary.rb

@@ -9,9 +9,28 @@ module Pod
   class Command
     class Binary < Command
       self.abstract_command = true
+      def self.options
+        [
+          ["--repo", "Cache repo (in accordance with `cache_repo` in `config_cocoapods_binary_cache`)"]
+        ]
+      end
+
+      def initialize(argv)
+        super
+        load_podfile
+        update_cli_config(:repo => argv.option("repo"))
+      end
 
       def prebuild_config
-        @prebuild_config ||= PodPrebuild::Config.instance
+        @prebuild_config ||= PodPrebuild.config
+      end
+
+      def load_podfile
+        Pod::Config.instance.podfile
+      end
+
+      def update_cli_config(options)
+        PodPrebuild.config.cli_config.merge!(options)
       end
     end
   end

data/lib/command/config.rb

@@ -1,31 +1,204 @@
 require_relative "../cocoapods-binary-cache/helper/json"
 
 module PodPrebuild
-  class Config
-    attr_reader :cache_repo, :cache_path, :prebuild_path, :prebuild_delta_path
+  def self.config
+    PodPrebuild::Config.instance
+  end
+
+  class Config # rubocop:disable Metrics/ClassLength
+    attr_accessor :dsl_config, :cli_config
 
     def initialize(path)
-      @data = PodPrebuild::JSONFile.new(path)
-      @cache_repo = @data["cache_repo"] || @data["prebuilt_cache_repo"]
-      @cache_path = File.expand_path(@data["cache_path"])
-      @prebuild_path = @data["prebuild_path"] || "_Prebuild"
-      @prebuild_delta_path = @data["prebuild_delta_path"] || "_Prebuild_delta/changes.json"
+      @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_path
+      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)
+      path.nil? ? "_Prebuilt" : "_Prebuilt/#{path}"
+    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/grab/cocoapods-binary-cache/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 disable_dsym?
+      @dsl_config[:disable_dsym]
+    end
+
+    def still_download_sources?(name)
+      option = @dsl_config[:still_download_sources]
+      option.is_a?(Array) ? option.include?(name) : option
+    end
+
+    def dont_remove_source_code?
+      @dsl_config[:dont_remove_source_code]
+    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 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,
+        :disable_dsym,
+        :still_download_sources,
+        :dont_remove_source_code,
+        :build_args,
+        :save_cache_validation_to,
+        :validate_prebuilt_settings,
+        :prebuild_code_gen,
+        :strict_diagnosis
+      ]
+    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/grab/cocoapods-binary-cache/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-cache/prebuilt-frameworks"
+        }
+      end
+    end
   end
 end

data/lib/command/executor/base.rb

@@ -2,6 +2,22 @@ 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 = {})
@@ -10,7 +26,8 @@ module PodPrebuild
       comps << cmd
       comps << "&> /dev/null" if options[:ignore_output]
       comps << "|| true" if options[:can_fail]
-      `#{comps.join(" ")}`
+      cmd = comps.join(" ")
+      raise "Fail to run command '#{cmd}'" unless system(cmd)
     end
 
     def git_clone(cmd, options = {})

data/lib/command/executor/fetcher.rb

@@ -3,6 +3,8 @@ require_relative "../helper/zip"
 
 module PodPrebuild
   class CacheFetcher < CommandExecutor
+    attr_reader :cache_branch
+
     def initialize(options)
       super(options)
       @cache_branch = options[:cache_branch]
@@ -10,14 +12,28 @@ module PodPrebuild
 
     def run
       Pod::UI.step("Fetching cache") do
-        fetch_cache(@config.cache_repo, @cache_branch, @config.cache_path)
+        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 fetch_cache(repo, branch, dest_dir)
+    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/grab/cocoapods-binary-cache/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}")
@@ -31,9 +47,9 @@ module PodPrebuild
     end
 
     def unzip_cache
-      Pod::UI.puts "Unzipping cache: #{@config.cache_path} -> #{@config.prebuild_path}".green
-      FileUtils.rm_rf(@config.prebuild_path)
-      FileUtils.mkdir_p(@config.prebuild_path)
+      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(