cocoapods-podfile_patch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9754afa9090b5b5b1ee61171e615a45607974f51
+  data.tar.gz: 76ad7be9d5dc18fe4b5e252cce3b2798af59e073
+SHA512:
+  metadata.gz: 9ec67eea259cc5c40b20335efd4a766182ed785dd1aa70f43b2ed2ca4beb2aa9b7de9ee79402cc79e1663367d50e39b0c1b0c01b7f9c4713f69a3b93c4babdbf
+  data.tar.gz: 8686e788b26ea2e89d84bd5b8d450cb1024ad13175915968f434f6f31f193ba6f8e5482cae6b9ec441d04c96ee94dac1965daa08d90615aa5d74eebcdbbc9def

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-podfile_patch.gemspec
+gemspec
+
+group :development do
+  gem 'cocoapods'
+
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Gao <gaoji@bytedance.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# cocoapods-podfile_patch
+
+This plugin provide the ability to override podfile in another file.
+
+Place a `Podfile.patch` at the same directory with Podfile. Configurate the pods
+in patchfile just like in Podfile. It will append to original podfile, and override
+the settings in podfile if duplicated.
+
+For example:
+
+Podfile:
+```
+    use_patch_file!
+    target EVA do
+        pod "A", "1.5.3", :inhibit_warning => true
+        pod "B", :path => "some/path"
+    end
+```
+
+Podfile.patch
+```
+    target EVA do
+        pod "A", :path => "path/to/local/A"
+    end
+```
+
+The final result equal to 
+```
+    target EVA do
+        pod "A", :path => "path/to/local/A"
+        pod "B", :path => "some/path"
+    end
+```
+
+This function is base on the parsed result of podfile. It means you could do ANYTHING
+you do in podfile, i.e. your custom pod function or other plugins.
+            
+## Installation
+
+    $ gem install cocoapods-podfile_patch
+
+## Usage
+
+Just add `use_patch_file!` in podfile, and make your own `Podfile.patch`

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+desc 'Runs all the specs'
+task :specs do
+  sh "bundle exec bacon #{specs('**')}"
+end
+
+task :default => :specs
+

data/cocoapods-podfile_patch.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-podfile_patch/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-podfile_patch'
+  spec.version       = CocoapodsPodfile_patch::VERSION
+  spec.authors       = ['Gao']
+  spec.email         = ['gaoji@bytedance.com']
+  spec.description   = %q{A short description of cocoapods-podfile_patch.}
+  spec.summary       = %q{A longer description of cocoapods-podfile_patch.}
+  spec.homepage      = 'https://github.com/EXAMPLE/cocoapods-podfile_patch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cocoapods-podfile_patch/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsPodfile_patch
+  VERSION = "0.0.1"
+end

data/lib/cocoapods-podfile_patch/podfile_patch.rb

@@ -0,0 +1,232 @@
+
+require 'cocoapods-core/specification'
+require 'cocoapods-core/podfile'
+require 'pathname'
+require 'set'
+
+
+class PodfilePatch
+
+    def main(podfile)
+    
+        podfile_root_path = Pathname.new(podfile.defined_in_file).dirname
+        patch_file_path = self.patchfile_filepath(podfile_root_path)
+        if not patch_file_path.file?
+            Pod::UI.info "Podfile patch feature is enabled. (No patch file now.)"
+            return  
+        end
+    
+        patchfile = self.patchfile(patch_file_path)
+        self.patch(podfile: podfile, with_podfile: patchfile)
+    
+        Pod::UI.titled_section "Podfile patch feature is enabled" do
+            next unless Pod::UI.config.verbose?
+            Pod::UI.section "Patchfile Info" do 
+                self.print_podfile_raw_dependencies patchfile
+            end
+            Pod::UI.section "Modified Podfile Info" do 
+                self.print_podfile_raw_dependencies podfile
+            end
+        end
+    end
+
+    def patchfile_filepath(podfile_root) # [Pathname]
+        Pathname.new(podfile_root) + "Podfile.patch"
+    end
+
+    def patchfile(patch_file_path) # [Podfile]
+        Pod::Podfile.from_ruby(patch_file_path)
+    end
+
+    def patch(podfile:, with_podfile: )
+        original = podfile
+        patch = with_podfile
+
+        merge_target_definitions_dependency(
+            podfile.root_target_definitions[0], 
+            patch.root_target_definitions[0]
+            )
+    end
+
+    def merge_target_definitions_dependency(targetdef, patch_targetdef)
+        # Demo Data
+        # Original Target
+        # ```
+        # TargetDefination 'Pods':
+        # [{"BDWebImage"=>["1.0.1.1-binary"]}]
+        #
+        #     TargetDefination 'Pods-FrameworkDemos_Tests':
+        #     ["BDWebImage/SDAdapter", "BDWebImage/Download", {"TTNetworkManager"=>["2.2.8.46-rc.18"]}, {"AFNetworking"=>[{:path=>"/Users/lea/Downloads/AFNetworking"}]}]
+        #   
+        #     TargetDefination 'Pods-FrameworkDemos_Example':
+        #     ["BDWebImage", {"TTNetworkManager"=>["2.2.8.46-rc.18"]}]
+        # ```
+        #
+        # Patch Target
+        # ```
+        # TargetDefination 'Pods':
+        # [{"AFNetworking"=>["2.3"]}]
+        # ```
+
+        # 1. find all dependency patch_targetdef: patched_dependencies
+        # 2. modify targetdef's depedencies recursively:
+        #       - replace the requirement to the one in patched_dependencies 
+        #       - add to target if not contained
+
+
+        def get_raw_dependencies(target_defination)
+            (target_defination.send :get_hash_value, 'dependencies') || []
+        end
+
+        all_dependencies_in_patch = begin
+            def all_dependencies(target_defination)
+                d = get_raw_dependencies(target_defination) 
+                d += (target_defination.children.map do |subtarget|
+                    all_dependencies(subtarget)
+                end.flatten || [])
+                d
+            end
+            all_dependencies(patch_targetdef)
+        end
+        
+        def transform_target_dependency_to_dict(dependencies)
+            dict = {}
+            dependencies.each do |name_or_hash|
+                if name_or_hash.is_a?(Hash)
+                    name = name_or_hash.keys.first
+                    requirements = name_or_hash.values.first
+                    dict[name] = requirements
+                else
+                    dict[name_or_hash] = {}
+                end
+            end
+            dict
+        end
+
+        dependencies_dict_in_patch = transform_target_dependency_to_dict(all_dependencies_in_patch)
+
+        def modify_target_defination_recursively(target_defination, &block)
+            block.call(target_defination)
+            target_defination.children.each { |t| modify_target_defination_recursively(t, &block) }
+        end
+
+        patch_file_all_targets_dict = begin
+            targets = {}
+            modify_target_defination_recursively(patch_targetdef) do |t|
+                targets[t.name] = t
+            end
+            targets
+        end
+
+        patch_file_target_to_dependency_dict = begin
+            dict = {}
+            modify_target_defination_recursively(patch_targetdef) do |t|
+                deps = get_raw_dependencies(t)
+                dict[t.name] = transform_target_dependency_to_dict(deps)
+            end
+            dict
+        end
+
+        modified_dependencies_names = {} # pod name => target name
+
+        modify_target_defination_recursively(targetdef) do |t|
+            deps = get_raw_dependencies(t)
+            new_deps = []
+            deps_set = Set.new
+            
+            # modify origianl dependency
+            deps.each do |name_or_hash|
+                name = nil
+                if name_or_hash.is_a?(Hash)
+                    name = name_or_hash.keys.first
+                else
+                    name = name_or_hash
+                end
+                if dependencies_dict_in_patch.key? name
+                    new_deps << {name => dependencies_dict_in_patch[name]}
+                    modified_dependencies_names[name] = t
+                else
+                    new_deps << name_or_hash
+                end
+                deps_set.add(name)
+            end
+            # add new dependency
+            patching_deps = patch_file_target_to_dependency_dict[t.name]
+            if not patching_deps.blank?
+                patching_deps.each do |name, requirements|
+                    if not deps_set.include? name
+                        new_deps << (requirements.empty? ? name : {name => requirements})
+                        modified_dependencies_names[name] = t
+                    end
+                end
+            end
+
+            t.send :set_hash_value, "dependencies", new_deps
+        end
+
+        # handle MODULAR_HEADERS & INHIBIT_WARNING
+        [ :raw_inhibit_warnings_hash,
+          :raw_use_modular_headers_hash].each do |method|
+            modify_target_defination_recursively(targetdef) do |t|
+                original_inhibit_warning_dict = t.send method
+                original_inhibit_warning_dict.each do |key, value|
+                    # the key is "for_pods" or "not_for_pods" or "all"
+                    # Clear if patchfile have modified the pod
+                    next unless value.kind_of? Array
+                    value.reject! { |name| modified_dependencies_names.include? name}
+                end
+    
+                patch_target = patch_file_all_targets_dict[t.name]
+                next if patch_target.nil?
+                patch_inhibit_warning_dict = patch_target.send method
+                patch_inhibit_warning_dict.each do |key, value|
+                    if value.kind_of? Array
+                        original = original_inhibit_warning_dict[key] || []
+                        original.concat(value).uniq! 
+                        original_inhibit_warning_dict[key] = original
+                    elsif [true, false].include? value # "all"
+                        original_inhibit_warning_dict[key] = value
+                    end
+                end
+            end
+        end
+
+        # handle CONFIGURATION_WHITELIST
+        modify_target_defination_recursively(targetdef) do |t|
+            original = t.send :raw_configuration_pod_whitelist
+            original.each do |config_name, pods|
+                # Clear if patchfile have modified the pod
+                next unless pods.kind_of? Array
+                pods.reject! { |name| modified_dependencies_names.include? name}
+            end
+
+            patch_target = patch_file_all_targets_dict[t.name]
+            next if patch_target.nil?
+            patched = patch_target.send :raw_configuration_pod_whitelist
+            patched.each do |config_name, pods|
+                next unless pods.kind_of? Array
+                original_pods = original[config_name] || []
+                original_pods.concat(pods).uniq! 
+                original[config_name] = original_pods
+            end
+        end
+    end
+
+    def print_podfile_raw_dependencies(podfile)
+
+        def print_target_def_and_its_dependencies(target_def, intend = "")
+            puts "|\n"
+            puts "| #{intend}TARGET_DEFINITION: #{target_def}"
+            puts "| #{intend}INHIBIT_WARNING: #{target_def.send :raw_inhibit_warnings_hash}"
+            puts "| #{intend}DEPS: #{target_def.send :get_hash_value, 'dependencies'}"
+            target_def.children.each do |target_def|
+                print_target_def_and_its_dependencies(target_def, intend + "    ")
+            end
+        end
+        podfile.root_target_definitions.each do |target_def|
+            print_target_def_and_its_dependencies(target_def)
+        end
+    end 
+end
+
+

data/lib/cocoapods-podfile_patch.rb

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

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,64 @@
+module Pod
+    class Podfile
+        module DSL
+            # Enable Podfile Patch feature.
+            # 
+            # Thid feature provide the ability to override podfile in another file.
+            #
+            # Place a `Podfile.patch` at the same directory with Podfile. Configurate the pods
+            # in patchfile just like in Podfile. It will append to original podfile, and override
+            # the settings in podfile if duplicated.
+            #
+            # For example:
+            #
+            # Podfile:
+            # ```
+            #     target EVA do
+            #         pod "A", "1.5.3", :inhibit_warning => true
+            #         pod "B", :path => "some/path"
+            #     end
+            # ```
+            #
+            # Podfile.patch
+            # ```
+            #     target EVA do
+            #         pod "A", :path => "path/to/local/A"
+            #     end
+            # ```
+            #
+            # The final result equal to 
+            # ```
+            #     target EVA do
+            #         pod "A", :path => "path/to/local/A"
+            #         pod "B", :path => "some/path"
+            #     end
+            # ```
+            #
+            # This function is base on the parsed result of podfile. It means you could do ANYTHING
+            # you do in podfile, i.e. your custom pod function or other plugins.
+            #
+            def use_patch_file!(enabled = true)
+                @enable_patch = enabled
+                if self.defined_in_file.basename.to_s.downcase == "podfile.patch"
+                    raise "Cannot call `#{__method__}` in Podfile.patch" 
+                end
+            end
+
+        end
+    end
+end
+
+module Pod
+    class Podfile
+        old_initialize_function = instance_method(:initialize)
+        define_method(:initialize) do |defined_in_file = nil, internal_hash = {}, &block|
+            old_initialize_function.bind(self).(defined_in_file, internal_hash, &block)
+
+            if @enable_patch
+                require 'cocoapods-podfile_patch/podfile_patch'
+                patcher = PodfilePatch.new
+                patcher.main(self)
+            end
+        end
+    end
+end

data/spec/command/podfile_patch_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Podfile_patch do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ podfile_patch }).should.be.instance_of Command::Podfile_patch
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-podfile_patch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of cocoapods-podfile_patch.
+email:
+- gaoji@bytedance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods-podfile_patch.gemspec
+- lib/cocoapods-podfile_patch.rb
+- lib/cocoapods-podfile_patch/gem_version.rb
+- lib/cocoapods-podfile_patch/podfile_patch.rb
+- lib/cocoapods_plugin.rb
+- spec/command/podfile_patch_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/EXAMPLE/cocoapods-podfile_patch
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: A longer description of cocoapods-podfile_patch.
+test_files:
+- spec/command/podfile_patch_spec.rb
+- spec/spec_helper.rb