carthage_remote_cache 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76eb34fe905eb5fce02802b6b3d7a764b144cc4ab20b6f67d2068215c6605811
-  data.tar.gz: ce2786ceae18cdc95d4c21360044b21838f839879d5a69f883d7b8c8d2040f15
+  metadata.gz: db51bc926af285ff03bc266988ab005c5f7ab4e7131aec89d12a99b1d14ea0f1
+  data.tar.gz: 6d41c8d5b3c6b08369fe595169f53ca8c8cfbc22614726227687625efae341b4
 SHA512:
-  metadata.gz: a128b2d782cee56f2ddfc018a8f4e4e3275dd87b1337d6420861ee376edd0ea468655739951667768855721d0f91a7176a4102a4f20a2cc92e363e617bebe2d8
-  data.tar.gz: ffead6c5c29416ed7d12e2fdbd26f465127deedb80fb3af261904de35b2a22245a9302427081ff5e86585e2426db4a4444bbac57680e0726b7b3d2d9809f2e8d
+  metadata.gz: 2fc9aa022853786a525dc61f4bbb23f1c53ff5458b05466bdf0041ac664703118391fa1cf82671c32e39012eefa1f01f664a903b35a85142e8b18ff6ae450a1f
+  data.tar.gz: ce992ab16d4281d7d348e3b04ef405de51a66fb1036282ae6a17055c7a0ab958aa1c7bb6b3e24a7adad2f04c6fc727938624e493fe31b3bdd4c2474cbd1b1540

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.7.1-alpine3.12
+
+RUN apk add --no-cache g++ make
+RUN gem install carthage_remote_cache
+
+EXPOSE 9292
+CMD ["carthagerc", "server"]

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    carthage_remote_cache (0.0.5)
+    carthage_remote_cache (0.0.10)
       concurrent-ruby (~> 1.0.5)
-      rack (~> 2.0.4)
+      rack (>= 2.0.6, < 2.3.0)
       rest-client (~> 2.0.2)
-      sinatra (~> 2.0.0)
+      sinatra (~> 2.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    coderay (1.1.3)
     concurrent-ruby (1.0.5)
-    domain_name (0.5.20170404)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.9.21)
+    ffi (1.15.0)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -31,70 +31,70 @@ GEM
       test-unit (~> 3.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
     metaclass (0.0.4)
-    method_source (0.9.0)
-    mime-types (3.1)
+    method_source (1.0.0)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mime-types-data (3.2021.0225)
     mocha (1.3.0)
       metaclass (~> 0.0.1)
-    mustermann (1.0.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     nenv (0.3.0)
     netrc (0.11.0)
-    notiffany (0.1.1)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    power_assert (1.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.4)
-    rack-protection (2.0.0)
+    power_assert (2.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rack-protection (2.0.8.1)
       rack
-    rake (10.5.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rerun (0.13.0)
+    rake (13.0.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rerun (0.13.1)
       listen (~> 3.0)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    ruby_dep (1.5.0)
-    rufo (0.2.0)
+    ruby2_keywords (0.0.4)
+    rufo (0.13.0)
     shellany (0.0.1)
-    sinatra (2.0.0)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    test-unit (3.2.7)
+    test-unit (3.2.9)
       power_assert
-    thor (0.20.0)
-    tilt (2.0.8)
+    thor (1.1.0)
+    tilt (2.0.10)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   carthage_remote_cache!
   guard (~> 2.14.2)
   guard-test (~> 2.0.8)
   mocha (~> 1.3.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rerun
   rufo
   test-unit (~> 3.2.7)
 
 BUNDLED WITH
-   1.16.1
+   2.2.11

data/Guardfile

@@ -1,6 +1,6 @@
 guard :test do
   watch(%r{^test/.+_tests\.rb$})
-  watch('test/test_helper.rb') { 'test' }
-  watch('test/fixtures.rb') { 'test' }
+  watch("test/test_helper.rb") { "test" }
+  watch("test/fixtures.rb") { "test" }
   watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_tests.rb" }
 end

data/README.md

@@ -68,22 +68,29 @@ It is recommended to always perform the upload workflow after upgrading Xcode an
 
 ### Download Workflow
 
-Once cache server has been populated with framework binaries, it's time to fetch frameworks from a different machine. Make sure to pull in `Cartrcfile` from respository before executing:
+Once the cache server has been populated with framework binaries, it's time to fetch frameworks from a different machine. Make sure to pull in `Cartrcfile` from the repository before executing:
 
     $ carthagerc download
 
-You should expect to see following output on a machine with empty `Carthage` folder:
+You should expect to see the following output on a machine with empty `Carthage` folder:
 
     Downloaded and extracted 53 archives (97.2 MB), skipped 0 archives.
 
 Your project should be ready for building.
 
-#### Overwriting Local Carthage Folder
+#### Overwrite Local Carthage Folder
 
 In case you happen to change a file in `Carthage/Build` by accident, it's possible to force download all frameworks again with:
 
     $ carthagerc download --force
 
+#### Download Only Some Platforms
+
+The example above downloaded all frameworks for all platforms (iOS, macOS, tvOS, watchOS). If large dependencies or network speed are an issue, you can download only a subset of the platforms by using the `--platform` argument:
+
+    $ carthagerc download --platform iOS,macOS,tvOS,watchOS
+
+Please note, that invoking the `download` command multiple times with different platform arguments is not supported. The `.version` file will "forget" that `carthagerc` already downloaded the platform specified before the last download. If you need multiple platforms, specify them in a single `download` command once, delimited with a comma.
 
 ### Config
 
@@ -105,6 +112,39 @@ Which will print similar information:
     Local Build Frameworks:
     Attributions 0.3 [:iOS]
 
+### Verify Framework Versions
+
+When switching between development branches, it's very easy to lose track of whether existing framework binaries in `Carthage/Build` match version numbers from `Cartfile.resolved`. As a result, you will probably lose several minutes of your development time, because `Xcode` doesn't tell you about outdated or missing framework binaries.
+
+Luckily, `carthage_remote_cache` provides following command:
+
+    carthagerc verify
+
+If existing frameworks match `Cartfile.resolved`, script exits with `0` and doesn't print anything.
+
+In the event of framework version mismatch, you'll be able to observe following output:
+
+    Detected differences between existing frameworks in 'Carthage/Build' and entries in 'Cartfile.resolved':
+
+    +-----------------+----------------+-------------------+
+    | Framework       | Carthage/Build | Cartfile.resolved |
+    +-----------------+----------------+-------------------+
+    | CocoaLumberjack |          3.2.1 |             3.4.1 |
+    | PhoneNumberKit  |          1.3.0 |             2.1.0 |
+    | HelloWorld      |              - |             3.0.0 |
+    +-----------------+----------------+-------------------+
+
+    To resolve the issue:
+    - run `carthagerc download` to fetch missing frameworks from the server.
+    - if the issue persists, run `carthage bootstrap` to build frameworks and `carthagerc upload` to populate the server.
+
+#### Git Hook
+
+Running `carthagerc verify` manually on every git checkout / merge / pull could be quite cumbersome. To automate this task, integrate following script [carthagerc-verify-githook](https://github.com/kayak/carthage_remote_cache/blob/master/integrations/carthagerc-verify-githook) into your repository's git hooks, e.g. `post-checkout`.
+
+See `$ man githooks` for all available git hooks and their documentation.
+
+
 ### Cache Server
 
 Start the server with
@@ -122,6 +162,19 @@ Server is bound to port 9292 by default. If you need to use different port, spec
 
 Don't forget to change port number in your version controlled `Cartrcfile`.
 
+#### Version Compatibility
+
+Before each `carthagerc [upload|download]`, the script compares its version number against cache server. If the version doesn't match, `carthagerc` aborts with:
+
+    Version mismatch:
+      Cache server version: 0.0.7
+      Client version:       0.0.6
+
+    Please use the same version as cache server is using by running:
+    $ gem install carthage_remote_cache -v 0.0.7
+
+Please note, that this functionality only works with clients starting with version [0.0.6](https://github.com/kayak/carthage_remote_cache/releases/tag/0.0.6).
+
 #### Directory Structure
 
 Cache server stores version files and framework archives in following directory structure:
@@ -148,7 +201,7 @@ It's safe to delete whole directories since no other metadata is stored.
 
 #### Launch Agent
 
-You can also run the cache server as a launch agent. Copy the template [com.kayak.carthagerc.server.plist](https://github.com/kayak/carthage_remote_cache/blob/master/com.kayak.carthagerc.server.plist) file to `~/Library/LaunchAgents`, change log
+You can also run the cache server as a launch agent. Copy the template [com.kayak.carthagerc.server.plist](https://github.com/kayak/carthage_remote_cache/blob/master/integrations/com.kayak.carthagerc.server.plist) file to `~/Library/LaunchAgents`, change log
 paths to include your username and run:
 
     $ launchctl load -w ~/Library/LaunchAgents/com.kayak.carthagerc.server.plist
@@ -159,6 +212,30 @@ If you want to stop the agent, run:
 
 Check out official documentation on [Launch Agents](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) for more info.
 
+#### Docker
+
+To build an image based on the latest released gem, run
+
+    $ docker build -t carthagerc .
+
+Afterwards you can run the image in a container using
+
+    $ docker run -d --publish 9292:9292 --name carthagerc carthagerc:latest
+
+The server will now be available on port 9292 on `localhost`. Note that the command above will cause any data added to `~/.carthagerc_server` to be written into the container layer. While this works, it's generally discouraged due to decreased performance and portability. To avoid this, you can use a volume.
+
+    $ docker run -d --publish 9292:9292 --mount "source=carthagerc,target=/root/.carthagerc_server" --name carthagerc carthagerc:latest
+
+We also recommend adding the `--log-opt` option to limit the size of logs, e.g. `--log-opt max-size=50m`.
+
+To inspect the logs after running, use
+
+    $ docker logs carthagerc
+
+To stop the container, run
+
+    $ docker container stop carthagerc
+
 ### Version
 
     $ carthagerc version
@@ -175,7 +252,7 @@ Documentation is also available when running `carthagerc` or `carthagerc --help`
         config
             print environment information and Cartrcfile configuration
 
-        download [-f|--force] [-v|--verbose]
+        download [-f|--force] [-v|--verbose] [-mPLATFORM|--platform=PLATFORM]
             fetch missing frameworks into Carthage/Build
 
         init
@@ -187,12 +264,17 @@ Documentation is also available when running `carthagerc` or `carthagerc --help`
         server [-pPORT|--port=PORT]
             start cache server
 
+        verify
+            compare versions from Cartfile.resolved to existing frameworks in Carthage/Build
+
         version
             print current version number
 
     OPTIONS
         -f, --force                      Force upload/download of framework archives even if local and server .version files match
         -h, --help                       Show help
+        -m, --platform=PLATFORM          Comma delimited list of platforms which should be downloaded from the server; e.g. `--platform iOS,macOS`; Supported values: iOS, macOS, tvOS, watchOS
+        -n, --no-retry                   Don't retry download or upload on network failures
         -p, --port=PORT                  Server application port used when starting server, default port is 9292
         -v, --verbose                    Show extra runtime information
 

data/Rakefile

@@ -5,10 +5,10 @@ task :default => :spec
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_tests.rb']
+  t.test_files = FileList["test/*_tests.rb"]
   t.verbose = true
 end
 
 task :format do
-  system('rufo bin/carthagerc lib test Gemfile Guardfile Rakefile carthage_remote_cache.gemspec')
+  system("bundle exec rufo bin/carthagerc lib test Gemfile Guardfile Rakefile carthage_remote_cache.gemspec")
 end

data/bin/carthagerc

@@ -2,13 +2,15 @@
 
 $LOAD_PATH.push File.expand_path("../../lib", __FILE__)
 
-require 'optparse'
-require 'carthage_remote_cache'
-require 'commands'
+require "optparse"
+require "carthage_remote_cache"
+require "commands"
 
-ARGV << '-h' if ARGV.empty?
+ARGV << "-h" if ARGV.empty?
+command = ARGV[0]
 options = {
   :force => false,
+  :is_retry_enabled => true,
   :server_port => SERVER_DEFAULT_PORT,
   :verbose => false,
 }
@@ -30,7 +32,7 @@ opt_parser = OptionParser.new do |opt|
   opt.separator "    config"
   opt.separator "        print environment information and #{CARTRCFILE} configuration"
   opt.separator ""
-  opt.separator "    download [-f|--force] [-v|--verbose]"
+  opt.separator "    download [-f|--force] [-v|--verbose] [-mPLATFORM|--platform=PLATFORM]"
   opt.separator "        fetch missing frameworks into Carthage/Build"
   opt.separator ""
   opt.separator "    init"
@@ -42,6 +44,9 @@ opt_parser = OptionParser.new do |opt|
   opt.separator "    server [-pPORT|--port=PORT]"
   opt.separator "        start cache server"
   opt.separator ""
+  opt.separator "    verify"
+  opt.separator "        compare versions from #{CARTFILE_RESOLVED} to existing frameworks in #{CARTHAGE_BUILD_DIR}"
+  opt.separator ""
   opt.separator "    version"
   opt.separator "        print current version number"
   opt.separator ""
@@ -56,6 +61,15 @@ opt_parser = OptionParser.new do |opt|
     exit
   end
 
+  opt.on("-m", "--platform=PLATFORM", "Comma delimited list of platforms which should be downloaded from the server; e.g. `--platform iOS,macOS`; Supported values: #{PLATFORMS.map(&:to_s).join(", ")}") do |platform|
+    raise AppError.new("[-p|--platform] is only supported for the 'download' command") if command != "download"
+    options[:platforms] = platform_to_symbols(platform)
+  end
+
+  opt.on("-n", "--no-retry", "Don't retry download or upload on network failures") do
+    options[:is_retry_enabled] = false
+  end
+
   opt.on("-pPORT", "--port=PORT", "Server application port used when starting server, default port is #{SERVER_DEFAULT_PORT}") do |port|
     options[:server_port] = port
   end
@@ -65,10 +79,9 @@ opt_parser = OptionParser.new do |opt|
   end
 end
 
-opt_parser.parse!
-
 begin
-  command = ARGV[0]
+  opt_parser.parse!
+
   case command
   when "config"
     puts Configuration.new_with_defaults
@@ -80,10 +93,12 @@ begin
     UploadCommand.new_with_defaults(options).run
   when "server"
     ServerCommand.new(options).run
+  when "verify"
+    VerifyCommand.new_with_defaults(options).run
   when "version"
     puts VERSION
   else
-    bail("Unsupported command #{command}, run with --help to show available commands")
+    bail("Unsupported command #{command}, run with --help to show available commands or see README at https://github.com/kayak/carthage_remote_cache")
   end
 rescue AppError => e
   bail(e.message)

data/carthage_remote_cache.gemspec

@@ -14,23 +14,23 @@ Gem::Specification.new do |spec|
   spec.email = ["jblahunka@kayak.com"]
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|example)/})
+    f.match(%r{^(test|spec|features|example|integrations)/})
   end
   spec.bindir = "bin"
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "guard", "~> 2.14.2"
   spec.add_development_dependency "guard-test", "~> 2.0.8"
   spec.add_development_dependency "mocha", "~> 1.3.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rerun"
   spec.add_development_dependency "rufo"
   spec.add_development_dependency "test-unit", "~> 3.2.7"
 
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0.5"
-  spec.add_runtime_dependency "rack", "~> 2.0.4"
+  spec.add_runtime_dependency "rack", ">= 2.0.6", "< 2.3.0"
   spec.add_runtime_dependency "rest-client", "~> 2.0.2"
-  spec.add_runtime_dependency "sinatra", "~> 2.0.0"
+  spec.add_runtime_dependency "sinatra", "~> 2.0.4"
 end

data/dev/start_server

@@ -3,6 +3,6 @@
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 pushd "$DIR/../lib/server"
 
-rerun --no-notify rackup
+bundle exec rerun --no-notify rackup
 
 popd