cocoacache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79c19952c9762997d1df2764df553418753291713e056fb46ac78f4f475aaa52
+  data.tar.gz: dc8dd66718d9397267977d9b5a45fdeb64415cbbc1e8bbdd4222c7e5af84ea02
+SHA512:
+  metadata.gz: dd858d97aa764dedcb54f8d98a0934c65c496abb36184d6f1a1a348569fa08dac3c1395b90959d598d46eb2633754c77f85bc9fac124e5ff981e6c3dc105da4c
+  data.tar.gz: be5221d30aac81c3b9c1a5cdfd9ab365640a8e559df07a7f29d0c34515832e87af8eecca181ebfb23ce69b059fba41a31470ef9602c4a1b9afe546fb1c736f0d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Suyeol Jeon (xoul.kr)
+
+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,76 @@
+# CocoaCache
+
+[![Gem](https://img.shields.io/gem/v/cocoacache.svg)](https://rubygems.org/gems/cocoacache)
+[![Build Status](https://travis-ci.org/devxoul/CocoaCache.svg?branch=master)](https://travis-ci.org/devxoul/CocoaCache)
+[![Codecov](https://img.shields.io/codecov/c/github/devxoul/CocoaCache.svg)](https://codecov.io/gh/devxoul/CocoaCache)
+
+Partial CocoaPods Specs cache for the faster CI build.
+
+## Background
+
+It takes several minutes updating CocoaPods Specs repository while building a project on a CI server. In order to prevent from updating Specs repository, you have to cache the entire Specs repository located in `~/.coccoapods/repos/master`. But this is too large to cache in the CI server. CocoaCache helps to cache specific Pod specs to prevent from updating the Specs repository.
+
+## Concepts
+
+![CocoaCache](https://user-images.githubusercontent.com/931655/60092486-1aa3dd00-9782-11e9-9afe-6e4cb8933e9e.png)
+
+### Saving Cache (Previous Build)
+
+1. Find Pods from `Podfile.lock` to cache.
+2. Copy the specific Specs from the origin Specs directory to `./Specs`.
+   ```
+   $HOME/.cocoapods/repos/master/Specs/7/7/7/ReactorKit -> ./Specs/7/7/7/ReactorKit
+   ```
+3. Cache `./Specs` to the CI server.
+
+### Restoring Cache (Next Build)
+
+1. Restore the `./Spec` directory from the CI server.
+2. Find Pods from `Podfile.lock` to restore.
+3. Copy the cached Specs back to the origin Specs directory from `./Specs`.
+   ```
+   ./Specs/7/7/7/ReactorKit -> $HOME/.cocoapods/repos/master/Specs/7/7/7/ReactorKit
+   ```
+
+## Installation
+
+```console
+$ gem install cocoacache
+```
+
+## Usage
+
+```
+Usage: cocoacache COMMAND [options]
+
+Commands:
+  save        Copy specs from the origin Specs to cache directory.
+  restore     Copy the cached Specs back to the origin directory.
+
+Options:
+  --origin <value>    The origin Specs directory. Defaults to $HOME/.cocoapods/repos/master/Specs
+  --cache <value>     Where to cache the Specs. Defaults to ~/Specs
+  --podfile <value>   The path for the Podfile.lock. Defaults to ~/Podfile.lock
+```
+
+## Configuration
+
+### Travis
+
+**`.travis.yml`**
+
+```yml
+cache:
+  - directories:
+    - Specs
+
+before_install:
+  - ruby scripts/cache_cocoapods.rb restore
+
+before_cache:
+  - ruby scripts/cache_cocoapods.rb save
+```
+
+## License
+
+**CocoaCache** is under MIT license. See the [LICENSE] file for more info.

data/bin/cocoacache

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "cocoacache"
+
+core_factory = CocoaCache::Core
+CocoaCache::Command.run(core_factory, ARGV)

data/lib/cocoacache.rb

@@ -0,0 +1,6 @@
+module CocoaCache
+  require "cocoacache/version"
+
+  autoload :Command,   "cocoacache/command"
+  autoload :Core,      "cocoacache/core"
+end

data/lib/cocoacache/command.rb

@@ -0,0 +1,69 @@
+require "colored2"
+
+module CocoaCache
+  class Command
+    def self.run(core_factory, argv)
+      case argv[0]
+      when "save"
+        core = self.get_core(core_factory, argv)
+        core.save()
+
+      when "restore"
+        core = self.get_core(core_factory, argv)
+        core.restore()
+
+      when "--version"
+        puts CocoaCache::VERSION
+
+      else
+        self.help
+      end
+    end
+
+    def self.get_core(factory, argv)
+      return factory.new(
+        :origin_specs_dir => (
+          self.parse_argument(argv, "--origin") \
+          or "$HOME/.cocoapods/repos/master/Specs"
+        ),
+        :cache_specs_dir => (
+          self.parse_argument(argv, "--cache") \
+            or "Specs"
+        ),
+        :podfile_path => (
+          self.parse_argument(argv, "--podfile") \
+          or "Podfile.lock"
+        ),
+      )
+    end
+
+    def self.help
+      puts <<~HELP
+      Usage: cocoacache COMMAND [options]
+
+      Commands:
+        save        Copy specs from the origin Specs to cache directory.
+        restore     Copy the cached Specs back to the origin directory.
+
+      Options:
+        --origin <value>    The origin Specs directory. Defaults to $HOME/.cocoapods/repos/master/Specs
+        --cache <value>     Where to cache the Specs. Defaults to ~/Specs
+        --podfile <value>   The path for the Podfile.lock. Defaults to ~/Podfile.lock
+      HELP
+    end
+
+    def self.parse_argument(argv, name)
+      index = argv.index(name)
+      if index.nil?
+        return nil
+      end
+
+      value = argv[index + 1]
+      if value.nil? or value.start_with?('--')
+        raise Exception("[!] Insufficient value for option '#{name}'".red)
+      end
+
+      return value
+    end
+  end
+end

data/lib/cocoacache/core.rb

@@ -0,0 +1,59 @@
+require "digest"
+require "yaml"
+
+module CocoaCache
+  class Core
+    attr_accessor :mute
+
+    def initialize(origin_specs_dir:, cache_specs_dir:, podfile_path:)
+      @origin_specs_dir = origin_specs_dir
+      @cache_specs_dir = cache_specs_dir
+      @podfile_path = podfile_path
+    end
+
+    def save()
+      pods = get_pods()
+      pods.each do |pod|
+        origin_path = get_origin_path(pod)
+        cache_path = get_cache_path(pod)
+        copy_dir(:from => origin_path, :to => cache_path)
+      end
+    end
+
+    def restore()
+      pods = get_pods()
+      pods.each do |pod|
+        origin_path = get_origin_path(pod)
+        cache_path = get_cache_path(pod)
+        copy_dir(:from => cache_path, :to => origin_path)
+      end
+    end
+
+    def copy_dir(from:, to:)
+      log "Copy #{from} -> #{to}"
+      `mkdir -p #{to} && cp -R #{from} #{to}/../`
+    end
+
+    def get_pods()
+      lockfile = YAML.load(File.read(@podfile_path))
+      pods = lockfile["SPEC REPOS"]["https://github.com/cocoapods/specs.git"]
+      return pods
+    end
+
+    def get_origin_path(pod)
+      return File.join(@origin_specs_dir, *get_shard_prefixes(pod), pod)
+    end
+
+    def get_cache_path(pod)
+      return File.join(@cache_specs_dir, *get_shard_prefixes(pod), pod)
+    end
+
+    def get_shard_prefixes(pod)
+      return Digest::MD5.hexdigest(pod)[0...3].split("")
+    end
+
+    def log(*strings)
+      puts strings.join(" ") if not @mute
+    end
+  end
+end

data/lib/cocoacache/version.rb

@@ -0,0 +1,3 @@
+module CocoaCache
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: cocoacache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Suyeol Jeon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Partial CocoaPods Specs cache for the faster CI build. It helps to cache
+  specific Pod specs to prevent from updatingthe Specs repository.
+email: devxoul@gmail.com
+executables:
+- cocoacache
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/cocoacache
+- lib/cocoacache.rb
+- lib/cocoacache/command.rb
+- lib/cocoacache/core.rb
+- lib/cocoacache/version.rb
+homepage: https://github.com/devxoul/CocoaCache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Partial CocoaPods Specs cache for the faster CI build
+test_files: []