carthage_remote_cache 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9bbfa634ee9bb3c1bfadcd969e0cee161b05b31
-  data.tar.gz: 41a3a1a435a0db2570ca4165cc2056c44ecdaf44
+  metadata.gz: 9d72fcf3c6a1bd8bed3bf28731cb8be97eef6447
+  data.tar.gz: 99bf505f952e7cc72198b20d8a80c24900f77ebb
 SHA512:
-  metadata.gz: d192c10e5ac5e87bd66deadb3808b688e7f471e7fbb9d30761edbe439c5ad29418e001edcc051d80e83935862cd625ba08edaee3c8deb3c5708eca1090be0b90
-  data.tar.gz: f714d62a8a03134efa062bc061adeb121f8c9f4960ec22ca8b77b8d6a79e0c96332d5ada2dcb4864856007dffd24fb3d20177d1508211eb1ac3e407c52d5acff
+  metadata.gz: 9a68a8da37a77f7f7b7a374a927d75869f4b2970e3896ba2f02e43d4ad9b693ed4d635aa4fc2dc6df664309ed7ef9688f42ae3dc1e2bdf68a73e96fd61509ae8
+  data.tar.gz: e8fbdcb7ff274a4eeb05c869c467ca213a1aba0d9c667284049a58573e1c45bcdabfeeddcdbdb406785a9a525fe7ae9b39513e35d0c1baf75651b8f60413a036

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    carthage_remote_cache (0.0.6)
+    carthage_remote_cache (0.0.7)
       concurrent-ruby (~> 1.0.5)
       rack (~> 2.0.4)
       rest-client (~> 2.0.2)
-      sinatra (~> 2.0.0)
+      sinatra (~> 2.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -43,7 +43,7 @@ GEM
     mime-types-data (3.2016.0521)
     mocha (1.3.0)
       metaclass (~> 0.0.1)
-    mustermann (1.0.1)
+    mustermann (1.0.2)
     nenv (0.3.0)
     netrc (0.11.0)
     notiffany (0.1.1)
@@ -54,7 +54,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rack (2.0.4)
-    rack-protection (2.0.0)
+    rack-protection (2.0.1)
       rack
     rake (10.5.0)
     rb-fsevent (0.10.2)
@@ -69,10 +69,10 @@ GEM
     ruby_dep (1.5.0)
     rufo (0.2.0)
     shellany (0.0.1)
-    sinatra (2.0.0)
+    sinatra (2.0.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.1)
       tilt (~> 2.0)
     test-unit (3.2.7)
       power_assert

data/README.md

@@ -105,6 +105,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
@@ -161,7 +194,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
@@ -200,6 +233,9 @@ 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
 

data/bin/carthagerc

@@ -42,6 +42,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 ""
@@ -80,10 +83,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,7 +14,7 @@ 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) }
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0.5"
   spec.add_runtime_dependency "rack", "~> 2.0.4"
   spec.add_runtime_dependency "rest-client", "~> 2.0.2"
-  spec.add_runtime_dependency "sinatra", "~> 2.0.0"
+  spec.add_runtime_dependency "sinatra", "~> 2.0.1"
 end

data/lib/api.rb

@@ -1,6 +1,7 @@
 class API
-  def initialize(shell, networking, options)
+  def initialize(shell, config, networking, options)
     @shell = shell
+    @config = config
     @networking = networking
     @options = options
   end
@@ -8,7 +9,28 @@ class API
   def verify_server_version
     server_version = @networking.get_server_version
     unless server_version == VERSION
-      raise VersionMismatchError.new, version_mismatch_message(server_version)
+      raise ServerVersionMismatchError.new, version_mismatch_message(server_version)
+    end
+  end
+
+  def verify_build_dir_matches_cartfile_resolved
+    errors = []
+    for carthage_dependency in @config.carthage_resolved_dependencies
+      begin
+        version_file = carthage_dependency.new_version_file
+        carthage_dependency.verify_version_in_version_file(version_file)
+      rescue VersionFileDoesNotExistError => e
+        errors << OutdatedFrameworkBuildError.new(
+          carthage_dependency.guessed_framework_basename,
+          '-',
+          carthage_dependency.version
+        )
+      rescue OutdatedFrameworkBuildError => e
+        errors << e
+      end
+    end
+    if errors.count > 0
+      raise FrameworkValidationError.new(errors)
     end
   end
 

data/lib/carthage_dependency.rb

@@ -27,6 +27,10 @@ class CarthageDependency
     @version = args[:version]
   end
 
+  def new_version_file
+    VersionFile.new(version_filepath)
+  end
+
   # Since one Cartfile.resolved entry may produce multiple differently named frameworks,
   # this is an entry point to identifying a framework name.
   def guessed_framework_basename
@@ -65,25 +69,13 @@ class CarthageDependency
     end
   end
 
-  def validate_version_file(version_file)
+  def verify_version_in_version_file(version_file)
     if @version != version_file.version
-      raise OutdatedFrameworkBuildError.new, version_validation_message(version_file)
+      raise OutdatedFrameworkBuildError.new(guessed_framework_basename, version_file.version, @version)
     end
   end
 
   def to_s
     "#{@origin.to_s} \"#{@source}\" \"#{@version}\""
   end
-
-  private
-
-  def version_validation_message(version_file)
-    <<~EOS
-      Outdated version of '#{guessed_framework_basename}' framework detected:
-        Expected version '#{@version}'
-        Found version '#{version_file.version}'
-
-      Please run `carthage bootstrap` to build frameworks.
-    EOS
-  end
 end

data/lib/carthage_remote_cache.rb

@@ -11,6 +11,7 @@ require 'errors'
 require 'log'
 require 'networking'
 require 'shell_wrapper'
+require 'table'
 require 'utils'
 require 'version'
 require 'version_file'

data/lib/commands.rb

@@ -5,3 +5,4 @@ require 'commands/download_command'
 require 'commands/init_command'
 require 'commands/server_command'
 require 'commands/upload_command'
+require 'commands/verify_command'

data/lib/commands/download_command.rb

@@ -5,7 +5,7 @@ class DownloadCommand
     shell = ShellWrapper.new
     config = Configuration.new(shell)
     networking = Networking.new(config)
-    api = API.new(shell, networking, options)
+    api = API.new(shell, config, networking, options)
 
     DownloadCommand.new(
       config: config,
@@ -21,6 +21,7 @@ class DownloadCommand
   end
 
   def run
+    @config.ensure_shell_commands
     @api.verify_server_version
 
     pool = Concurrent::FixedThreadPool.new(THREAD_POOL_SIZE)
@@ -31,7 +32,7 @@ class DownloadCommand
     @total_archive_size = 0
     errors = Concurrent::Array.new
 
-    for carthage_dependency in @config.carthage_dependencies
+    for carthage_dependency in @config.carthage_resolved_dependencies
       pool.post(carthage_dependency) do |carthage_dependency|
         begin
           download(carthage_dependency)
@@ -58,7 +59,7 @@ class DownloadCommand
   def download(carthage_dependency)
     local_version_file =
       if File.exist?(carthage_dependency.version_filepath)
-        VersionFile.new(carthage_dependency.version_filepath)
+        carthage_dependency.new_version_file
       else
         nil
       end

data/lib/commands/upload_command.rb

@@ -5,7 +5,7 @@ class UploadCommand
     shell = ShellWrapper.new
     config = Configuration.new(shell)
     networking = Networking.new(config)
-    api = API.new(shell, networking, options)
+    api = API.new(shell, config, networking, options)
 
     UploadCommand.new(
       config: config,
@@ -21,7 +21,9 @@ class UploadCommand
   end
 
   def run
+    @config.ensure_shell_commands
     @api.verify_server_version
+    @api.verify_build_dir_matches_cartfile_resolved
 
     pool = Concurrent::FixedThreadPool.new(THREAD_POOL_SIZE)
 
@@ -33,7 +35,7 @@ class UploadCommand
     @total_archive_size = 0
     errors = Concurrent::Array.new
 
-    for carthage_dependency in @config.carthage_dependencies
+    for carthage_dependency in @config.carthage_resolved_dependencies
       pool.post(carthage_dependency) do |carthage_dependency|
         begin
           upload(carthage_dependency)
@@ -58,9 +60,7 @@ class UploadCommand
   private
 
   def upload(carthage_dependency)
-    version_file = VersionFile.new(carthage_dependency.version_filepath)
-
-    carthage_dependency.validate_version_file(version_file)
+    version_file = carthage_dependency.new_version_file
 
     if @api.version_file_matches_server?(carthage_dependency, version_file)
       $LOG.debug("Version file #{version_file.path} matches server version, skipping upload")

data/lib/commands/verify_command.rb

@@ -0,0 +1,18 @@
+class VerifyCommand
+  def self.new_with_defaults(options)
+    shell = ShellWrapper.new
+    config = Configuration.new(shell)
+    networking = Networking.new(config)
+    api = API.new(shell, config, networking, options)
+
+    VerifyCommand.new(api: api)
+  end
+
+  def initialize(args)
+    @api = args[:api]
+  end
+
+  def run
+    @api.verify_build_dir_matches_cartfile_resolved
+  end
+end

data/lib/configuration.rb

@@ -11,14 +11,15 @@ class Configuration
     yield(@@user_config)
   end
 
-  attr_reader :xcodebuild_version, :swift_version, :carthage_dependencies, :server_uri
+  attr_reader :carthage_resolved_dependencies, :server_uri
 
   def self.new_with_defaults
     Configuration.new(ShellWrapper.new)
   end
 
   def initialize(shell)
-    initialize_env(shell)
+    @shell = shell
+    initialize_cartfile_resolved
     initialize_cartrcfile
   end
 
@@ -26,16 +27,40 @@ class Configuration
     version_files.flat_map { |vf| vf.framework_names }.uniq.sort
   end
 
+  # Ensure, that these lazy properties are loaded before kicking off async code.
+  def ensure_shell_commands
+    xcodebuild_version
+    swift_version
+  end
+
+  def xcodebuild_version
+    if @xcodebuild_version.nil?
+      xcodebuild_raw_version = @shell.xcodebuild_version
+      @xcodebuild_version = xcodebuild_raw_version[/Build version (.*)$/, 1]
+      raise AppError.new, "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
+    end
+    @xcodebuild_version
+  end
+
+  def swift_version
+    if @swift_version.nil?
+      swift_raw_version = @shell.swift_version
+      @swift_version = swift_raw_version[/Apple Swift version (.*) \(/, 1]
+      raise AppError.new, "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
+    end
+    @swift_version
+  end
+
   def to_s
     <<~EOS
-      Xcodebuild: #{@xcodebuild_version}
+      Xcodebuild: #{xcodebuild_version}
       ---
-      Swift: #{@swift_version}
+      Swift: #{swift_version}
       ---
       Server: #{@server_uri.to_s}
       ---
       Cartfile.resolved:
-      #{@carthage_dependencies.join("\n")}
+      #{@carthage_resolved_dependencies.join("\n")}
       ---
       Local Build Frameworks:
       #{framework_names_with_platforms.join("\n")}
@@ -44,17 +69,9 @@ class Configuration
 
   private
 
-  def initialize_env(shell)
-    xcodebuild_raw_version = shell.xcodebuild_version
-    @xcodebuild_version = xcodebuild_raw_version[/Build version (.*)$/, 1]
-    raise AppError.new, "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
-
-    swift_raw_version = shell.swift_version
-    @swift_version = swift_raw_version[/Apple Swift version (.*) \(/, 1]
-    raise AppError.new, "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
-
+  def initialize_cartfile_resolved
     raise AppError.new, "Misssing #{CARTFILE_RESOLVED}" unless File.exist?(CARTFILE_RESOLVED)
-    @carthage_dependencies = File.readlines(CARTFILE_RESOLVED)
+    @carthage_resolved_dependencies = File.readlines(CARTFILE_RESOLVED)
       .map { |line| CarthageDependency.parse_cartfile_resolved_line(line) }
       .compact
   end
@@ -79,6 +96,6 @@ class Configuration
   end
 
   def version_files
-    @carthage_dependencies.map { |d| VersionFile.new(d.version_filepath) }
+    @carthage_resolved_dependencies.map { |d| d.new_version_file }
   end
 end

data/lib/errors.rb

@@ -19,8 +19,53 @@ class MultipleErrorsError < AppError
   end
 end
 
-class OutdatedFrameworkBuildError < AppError; end
+class VersionFileDoesNotExistError < AppError; end
+
+class OutdatedFrameworkBuildError < AppError
+  attr_reader :framework_name, :build_version, :cartfile_resolved_version
+
+  def initialize(framework_name, build_version, cartfile_resolved_version)
+    @framework_name = framework_name
+    @build_version = build_version
+    @cartfile_resolved_version = cartfile_resolved_version
+  end
+
+  def ==(o)
+    self.class == o.class && state == o.state
+  end
+
+  def to_s
+    "framework name: #{@framework_name}, build version: #{@build_version}, resolved version: #{@cartfile_resolved_version}"
+  end
+
+  protected
+
+  def state
+    [@framework_name, @build_version, @cartfile_resolved_version]
+  end
+end
+
+class FrameworkValidationError < AppError
+  def initialize(errors)
+    @errors = errors
+  end
+
+  def to_s
+    header = ['Framework', CARTHAGE_BUILD_DIR, CARTFILE_RESOLVED]
+    rows = @errors.map { |e| [e.framework_name, e.build_version, e.cartfile_resolved_version] }
+    table = Table.new(header, rows)
+    <<~EOS
+      Detected differences between existing frameworks in '#{CARTHAGE_BUILD_DIR}' and entries in '#{CARTFILE_RESOLVED}':
+
+      #{table}
+
+      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.
+    EOS
+  end
+end
 
 class MissingFrameworkDirectoryError < AppError; end
 
-class VersionMismatchError < AppError; end
+class ServerVersionMismatchError < AppError; end

data/lib/table.rb

@@ -0,0 +1,58 @@
+class Table
+  def initialize(header, rows)
+    @header = header
+    @rows = rows
+    @column_sizes = calculate_column_sizes
+  end
+
+  def to_s
+    lines = [
+      separator_line,
+      header_line,
+      separator_line,
+      @rows.map { |r| row_line(r) },
+      separator_line,
+    ]
+
+    lines
+      .flatten
+      .reject { |line| line.empty? }
+      .join("\n")
+  end
+
+  private
+
+  def calculate_column_sizes
+    all = [@header] + @rows
+    result = all.transpose.map do |row|
+      lengths = row.map { |r| r.length }
+      lengths.max + 2
+    end
+    result
+  end
+
+  def separator_line
+    dashes = @column_sizes.map { |size| '-' * size }
+    '+' + dashes.join('+') + '+'
+  end
+
+  def header_line
+    columns = @header.each_with_index.map do |column, index|
+      column_size = @column_sizes[index] - 1
+      " %-#{column_size}.#{column_size}s" % column
+    end
+    '|' + columns.join('|') + '|'
+  end
+
+  def row_line(row)
+    columns = row.each_with_index.map do |column, index|
+      column_size = @column_sizes[index] - 1
+      if index == 0
+        " %-#{column_size}.#{column_size}s" % column
+      else
+        "%#{column_size}.#{column_size}s " % column
+      end
+    end
+    '|' + columns.join('|') + '|'
+  end
+end

data/lib/version.rb

@@ -1 +1 @@
-VERSION = '0.0.6'
+VERSION = '0.0.7'

data/lib/version_file.rb

@@ -62,7 +62,7 @@ class VersionFile
   private
 
   def parse
-    raise AppError.new, "File #{path} doesn't exist, has carthage been bootstrapped?" unless File.exist?(@path)
+    raise VersionFileDoesNotExistError.new, "File #{path} doesn't exist, has carthage been bootstrapped?" unless File.exist?(@path)
 
     file = File.read(@path)
     json = JSON.parse(file)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carthage_remote_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Juraj Blahunka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1
 description: Centralized cache to serve carthage frameworks. Useful for distributed
   CI setup with several build machines.
 email:
@@ -197,7 +197,6 @@ files:
 - Rakefile
 - bin/carthagerc
 - carthage_remote_cache.gemspec
-- com.kayak.carthagerc.server.plist
 - dev/console
 - dev/setup
 - dev/start_server
@@ -210,6 +209,7 @@ files:
 - lib/commands/init_command.rb
 - lib/commands/server_command.rb
 - lib/commands/upload_command.rb
+- lib/commands/verify_command.rb
 - lib/configuration.rb
 - lib/constants.rb
 - lib/crc32.rb
@@ -219,6 +219,7 @@ files:
 - lib/server/config.ru
 - lib/server/server_app.rb
 - lib/shell_wrapper.rb
+- lib/table.rb
 - lib/utils.rb
 - lib/version.rb
 - lib/version_file.rb

data/com.kayak.carthagerc.server.plist

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-    <dict>
-        <key>Label</key>
-        <string>com.kayak.carthagerc.server</string>
-        <key>ProgramArguments</key>
-        <array>
-            <string>/usr/local/bin/carthagerc</string>
-            <string>server</string>
-            <string>--port=9292</string>
-        </array>
-        <key>KeepAlive</key>
-        <true/>
-        <key>StandardOutPath</key>
-        <string>/Users/MY_USER/Library/Logs/carthagerc.server.stdout.log</string>
-        <key>StandardErrorPath</key>
-        <string>/Users/MY_USER/Library/Logs/carthagerc.server.stderr.log</string>
-    </dict>
-</plist>