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.



215
216
217
 
# File 'lib/run_loop/xcode.rb', line 215

def beta?
  developer_dir[/Xcode-[Bb]eta.app/, 0]
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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/run_loop/xcode.rb', line 235

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

    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

#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:



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

def v100
  fetch_version(:v100)
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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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`.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/run_loop/xcode.rb', line 183

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



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

def version_gte_100?
  version >= v100
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



168
169
170
 
# File 'lib/run_loop/xcode.rb', line 168

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



161
162
163
 
# File 'lib/run_loop/xcode.rb', line 161

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



154
155
156
 
# File 'lib/run_loop/xcode.rb', line 154

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



175
176
177
 
# File 'lib/run_loop/xcode.rb', line 175

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



147
148
149
 
# File 'lib/run_loop/xcode.rb', line 147

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



140
141
142
 
# File 'lib/run_loop/xcode.rb', line 140

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



133
134
135
 
# File 'lib/run_loop/xcode.rb', line 133

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



126
127
128
 
# File 'lib/run_loop/xcode.rb', line 126

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



119
120
121
 
# File 'lib/run_loop/xcode.rb', line 119

def version_gte_94?
  version >= v94
end