carthage_cache 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e4c0f89e316c523b4c0b7c779550416c3aa3d1
-  data.tar.gz: 27bb06a646fbc19798a251464bb15e2afd3939d6
+  metadata.gz: d298e36ed76a7ba934367dd437ccd25f370bb66e
+  data.tar.gz: e21ad383a1a9ce54a9faf6271e495def4cdc9a4e
 SHA512:
-  metadata.gz: e73634ee8da48c3809cce1e81c72a53f95fe92bb85f5aff51127b16690bde6fff50c5b12665e65a44d674e51f4d698c0873a4b5935ef6bc3bd21249c5e5f7a6a
-  data.tar.gz: dcfb6577a53c9ec84c88456e52e6ac109cf8c5b6fd4e6d9b624cd844e0c3c373064e3c4b680aa06badbd770ae13e722e6cfefaa4b50fbe0d413bcceca5605778
+  metadata.gz: 8deda74fee8bcdc4e87814419324c575d3af920abca7861a7125af4a0d27df255b474a09dd42d4569f7b1becac0639077e111738205bd431875068cc1481be35
+  data.tar.gz: 5911f2d074383b5cf017b3812dde21427977613f14900f7c97ae09bc9847c0a858685667928fe0b3140c5d6c1ad35923c5d187b37cf459a8ee11f1e1b60a2853

data/README.md

@@ -107,6 +107,38 @@ If you want to check whether a cache exists for the current `Carfile.resolved`
 carthage_cache exist
 ```
 
+If you want to publish an archive that already exists
+
+```
+carthage_cache publish --force
+```
+
+If you want to delete unused libraries from build directory for all targets
+
+```
+carthage_cache prune
+```
+
+You can also prune the build directory before publishing a new archive
+
+```
+carthage_cache 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 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
 
 ```

data/exe/carthage_cache

@@ -53,10 +53,12 @@ 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.action do |args, options|
-    options.default force: false
+    options.default force: false, prune: false
     app = CarthageCache::Application.new(args.first || ".", verbose, config)
-    app.create_archive(options.force)
+    app.create_archive(options.force, options.prune, options.prune_white_list)
   end
 end
 
@@ -64,9 +66,21 @@ command :config do |c|
   c.syntax = "#{PROGRAM_NAME} config [PROJECT_PATH]"
   c.description = "Generates a '#{CarthageCache::Configurator::CONFIG_FILE_NAME}' config file."
   c.action do |args, options|
-    configurator = CarthageCache::Configurator.new(args.first || ".")
+    terminal = CarthageCache::Terminal.new(verbose)
+    configurator = CarthageCache::Configurator.new(terminal, args.first || ".")
     wizard = CarthageCache::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 = CarthageCache::Application.new(args.first || ".", verbose, config)
+    app.prune_build_directory(options.prune_white_list)
+  end
+end

data/lib/carthage_cache.rb

@@ -7,12 +7,14 @@ require "carthage_cache/carthage_resolved_file"
 require "carthage_cache/project"
 require "carthage_cache/repository"
 require "carthage_cache/terminal"
+require "carthage_cache/configuration_validator"
 require "carthage_cache/configuration"
 require "carthage_cache/configurator"
 require "carthage_cache/configurator_wizard"
 require "carthage_cache/shell_command_executor.rb"
 require "carthage_cache/application.rb"
 require "carthage_cache/swift_version_resolver.rb"
+require "carthage_cache/build_collector.rb"
 
 module CarthageCache
 

data/lib/carthage_cache/application.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module CarthageCache
 
   class Application
@@ -13,7 +15,7 @@ module CarthageCache
     def initialize(project_path, verbose, config, repository: Repository, terminal: Terminal, swift_version_resolver: SwiftVersionResolver)
       @terminal = terminal.new(verbose)
       @archiver = Archiver.new
-      @config = Configurator.new(project_path, config).config
+      @config = Configurator.new(@terminal, project_path, config).config
       @repository = repository.new(@config.bucket_name, @config.hash_object[:aws_s3_client_options])
       @project = Project.new(project_path, CACHE_DIR_NAME, @terminal, @config.tmpdir, swift_version_resolver.new)
     end
@@ -32,8 +34,22 @@ module CarthageCache
       end
     end
 
-    def create_archive(force = false)
-      archive_builder.build if force || !archive_exist?
+    def create_archive(force = false, prune = false, prune_white_list = nil)
+      if force || !archive_exist?
+        prune_build_directory(prune_white_list) if prune
+        archive_builder.build
+      end
+    end
+
+    def prune_build_directory(white_list)
+      if white_list && File.exist?(white_list)
+        terminal.vputs "Prunning build directory with white list '#{white_list}' ..."
+        white_list = YAML.load(File.read(white_list))
+      else
+        white_list = {}
+        terminal.vputs "Prunning build directory ..."
+      end
+      build_collector.delete_unused_frameworks(white_list)
     end
 
     private
@@ -46,6 +62,10 @@ module CarthageCache
         @archive_builder ||= ArchiveBuilder.new(terminal, repository, archiver, project)
       end
 
+      def build_collector
+        @build_collector ||= BuildCollector.new(terminal, project.carthage_build_directory, project.all_frameworks)
+      end
+
   end
 
 end

data/lib/carthage_cache/build_collector.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+
+module CarthageCache
+
+  class BuildCollector
+
+    attr_reader :terminal
+    attr_reader :build_directory
+    attr_reader :required_frameworks
+
+    def initialize(terminal, build_directory, required_frameworks)
+      @terminal = terminal
+      @build_directory = build_directory
+      @required_frameworks = Set.new(required_frameworks)
+    end
+
+    def delete_unused_frameworks(white_list = {})
+      terminal.vputs "Deleting unused frameworks from '#{build_directory}' ..."
+      list_built_frameworks.each do |framework_path|
+        if delete_framework?(framework_path, white_list)
+          terminal.vputs "Deleting '#{framework_path}' because is not longer needed."
+          FileUtils.rm_r(framework_path)
+          FileUtils.rm_r("#{framework_path}.dSYM")
+          # TODO delete corresponding .bcsymbolmap file
+        end
+      end
+    end
+
+    private
+
+      def delete_framework?(framework_path, white_list)
+        framework = framework_name(framework_path)
+        if required_frameworks.include?(white_list[framework])
+          false
+        else
+          ! required_frameworks.include?(framework)
+        end
+      end
+
+      def list_built_frameworks
+        Dir[File.join(build_directory, "/**/*.framework")]
+      end
+
+      def framework_name(framework_path)
+        Pathname.new(framework_path).basename(".framework").to_s
+      end
+
+  end
+
+end

data/lib/carthage_cache/carthage_resolved_file.rb

@@ -5,14 +5,17 @@ module CarthageCache
   class CartfileResolvedFile
 
     attr_reader :file_path
+    attr_reader :terminal
+    attr_reader :swift_version_resolver
 
-    def initialize(file_path, swift_version_resolver = SwiftVersionResolver.new)
+    def initialize(file_path, terminal, swift_version_resolver = SwiftVersionResolver.new)
       @file_path = file_path
       @swift_version_resolver = swift_version_resolver
+      @terminal = terminal
     end
 
     def digest
-      @digest ||= Digest::SHA256.hexdigest(content + "#{swift_version}")
+      @digest ||= generate_digest
     end
 
     def content
@@ -20,9 +23,27 @@ module CarthageCache
     end
 
     def swift_version
-      @swift_version ||= @swift_version_resolver.swift_version
+      @swift_version ||= swift_version_resolver.swift_version
     end
 
+    def frameworks
+      @frameworks ||= content.each_line.map { |line| extract_framework_name(line) }
+    end
+
+    private
+
+      def generate_digest
+        terminal.vputs "Generating carthage_cache archive digest using swift version '#{swift_version}' and " \
+                      "the content of '#{file_path}'"
+        generated_digest = Digest::SHA256.hexdigest(content + "#{swift_version}")
+        terminal.vputs "Generated digest: #{generated_digest}"
+        generated_digest
+      end
+
+      def extract_framework_name(cartfile_line)
+        cartfile_line.split(" ")[1].split("/").last.gsub('"', "")
+      end
+
   end
 
 end

data/lib/carthage_cache/configuration.rb

@@ -13,17 +13,11 @@ module CarthageCache
     end
 
     def self.valid?(config)
-      config[:bucket_name]                                &&
-      config.has_key?(:aws_s3_client_options)             &&
-      config[:aws_s3_client_options][:region]             &&
-      config[:aws_s3_client_options][:access_key_id]      &&
-      config[:aws_s3_client_options][:secret_access_key]
+      ConfigurationValidator.new(config).valid?
     end
 
     def self.parse(str)
-      config = YAML.load(str)
-      raise "Invalid configuration" unless valid?(config)
-      new(config)
+      new(YAML.load(str))
     end
 
     def self.default
@@ -54,7 +48,7 @@ module CarthageCache
     end
 
     def valid?
-      self.class.valid?(hash_object)
+      self.class.valid?(self)
     end
 
     def merge(c)

data/lib/carthage_cache/configuration_validator.rb

@@ -0,0 +1,116 @@
+module CarthageCache
+
+  class MissingConfigurationKey < Struct.new(:keyname, :solution)
+
+    def self.missing_bucket_name
+      solution =  "You need to specify the AWS S3 bucket to be used.\n" \
+                  "You can either pass the '--bucket-name' option or "  \
+                  " add ':bucket_name: YOUR_BUCKET_NAME' to "           \
+                  ".carthage_cache.yml file.\nYou can also run "        \
+                  "'carthage_cache config' to generate the config file."
+      self.new(:bucket_name, solution)
+    end
+
+    def self.missing_aws_key(keyname, name)
+      solution =  "You need to specify the AWS #{name} to be used.\n"     \
+                  "You can either define a enviromental variable "        \
+                  "AWS_REGION or add ':#{keyname}: YOUR_KEY_VALUE' "      \
+                  "under the :aws_s3_client_options: key in the "         \
+                  ".carthage_cache.yml file.\nYou can also run "          \
+                  "'carthage_cache config' to generate the config file."
+      self.new("aws_s3_client_options.#{keyname}", solution)
+    end
+
+    def self.missing_aws_region
+      missing_aws_key("region", "region")
+    end
+
+    def self.missing_aws_access_key_id
+      missing_aws_key("access_key_id", "access key ID")
+    end
+
+    def self.missing_aws_secret_access_key
+      missing_aws_key("secret_access_key", "secret access key")
+    end
+
+  end
+
+  class ValidationResult
+
+    def self.valid
+      self.new(nil)
+    end
+
+    def self.invalid(error)
+      self.new(error)
+    end
+
+    attr_reader :error
+
+    def initialize(error)
+      @error = error
+    end
+
+    def valid?
+      @error == nil
+    end
+
+  end
+
+  class ConfigurationValidator
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def valid?
+      validate.valid?
+    end
+
+    def validate
+      return missing_bucket_name unless has_bucket_name?
+      return missing_aws_region unless has_aws_region?
+      return missing_aws_access_key_id unless has_aws_access_key_id?
+      return missing_aws_secret_access_key unless has_aws_secret_access_key?
+      ValidationResult.valid
+    end
+
+    private
+
+      def has_bucket_name?
+        config.bucket_name
+      end
+
+      def has_aws_region?
+        config.aws_region
+      end
+
+      def has_aws_access_key_id?
+        config.aws_access_key_id
+      end
+
+      def has_aws_secret_access_key?
+        config.aws_secret_access_key
+      end
+
+      def missing_bucket_name
+        ValidationResult.invalid(MissingConfigurationKey.missing_bucket_name)
+      end
+
+      def missing_aws_region
+        ValidationResult.invalid(MissingConfigurationKey.missing_aws_region)
+      end
+
+      def missing_aws_access_key_id
+        ValidationResult.invalid(MissingConfigurationKey.missing_aws_access_key_id)
+      end
+
+      def missing_aws_secret_access_key
+        ValidationResult.invalid(MissingConfigurationKey.missing_aws_secret_access_key)
+      end
+
+  end
+
+end

data/lib/carthage_cache/configurator.rb

@@ -8,14 +8,16 @@ module CarthageCache
 
     attr_reader :config_file_path
     attr_reader :base_config
+    attr_reader :terminal
 
-    def initialize(project_path, base_config = {})
+    def initialize(terminal, project_path, base_config = {})
       @config_file_path = File.join(project_path, CONFIG_FILE_NAME)
       @base_config = merge_config(base_config)
+      @terminal = terminal
     end
 
     def config
-      @config ||= load_config
+      @config ||= load_config!
     end
 
     def save_config(config)
@@ -29,15 +31,30 @@ module CarthageCache
         File.exist?(config_file_path)
       end
 
+      def load_config!
+        config = load_config
+        validate!(config)
+        config
+      end
+
       def load_config
         if config_file_exist?
           config = Configuration.parse(File.read(config_file_path))
-          config.merge(base_config)
+          config = config.merge(base_config)
         else
           base_config
         end
       end
 
+      def validate!(config)
+        validator = ConfigurationValidator.new(config)
+        result = validator.validate
+        unless result.valid?
+          terminal.error "error: #{result.error.solution}"
+          exit 1
+        end
+      end
+
       def remove_nil_keys(hash)
         hash.inject({}) do |new_hash, (k,v)|
           unless v.nil? || (v.respond_to?(:empty?) && v.empty?)

data/lib/carthage_cache/project.rb

@@ -13,7 +13,7 @@ module CarthageCache
       @cache_dir_name = cache_dir_name
       @terminal = terminal
       @tmpdir_base_path = tmpdir
-      @cartfile = CartfileResolvedFile.new(cartfile_resolved_path, swift_version_resolver)
+      @cartfile = CartfileResolvedFile.new(cartfile_resolved_path, terminal, swift_version_resolver)
     end
 
     def archive_filename
@@ -32,6 +32,10 @@ module CarthageCache
       @carthage_build_directory ||= File.join(project_path, "Carthage", "Build")
     end
 
+    def all_frameworks
+      cartfile.frameworks
+    end
+
     private
 
       def cartfile_resolved_path

data/lib/carthage_cache/terminal.rb

@@ -16,6 +16,10 @@ module CarthageCache
       puts(message) if verbose
     end
 
+    def error(message)
+      STDERR.puts(message)
+    end
+
   end
 
 end

data/lib/carthage_cache/version.rb

@@ -1,3 +1,3 @@
 module CarthageCache
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carthage_cache
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Guido Marucci Blas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-26 00:00:00.000000000 Z
+date: 2016-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,8 +137,10 @@ files:
 - lib/carthage_cache/archive_builder.rb
 - lib/carthage_cache/archive_installer.rb
 - lib/carthage_cache/archiver.rb
+- lib/carthage_cache/build_collector.rb
 - lib/carthage_cache/carthage_resolved_file.rb
 - lib/carthage_cache/configuration.rb
+- lib/carthage_cache/configuration_validator.rb
 - lib/carthage_cache/configurator.rb
 - lib/carthage_cache/configurator_wizard.rb
 - lib/carthage_cache/description.rb