cocoapods-fast-install 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78a43678654463ce4320017854ce718071e52242
+  data.tar.gz: d4800d0a22079111d2852b6634a19b4a37d024af
+SHA512:
+  metadata.gz: 247736d6728ced6ae683227a9eadd89fe320c97d43ea28114486017bc1e4bf46357c77288b4d2758a6edfd237290fb4cdbddf90cbbe82dd9608f90bad69d3199
+  data.tar.gz: da56f01a74334abbb228ceb3f959c388471dcf13280fd01396c12903bed6dcfde7a7dc18923df3de4827375b7328cdbb955d7b2ff98c27e259230c3a56042eef

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-fast-install.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,38 @@
+# cocoapods-fast-install
+
+A cocoapods plugin that speed up the pod install for CI.
+
+For the CI environment, we just pod install and build. Large mount 
+of files in project file will slow down the pod install. So we exclude
+some files from the xcodeproject, the header files, then the pod install 
+speed up.
+
+For a project containing 1700 header files in pods, it can reduce about 
+13 seconds in `Generating Pods project` step.
+
+Umbrella Header and Module are compatible with this plugin.
+ 
+## Installation
+
+    $ gem install cocoapods-fast-install
+
+## Usage
+
+In the Podfile
+
+```ruby
+plugin 'cocoapods-fast-install'
+accelerate_xcproject_generating!
+```
+
+If you want keep headers for some pods 
+
+```ruby
+plugin 'cocoapods-fast-install'
+accelerate_xcproject_generating! :keeping_header_for => ['Protobuf', 'AFNetworking']
+```
+
+
+## Licence
+
+MIT

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-fast-install.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-fast-install/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-fast-install'
+  spec.version       = CocoapodsFastInstall::VERSION
+  spec.authors       = ['Gao']
+  spec.email         = ['gaoji@bytedance.com']
+  spec.description   = %q{A short description of cocoapods-fast-install.}
+  spec.summary       = %q{A longer description of cocoapods-fast-install.}
+  spec.homepage      = 'https://github.com/EXAMPLE/cocoapods-fast-install'
+  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-fast-install.rb

@@ -0,0 +1 @@
+require 'cocoapods-fast-install/gem_version'

data/lib/cocoapods-fast-install/Patch.rb

@@ -0,0 +1,190 @@
+
+module Pod
+
+  # -------------------------------- find the target to exclude -------------------------------
+  class FastProjectGenerating
+
+    class << self
+      attr_accessor :user_excluded_targets # Array<String>
+      attr_accessor :excluded_target_names # Array<String>
+    end
+
+    def self.should_skip_path(absolute_path)
+      # may not support 'one pod for multiple platform'
+      self.excluded_target_names.all? { |name| not (absolute_path.to_s.include? '/'+name+'/') }
+    end
+  end
+
+
+  class PodTarget
+    def uses_cpp?
+      return @uses_cpp if defined? @uses_cpp
+      @uses_cpp = begin
+        file_accessors.reject { |a| a.spec.test_specification? }.any? do |file_accessor|
+          file_accessor.source_files.any? { |sf| ['.cpp', '.mm', '.cc', '.cxx', '.c++', '.C'].include? sf.extname }
+        end
+      end
+    end
+
+    def uses_relative_header_importing?
+      return @uses_relative_header_importing if defined?  @uses_relative_header_importing
+      @uses_relative_header_importing = begin
+        file_accessors.reject { |a| a.spec.test_specification? }.any? do |file_accessor|
+          file_accessor.public_headers.any? do |file|
+            file.extname == '.h' && begin
+                File.read(file) =~ /#import +"[\w]+\/.+\.h"/
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+  class Installer
+
+    OLD_FAST_INSTALL_2_generate_pods_project = instance_method :generate_pods_project
+    define_method :generate_pods_project do |*args|
+
+      # check the input names
+      names = pod_targets.map(&:name)
+      wrong_input_names = FastProjectGenerating.user_excluded_targets.select { |input| not (names.include? input) }
+      unless wrong_input_names.empty?
+        puts "Wrong input for accelerate_xcodeproj_generating! #{wrong_input_names}".red
+        FastProjectGenerating.user_excluded_targets -= wrong_input_names
+      end
+
+      # find the pod that cannot support
+      relative_importing_target_names = []
+      cpp_target_names = []
+$c = 0
+      pod_targets.map do |target|
+        if target.uses_cpp?
+          cpp_target_names << target.name
+        elsif target.uses_relative_header_importing?
+          relative_importing_target_names << target.name
+        end
+      end
+
+      FastProjectGenerating.excluded_target_names = []
+      FastProjectGenerating.excluded_target_names += FastProjectGenerating.user_excluded_targets
+      FastProjectGenerating.excluded_target_names += relative_importing_target_names
+
+
+      OLD_FAST_INSTALL_2_generate_pods_project.bind(self).(*args)
+
+
+      unless FastProjectGenerating.excluded_target_names.empty?
+        puts "Skip excluding headers (manually specified): #{FastProjectGenerating.user_excluded_targets}" unless FastProjectGenerating.user_excluded_targets.empty?
+        puts "Skip excluding headers (contain c++): #{cpp_target_names}" unless cpp_target_names.empty?
+        puts "Skip excluding headers (contain relative importing): #{relative_importing_target_names}" unless relative_importing_target_names.empty?
+      end
+
+      puts "cdddddd #{$c}"
+      exit
+    end
+
+  end
+
+
+  #---------------------------------- real function ------------------------------------
+
+
+  # Filter the Headers when adding file references (the origin)
+  class Project < Xcodeproj::Project
+
+    FAST_INSTALL_OLD_add_file_reference = instance_method :add_file_reference
+    define_method(:add_file_reference) do |absolute_path, group, reflect_file_system_structure, base_path = nil|
+      if absolute_path.extname == '.h'
+        if FastProjectGenerating.should_skip_path(absolute_path)
+          next
+        end
+      end
+
+      FAST_INSTALL_OLD_add_file_reference.bind(self).(absolute_path, group, false, base_path)
+    end
+
+  end
+
+
+  # Filter the Headers when adding to build phase
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        class PodTargetInstaller
+
+          # 其实应该直接修改 def add_files_to_build_phases(native_target, test_native_targets)
+          # 但 hook 这个函数更方便
+          FAST_INSTALL_OLD_project_file_references_array = instance_method :project_file_references_array
+          define_method(:project_file_references_array) do |files, file_type|
+              $c += files.count
+
+            if file_type == 'header'
+              files = files.reject do |path|
+                FastProjectGenerating.should_skip_path(path)
+              end
+            end
+            next FAST_INSTALL_OLD_project_file_references_array.bind(self).(files, file_type)
+
+          end
+
+        end
+      end
+    end
+  end
+
+
+  # There's a bug when use `header_dir` in podspec.
+  #
+  # The `header search path` is set to something like
+  #  "${PODS_ROOT}/Headers/Private/lottie-ios"
+  #
+  # But the when header_dir is set, the real headers will place in a nested folder. So we add a recursise search.
+  #
+  # Xcode cannot find the header file when it isn't added to the project AND the header file doesn't
+  # placed in the same directory with the source file who import it if header search path is not set.
+  #
+  #
+  class PodTarget
+
+
+    FAST_INSTALL_OLD_header_search_paths = instance_method :header_search_paths
+    define_method :header_search_paths do |*args|
+      paths = FAST_INSTALL_OLD_header_search_paths.bind(self).(*args)
+      paths = paths.map do |path|
+        if path.end_with?('Public') || path.end_with?('Private')
+          path
+        else
+          path + '/**' # recursive
+        end
+      end
+      paths
+    end
+
+  end
+
+
+  # class Sandbox
+  #   class HeadersStore
+  #
+  #     def add_file(namespace, relative_header_path, mkdir: true)
+  #       namespaced_path = root
+  #       namespaced_path.mkpath if mkdir
+  #
+  #       absolute_source = (sandbox.root + relative_header_path)
+  #       namespaced_path += absolute_source.relative_path_from(sandbox.root).dirname
+  #       namespaced_path.mkpath unless namespaced_path.exist?
+  #
+  #       source = absolute_source.relative_path_from(namespaced_path)
+  #       FileUtils.ln_sf(source, namespaced_path)
+  #       namespaced_path + relative_header_path.basename
+  #     end
+  #
+  #   end
+  # end
+
+
+
+end
+
+

data/lib/cocoapods-fast-install/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsFastInstall
+  VERSION = "0.0.2"
+end

data/lib/cocoapods-fast-install/main.rb

@@ -0,0 +1,23 @@
+module Pod
+  class Podfile
+    module DSL
+
+      def accelerate_xcproject_generating!(parameters={})
+
+        require 'cocoapods-fast-install/Patch'
+        require 'cocoapods-fast-install/validate_patch'
+
+        FastProjectGenerating.user_excluded_targets = []
+        skipped = parameters[:keeping_header_for]
+        if skipped.kind_of? String
+          FastProjectGenerating.user_excluded_targets << skipped
+        elsif skipped.kind_of? Array
+          FastProjectGenerating.user_excluded_targets += skipped
+        end
+      end
+
+    end
+  end
+end
+
+require 'cocoapods-fast-install/print_duration'

data/lib/cocoapods-fast-install/print_duration.rb

@@ -0,0 +1,86 @@
+
+
+
+# prints the durations
+
+module Pod
+  class Installer
+
+    class << self
+
+      def count_seconds(method)
+        old_method = instance_method(method)
+        define_method(method) do |*args|
+          start = Time.new
+          result = old_method.bind(self).(*args)
+          ends = Time.new
+          puts "[Fast Install] #{method} spends #{ends - start} seconds"
+          next result
+        end
+      end
+
+    end
+
+    count_seconds :install!
+
+    count_seconds :prepare
+    count_seconds :resolve_dependencies
+    count_seconds :download_dependencies
+    count_seconds :validate_targets
+    count_seconds :generate_pods_project
+    count_seconds :integrate_user_project
+    count_seconds :perform_post_install_actions
+
+  end
+end
+
+# #print the separated step in generating
+# module Pod
+#   class Installer
+#     class Xcode
+#       class PodsProjectGenerator
+#
+#         class << self
+#
+#           def count_seconds(method)
+#             old_method = instance_method(method)
+#             define_method(method) do |*args|
+#               start = Time.new
+#               result = old_method.bind(self).(*args)
+#               ends = Time.new
+#               puts "[Fast Install: PodsProjectGenerator] #{method} spends #{ends - start} seconds"
+#               next result
+#             end
+#           end
+#
+#         end
+#
+#         if Pod::VERSION.start_with? "1.5"
+#           count_seconds :prepare
+#           count_seconds :install_file_references
+#           count_seconds :install_libraries
+#           count_seconds :integrate_targets
+#           count_seconds :set_target_dependencies
+#         elsif Pod::VERSION.start_with? "1.6"
+#           count_seconds :generate!
+#
+#           # count_seconds :prepare
+#           count_seconds :install_file_references
+#           count_seconds :install_targets
+#           # count_seconds :integrate_targets
+#           # count_seconds :wire_target_dependencies
+#         end
+#
+#       end
+#     end
+#   end
+# end
+
+def print_duration(description, &block)
+  start = Time.new
+  result = block.call() if block_given?
+  stop = Time.new
+  puts "#{description} #{stop-start}"
+  return result
+end
+

data/lib/cocoapods-fast-install/validate_patch.rb

@@ -0,0 +1,18 @@
+
+# Validate will trigger the cache of some methods. If we skip validate step, these
+# methods will be used in generating step. So it have no significant effect.
+
+unless Pod::VERSION.start_with? "1.5"
+
+  module Pod
+    class Installer
+
+      def validate_targets
+        # no need to validate
+        # depress the original function
+      end
+
+    end
+  end
+
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,3 @@
+
+
+require 'cocoapods-fast-install/main'

data/spec/command/generating_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Generating do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ generating }).should.be.instance_of Command::Generating
+      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,89 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-fast-install
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Gao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-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-fast-install.
+email:
+- gaoji@bytedance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods-fast-install.gemspec
+- lib/cocoapods-fast-install.rb
+- lib/cocoapods-fast-install/Patch.rb
+- lib/cocoapods-fast-install/gem_version.rb
+- lib/cocoapods-fast-install/main.rb
+- lib/cocoapods-fast-install/print_duration.rb
+- lib/cocoapods-fast-install/validate_patch.rb
+- lib/cocoapods_plugin.rb
+- spec/command/generating_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/EXAMPLE/cocoapods-fast-install
+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-fast-install.
+test_files:
+- spec/command/generating_spec.rb
+- spec/spec_helper.rb