cocoapods-xcremotecache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c8ea806c777060721ce8e440f64f46f99e14012aea29e4b5f096839e11d81ea
+  data.tar.gz: 0a6ede5267ecdd314ac879a7bca8840f2d94b79a245f8b6002c9279c7a004862
+SHA512:
+  metadata.gz: c0949ce7b8617db61a2859cd787f3ab196a5f3048eed68b666ea69995ad491ea39e12fdf4b06b1c1a85a3c81eaec573c25ea996273203ae6691d5d24d6257e9c
+  data.tar.gz: 162f1467dfcc90185b6a97509ccf09f250ff2f758d86832a538e1415c03a0a9654d3e1037dca29c5ddf734203d6f81e8d9cab23966e80af710550ba424caf3e8

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-xcremotecache.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# cocoapods-xcremotecache
+
+The CocoaPods plugin that integrates XCRemoteCache with the project.
+
+## Installation
+
+Build & install the plugin
+
+```bash
+gem build cocoapods-xcremotecache.gemspec
+gem install cocoapods-xcremotecache-{CurrentGemVersion}.gem # e.g. gem install cocoapods-xcremotecache-0.0.1.gem
+```
+
+## Usage
+
+1. Add plugin reference to your project `Podfile`:
+```
+plugin 'cocoapods-xcremotecache'
+```
+2. Configure XCRemoteCache at the top of your `Podfile` definition:
+```ruby
+xcremotecache({
+    'cache_addresses' => ['http://localhost:8080/cache/pods'], 
+    'primary_repo' => 'https://your.primary.repo.git',
+    'mode' => 'consumer'
+})
+```
+3. (Optional) Unzip all XCRemoteCache binaries to the `xcrc_location` directory (defaults to `XCRC` placed next to the `Podfile`). If you don't provide all binaries in the location, the plugin will try to download the latest XCRemoteCache artifact from the public GitHub page.
+4. Call `pod install` and verify that `[XCRC] XCRemoteCache enabled` has been printed to the console.
+
+### Configuration parameters
+
+An object that is passed to the `xcremotecache` can contain all properties supported natively in the XCRemoteCache. In addition to that, there are extra parameters that are unique to the `cocoapods-xcremotecache`:
+
+| Parameter | Description | Default | Required |
+| ------------- | ------------- | ------------- | ------------- |
+| `enabled` | A Boolean value that enables XCRemoteCache integration to the project | `true` | ⬜️ |
+| `xcrc_location` | The location of all XCRemoteCache binaries | `{podfile_dir}/XCRC` | ⬜️ |
+| `exclude_targets` | Comma-separated list of targets that shouldn't use XCRemoteCache | `[]`| ⬜️ |
+| `exclude_build_configurations` | Comma-separated list of configurations that shouldn't use XCRemoteCache | `[]`| ⬜️ |
+| `final_target` | A target name that is build at the end of the build chain. Relevant only for a 'producer' mode to mark a given sha as ready to use from cache | `Debug` | ⬜️ |
+| `check_build_configuration` | A build configuration for which the remote cache availability is performed. Relevant only for a 'consumer' mode | `Debug` | ⬜️ |
+| `check_platform` | A platform for which the remote cache availability is performed. Relevant only for a 'consumer' mode | `iphonesimulator` | ⬜️ 
+| `modify_lldb_init` | Controls if the pod integration should modify `~/.lldbinit` | `true` | ⬜️ |
+| `xccc_file` | The path where should be placed the `xccc` binary (in the pod installation phase) | `{podfile_dir}/.rc/xccc` | ⬜️ |
+| `remote_commit_file` | The path of the file with the remote commit sha (in the pod installation phase) | `{podfile_dir}/.rc/arc.rc`| ⬜️ |
+
+## Uninstalling
+
+To fully uninstall the plugin, call:
+
+```bash
+gem uninstall cocoapods-xcremotecache
+```

data/Rakefile

@@ -0,0 +1,12 @@
+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-xcremotecache.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-xcremotecache/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-xcremotecache'
+  spec.version       = CocoapodsXcremotecache::VERSION
+  spec.authors       = ['Bartosz Polaczyk', 'Mark Vasiv']
+  spec.email         = ['bartoszp@spotify.com', 'mvasiv@spotify.com']
+  spec.description   = %q{CocoaPods plugin that enables XCRemoteCache with the project.}
+  spec.summary       = %q{A simple plugin that attaches to the post_install hook and modifies the generated project to use XCRemoteCache. Supports both producing anc consuming parts.}
+  spec.homepage      = 'https://github.com/spotify/XCRemoteCache'
+  spec.license       = 'Apache-2.0'
+
+  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']
+end

data/lib/cocoapods-xcremotecache/command/hooks.rb

@@ -0,0 +1,377 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'cocoapods'
+require 'cocoapods/resolver'
+require 'open-uri'
+require 'yaml'
+require 'json'
+
+
+module CocoapodsXCRemoteCacheModifier
+  # Registers for CocoaPods plugin hooks
+  module Hooks
+    BIN_DIR = '.rc'
+    FAKE_SRCROOT = "/#{'x' * 10 }"
+    LLDB_INIT_COMMENT="#RemoteCacheCustomSourceMap"
+    LLDB_INIT_PATH = "#{ENV['HOME']}/.lldbinit"
+
+    CUSTOM_CONFIGURATION_KEYS = [
+      'enabled', 
+      'xcrc_location',
+      'exclude_targets',
+      'exclude_build_configurations',
+      'final_target',
+      'check_build_configuration', 
+      'check_platform', 
+      'modify_lldb_init'
+    ]
+
+    class XCRemoteCache
+      @@configuration = nil
+
+      def self.configure(c) 
+        @@configuration = c
+      end
+
+      def self.set_configuration_default_values(user_proj_directory)
+        default_values = {
+          'mode' => 'consumer',
+          'enabled' => true, 
+          'xcrc_location' => "#{user_proj_directory}/XCRC", 
+          'exclude_build_configurations' => [],
+          'check_build_configuration' => 'Debug',
+          'check_platform' => 'iphonesimulator', 
+          'modify_lldb_init' => true, 
+          'xccc_file' => "#{user_proj_directory}/#{BIN_DIR}/xccc",
+          'remote_commit_file' => "#{user_proj_directory}/#{BIN_DIR}/arc.rc",
+          'exclude_targets' => [],
+        }
+        @@configuration.merge! default_values.select { |k, v| !@@configuration.key?(k) }
+      end
+
+      def self.validate_configuration()
+        required_values = [
+          'cache_addresses', 
+          'primary_repo',
+          'check_build_configuration',
+          'check_platform'
+        ]
+        
+        missing_configuration_values = required_values.select { |v| !@@configuration.key?(v) }
+        unless missing_configuration_values.empty?
+          throw "XCRemoteCache not fully configured. Make sure all required fields are provided. Missing fields are: #{missing_configuration_values.join(', ')}."
+        end
+
+        mode = @@configuration['mode']
+        unless mode == 'consumer' || mode == 'producer'
+          throw "Incorrect 'mode' value. Allowed values are ['consumer', 'producer'], but you provided '#{mode}'. A typo?"
+        end
+
+        unless mode == 'consumer' || @@configuration.key?('final_target')
+          throw "Missing 'final_target' value in the Pod configuration."
+        end
+      end
+
+      def self.generate_rcinfo()
+        @@configuration.select { |key, value| !CUSTOM_CONFIGURATION_KEYS.include?(key) }
+      end
+
+      def self.enable_xcremotecache(target, user_proj_directory, xc_location, xc_cc_path, mode, exclude_build_configurations, check_build_configuration, check_platform, final_target)
+          target.build_configurations.each do |config| 
+            # apply only for relevant Configurations
+            next if exclude_build_configurations.include?(config.name)
+            if mode == 'consumer'
+              config.build_settings['CC'] = [xc_cc_path]
+            end
+            config.build_settings['SWIFT_EXEC'] = ["#{xc_location}/xcswiftc"]
+            config.build_settings['LIBTOOL'] = ["#{xc_location}/xclibtool"]
+            config.build_settings['LD'] = ["#{xc_location}/xcld"]
+
+            config.build_settings['XCREMOTE_CACHE_FAKE_SRCROOT'] = FAKE_SRCROOT
+            add_cflags!(config.build_settings, '-fdebug-prefix-map', "#{user_proj_directory}=$(XCREMOTE_CACHE_FAKE_SRCROOT)")
+            add_swiftflags!(config.build_settings, '-debug-prefix-map', "#{user_proj_directory}=$(XCREMOTE_CACHE_FAKE_SRCROOT)")
+          end
+        
+
+        # User project is not generated from scratch (contrary to `Pods`), delete all previous XCRemoteCache phases
+        target.build_phases.delete_if {|phase| 
+          # Some phases (e.g. PBXSourcesBuildPhase) don't have strict name check respond_to?
+          if phase.respond_to?(:name) 
+              phase.name != nil && phase.name.start_with?("[XCRC]")
+          end
+        }
+
+        # Prebuild
+        if mode == 'consumer'
+          prebuild_script = target.new_shell_script_build_phase("[XCRC] Prebuild")
+          prebuild_script.shell_script = "\"$SCRIPT_INPUT_FILE_0\""
+          prebuild_script.input_paths = ["#{xc_location}/xcprebuild"]
+          prebuild_script.output_paths = [
+            "$(TARGET_TEMP_DIR)/rc.enabled", 
+            "$(DWARF_DSYM_FOLDER_PATH)/$(DWARF_DSYM_FILE_NAME)"
+          ]
+          prebuild_script.dependency_file = "$(TARGET_TEMP_DIR)/prebuild.d"
+
+          # Move prebuild (last element) to the first position (to make it real 'prebuild')
+          target.build_phases.rotate!(-1)
+        end
+
+        # Postbuild
+        postbuild_script = target.new_shell_script_build_phase("[XCRC] Postbuild")
+        postbuild_script.shell_script = "\"$SCRIPT_INPUT_FILE_0\""
+        postbuild_script.input_paths = ["#{xc_location}/xcpostbuild"]
+        postbuild_script.output_paths = [
+          "$(TARGET_BUILD_DIR)/$(MODULES_FOLDER_PATH)/$(PRODUCT_MODULE_NAME).swiftmodule/$(PLATFORM_PREFERRED_ARCH).swiftmodule.md5", 
+          "$(TARGET_BUILD_DIR)/$(MODULES_FOLDER_PATH)/$(PRODUCT_MODULE_NAME).swiftmodule/$(PLATFORM_PREFERRED_ARCH)-$(LLVM_TARGET_TRIPLE_VENDOR)-$(SWIFT_PLATFORM_TARGET_PREFIX)$(LLVM_TARGET_TRIPLE_SUFFIX).swiftmodule.md5"
+        ]
+        postbuild_script.dependency_file = "$(TARGET_TEMP_DIR)/postbuild.d"
+
+        # Mark a sha as ready for a given platform and configuration when building the final_target
+        if mode == 'producer' && target.name == final_target
+          mark_script = target.new_shell_script_build_phase("[XCRC] Mark")
+          mark_script.shell_script = "\"$SCRIPT_INPUT_FILE_0\" mark --configuration $CONFIGURATION --platform $PLATFORM_NAME"
+          mark_script.input_paths = ["#{xc_location}/xcprepare"]
+        end
+      end
+
+      def self.disable_xcremotecache_for_target(target)
+        target.build_configurations.each do |config|
+          config.build_settings.delete('CC') if config.build_settings.key?('CC')
+          config.build_settings.delete('SWIFT_EXEC') if config.build_settings.key?('SWIFT_EXEC')
+          config.build_settings.delete('LIBTOOL') if config.build_settings.key?('LIBTOOL')
+          config.build_settings.delete('LD') if config.build_settings.key?('LD')
+          # Add Fake src root for ObjC & Swift
+          config.build_settings.delete('XCREMOTE_CACHE_FAKE_SRCROOT')
+          remove_cflags!(config.build_settings, '-fdebug-prefix-map')
+          remove_swiftflags!(config.build_settings, '-debug-prefix-map')
+        end
+
+        # User project is not generated from scratch (contrary to `Pods`), delete all previous XCRemoteCache phases
+        target.build_phases.delete_if {|phase| 
+          # Some phases (e.g. PBXSourcesBuildPhase) don't have strict name check respond_to?
+          if phase.respond_to?(:name) 
+              phase.name != nil && phase.name.start_with?("[XCRC]")
+          end
+        }
+      end
+
+      # Writes XCRemoteCache info in the specified directory location
+      def self.save_rcinfo(info, directory)
+          File.open(File.join(directory, '.rcinfo'), 'w') { |file| file.write info.to_yaml }
+      end
+
+      def self.download_xcrc_if_needed(local_location)
+        required_binaries = ['xcld', 'xclibtool', 'xcpostbuild', 'xcprebuild', 'xcprepare', 'xcswiftc']
+        binaries_exist = required_binaries.reduce(true) do |exists, filename|
+          file_path = File.join(local_location, filename) 
+          exists = exists && File.exist?(file_path)
+        end
+
+        # Don't download XCRemoteCache if provided directory already contains it
+        return if binaries_exist
+
+        Dir.mkdir(local_location) unless File.exist?(local_location)
+        local_package_location = File.join(local_location, 'package.zip')
+
+        download_latest_xcrc_release(local_package_location)
+
+        if !system("unzip #{local_package_location} -d #{local_location}")
+          throw "Unzipping XCRemoteCache failed"
+        end 
+      end
+
+      def self.download_latest_xcrc_release(local_package_location)
+        release_url = 'https://api.github.com/repos/spotify/XCRemoteCache/releases/latest'
+        asset_url = nil
+        
+        open(release_url, :http_basic_authentication => credentials) do |f|          
+          asset_url = JSON.parse(f.read)['assets'][0]['url']
+        end
+
+        if asset_url.nil? 
+          throw "Downloading XCRemoteCache failed"
+        end
+
+        open(asset_url, :http_basic_authentication => credentials, "accept" => 'application/octet-stream') do |f|
+          File.open(local_package_location, "wb") do |file|
+            file.puts f.read
+          end
+        end
+      end
+
+      def self.add_cflags!(options, key, value)
+        return if options.fetch('OTHER_CFLAGS',[]).include?(' ' + value)
+        options['OTHER_CFLAGS'] = remove_cflags!(options, key) << " #{key}=#{value}" 
+      end
+
+      def self.remove_cflags!(options, key)
+        cflags_arr = options.fetch('OTHER_CFLAGS', ['$(inherited)'])
+        cflags_arr = [cflags_arr] if cflags_arr.kind_of? String
+        options['OTHER_CFLAGS'] = cflags_arr.delete_if {|flag| flag.start_with?(" #{key}=") }
+        options['OTHER_CFLAGS']
+      end
+
+      def self.add_swiftflags!(options, key, value)
+        return if options.fetch('OTHER_SWIFT_FLAGS','').include?(value)
+        options['OTHER_SWIFT_FLAGS'] = remove_swiftflags!(options, key) + " #{key} #{value}" 
+      end
+
+      def self.remove_swiftflags!(options, key)
+        options['OTHER_SWIFT_FLAGS'] = options.fetch('OTHER_SWIFT_FLAGS', '$(inherited)').gsub(/\s+#{Regexp.escape(key)}\s+\S+/, '')
+        options['OTHER_SWIFT_FLAGS']
+      end
+
+      # Uninstall the XCRemoteCache
+      def self.disable_xcremotecache(user_project)
+        user_project.targets.each do |target|
+          disable_xcremotecache_for_target(target)
+        end
+        user_project.save()
+
+        # Remove .lldbinit rewrite
+        save_lldbinit_rewrite(nil) unless !@@configuration['modify_lldb_init']
+      end
+
+      # Returns the content (array of lines) of the lldbinit with stripped XCRemoteCache rewrite
+      def self.clean_lldbinit_content(lldbinit_path)
+        all_lines = []
+        File.open(lldbinit_path) { |file|
+          while(line = file.gets) != nil
+            line = line.strip
+            if line == LLDB_INIT_COMMENT 
+              # skip current and next lines
+              file.gets
+              next
+            end
+            all_lines << line
+          end
+        }
+        all_lines
+      end
+
+      # Append source rewrite command to the lldbinit content
+      def self.add_lldbinit_rewrite(lines_content, user_proj_directory)
+        all_lines = lines_content.clone
+        all_lines << LLDB_INIT_COMMENT
+        all_lines << "settings set target.source-map #{FAKE_SRCROOT} #{user_proj_directory}"    
+        all_lines << ""
+        all_lines
+      end
+
+      def self.save_lldbinit_rewrite(user_proj_directory)
+        lldbinit_lines = clean_lldbinit_content(LLDB_INIT_PATH)
+        lldbinit_lines = add_lldbinit_rewrite(lldbinit_lines, user_proj_directory) unless user_proj_directory.nil?
+        File.write(LLDB_INIT_PATH, lldbinit_lines.join("\n"), mode: "w")
+      end
+
+      Pod::HooksManager.register('cocoapods-xcremotecache', :post_install) do |installer_context|
+        if @@configuration.nil?
+          Pod::UI.puts "[XCRC] Warning! XCRemoteCache not configured. Call xcremotecache({...}) in Podfile to enable XCRemoteCache"
+          next
+        end
+
+        user_project = installer_context.umbrella_targets[0].user_project
+
+        begin    
+          user_proj_directory = File.dirname(user_project.path)
+          set_configuration_default_values(user_proj_directory)
+
+          unless @@configuration['enabled']
+            Pod::UI.puts "[XCRC] XCRemoteCache disabled"
+            disable_xcremotecache(user_project)
+            next
+          end
+
+          validate_configuration()
+
+          mode = @@configuration['mode']
+          xccc_location = @@configuration['xccc_file']
+          remote_commit_file = @@configuration['remote_commit_file']
+          xcrc_location = @@configuration['xcrc_location']
+          exclude_targets = @@configuration['exclude_targets'] || []
+          exclude_build_configurations = @@configuration['exclude_build_configurations'] || []
+          final_target = @@configuration['final_target']
+          check_build_configuration = @@configuration['check_build_configuration']
+          check_platform = @@configuration['check_platform']
+
+          # Download XCRC
+          download_xcrc_if_needed(xcrc_location)
+
+          # Save .rcinfo
+          save_rcinfo(generate_rcinfo(), user_proj_directory)
+
+          # Create directory for xccc & arc.rc location
+          Dir.mkdir(BIN_DIR) unless File.exist?(BIN_DIR)
+
+          # Remove previous xccc & arc.rc
+          File.delete(remote_commit_file) if File.exist?(remote_commit_file)
+          File.delete(xccc_location) if File.exist?(xccc_location)
+
+          # Prepare XCRC
+          begin
+            prepare_result = YAML.load`#{xcrc_location}/xcprepare --configuration #{check_build_configuration} --platform #{check_platform}`
+            unless prepare_result['result'] || mode != 'consumer'
+              # Uninstall the XCRemoteCache for the consumer mode
+              disable_xcremotecache(user_project)
+              Pod::UI.puts "[XCRC] XCRemoteCache disabled - no artifacts available"
+              next
+            end
+          rescue => error
+            disable_xcremotecache(user_project)
+            Pod::UI.puts "[XCRC] XCRemoteCache failed with an error: #{error}."
+            next
+          end
+
+          # Attach XCRemoteCache to Pods targets
+          installer_context.pods_project.targets.each do |target|
+              next if target.name.start_with?("Pods-")
+              next if target.name.end_with?("Tests")
+              next if exclude_targets.include?(target.name)
+              enable_xcremotecache(target, user_proj_directory, xcrc_location, xccc_location, mode, exclude_build_configurations, check_build_configuration, check_platform, final_target)
+          end
+
+          # Create .rcinfo into `Pods` directory as that .xcodeproj reads configuration from .xcodeproj location
+          pods_proj_directory = installer_context.sandbox_root
+          
+          # Manual .rcinfo generation (in YAML format)
+          save_rcinfo({'extra_configuration_file' => "#{user_proj_directory}/.rcinfo"}, pods_proj_directory)
+
+          installer_context.pods_project.save()
+
+          # Attach XCRC to the app targets
+          user_project.targets.each do |target|
+              next if exclude_targets.include?(target.name)
+              enable_xcremotecache(target, user_proj_directory, xcrc_location, xccc_location, mode, exclude_build_configurations, check_build_configuration, check_platform, final_target)
+          end
+
+          # Set Target sourcemap
+          if @@configuration['modify_lldb_init']
+            save_lldbinit_rewrite(user_proj_directory)
+          else
+            Pod::UI.puts "[XCRC] lldbinit modification is disabled. Debugging may behave weirdly"
+            Pod::UI.puts "[XCRC] put \"settings set target.source-map #{FAKE_SRCROOT} \#{your_project_directory}\" to your \".lldbinit\" "
+          end
+
+          user_project.save()
+          Pod::UI.puts "[XCRC] XCRemoteCache enabled"
+        rescue Exception => e
+          Pod::UI.puts "[XCRC] XCRemoteCache disabled with error: #{e}"
+          puts e.full_message(highlight: true, order: :top)
+          disable_xcremotecache(user_project)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-xcremotecache/command/podfile.rb

@@ -0,0 +1,26 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'cocoapods'
+
+module Pod
+  class Podfile
+    module DSL
+        
+      def xcremotecache(configuration)
+          CocoapodsXCRemoteCacheModifier::Hooks::XCRemoteCache.configure(configuration)
+      end
+    end
+  end
+end

data/lib/cocoapods-xcremotecache/command/xcremotecache.rb

@@ -0,0 +1,56 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Pod
+  class Command
+    # This is an example of a cocoapods plugin adding a top-level subcommand
+    # to the 'pod' command.
+    #
+    # You can also create subcommands of existing or new commands. Say you
+    # wanted to add a subcommand to `list` to show newly deprecated pods,
+    # (e.g. `pod list deprecated`), there are a few things that would need
+    # to change.
+    #
+    # - move this file to `lib/pod/command/list/deprecated.rb` and update
+    #   the class to exist in the the Pod::Command::List namespace
+    # - change this class to extend from `List` instead of `Command`. This
+    #   tells the plugin system that it is a subcommand of `list`.
+    # - edit `lib/cocoapods_plugins.rb` to require this file
+    #
+    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
+    #       in the `plugins.json` file, once your plugin is released.
+    #
+    class Xcremotecache < Command
+      self.summary = 'Plugin to integrate CocoaPods with XCRemoteCache.'
+
+      self.description = <<-DESC
+        Configuring a project to use XCRemoteCache (along the Pods targets).
+      DESC
+
+      def initialize(argv)
+        @name = argv.shift_argument
+        super
+      end
+
+      def validate!
+        super
+        help! 'A Pod name is required.' unless @name
+      end
+
+      def run
+        UI.puts "Add your implementation for the cocoapods-xcremotecache plugin in #{__FILE__}"
+      end
+    end
+  end
+end

data/lib/cocoapods-xcremotecache/command.rb

@@ -0,0 +1,17 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'cocoapods-xcremotecache/command/xcremotecache'
+require 'cocoapods-xcremotecache/command/hooks'
+require 'cocoapods-xcremotecache/command/podfile'

data/lib/cocoapods-xcremotecache/gem_version.rb

@@ -0,0 +1,17 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module CocoapodsXcremotecache
+  VERSION = "0.0.1"
+end

data/lib/cocoapods-xcremotecache.rb

@@ -0,0 +1,15 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'cocoapods-xcremotecache/gem_version'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,15 @@
+# Copyright 2021 Spotify AB
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'cocoapods-xcremotecache/command'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-xcremotecache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bartosz Polaczyk
+- Mark Vasiv
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-16 00:00:00.000000000 Z
+dependencies: []
+description: CocoaPods plugin that enables XCRemoteCache with the project.
+email:
+- bartoszp@spotify.com
+- mvasiv@spotify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- cocoapods-xcremotecache.gemspec
+- lib/cocoapods-xcremotecache.rb
+- lib/cocoapods-xcremotecache/command.rb
+- lib/cocoapods-xcremotecache/command/hooks.rb
+- lib/cocoapods-xcremotecache/command/podfile.rb
+- lib/cocoapods-xcremotecache/command/xcremotecache.rb
+- lib/cocoapods-xcremotecache/gem_version.rb
+- lib/cocoapods_plugin.rb
+homepage: https://github.com/spotify/XCRemoteCache
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A simple plugin that attaches to the post_install hook and modifies the generated
+  project to use XCRemoteCache. Supports both producing anc consuming parts.
+test_files: []