xcode-install 2.6.4 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77e63eb1a9a586f24c71906f12ba305837dea1c9c8b85d2d6eff7e6316ceccc4
-  data.tar.gz: 9de18b7a27cd8aa7b35c9a2bc79d179838c376cca2320e48dd31179fd08bcacc
+  metadata.gz: f5f95c1ec6494fb1482c6862a786fd3f149327096468dbfd01886d6a320ab31f
+  data.tar.gz: ef0e89795d7a5169a97adb29467025693644db1a8805e1ae395cd76066ae2569
 SHA512:
-  metadata.gz: d39934561eb6d766229b547e723af2fcf819403c24bcb2df5ab07261115bfc76faf48a180b689c810c1404a061f1b994343808c91fdeeebb99647e20fe3d7638
-  data.tar.gz: 67c420c58617fb77a13bae2d2173612e0b25257f8740df475b0aef74e3a174157f51bf5c95eac8f6aa96d9011c0e7b9cbc90cd5c72c63ce94dab4ac5ff093968
+  metadata.gz: 4fa023f63479190d92da8f7a54d9ac0a9556eab534e4e4ea4a784f6bbd10837678910570dd9665d409214d52e47432ebafa99aaae0a9022097bde4540d42390f
+  data.tar.gz: 73c28ae14d7081a62376ce4611cae869987b8e2681325770b20d8d5f3be153abc02c7c0e3b94828c703ab786dd5960a62c6f3b097b162b82be39cf197e031d99

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: "CI"
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+
+    runs-on: macos-latest
+    steps:
+    # Setup env
+    - uses: actions/checkout@v2
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+
+    # Show env
+    - name: Show macOS version
+      run: sw_vers
+    - name: Show env versions
+      run: |
+        ruby --version
+        bundler --version
+        echo $HOME
+    
+    # Prepare
+    - name: Install bundler 2.2.14
+      run: gem install bundler -v "~> 2.2.14"
+    - name: Install ruby dependencies
+      run: |
+        bundle config --local clean 'true'
+        bundle config --local path '.vendor'
+        bundle config --local jobs 8
+        bundle config --local without 'system_tests'
+        bundle install
+
+    - name: Run test
+      run: bundle exec rake spec
+    - name: Run lint
+      run: bundle exec rake rubocop

data/.gitignore

@@ -14,3 +14,4 @@
 mkmf.log
 .DS_Store
 test
+.vendor

data/README.md

@@ -1,6 +1,6 @@
 # Xcode::Install
 
-[![Gem Version](http://img.shields.io/gem/v/xcode-install.svg?style=flat)](http://badge.fury.io/rb/xcode-install) [![CircleCI](https://circleci.com/gh/xcpretty/xcode-install.svg?style=svg)](https://circleci.com/gh/xcpretty/xcode-install)
+[![Gem Version](http://img.shields.io/gem/v/xcode-install.svg?style=flat)](http://badge.fury.io/rb/xcode-install) [![Build Status](https://github.com/xcpretty/xcode-install/actions/workflows/ci.yml/badge.svg)](https://github.com/xcpretty/xcode-install/actions)
 
 Install and update your Xcodes automatically.
 
@@ -87,6 +87,16 @@ $ xcversion list
 
 They have to be installed using the full name, e.g. `xcversion install '7 GM seed'`.
 
+#### `.xcode-version`
+
+We recommend the creation of a `.xcode-version` file to explicitly declare and store the Xcode version to be used by your CI environment as well as your team.
+
+```
+12.5
+```
+
+Read [the proposal](/XCODE_VERSION.md) of `.xcode-version`.
+
 ### Select
 
 To see the currently selected version, run
@@ -151,7 +161,7 @@ to a dialog popping up. Feel free to dupe [the radar][5]. 📡
 
 XcodeInstall normally relies on the Spotlight index to locate installed versions of Xcode. If you use it while
 indexing is happening, it might show inaccurate results and it will not be able to see installed
-versions on unindexed volumes. 
+versions on unindexed volumes.
 
 To workaround the Spotlight limitation, XcodeInstall searches `/Applications` folder to locate Xcodes when Spotlight is disabled on the machine, or when Spotlight query for Xcode does not return any results. But it still won't work if your Xcodes are not located under `/Applications` folder.
 
@@ -165,7 +175,7 @@ project, especially [@henrikhodne][6] and [@lacostej][7] for making XcodeInstall
 
 ## Contributing
 
-1. Fork it ( https://github.com/KrauseFx/xcode-install/fork )
+1. Fork it ( https://github.com/xcpretty/xcode-install/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/XCODE_VERSION.md

@@ -0,0 +1,49 @@
+# `.xcode-version`
+
+## Introduction
+
+This is a proposal for a new standard for the iOS community: a text-based file that defines the Xcode version to use to compile and package a given iOS project.
+
+This will be used by this gem, however it's designed in a way that any tool in the future can pick it up, no matter if it's Ruby based, Swift, JavaScript, etc.
+
+Similar to the [.ruby-version file](https://en.wikipedia.org/wiki/Ruby_Version_Manager), the `.xcode-version` file allows any CI system or IDE to automatically install and switch to the Xcode version needed for a given project to successfully compile your project.
+
+## Filename
+
+The filename must always be `.xcode-version`.
+
+## File location
+
+The file must be located in the same directory as your Xcode project/workspace, and you should add it to your versioning system (e.g. git).
+
+## File content
+
+The file content must be a simple string in a text file. The file may or may not end with an empty new line, this gem is responsible for stripping out the trailing `\n` (if used).
+
+### Sample files
+
+To define an official Xcode release
+
+```
+9.3
+```
+
+```
+7.2.1
+```
+
+You can also use pre-releases
+
+```
+11.5 GM Seed
+```
+
+```
+12 beta 6
+```
+
+Always following the same version naming listed by `xcversion list`.
+
+**Note**: Be aware that pre-releases might be eventually taken down from Apple's servers, meaning that it won't allow you to have fully reproducible builds as you won't be able to download the Xcode release once it's gone.
+
+It is recommended to only use non-beta releases in an `.xcode-version` file to have fully reproducible builds that you'll be able to run in a few years also.

data/lib/xcode/install.rb

@@ -25,13 +25,14 @@ module XcodeInstall
     # @param progress: parse and show the progress?
     # @param progress_block: A block that's called whenever we have an updated progress %
     #                        the parameter is a single number that's literally percent (e.g. 1, 50, 80 or 100)
-    # rubocop:disable Metrics/AbcSize
+    # @param retry_download_count: A count to retry the downloading Xcode dmg/xip
     def fetch(url: nil,
               directory: nil,
               cookies: nil,
               output: nil,
               progress: nil,
-              progress_block: nil)
+              progress_block: nil,
+              retry_download_count: 3)
       options = cookies.nil? ? [] : ['--cookie', cookies, '--cookie-jar', COOKIES_PATH]
 
       uri = URI.parse(url)
@@ -78,38 +79,8 @@ module XcodeInstall
       # "Partial file. Only a part of the file was transferred."
       # https://curl.haxx.se/mail/archive-2008-07/0098.html
       # https://github.com/KrauseFx/xcode-install/issues/210
-      3.times do
-        # Non-blocking call of Open3
-        # We're not using the block based syntax, as the bacon testing
-        # library doesn't seem to support writing tests for it
-        stdin, stdout, stderr, wait_thr = Open3.popen3(command_string)
-
-        # Poll the file and see if we're done yet
-        while wait_thr.alive?
-          sleep(0.5) # it's not critical for this to be real-time
-          next unless File.exist?(progress_log_file) # it might take longer for it to be created
-
-          progress_content = File.read(progress_log_file).split("\r").last
-
-          # Print out the progress for the CLI
-          if progress
-            print "\r#{progress_content}%"
-            $stdout.flush
-          end
-
-          # Call back the block for other processes that might be interested
-          matched = progress_content.match(/^\s*(\d+)/)
-          next unless matched && matched.length == 2
-          percent = matched[1].to_i
-          progress_block.call(percent) if progress_block
-        end
-
-        # as we're not making use of the block-based syntax
-        # we need to manually close those
-        stdin.close
-        stdout.close
-        stderr.close
-
+      retry_download_count.times do
+        wait_thr = poll_file(command_string: command_string, progress_log_file: progress_log_file, progress: progress, progress_block: progress_block)
         return wait_thr.value.success? if wait_thr.value.success?
       end
       false
@@ -117,6 +88,41 @@ module XcodeInstall
       FileUtils.rm_f(COOKIES_PATH)
       FileUtils.rm_f(progress_log_file)
     end
+
+    def poll_file(command_string:, progress_log_file:, progress: nil, progress_block: nil)
+      # Non-blocking call of Open3
+      # We're not using the block based syntax, as the bacon testing
+      # library doesn't seem to support writing tests for it
+      stdin, stdout, stderr, wait_thr = Open3.popen3(command_string)
+
+      # Poll the file and see if we're done yet
+      while wait_thr.alive?
+        sleep(0.5) # it's not critical for this to be real-time
+        next unless File.exist?(progress_log_file) # it might take longer for it to be created
+
+        progress_content = File.read(progress_log_file).split("\r").last || ''
+
+        # Print out the progress for the CLI
+        if progress
+          print "\r#{progress_content}%"
+          $stdout.flush
+        end
+
+        # Call back the block for other processes that might be interested
+        matched = progress_content.match(/^\s*(\d+)/)
+        next unless matched && matched.length == 2
+        percent = matched[1].to_i
+        progress_block.call(percent) if progress_block
+      end
+
+      # as we're not making use of the block-based syntax
+      # we need to manually close those
+      stdin.close
+      stdout.close
+      stderr.close
+
+      wait_thr
+    end
   end
 
   # rubocop:disable Metrics/ClassLength
@@ -135,7 +141,7 @@ module XcodeInstall
       File.symlink?(SYMLINK_PATH) ? SYMLINK_PATH : nil
     end
 
-    def download(version, progress, url = nil, progress_block = nil)
+    def download(version, progress, url = nil, progress_block = nil, retry_download_count = 3)
       xcode = find_xcode_version(version) if url.nil?
       return if url.nil? && xcode.nil?
 
@@ -147,7 +153,8 @@ module XcodeInstall
         cookies: url ? nil : spaceship.cookie,
         output: dmg_file,
         progress: progress,
-        progress_block: progress_block
+        progress_block: progress_block,
+        retry_download_count: retry_download_count
       )
       result ? CACHE_DIR + dmg_file : nil
     end
@@ -173,7 +180,7 @@ module XcodeInstall
       seedlist.each do |current_seed|
         return current_seed if parsed_version && current_seed.version == parsed_version
       end
-      
+
       nil
     end
 
@@ -214,7 +221,7 @@ module XcodeInstall
         current_xcode.installed = cached_installed_versions.include?(current_xcode.version)
       end
 
-      all_xcodes.sort_by(&:version)
+      all_xcodes.sort_by { |seed| [seed.version, -seed.date_modified] }.reverse
     end
 
     def install_dmg(dmg_path, suffix = '', switch = true, clean = true)
@@ -280,8 +287,8 @@ HELP
     end
 
     # rubocop:disable Metrics/ParameterLists
-    def install_version(version, switch = true, clean = true, install = true, progress = true, url = nil, show_release_notes = true, progress_block = nil)
-      dmg_path = get_dmg(version, progress, url, progress_block)
+    def install_version(version, switch = true, clean = true, install = true, progress = true, url = nil, show_release_notes = true, progress_block = nil, retry_download_count = 3)
+      dmg_path = get_dmg(version, progress, url, progress_block, retry_download_count)
       fail Informative, "Failed to download Xcode #{version}." if dmg_path.nil?
 
       if install
@@ -300,17 +307,21 @@ HELP
     end
 
     def list_annotated(xcodes_list)
-      installed = installed_versions.map(&:version)
+      installed = installed_versions.map(&:appname_version)
+
       xcodes_list.map do |x|
-        xcode_version = x.split(' ').first # exclude "beta N", "for Lion".
-        xcode_version << '.0' unless xcode_version.include?('.')
+        xcode_version = x.split(' ') # split version and "beta N", "for Lion"
+        xcode_version[0] << '.0' unless xcode_version[0].include?('.')
+
+        # to match InstalledXcode.appname_version format
+        version = Gem::Version.new(xcode_version.join('.'))
 
-        installed.include?(xcode_version) ? "#{x} (installed)" : x
+        installed.include?(version) ? "#{x} (installed)" : x
       end.join("\n")
     end
 
     def list
-      list_annotated(list_versions.sort_by(&:to_f))
+      list_annotated(list_versions.sort { |first, second| compare_versions(first, second) })
     end
 
     def rm_list_cache
@@ -366,7 +377,7 @@ HELP
       `sudo /usr/sbin/dseditgroup -o edit -t group -a staff _developer`
     end
 
-    def get_dmg(version, progress = true, url = nil, progress_block = nil)
+    def get_dmg(version, progress = true, url = nil, progress_block = nil, retry_download_count = 3)
       if url
         path = Pathname.new(url)
         return path if path.exist?
@@ -377,7 +388,7 @@ HELP
         end
       end
 
-      download(version, progress, url, progress_block)
+      download(version, progress, url, progress_block, retry_download_count)
     end
 
     def fetch_seedlist
@@ -457,6 +468,35 @@ HELP
       links
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def compare_versions(first, second)
+      # Sort by version number
+      numeric_comparation = first.to_f <=> second.to_f
+      return numeric_comparation if numeric_comparation != 0
+
+      # Return beta versions before others
+      is_first_beta = first.include?('beta')
+      is_second_beta = second.include?('beta')
+      return -1 if is_first_beta && !is_second_beta
+      return 1 if !is_first_beta && is_second_beta
+
+      # Return GM versions before others
+      is_first_gm = first.include?('GM')
+      is_second_gm = second.include?('GM')
+      return -1 if is_first_gm && !is_second_gm
+      return 1 if !is_first_gm && is_second_gm
+
+      # Return Release Candidate versions before others
+      is_first_rc = first.include?('RC') || first.include?('Release Candidate')
+      is_second_rc = second.include?('RC') || second.include?('Release Candidate')
+      return -1 if is_first_rc && !is_second_rc
+      return 1 if !is_first_rc && is_second_rc
+
+      # Sort alphabetically
+      first <=> second
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
     def hdiutil(*args)
       io = IO.popen(['hdiutil', *args])
       result = io.read
@@ -508,12 +548,13 @@ HELP
       end
     end
 
-    def download(progress, progress_block = nil)
+    def download(progress, progress_block = nil, retry_download_count = 3)
       result = Curl.new.fetch(
         url: source,
         directory: CACHE_DIR,
         progress: progress,
-        progress_block: progress_block
+        progress_block: progress_block,
+        retry_download_count: retry_download_count
       )
       result ? dmg_path : nil
     end
@@ -601,6 +642,17 @@ HELP
       @bundle_version ||= Gem::Version.new(bundle_version_string)
     end
 
+    def appname_version
+      appname = @path.basename('.app').to_s
+      version_string = appname.split('-').last
+      begin
+        Gem::Version.new(version_string)
+      rescue ArgumentError
+        puts 'Unable to determine Xcode version from path name, installed list may not correctly identify installed betas'
+        Gem::Version.new(nil)
+      end
+    end
+
     def uuid
       @uuid ||= plist_entry(':DVTPlugInCompatibilityUUID')
     end
@@ -702,7 +754,7 @@ HELP
   #
   # Sample object:
   # <XcodeInstall::Xcode:0x007fa1d451c390
-  #    @date_modified=2015,
+  #    @date_modified=1573661580,
   #    @name="6.4",
   #    @path="/Developer_Tools/Xcode_6.4/Xcode_6.4.dmg",
   #    @url=
@@ -725,7 +777,7 @@ HELP
 
     def initialize(json, url = nil, release_notes_url = nil)
       if url.nil?
-        @date_modified = json['dateModified'].to_i
+        @date_modified = DateTime.strptime(json['dateModified'], '%m/%d/%y %H:%M').strftime('%s').to_i
         @name = json['name'].gsub(/^Xcode /, '')
         @path = json['files'].first['remotePath']
         url_prefix = 'https://developer.apple.com/devcenter/download.action?path='
@@ -757,6 +809,7 @@ HELP
 
     def self.new_prerelease(version, url, release_notes_path)
       new('name' => version,
+          'dateModified' => '01/01/70 00:00',
           'files' => [{ 'remotePath' => url.split('=').last }],
           'release_notes_path' => release_notes_path)
     end

data/lib/xcode/install/install.rb

@@ -17,13 +17,14 @@ module XcodeInstall
          ['--no-install', 'Only download DMG, but do not install it.'],
          ['--no-progress', 'Don’t show download progress.'],
          ['--no-clean', 'Don’t delete DMG after installation.'],
-         ['--no-show-release-notes', 'Don’t open release notes in browser after installation.']].concat(super)
+         ['--no-show-release-notes', 'Don’t open release notes in browser after installation.'],
+         ['--retry-download-count', 'Count of retrying download when curl is failed.']].concat(super)
       end
 
       def initialize(argv)
         @installer = Installer.new
         @version = argv.shift_argument
-        @version ||= File.read('.xcode-version') if File.exist?('.xcode-version')
+        @version ||= File.read('.xcode-version').strip if File.exist?('.xcode-version')
         @url = argv.option('url')
         @force = argv.flag?('force', false)
         @should_clean = argv.flag?('clean', true)
@@ -31,6 +32,7 @@ module XcodeInstall
         @should_switch = argv.flag?('switch', true)
         @progress = argv.flag?('progress', true)
         @show_release_notes = argv.flag?('show-release-notes', true)
+        @retry_download_count = argv.option('retry-download-count', '3')
         super
       end
 
@@ -44,11 +46,12 @@ module XcodeInstall
         end
         fail Informative, "Version #{@version} doesn't exist." unless @url || @installer.exist?(@version)
         fail Informative, "Invalid URL: `#{@url}`" unless !@url || @url =~ /\A#{URI.regexp}\z/
+        fail Informative, "Invalid Retry: `#{@retry_download_count} is not positive number.`" if (@retry_download_count =~ /\A[0-9]*\z/).nil?
       end
 
       def run
         @installer.install_version(@version, @should_switch, @should_clean, @should_install,
-                                   @progress, @url, @show_release_notes)
+                                   @progress, @url, @show_release_notes, nil, @retry_download_count.to_i)
       end
     end
   end