cocoapods-binary-cache 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7896d5bccb5c1b995271da31a02a9374ff4abc833e081bff2b38fe2401dfa2da
-  data.tar.gz: ca520b237ddf0377a1e1ca03f90e5f4afa79f576241662ae22c3a9fc86e158c5
+  metadata.gz: 2d362803909e7c1d6490e6e589706882e9b8b3e1a94c58fb496f790f8a8d41a5
+  data.tar.gz: ed54d6a54246ac70cf8b5a55e11d76b407b8e7f75aeaf1dfa863ecd6e15972c5
 SHA512:
-  metadata.gz: 3a7a9a3decaa6a14b80c80b77e69576a9b77ccbb3b4a5760c23c6e02b7ebc809a1e326ccf19030d6a1e091cdaa21a2a0d14c141d87457e7fdba7742c04adcf37
-  data.tar.gz: 4b6c9a841f4b98d41b1ad1ed36aaab65e7c7b59cd4ee30b1b13b0f695b264a0ef1222007adf305cab0be216d175f41d471a61368f641653592a31b5e23ecff1f
+  metadata.gz: 786d8ae14ca79bd43a4d2a0fda5b56f47bf59d8ba6043855609ad14f8ca18bca5ce5c7f40d121106756bf7cf4882f0b8c158f5f73fffc521c88dcf59f2c81d32
+  data.tar.gz: 7f213efbebb1cf27da7ac2794d154f83abb45ec16ae0b81b8f6a510af8e44101ae1b6b10341ac57c07d7ada16161551a42bd2ebd0e7c8680dff3029739d8cc38

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

@@ -7,6 +7,10 @@ module PodPrebuild
       @hit = hit.to_set - missed_with_reasons.keys
     end
 
+    def all
+      (hit + missed).to_set
+    end
+
     def missed
       @missed_with_reasons.keys.to_set
     end

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

@@ -5,7 +5,7 @@ module PodPrebuild
         PodPrebuild::PodfileChangesCacheValidator.new(options),
         PodPrebuild::NonDevPodsCacheValidator.new(options)
       ]
-      @validators << PodPrebuild::DevPodsCacheValidator.new(options) if Pod::Podfile::DSL.dev_pods_enabled
+      @validators << PodPrebuild::DevPodsCacheValidator.new(options) if PodPrebuild.config.dev_pods_enabled?
       @validators << PodPrebuild::DependenciesGraphCacheValidator.new(options)
       @validators << PodPrebuild::ExclusionCacheValidator.new(options)
     end

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

@@ -1,11 +1,16 @@
 module PodPrebuild
   class DependenciesGraphCacheValidator < AccumulatedCacheValidator
+    def initialize(options)
+      super(options)
+      @ignored_pods = options[:ignored_pods] || Set.new
+    end
+
     def validate(accumulated)
       return accumulated if library_evolution_supported? || @pod_lockfile.nil?
 
       dependencies_graph = DependenciesGraph.new(@pod_lockfile.lockfile)
-      clients = dependencies_graph.get_clients(accumulated.missed.to_a)
-      unless Pod::Podfile::DSL.dev_pods_enabled
+      clients = dependencies_graph.get_clients(accumulated.discard(@ignored_pods).missed.to_a)
+      unless PodPrebuild.config.dev_pods_enabled?
         clients = clients.reject { |client| @pod_lockfile.dev_pods.keys.include?(client) }
       end
 

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

@@ -1,56 +1,50 @@
 # Copyright 2019 Grabtaxi Holdings PTE LTE (GRAB), All rights reserved.
 # Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 
-require 'rgl/adjacency'
-require 'rgl/dot'
-require_relative 'graph_visualizer'
+require "rgl/adjacency"
+require "rgl/dot"
+require_relative "graph_visualizer"
 
-# Using RGL graph because GraphViz doesn't store adjacent of a node/vertex but we need to traverse a substree from any node
+# Using RGL graph because GraphViz doesn't store adjacent of a node/vertex
+# but we need to traverse a substree from any node
 # https://github.com/monora/rgl/blob/master/lib/rgl/adjacency.rb
 
 class DependenciesGraph
   def initialize(lockfile)
     @lockfile = lockfile
-    @invert_edge = true # A normal edge is an edge (one direction) from library A to library B which is a dependency of A.
+    # A normal edge is an edge (one direction) from library A to library B which is a dependency of A.
+    @invert_edge = true
   end
 
   # Input : a list of library names.
   # Output: a set of library names which are clients (directly and indirectly) of those input libraries.
   def get_clients(libnames)
-    result = Set.new()
+    result = Set.new
     libnames.each do |lib|
       if graph.has_vertex?(lib)
         result.merge(traverse_sub_tree(graph, lib))
       else
-        puts "Warning: cannot find lib: #{lib}"
+        Pod::UI.puts "Warning: cannot find lib: #{lib}"
       end
     end
     result
   end
 
-  def write_graphic_file(output_graphic_fmt, filename='graph', highlight_nodes=Set[])
-    if !output_graphic_fmt
-      puts 'Error: Need graphic format.'
-      return
-    end
-    graph.write_to_graphic_file(output_graphic_fmt, dotfile=filename, options={}, highlight_nodes)
+  def write_graphic_file(options)
+    graph.write_to_graphic_file(options)
   end
 
   private
 
   def dependencies
-    @dependencies ||= begin
-      if @lockfile
-        @lockfile.to_hash['PODS']
-      else
-        nil
-      end
-    end
+    @dependencies ||= (@lockfile && @lockfile.to_hash["PODS"])
   end
 
   # Convert array of dictionaries -> a dictionary with format {A: [A's dependencies]}
   def pod_to_dependencies
-    dependencies.map { |d| d.is_a?(Hash) ? d : { d => [] } }.reduce({}) { |combined, individual| combined.merge!(individual) }
+    dependencies
+      .map { |d| d.is_a?(Hash) ? d : { d => [] } }
+      .reduce({}) { |combined, individual| combined.merge!(individual) }
   end
 
   def add_vertex(graph, pod)
@@ -65,14 +59,15 @@ class DependenciesGraph
 
   def graph
     @graph ||= begin
-      graph = RGL::DirectedAdjacencyGraph.new()
-
+      graph = RGL::DirectedAdjacencyGraph.new
       pod_to_dependencies.each do |pod, dependencies|
         pod_node = add_vertex(graph, pod)
         next if pod_node.nil?
+
         dependencies.each do |dependency|
           dep_node = add_vertex(graph, dependency)
           next if dep_node.nil?
+
           if @invert_edge
             graph.add_edge(dep_node, pod_node)
           else
@@ -85,11 +80,11 @@ class DependenciesGraph
   end
 
   def traverse_sub_tree(graph, vertex)
-    visited_nodes = Set.new()
+    visited_nodes = Set.new
     graph.each_adjacent(vertex) do |v|
       visited_nodes.add(v)
       visited_nodes.merge(traverse_sub_tree(graph, v))
     end
     visited_nodes
   end
-end
+end

data/lib/cocoapods-binary-cache/dependencies_graph/graph_visualizer.rb

@@ -2,73 +2,64 @@
 # Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 # https://github.com/monora/rgl/blob/0b526e16f9fb344abf387f4c5523d7917ce8f4b1/lib/rgl/dot.rb
 
-require 'rgl/rdot'
+require "rgl/rdot"
 
 module RGL
   module Graph
-    def to_dot_graph(params={}, highlight_nodes)
-      params['name'] ||= self.class.name.gsub(/:/, '_')
-      fontsize       = params['fontsize'] ? params['fontsize'] : '12'
-      graph          = (directed? ? DOT::Digraph : DOT::Graph).new(params)
-      edge_class     = directed? ? DOT::DirectedEdge : DOT::Edge
-      vertex_options = params['vertex'] || {}
-      edge_options   = params['edge'] || {}
+    def to_dot_graph(options)
+      highlight_nodes = options[:highlight_nodes] || Set.new
+      options["name"] ||= self.class.name.gsub(/:/, "_")
+      fontsize = options["fontsize"] || "12"
+      graph = (directed? ? DOT::Digraph : DOT::Graph).new(options)
+      edge_class = directed? ? DOT::DirectedEdge : DOT::Edge
+      vertex_options = options["vertex"] || {}
+      edge_options = options["edge"] || {}
 
       each_vertex do |v|
-        default_vertex_options =  {
-          'name'     => vertex_id(v),
-          'fontsize' => fontsize,
-          'label'    => vertex_label(v),
-          'style'    => 'filled',
+        default_vertex_options = {
+          "name" => vertex_id(v),
+          "fontsize" => fontsize,
+          "label" => vertex_label(v),
+          "style" => "filled"
         }
-        if highlight_nodes.include?(v)
-          default_vertex_options = default_vertex_options.merge({
-            'color' => 'red',
-            'fillcolor' => 'red'
-          })
-        else
-          default_vertex_options = default_vertex_options.merge({
-            'color' => 'blue',
-            'fillcolor' => 'blue'
-          })
-        end
-
+        default_vertex_options.merge!("color" => "red", "fillcolor" => "red") if highlight_nodes.include?(v)
         each_vertex_options = default_vertex_options.merge(vertex_options)
-        vertex_options.each{|option, val| each_vertex_options[option] = val.call(v) if val.is_a?(Proc)}
+        vertex_options.each { |option, val| each_vertex_options[option] = val.call(v) if val.is_a?(Proc) }
         graph << DOT::Node.new(each_vertex_options)
       end
 
       each_edge do |u, v|
         default_edge_options = {
-          'from'     => vertex_id(u),
-          'to'       => vertex_id(v),
-          'fontsize' => fontsize
+          "from" => vertex_id(u),
+          "to" => vertex_id(v),
+          "fontsize" => fontsize
         }
         each_edge_options = default_edge_options.merge(edge_options)
-        edge_options.each{|option, val| each_edge_options[option] = val.call(u, v) if val.is_a?(Proc)}
+        edge_options.each { |option, val| each_edge_options[option] = val.call(u, v) if val.is_a?(Proc) }
         graph << edge_class.new(each_edge_options)
       end
 
       graph
     end
 
-    def write_to_graphic_file(fmt='png', dotfile="graph", options={}, highlight_nodes)
-      src = dotfile + ".dot"
-      dot = dotfile + "." + fmt
+    def write_to_graphic_file(options)
+      output_path = Pathname.new(options[:output_path])
+      fmt = output_path.extname.delete_prefix(".")
+      dotfile = output_path.sub_ext(".dot")
 
-      File.open(src, 'w') do |f|
-        f << self.to_dot_graph(params=options, highlight_nodes=highlight_nodes).to_s << "\n"
+      File.open(dotfile, "w") do |f|
+        f << to_dot_graph(options).to_s
       end
 
-      unless system("dot -T#{fmt} #{src} -o #{dot}")
-        message = <<-HEREDOC # Use <<- to indent End of String terminator
+      unless system("dot -T#{fmt} #{dotfile} -o #{output_path}")
+        message = <<~HEREDOC
           Error executing dot. Did you install GraphViz?
           Try installing it via Homebrew: `brew install graphviz`.
           Visit https://graphviz.org/download/ for more installation instructions.
         HEREDOC
         raise message
       end
-      dot
+      output_path
     end
   end
 end

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

@@ -10,7 +10,15 @@ module PodPrebuild
     end
 
     def run
-      @diagnosers.each(&:run)
+      diagnosis = @diagnosers.map(&:run)
+      errors = diagnosis.select { |d| d[0] == :error }.map { |d| d[1] }
+      warnings = diagnosis.select { |d| d[0] == :error }.map { |d| d[1] }
+
+      warnings.each { |d| Pod::UI.puts "⚠️  #{d[1]}" }
+      errors.each { |d| Pod::UI.puts "🚩  #{d[1]}" }
+      return if errors.empty? || !PodPrebuild.config.strict_diagnosis?
+
+      raise "There are #{errors.count} error(s) spotted after the diagnosis"
     end
   end
 end

data/lib/cocoapods-binary-cache/diagnosis/integration.rb

@@ -3,17 +3,21 @@ require_relative "base"
 module PodPrebuild
   class IntegrationDiagnosis < BaseDiagnosis
     def run
-      should_be_integrated = if Pod::Podfile::DSL.prebuild_job? \
+      should_be_integrated = if PodPrebuild.config.prebuild_job? \
                              then @cache_validation.hit + @cache_validation.missed \
                              else @cache_validation.hit \
                              end
       should_be_integrated = should_be_integrated.map { |name| name.split("/")[0] }.to_set
       unintegrated = should_be_integrated.reject do |name|
         module_name = spec(name)&.module_name || name
-        framework_path = @standard_sandbox.pod_dir(name) + "#{module_name}.framework"
+        framework_path = \
+          @standard_sandbox.pod_dir(name) + \
+          PodPrebuild.config.prebuilt_path(path: "#{module_name}.framework")
         framework_path.exist?
       end
-      Pod::UI.puts "🚩 Unintegrated frameworks: #{unintegrated}".yellow unless unintegrated.empty?
+      return [] if unintegrated.empty?
+
+      [[:error, "Unintegrated frameworks: #{unintegrated}"]]
     end
   end
 end

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

@@ -13,7 +13,7 @@ module PodPrebuild
       end
 
       def stages
-        @stages ||= Pod::Podfile::DSL.prebuild_job? ? [:prebuild, :integration] : [:integration]
+        @stages ||= PodPrebuild.config.prebuild_job? ? [:prebuild, :integration] : [:integration]
       end
 
       def current_stage

data/lib/cocoapods-binary-cache/helper/checksum.rb

@@ -4,9 +4,15 @@
 require "digest/md5"
 
 class FolderChecksum
-  def self.checksum(dir)
-    files = Dir["#{dir}/**/*"].reject { |f| File.directory?(f) }
-    content = files.map { |f| File.read(f) }.join
-    Digest::MD5.hexdigest(content).to_s
+  def self.git_checksum(dir)
+    checksum_of_files(`git ls-files #{dir}`.split("\n"))
+  rescue => e
+    Pod::UI.warn "Cannot get checksum of tracked files under #{dir}: #{e}"
+    checksum_of_files(Dir["#{dir}/**/*"].reject { |f| File.directory?(f) })
+  end
+
+  def self.checksum_of_files(files)
+    checksums = files.sort.map { |f| Digest::MD5.hexdigest(File.read(f)) }
+    Digest::MD5.hexdigest(checksums.join)
   end
 end

data/lib/cocoapods-binary-cache/helper/lockfile.rb

@@ -68,7 +68,7 @@ module PodPrebuild
     # Generate a map between a dev_pod and it source hash
     def dev_pod_hashes_map
       @dev_pod_hashes_map ||=
-        dev_pod_sources.map { |name, attribs| [name, FolderChecksum.checksum(attribs[:path])] }.to_h
+        dev_pod_sources.map { |name, attribs| [name, FolderChecksum.git_checksum(attribs[:path])] }.to_h
     end
 
     # Parse an item under `PODS` section of a Lockfile

data/lib/cocoapods-binary-cache/helper/podspec.rb

@@ -1,8 +1,10 @@
 module Pod
   class Specification
-    # TODO: this detect objc lib as empty source, eg. Realm
     def empty_source_files?
-      return subspecs.all?(&:empty_source_files?) unless subspecs.empty?
+      unless subspecs.empty?
+        # return early if there are some files in subpec(s) but process the spec itself
+        return false unless subspecs.all?(&:empty_source_files?)
+      end
 
       check = lambda do |patterns|
         patterns = [patterns] if patterns.is_a?(String)

data/lib/cocoapods-binary-cache/hooks/post_install.rb

@@ -5,29 +5,19 @@ module PodPrebuild
     end
 
     def run
-      edit_scheme_for_code_coverage if PodPrebuild::Env.prebuild_stage?
       diagnose if PodPrebuild::Env.integration_stage?
     end
 
     private
 
     def diagnose
-      Pod::UI.section("Diagnosing cocoapods-binary-cache") do
+      Pod::UI.title("Diagnosing cocoapods-binary-cache") do
         PodPrebuild::Diagnosis.new(
-          cache_validation: PodPrebuild::StateStore.cache_validation,
+          cache_validation: PodPrebuild.state.cache_validation,
           standard_sandbox: @installer_context.sandbox,
           specs: @installer_context.umbrella_targets.map(&:specs).flatten
         ).run
       end
     end
-
-    def edit_scheme_for_code_coverage
-      return unless Pod::Podfile::DSL.dev_pods_enabled && @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
-
-      # Modify pods scheme to support code coverage
-      # If we don't prebuild dev pod -> no need to care about this in Pod project
-      # because we setup in the main project (ex. DriverCI scheme)
-      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox)
-    end
   end
 end

data/lib/cocoapods-binary-cache/hooks/pre_install.rb

@@ -2,32 +2,30 @@ module PodPrebuild
   class PreInstallHook
     include ObjectSpace
 
-    attr_reader :installer_context, :podfile, :prebuild_sandbox, :cache_validation
+    attr_reader :installer_context, :podfile, :prebuild_sandbox, :standard_sandbox, :cache_validation
 
     def initialize(installer_context)
       @installer_context = installer_context
       @podfile = installer_context.podfile
       @pod_install_options = {}
       @prebuild_sandbox = nil
+      @standard_sandbox = installer_context.sandbox
       @cache_validation = nil
     end
 
     def run
       return if @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
 
-      require_relative "../pod-binary/helper/feature_switches"
-
       log_section "🚀  Prebuild frameworks"
       ensure_valid_podfile
       save_installation_states
-      Pod::UI.section("Prepare environment") { prepare_environment }
       create_prebuild_sandbox
-      Pod::UI.section("Detect implicit dependencies") { detect_implicit_dependencies }
-      Pod::UI.section("Validate prebuilt cache") { validate_cache }
-      prebuild! if Pod::Podfile::DSL.prebuild_job?
-      Pod::UI.section("Reset environment") { reset_environment }
+      Pod::UI.title("Detect implicit dependencies") { detect_implicit_dependencies }
+      Pod::UI.title("Validate prebuilt cache") { validate_cache }
+      prebuild! if PodPrebuild.config.prebuild_job?
 
       PodPrebuild::Env.next_stage!
+      prepare_for_integration
       log_section "🤖  Resume pod installation"
       require_relative "../pod-binary/integration"
     end
@@ -36,7 +34,6 @@ module PodPrebuild
 
     def save_installation_states
       save_pod_install_options
-      save_states_from_dsl
     end
 
     def save_pod_install_options
@@ -55,28 +52,7 @@ module PodPrebuild
       end
     end
 
-    def prepare_environment
-      Pod::Installer.force_disable_integration true # don't integrate targets
-      Pod::Config.force_disable_write_lockfile true # disbale write lock file for perbuild podfile
-      Pod::Installer.disable_install_complete_message true # disable install complete message
-    end
-
-    def reset_environment
-      Pod::Installer.force_disable_integration false
-      Pod::Config.force_disable_write_lockfile false
-      Pod::Installer.disable_install_complete_message false
-      Pod::UserInterface.warnings = [] # clean the warning in the prebuild step, it's duplicated.
-    end
-
-    def save_states_from_dsl
-      # Note: DSL is reloaded when creating an installer (Pod::Installer.new).
-      # Any mutation to DSL is highly discouraged
-      # --> Rather, perform mutation on PodPrebuild::StateStore instead
-      PodPrebuild::StateStore.excluded_pods += Pod::Podfile::DSL.excluded_pods
-    end
-
     def create_prebuild_sandbox
-      standard_sandbox = installer_context.sandbox
       @prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sandbox)
       Pod::UI.message "Create prebuild sandbox at #{@prebuild_sandbox.root}"
     end
@@ -88,11 +64,9 @@ module PodPrebuild
         .group_by { |spec| spec.name.split("/")[0] }
         .select { |_, specs| specs.all?(&:empty_source_files?) }
         .keys
-
-      PodPrebuild::StateStore.excluded_pods += pods_with_empty_source_files
+      PodPrebuild.config.update_detected_excluded_pods!(pods_with_empty_source_files)
+      PodPrebuild.config.update_detected_prebuilt_pod_names!(@original_installer.prebuilt_pod_names)
       Pod::UI.puts "Exclude pods with empty source files: #{pods_with_empty_source_files.to_a}"
-
-      # TODO (thuyen): Detect dependencies of a prebuilt pod and treat them as prebuilt pods as well
     end
 
     def validate_cache
@@ -101,16 +75,16 @@ module PodPrebuild
         podfile: podfile,
         pod_lockfile: installer_context.lockfile,
         prebuilt_lockfile: prebuilt_lockfile,
-        validate_prebuilt_settings: Pod::Podfile::DSL.validate_prebuilt_settings,
+        validate_prebuilt_settings: PodPrebuild.config.validate_prebuilt_settings,
         generated_framework_path: prebuild_sandbox.generate_framework_path,
         sandbox_root: prebuild_sandbox.root,
-        ignored_pods: PodPrebuild::StateStore.excluded_pods,
-        prebuilt_pod_names: @original_installer.prebuilt_pod_names
+        ignored_pods: PodPrebuild.config.excluded_pods,
+        prebuilt_pod_names: PodPrebuild.config.prebuilt_pod_names
       ).validate
-      path_to_save_cache_validation = Pod::Podfile::DSL.save_cache_validation_to
+      path_to_save_cache_validation = PodPrebuild.config.save_cache_validation_to
       @cache_validation.update_to(path_to_save_cache_validation) unless path_to_save_cache_validation.nil?
       cache_validation.print_summary
-      PodPrebuild::StateStore.cache_validation = cache_validation
+      PodPrebuild.state.update(:cache_validation => cache_validation)
     end
 
     def prebuild!
@@ -129,6 +103,15 @@ module PodPrebuild
       end
     end
 
+    def prepare_for_integration
+      # Remove local podspec of external sources so that it downloads sources correctly.
+      # Otherwise, with incremental pod installation, CocoaPods downloads the sources
+      # based on the `s.source` declaration in the podspecs which are sometimes incorrect.
+      PodPrebuild.config.prebuilt_pod_names.each do |name|
+        @standard_sandbox.remove_local_podspec(name) if @standard_sandbox.checkout_sources.key?(name)
+      end
+    end
+
     def log_section(message)
       Pod::UI.puts "-----------------------------------------"
       Pod::UI.puts message