Class: RunLoop::Xcode

Inherits:
Object
  • Object
show all
Includes:
Shell
Defined in:
lib/run_loop/xcode.rb

Overview

Note:

All command line tools are run in the context of ‘xcrun`.

A model of the active Xcode version.

Throughout this class’s documentation, there are references to the _active version of Xcode_. The active Xcode version is the one returned by ‘xcrun xcodebuild`. The current Xcode version can be set using `xcode-select` or overridden using the `DEVELOPER_DIR`.

Constant Summary

Constants included from Shell

Shell::DEFAULT_OPTIONS

Instance Method Summary collapse

Methods included from Shell

run_shell_command, #run_shell_command

Methods included from Encoding

#transliterate

Instance Method Details

#beta? ⇒ Boolean

Note:

Relies on Xcode beta versions having and app bundle named Xcode-Beta.app

Is this a beta version of Xcode?

Returns:

  • (Boolean) —

    True if the Xcode version is beta.



260
261
262
 
# File 'lib/run_loop/xcode.rb', line 260

def beta?
  developer_dir[/Xcode-[Bb]eta.app/, 0]
end

#core_simulator_dir ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/run_loop/xcode.rb', line 317

def core_simulator_dir
  if version_gte_110?
    core_simulator_dir = File.join(developer_dir,
                                  'Platforms', 'iPhoneOS.platform', 'Library',
                                  'Developer', 'CoreSimulator')
  else
    core_simulator_dir = File.join(developer_dir,
                                  'Platforms', 'iPhoneOS.platform', 'Developer',
                                  'Library', 'CoreSimulator')
  end
  File.expand_path(core_simulator_dir)
end

#default_device ⇒ Object 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/run_loop/xcode.rb', line 341

def default_device
  xcode_version = version
  if xcode_version.major == 11
    return "iPhone 11"
  end

  if xcode_version.major == 10
    if xcode_version.minor >= 2
      return "iPhone Xs"
    else
      return "iPhone XS"
    end
  end

  # Xcode < 10
  return "iPhone #{xcode_version.major - 1}"
end

#developer_dir ⇒ String

Returns the path to the current developer directory.

From the man pages:

“‘ $ man xcode-select DEVELOPER_DIR Overrides the active developer directory. When DEVELOPER_DIR is set, its value will be used instead of the system-wide active developer directory. “`

Returns:

  • (String) —

    path to current developer directory

Raises:

  • (RuntimeError) —

    If path to Xcode.app/Contents/Developer cannot be determined.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/run_loop/xcode.rb', line 280

def developer_dir
  @xcode_developer_dir ||= begin
    if RunLoop::Environment.developer_dir
      path = RunLoop::Environment.developer_dir
    else
      path = xcode_select_path
    end

    require 'pathname'
    path = Pathname.new(path).realpath.to_s

    if !File.directory?(path)
      raise RuntimeError,
%Q{Cannot determine the active Xcode.  Expected an Xcode here:

#{path}

Check the value of xcode-select:

# Does this resolve to a valid Xcode.app/Contents/Developer path?
$ xcode-select --print-path

Is the DEVELOPER_DIR variable set in your environment?  You would
only use this if you have multiple Xcode's installed.

$ echo $DEVELOPER_DIR

See the man pages for xcrun and xcode-select for details.

$ man xcrun
$ man xcode-select
}
    end
    path
  end
end

#inspect ⇒ Object

Returns debug String representation



25
26
27
 
# File 'lib/run_loop/xcode.rb', line 25

def inspect
  to_s
end

#ios_version ⇒ Object 



330
331
332
333
334
335
336
337
338
339
 
# File 'lib/run_loop/xcode.rb', line 330

def ios_version
  xcode_version = version
  sim_major = xcode_version.major + 2
  sim_minor = xcode_version.minor
  if xcode_version == v103
    sim_minor = 4
  end

  return RunLoop::Version.new("#{sim_major}.#{sim_minor}")
end

#to_s ⇒ Object

Returns a String representation.



20
21
22
 
# File 'lib/run_loop/xcode.rb', line 20

def to_s
  "#<Xcode #{version.to_s}>"
end

#v100 ⇒ RunLoop::Version

Returns a version instance for Xcode 10.0; used to check for the availability of features and paths to various items on the filesystem

Returns:



57
58
59
 
# File 'lib/run_loop/xcode.rb', line 57

def v100
  fetch_version(:v100)
end

#v102 ⇒ RunLoop::Version

Returns a version instance for Xcode 10.2; used to check for the availability of features and paths to various items on the filesystem

Returns:



49
50
51
 
# File 'lib/run_loop/xcode.rb', line 49

def v102
  fetch_version(:v102)
end

#v103 ⇒ RunLoop::Version

availability of features and paths to various items on the filesystem

Returns:



41
42
43
 
# File 'lib/run_loop/xcode.rb', line 41

def v103
  fetch_version(:v103)
end

#v110 ⇒ RunLoop::Version

Returns a version instance for Xcode 11.0; used to check for the availability of features and paths to various items on the filesystem

Returns:



33
34
35
 
# File 'lib/run_loop/xcode.rb', line 33

def v110
  fetch_version(:v110)
end

#v80 ⇒ RunLoop::Version

Returns a version instance for ‘Xcode 8.0`; used to check for the availability of features and paths to various items on the filesystem.

Returns:



129
130
131
 
# File 'lib/run_loop/xcode.rb', line 129

def v80
  fetch_version(:v80)
end

#v81 ⇒ RunLoop::Version

Returns a version instance for ‘Xcode 8.1`; used to check for the availability of features and paths to various items on the filesystem.

Returns:



121
122
123
 
# File 'lib/run_loop/xcode.rb', line 121

def v81
  fetch_version(:v81)
end

#v82 ⇒ RunLoop::Version

Returns a version instance for Xcode 8.2; used to check for the availability of features and paths to various items on the filesystem

Returns:



113
114
115
 
# File 'lib/run_loop/xcode.rb', line 113

def v82
  fetch_version(:v82)
end

#v83 ⇒ RunLoop::Version

Returns a version instance for Xcode 8.3; used to check for the availability of features and paths to various items on the filesystem

Returns:



105
106
107
 
# File 'lib/run_loop/xcode.rb', line 105

def v83
  fetch_version(:v83)
end

#v90 ⇒ RunLoop::Version

Returns a version instance for Xcode 9.0; used to check for the availability of features and paths to various items on the filesystem

Returns:



97
98
99
 
# File 'lib/run_loop/xcode.rb', line 97

def v90
  fetch_version(:v90)
end

#v91 ⇒ RunLoop::Version

Returns a version instance for Xcode 9.1; used to check for the availability of features and paths to various items on the filesystem

Returns:



89
90
91
 
# File 'lib/run_loop/xcode.rb', line 89

def v91
  fetch_version(:v91)
end

#v92 ⇒ RunLoop::Version

Returns a version instance for Xcode 9.2; used to check for the availability of features and paths to various items on the filesystem

Returns:



81
82
83
 
# File 'lib/run_loop/xcode.rb', line 81

def v92
  fetch_version(:v92)
end

#v93 ⇒ RunLoop::Version

Returns a version instance for Xcode 9.3; used to check for the availability of features and paths to various items on the filesystem

Returns:



73
74
75
 
# File 'lib/run_loop/xcode.rb', line 73

def v93
  fetch_version(:v93)
end

#v94 ⇒ RunLoop::Version

Returns a version instance for Xcode 9.4; used to check for the availability of features and paths to various items on the filesystem

Returns:



65
66
67
 
# File 'lib/run_loop/xcode.rb', line 65

def v94
  fetch_version(:v94)
end

#version ⇒ RunLoop::Version

Returns the current version of Xcode.

Returns:

  • (RunLoop::Version) —

    The current version of Xcode as reported by ‘xcrun xcodebuild -version`.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/run_loop/xcode.rb', line 228

def version
  @xcode_version ||= begin
    if RunLoop::Environment.xtc?
      RunLoop::Version.new("0.0.0")
    else
      version = RunLoop::Version.new("0.0.0")
      begin
        args = ["xcrun", "xcodebuild", "-version"]
        hash = run_shell_command(args)
        if hash[:exit_status] != 0
          RunLoop.log_error("xcrun xcodebuild -version exited non-zero")
        else
          out = hash[:out]
          version_string = out.chomp[VERSION_REGEX, 0]
          version = RunLoop::Version.new(version_string)
        end
      rescue RuntimeError => e
        RunLoop.log_error(%Q[
Could not find Xcode version:

  #{e.class}: #{e.message}
])
      end
      version
    end
  end
end

#version_gte_100? ⇒ Boolean

Is the active Xcode version 10.0 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 10.0



157
158
159
 
# File 'lib/run_loop/xcode.rb', line 157

def version_gte_100?
  version >= v100
end

#version_gte_102? ⇒ Boolean

Is the active Xcode version 10.2 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 10.2



150
151
152
 
# File 'lib/run_loop/xcode.rb', line 150

def version_gte_102?
  version >= v102
end

#version_gte_103? ⇒ Boolean

Is the active Xcode version 10.3 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 10.3



143
144
145
 
# File 'lib/run_loop/xcode.rb', line 143

def version_gte_103?
  version >= v103
end

#version_gte_110? ⇒ Boolean

Is the active Xcode version 11.0 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 11.0



136
137
138
 
# File 'lib/run_loop/xcode.rb', line 136

def version_gte_110?
  version >= v110
end

#version_gte_81? ⇒ Boolean

Is the active Xcode version 8.1 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 8.1



213
214
215
 
# File 'lib/run_loop/xcode.rb', line 213

def version_gte_81?
  version >= v81
end

#version_gte_82? ⇒ Boolean

Is the active Xcode version 8.2 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 8.2



206
207
208
 
# File 'lib/run_loop/xcode.rb', line 206

def version_gte_82?
  version >= v82
end

#version_gte_83? ⇒ Boolean

Is the active Xcode version 8.3 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 8.3



199
200
201
 
# File 'lib/run_loop/xcode.rb', line 199

def version_gte_83?
  version >= v83
end

#version_gte_8? ⇒ Boolean

Is the active Xcode version 8.0 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 8.0



220
221
222
 
# File 'lib/run_loop/xcode.rb', line 220

def version_gte_8?
  version >= v80
end

#version_gte_90? ⇒ Boolean

Is the active Xcode version 9.0 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 9.0



192
193
194
 
# File 'lib/run_loop/xcode.rb', line 192

def version_gte_90?
  version >= v90
end

#version_gte_91? ⇒ Boolean

Is the active Xcode version 9.1 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 9.1



185
186
187
 
# File 'lib/run_loop/xcode.rb', line 185

def version_gte_91?
  version >= v91
end

#version_gte_92? ⇒ Boolean

Is the active Xcode version 9.2 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 9.2



178
179
180
 
# File 'lib/run_loop/xcode.rb', line 178

def version_gte_92?
  version >= v92
end

#version_gte_93? ⇒ Boolean

Is the active Xcode version 9.3 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 9.3



171
172
173
 
# File 'lib/run_loop/xcode.rb', line 171

def version_gte_93?
  version >= v93
end

#version_gte_94? ⇒ Boolean

Is the active Xcode version 9.4 or above?

Returns:

  • (Boolean) —

    ‘true` if the current Xcode version is >= 9.4



164
165
166
 
# File 'lib/run_loop/xcode.rb', line 164

def version_gte_94?
  version >= v94
end