Class: Pod::Generate::PodfileGenerator
- Inherits:
-
Object
- Object
- Pod::Generate::PodfileGenerator
- Defined in:
- lib/cocoapods/generate/podfile_generator.rb
Overview
Generates podfiles for pod specifications given a configuration.
Instance Attribute Summary collapse
-
#configuration ⇒ Configuration
readonly
The configuration used when generating podfiles.
Instance Method Summary collapse
-
#dependency_compilation_kwargs(pod_name) ⇒ Hash
A hash with “compilation”-related dependency options for the ‘pod` DSL method.
-
#inhibit_all_warnings? ⇒ Boolean
Whether all warnings should be inhibited.
-
#initialize(configuration) ⇒ PodfileGenerator
constructor
A new instance of PodfileGenerator.
- #installation_options ⇒ Object
-
#lockfile_versions ⇒ Hash<String,String>
Versions in the lockfile keyed by pod name.
-
#pod_args_for_dependency(podfile, dependency) ⇒ Hash<String,Array<Dependency>>
Returns the arguments that should be passed to the Podfile DSL’s ‘pod` method for the given podfile and dependency.
-
#podfile_dependencies ⇒ Hash<String,Array<Dependency>>
Dependencies in the podfile grouped by root name.
-
#podfile_for_spec(spec) ⇒ Podfile
A podfile suitable for installing the given spec.
- #podfile_plugins ⇒ Object
-
#podfiles_by_spec ⇒ Hash<Specification, Podfile>
A hash of specifications to generated podfiles.
- #supported_swift_versions ⇒ Object
- #swift_version ⇒ Object
-
#transitive_dependencies_by_pod ⇒ Hash<String,Array<Dependency>>
The transitive dependency objects dependency upon by each pod.
- #transitive_local_dependencies(spec, paths) ⇒ Object
-
#use_modular_headers? ⇒ Boolean
Whether all pods should use modular headers.
Constructor Details
#initialize(configuration) ⇒ PodfileGenerator
Returns a new instance of PodfileGenerator.
13 14 15 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 13 def initialize(configuration) @configuration = configuration end |
Instance Attribute Details
#configuration ⇒ Configuration (readonly)
Returns the configuration used when generating podfiles.
11 12 13 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 11 def configuration @configuration end |
Instance Method Details
#dependency_compilation_kwargs(pod_name) ⇒ Hash
Returns a hash with “compilation”-related dependency options for the ‘pod` DSL method.
197 198 199 200 201 202 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 197 def dependency_compilation_kwargs(pod_name) = {} [:inhibit_warnings] = inhibit_warnings?(pod_name) if inhibit_warnings?(pod_name) != inhibit_all_warnings? [:modular_headers] = modular_headers?(pod_name) if modular_headers?(pod_name) != use_modular_headers? end |
#inhibit_all_warnings? ⇒ Boolean
Returns whether all warnings should be inhibited.
168 169 170 171 172 173 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 168 def inhibit_all_warnings? return false unless configuration.use_podfile? target_definition_list.all? do |target_definition| target_definition.send(:inhibit_warnings_hash)['all'] end end |
#installation_options ⇒ Object
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 299 def = { deterministic_uuids: configuration.deterministic_uuids?, share_schemes_for_development_pods: configuration.share_schemes_for_development_pods?, warn_for_multiple_pod_sources: configuration.warn_for_multiple_pod_sources? } if Pod::Installer::InstallationOptions..include?('generate_multiple_pod_projects') [:generate_multiple_pod_projects] = configuration.generate_multiple_pod_projects? end if Pod::Installer::InstallationOptions..include?('incremental_installation') [:incremental_installation] = configuration.incremental_installation? end end |
#lockfile_versions ⇒ Hash<String,String>
Returns versions in the lockfile keyed by pod name.
243 244 245 246 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 243 def lockfile_versions return {} unless configuration.use_lockfile_versions? @lockfile_versions ||= Hash[configuration.lockfile.pod_names.map { |name| [name, "= #{configuration.lockfile.version(name)}"] }] end |
#pod_args_for_dependency(podfile, dependency) ⇒ Hash<String,Array<Dependency>>
Returns the arguments that should be passed to the Podfile DSL’s ‘pod` method for the given podfile and dependency
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 256 def pod_args_for_dependency(podfile, dependency) dependency = podfile_dependencies[dependency.root_name] .map { |dep| dep.dup.tap { |d| d.name = dependency.name } } .push(dependency) .reduce(&:merge) = dependency_compilation_kwargs(dependency.name) [:source] = dependency.podspec_repo if dependency.podspec_repo .update(dependency.external_source) if dependency.external_source %i[path podspec].each do |key| next unless (path = [key]) [key] = Pathname(path) .(configuration.podfile.defined_in_file.dirname) .relative_path_from(podfile.defined_in_file.dirname) .to_s end args = [dependency.name] if dependency.external_source.nil? requirements = dependency.requirement.as_list if (version = lockfile_versions[dependency.name]) requirements << version end args.concat requirements.uniq end args << unless .empty? args end |
#podfile_dependencies ⇒ Hash<String,Array<Dependency>>
Returns dependencies in the podfile grouped by root name.
235 236 237 238 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 235 def podfile_dependencies return {} unless configuration.use_podfile? @podfile_dependencies ||= configuration.podfile.dependencies.group_by(&:root_name).tap { |h| h.default = [] } end |
#podfile_for_spec(spec) ⇒ Podfile
Returns a podfile suitable for installing the given spec.
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 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 137 138 139 140 141 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 30 def podfile_for_spec(spec) generator = self dir = configuration.gen_dir_for_pod(spec.name) Pod::Podfile.new do project "#{spec.name}.xcodeproj" workspace "#{spec.name}.xcworkspace" plugin 'cocoapods-generate' install! 'cocoapods', generator. generator.podfile_plugins.each do |name, | plugin(*[name, ].compact) end use_frameworks!(generator.configuration.use_frameworks?) if (supported_swift_versions = generator.supported_swift_versions) supports_swift_versions(supported_swift_versions) end # Explicitly set sources generator.configuration.sources.each do |source_url| source(source_url) end self.defined_in_file = dir.join('CocoaPods.podfile.yaml') test_specs = spec.recursive_subspecs.select(&:test_specification?) app_specs = if spec.respond_to?(:app_specification?) spec.recursive_subspecs.select(&:app_specification?) else [] end # Stick all of the transitive dependencies in an abstract target. # This allows us to force CocoaPods to use the versions / sources / external sources # that we want. # By using an abstract target, abstract_target 'Transitive Dependencies' do pods_for_transitive_dependencies = [spec.name] .concat(test_specs.map(&:name)) .concat(test_specs.flat_map { |ts| ts.dependencies.flat_map(&:name) }) .concat(app_specs.map(&:name)) .concat(app_specs.flat_map { |as| as.dependencies.flat_map(&:name) }) dependencies = generator .transitive_dependencies_by_pod .values_at(*pods_for_transitive_dependencies) .compact .flatten(1) .uniq .sort_by(&:name) .reject { |d| d.root_name == spec.root.name } dependencies.each do |dependency| pod_args = generator.pod_args_for_dependency(self, dependency) pod(*pod_args) end end # Add platform-specific concrete targets that inherit the # `pod` declaration for the local pod. spec_platform_names = spec.available_platforms.map(&:string_name).flatten.each.reject do |platform_name| !generator.configuration.platforms.nil? && !generator.configuration.platforms.include?(platform_name.downcase) end spec_platform_names.sort.each do |platform_name| target "App-#{platform_name}" do current_target_definition.swift_version = generator.swift_version if generator.swift_version end end # this block has to come _before_ inhibit_all_warnings! / use_modular_headers!, # and the local `pod` declaration current_target_definition.instance_exec do transitive_dependencies = children.find { |c| c.name == 'Transitive Dependencies' } %w[use_modular_headers inhibit_warnings].each do |key| value = transitive_dependencies.send(:internal_hash).delete(key) next if value.blank? set_hash_value(key, value) end end inhibit_all_warnings! if generator.inhibit_all_warnings? use_modular_headers! if generator.use_modular_headers? # This is the pod declaration for the local pod, # it will be inherited by the concrete target definitions below = generator.dependency_compilation_kwargs(spec.name) [:path] = spec.defined_in_file.relative_path_from(dir).to_s { testspecs: test_specs, appspecs: app_specs }.each do |key, specs| [key] = specs.map { |s| s.name.sub(%r{^#{Regexp.escape spec.root.name}/}, '') }.sort unless specs.empty? end pod spec.name, ** # Implement local-sources option to set up dependencies to podspecs in the local filesystem. next if generator.configuration.local_sources.empty? generator.transitive_local_dependencies(spec, generator.configuration.local_sources).each do |dependency, podspec_file| = generator.dependency_compilation_kwargs(dependency.name) [:path] = if podspec_file[0] == '/' # absolute path podspec_file else '../../' + podspec_file end pod dependency.name, ** end end end |
#podfile_plugins ⇒ Object
317 318 319 320 321 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 317 def podfile_plugins configuration.podfile_plugins.merge('cocoapods-disable-podfile-validations' => { 'no_abstract_only_pods' => true }) do |_key, old_value, new_value| old_value.merge(new_value) end end |
#podfiles_by_spec ⇒ Hash<Specification, Podfile>
Returns a hash of specifications to generated podfiles.
20 21 22 23 24 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 20 def podfiles_by_spec Hash[configuration.podspecs.map do |spec| [spec, podfile_for_spec(spec)] end] end |
#supported_swift_versions ⇒ Object
288 289 290 291 292 293 294 295 296 297 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 288 def supported_swift_versions return unless configuration.use_podfile? return if target_definition_list.empty? return unless target_definition_list.first.respond_to?(:swift_version_requirements) target_definition_list.reduce(nil) do |supported_swift_versions, target_definition| target_swift_versions = target_definition.swift_version_requirements next supported_swift_versions unless target_swift_versions Array(target_swift_versions) | Array(supported_swift_versions) end end |
#swift_version ⇒ Object
284 285 286 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 284 def swift_version @swift_version ||= target_definition_list.map(&:swift_version).compact.max end |
#transitive_dependencies_by_pod ⇒ Hash<String,Array<Dependency>>
Returns the transitive dependency objects dependency upon by each pod.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 207 def transitive_dependencies_by_pod return {} unless configuration.use_lockfile? @transitive_dependencies_by_pod ||= begin lda = ::Pod::Installer::Analyzer::LockingDependencyAnalyzer dependency_graph = Molinillo::DependencyGraph.new configuration.lockfile.dependencies.each do |dependency| dependency_graph.add_vertex(dependency.name, dependency, true) end add_to_dependency_graph = if lda.method(:add_to_dependency_graph).parameters.size == 4 # CocoaPods < 1.6.0 ->(pod) { lda.add_to_dependency_graph(pod, [], dependency_graph, []) } else ->(pod) { lda.add_to_dependency_graph(pod, [], dependency_graph, [], Set.new) } end configuration.lockfile.internal_data['PODS'].each(&add_to_dependency_graph) transitive_dependencies_by_pod = Hash.new { |hash, key| hash[key] = [] } dependency_graph.each do |v| transitive_dependencies_by_pod[v.name].concat v.recursive_successors.map(&:payload) << v.payload end transitive_dependencies_by_pod.each_value(&:uniq!) transitive_dependencies_by_pod end end |
#transitive_local_dependencies(spec, paths) ⇒ Object
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 143 def transitive_local_dependencies(spec, paths) dependencies = spec.dependencies return_list = [] dependencies.each do |dependency| found_podspec_file = nil name = dependency.name.split('/')[0] paths.each do |path| podspec_file = path + '/' + name + '.podspec' next unless File.file?(podspec_file) found_podspec_file = podspec_file break end next unless found_podspec_file return_list << [dependency, found_podspec_file] dep_spec = Pod::Specification.from_file(found_podspec_file) dep_spec.dependencies.each do |d_dep| dependencies << d_dep unless dependencies.include? d_dep end end return_list end |
#use_modular_headers? ⇒ Boolean
Returns whether all pods should use modular headers.
178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/cocoapods/generate/podfile_generator.rb', line 178 def use_modular_headers? if configuration.use_podfile? && configuration.use_modular_headers? raise Informative, 'Conflicting `use_modular_headers` option. Cannot specify both `--use-modular-headers` and `--use-podfile`.' end if configuration.use_podfile? target_definition_list.all? do |target_definition| target_definition.use_modular_headers_hash['all'] end else configuration.use_modular_headers? end end |