Class: Pod::Lockfile
- Inherits:
-
Object
- Object
- Pod::Lockfile
- Defined in:
- lib/cocoapods-core/lockfile.rb
Overview
The Lockfile stores information about the pods that were installed by CocoaPods.
It is used in combination with the Podfile to resolve the exact version of the Pods that should be installed (i.e. to prevent ‘pod install` from upgrading dependencies).
Moreover it is used as a manifest of an installation to detect which Pods need to be installed or removed.
Instance Attribute Summary collapse
-
#defined_in_file ⇒ String
The file where the Lockfile is serialized.
-
#internal_data ⇒ String
readonly
The hash used to initialize the Lockfile.
Class Method Summary collapse
-
.from_file(path) ⇒ Lockfile
Loads a lockfile form the given path.
-
.generate(podfile, specs) ⇒ Lockfile
Generates a hash representation of the Lockfile generated from a given Podfile and the list of resolved Specifications.
Instance Method Summary collapse
-
#==(other) ⇒ Bool
Whether the Podfiles are equal.
-
#checksum(name) ⇒ String, Nil
Returns the checksum for the given Pod.
-
#cocoapods_version ⇒ Version
The version of CocoaPods which generated this lockfile.
-
#dependencies ⇒ Array<Dependency>
The dependencies of the Podfile used for the last installation.
-
#dependency_to_lock_pod_named(name) ⇒ Dependency
Generates a dependency that requires the exact version of the Pod with the given name.
- #detect_changes_with_podfile(podfile) ⇒ Hash{Symbol=>Array[Strings]}
-
#initialize(hash) ⇒ Lockfile
constructor
A new instance of Lockfile.
-
#inspect ⇒ String
A string representation suitable for debugging.
-
#pod_names ⇒ Array<String>
The names of the installed Pods.
-
#to_hash ⇒ Hash{String=>Array,Hash,String}
A hash representation of the Lockfile.
-
#to_yaml ⇒ String
The YAML representation of the Lockfile, used for serialization.
-
#version(pod_name) ⇒ Version, Nil
Returns the version of the given Pod.
-
#write_to_disk(path) ⇒ void
Writes the Lockfile to the given path.
Constructor Details
#initialize(hash) ⇒ Lockfile
Returns a new instance of Lockfile.
25 26 27 |
# File 'lib/cocoapods-core/lockfile.rb', line 25 def initialize(hash) @internal_data = hash end |
Instance Attribute Details
#defined_in_file ⇒ String
Returns the file where the Lockfile is serialized.
54 55 56 |
# File 'lib/cocoapods-core/lockfile.rb', line 54 def defined_in_file @defined_in_file end |
#internal_data ⇒ String (readonly)
Returns the hash used to initialize the Lockfile.
20 21 22 |
# File 'lib/cocoapods-core/lockfile.rb', line 20 def internal_data @internal_data end |
Class Method Details
.from_file(path) ⇒ Lockfile
This method returns nil if the given path doesn’t exists.
Loads a lockfile form the given path.
40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/cocoapods-core/lockfile.rb', line 40 def self.from_file(path) return nil unless path.exist? require 'yaml' hash = YAML.load(File.open(path)) unless hash && hash.is_a?(Hash) raise Informative, "Invalid Lockfile in `#{path}`" end lockfile = Lockfile.new(hash) lockfile.defined_in_file = path lockfile end |
.generate(podfile, specs) ⇒ Lockfile
Generates a hash representation of the Lockfile generated from a given Podfile and the list of resolved Specifications. This representation is suitable for serialization.
334 335 336 337 338 339 340 341 342 343 |
# File 'lib/cocoapods-core/lockfile.rb', line 334 def generate(podfile, specs) hash = { 'PODS' => generate_pods_data(specs), 'DEPENDENCIES' => generate_dependencies_data(podfile), 'EXTERNAL SOURCES' => generate_external_sources_data(podfile), 'SPEC CHECKSUMS' => generate_checksums(specs), 'COCOAPODS' => CORE_VERSION } Lockfile.new(hash) end |
Instance Method Details
#==(other) ⇒ Bool
Returns Whether the Podfiles are equal.
58 59 60 |
# File 'lib/cocoapods-core/lockfile.rb', line 58 def ==(other) other && self.to_hash == other.to_hash end |
#checksum(name) ⇒ String, Nil
Returns the checksum for the given Pod.
104 105 106 |
# File 'lib/cocoapods-core/lockfile.rb', line 104 def checksum(name) checksum_data[name] end |
#cocoapods_version ⇒ Version
Returns The version of CocoaPods which generated this lockfile.
153 154 155 |
# File 'lib/cocoapods-core/lockfile.rb', line 153 def cocoapods_version Version.new(internal_data['COCOAPODS']) end |
#dependencies ⇒ Array<Dependency>
It includes only the dependencies explicitly required in the podfile and not those triggered by the Resolver.
Returns the dependencies of the Podfile used for the last installation.
113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/cocoapods-core/lockfile.rb', line 113 def dependencies unless @dependencies data = internal_data['DEPENDENCIES'] || [] @dependencies = data.map do |string| dep = Dependency.from_string(string) dep.external_source = external_sources_data[dep.root_name] dep end end @dependencies end |
#dependency_to_lock_pod_named(name) ⇒ Dependency
The generated dependencies used are by the Resolver from upgrading a Pod during an installation.
Generates a dependency that requires the exact version of the Pod with the given name.
138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/cocoapods-core/lockfile.rb', line 138 def dependency_to_lock_pod_named(name) dep = dependencies.find { |d| d.name == name || d.root_name == name } version = version(name) unless dep && version raise StandardError, "Attempt to lock the `#{name}` Pod without an known dependency." end locked_dependency = dep.dup locked_dependency.specific_version = version locked_dependency end |
#detect_changes_with_podfile(podfile) ⇒ Hash{Symbol=>Array[Strings]}
Why do we look for compatibility instead of just comparing if the two dependencies are equal?
Analyzes the Pod::Lockfile and detects any changes applied to the Podfile since the last installation.
For each Pod, it detects one state among the following:
-
added: Pods that weren’t present in the Podfile.
-
changed: Pods that were present in the Podfile but changed:
-
Pods whose version is not compatible anymore with Podfile,
-
Pods that changed their head or external options.
-
-
removed: Pods that were removed form the Podfile.
-
unchanged: Pods that are still compatible with Podfile.
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/cocoapods-core/lockfile.rb', line 230 def detect_changes_with_podfile(podfile) result = {} [ :added, :changed, :removed, :unchanged ].each { |k| result[k] = [] } installed_deps = dependencies.map { |d| dependency_to_lock_pod_named(d.name) } all_dep_names = (dependencies + podfile.dependencies).map(&:name).uniq all_dep_names.each do |name| installed_dep = installed_deps.find { |d| d.name == name } podfile_dep = podfile.dependencies.find { |d| d.name == name } if installed_dep.nil? then key = :added elsif podfile_dep.nil? then key = :removed elsif podfile_dep.compatible?(installed_dep ) then key = :unchanged else key = :changed end result[key] << name end result end |
#inspect ⇒ String
Returns a string representation suitable for debugging.
64 65 66 |
# File 'lib/cocoapods-core/lockfile.rb', line 64 def inspect "#<#{self.class}>" end |
#pod_names ⇒ Array<String>
Returns the names of the installed Pods.
76 77 78 79 |
# File 'lib/cocoapods-core/lockfile.rb', line 76 def pod_names generate_pod_names_and_versions unless @pod_names @pod_names end |
#to_hash ⇒ Hash{String=>Array,Hash,String}
Returns a hash representation of the Lockfile.
287 288 289 290 291 292 293 |
# File 'lib/cocoapods-core/lockfile.rb', line 287 def to_hash hash = {} internal_data.each do |key, value| hash[key] = value unless value.empty? end hash end |
#to_yaml ⇒ String
Empty root keys are discarded.
The YAML string is prettified.
Returns the YAML representation of the Lockfile, used for serialization.
302 303 304 305 306 307 308 309 310 311 |
# File 'lib/cocoapods-core/lockfile.rb', line 302 def to_yaml keys_hint = [ "PODS", "DEPENDENCIES", "EXTERNAL SOURCES", "SPEC CHECKSUMS", "COCOAPODS" ] YAMLConverter.convert_hash(to_hash, keys_hint, "\n\n") end |
#version(pod_name) ⇒ Version, Nil
Returns the version of the given Pod.
89 90 91 92 93 94 |
# File 'lib/cocoapods-core/lockfile.rb', line 89 def version(pod_name) version = pod_versions[pod_name] return version if version root_name = pod_versions.keys.find { |name| Specification.root_name(name) == pod_name } pod_versions[root_name] end |
#write_to_disk(path) ⇒ void
This method returns an undefined value.
Writes the Lockfile to the given path.
263 264 265 266 267 |
# File 'lib/cocoapods-core/lockfile.rb', line 263 def write_to_disk(path) path.dirname.mkpath unless path.dirname.exist? File.open(path, 'w') {|f| f.write(to_yaml) } self.defined_in_file = path end |