carthage_cache_res 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f30f9f51f50d2b8ef8bb55952570f11e561984ea501b3c6c0f9f58941de51a0e
+  data.tar.gz: 10d973dad4c19fde0a14555fb6222cf785f404967b1cbdb94f105b46b5492bc0
+SHA512:
+  metadata.gz: 971215605b5cb17f61280e5932180afcae549b384bbbfd405168ad958ebee3c62d657737c4bca26a3c05a46a961a484d8e8ccda97ac282d3722d30484008acbb
+  data.tar.gz: f02155ded2671dba615a7e9543056a8d0e83298878875c62564a2f0f824815c34c4806ad20e6ca66e7fb9e7fd00867b57de003fa92fcf97b791e651655486c85

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Carthage/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.6.2

data/.travis.yml

@@ -0,0 +1,17 @@
+os:
+  - osx
+language: ruby
+cache: bundler
+osx_image: xcode11
+rvm:
+  - 2.6.2
+
+branches:
+  only:
+    - master
+
+before_install: sudo gem install bundler
+
+addons:
+    code_climate:
+        repo_token: 6220ef8896c380cb590d4640621d1fc4c0d6d36ccc24d3d818cfba76bbd50014

data/CODEOWNERS

@@ -0,0 +1 @@
+*       @hola

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Guido Marucci Blas
+
+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,216 @@
+# CarthageCacheRes
+
+[![Build Status](https://travis-ci.org/guidomb/carthage_cache_res.svg?branch=master)](https://travis-ci.org/guidomb/carthage_cache_res)
+[![Code Climate](https://codeclimate.com/github/guidomb/carthage_cache_res/badges/gpa.svg)](https://codeclimate.com/github/guidomb/carthage_cache_res)
+[![Test Coverage](https://codeclimate.com/github/guidomb/carthage_cache_res/badges/coverage.svg)](https://codeclimate.com/github/guidomb/carthage_cache_res/coverage)
+[![Gem Version](https://badge.fury.io/rb/carthage_cache_res.svg)](https://badge.fury.io/rb/carthage_cache_res)
+
+CarthageCacheRes allows Carthage users to have a shared cache of their `Carthage/Build` folder backed by Amazon S3.
+
+Most libraries don't provide pre-compiled binaries, `.framework` files, in their releases. Even if they do, due to Swift lack of ABI, you might be forced to use `--no-use-binaries` flag and compile all your dependencies. Which, depending on the amount of dependencies and their size it could take significant time.
+
+When you add slow building environments like Travis CI to the mix, a project bootstrap could take around 25 minutes just to build all your dependencies. Which is a lot for every push or pull request. You want your build and test to run really fast.
+
+CarthageCacheRes generates a hash key based on the content of your `Cartfile.resolved` and the current
+installed version of Swift. Then it checks if there is a cache archive (a zip file of your `Carthage/Build` directory) associated to that hash. If there is one it will download it and install it in your project avoiding the need to run `carthage bootstrap`.
+
+**Do you want to improve carthage_cache_res?** [Check all the issues tagged with `help-wanted`!](https://github.com/guidomb/carthage_cache_res/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). I'll be more than happy to review your pull request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carthage_cache_res'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carthage_cache_res
+
+## Setup
+
+### AWS credentials
+
+First of all you need to configure your AWS credentials. You can do this by a `.carthage_cache_res.yml` file. CarthageCacheRes will try to find this file in the current working directory. It is recommended to generate this file in each project you want to use CarthageCacheRes.
+
+To generate a `.carthage_cache_res.yml` you just need to run
+
+```
+carthage_cache_res config
+```
+
+You can also set your credentials using the following environmental variables
+
+ * `AWS_REGION`
+ * `AWS_ACCESS_KEY_ID`
+ * `AWS_SECRET_ACCESS_KEY`
+ * `AWS_SESSION_TOKEN` # optional, for [temporary security credentials](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
+
+Or if you prefer using [AWS Named Profiles](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-multiple-profiles), you can use the following environmental variables instead
+
+ * `AWS_REGION`
+ * `AWS_PROFILE`
+
+### AWS S3 bucket
+
+CarthageCacheRes will assume there is a bucket named `carthage-cache`. You can change the bucket to be used by using the option `-b` or `--bucket-name`.
+
+### IAM Policy
+
+Once you create the bucket, you will need to create a user. Go to the IAM section and create a new user. Create a new group, and add the new user to that group.
+Create a policy with the following permissions:
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "autogenerated-id",
+            "Effect": "Allow",
+            "Action": [
+                "s3:ListBucket"
+            ],
+            "Resource": [
+                "arn:aws:s3:::carthage-cache"
+            ]
+        },
+        {
+            "Sid": "autogenerated-id",
+            "Effect": "Allow",
+            "Action": [
+                "s3:DeleteObject",
+                "s3:GetObject",
+                "s3:PutObject"
+            ],
+            "Resource": [
+                "arn:aws:s3:::carthage-cache/*"
+            ]
+        }
+    ]
+}
+```
+Don't forget to attach the policy to the group and make sure to replace `autogenerated-id` with an ID that should be unique. You can generate a new policy using AWS policy generator and replace the content with the previous snippet keeping the SID field.
+
+## Usage
+
+If you want to bootstrap a project from cache and if there is none then fallback to Carthage.
+
+```
+carthage_cache_res install || carthage bootstrap
+```
+
+If you want to update dependencies and update cache
+
+```
+carthage update && carthage_cache_res publish
+```
+
+If you want to check whether a cache exists for the current `Carfile.resolved`
+
+```
+carthage_cache_res exist
+```
+
+If you want to publish an archive that already exists
+
+```
+carthage_cache_res publish --force
+```
+
+If you want to delete unused libraries from build directory for all targets
+
+```
+carthage_cache_res prune
+```
+
+You can also prune the build directory before publishing a new archive
+
+```
+carthage_cache_res publish --prune-build-directory
+```
+
+Both `prune` and `publish` accept `--prune-white-list` to configure frameworks that don't appear in the `Cartfile.resolved` and should not be pruned by associating them with a framework that does appear in `Cartfile.resolved`. Like `CocoaLumberjackSwift`:
+
+```
+carthage_cache_res publish -p -w .white-list.yml
+```
+ * *`-p` is the short version of `--prune-build-directory`*
+ * *`-w` is the short version of `--prune-white-list`*
+
+where `.white-list.yml` is
+
+```yaml
+"CocoaLumberjackSwift": "CocoaLumberjack"
+```
+
+For more information run the help command
+
+```
+carthage_cache_res help
+```
+
+### OSS project
+
+In an OSS project you wouldn't store AWS credentials anywhere since anyone can have access, even if you have a build like travis that supports for encrypted variables but these are not available in your contributors pull requests build.
+
+In order allow your build to run in these circumstances, you can avoid defining these variables
+
+ * `AWS_ACCESS_KEY_ID`
+ * `AWS_SECRET_ACCESS_KEY`
+ * `AWS_PROFILE`
+
+And **carthage_cache_res** will work in read-only mode, you wont be able to publish new items but your build will still be able to fetch the cached dependencies.
+
+The only requirement is to make the action `s3:GetObject` avaible for any anonymous user in your S3 Bucket
+
+```
+{
+  "Version":"2012-10-17",
+  "Statement":[
+    {
+      "Sid":"AddPerm",
+      "Effect":"Allow",
+      "Principal": "*",
+      "Action":["s3:GetObject"],
+      "Resource":["arn:aws:s3:::examplebucket/*"]
+    }
+  ]
+}
+```
+
+> Please know that this will make all your dependencies **PUBLIC** and accessible for anyone, so if you have sensitive information or proprietary code there you should avoid this configuration.
+
+### Project's root directory
+
+The `carthage_cache_res` command assumes that the project's root directory is the current working directory and that the `Cartfile.resolved` file is located in the project's root directory. All `carthage_cache_res` accept an optional argument to set the project's root directory. For example
+
+```
+carthage_cache_res install
+```
+Will try to read the `Cartfile.resolved` file from the current working directory and will install the cache archive in `./Carthage/Build`.
+
+```
+carthage_cache_res install PATH/TO/MY/PROJECT
+```
+Will try to read the `PATH/TO/MY/PROJECT/Cartfile.resolved` and will install the cache archive in `PATH/TO/MY/PROJECT/Carthage/Build`.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guidomb/carthage_cache_res/issues/new.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# target that generates junit test report for CI builds
+RSpec::Core::RakeTask.new(:ci_spec) do |t|
+  t.fail_on_error = false
+  t.rspec_opts = "--no-drb -r rspec_junit_formatter --format RspecJunitFormatter -o junit.xml"
+end
+
+task :default => :spec 

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "carthage_cache_res"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carthage_cache_res.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carthage_cache_res/version'
+require 'carthage_cache_res/description'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carthage_cache_res"
+  spec.version       = CarthageCacheRes::VERSION
+  spec.authors       = ["Guido Marucci Blas", "dokim"]
+  spec.email         = ["guidomb@gmail.com", "doublekick132@gmail.com"]
+
+  spec.summary       = CarthageCacheRes::DESCRIPTION
+  spec.description   = %q{
+    CarthageCache generate a hash key based on the content of your Cartfile.resolved and checks
+    if there is a cache archive (a zip file of your Carthage/Build directory) associated to that hash.
+    If there is one it will download it and install it in your project avoiding the need to run carthage bootstrap.
+    -------Thanks Mr.Blas but now we are facing dependency conflict with Fastlane 2.144--------
+    What I want to solve: Dependency conflict with Fastlane 2.144
+    What I did: 
+      1. Changed name of this gem to "carthage_cache_res"
+      2. Fixed runtime dependencies: aws-sdk > 3.0, commander = 4.3.8
+      3. Changed system dependency versions: ruby > 2.6, xcode 11.x
+  }
+  spec.homepage      = "https://github.com/dokim/carthage_cache_res"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.2.3"
+
+  spec.add_dependency "aws-sdk", "~> 3.0"
+  spec.add_dependency "commander", "=4.3.8"
+end

data/exe/carthage_cache_res

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+if Gem::Specification::find_all_by_name('bundler').any?
+  require 'bundler/setup'
+else
+  require 'rubygems'
+  gem 'carthage_cache_res'
+end
+
+require "commander/import"
+require "carthage_cache_res"
+
+PROGRAM_NAME = 'carthage_cache_res'
+
+program :name, PROGRAM_NAME
+program :version, CarthageCacheRes::VERSION
+program :description, CarthageCacheRes::DESCRIPTION
+
+config = {}
+verbose = false
+global_option('-b', '--bucket-name BUCKET_NAME', 'Set Amazon S3 bucket to be used to store cache archives') do |bucket_name|
+  config[:bucket_name] = bucket_name
+end
+global_option('--verbose') { verbose = true }
+
+command :exist do |c|
+  c.syntax = "#{PROGRAM_NAME} exist [PROJECT_PATH]"
+  c.description = 'Checks if a cache archive exists for the current Cartfile.resolved.'
+  c.option '-s', '--script', 'Makes prgram write "true" or "false" to STDOUT instead of more verbose message.'
+  c.action do |args, options|
+    app = CarthageCacheRes::Application.new(args.first || ".", verbose, config)
+    if app.archive_exist?
+      if options.script
+        puts "true"
+      else
+        puts "There is a cached archive for the current Cartfile.resolved file."
+      end
+    else
+      if options.script
+        puts "false"
+      else
+        puts "No cached archive available for the current Cartfile.resolved file."
+        puts "You should probably run 'carthage bootstrap'."
+      end
+    end
+  end
+end
+
+command :install do |c|
+  c.syntax = "#{PROGRAM_NAME} install [PROJECT_PATH]"
+  c.description = 'Installs the cache archive for the current Cartfile.resolved.'
+  c.action do |args, options|
+    app = CarthageCacheRes::Application.new(args.first || ".", verbose, config)
+    exit 1 unless app.install_archive
+  end
+end
+
+command :publish do |c|
+  c.syntax = "#{PROGRAM_NAME} publish [PROJECT_PATH]"
+  c.description = 'Generates and uploads the cache archive for the current Cartfile.resolved.'
+  c.option '-f', '--force', 'Forces to create a new archive even if an archive already exist.'
+  c.option '-p', '--prune-build-directory', 'Removes unused frameworks from build directory.'
+  c.option '-w', '--prune-white-list PRUNE_WHITE_LIST', String, 'Path to a YAML file containing the prune white list.'
+  c.option '-x', '--platforms PLATFORMS', String, 'A comma separated list of platforms that should be archived. Platforms not present in this list won\'t be archived'
+  c.action do |args, options|
+    options.default force: false
+    app = CarthageCacheRes::Application.new(args.first || ".", verbose, config)
+    platforms = options.platforms.split(",") if options.platforms
+    if platforms && platforms.empty?
+      puts "If you pass -x or --platforms option the you must specify at least one platform."
+      exit 1
+    end
+    app.create_archive(options.force, options.prune_build_directory, options.prune_white_list, platforms)
+  end
+end
+
+command :config do |c|
+  c.syntax = "#{PROGRAM_NAME} config [PROJECT_PATH]"
+  c.description = "Generates a '#{CarthageCacheRes::Configurator::CONFIG_FILE_NAME}' config file."
+  c.action do |args, options|
+    terminal = CarthageCacheRes::Terminal.new(verbose)
+    configurator = CarthageCacheRes::Configurator.new(terminal, args.first || ".")
+    wizard = CarthageCacheRes::ConfiguratorWizard.new(method(:ask), method(:password))
+    config = wizard.start
+    configurator.save_config(config)
+  end
+end
+
+command :prune do |c|
+  c.syntax = "#{PROGRAM_NAME} prune [PROJECT_PATH]"
+  c.description = 'Removes unused frameworks from build directory.'
+  c.option '-w', '--prune-white-list PRUNE_WHITE_LIST', String, 'Path to a YAML file containing the prune white list.'
+  c.action do |args, options|
+    options.default force: false, prune: false
+    app = CarthageCacheRes::Application.new(args.first || ".", verbose, config)
+    app.prune_build_directory(options.prune_white_list)
+  end
+end
+
+command :validate do |c|
+  c.syntax = "#{PROGRAM_NAME} validate [PROJECT_PATH]"
+  c.description = 'Validates the cache archive for the current Cartfile.resolved.'
+  c.action do |args, options|
+    app = CarthageCacheRes::Application.new(args.first || ".", verbose, config)
+    exit 1 unless app.validate_installation
+  end
+end