carthage_remote_cache 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 99a24b3d5f791bcaeb20e54585407e069cef1315
-  data.tar.gz: f2142c1579c0be86a434b7145d6d0598724bb29d
+SHA256:
+  metadata.gz: 419b8edd1e39136269db80965bcffb2fe4e6207f7b83459e549a37f4beac9f7c
+  data.tar.gz: 0c83197b67a7e6b5ef504a1811a533a082c98152e07315414d346eb97049a9fc
 SHA512:
-  metadata.gz: 959084abe1f980e686068760c818f4b138e03075cc88667fc47ea875dab38ab7eb21c5e5a94bb775654e2558a2aa98ed07126e89c4cbadfbb02b456d604494fb
-  data.tar.gz: 4469e11a247c273fc956ed1afac2d6f76a3404d6ee7a24ab387c9d2a1c0145868255b5af2c68f9417b0b1f1c222e5ebe27bfe65704133f118bd2cc48d0561052
+  metadata.gz: 5b4aaad19ca7a53f5ce85fa801c22fe019c66a3281ecb6d239516d8d0c94418201b1974d149ff44fc2e22b6a5085227f9280680b0aef1bc0700ea480fa4a1310
+  data.tar.gz: 5fd1d49c2c75c9ffa64fc36cad248ee4cb670abab779f821582cdfc8b656ba175ece52608a6017022d2ffabd1997bda53c442229d14b876041f557929396bbc9

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.5.0
+script:
+ - bundle exec rake test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carthage_remote_cache (0.0.3)
+    carthage_remote_cache (0.0.4)
       concurrent-ruby (~> 1.0.5)
       rack (~> 2.0.4)
       rest-client (~> 2.0.2)
@@ -10,25 +10,53 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.9.18)
+    ffi (1.9.21)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-test (2.0.8)
+      guard-compat (~> 1.2)
+      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)
+    metaclass (0.0.4)
+    method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
+    mocha (1.3.0)
+      metaclass (~> 0.0.1)
     mustermann (1.0.1)
+    nenv (0.3.0)
     netrc (0.11.0)
+    notiffany (0.1.1)
+      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)
       rack
-    rake (10.4.2)
+    rake (10.5.0)
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -39,11 +67,16 @@ GEM
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     ruby_dep (1.5.0)
+    rufo (0.2.0)
+    shellany (0.0.1)
     sinatra (2.0.0)
       mustermann (~> 1.0)
       rack (~> 2.0)
       rack-protection (= 2.0.0)
       tilt (~> 2.0)
+    test-unit (3.2.7)
+      power_assert
+    thor (0.20.0)
     tilt (2.0.8)
     unf (0.1.4)
       unf_ext
@@ -55,8 +88,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   carthage_remote_cache!
+  guard (~> 2.14.2)
+  guard-test (~> 2.0.8)
+  mocha (~> 1.3.0)
   rake (~> 10.0)
   rerun
+  rufo
+  test-unit (~> 3.2.7)
 
 BUNDLED WITH
    1.16.1

data/Guardfile

@@ -0,0 +1,6 @@
+guard :test do
+  watch(%r{^test/.+_tests\.rb$})
+  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

@@ -1,5 +1,8 @@
 # CarthageRemoteCache
 
+[![Build Status](https://travis-ci.org/kayak/carthage_remote_cache.svg?branch=master)](https://travis-ci.org/kayak/carthage_remote_cache)
+[![Gem Version](https://badge.fury.io/rb/carthage_remote_cache.svg)](https://badge.fury.io/rb/carthage_remote_cache)
+
 Centralized cache to serve Carthage frameworks. Useful for distributed CI setup with several build machines. It's aware of your `xcodebuild` and `swift` versions and builds on top of Carthage's `.xyz.version` file mechanism.
 
 ## Installation
@@ -8,6 +11,8 @@ The gem is published at [rubygems.org](https://rubygems.org/gems/carthage_remote
 
     $ gem install carthage_remote_cache
 
+_Note: Installing ri documentation for sinatra can be quite slow. Install with_ `--no-rdoc --no-ri` _if you don't want to wait._
+
 ## Quickstart
 
 1. Run `carthagerc server` to start the cache on a remote server
@@ -28,7 +33,7 @@ Before running any other commands, it's required to initialize `carthagerc` in y
 Which produces a `Cartrcfile`. Configuration is done via plain `ruby` code, so it is as simple as:
 
     Configuration.setup do |c|
-        c.server = "http://localhost:9292/"
+      c.server = "http://localhost:9292/"
     end
 
 `Cartrcfile` is supposed to be version controlled (e.g. included in git repository), so that it lives along your code and all consumers of the repository have access to same configuration.
@@ -45,15 +50,15 @@ Start the upload with:
 
 After couple of seconds you should be able to see confirmation in terminal:
 
-    Uploaded 53 archives, skipped 0.
+    Uploaded 53 archives (97.2 MB), skipped 0.
 
 #### Overwriting Existing Cache
 
 Attempting to run `carthagerc upload` again will not upload any framework binaries, since all of them are already present on the cache server:
 
-    Uploaded 53 archives, skipped 53.
+    Uploaded 0 archives (0.0 MB), skipped 53.
 
-If your cache happen to be tainted by invalid framework binaries, you can overwrite existing cache with
+If your cache happens to be tainted by invalid framework binaries, you can overwrite existing cache with
 
     $ carthagerc upload --force
 
@@ -69,7 +74,7 @@ Once cache server has been populated with framework binaries, it's time to fetch
 
 You should expect to see following output on a machine with empty `Carthage` folder:
 
-    Downloaded and extracted 53 archives, skipped 0 archives.
+    Downloaded and extracted 53 archives (97.2 MB), skipped 0 archives.
 
 Your project should be ready for building.
 
@@ -117,6 +122,30 @@ 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`.
 
+#### Directory Structure
+
+Cache server stores version files and framework archives in following directory structure:
+
+    .carthagerc_server/
+      9C40b/                            # Xcode version
+        4.0.3/                          # Swift version
+          Framework1/
+            1.0.0/                      # Framework1 version
+              .Framework1.version       # Carthage .version file
+              Framework1-iOS.zip        # Framework binary, dSYM and bcsymbolmap files
+              Framework1-macOS.zip
+              Framework1-tvOS.zip
+              Framework1-watchOS.zip
+            2.0.3/                      # Framework1 version
+              .Framework1.version
+              Framework1-iOS.zip
+          Framework2/
+            v3.2/                       # Framework2 version
+              .Framework2.version
+              Framework2-iOS.zip
+
+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
@@ -128,7 +157,11 @@ If you want to stop the agent, run:
 
     $ launchctl unload ~/Library/LaunchAgents/com.kayak.carthagerc.server.plist
 
-Check out official documentation on [Launch Agents](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) for more info. 
+Check out official documentation on [Launch Agents](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) for more info.
+
+### Version
+
+    $ carthagerc version
 
 ### Help
 
@@ -140,7 +173,7 @@ Documentation is also available when running `carthagerc` or `carthagerc --help`
 
     COMMANDS
         config
-            prints environment information and Cartrcfile configuration
+            print environment information and Cartrcfile configuration
 
         download [-f|--force] [-v|--verbose]
             fetch missing frameworks into Carthage/Build
@@ -154,6 +187,9 @@ Documentation is also available when running `carthagerc` or `carthagerc --help`
         server [-pPORT|--port=PORT]
             start cache server
 
+        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
@@ -162,15 +198,27 @@ Documentation is also available when running `carthagerc` or `carthagerc --help`
 
 ## Development
 
+### Setup
+
 After checking out the repo, run `dev/setup` to install dependencies. You can also run `dev/console` for an interactive prompt that will allow you to experiment.
 
+### Development Server
+
 To start development server, run `dev/start_server`, which utilizes `rerun` for automatic reloading of source code and resources.
 
-Execute unit tests with `rake test`.
+### Tests
+
+Execute unit tests with `rake test` or start monitoring directories for changes with `bundle exec guard`.
+
+### Source Code Format
+
+Before committing, make sure to auto-format source code wit `rake format`.
+
+### Gem Lifecycle
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `carthage_remote_cache.gemspec`, 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/gems/carthage_remote_cache).
+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/gems/carthage_remote_cache).
 
-### Example Folder
+### Experiments With Example Folder
 
 Repository is bundled with an example Carthage setup for your experiments. Open the [example](https://github.com/kayak/carthage_remote_cache/blob/master/example) folder, where you should be able to see following files, which are preconfigured to bring in a couple of frameworks:
 - Cartfile

data/Rakefile

@@ -1,10 +1,14 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "rake/testtask"
 
 task :default => :spec
 
 Rake::TestTask.new do |t|
-    t.libs << "test"
-    t.test_files = FileList['test/*_tests.rb']
-    t.verbose = true
+  t.libs << "test"
+  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')
 end

data/bin/carthagerc

@@ -8,78 +8,83 @@ require 'commands'
 
 ARGV << '-h' if ARGV.empty?
 options = {
-    :force => false,
-    :server_port => SERVER_DEFAULT_PORT,
-    :verbose => false,
+  :force => false,
+  :server_port => SERVER_DEFAULT_PORT,
+  :verbose => false,
 }
 opt_parser = OptionParser.new do |opt|
-    opt.banner = "carthagerc COMMAND [OPTIONS]"
-    opt.separator ""
-    opt.separator "DESCRIPTION"
-    opt.separator "    carthagerc is a centralized remote cache for Carthage framework artifacts. Check out project information at https://github.com/kayak/carthage_remote_cache"
-    opt.separator ""
-    opt.separator "QUICKSTART"
-    opt.separator "    1. Run `carthagerc server` to start the cache on a remote server"
-    opt.separator "    2. `cd` to your project's root folder"
-    opt.separator "    3. Run `carthagerc init` to create `Cartrcfile` and point the server property to your running server URL"
-    opt.separator "    4. Assuming your `Carthage` directory is already built, run `carthagerc upload` to populate remote cache"
-    opt.separator "    5. Push your `Cartrcfile` and from a different machine run `cartrcfile download` to fetch frameworks into `Carthage/Build/` folder"
-    opt.separator "    6. Build your app without having to wait for `carthage bootstrap`"
-    opt.separator ""
-    opt.separator "COMMANDS"
-    opt.separator "    config"
-    opt.separator "        prints environment information and #{CARTRCFILE} configuration"
-    opt.separator ""
-    opt.separator "    download [-f|--force] [-v|--verbose]"
-    opt.separator "        fetch missing frameworks into Carthage/Build"
-    opt.separator ""
-    opt.separator "    init"
-    opt.separator "        create initial #{CARTRCFILE} in current directory"
-    opt.separator ""
-    opt.separator "    upload [-f|--force] [-v|--verbose]"
-    opt.separator "        archive frameworks in Carthage/Build and upload them to the server"
-    opt.separator ""
-    opt.separator "    server [-pPORT|--port=PORT]"
-    opt.separator "        start cache server"
-    opt.separator ""
-    opt.separator "OPTIONS"
+  opt.banner = "carthagerc COMMAND [OPTIONS]"
+  opt.separator ""
+  opt.separator "DESCRIPTION"
+  opt.separator "    carthagerc is a centralized remote cache for Carthage framework artifacts. Check out project information at https://github.com/kayak/carthage_remote_cache"
+  opt.separator ""
+  opt.separator "QUICKSTART"
+  opt.separator "    1. Run `carthagerc server` to start the cache on a remote server"
+  opt.separator "    2. `cd` to your project's root folder"
+  opt.separator "    3. Run `carthagerc init` to create `Cartrcfile` and point the server property to your running server URL"
+  opt.separator "    4. Assuming your `Carthage` directory is already built, run `carthagerc upload` to populate remote cache"
+  opt.separator "    5. Push your `Cartrcfile` and from a different machine run `cartrcfile download` to fetch frameworks into `Carthage/Build/` folder"
+  opt.separator "    6. Build your app without having to wait for `carthage bootstrap`"
+  opt.separator ""
+  opt.separator "COMMANDS"
+  opt.separator "    config"
+  opt.separator "        print environment information and #{CARTRCFILE} configuration"
+  opt.separator ""
+  opt.separator "    download [-f|--force] [-v|--verbose]"
+  opt.separator "        fetch missing frameworks into Carthage/Build"
+  opt.separator ""
+  opt.separator "    init"
+  opt.separator "        create initial #{CARTRCFILE} in current directory"
+  opt.separator ""
+  opt.separator "    upload [-f|--force] [-v|--verbose]"
+  opt.separator "        archive frameworks in Carthage/Build and upload them to the server"
+  opt.separator ""
+  opt.separator "    server [-pPORT|--port=PORT]"
+  opt.separator "        start cache server"
+  opt.separator ""
+  opt.separator "    version"
+  opt.separator "        print current version number"
+  opt.separator ""
+  opt.separator "OPTIONS"
 
-    opt.on("-f", "--force", "Force upload/download of framework archives even if local and server .version files match") do
-        options[:force] = true
-    end
+  opt.on("-f", "--force", "Force upload/download of framework archives even if local and server .version files match") do
+    options[:force] = true
+  end
 
-    opt.on("-h", "--help", "Show help") do
-        puts opt_parser
-        exit
-    end
+  opt.on("-h", "--help", "Show help") do
+    puts opt_parser
+    exit
+  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
+  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
 
-    opt.on("-v", "--verbose", "Show extra runtime information") do
-        $LOG.level = Logger::DEBUG
-    end
+  opt.on("-v", "--verbose", "Show extra runtime information") do
+    $LOG.level = Logger::DEBUG
+  end
 end
 
 opt_parser.parse!
 
 begin
-    command = ARGV[0]
-    case command
-    when "config"
-        puts Configuration.new
-    when "download"
-        DownloadCommand.new(options).run
-    when "init"
-        InitCommand.new(options).run
-    when "upload"
-        UploadCommand.new(options).run
-    when "server"
-        ServerCommand.new(options).run
-    else
-        bail("Unsupported command #{command}, run with --help to show available commands")
-    end
+  command = ARGV[0]
+  case command
+  when "config"
+    puts Configuration.new_with_defaults
+  when "download"
+    DownloadCommand.new_with_defaults(options).run
+  when "init"
+    InitCommand.new(options).run
+  when "upload"
+    UploadCommand.new_with_defaults(options).run
+  when "server"
+    ServerCommand.new(options).run
+  when "version"
+    puts VERSION
+  else
+    bail("Unsupported command #{command}, run with --help to show available commands")
+  end
 rescue AppError => e
-    bail(e.message)
+  bail(e.message)
 end

data/carthage_remote_cache.gemspec

@@ -1,24 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
 Gem::Specification.new do |spec|
-  spec.name          = "carthage_remote_cache"
-  spec.version       = "0.0.3"
+  spec.name = "carthage_remote_cache"
+  spec.version = VERSION
 
-  spec.summary       = %q{Centralized cache to serve carthage frameworks. Useful for distributed CI setup with several build machines.}
-  spec.description   = spec.summary
-  spec.homepage      = "https://github.com/kayak/carthage_remote_cache"
-  spec.license       = "Apache-2.0"
-  spec.authors       = ["Juraj Blahunka"]
-  spec.email         = ["jblahunka@kayak.com"]
+  spec.summary = %q{Centralized cache to serve carthage frameworks. Useful for distributed CI setup with several build machines.}
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/kayak/carthage_remote_cache"
+  spec.license = "Apache-2.0"
+  spec.authors = ["Juraj Blahunka"]
+  spec.email = ["jblahunka@kayak.com"]
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features|example)/})
   end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "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 "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"

data/lib/api.rb

@@ -1,40 +1,45 @@
 class API
+  def initialize(shell, networking, options)
+    @shell = shell
+    @networking = networking
+    @options = options
+  end
 
-    def initialize(networking, options)
-        @networking = networking
-        @options = options
+  def version_file_matches_server?(carthage_dependency, version_file)
+    if @options[:force]
+      false
+    else
+      server_version_file = @networking.download_version_file(carthage_dependency)
+      result = version_file.same_content?(server_version_file)
+      server_version_file.remove unless server_version_file.nil?
+      result
     end
+  end
 
-    def version_file_matches_server?(carthage_dependency, version_file)
-        if @options[:force]
-            false
-        else
-            server_version_file = @networking.download_version_file(carthage_dependency)
-            result = version_file.same_content?(server_version_file)
-            server_version_file.remove unless server_version_file.nil?
-            result
-        end
+  # @return zip archive size in Bytes
+  def create_and_upload_archive(carthage_dependency, framework_name, platform)
+    archive = CarthageArchive.new(framework_name, platform)
+    archive.create_archive(@shell, carthage_dependency.should_include_dsym)
+    archive_size = archive.archive_size
+    begin
+      @networking.upload_framework_archive(archive.archive_path, carthage_dependency, framework_name, platform)
+    ensure
+      archive.delete_archive
     end
+    archive_size
+  end
 
-    def create_and_upload_archive(carthage_dependency, framework_name, platform)
-        archive = CarthageArchive.new(framework_name, platform)
-        archive.create_archive
-        begin
-            @networking.upload_framework_archive(archive.archive_path, carthage_dependency, framework_name, platform)
-        ensure
-            archive.delete_archive
-        end
+  # @return zip archive size in Bytes or nil if archive download failed
+  def download_and_unpack_archive(carthage_dependency, framework_name, platform)
+    archive = @networking.download_framework_archive(carthage_dependency, framework_name, platform)
+    return nil if archive.nil?
+    archive_size = archive.archive_size
+    begin
+      $LOG.debug("Downloaded #{archive.archive_path}")
+      archive.unpack_archive(@shell)
+    ensure
+      archive.delete_archive
     end
-
-    def download_and_unpack_archive(carthage_dependency, framework_name, platform)
-        archive = @networking.download_framework_archive(carthage_dependency, framework_name, platform)
-        return nil if archive.nil?
-        begin
-            $LOG.debug("Downloaded #{archive.archive_path}")
-            archive.unpack_archive
-        ensure
-            archive.delete_archive
-        end
-    end
-
+    archive_size
+  end
 end