pod-builder 0.9.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5d7b7bb753baab42ba1ebf90cff6c4f46160a0e0161336a0d9c035ce2a0d7b2
-  data.tar.gz: 431039e01adb554df23b8832be48f3908994b39945d5242881e780824f3be3a9
+  metadata.gz: 5281c507a89f44af31e4f826d10c45cfd5c68e7b62ed3b3c66d840181909f95d
+  data.tar.gz: 139f7835eedc3030378a5fa53fd7cd80fec8739fc5c0bccec9e654fc8199d711
 SHA512:
-  metadata.gz: 438e67d0ed933e30f4556bbf9ab8c60a4a6af038a973bfdc735cc3fb6a45ee1805a0ad8d3dcaa0794c0e28cc2b165ca1aa55025abd90b9e3c2e5112f0e402d46
-  data.tar.gz: 63aec152527fc2c7592b136350e84c950350449fe307192593169a03d3990c102f5198948c411d5d2f207c5520cf1fa3c971ecee2ae569b84678adc9755b22b9
+  metadata.gz: e7468475cbaf61dd82f5360b41678377b12aac63f6637e794777a1064dcbcaf194ad56ad966eeaf19d0f79be28475f52c9314b6fa9773bd52d7dc944d8587cdd
+  data.tar.gz: f8522731ffaa190fe6024dc7675d2a2231c064189557cfb352e3ef363c975213379c54d02b9385fd5605fdfde33b4bb6dca108517edfa8bc88ef9767761c9f55

data/README.md

@@ -94,7 +94,11 @@ Will recompile all pods to the versions defined in the Restore-Podfile. You woul
 
 #### `install_sources` command
 
-When using PodBuilder you loose ability to directly access to the source code of a pod. To overcome this limitation you can use this command which downloads the pod's source code to _Frameworks/Sources_ and with some [tricks](https://medium.com/@t.camin/debugging-prebuilt-frameworks-c9f52d42600b) restores the ability to step into the pods code. This can be very helpful to catch the exact location of a crash when it occurs (showing something more useful than assembly code). It is however advisable to switch to the original pod when doing any advanced debugging during development of code that involves a pod.
+When using PodBuilder you loose ability to directly access to the source code of a pod. To overcome this limitation you can use this command which downloads the pod's source code to _Frameworks/Sources_ and with some [tricks](https://medium.com/@t.camin/debugging-prebuilt-frameworks-c9f52d42600b) restores the ability to use the debugger and step into the code of your prebuilt dependencies. This can be very helpful to catch the exact location of a crash when it occurs (showing something more useful than assembly code). It is however advisable to switch to the original pod when doing any advanced debugging during development of code that involves a pod.
+
+#### `update_lldbinit` command
+
+In some situations you may already have source code for your prebuilt frameworks (e.g. committed in your repo). In this case there is no need to use the `install_sources`, you can run this command passing the folder that contains the source code that you used to generate the prebuilt frameworks. This will update the `~/.lldbinit-Xcode` file which will restore the ability to use the debugger and step into the code of your prebuilt dependencies.
 
 #### `switch` command
 

data/exe/pod_builder

@@ -31,7 +31,8 @@ Command:
     + build_all                      Build all pods declared in the PodBuilder-Podfile
     + update                         Rebuild frameworks that are outdated
     + restore_all                    Rebuild all pods declared in the Restore-Podfile
-    + install_sources                Install sources of pods to debug into prebuild frameworks
+    + install_sources                Install sources of pods to debug into prebuilt frameworks
+    + update_lldbinit                Update ~/.lldbinit-Xcode setting target.source-map to debug prebuilt frameworks
     + switch                         Switch between prebuilt/development/standard pod in the Application-Podfile
     + clean                          Remove prebuild frameworks, dSYMs and source files added by `install_sources` command that are no longer in the PodBuilder-Podfile
     + sync_podfile                   Update your Application-Podfile with all pods declared in the PodBuilder-Podfile
@@ -233,8 +234,7 @@ Usage:
     $ pod_builder install_sources
 
       Install source of prebuilt pods to be able to step into and debug framework's code.
-        
-Options:
+
 "         
       end,
       :call => [        
@@ -242,6 +242,25 @@ Options:
       ]
     },
 
+    "update_lldbinit" => {         
+      :opts => OptionParser.new do |opts|
+        opts.banner = "
+Usage:
+        
+    $ pod_builder install_sources PATH
+
+      Update ~/.lldbinit-Xcode setting target.source-map in order to be able to step into 
+      and debug framework's code.
+
+      Specify the PATH of the folder containing the source code of prebuilt frameworks. PATH can be relative to PodBuilder's Framework folder.
+
+"         
+      end,
+      :call => [        
+        PodBuilder::Command::UpdateLldbInit
+      ]
+    },
+
     "switch" => {      
       :opts => OptionParser.new do |opts|
         opts.banner = "

data/lib/pod_builder/command.rb

@@ -12,3 +12,4 @@ require 'pod_builder/command/switch'
 require 'pod_builder/command/generate_lfs'
 require 'pod_builder/command/sync_podfile'
 require 'pod_builder/command/info'
+require 'pod_builder/command/update_lldbinit'

data/lib/pod_builder/command/install_sources.rb

@@ -25,7 +25,8 @@ module PodBuilder
 
         Command::Clean::clean_sources()
 
-        rewrite_lldinit
+        ARGV << PodBuilder::basepath("Sources")
+        Command::UpdateLldbInit::call(options)
 
         puts "\n\n🎉 done!\n".green
         return 0
@@ -66,32 +67,6 @@ module PodBuilder
   
         return nil
       end
-
-      def self.rewrite_lldinit
-        puts "Writing ~/.lldbinit-Xcode".yellow
-
-        lldbinit_path = File.expand_path('~/.lldbinit-Xcode')
-        FileUtils.touch(lldbinit_path)
-
-        lldbinit_lines = []
-        File.read(lldbinit_path).each_line do |line|
-          if lldbinit_lines.include?(line.strip()) ||
-             line.start_with?("settings set target.source-map") ||
-             line.strip() == "" then
-            next
-          end
-            
-          lldbinit_lines.push(line)
-        end
-
-        build_path = "#{PodBuilder::Configuration.build_path}/Pods"
-        source_path = PodBuilder::basepath("Sources")
-
-        lldbinit_lines.push("settings set target.source-map '#{build_path}' '#{source_path}'")
-        lldbinit_lines.push("")
-      
-        File.write(lldbinit_path, lldbinit_lines.join("\n"))
-      end
     end
   end
 end

data/lib/pod_builder/command/update_lldbinit.rb

@@ -0,0 +1,137 @@
+require 'pod_builder/core'
+
+module PodBuilder
+  module Command
+    class UpdateLldbInit
+      def self.call(options)
+        Configuration.check_inited
+        PodBuilder::prepare_basepath
+        
+        argument_pods = ARGV.dup
+        
+        unless argument_pods.count > 0 
+          return -1
+        end
+        unless argument_pods.count == 1
+          raise "\n\nSpecify a single PATH to the folder containing the prebuilt framework's source code\n\n".red 
+        end
+        
+        base_path = PodBuilder::basepath("")
+        path = argument_pods[0]
+        
+        is_absolute = ["~", "/"].include?(path[0])
+        if !is_absolute
+          path = Pathname.new(File.join(base_path, path))
+        end
+        
+        path = File.expand_path(path)
+        
+        framework_paths = Dir.glob("#{base_path}/**/*.framework")
+        
+        unless framework_paths.count > 0
+          raise "\n\nNo prebuilt frameworks found in `#{path}`\n\n".red 
+        end
+
+        puts "Extracting debug information".yellow
+
+        podspec_paths = Dir.glob("#{path}/**/*.podspec") + Dir.glob("#{path}/**/*.podspec.json")
+        podspec_contents = podspec_paths.map { |t| File.read(t).gsub(/\s+/, "").gsub("\"", "'") }
+        
+        replace_paths = []
+        
+        framework_paths.each do |framework_path|
+          name = File.basename(framework_path, File.extname(framework_path)) 
+          executable_path = File.join(framework_path, name)
+          
+          dwarf_dump_lib = `dwarfdump --debug-info #{executable_path} | grep '#{Configuration.build_base_path}' | head -n 1`.strip()          
+          
+          if (matches = dwarf_dump_lib.match(/#{Configuration.build_base_path}(.*)\/Pods/)) && matches.size == 2
+            original_compile_path = "#{Configuration.build_base_path}#{matches[1]}/Pods/#{name}"
+            
+            if podspec_path = find_podspec_path_for(name, podspec_paths, podspec_contents)
+              replace_paths.push("#{original_compile_path},#{File.dirname(podspec_path)}")
+            else
+              puts "Failed to find podspec for #{name}".blue
+            end 
+          else
+            # Look for path in dSYM
+            dsym_paths = Dir.glob("#{base_path}/**/iphonesimulator/#{name}.framework.dSYM")
+            dsym_paths.each do |dsym_path|
+              name = File.basename(dsym_path, ".framework.dSYM") 
+              dsym_dwarf_path = File.join(dsym_path, "Contents/Resources/DWARF")
+              dsym_dwarf_path = File.join(dsym_dwarf_path, name)
+              
+              dwarf_dump_lib = `dwarfdump --debug-info #{dsym_dwarf_path} | grep '#{Configuration.build_base_path}' | head -n 1`.strip()
+              
+              if (matches = dwarf_dump_lib.match(/#{Configuration.build_base_path}(.*)\/Pods/)) && matches.size == 2
+                original_compile_path = "#{Configuration.build_base_path}#{matches[1]}/Pods/#{name}"
+
+                if podspec_path = find_podspec_path_for(name, podspec_paths, podspec_contents)
+                  replace_paths.push("#{original_compile_path},#{File.dirname(podspec_path)}")
+                else
+                  puts "Failed to find podspec for #{name}".blue
+                end                
+              end
+            end    
+          end
+        end
+        
+        replace_paths.uniq!
+
+        source_map_lines = replace_paths.flat_map { |t| ["# <pb>", "settings append target.source-map '#{t.split(",").first}' '#{t.split(",").last}'"] }
+        if source_map_lines.count > 1
+          # first occurrance should be a set
+          source_map_lines[1] = source_map_lines[1].gsub("settings append target.source-map", "settings set target.source-map")
+        end
+        rewrite_lldinit(source_map_lines)
+        
+        puts "\n\n🎉 done!\n".green
+        return 0
+      end
+
+      def self.find_podspec_path_for(name, podspec_paths, podspec_contents)
+        if (path = podspec_paths.detect { |t| File.basename(t, ".podspec") == name.gsub("_", "-") })
+          return path
+        elsif (path_index = podspec_contents.find_index { |t| t.include?(".module_name='#{name}'") })
+          return podspec_paths[path_index]
+        elsif (path_index = podspec_contents.find_index { |t| t.include?(".name='#{name}") }) # kind of optimistic,, but a last resort
+          return podspec_paths[path_index]
+        elsif (path_index = podspec_contents.find_index { |t| t.include?("'module_name':'#{name}'") }) # [json podspec]
+          return podspec_paths[path_index]
+        elsif (path_index = podspec_contents.find_index { |t| t.include?("'name':'#{name}") }) # [json podspec] kind of optimistic,, but a last resort
+          return podspec_paths[path_index]
+        else
+          return nil
+        end
+      end
+
+      def self.rewrite_lldinit(source_map_lines)
+        puts "Writing ~/.lldbinit-Xcode".yellow
+
+        lldbinit_path = File.expand_path('~/.lldbinit-Xcode')
+        FileUtils.touch(lldbinit_path)
+
+        lldbinit_lines = []
+        skipNext = false
+        File.read(lldbinit_path).each_line do |line|
+          if line.include?("# <pb>")
+            skipNext = true
+            next
+          elsif skipNext
+            skipNext = false
+            next
+          elsif line != "\n"
+            if line.include?("settings set target.source-map")
+              raise "\n\n~/.lldbinit-Xcode already includes a manual `settings set target.source-map`. This is unsupported and you'll have to manually remove that entry\n"
+            end
+            lldbinit_lines.push(line)
+          end
+        end
+
+        lldbinit_lines += source_map_lines
+      
+        File.write(lldbinit_path, lldbinit_lines.join("\n"))
+      end
+    end
+  end
+end

data/lib/pod_builder/configuration.rb

@@ -36,6 +36,7 @@ module PodBuilder
       attr_accessor :license_filename
       attr_accessor :subspecs_to_split
       attr_accessor :development_pods_paths
+      attr_accessor :build_base_path
       attr_accessor :build_path
       attr_accessor :configuration_filename
       attr_accessor :dev_pods_configuration_filename
@@ -60,7 +61,8 @@ module PodBuilder
     @license_filename = "Pods-acknowledgements"
     @subspecs_to_split = []
     @development_pods_paths = []
-    @build_path = "/tmp/pod_builder_#{(Time.now.to_f * 1000).to_i}".freeze
+    @build_base_path = "/tmp/pod_builder_".freeze
+    @build_path = "#{build_base_path}#{(Time.now.to_f * 1000).to_i}".freeze
     @configuration_filename = "PodBuilder.json".freeze
     @dev_pods_configuration_filename = "PodBuilderDevPodsPaths.json".freeze
     @lfs_min_file_size = MIN_LFS_SIZE_KB

data/lib/pod_builder/version.rb

@@ -1,4 +1,4 @@
 module PodBuilder
-  VERSION = "0.9.9"
+  VERSION = "1.0.0"
 end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pod-builder
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Tomas Camin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -254,6 +254,7 @@ files:
 - lib/pod_builder/command/switch.rb
 - lib/pod_builder/command/sync_podfile.rb
 - lib/pod_builder/command/update.rb
+- lib/pod_builder/command/update_lldbinit.rb
 - lib/pod_builder/configuration.rb
 - lib/pod_builder/core.rb
 - lib/pod_builder/info.rb