cocoapods-patch 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f1fc48aa0350d562d1ad476ab439624105cee81c22bab3b604a73131e1dd6eb
-  data.tar.gz: b03c8bf4611c20f40536936fa02c2b43f833588b63038d083fe834be9a368a0c
+  metadata.gz: '09b3961ea67614d95650203463aa53b0e556e4630f52bc88a1d826670aa932db'
+  data.tar.gz: 2bbd9aeedbf8912b991c7e83762b12c5b1ef4def1d2fc0af03a066126fd6569f
 SHA512:
-  metadata.gz: c96592ef2a7c17cbc4916afc582a0af9219bf2ecf351dbc6f21ab10a6660cb4de8e5a8fcd69c3cada1d5d69c6c29c53e654143f426193e23a0e4bf757acb4d78
-  data.tar.gz: c7c7d93705236d902f9ddd02d4102ae800c9280bc1f8549d31b600a7fc4a1c5b6616b2029a0e2468fa58678fabc3dc5d5a9d09ddcba34f83ad414251a7added1
+  metadata.gz: d973db22fe9a736b16df29b251cc3cd177ce6c7cac399f3f7f75ca55786776015e650fb680003c4376d144621c765c6eaca66d429e4eae8e00e86bcbea2f3bb9
+  data.tar.gz: ee4054f9540888b48282e1275355658d17bf1b744dbe2f3ad725b53b4cf0a980085f49d34eb6815fdbf03484b92bb3e253669702bd6804b6ff50aefcd470e5d0

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Installation & Update
+
+To install or update cocoapods-patch see [README](https://github.com/DoubleSymmetry/cocoapods-patch).
+
+## Main
+
+##### Enhancements
+
+* None.
+
+##### 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,42 @@
+
+# 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.5.
+
+## 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.6"
+  VERSION = "1.0.0"
 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,17 +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) {
-    Pod::UI.puts "YOOOOO #{patch_file} - #{directory_arg}"
-    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,7 +24,16 @@ 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
+          # 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)
@@ -33,18 +42,35 @@ module Pod
             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/{cocoapods-patch → pod}/command/patch.rb

@@ -1,3 +1,6 @@
+require_relative 'patch/apply'
+require_relative 'patch/create'
+
 module Pod
   class Command
     class Patch < Command
@@ -7,6 +10,10 @@ module Pod
       def patch_file
         config.project_root + 'patches' + "#{@name}.diff"
       end
+
+      def patches_path
+        config.project_root + 'patches'
+      end
     end
   end
 end

data/lib/pod/command.rb

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

data/lib/pod/hook.rb

@@ -0,0 +1,28 @@
+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 { |p| apply_patch(p) }
+      end
+    end
+  end
+end

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Double Symmetry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-11-01 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,15 @@ 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/hook.rb
 homepage: https://github.com/DoubleSymmetry/cocoapods-patch
 licenses:
 - MIT

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'