cocoapods-patch 0.0.7 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2626728359e198af7ecc119c2bc846520c233f725cea13857a12a936bfacb527
-  data.tar.gz: ef94a39a36598ce2274b099f34af86953a21086d52b135dff893f6e21cf5aebf
+  metadata.gz: 9f8a1091ce7f95d367d0fb5cdcdc01533bade7aa87c3750c03607ca0d0d6893b
+  data.tar.gz: 91ad3babdd2763618a7bedc0bb4186d63558df08c6bbc2a72453e4dcc2fbe555
 SHA512:
-  metadata.gz: 230e132b95a6bcadeb9e442fa5576ec5b57c36cefc543fae0feed769569fbadf4ac0e0f8e7799939e938a3bdede73d15517e150a3e6daf042471d2321fc9584b
-  data.tar.gz: d335a0613d53c0931caacd4e2938e8083d7b32cdbb843dd406b91e5714a77e8b678537577fa8d05cef2d2f2a4accfc39a80f210db17f074f3d22012d82e4b5a8
+  metadata.gz: 56c086ce0f18238fedb169377d9de115cf50a660d2d5356b78c9c973441fe79e30f98372fcce72242431afcbbe418ae95aaaa23f5986ba9bdbdf551f8a8843ba
+  data.tar.gz: 29cafa7c713700b5ff74a3c82ade35f20885d8411ee9a117be870e473ee60a8d4c58f377c0506ab9e2b4ef382734b1768c4318d65c930000008357178221749d

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Installation & Update
+
+To install or update cocoapods-patch see [README](https://github.com/DoubleSymmetry/cocoapods-patch).
+
+## Master
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* None.
+
+## 1.0.1 (2.11.21)
+
+##### Enhancements
+
+* Change name of generated patch files to include pod version used
+  [dcvz](https://github.com/dcvz)
+
+* Use lockfile to use more correct installation of fresh dependencies.
+  [dcvz](https://github.com/dcvz)
+
+##### Bug Fixes
+
+* None.
+
+## 1.0.0 (1.11.21)
+
+##### Enhancements
+
+* Use official pre_integrate hook
+  [dcvz](https://github.com/dcvz)
+  [#7](https://github.com/DoubleSymmetry/cocoapods-patch/pull/7)
+
+##### Bug Fixes
+
+* None.

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/gem_version.rb → cocoapods_patch.rb}

@@ -1,3 +1,3 @@
 module CocoapodsPatch
-  VERSION = "0.0.7"
+  VERSION = "1.0.1"
 end

data/lib/cocoapods_plugin.rb

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

data/lib/{cocoapods-patch → pod}/command/patch/apply.rb

@@ -37,16 +37,16 @@ def apply_patch(patch_file)
   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"
+    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}"
+        Pod::UI.puts "Successfully applied #{patch_file} 🎉"
       else
-        Pod::UI.warn "Failed to apply #{patch_file}"
+        Pod::UI.warn "Error: failed to apply #{patch_file}"
       end
     end
   }

data/lib/{cocoapods-patch → pod}/command/patch/create.rb

@@ -24,28 +24,53 @@ module Pod
           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
-          FileUtils.mkdir_p('patches')
+          # 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)
+            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}"
+            gen_diff_cmd = "git diff --no-index '#{theirs}' '#{ours}' > '#{patch_file}'"
 
             did_succeed = system(gen_diff_cmd)
             if not did_succeed.nil?
-              UI.puts "Created patch #{patch_file}"
+              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 creating patch for #{@name}"
+              UI.warn "Error: failed to create patch for #{@name}"
             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,36 @@
+require 'cocoapods'
+require 'pathname'
+require_relative 'command/patch/apply'
+
+module CocoapodsPatch
+  module Hooks
+    Pod::HooksManager.register('cocoapods-patch', :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")
+          context.sandbox.clean_pod(pod_name)
+        end
+      end
+    end
+
+    Pod::HooksManager.register('cocoapods-patch', :pre_integrate) do |context|
+      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
+end

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.1
 platform: ruby
 authors:
 - Double Symmetry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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: '0'
+        version: '3.9'
 description: Create & apply patches to Pods
 email:
 - dev@doublesymmetry.com
@@ -45,14 +73,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/cocoapods-patch.rb
-- lib/cocoapods-patch/command.rb
-- lib/cocoapods-patch/command/patch.rb
-- lib/cocoapods-patch/command/patch/apply.rb
-- lib/cocoapods-patch/command/patch/create.rb
-- lib/cocoapods-patch/gem_version.rb
-- lib/cocoapods-patch/hook.rb
+- CHANGELOG.md
+- 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: https://github.com/DoubleSymmetry/cocoapods-patch
 licenses:
 - MIT

data/lib/cocoapods-patch/command/patch.rb

@@ -1,12 +0,0 @@
-module Pod
-  class Command
-    class Patch < Command
-      self.abstract_command = true
-      self.summary = 'Create & apply patches to Pods.'
-
-      def patch_file
-        config.project_root + 'patches' + "#{@name}.diff"
-      end
-    end
-  end
-end

data/lib/cocoapods-patch/command.rb

@@ -1,3 +0,0 @@
-require 'cocoapods-patch/command/patch'
-require 'cocoapods-patch/command/patch/apply'
-require 'cocoapods-patch/command/patch/create'

data/lib/cocoapods-patch/hook.rb

@@ -1,27 +0,0 @@
-require 'cocoapods'
-require 'pathname'
-require_relative 'command/patch/apply'
-
-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 { |p| apply_patch(p) }
-    end
-  end
-end

data/lib/cocoapods-patch.rb

@@ -1 +0,0 @@
-require 'cocoapods-patch/gem_version'