Class: FastlaneCore::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/fastlane_core/project.rb

Overview

Represents an Xcode project

Instance Attribute Summary collapse

Raw Access collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Project

Returns a new instance of Project.



69
70
71
72
73
74
75
76
77
 
# File 'lib/fastlane_core/project.rb', line 69

def initialize(options)
  self.options = options
  self.path = File.expand_path(options[:workspace] || options[:project])
  self.is_workspace = (options[:workspace].to_s.length > 0)

  if !path or !File.directory?(path)
    raise "Could not find project at path '#{path}'".red
  end
end

Instance Attribute Details

#is_workspace ⇒ Object

Is this project a workspace?



64
65
66
 
# File 'lib/fastlane_core/project.rb', line 64

def is_workspace
  @is_workspace
end

#options ⇒ Object

The config object containing the scheme, configuration, etc.



67
68
69
 
# File 'lib/fastlane_core/project.rb', line 67

def options
  @options
end

#path ⇒ Object

Path to the project/workspace



61
62
63
 
# File 'lib/fastlane_core/project.rb', line 61

def path
  @path
end

Class Method Details

.detect_projects(config) ⇒ Object

Project discovery



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/fastlane_core/project.rb', line 6

def detect_projects(config)
  if config[:workspace].to_s.length > 0 and config[:project].to_s.length > 0
    raise "You can only pass either a workspace or a project path, not both".red
  end

  return if config[:project].to_s.length > 0

  if config[:workspace].to_s.length == 0
    workspace = Dir["./*.xcworkspace"]
    if workspace.count > 1
      puts "Select Workspace: "
      config[:workspace] = choose(*workspace)
    elsif !workspace.first.nil?
      config[:workspace] = workspace.first
    end
  end

  return if config[:workspace].to_s.length > 0

  if config[:workspace].to_s.length == 0 and config[:project].to_s.length == 0
    project = Dir["./*.xcodeproj"]
    if project.count > 1
      puts "Select Project: "
      config[:project] = choose(*project)
    elsif !project.first.nil?
      config[:project] = project.first
    end
  end

  if config[:workspace].nil? and config[:project].nil?
    select_project(config)
  end
end

.run_command(command, timeout: 0) ⇒ Object

runs the specified command and kills it if timeouts Note: currently affected by fastlane/fastlane_core#102



289
290
291
292
 
# File 'lib/fastlane_core/project.rb', line 289

def self.run_command(command, timeout: 0)
  require 'timeout'
  @raw = Timeout.timeout(timeout) { `#{command}`.to_s }
end

.select_project(config) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fastlane_core/project.rb', line 40

def select_project(config)
  loop do
    path = ask("Couldn't automatically detect the project file, please provide a path: ".yellow).strip
    if File.directory? path
      if path.end_with? ".xcworkspace"
        config[:workspace] = path
        break
      elsif path.end_with? ".xcodeproj"
        config[:project] = path
        break
      else
        Helper.log.error "Path must end with either .xcworkspace or .xcodeproj"
      end
    else
      Helper.log.error "Couldn't find project at path '#{File.expand_path(path)}'".red
    end
  end
end

.xcode_list_timeout ⇒ Object 



280
281
282
 
# File 'lib/fastlane_core/project.rb', line 280

def self.xcode_list_timeout
  (ENV['FASTLANE_XCODE_LIST_TIMEOUT'] || 10).to_i
end

Instance Method Details

#app_name ⇒ Object 



159
160
161
162
163
164
165
166
 
# File 'lib/fastlane_core/project.rb', line 159

def app_name
  # WRAPPER_NAME: Example.app
  # WRAPPER_SUFFIX: .app
  name = build_settings(key: "WRAPPER_NAME")

  return name.gsub(build_settings(key: "WRAPPER_SUFFIX"), "") if name
  return "App" # default value
end

#build_settings(key: nil, optional: true) ⇒ Object

Get the build settings for our project this is used to properly get the DerivedData folder

Parameters:

  • The (String) —

    key of which we want the value for (e.g. “PRODUCT_NAME”)



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/fastlane_core/project.rb', line 201

def build_settings(key: nil, optional: true)
  unless @build_settings
    # We also need to pass the workspace and scheme to this command
    command = "xcrun xcodebuild -showBuildSettings #{xcodebuild_parameters.join(' ')}"
    @build_settings = Helper.backticks(command, print: false)
  end

  begin
    result = @build_settings.split("\n").find { |c| c.split(" = ").first.strip == key }
    return result.split(" = ").last
  rescue => ex
    return nil if optional # an optional value, we really don't care if something goes wrong

    Helper.log.error caller.join("\n\t")
    Helper.log.error "Could not fetch #{key} from project file: #{ex}"
  end

  nil
end

#configurations ⇒ Object

Get all available configurations in an array



141
142
143
 
# File 'lib/fastlane_core/project.rb', line 141

def configurations
  parsed_info.configurations
end

#default_app_identifier ⇒ Object

Returns bundle_id and sets the scheme for xcrun



146
147
148
 
# File 'lib/fastlane_core/project.rb', line 146

def default_app_identifier
  default_build_settings(key: "PRODUCT_BUNDLE_IDENTIFIER")
end

#default_app_name ⇒ Object

Returns app name and sets the scheme for xcrun



151
152
153
154
155
156
157
 
# File 'lib/fastlane_core/project.rb', line 151

def default_app_name
  if is_workspace
    return default_build_settings(key: "PRODUCT_NAME")
  else
    return app_name
  end
end

#default_build_settings(key: nil, optional: true) ⇒ Object

Returns the build settings and sets the default scheme to the options hash



222
223
224
225
 
# File 'lib/fastlane_core/project.rb', line 222

def default_build_settings(key: nil, optional: true)
  options[:scheme] = schemes.first if is_workspace
  build_settings(key: key, optional: optional)
end

#ios? ⇒ Boolean

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/fastlane_core/project.rb', line 181

def ios?
  !mac? && !tvos?
end

#mac? ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
171
172
173
 
# File 'lib/fastlane_core/project.rb', line 168

def mac?
  # Some projects have different values... we have to look for all of them
  return true if build_settings(key: "PLATFORM_NAME") == "macosx"
  return true if build_settings(key: "PLATFORM_DISPLAY_NAME") == "OS X"
  false
end

#project_name ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/fastlane_core/project.rb', line 83

def project_name
  if is_workspace
    return File.basename(options[:workspace], ".xcworkspace")
  else
    return File.basename(options[:project], ".xcodeproj")
  end
end

#raw_info(silent: false) ⇒ Object 



227
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/fastlane_core/project.rb', line 227

def raw_info(silent: false)
  # Examples:

  # Standard:
  #
  # Information about project "Example":
  #     Targets:
  #         Example
  #         ExampleUITests
  #
  #     Build Configurations:
  #         Debug
  #         Release
  #
  #     If no build configuration is specified and -scheme is not passed then "Release" is used.
  #
  #     Schemes:
  #         Example
  #         ExampleUITests

  # CococaPods
  #
  # Example.xcworkspace
  # Information about workspace "Example":
  #     Schemes:
  #         Example
  #         HexColors
  #         Pods-Example

  return @raw if @raw

  # Unfortunately since we pass the workspace we also get all the
  # schemes generated by CocoaPods

  options = xcodebuild_parameters.delete_if { |a| a.to_s.include? "scheme" }
  command = "xcrun xcodebuild -list #{options.join(' ')}"
  Helper.log.info command.yellow unless silent

  # xcode >= 6 might hang here if the user schemes are missing
  begin
    timeout = FastlaneCore::Project.xcode_list_timeout
    @raw = FastlaneCore::Project.run_command(command, timeout: timeout)
  rescue Timeout::Error
    raise "xcodebuild -list timed-out after #{timeout} seconds. You might need to recreate the user schemes." \
      " You can override the timeout value with the environment variable FASTLANE_XCODE_LIST_TIMEOUT".red
  end

  raise "Error parsing xcode file using `#{command}`".red if @raw.length == 0

  return @raw
end

#schemes ⇒ Object

Get all available schemes in an array



92
93
94
 
# File 'lib/fastlane_core/project.rb', line 92

def schemes
  parsed_info.schemes
end

#select_scheme(preferred_to_include: nil) ⇒ Object

Let the user select a scheme Use a scheme containing the preferred_to_include string when multiple schemes were found rubocop:disable Metrics/AbcSize



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fastlane_core/project.rb', line 99

def select_scheme(preferred_to_include: nil)
  if options[:scheme].to_s.length > 0
    # Verify the scheme is available
    unless schemes.include?(options[:scheme].to_s)
      Helper.log.error "Couldn't find specified scheme '#{options[:scheme]}'.".red
      options[:scheme] = nil
    end
  end

  return if options[:scheme].to_s.length > 0

  if schemes.count == 1
    options[:scheme] = schemes.last
  elsif schemes.count > 1
    preferred = nil
    if preferred_to_include
      preferred = schemes.find_all { |a| a.downcase.include?(preferred_to_include.downcase) }
    end

    if preferred_to_include and preferred.count == 1
      options[:scheme] = preferred.last
    elsif automated_scheme_selection? && schemes.include?(project_name)
      Helper.log.info "Using scheme matching project name (#{project_name}).".yellow
      options[:scheme] = project_name
    elsif Helper.is_ci?
      Helper.log.error "Multiple schemes found but you haven't specified one.".red
      Helper.log.error "Since this is a CI, please pass one using the `scheme` option".red
      raise "Multiple schemes found".red
    else
      puts "Select Scheme: "
      options[:scheme] = choose(*schemes)
    end
  else
    Helper.log.error "Couldn't find any schemes in this project, make sure that the scheme is shared if you are using a workspace".red
    Helper.log.error "Open Xcode, click on `Manage Schemes` and check the `Shared` box for the schemes you want to use".red

    raise "No Schemes found".red
  end
end

#tvos? ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
178
179
 
# File 'lib/fastlane_core/project.rb', line 175

def tvos?
  return true if build_settings(key: "PLATFORM_NAME").to_s.include? "appletv"
  return true if build_settings(key: "PLATFORM_DISPLAY_NAME").to_s.include? "tvOS"
  false
end

#workspace? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/fastlane_core/project.rb', line 79

def workspace?
  self.is_workspace
end

#xcodebuild_parameters ⇒ Object 



185
186
187
188
189
190
191
192
 
# File 'lib/fastlane_core/project.rb', line 185

def xcodebuild_parameters
  proj = []
  proj << "-workspace '#{options[:workspace]}'" if options[:workspace]
  proj << "-scheme '#{options[:scheme]}'" if options[:scheme]
  proj << "-project '#{options[:project]}'" if options[:project]

  return proj
end