xcode-archive-cache 0.0.6

data/lib/command/command.rb

@@ -0,0 +1,45 @@
+module XcodeArchiveCache
+  class Command < CLAide::Command
+
+    include XcodeArchiveCache::Logs
+
+    self.abstract_command = true
+    self.command = "xcode-archive-cache"
+    self.description = "XcodeArchiveCache, cache for Xcode archive action"
+
+    def self.options
+      [
+          ["--log-level=[nothing|info|verbose]", "Level of log verbosity, defaults to info"]
+      ].concat(super.reject { |(name, _)| name != "--help" })
+    end
+
+    def self.run(argv)
+      help! "You cannot run XcodeArchiveCache as root." if Process.uid == 0 && !Gem.win_platform?
+
+      super(argv)
+    end
+
+    def initialize(argv)
+      super
+      log_level = argv.option("log-level", "info")
+      set_log_level(log_level)
+    end
+  end
+
+  def self.report_error(exception)
+    case exception
+    when Interrupt
+      info("Cancelled")
+      exit 1
+    when SystemExit
+      raise
+    else
+      if ENV["XCODE_ARCHIVE_CACHE_ENV"] != "development"
+        error(exception.message)
+        exit 1
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/command/inject.rb

@@ -0,0 +1,52 @@
+module XcodeArchiveCache
+  class Command
+    class Inject < Command
+
+      include XcodeArchiveCache::Logs
+
+      self.description = "Setup workspace or project for being built using cached dependencies"
+
+      def self.options
+        [
+            ["--cachefile=/path/to/Cachefile", "Explicit Cachefile location, defaults to $PWD/Cachefile"],
+            ["--configuration", "Name of configuration from Cachefile, required"],
+            ["--destination=[<full destination specifier>|generic]", "xcodebuild-style destination. Defaults to 'generic', ignored for archive action"],
+            ["--storage=/path/to/storage", "Storage dir path, required"]
+        ].concat(super)
+      end
+
+      DEFAULT_CACHEFILE = "Cachefile"
+
+      def initialize(argv)
+        super
+
+        @configuration_name = argv.option("configuration")
+        if @configuration_name == nil
+          error("configuration is required")
+          exit 1
+        end
+
+        @storage = argv.option("storage")
+        if @storage == nil
+          error("storage parameter is required")
+          exit 1
+        end
+
+        @cachefile_path = argv.option("cachefile", DEFAULT_CACHEFILE)
+        @destination = argv.option("destination", XcodeArchiveCache::Xcodebuild::GENERIC_DESTINATION)
+      end
+
+      def run
+        config = XcodeArchiveCache::Config.from_file(@cachefile_path).entry
+        config.settings.destination = @destination
+        config.active_configuration_name = @configuration_name
+        config.storage.type = :local
+        config.storage.path = @storage
+
+        debug(config)
+
+        XcodeArchiveCache::Runner.new(config).run
+      end
+    end
+  end
+end

data/lib/config/config.rb

@@ -0,0 +1,211 @@
+module XcodeArchiveCache
+  class Config
+
+    include XcodeArchiveCache::Config::DSL
+
+    class Entry
+
+      # @return [String]
+      #
+      attr_reader :name
+
+      # @return [Array<Configuration>]
+      #
+      attr_reader :configurations
+
+      # @return [String]
+      #
+      attr_accessor :active_configuration_name
+
+      # @return [Array<Target>]
+      #
+      attr_reader :targets
+
+      # @return [Settings]
+      #
+      attr_reader :settings
+
+      # @return [Storage]
+      #
+      attr_reader :storage
+
+      def initialize(name)
+        @name = name
+        @configurations = []
+        @active_configuration_name = nil
+        @settings = Settings.new
+        @storage = Storage.new
+        @targets = []
+        @file_extname = ""
+      end
+
+      # @return [String]
+      #
+      def file_path
+        return name if File.extname(name) == file_extname
+
+        name + file_extname
+      end
+
+      # @return [Configuration]
+      #
+      def active_configuration
+        configuration = configurations.select{|config| config.name == active_configuration_name }.first
+        if configuration == nil
+          raise Informative, "Found no configuration with name \"#{active_configuration_name}\""
+        end
+
+        configuration
+      end
+
+      def to_s
+        "path: #{file_path}\nactive configuration: #{active_configuration_name}\nconfigurations:\n\t#{configurations.join("\n\t")}\n#{settings}\nstorage: #{storage}\ntargets:\n\t#{targets.join("\n\t")}"
+      end
+
+      private
+
+      # @return [String]
+      #
+      attr_reader :file_extname
+    end
+
+    class Workspace < Entry
+      def initialize(path)
+        super(path)
+        @file_extname = ".xcworkspace"
+      end
+    end
+
+    class Project < Entry
+      def initialize(path)
+        super(path)
+        @file_extname = ".xcodeproj"
+      end
+    end
+
+    class Configuration
+      # @return [String]
+      #
+      attr_reader :name
+
+      # @return [String]
+      #
+      attr_accessor :build_configuration
+
+      # @return [String]
+      #
+      attr_accessor :action
+
+      # @return [String]
+      #
+      attr_accessor :xcodebuild_args
+
+      # @param [String] name
+      #
+      def initialize(name)
+        @name = name
+        @action = "archive"
+      end
+
+      def to_s
+        "#{name}, build configuration: #{build_configuration}, action: #{action}, xcodebuild args: \"#{xcodebuild_args}\""
+      end
+    end
+
+    class Settings
+      # @return [String]
+      #
+      attr_accessor :derived_data_path
+
+      # @return [String]
+      #
+      attr_accessor :destination
+
+      def to_s
+        "destination: #{destination}, derived data path: #{derived_data_path}"
+      end
+    end
+
+    class Storage
+
+      # @return [Symbol]
+      #
+      attr_accessor :type
+
+      # @return [String]
+      #
+      attr_accessor :path
+
+      def to_s
+        "#{type}, path: #{path}"
+      end
+    end
+
+    class Target
+
+      # @return [String]
+      #
+      attr_reader :name
+
+      # @return [Array<String>]
+      #
+      attr_reader :dependencies
+
+      # @param [String] name
+      #
+      def initialize(name)
+        @name = name
+        @dependencies = []
+      end
+
+      def to_s
+        "#{name}, dependencies: #{dependencies.join(", ")}"
+      end
+    end
+
+    # @param [String] path
+    #
+    def self.from_file(path)
+      contents = File.open(path, "r:utf-8", &:read)
+
+      config = Config.new do
+        begin
+          eval(contents, nil, path)
+        rescue Exception => e
+          raise Informative, "Invalid #{File.basename(path)} file: #{e.message}"
+        end
+      end
+
+      config
+    end
+
+    # @return [Entry]
+    #
+    attr_reader :entry
+
+    def initialize(&block)
+      @entry = nil
+      @current_target = nil
+
+      if block
+        instance_eval(&block)
+      end
+    end
+
+    private
+
+    attr_writer :entry
+
+    # @return [Configuration]
+    #
+    def current_configuration
+      entry.configurations.last
+    end
+
+    # @return [Target]
+    #
+    def current_target
+      entry.targets.last
+    end
+  end
+end

data/lib/config/dsl.rb

@@ -0,0 +1,69 @@
+module XcodeArchiveCache
+  class Config
+    module DSL
+
+      # @param [String] name
+      #
+      def workspace(name)
+        self.entry = Workspace.new(name)
+
+        yield
+      end
+
+      # @param [String] name
+      #
+      def project(name)
+        self.entry = Project.new(name)
+
+        yield
+      end
+
+      # @param [String] name
+      #
+      def configuration(name)
+        entry.configurations.push(Configuration.new(name))
+
+        yield
+      end
+
+      # @param [String] name
+      #
+      def build_configuration(name)
+        current_configuration.build_configuration = name
+      end
+
+      # @param [String] name
+      #
+      def action(name)
+        current_configuration.action = name
+      end
+
+      # @param [String] args
+      #
+      def xcodebuild_args(args)
+        current_configuration.xcodebuild_args = args
+      end
+
+      # @param [String] path
+      #
+      def derived_data_path(path)
+        entry.settings.derived_data_path = path
+      end
+
+      # @return [String]
+      #
+      def target(name)
+        target = Target.new(name)
+        entry.targets.push(target)
+
+        yield
+      end
+
+      # @param [String] name
+      #
+      def cache(name)
+        current_target.dependencies.push(name)
+      end
+    end
+  end
+end

data/lib/injection/build_flags_changer.rb

@@ -0,0 +1,172 @@
+module XcodeArchiveCache
+  module Injection
+    class BuildFlagsChanger
+
+      include XcodeArchiveCache::Logs
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] path
+      #
+      def add_framework_search_path(build_configuration, path)
+        debug("using framework search path #{path}")
+        add_flag_to_configuration(build_configuration, FRAMEWORK_SEARCH_PATHS_KEY, path_to_search_path(path))
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [XcodeArchiveCache::BuildGraph::Node] node
+      #
+      def add_framework_linker_flag(build_configuration, node)
+        linker_flag = get_framework_linker_flag(node)
+        if linker_flag
+          debug("using linker flag #{linker_flag}")
+          add_linker_flag(build_configuration, linker_flag)
+        end
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [XcodeArchiveCache::BuildGraph::Node] node
+      #
+      def add_framework_headers_iquote(build_configuration, artifact_location, node)
+        headers_search_path = get_framework_headers_iquote(artifact_location, node)
+        debug("using -iquote path #{headers_search_path}")
+        add_cflag(build_configuration, headers_search_path)
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] path
+      #
+      def add_library_search_path(build_configuration, path)
+        debug("using library search path #{path}")
+        add_flag_to_configuration(build_configuration, LIBRARY_SEARCH_PATHS_KEY, path_to_search_path(path))
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] path
+      #
+      def add_headers_search_path(build_configuration, path)
+        debug("using headers search path #{path}")
+        add_flag_to_configuration(build_configuration, HEADER_SEARCH_PATHS_KEY, path)
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] path
+      #
+      def add_iquote_path(build_configuration, path)
+        debug("using -iquote path #{path}")
+        add_cflag(build_configuration, path_to_iquote(path))
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] path
+      #
+      def add_capital_i_path(build_configuration, path)
+        debug("using -I path #{path}")
+        add_cflag(build_configuration, path_to_capital_i(path))
+      end
+
+      private
+
+      FRAMEWORK_SEARCH_PATHS_KEY = "FRAMEWORK_SEARCH_PATHS"
+      LIBRARY_SEARCH_PATHS_KEY = "LIBRARY_SEARCH_PATHS"
+      HEADER_SEARCH_PATHS_KEY = "HEADER_SEARCH_PATHS"
+      OTHER_CFLAGS_KEY = "OTHER_CFLAGS"
+      OTHER_LDFLAGS_KEY = "OTHER_LDFLAGS"
+      INHERITED_SETTINGS_VALUE = "$(inherited)"
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] flag
+      #
+      def add_linker_flag(build_configuration, flag)
+        add_flag_to_configuration(build_configuration, OTHER_LDFLAGS_KEY, flag)
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] flag
+      #
+      def add_cflag(build_configuration, flag)
+        add_flag_to_configuration(build_configuration, OTHER_CFLAGS_KEY, flag)
+      end
+
+      # @param [Xcodeproj::Project::Object::XCBuildConfiguration] build_configuration
+      # @param [String] key
+      # @param [String] flag
+      #
+      def add_flag_to_configuration(build_configuration, key, flag)
+        flags = build_configuration.build_settings[key]
+        build_configuration.build_settings[key] = add_flag(flags, flag)
+      end
+
+      # @param [Object] flags
+      # @param [String] new_flag
+      #
+      # @return [Array<String>]
+      #
+      def add_flag(flags, new_flag)
+        if flags && flags.length > 0
+          if flags.is_a?(String)
+            flags = [flags, new_flag]
+          elsif flags.is_a?(Array)
+            flags += [new_flag] unless flags.include?(new_flag)
+          else
+            raise StandardError.new, "Flags value is neither string nor array: #{flags.class}"
+          end
+        else
+          flags = [INHERITED_SETTINGS_VALUE, new_flag]
+        end
+
+        flags
+      end
+
+      # @param [String] path
+      #
+      # @return [String]
+      #
+      def path_to_search_path(path)
+        "\"#{path}\""
+      end
+
+      # @param [String] path
+      # @param [XcodeArchiveCache::BuildGraph::Node] node
+      #
+      # @return [String]
+      #
+      def get_framework_headers_iquote(path, node)
+        if node.has_framework_product?
+          headers_dir_path = File.join(path, node.product_file_name, "Headers")
+          path_to_iquote(headers_dir_path)
+        end
+      end
+
+      # @param [String] path
+      #
+      # @return [String]
+      #
+      def path_to_iquote(path)
+        "-iquote \"#{path}\""
+      end
+
+      # @param [String] path
+      #
+      # @return [Stirng]
+      #
+      def path_to_capital_i(path)
+        "-I\"#{path}\""
+      end
+
+      # @param [XcodeArchiveCache::BuildGraph::Node] node
+      #
+      # @return [String]
+      #
+      #         Something.framework -> -framework "Something"
+      #
+      def get_framework_linker_flag(node)
+        return unless node.product_file_name
+
+        framework_name = File.basename(node.product_file_name, File.extname(node.product_file_name))
+        return unless framework_name
+
+        "-framework \"#{framework_name}\""
+      end
+    end
+  end
+end