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.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cocoapods/config.rb', line 100

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

.instance ⇒ Config

Returns the current config instance creating one if needed.

Returns:

  • (Config) —

    the current config instance creating one if needed.



323
324
325
 
# File 'lib/cocoapods/config.rb', line 323

def self.instance
  @instance ||= new
end

Instance Attribute Details

#cache_root ⇒ Pathname

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.



87
88
89
 
# File 'lib/cocoapods/config.rb', line 87

def cache_root
  @cache_root
end

#installation_root ⇒ Pathname 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.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/cocoapods/config.rb', line 157

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

#new_version_message ⇒ Bool 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.



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

def new_version_message
  @new_version_message
end

#podfile ⇒ Podfile, Nil

Returns:

  • (Podfile) —

    The Podfile to use for the current execution.

  • (Nil) —

    If no Podfile is available.



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

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

#repos_dir ⇒ Pathname

Returns the directory where the CocoaPods sources are stored.

Returns:

  • (Pathname) —

    the directory where the CocoaPods sources are stored.



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

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

#sandbox_root ⇒ Pathname Also known as: project_pods_root

Returns The root of the sandbox.

Returns:

  • (Pathname) —

    The root of the sandbox.



182
183
184
 
# File 'lib/cocoapods/config.rb', line 182

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

#silent ⇒ Bool 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_cache ⇒ Bool 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.



75
76
77
 
# File 'lib/cocoapods/config.rb', line 75

def skip_download_cache
  @skip_download_cache
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.



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

def verbose
  @verbose
end

Instance Method Details

#default_podfile_path ⇒ Pathname

Note:

The file is expected to be named Podfile.default

Returns the path of the default Podfile pods.

Returns:

  • (Pathname) 


237
238
239
 
# File 'lib/cocoapods/config.rb', line 237

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

#default_test_podfile_path ⇒ Pathname

Note:

The file is expected to be named Podfile.test

Returns the path of the default Podfile test pods.

Returns:

  • (Pathname) 


247
248
249
 
# File 'lib/cocoapods/config.rb', line 247

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

#home_dir ⇒ Pathname

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

Returns:

  • (Pathname) —

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



131
132
133
 
# File 'lib/cocoapods/config.rb', line 131

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

#lockfile ⇒ Lockfile, Nil

Returns:

  • (Lockfile) —

    The Lockfile to use for the current execution.

  • (Nil) —

    If no Lockfile is available.



206
207
208
 
# File 'lib/cocoapods/config.rb', line 206

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

#lockfile_path ⇒ Object

Note:

The Lockfile is named ‘Podfile.lock`.

Returns the path of the Lockfile.



227
228
229
 
# File 'lib/cocoapods/config.rb', line 227

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

#podfile_path ⇒ Pathname, 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) 


219
220
221
 
# File 'lib/cocoapods/config.rb', line 219

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



305
306
307
308
309
310
311
312
313
 
# File 'lib/cocoapods/config.rb', line 305

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

#sandbox ⇒ Sandbox

Returns The sandbox of the current project.

Returns:

  • (Sandbox) —

    The sandbox of the current project.



191
192
193
 
# File 'lib/cocoapods/config.rb', line 191

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

#search_index_file ⇒ Pathname

Returns The file to use to cache the search data.

Returns:

  • (Pathname) —

    The file to use to cache the search data.



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

def search_index_file
  cache_root + 'search_index.json'
end

#sources_manager ⇒ Object 



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

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

#templates_dir ⇒ Pathname

Returns the directory where the CocoaPods templates are stored.

Returns:

  • (Pathname) —

    the directory where the CocoaPods templates are stored.



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

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