pod-builder 2.0.0.beta.21 → 2.0.0.beta.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38b88a4295edaa11ff7dd4f13ee2bce7cdef29f01f7b1784b619d99e670bdc57
-  data.tar.gz: 07dff8cb7ef9f8ece6b484f3310d747ff379ca93763cac482c57a1bcfe17d493
+  metadata.gz: 026afc87b8f1c1b60367e611927d1e958f9eab4fa8b362fe5530b8f364b73469
+  data.tar.gz: d20a47f60ffea78ad81acb3b7e015bbd62c081ac0b5e493d652a56c24ff07704
 SHA512:
-  metadata.gz: 3f7eae835712373a68c7ee54b12c8b3d7af9777abe4b96bdc179600c47d34f598c4d85c46e02f5af2da682953eb8766889e1cf2e7b86b8274ab73e8e0a617b50
-  data.tar.gz: c9e2c614bdd38c806f1818ed89e8371211ae5547eaab7cd07950a922397e13583c2df338d78c595f7ee316b1b3554bb38705e13110d6d898e07e5fcc5350d634
+  metadata.gz: 9ecececb6dca35557797fade2be225d7212d2090a5b2a94883842f7f1bf0d0cb9272eaf3abb721e92f50db8e6e7384453b0c9e5e6929a26a96310ba761dc0d45
+  data.tar.gz: b0f464538c82dc152c388a3cc20ab7b8b14a0a4e28469fea60ee7f7ecc314ea4475895b7fdecd387da8e12be437b4ccea005bd7bb148a9f16458d0a2c53ecd96

data/README.md

@@ -118,16 +118,20 @@ Will recompile all pods to the versions defined in the Restore-Podfile. You woul
 
 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 _PodBuilder/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
+#### `generate_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 a custom specified `lldbinit` file which will restore the ability to use the debugger and step into the code of your prebuilt dependencies.
+In some situations you may already have source code for your prebuilt frameworks, for example if your project is organized as a monorepo. 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. 
 
-The `lldbinit` should not be autoloaded from Xcode (e.g. should not be placed under ~/.lldbinit-Xcode) because it can cause weird issues with debugging. Instead load the file using a shared breakpoint placed at the beginning loading by invoking a 
+This command will generate a custom lldinit file which will be stored in the _PodBuilder_ folder. Note that this file is added to the .gitignore since it contains absolute path information. Since Xcode 11.5 customly defined lldbinit can be selected in the Run tab in your scheme project ("LLDB Init File"). You should select the generated llbb file path or, if you're using project generation tools such as XcodeGen, you can set it to `${SRCROOT}/../PodBuilder/lldbinit`.
 
+The most convenient place to update the lldbinit file is in your Podfile pre_install or post_install actions. It is suggested to add the following lines
 
-#### `clear_lldbinit` command
+````
+    pid = spawn("pod_builder generate_lldbinit")
+    Process.detach(pid)
+```
 
-Run this command to remove PodBuilder's customizations from the specified `lldbinit`.
+To generate lldbinit file. We're generating it asynchronously to avoid unnecessarily slow down `pod install` since this file will be needed only when build and running your application.
 
 #### `switch` command
 
@@ -308,16 +312,6 @@ Normally when multiple subspecs are specified in a target a single framework is
 }
 ```
 
-#### `lfs_update_gitattributes` 
-
-Adds a _.gitattributes_ to _PodBuilder/Prebuilt_ and _PodBuilder/dSYM_ to exclude large files. If `lfs_include_pods_folder` is true it will add a the same _.gitattributes_ to the application's _Pods_ folder as well.
-
-
-#### `lfs_include_pods_folder`
-
-See [`lfs_update_gitattributes`](#lfs_update_gitattributes).
-
-
 #### `use_bundler`
 
 If you use bundler to pin the version of CocoaPods in your project set this to true. Default false.
@@ -358,11 +352,6 @@ How to proceed in these cases?
 3. One-by-one switch your pods back to prebuilt, verifying everytime that your Project still compiles.
 
 
-### **Build failed with longish output to the stdout, what should I do next?**
-
-Relaunch the build command passing `-d`, this won't delete the temporary _/tmp/pod_builder_ folder on failure. Open _/tmp/pod_builder/Pods/Pods.xcproject_, make the Pods-DummyTarget target visible by clicking on _Show_ under _Product->Scheme->Manage shemes..._ and build from within Xcode. This will help you understand what went wrong. Remeber to verify that you're building the _Release_ build configuration.
-
-
 ### **Do I need to commit compiled frameworks?**
 
 No. If the size of compiled frameworks in your repo is a concern (and for whatever reason you can't use [Git-LFS](#git-lfs)) you can choose add the _Prebuilt_ and _dSYM_ folder to .gitignore and run `pod_builder update` to rebuild all frameworks that need to be recompiled.
@@ -374,9 +363,8 @@ Please open an issue here. You may also add the name of the pod to the [`skip_po
 
 # Git LFS
 
-PodBuilder integrates with [Git Large File Storage](https://git-lfs.github.com) to move large files, like the prebuilt frameworks, out of your git repo. This allows to benefit from the compilation speed ups of the precompiled frameworks without impacting on your repo overall size.
+We high encourage to use PodBuilder in combination with Git LFS. Tacking PodBuilder/Prebuilt/**/*.framework/* and PodBuilder/Prebuilt/**/*.a and PodBuilder/dSYM/**/* will ensure that your repo size stays under control with all the benefits of having prebuilt dependencies ready to use.
 
-When [`lfs_update_gitattributes = true`](#lfs_update_gitattributes) PodBuilder will automatically update the _.gitattributes_ with the files generated by PodBuilder when building pods.
 
 # Try it out!
 

data/exe/pod_builder

@@ -39,8 +39,7 @@ Command:
     + update                         Rebuild items that are outdated
     + restore_all                    Rebuild all pods declared in the Restore-Podfile
     + install_sources                Install sources of pods to debug into prebuilt items
-    + update_lldbinit                Generate an lldbinit file with setting target.source-map to debug prebuilt items
-    + clear_lldbinit                 Clear an lldbinit file from PodBuilder's customizations
+    + generate_lldbinit              Generate an lldbinit file with setting target.source-map to debug prebuilt items
     + switch                         Switch between prebuilt/development/standard pod in the Application-Podfile
     + clean                          Remove prebuild items, 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
@@ -198,14 +197,6 @@ Options:
       ]
     },
 
-    "update_lfs" => {
-      :opts => OptionParser.new do |opts|
-      end,
-      :call => [        
-        PodBuilder::Command::GenerateLFS
-      ]
-    },
-
     "deintegrate" => {           
       :opts => OptionParser.new do |opts|
         opts.banner = "
@@ -259,40 +250,27 @@ Usage:
       ]
     },
 
-    "update_lldbinit" => {         
+    "generate_lldbinit" => {         
       :opts => OptionParser.new do |opts|
         opts.banner = "
 Usage:
         
-    $ pod_builder update_lldbinit <LLDBINIT_PATH> <PATH>
-
-      Update LLDBINIT_PATH setting target.source-map in order to be able to step into 
-      and debug prebuilt prebuilt's code.
+    $ pod_builder generate_lldbinit [PATH]
 
-      Specify the PATH of the folder containing the source code of prebuilt items. PATH can be relative to PodBuilder's Prebuilt folder.
+      Update PodBuilder's custom lldbinit by setting the target.source-map which allows to
+      step into and debug prebuilt prebuilt's code. To allow this to work it is required
+      to specify a path containing the source code that generated the prebuilt item.
 
-"         
+      You can pass a [PATH] which PodBuilder will use to look for dependencies's source code. 
+      If omitted it will be implied that the project is organized as a monorepo expecting
+      source code dependencies to live in the project repo.
+"
       end,
       :call => [        
         PodBuilder::Command::UpdateLldbInit
       ]
     },
 
-    "clear_lldbinit" => {         
-      :opts => OptionParser.new do |opts|
-        opts.banner = "
-Usage:
-        
-    $ pod_builder clear_lldbinit <LLDBINIT_PATH>
-
-      Clear LLDBINIT_PATH setting target.source-map PodBuilder's customizations
-"         
-      end,
-      :call => [        
-        PodBuilder::Command::ClearLldbInit
-      ]
-    },
-
     "switch" => {      
       :opts => OptionParser.new do |opts|
         opts.banner = "

data/lib/pod_builder/command.rb

@@ -9,8 +9,6 @@ require 'pod_builder/command/deintegrate'
 require 'pod_builder/command/generate_podspec'
 require 'pod_builder/command/install_sources'
 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'
-require 'pod_builder/command/clear_lldbinit'
+require 'pod_builder/command/generate_lldbinit'

data/lib/pod_builder/command/build.rb

@@ -96,7 +96,6 @@ module PodBuilder
 
         Licenses::write(licenses, all_buildable_items)
 
-        GenerateLFS::call()
         Podspec::generate(all_buildable_items, analyzer)
 
         builded_pods = podfiles_items.flatten

data/lib/pod_builder/command/generate_lldbinit.rb

@@ -0,0 +1,151 @@
+require 'pod_builder/core'
+require 'digest'
+
+module PodBuilder
+  module Command
+    class UpdateLldbInit
+      def self.call
+        Configuration.check_inited
+        if Configuration.build_using_repo_paths
+          raise "\n\nlldb shenanigans not supported when 'build_using_repo_paths' is enabled".red
+        end
+
+        arguments = ARGV.dup
+
+        if arguments.count > 0
+          source_path = arguments[0]
+          if !is_absolute_path(source_path)
+            source_path = PodBuilder::basepath(source_path)
+          end
+          source_path = File.expand_path(source_path)  
+
+          raise "\n\nSpecified path does not exists" unless File.directory?(source_path)
+        end
+
+        base_path = PodBuilder::basepath
+            
+        app_podfile_content = File.read(PodBuilder::project_path("Podfile"))
+        podfile_hash = Digest::MD5.hexdigest(app_podfile_content)
+
+        lldbinit_path = File.expand_path(PodBuilder::basepath(Configuration.lldbinit_name))
+        lldbinit_content = File.exist?(lldbinit_path) ? File.read(lldbinit_path) : ""
+
+        if lldbinit_content.include?("# <pb_md5:#{base_path}:#{podfile_hash}")
+          puts "\n\n🎉 already in sync!\n".green
+          return 0
+        end
+
+        puts "Extracting debug information".yellow
+
+        unless source_path.nil?
+          podspec_paths = Dir.glob("#{source_path}/**/*.podspec") + Dir.glob("#{source_path}/**/*.podspec.json")
+          podspec_contents = podspec_paths.map { |t| File.read(t).gsub(/\s+/, "").gsub("\"", "'") }
+        end
+
+        source_map_lines = []
+        Dir.glob("#{PodBuilder::prebuiltpath}/**/Podbuilder.json").each do |path|
+          data = JSON.parse(File.read(path))
+          next if data.fetch("is_prebuilt", true)
+
+          # It would be much nicer if PodBuilder.json already contained this info in a custom key
+          pod_name_matches = data["entry"].match(/pod '(.*?)'/)
+          next unless pod_name_matches&.size == 2
+          
+          podspec_name = pod_name_matches[1]
+          podspec_path = "#{File.dirname(path)}/#{podspec_name}.podspec"
+          
+          next unless File.exist?(podspec_path)
+
+          build_source_path_matches = data["entry"].match(/:path => '(.*?)'/)
+          if build_source_path_matches&.size == 2
+            build_source_path = build_source_path_matches[1]
+            
+            if !is_absolute_path(build_source_path[0])
+              build_source_path = PodBuilder::basepath(build_source_path)
+            end
+            build_source_path = File.expand_path(build_source_path)  
+          elsif source_path.nil?
+            next
+          else
+            # Find source code for podspec_name
+            podspec_path = find_podspec_path_for(podspec_name, podspec_paths, podspec_contents)
+            next if podspec_path.nil?
+          end
+          
+          original_compile_path = data["original_compile_path"] + "/Pods/#{podspec_name}"
+          if is_prebuilt_pod(podspec_path, app_podfile_content)
+            unless source_map_lines.include?("settings append target.source-map '#{original_compile_path}'")
+              source_map_lines.push("# <pb:#{base_path}>\n", "settings append target.source-map '#{original_compile_path}' '#{build_source_path}'\n")
+            end
+          end
+        end
+
+        rewrite_lldinit(lldbinit_path, source_map_lines, base_path, podfile_hash)
+        
+        puts "\n\n🎉 done!\n".green
+        return 0
+      end
+
+      private 
+
+      def self.is_absolute_path(path)
+        return ["~", "/"].any? { |t| t.start_with?(t) }
+      end
+
+      def self.is_prebuilt_pod(podspec_path, app_podfile_content)
+        development_path = Pathname.new(podspec_path).relative_path_from(Pathname.new(PodBuilder::project_path)).parent.to_s
+
+        return app_podfile_content.include?(":path => '#{development_path}'")
+      end
+
+      def self.rewrite_lldinit(lldbinit_path, source_map_lines, base_path, podfile_hash)
+        puts "Writing #{lldbinit_path}".yellow
+
+        FileUtils.touch(lldbinit_path)
+        raise "\n\nDestination file should be a file".red unless File.exist?(lldbinit_path)
+
+        lldbinit_lines = []
+        skipNext = false
+        File.read(lldbinit_path).each_line do |line|
+          if line.include?("# <pb:#{base_path}>") || 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_destination_path} already includes a manual `settings set target.source-map`. This is unsupported and you'll have to manually remove that entry\n".red
+            end
+            lldbinit_lines.push(line)
+          end
+        end
+
+        source_map_lines.insert(0, "# <pb>\n")
+        source_map_lines.insert(1, "settings clear target.source-map\n")
+        source_map_lines.insert(2, "# <pb:#{base_path}>\n")
+        source_map_lines.insert(3, "# <pb_md5:#{base_path}:#{podfile_hash}>\n")
+
+        lldbinit_lines += source_map_lines
+      
+        File.write(lldbinit_path, lldbinit_lines.join())
+      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
+    end
+  end
+end

data/lib/pod_builder/command/init.rb

@@ -22,17 +22,8 @@ module PodBuilder
         FileUtils.mkdir_p("#{OPTIONS[:prebuild_path]}/.pod_builder")
         FileUtils.touch("#{OPTIONS[:prebuild_path]}/.pod_builder/pod_builder")
 
-        source_path_rel_path = "Sources"
-        development_pods_config_rel_path = Configuration.dev_pods_configuration_filename
-
-        git_ignores = ["Pods/",
-                       "*.xcworkspace",
-                       "*.xcodeproj",
-                       "Podfile.lock",
-                       source_path_rel_path,
-                       development_pods_config_rel_path]
-        
-        File.write("#{OPTIONS[:prebuild_path]}/.gitignore", git_ignores.join("\n"))
+        write_gitignore
+        write_gitattributes
 
         project_podfile_path = PodBuilder::project_path("Podfile")
         prebuilt_podfile_path = File.join(OPTIONS[:prebuild_path], "Podfile")
@@ -45,7 +36,9 @@ module PodBuilder
         podfile_content = Podfile.update_project_entries(podfile_content, Init.method(:podfile_path_transform))
         podfile_content = Podfile.update_require_entries(podfile_content, Init.method(:podfile_path_transform))
 
-        podfile_content = Podfile.prepare_for_react_native(podfile_content)
+        if podfile_content.include?("/node_modules/react-native/")
+          podfile_content = Podfile.prepare_for_react_native(podfile_content)
+        end
 
         File.write(prebuilt_podfile_path, podfile_content)
 
@@ -59,6 +52,27 @@ module PodBuilder
 
       private 
 
+      def self.write_gitignore
+        source_path_rel_path = "Sources"
+        development_pods_config_rel_path = Configuration.dev_pods_configuration_filename
+
+        git_ignores = ["Pods/",
+                       "*.xcworkspace",
+                       "*.xcodeproj",
+                       "Podfile.lock",
+                       Configuration.lldbinit_name,
+                       source_path_rel_path,
+                       development_pods_config_rel_path]
+        
+        File.write("#{OPTIONS[:prebuild_path]}/.gitignore", git_ignores.join("\n"))
+      end
+
+      def self.write_gitattributes
+        git_attributes = ["#{Configuration.prebuilt_info_filename} binary"]
+        
+        File.write("#{OPTIONS[:prebuild_path]}/.gitattributes", git_attributes.join("\n"))
+      end
+
       def self.podfile_path_transform(path)
         use_absolute_paths = false
         podfile_path = File.join(OPTIONS[:prebuild_path], "Podfile")

data/lib/pod_builder/configuration.rb

@@ -23,7 +23,6 @@ module PodBuilder
     DEFAULT_FORCE_PREBUILD_PODS = ["Firebase", "GoogleTagManager"]
     DEFAULT_BUILD_SYSTEM = "Legacy".freeze # either Latest (New build system) or Legacy (Standard build system)
     DEFAULT_LIBRARY_EVOLUTION_SUPPORT = false
-    MIN_LFS_SIZE_KB = 256.freeze
     DEFAULT_PLATFORMS = ["iphoneos", "iphonesimulator", "appletvos", "appletvsimulator"].freeze
     DEFAULT_BUILD_FOR_APPLE_SILICON = false
     DEFAULT_BUILD_USING_REPO_PATHS = false
@@ -31,7 +30,6 @@ module PodBuilder
     private_constant :DEFAULT_BUILD_SETTINGS
     private_constant :DEFAULT_BUILD_SYSTEM
     private_constant :DEFAULT_LIBRARY_EVOLUTION_SUPPORT
-    private_constant :MIN_LFS_SIZE_KB
     
     class <<self      
       attr_accessor :allow_building_development_pods
@@ -51,9 +49,6 @@ module PodBuilder
       attr_accessor :build_path
       attr_accessor :configuration_filename
       attr_accessor :dev_pods_configuration_filename
-      attr_accessor :lfs_min_file_size
-      attr_accessor :lfs_update_gitattributes
-      attr_accessor :lfs_include_pods_folder
       attr_accessor :project_name
       attr_accessor :restore_enabled
       attr_accessor :prebuilt_info_filename
@@ -65,6 +60,7 @@ module PodBuilder
       attr_accessor :build_for_apple_silicon
       attr_accessor :build_using_repo_paths
       attr_accessor :react_native_project
+      attr_accessor :lldbinit_name
     end
     
     @allow_building_development_pods = false
@@ -84,14 +80,12 @@ module PodBuilder
     @build_path = build_base_path
     @configuration_filename = "PodBuilder.json".freeze
     @dev_pods_configuration_filename = "PodBuilderDevPodsPaths.json".freeze
-    @lfs_min_file_size = MIN_LFS_SIZE_KB
-    @lfs_update_gitattributes = false
-    @lfs_include_pods_folder = false
     @project_name = ""
     @restore_enabled = true
     @prebuilt_info_filename = "PodBuilder.json"
     @lockfile_name = "PodBuilder.lock"
     @lockfile_path = "/tmp/#{lockfile_name}"
+    @lldbinit_name = "lldbinit".freeze
 
     @use_bundler = false
     @deterministic_build = false
@@ -173,16 +167,6 @@ module PodBuilder
             Configuration.subspecs_to_split = value
           end
         end
-        if value = json["lfs_update_gitattributes"]
-          if [TrueClass, FalseClass].include?(value.class)
-            Configuration.lfs_update_gitattributes = value
-          end
-        end
-        if value = json["lfs_include_pods_folder"]
-          if [TrueClass, FalseClass].include?(value.class)
-            Configuration.lfs_include_pods_folder = value
-          end
-        end
         if value = json["project_name"]
           if value.is_a?(String) && value.length > 0
             Configuration.project_name = value
@@ -262,8 +246,6 @@ module PodBuilder
       config["library_evolution_support"] = Configuration.library_evolution_support
       config["license_filename"] = Configuration.license_filename
       config["subspecs_to_split"] = Configuration.subspecs_to_split
-      config["lfs_update_gitattributes"] = Configuration.lfs_update_gitattributes
-      config["lfs_include_pods_folder"] = Configuration.lfs_include_pods_folder
       config["restore_enabled"] = Configuration.restore_enabled
       config["allow_building_development_pods"] = Configuration.allow_building_development_pods
       config["use_bundler"] = Configuration.use_bundler