enrich-pod-patcher 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 310dd4c977748c88b926f757e3a345d7894359b7857021f20c0784496acc9dc5
+  data.tar.gz: 994ad2bdc661218e7bfe7ffc53a3d59a4c1878d61d1eb9ba0d0e71c7f98c7830
+SHA512:
+  metadata.gz: 8c9842268a7af22c4e60f073efbf1bbfd4650f6d6633f560fef351b811b165207920915c4ac7341a59a726c8d0810b2ba91bef3dff43f70c785912a37ad6e7c4
+  data.tar.gz: 3477da36f4bf3a89a1ed48e48e6004b79c86817ed64d06ebd998a9a209d18b785ef6fbddf11ee99584195aeb10b1ed54513bd585f571e03c66f4be151189bfea

data/README.md

@@ -0,0 +1,48 @@
+
+# cocoapods-patch
+
+cocoapods-patch is a Cocoapods plugin that solves the problem of forking and maintaining a separate version of a Pod when only a small (often a one-liner), long-lived change in the original Pod is needed.
+
+The idea behind the plugin is that patches should live inside the repo (in the `patches` directory) and be distributed together with the rest of your source code. This way, you can more easily code review and test the changes to a Pod and keep it synced across your team.
+
+## Installation
+
+First, install the plugin
+
+    $ gem install cocoapods-patch
+
+Next, add a `plugin 'cocoapods-patch'` line to your Podfile to use the plugin. This will enable [automatic apply](#automatically-applying-all-patches-on-install) so you don't have to worry about it again.
+
+That's it, you're done.
+
+**NOTE:**
+`cocoapods-patch` version 1.0.0 and above require you to use Cocoapods 1.11.0 or greater.
+For anything below that please use version 0.0.9.
+
+## Migrating to v1.0.1+
+
+In v1.0.1 of the plugin we've changed the naming scheme of the generated patch files to also include the version of the pods used to generate the patches. This will allow us to do more automation safety and make sure patches are applied successfully.
+
+We've added a new command to help with the migration. After updating before doing a `pod install` please first run `pod patch migrate` which will translate any existing patches into their new format. This will use the current version of the pods stated in your lockfile.
+
+## Usage
+
+### Creating a patch
+
+To create a patch, first, you need to modify the source code of the installed Pod. Do the desired changes to the Pod source code (under the `Pods/` directory). Once you're satisfied with the result, run:
+
+    pod patch create POD_NAME
+
+This will create a `patches/POD_NAME.diff` file in your repository. The patch is a diff between the Pod version you have specified in your Podfile and your local changes to the Pod. You can now add and commit this patch.
+
+### Automatically applying all patches on install
+
+cocoapod-patch can be seamlessly integrated into the normal iOS development workflow. If you follow the installation instructions and add `plugin 'cocoapods-patch'` to your Podfile, every time you do a `pod install`, the plugin will go throught all the available patches and try to apply them. It will only warn you when the patch cannot be applied.
+
+### Applying a patch manually
+
+When you want to apply a patch to a pod, run
+
+    pod patch apply POD_NAME
+
+This command will look for the appropriate patch in the `patches` directory and, if possibly, apply it to your local Pod. A patch can be applied only once.

data/lib/cocoapods_patch.rb

@@ -0,0 +1,3 @@
+module EnrichPodPatcher
+  VERSION = "1.2.0"
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,2 @@
+require 'pod/command'
+require 'pod/hook'

data/lib/pod/command/patch/apply.rb

@@ -0,0 +1,53 @@
+require 'cocoapods'
+
+module Pod
+  class Command
+    class Patch < Command
+      class Apply < Patch
+        self.summary = 'Applies a patch to an installed Pod'
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true)
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          help! 'A Pod name is required.' unless @name
+        end
+
+        def run
+          apply_patch patch_file
+        end
+      end
+    end
+  end
+end
+
+# also used from the post-install hook
+def apply_patch(patch_file)
+  working_dir = Dir.pwd
+  repo_root = `git rev-parse --show-toplevel`.strip
+  ios_project_path = Pathname.new(working_dir).relative_path_from(Pathname.new(repo_root))
+
+  directory_arg = (ios_project_path.to_s.eql? ".") ? "Pods" : File.join(ios_project_path, 'Pods')
+
+  Dir.chdir(repo_root) {
+    check_cmd = "git apply --check '#{patch_file}' --directory='#{directory_arg}' -p2 2> /dev/null"
+
+    can_apply = system(check_cmd)
+    if can_apply
+      apply_cmd = check_cmd.gsub('--check ', '')
+      did_apply = system(apply_cmd)
+      if did_apply
+        Pod::UI.puts "Successfully applied #{patch_file} 🎉"
+      else
+        Pod::UI.warn "Error: failed to apply #{patch_file}"
+      end
+    end
+  }
+end

data/lib/pod/command/patch/create.rb

@@ -0,0 +1,80 @@
+require 'pathname'
+
+module Pod
+  class Command
+    class Patch < Command
+      class Create < Patch
+        self.description = <<-DESC
+            Creates a patch file comparing your local Pod changes to the upstream
+            version specified in your Podfile. The patch is saved into the `patches`
+            directory.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true)
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          help! 'A Pod name is required.' unless @name
+        end
+
+        def clear_patches_folder_if_empty
+          if Dir.empty?(patches_path)
+            FileUtils.remove_dir(patches_path)
+          end
+        end
+
+        def run
+          # create patches folder if it doesn't exist
+          FileUtils.mkdir_p(patches_path)
+
+          Dir.mktmpdir('cocoapods-patch-', config.project_root) do |work_dir|
+            sandbox = Pod::Sandbox.new(work_dir)
+            installer = Pod::Installer.new(sandbox, config.podfile, config.lockfile)
+            installer.clean_install = true
+
+            installer.prepare
+            installer.resolve_dependencies
+
+            UI.puts "Checking if pod exists in project..."
+            specs_by_platform = installer.send :specs_for_pod, @name
+
+            if specs_by_platform.empty?
+              clear_patches_folder_if_empty
+              help! "Given pod does not exist in project. Did you use incorrect pod name?"
+
+              return
+            end
+
+            pod_installer = installer.send :create_pod_installer, @name
+            pod_installer.install!
+
+            UI.puts "Creating patch"
+            theirs = Pathname.new(work_dir).join(@name).relative_path_from(config.project_root)
+            ours = config.project_pods_root.join(@name).relative_path_from(config.project_root)
+            gen_diff_cmd = "git diff --no-index '#{theirs}' '#{ours}' > '#{patch_file}'"
+
+            did_succeed = system(gen_diff_cmd)
+            if not did_succeed.nil?
+              if File.empty?(patch_file)
+                File.delete(patch_file)
+                clear_patches_folder_if_empty
+                UI.warn "Error: no changes detected between current pod and original"
+              else
+                UI.puts "Created patch #{patch_file} 🎉"
+              end
+            else
+              UI.warn "Error: failed to create patch for #{@name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pod/command/patch/migrate.rb

@@ -0,0 +1,44 @@
+require 'pathname'
+
+module Pod
+  class Command
+    class Patch < Command
+      class Migrate < Patch
+        self.description = <<-DESC
+            Migrates previous patch files to the new format.
+        DESC
+
+        def clear_patches_folder_if_empty
+          if Dir.empty?(patches_path)
+            FileUtils.remove_dir(patches_path)
+          end
+        end
+
+        def run
+          UI.puts 'Migrating patches...'
+          patches_dir = Pathname.new(Dir.pwd) + 'patches'
+          if patches_dir.directory?
+            patches = patches_dir.each_child.select { |c| c.to_s.end_with?('.diff') }
+            patches.each do |p|
+              # check if patch file has new format
+              if p.to_s.include?('+')
+                # do nothing
+              else
+                # rename patch file
+                pod_name = p.basename('.diff').to_s
+                UI.puts "Renaming #{pod_name}"
+
+                pod_version = config.lockfile.version(pod_name)
+                new_patch_name = p.to_s.gsub('.diff', "+#{pod_version}.diff")
+                
+                File.rename(p, new_patch_name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/pod/command/patch.rb

@@ -0,0 +1,20 @@
+require_relative 'patch/apply'
+require_relative 'patch/create'
+
+module Pod
+  class Command
+    class Patch < Command
+      self.abstract_command = true
+      self.summary = 'Create & apply patches to Pods.'
+
+      def patch_file
+        version = config.lockfile.version(@name)
+        return config.project_root + 'patches' + "#{@name}+#{version}.diff"
+      end
+
+      def patches_path
+        config.project_root + 'patches'
+      end
+    end
+  end
+end

data/lib/pod/command.rb

@@ -0,0 +1,4 @@
+require_relative 'command/patch'
+require_relative 'command/patch/apply'
+require_relative 'command/patch/create'
+require_relative 'command/patch/migrate'

data/lib/pod/hook.rb

@@ -0,0 +1,54 @@
+require 'cocoapods'
+require 'pathname'
+require_relative 'command/patch/apply'
+
+module EnrichPodPatcher
+  module Hooks
+    Pod::HooksManager.register('enrich-pod-patcher', :pre_install) do |context|
+      Pod::UI.puts 'Preparing patchable pods for clean patching'
+      patches_dir = Pathname.new(Dir.pwd) + 'patches'
+      if patches_dir.directory?
+        patches = patches_dir.each_child.select { |c| c.to_s.end_with?('.diff') }
+        patches.each do |p|
+          pod_name = File.basename(p, ".diff")
+          pod_dir = context.sandbox.pod_dir(pod_name)
+          context.sandbox.clean_pod(pod_name, pod_dir)
+        end
+      end
+    end
+  end
+end
+
+class Pod::Installer
+  # Because our patches may also delete files, we need to apply them before the pod project is generated
+  # The project is generated in the `integrate` method, so we override it
+  # We first run our patch action and then the original implementation of the method
+  # Reference: https://github.com/CocoaPods/CocoaPods/blob/760828a07f8fcfbff03bce13f56a1789b6f5a95d/lib/cocoapods/installer.rb#L178
+  alias_method :integrate_old, :integrate
+
+  def integrate
+    # apply our patches
+    apply_patches
+    # run the original implementation
+    integrate_old
+  end
+
+  def apply_patches
+    Pod::UI.puts 'Applying patches if necessary'
+      patches_dir = Pathname.new(Dir.pwd) + 'patches'
+      if patches_dir.directory?
+        patches = patches_dir.each_child.select { |c| c.to_s.end_with?('.diff') }
+        patches.each do |p|
+          pod_name = File.basename(p, ".diff")
+          # check if patch is in new format otherwise warn user
+          unless p.to_s.include?('+')
+            Pod::UI.puts "WARNING: #{pod_name}.diff has an old naming format. Please run pod patch migration first before pod install. See the README for more information.".yellow
+          end
+
+          apply_patch(p)
+        end
+      end
+  end
+end
+
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: enrich-pod-patcher
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Enrich Software Corp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Create & apply patches to Pods
+email:
+- doug.yuen@enrichsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/cocoapods_patch.rb
+- lib/cocoapods_plugin.rb
+- lib/pod/command.rb
+- lib/pod/command/patch.rb
+- lib/pod/command/patch/apply.rb
+- lib/pod/command/patch/create.rb
+- lib/pod/command/patch/migrate.rb
+- lib/pod/hook.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Create & apply patches to Pods
+test_files: []