Class: FastlaneCore::Project
- Inherits:
-
Object
- Object
- FastlaneCore::Project
- Defined in:
- lib/fastlane_core/project.rb
Overview
Represents an Xcode project
Instance Attribute Summary collapse
-
#is_workspace ⇒ Object
Is this project a workspace?.
-
#options ⇒ Object
The config object containing the scheme, configuration, etc.
-
#path ⇒ Object
Path to the project/workspace.
Raw Access collapse
-
.run_command(command, timeout: 0) ⇒ Object
runs the specified command and kills it if timeouts Note: currently affected by fastlane/fastlane_core#102.
- .xcode_list_timeout ⇒ Object
-
#build_settings(key: nil, optional: true) ⇒ Object
Get the build settings for our project this is used to properly get the DerivedData folder.
-
#default_build_settings(key: nil, optional: true) ⇒ Object
Returns the build settings and sets the default scheme to the options hash.
- #raw_info(silent: false) ⇒ Object
Class Method Summary collapse
-
.detect_projects(config) ⇒ Object
Project discovery.
- .select_project(config) ⇒ Object
Instance Method Summary collapse
- #app_name ⇒ Object
-
#configurations ⇒ Object
Get all available configurations in an array.
-
#default_app_identifier ⇒ Object
Returns bundle_id and sets the scheme for xcrun.
-
#default_app_name ⇒ Object
Returns app name and sets the scheme for xcrun.
-
#initialize(options) ⇒ Project
constructor
A new instance of Project.
- #ios? ⇒ Boolean
- #mac? ⇒ Boolean
- #project_name ⇒ Object
-
#schemes ⇒ Object
Get all available schemes in an array.
-
#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.
- #tvos? ⇒ Boolean
- #workspace? ⇒ Boolean
- #xcodebuild_parameters ⇒ Object
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() self. = self.path = File.([:workspace] || [:project]) self.is_workspace = ([:workspace].to_s.length > 0) if !path or !File.directory?(path) UI.user_error!("Could not find project at path '#{path}'") 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 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 UI.user_error!("You can only pass either a workspace or a project path, not both") 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
287 288 289 290 |
# File 'lib/fastlane_core/project.rb', line 287 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 UI.error("Path must end with either .xcworkspace or .xcodeproj") end else UI.error("Couldn't find project at path '#{File.(path)}'") end end end |
.xcode_list_timeout ⇒ Object
278 279 280 |
# File 'lib/fastlane_core/project.rb', line 278 def self.xcode_list_timeout (ENV['FASTLANE_XCODE_LIST_TIMEOUT'] || 10).to_i end |
Instance Method Details
#app_name ⇒ Object
157 158 159 160 161 162 163 164 |
# File 'lib/fastlane_core/project.rb', line 157 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
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/fastlane_core/project.rb', line 199 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 UI.error(caller.join("\n\t")) UI.error("Could not fetch #{key} from project file: #{ex}") end nil end |
#configurations ⇒ Object
Get all available configurations in an array
139 140 141 |
# File 'lib/fastlane_core/project.rb', line 139 def configurations parsed_info.configurations end |
#default_app_identifier ⇒ Object
Returns bundle_id and sets the scheme for xcrun
144 145 146 |
# File 'lib/fastlane_core/project.rb', line 144 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
149 150 151 152 153 154 155 |
# File 'lib/fastlane_core/project.rb', line 149 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
220 221 222 223 |
# File 'lib/fastlane_core/project.rb', line 220 def default_build_settings(key: nil, optional: true) [:scheme] = schemes.first if is_workspace build_settings(key: key, optional: optional) end |
#ios? ⇒ Boolean
179 180 181 |
# File 'lib/fastlane_core/project.rb', line 179 def ios? !mac? && !tvos? end |
#mac? ⇒ Boolean
166 167 168 169 170 171 |
# File 'lib/fastlane_core/project.rb', line 166 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([:workspace], ".xcworkspace") else return File.basename([:project], ".xcodeproj") end end |
#raw_info(silent: false) ⇒ Object
225 226 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 |
# File 'lib/fastlane_core/project.rb', line 225 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 = xcodebuild_parameters.delete_if { |a| a.to_s.include? "scheme" } command = "xcrun xcodebuild -list #{.join(' ')}" UI.important(command) 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 UI.user_error!("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") end UI.user_error!("Error parsing xcode file using `#{command}`") 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
98 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 |
# File 'lib/fastlane_core/project.rb', line 98 def select_scheme(preferred_to_include: nil) if [:scheme].to_s.length > 0 # Verify the scheme is available unless schemes.include?([:scheme].to_s) UI.error("Couldn't find specified scheme '#{[:scheme]}'.") [:scheme] = nil end end return if [:scheme].to_s.length > 0 if schemes.count == 1 [: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 [:scheme] = preferred.last elsif automated_scheme_selection? && schemes.include?(project_name) UI.important("Using scheme matching project name (#{project_name}).") [:scheme] = project_name elsif Helper.is_ci? UI.error("Multiple schemes found but you haven't specified one.") UI.error("Since this is a CI, please pass one using the `scheme` option") UI.user_error!("Multiple schemes found") else puts "Select Scheme: " [:scheme] = choose(*schemes) end else UI.error("Couldn't find any schemes in this project, make sure that the scheme is shared if you are using a workspace") UI.error("Open Xcode, click on `Manage Schemes` and check the `Shared` box for the schemes you want to use") UI.user_error!("No Schemes found") end end |
#tvos? ⇒ Boolean
173 174 175 176 177 |
# File 'lib/fastlane_core/project.rb', line 173 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
79 80 81 |
# File 'lib/fastlane_core/project.rb', line 79 def workspace? self.is_workspace end |
#xcodebuild_parameters ⇒ Object
183 184 185 186 187 188 189 190 |
# File 'lib/fastlane_core/project.rb', line 183 def xcodebuild_parameters proj = [] proj << "-workspace #{[:workspace].shellescape}" if [:workspace] proj << "-scheme #{[:scheme].shellescape}" if [:scheme] proj << "-project #{[:project].shellescape}" if [:project] return proj end |