cocoapods-patch 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0630f65e8646fbca0c6a49834d7cb617ad8fc1895a23bb6eeca1c92cf6ba96fe
-  data.tar.gz: 7ddba775f9029c46588750f176870f6b5c5ec27ce0373db22ac5832dab354a85
+  metadata.gz: 765a982a7881db3b57c31e3bbe5e54ec56f5d990a4918c81f1ff7dbf6e7d9cf7
+  data.tar.gz: b9ec1d2c051c580b5f9c79f34e6905b8931a5ca3abcde268d61ff03fbdb6e938
 SHA512:
-  metadata.gz: 6e56809e31e8b3beecdc9bf9df7699915cb8591aa05d70b428ab47803414552d22e14cfce734ec5733002ae9ba5943e97539bbe4853dffea03f539a413a63b4a
-  data.tar.gz: 2511dc28bc71ef9f6d04470a315b12f7a442afdb9d1020798ea93ed8ef23faae065c2cedfe8819723e1809b97a114c5598aed7d6d40b8d5aa600cece249f1fc9
+  metadata.gz: 32860c686e91f67ee8d4939bb1507c852b34284c626086a74375e3c51a38d6c31e4b06e4f07e401f73724105824b55e3b3cc59001fbac875843e5e904046d970
+  data.tar.gz: 8702ff7065ed62bdca2455c145a7519bc9317db9f86a05639b8c2f08ae5dd9901e6566bfe6ea0dfd6b5501fa25d7a910af085ce3270996545a02d2117f701cfc

data/README.md

@@ -0,0 +1,38 @@
+
+# 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.
+
+## 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.3"
+  VERSION = "0.0.8"
 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/pod/command.rb

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

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/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/{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}"
 
             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/hook.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Double Symmetry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,56 @@ dependencies:
     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: '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: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Create & apply patches to Pods
 email:
 - dev@doublesymmetry.com
@@ -45,14 +73,14 @@ 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
+- 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.rb

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

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/command/patch/apply.rb

@@ -1,44 +0,0 @@
-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)
-  check_cmd = "git apply --check #{patch_file} --directory=Pods -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 "Failed to apply #{patch_file}"
-    end
-  end
-end

data/lib/cocoapods-patch/hook.rb

@@ -1,34 +0,0 @@
-require 'cocoapods'
-require 'pathname'
-require_relative 'command/patch/apply'
-
-class Pod::Installer
-  # The only way to run my custom method after the pod integrates with the project (http://blog.bigbinary.com/2012/01/08/alias-vs-alias-method.html)
-  # Repace the method implementation integrate_user_project with ours
-  alias_method :perform_post_install_actions_old, :perform_post_install_actions
-
-  def perform_post_install_actions
-    # integrate with the user project
-    perform_post_install_actions_old
-    # run custom post_integrate_method
-    apply_patches
-  end
-
-  def apply_patches
-    Pod::UI.puts 'Applying patches if necessary'
-    patches_dir = Pathname.new(Dir.pwd) + 'patches'
-    patches = patches_dir.each_child.select { |c| c.to_s.end_with?('.diff') }
-    patches.each { |p| apply_patch(p) }
-  end
-end
-
-# module CocoapodsPatch
-#   module Hooks
-#     Pod::HooksManager.register('cocoapods-patch', :post_integrate) do |context|
-#       Pod::UI.puts 'Applying patches if necessary'
-#       patches_dir = Pathname.new(context.sandbox_root) + '..' + 'patches'
-#       patches = patches_dir.each_child.select { |c| c.to_s.end_with?('.diff') }
-#       patches.each { |p| apply_patch(p) }
-#     end
-#   end
-# end