carthage_cashier 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28ecf601ee72f1477eced0f62bc4ada244bf85a
-  data.tar.gz: 0ce49e5f6440b1feecc67f6485221a8bf0538d9c
+  metadata.gz: 8827764212bba9febafddd439bd221fb593ac5ed
+  data.tar.gz: a44684d6bb2b1c1b5ed9e58b7898d1ac6ed15601
 SHA512:
-  metadata.gz: a34ad9159b8afd4372beb4925f60aaea0fa2374d42bb7cfdade058adb751f3069d9a964fe72f018b7c5929bbaa836e4e48c5aa8e07f79f3f6ab46afe8f40ec13
-  data.tar.gz: 662c3749f68d7718950e9865b2e806ba05b6fdca68f04747427665c086dc19d494975260aadf86a319e184206dee3b912e38d1c635a6e40d6fb2214e348e64b5
+  metadata.gz: 37aec97ed49bf9d6092e2f33582b040db4b20e7f8f29e2c24864a321991b2971668cbe82cc144c52c58c2318a7b37913455b822f8f06828ee864ad1460832ed4
+  data.tar.gz: 5721a04bf2b20b9988b548b09a241f8181c016c6bc0736edfbe0a56fae5d9bb40991fc13856ba04ec557329dd355fb8f3e35bf9a61cd544447e040b119cc95ec

data/bin/carthage_cashier

@@ -1,4 +1,38 @@
 #!/usr/bin/env ruby
-
 require 'carthage_cashier'
-CarthageCashier.run ARGV
+
+# Create and parse configuration
+configuration = CarthageCashier::Configuration.new
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: carthage_cashier [OPTIONS]"
+  opts.separator ""
+  opts.separator "Uses cache to load appropriate dependencies. If cached version of the current version is not available,"
+  opts.separator "bootstraps it and saves back to cache for further use. Also takes into account compiler version."
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-c", "--[no-]clean", "This option will clean (delete) all cached files for all projects before bootstrapping.") do |v|
+    configuration.clean = v
+  end
+
+  opts.on("-w", "--[no-]whole", "Uses MD5 of Cartfile.resolved to check cache and restores the whole image of the folder if available.") do |v|
+    configuration.whole_mode = v
+  end
+
+  opts.on("-f", "--[no-]force", "Force bootstrap dependencies without using cached versions and save the built products to cache.") do |v|
+    configuration.force_mode = v
+  end
+
+  opts.on("-d", "--root-directory DIRECTORY", "Force bootstrap dependencies without using cached versions and save the built products to cache.") do |dir|
+    configuration.root_directory = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+CarthageCashier.run configuration

data/lib/carthage_cashier/version.rb

@@ -1,3 +1,3 @@
 module CarthageCashier
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/carthage_cashier.rb

@@ -21,232 +21,229 @@ module CarthageCashier
     ALL = [IOS, TVOS, OSX, WATCHOS]
   end
 
-  # Parse args
-  OPTIONS = {}
-
-  def self.setup_opts_parser()
-    opts_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: carthage_cache.rb [OPTIONS] project_root"
-      opts.separator ""
-      opts.separator "Uses cache to load appropriate dependencies. If cached version of the current version is not available,"
-      opts.separator "bootstraps it and saves back to cache for further use. Also takes into account compiler version."
-      opts.separator ""
-      opts.separator "Specific options:"
-
-      opts.on("-c", "--[no-]clean", "This option will clean (delete) all cached files for all projects.") do |v|
-        OPTIONS[:clean] = v
-      end
+  # Platforms is unused for now
+  Configuration = Struct.new(:clean, :whole_mode, :force_mode, :platforms, :root_directory)
 
-      opts.on("-w", "--[no-]whole", "Uses MD5 of Cartfile.resolved to check cache and restores the whole image of the folder if available. (worse)") do |v|
-        OPTIONS[:whole] = v
-      end
+  class Cashier
 
-      opts.on("-f", "--[no-]force", "Force bootstrap dependencies without using cached versions and save the built products to cache.") do |v|
-        OPTIONS[:force] = v
-      end
+    @config = Configuration.new
 
-      opts.on_tail("-h", "--help", "Show this message") do
-        puts opts
-        exit
-      end
+    def initialize(config)
+      raise "Error: parameter has to be a configuration struct." unless config.is_a? Configuration
+      self.class.config = config
+      self.clean_caches if config.clean == true
     end
 
-    return opts_parser
-  end
+    def self.config
+      @config
+    end
+
+    def config
+      self.class.config
+    end
 
-  def self.get_cache_paths()
-    base_path = "#{CARTHAGE_CACHE_DIR}/#{COMPILER_VER}"
-    paths = {}
+    def self.config=(value)
+      @config = value
+    end
 
-    if OPTIONS[:whole]
-      paths["WHOLE"] = "#{base_path}/whole"
-    else
-      Platform::ALL.each do |platform|
-          paths[platform] = "#{base_path}/intelligent/#{platform}"
+    def clean_caches()
+      puts "Cleaning all cached files."
+      FileUtils.rm_rf(CARTHAGE_CACHE_DIR)
+    end
+
+    def get_cache_paths()
+      base_path = "#{CARTHAGE_CACHE_DIR}/#{COMPILER_VER}"
+      paths = {}
+
+      if config.whole_mode == true
+        paths["WHOLE"] = "#{base_path}/whole"
+      else
+        Platform::ALL.each do |platform|
+            paths[platform] = "#{base_path}/intelligent/#{platform}"
+        end
       end
+
+      return paths
     end
 
-    return paths
-  end
+    # Gets the names and hashes from resolved cartfile
+    def parse_resolved_cartfile(path)
+      dependencies = {}
 
-  # Gets the names and hashes from resolved cartfile
-  def self.parse_resolved_cartfile(path)
-    dependencies = {}
+      # Open file and read line by line
+      File.open(path) do |file|
+        file.each_line do |line|
 
-    # Open file and read line by line
-    File.open(path) do |file|
-      file.each_line do |line|
+          # Run regex on line
+          result = /^git(?>hub)? ".*(?<=\/)([^"]*)" "(.*)"$/.match(line)
 
-        # Run regex on line
-        result = /^git(?>hub)? ".*(?<=\/)([^"]*)" "(.*)"$/.match(line)
+          # If we found match (0) and name capture group (1) and hash/version capture group (2)
+          if !result.nil? && result.length == 3
+            dependencies[result[2]] = result[1].chomp('.git')
+          end
 
-        # If we found match (0) and name capture group (1) and hash/version capture group (2)
-        if !result.nil? && result.length == 3
-          dependencies[result[2]] = result[1].chomp('.git')
         end
-
       end
+
+      return dependencies
     end
 
-    return dependencies
-  end
+    def find_xcodeproj_files()
+      projects = XcodeProject::Project.find("Carthage/Checkouts/**")
 
-  def self.find_xcodeproj_files()
-    projects = XcodeProject::Project.find("Carthage/Checkouts/**")
+      # Filter out example, test projects
+      projects.each do |p|
+        projects.delete p unless /[Dd]emo$|[Ee]xample$|[Tt]est[s]*$/.match(p.name).nil?
+      end
 
-    # Filter out example, test projects
-    projects.each do |p|
-      projects.delete p unless /[Dd]emo$|[Ee]xample$|[Tt]est[s]*$/.match(p.name).nil?
+      return projects
     end
 
-    return projects
-  end
+    def parse_product_name_mappings(xcodeproj_files, dependencies)
+      names = {}
 
-  def self.parse_product_name_mappings(xcodeproj_files, dependencies)
-    names = {}
+      xcodeproj_files.each do |xp|
+        data = xp.read
 
-    xcodeproj_files.each do |xp|
-      data = xp.read
+        next unless data.targets.first.config("Release").build_settings["DEFINES_MODULE"]
+        product_name = data.targets.first.config("Release").build_settings["PRODUCT_NAME"]
 
-      next unless data.targets.first.config("Release").build_settings["DEFINES_MODULE"]
-      product_name = data.targets.first.config("Release").build_settings["PRODUCT_NAME"]
+        # If the proj is using target name
+        if product_name == "$(TARGET_NAME)"
+          product_name = data.targets.first.name
+        end
 
-      # If the proj is using target name
-      if product_name == "$(TARGET_NAME)"
-        product_name = data.targets.first.name
-      end
+        key = nil
+        file_path = xp.file_path.to_s
+        dependencies.values.each do |name|
+          next unless file_path.include? name
+          key = name
+          break
+        end
 
-      key = nil
-      file_path = xp.file_path.to_s
-      dependencies.values.each do |name|
-        next unless file_path.include? name
-        key = name
-        break
+        next unless key.nil? == false
+        names[key] = product_name unless names.values.include?(product_name)
       end
 
-      next unless key.nil? == false
-      names[key] = product_name unless names.values.include?(product_name)
+      return names
     end
 
-    return names
-  end
-
-  def self.cache_built_dependencies(dependencies)
-    puts("Caching built dependencies.")
+    def cache_built_dependencies(dependencies)
+      puts("Caching built dependencies.")
 
-    cache_paths = get_cache_paths
+      cache_paths = get_cache_paths
 
-    if OPTIONS[:whole] == true
-        cache_path = "#{cache_paths.values.first}/#{Digest::MD5.file CARTHAGE_RESOLVED_FILE}/"
+      if config.whole_mode == true
+          cache_path = "#{cache_paths.values.first}/#{Digest::MD5.file CARTHAGE_RESOLVED_FILE}/"
 
-        # Get target dir
-        src_dir = Dir.getwd + "/Carthage/Build/"
+          # Get target dir
+          src_dir = Dir.getwd + "/Carthage/Build/"
 
-        # Create the target dir if needed and copy files
-        FileUtils.mkdir_p cache_path unless File.exists? cache_path
-        FileUtils.cp_r Dir["#{src_dir}/*"], cache_path
-    else
-      xcodeproj_files = find_xcodeproj_files
-      products_name_mapping = parse_product_name_mappings xcodeproj_files, dependencies
+          # Create the target dir if needed and copy files
+          FileUtils.mkdir_p cache_path unless File.exists? cache_path
+          FileUtils.cp_r Dir["#{src_dir}/*"], cache_path
+      else
+        xcodeproj_files = find_xcodeproj_files
+        products_name_mapping = parse_product_name_mappings xcodeproj_files, dependencies
 
-      dependencies.each do |d_ver, d_name|
-        next unless products_name_mapping.keys.include?(d_name)
-        product_name = products_name_mapping[d_name]
+        dependencies.each do |d_ver, d_name|
+          next unless products_name_mapping.keys.include?(d_name)
+          product_name = products_name_mapping[d_name]
 
-        get_cache_paths.each do |platform, path|
-          target_dir = "#{path}/#{d_name}/#{d_ver}"
-          src_dir = "Carthage/Build/#{platform}"
-          fmwk_path = "#{src_dir}/#{product_name}.framework"
+          get_cache_paths.each do |platform, path|
+            target_dir = "#{path}/#{d_name}/#{d_ver}"
+            src_dir = "Carthage/Build/#{platform}"
+            fmwk_path = "#{src_dir}/#{product_name}.framework"
 
-          next unless fmwk_path.empty? == false
-          next unless Dir.exist? src_dir
+            next unless fmwk_path.empty? == false
+            next unless Dir.exist? src_dir
 
-          # Create the target dir if needed and copy files
-          if File.exists? target_dir
-            FileUtils.rm_rf target_dir
+            # Create the target dir if needed and copy files
+            if File.exists? target_dir
+              FileUtils.rm_rf target_dir
+            end
+            FileUtils.mkdir_p target_dir
+            FileUtils.cp_r fmwk_path, target_dir
+            FileUtils.cp_r "#{fmwk_path}.dSYM", target_dir
           end
-          FileUtils.mkdir_p target_dir
-          FileUtils.cp_r fmwk_path, target_dir
-          FileUtils.cp_r "#{fmwk_path}.dSYM", target_dir
         end
+
+        # Steps
+        # 1. Find .xcodeproj in Carthage/Checkouts after running carthage checkout
+        # 2. Parse Product Name to be able to find corresponding .framework
+        # 3. Copy that from each platform folder to cache
+        # Question: How to figure out .bcsymbolmap files? Relation to .framework? Metadata? Timestamp?
       end
 
-      # Steps
-      # 1. Find .xcodeproj in Carthage/Checkouts after running carthage checkout
-      # 2. Parse Product Name to be able to find corresponding .framework
-      # 3. Copy that from each platform folder to cache
-      # Question: How to figure out .bcsymbolmap files? Relation to .framework? Metadata? Timestamp?
     end
 
-  end
+    def copy_dependencies_from_cache(dependencies)
+      uncached = {}
+      cache_paths = get_cache_paths
 
-  def self.copy_dependencies_from_cache(dependencies)
-    uncached = {}
-    cache_paths = get_cache_paths
-
-    # Whole cache
-    if OPTIONS[:whole]
-      cache_path = "#{cache_paths.values.first}/#{Digest::MD5.file CARTHAGE_RESOLVED_FILE}/"
-      if Dir.exist? cache_path
-        found = true
+      # Whole cache
+      if config.whole_mode == true
+        cache_path = "#{cache_paths.values.first}/#{Digest::MD5.file CARTHAGE_RESOLVED_FILE}/"
+        if Dir.exist? cache_path
+          found = true
 
-        # Get target dir
-        target_dir = Dir.getwd + "/Carthage/Build"
+          # Get target dir
+          target_dir = Dir.getwd + "/Carthage/Build"
 
-        # Create the target dir if needed and copy files
-        if File.exists? target_dir
-          FileUtils.rm_rf target_dir
+          # Create the target dir if needed and copy files
+          if File.exists? target_dir
+            FileUtils.rm_rf target_dir
+          end
+          FileUtils.mkdir_p target_dir
+          FileUtils.cp_r Dir["#{cache_path}/*"], target_dir
+        else
+          uncached.replace dependencies
         end
-        FileUtils.mkdir_p target_dir
-        FileUtils.cp_r Dir["#{cache_path}/*"], target_dir
       else
-        uncached.replace dependencies
-      end
-    else
-      # Intelligent cache
-      dependencies.each do |d_ver, d_name|
-        found = false
+        # Intelligent cache
+        dependencies.each do |d_ver, d_name|
+          found = false
 
-        cache_paths.each do |platform, path|
-          dep_cache_path = "#{path}/#{d_name}/#{d_ver}"
+          cache_paths.each do |platform, path|
+            dep_cache_path = "#{path}/#{d_name}/#{d_ver}"
 
-          if Dir.exist? dep_cache_path
-            found = true
+            if Dir.exist? dep_cache_path
+              found = true
 
-            target_dir = Dir.getwd + "/Carthage/Build/#{platform}"
+              target_dir = Dir.getwd + "/Carthage/Build/#{platform}"
 
-            # Create the target dir if needed and copy files
-            FileUtils.mkdir_p target_dir unless File.exists? target_dir
-            FileUtils.cp_r Dir["#{dep_cache_path}/*"], target_dir
+              # Create the target dir if needed and copy files
+              FileUtils.mkdir_p target_dir unless File.exists? target_dir
+              FileUtils.cp_r Dir["#{dep_cache_path}/*"], target_dir
+            end
           end
-        end
 
-        # If not found, put it in uncached
-        uncached[d_ver] = d_name unless found
+          # If not found, put it in uncached
+          uncached[d_ver] = d_name unless found
+        end
       end
+
+      puts "Copied dependencies from cache: #{dependencies.values - uncached.values}"
+      return uncached
     end
 
-    puts "Copied dependencies from cache: #{dependencies.values - uncached.values}"
-    return uncached
-  end
+    def boostrap_and_cache(dependencies = {})
 
-  def self.boostrap_and_cache(dependencies = {})
+      if dependencies.count == 0
+        success = system(ENV.to_hash, "carthage bootstrap")
+      else
+        # Pass only some deps to carthage bootstrap, so we don't build everything
+        success = system(ENV.to_hash, "carthage bootstrap #{dependencies.values.join(" ")}")
+      end
 
-    if dependencies.count == 0
-      success = system("carthage bootstrap")
-    else
-      # Pass only some deps to carthage bootstrap, so we don't build everything
-      success = system("carthage bootstrap #{dependencies.values.join(" ")}")
+      # Check result and cache if appropriate
+      if success
+        cache_built_dependencies dependencies
+      else
+        raise "ERROR: Carthage bootstrap failed, can't cache built dependencies."
+      end
     end
 
-    # Check result and cache if appropriate
-    if success
-      cache_built_dependencies dependencies
-      exit 0
-    else
-      puts("ERROR: Carthage bootstrap failed, can't cache built dependencies.")
-      exit 1
-    end
   end
 
   # -----------
@@ -254,50 +251,40 @@ module CarthageCashier
   # -----------
 
 
-  def self.run(arguments = ARGV)
-    opts_parser = setup_opts_parser
-    opts_parser.parse!(arguments)
+  def self.run(configuration)
+    cashier = Cashier.new configuration
 
-    # Clean cache
-    if OPTIONS[:clean]
-      puts "Cleaning all cached files."
-      FileUtils.rm_rf(CARTHAGE_CACHE_DIR)
-      exit 0
-    end
+    # Set default path if no specified
+    configuration.root_directory = "." if configuration.root_directory.nil?
 
-    # Safety check
-    if arguments.count != 1
-      puts opts_parser.help
-      exit 1
-    end
+    # Run carthage and cache operations in specified dir
+    Dir.chdir(configuration.root_directory) do
 
-    # Change to project dir
-    Dir.chdir arguments[0]
+      # Get Cartfile.resolved
+      if File.exist?(CARTHAGE_RESOLVED_FILE) == false
+        puts("No #{CARTHAGE_RESOLVED_FILE} found in specified directory. Bootstrapping instead.")
+        cashier.boostrap_and_cache
+        return
+      end
 
-    # Get Cartfile.resolved
-    if !File.exist?(CARTHAGE_RESOLVED_FILE)
-      puts("No #{CARTHAGE_RESOLVED_FILE} found in specified directory. Bootstrapping instead.")
-      boostrap_and_cache
-    end
+      # Get dependencies
+      deps = cashier.parse_resolved_cartfile CARTHAGE_RESOLVED_FILE
 
-    # Get dependencies
-    deps = parse_resolved_cartfile CARTHAGE_RESOLVED_FILE
-
-    # Force bootstrap or try loading dependencies from cache
-    if OPTIONS[:force]
-      puts "Force bootstrapping and caching results."
-      boostrap_and_cache deps
-    else
-      remaining_deps = copy_dependencies_from_cache deps
-      if remaining_deps.count == 0
-        puts "Loaded all dependencies from cache."
-        exit 0
+      # Force bootstrap or try loading dependencies from cache
+      if configuration.force_mode == true
+        puts "Force bootstrapping and caching results."
+        cashier.boostrap_and_cache deps
+      else
+        remaining_deps = cashier.copy_dependencies_from_cache deps
+        if remaining_deps.count == 0
+          puts "Loaded all dependencies from cache."
+          return
+        end
       end
-    end
-
-    # Bootstrapping remaining dependencies
-    puts "Following dependencies not cached, bootstrapping them now: #{remaining_deps.values}"
-    boostrap_and_cache remaining_deps
 
+      # Bootstrapping remaining dependencies
+      puts "Following dependencies not cached, bootstrapping them now: #{remaining_deps.values}"
+      cashier.boostrap_and_cache remaining_deps
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carthage_cashier
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Hadl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-20 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproject
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 description: 
 email:
 - doha@nodes.dk
@@ -63,7 +49,7 @@ files:
 - bin/carthage_cashier
 - lib/carthage_cashier.rb
 - lib/carthage_cashier/version.rb
-homepage: https://www.github.com/nodes-ios/carthage_cache
+homepage: https://www.github.com/nodes-ios/carthage_cashier
 licenses:
 - MIT
 metadata: {}