cocoapods-patch 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2626728359e198af7ecc119c2bc846520c233f725cea13857a12a936bfacb527
-  data.tar.gz: ef94a39a36598ce2274b099f34af86953a21086d52b135dff893f6e21cf5aebf
+  metadata.gz: 765a982a7881db3b57c31e3bbe5e54ec56f5d990a4918c81f1ff7dbf6e7d9cf7
+  data.tar.gz: b9ec1d2c051c580b5f9c79f34e6905b8931a5ca3abcde268d61ff03fbdb6e938
 SHA512:
-  metadata.gz: 230e132b95a6bcadeb9e442fa5576ec5b57c36cefc543fae0feed769569fbadf4ac0e0f8e7799939e938a3bdede73d15517e150a3e6daf042471d2321fc9584b
-  data.tar.gz: d335a0613d53c0931caacd4e2938e8083d7b32cdbb843dd406b91e5714a77e8b678537577fa8d05cef2d2f2a4accfc39a80f210db17f074f3d22012d82e4b5a8
+  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.7"
+  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/{cocoapods-patch → pod}/command/patch/apply.rb

@@ -44,9 +44,9 @@ def apply_patch(patch_file)
       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,8 +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
-          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)
@@ -34,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/{cocoapods-patch → pod}/hook.rb

@@ -2,6 +2,22 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Double Symmetry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-23 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'