pod-builder 2.0.0.beta.25 → 2.0.0.beta.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b20eb1955937c42e11f9e8e261f40a907a50a7225a6a892915963d82b99317
-  data.tar.gz: 3a2b45e51f95e4573bfc29838181f823fa9c12b754c751cb0506c28c3a09a60c
+  metadata.gz: d4cde0acf0b503aaa846162710c25456d306b0ae6e53492b717795e4540f5b9f
+  data.tar.gz: ddfc897b5dd2d280a2b5e636706d62c854d01bb34f605b813d70a48ace6fad75
 SHA512:
-  metadata.gz: 7ca77c2cce6fdc77c95a6748cbaf1cf08dc6163cf0906ae09a90a05373832d5dc35c4a4b04a57a00776bed873eb5cbee590127749d5d93cd621b85fd88ec5eed
-  data.tar.gz: 22d3bc57f93f27118788ecd95097eaa9d522032e6a19fd5f9ab673834fb2d3655c5f9387b57cbdd01cf77b3d41ad39e59563151e2680cd5bccea938cacb14b42
+  metadata.gz: 5f468d84983dc689b5dceef947da7d3ce586bd2d34be76ec439a236ba45435a6865b54d154233fdae038352ff1582cb68fcfdc520e5a101ed4842d86cde3e973
+  data.tar.gz: f45e9377fd79dff65b9c72580a29308172cc3cf3410093c2a6d2a7c9245c7000bc732b4d78473dd58ef14a3712a7cb9697bf87e7cd8331f8b413e0f550c04cc4

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
 
@@ -296,28 +300,6 @@ PodBuilder writes a plist and markdown license files of pods specified in the Po
 }
 ```
 
-#### `subspecs_to_split`
-
-Normally when multiple subspecs are specified in a target a single framework is produced. There are rare cases where you specify different subspecs in different targets: a typical case is subspec specifically designed for app extensions, where you want to use a subspec in the main app and another one in the app extension. 
-
-**Warning**: This will work properly only for static frameworks (_static_framework = true_ specified in the podspec). See [issue](https://github.com/CocoaPods/CocoaPods/issues/5708) and [issue](https://github.com/CocoaPods/CocoaPods/issues/5643)
-
-```json
-{
-    "subspecs_to_split": ["Podname1/Subspec1", "Podname1/Subspec2", "Podname2/Subspec1", "Podname2/Subspec1"]
-}
-```
-
-#### `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 +340,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 +351,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
@@ -72,7 +71,7 @@ Options:
           OPTIONS[:update_repos] = false
         end
         opts.on("-f", "--force", "Rebuild items even when no code change is detected") do |o|
-          OPTIONS[:force_rebuild] = false
+          OPTIONS[:force_rebuild] = true
         end
         opts.on("-w", "--allow-warnings", "Allow warnings") do |o|
           OPTIONS[:allow_warnings] = o
@@ -80,6 +79,9 @@ Options:
         # opts.on("-a", "--auto-resolve-deps", "Resolve pod dependencies automatically") do |o|
         #   OPTIONS[:auto_resolve_dependencies] = o
         # end
+        opts.on("-s", "--no-stdin", "Never request interaction with sdtin (e.g. in CI environment)") do |o|
+          OPTIONS[:no_stdin_available] = o
+        end
         opts.on("-d", "--debug", "Don't clean build folder") do |o|
           OPTIONS[:debug] = o
         end
@@ -109,6 +111,9 @@ Options:
         opts.on("-w", "--allow-warnings", "Allow warnings") do |o|
           OPTIONS[:allow_warnings] = o
         end
+        opts.on("-s", "--no-stdin", "Never request interaction with sdtin (e.g. in CI environment)") do |o|
+          OPTIONS[:no_stdin_available] = o
+        end
         opts.on("-d", "--debug", "Don't clean build folder") do |o|
           OPTIONS[:debug] = o
         end
@@ -198,14 +203,6 @@ Options:
       ]
     },
 
-    "update_lfs" => {
-      :opts => OptionParser.new do |opts|
-      end,
-      :call => [        
-        PodBuilder::Command::GenerateLFS
-      ]
-    },
-
     "deintegrate" => {           
       :opts => OptionParser.new do |opts|
         opts.banner = "
@@ -259,40 +256,27 @@ Usage:
       ]
     },
 
-    "update_lldbinit" => {         
+    "generate_lldbinit" => {         
       :opts => OptionParser.new do |opts|
         opts.banner = "
 Usage:
         
-    $ pod_builder update_lldbinit <LLDBINIT_PATH> <PATH>
+    $ pod_builder generate_lldbinit [PATH]
 
-      Update LLDBINIT_PATH setting target.source-map in order to be able to step into 
-      and debug prebuilt prebuilt's code.
+      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.
 
-      Specify the PATH of the folder containing the source code of prebuilt items. PATH can be relative to PodBuilder's Prebuilt folder.
-
-"         
+      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 = "
@@ -397,7 +381,7 @@ begin
 rescue Exception => e
   error = e.to_s
 
-  if error.length < 1000
+  if error.length < 1000 || !File.directory?(PodBuilder::Configuration.build_path)
     puts "#{error.red}\n"
     puts e.backtrace.join("\n\t").red
     puts "\n\nCommand failed!".red

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

@@ -49,55 +49,50 @@ module PodBuilder
 
         restore_file_error = Podfile.restore_file_sanity_check
   
-        check_splitted_subspecs_are_static(all_buildable_items)
         check_pods_exists(argument_pods, all_buildable_items)
 
         pods_to_build = resolve_pods_to_build(argument_pods, buildable_items)
         buildable_items -= pods_to_build
 
         # We need to split pods to build in 3 groups
-        # 1. subspecs: because the resulting .framework path is treated differently when added to Configuration.subspecs_to_split
-        # 2. pods to build in release
-        # 3. pods to build in debug
+        # 1. pods to build in release
+        # 2. pods to build in debug
 
         check_not_building_development_pods(pods_to_build)
 
-        pods_to_build_subspecs = pods_to_build.select { |x| x.is_subspec && Configuration.subspecs_to_split.include?(x.name) }
-
         # Remove dependencies from pods to build
         all_dependencies_name = pods_to_build.map(&:dependency_names).flatten.uniq
         pods_to_build.select! { |x| !all_dependencies_name.include?(x.name) }
 
-        pods_to_build -= pods_to_build_subspecs
         pods_to_build_debug = pods_to_build.select { |x| x.build_configuration == "debug" }
         pods_to_build_release = pods_to_build - pods_to_build_debug
 
         check_dependencies_build_configurations(all_buildable_items)
 
-        podfiles_items = pods_to_build_subspecs.map { |x| [x] }
-        podfiles_items.push(pods_to_build_debug)
-        podfiles_items.push(pods_to_build_release)   
+        podfiles_items = [pods_to_build_debug] + [pods_to_build_release]
 
-        licenses = []
+        install_using_frameworks = Podfile::install_using_frameworks(analyzer)
         
-        podfiles_items.select { |x| x.count > 0 }.each do |podfile_items|
+        install_result = InstallResult.new
+        podfiles_items.reject { |x| x.empty? }.each do |podfile_items|
           build_configuration = podfile_items.map(&:build_configuration).uniq.first
           
           podfile_items = podfile_items.map { |t| t.recursive_dependencies(all_buildable_items) }.flatten.uniq
-          podfile_content = Podfile.from_podfile_items(podfile_items, analyzer, build_configuration)
+          podfile_content = Podfile.from_podfile_items(podfile_items, analyzer, build_configuration, install_using_frameworks)
           
-          licenses += Install.podfile(podfile_content, podfile_items, podfile_items.first.build_configuration)
+          install_result += Install.podfile(podfile_content, podfile_items, podfile_items.first.build_configuration)          
           
           # remove lockfile which gets unexplicably created
           FileUtils.rm_f(PodBuilder::basepath("Podfile.lock"))
         end
 
+        install_result.write_prebuilt_info_files
+
         Clean::prebuilt_items(all_buildable_items)
 
-        Licenses::write(licenses, all_buildable_items)
+        Licenses::write(install_result.licenses, all_buildable_items)
 
-        GenerateLFS::call()
-        Podspec::generate(all_buildable_items, analyzer)
+        Podspec::generate(all_buildable_items, analyzer, install_using_frameworks)
 
         builded_pods = podfiles_items.flatten
         
@@ -140,24 +135,6 @@ module PodBuilder
         end
       end
 
-      def self.check_splitted_subspecs_are_static(all_buildable_items)
-        non_static_subspecs = all_buildable_items.select { |x| x.is_subspec && x.is_static == false }
-        non_static_subspecs_names = non_static_subspecs.map(&:name)
-
-        invalid_subspecs = Configuration.subspecs_to_split & non_static_subspecs_names # intersect
-
-        unless invalid_subspecs.count > 0
-          return
-        end
-
-        warn_message = "The following pods `#{invalid_subspecs.join(" ")}` are non static binaries which are being splitted over different targets. Beware that this is an unsafe setup as per https://github.com/CocoaPods/CocoaPods/issues/5708 and https://github.com/CocoaPods/CocoaPods/issues/5643\n\nYou can ignore this error by passing the `--allow-warnings` flag to the build command\n"
-        if OPTIONS[:allow_warnings]
-          puts "\n\n⚠️  #{warn_message}".yellow
-        else
-          raise "\n\n🚨️  #{warn_message}".red
-        end
-      end
-
       def self.check_dependencies_build_configurations(pods)
         pods.each do |pod|
           pod_dependency_names = pod.dependency_names.select { |x| !pod.has_common_spec(x) }
@@ -197,9 +174,9 @@ module PodBuilder
         if !expected_stripped.all? { |x| stripped_lines.include?(x) }
           warn_message = "PodBuilder's post install actions missing from application Podfile!\n"
           if OPTIONS[:allow_warnings]
-            puts "\n\n⚠️  #{warn_message}".yellow
+            puts "\n\n#{warn_message}".yellow
           else
-            raise "\n\n🚨️  #{warn_message}".red
+            raise "\n\n#{warn_message}".red
           end
         end
       end

data/lib/pod_builder/command/clean.rb

@@ -23,7 +23,7 @@ module PodBuilder
         puts "Cleaning prebuilt folder".yellow
 
         root_names = buildable_items.map(&:root_name).uniq
-        Dir.glob(File.join(PodBuilder::prebuiltpath, "*")).each do |path|
+        Dir.glob(PodBuilder::prebuiltpath("*")).each do |path|
           basename = File.basename(path)
           unless root_names.include?(basename) 
             puts "Cleanining up `#{basename}`, no longer found among dependencies".blue
@@ -65,7 +65,7 @@ module PodBuilder
 
         paths_to_delete.flatten.each do |path|
           confirm = ask("#{path} unused.\nDelete it? [Y/N] ") { |yn| yn.limit = 1, yn.validate = /[yn]/i }
-          if confirm.downcase == 'y'
+          if confirm.downcase == 'y' || OPTIONS.has_key?(:no_stdin_available)
             PodBuilder::safe_rm_rf(path)
           end
         end

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}/**/#{Configuration.prebuilt_info_filename}").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