Class: Pod::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods/config.rb

Overview

Stores the global configuration of CocoaPods.

Defined Under Namespace

Modules: Mixin

Constant Summary collapse

DEFAULTS =

The default settings for the configuration.

Users can specify custom settings in `~/.cocoapods/config.yaml`. An example of the contents of this file might look like:

---
skip_repo_update: true
new_version_message: false
{
  :verbose             => false,
  :silent              => false,
  :skip_download_cache => !ENV['COCOAPODS_SKIP_CACHE'].nil?,

  :new_version_message => ENV['COCOAPODS_SKIP_UPDATE_MESSAGE'].nil?,

  :cache_root          => Pathname.new(Dir.home) + 'Library/Caches/CocoaPods',
}

UI collapse

Installation collapse

Cache collapse

Initialization collapse

Paths collapse

Singleton collapse

UI collapse

Initialization collapse

Paths collapse

Private helpers collapse

Instance Method Summary collapse

Constructor Details

#initialize(use_user_settings = true) ⇒ Config

Returns a new instance of Config.


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/cocoapods/config.rb', line 105

def initialize( = true)
  configure_with(DEFAULTS)

  unless ENV['CP_HOME_DIR'].nil?
    @cache_root = home_dir + 'cache'
  end

  if  && .exist?
    require 'yaml'
     = YAML.load_file()
    configure_with()
  end

  unless ENV['CP_CACHE_DIR'].nil?
    @cache_root = Pathname.new(ENV['CP_CACHE_DIR']).expand_path
  end
end

Class Attribute Details

.instanceConfig

Returns the current config instance creating one if needed.

Returns:

  • (Config)

    the current config instance creating one if needed.


342
343
344
# File 'lib/cocoapods/config.rb', line 342

def self.instance
  @instance ||= new
end

Instance Attribute Details

#allow_rootBool Also known as: allow_root?

Returns Whether CocoaPods is allowed to run as root.

Returns:

  • (Bool)

    Whether CocoaPods is allowed to run as root.


65
66
67
# File 'lib/cocoapods/config.rb', line 65

def allow_root
  @allow_root
end

#cache_rootPathname

Returns The directory where CocoaPods should cache remote data and other expensive to compute information.

Returns:

  • (Pathname)

    The directory where CocoaPods should cache remote data and other expensive to compute information.


92
93
94
# File 'lib/cocoapods/config.rb', line 92

def cache_root
  @cache_root
end

#installation_rootPathname Also known as: project_root

Returns the root of the CocoaPods installation where the Podfile is located.

Returns:

  • (Pathname)

    the root of the CocoaPods installation where the Podfile is located.


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/cocoapods/config.rb', line 164

def installation_root
  @installation_root ||= begin
    current_dir = Pathname.new(ActiveSupport::Multibyte::Unicode.normalize(Dir.pwd))
    current_path = current_dir
    until current_path.root?
      if podfile_path_in_dir(current_path)
        installation_root = current_path
        unless current_path == current_dir
          UI.puts("[in #{current_path}]")
        end
        break
      else
        current_path = current_path.parent
      end
    end
    installation_root || current_dir
  end
end

#new_version_messageBool Also known as: new_version_message?

Returns Whether a message should be printed when a new version of CocoaPods is available.

Returns:

  • (Bool)

    Whether a message should be printed when a new version of CocoaPods is available.


71
72
73
# File 'lib/cocoapods/config.rb', line 71

def new_version_message
  @new_version_message
end

#podfilePodfile, Nil

Returns:

  • (Podfile)

    The Podfile to use for the current execution.

  • (Nil)

    If no Podfile is available.


204
205
206
# File 'lib/cocoapods/config.rb', line 204

def podfile
  @podfile ||= Podfile.from_file(podfile_path) if podfile_path
end

#repos_dirPathname

Returns the directory where the CocoaPods sources are stored.

Returns:

  • (Pathname)

    the directory where the CocoaPods sources are stored.


142
143
144
# File 'lib/cocoapods/config.rb', line 142

def repos_dir
  @repos_dir ||= Pathname.new(ENV['CP_REPOS_DIR'] || (home_dir + 'repos')).expand_path
end

#sandbox_rootPathname Also known as: project_pods_root

Returns The root of the sandbox.

Returns:

  • (Pathname)

    The root of the sandbox.


188
189
190
# File 'lib/cocoapods/config.rb', line 188

def sandbox_root
  @sandbox_root ||= installation_root + 'Pods'
end

#silentBool Also known as: silent?

Returns Whether CocoaPods should produce not output.

Returns:

  • (Bool)

    Whether CocoaPods should produce not output.


60
61
62
# File 'lib/cocoapods/config.rb', line 60

def silent
  @silent
end

#skip_download_cacheBool Also known as: skip_download_cache?

Returns Whether the installer should skip the download cache.

Returns:

  • (Bool)

    Whether the installer should skip the download cache.


80
81
82
# File 'lib/cocoapods/config.rb', line 80

def skip_download_cache
  @skip_download_cache
end

#verboseBool

Returns Whether CocoaPods should provide detailed output about the performed actions.

Returns:

  • (Bool)

    Whether CocoaPods should provide detailed output about the performed actions.


55
56
57
# File 'lib/cocoapods/config.rb', line 55

def verbose
  @verbose
end

Instance Method Details

#default_podfile_pathPathname

Note:

The file is expected to be named Podfile.default

Returns the path of the default Podfile pods.

Returns:

  • (Pathname)

243
244
245
# File 'lib/cocoapods/config.rb', line 243

def default_podfile_path
  @default_podfile_path ||= templates_dir + 'Podfile.default'
end

#default_test_podfile_pathPathname

Note:

The file is expected to be named Podfile.test

Returns the path of the default Podfile test pods.

Returns:

  • (Pathname)

253
254
255
# File 'lib/cocoapods/config.rb', line 253

def default_test_podfile_path
  @default_test_podfile_path ||= templates_dir + 'Podfile.test'
end

#exclude_from_backup(dir) ⇒ void

This method returns an undefined value.

Excludes the given dir from Time Machine backups.

Parameters:

  • dir (Pathname)

    The directory to exclude from Time Machine backups.


329
330
331
332
# File 'lib/cocoapods/config.rb', line 329

def exclude_from_backup(dir)
  return if Gem.win_platform?
  system('tmutil', 'addexclusion', dir.to_s, %i(out err) => File::NULL)
end

#home_dirPathname

Returns the directory where repos, templates and configuration files are stored.

Returns:

  • (Pathname)

    the directory where repos, templates and configuration files are stored.


136
137
138
# File 'lib/cocoapods/config.rb', line 136

def home_dir
  @home_dir ||= Pathname.new(ENV['CP_HOME_DIR'] || '~/.cocoapods').expand_path
end

#lockfileLockfile, Nil

Returns:

  • (Lockfile)

    The Lockfile to use for the current execution.

  • (Nil)

    If no Lockfile is available.


212
213
214
# File 'lib/cocoapods/config.rb', line 212

def lockfile
  @lockfile ||= Lockfile.from_file(lockfile_path) if lockfile_path
end

#lockfile_pathObject

Note:

The Lockfile is named `Podfile.lock`.

Returns the path of the Lockfile.


233
234
235
# File 'lib/cocoapods/config.rb', line 233

def lockfile_path
  @lockfile_path ||= installation_root + 'Podfile.lock'
end

#podfile_pathPathname, Nil

Note:

The Podfile can be named either `CocoaPods.podfile.yaml`, `CocoaPods.podfile` or `Podfile`. The first two are preferred as they allow to specify an OS X UTI.

Returns the path of the Podfile.

Returns:

  • (Pathname)
  • (Nil)

225
226
227
# File 'lib/cocoapods/config.rb', line 225

def podfile_path
  @podfile_path ||= podfile_path_in_dir(installation_root)
end

#podfile_path_in_dir(dir) ⇒ Pathname, Nil

Returns the path of the Podfile in the given dir if any exists.

Parameters:

  • dir (Pathname)

    The directory where to look for the Podfile.

Returns:

  • (Pathname)

    The path of the Podfile.

  • (Nil)

    If not Podfile was found in the given dir


312
313
314
315
316
317
318
319
320
# File 'lib/cocoapods/config.rb', line 312

def podfile_path_in_dir(dir)
  PODFILE_NAMES.each do |filename|
    candidate = dir + filename
    if candidate.file?
      return candidate
    end
  end
  nil
end

#sandboxSandbox

Returns The sandbox of the current project.

Returns:

  • (Sandbox)

    The sandbox of the current project.


197
198
199
# File 'lib/cocoapods/config.rb', line 197

def sandbox
  @sandbox ||= Sandbox.new(sandbox_root)
end

#search_index_filePathname

Returns The file to use to cache the search data.

Returns:

  • (Pathname)

    The file to use to cache the search data.


259
260
261
# File 'lib/cocoapods/config.rb', line 259

def search_index_file
  cache_root + 'search_index.json'
end

#sources_managerSource::Manager

Returns the source manager for the spec repos in `repos_dir`.

Returns:

  • (Source::Manager)

    the source manager for the spec repos in `repos_dir`


150
151
152
153
# File 'lib/cocoapods/config.rb', line 150

def sources_manager
  return @sources_manager if @sources_manager && @sources_manager.repos_dir == repos_dir
  @sources_manager = Source::Manager.new(repos_dir)
end

#templates_dirPathname

Returns the directory where the CocoaPods templates are stored.

Returns:

  • (Pathname)

    the directory where the CocoaPods templates are stored.


157
158
159
# File 'lib/cocoapods/config.rb', line 157

def templates_dir
  @templates_dir ||= Pathname.new(ENV['CP_TEMPLATES_DIR'] || (home_dir + 'templates')).expand_path
end

#verbose?Bool

Returns Whether CocoaPods should provide detailed output about the performed actions.

Returns:

  • (Bool)

    Whether CocoaPods should provide detailed output about the performed actions.


56
57
58
# File 'lib/cocoapods/config.rb', line 56

def verbose
  @verbose
end

#with_changes(changes) { ... } ⇒ Object

Applies the given changes to the config for the duration of the given block.

Parameters:

  • changes (Hash<#to_sym,Object>)

    the changes to merge temporarily with the current config

Yields:

  • is called while the changes are applied


34
35
36
37
38
39
40
41
42
43
44
# File 'lib/cocoapods/config.rb', line 34

def with_changes(changes)
  old = {}
  changes.keys.each do |key|
    key = key.to_sym
    old[key] = send(key) if respond_to?(key)
  end
  configure_with(changes)
  yield if block_given?
ensure
  configure_with(old)
end