Class: PodBuilder::Command::Build

Inherits:
Object
  • Object
show all
Defined in:
lib/pod_builder/command/build.rb

Class Method Summary collapse

Class Method Details

.add_dependencies(pods, buildable_items) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/pod_builder/command/build.rb', line 177

def self.add_dependencies(pods, buildable_items)
  pods.dup.each do |pod|
    build_configuration = pods.first.build_configuration

    dependencies = pod.dependencies(buildable_items).select { |x| !pods.include?(x) && !pod.has_common_spec(x.name) }
    dependencies.each { |x| x.build_configuration = build_configuration }
    pods = dependencies + pods # dependencies should come first
  end
  
  return pods
end

.call(options) ⇒ Object 



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
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
 
# File 'lib/pod_builder/command/build.rb', line 7

def self.call(options)          
  Configuration.check_inited
  PodBuilder::prepare_basepath

  argument_pods = ARGV.dup

  unless argument_pods.count > 0 
    return false
  end

  check_not_building_subspecs(argument_pods)

  update_repo = options[:update_repos] || false
  installer, analyzer = Analyze.installer_at(PodBuilder::basepath, update_repo)

  all_buildable_items = Analyze.podfile_items(installer, analyzer)
  prebuilt_items = all_buildable_items.select { |x| x.is_prebuilt }
  buildable_items = all_buildable_items - prebuilt_items

  if argument_pods.first == "*"
    argument_pods = buildable_items.map(&:root_name)
  end

  argument_pods.select! { |x| buildable_items.map(&:root_name).include?(x) }
  argument_pods.uniq!

  unless argument_pods.count > 0 
    puts "\n\nNo pods to build found, `#{ARGV.join(" ")}` is/are prebuilt\n".yellow
    puts "\n\n🎉 done!\n".green

    return true
  end

  check_splitted_subspecs_are_static(all_buildable_items, options)
  check_pods_exists(argument_pods, buildable_items)

  pods_to_build = buildable_items.select { |x| argument_pods.include?(x.root_name) }
  pods_to_build += other_subspecs(pods_to_build, buildable_items)

  buildable_items -= pods_to_build

  check_no_common_dependencies(pods_to_build, buildable_items)
  check_not_building_dependency(pods_to_build, buildable_items)

  # Remove dependencies from pods to build
  all_dependencies_name = pods_to_build.map(&:dependency_names).flatten.uniq
  pods_to_build.select! { |x| !all_dependencies_name.include?(x.name) }

  # We need to split pods to build in 3 groups
  # 1. subspecs: because the resulting .framework path is treated differently when added to Configuration.subspecs_to_split
  # 2. pods to build in release
  # 3. pods to build in debug

  pods_to_build_subspecs = pods_to_build.select { |x| x.is_subspec && Configuration.subspecs_to_split.include?(x.name) }
  pods_to_build -= pods_to_build_subspecs
  pods_to_build_debug = pods_to_build.select { |x| x.build_configuration == "debug" }
  pods_to_build_release = pods_to_build - pods_to_build_debug

  check_dependencies_build_configurations(all_buildable_items)

  podfiles_items = pods_to_build_subspecs.map { |x| [x] }
  podfiles_items.push(pods_to_build_debug)
  podfiles_items.push(pods_to_build_release)   

  licenses = []
  
  podfiles_items.select { |x| x.count > 0 }.each do |podfile_items|
    podfile_items = add_dependencies(podfile_items, all_buildable_items)
    podfile_content = Podfile.from_podfile_items(podfile_items, analyzer)
    
    Install.podfile(podfile_content, podfile_items, podfile_items.first.build_configuration)

    licenses += license_specifiers
    
    # remove lockfile which gets unexplicably created
    FileUtils.rm_f(PodBuilder::basepath("Podfile.lock"))
  end

  write_license_files(licenses, all_buildable_items)

  GenerateLFS::call(nil)
  Podspec::generate(analyzer)

  builded_pods = podfiles_items.flatten
  builded_pods_and_deps = add_dependencies(builded_pods, all_buildable_items).select { |x| !x.is_prebuilt }
  Podfile::write_restorable(builded_pods, all_buildable_items, analyzer)     
  if !options.has_key?(:skip_prebuild_update)   
    Podfile::write_prebuilt(all_buildable_items, analyzer)
  end

  Podfile::deintegrate_install

  sanity_checks(options)

  puts "\n\n🎉 done!\n".green
  return true
end

.check_dependencies_build_configurations(pods) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/pod_builder/command/build.rb', line 251

def self.check_dependencies_build_configurations(pods)
  pods.each do |pod|
    pod_dependency_names = pod.dependency_names.select { |x| !pod.has_common_spec(x) }

    remaining_pods = pods - [pod]
    pods_with_common_deps = remaining_pods.select { |x| x.dependency_names.any? { |y| pod_dependency_names.include?(y) && !x.has_common_spec(y) } }
    
    pods_with_unaligned_build_configuration = pods_with_common_deps.select { |x| x.build_configuration != pod.build_configuration }
    pods_with_unaligned_build_configuration.map!(&:name)

    raise "Dependencies of `#{pod.name}` don't have the same build configuration (#{pod.build_configuration}) of `#{pods_with_unaligned_build_configuration.join(",")}`'s dependencies" if pods_with_unaligned_build_configuration.count > 0
  end
end

.check_no_common_dependencies(pods_to_build, buildable_items) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/pod_builder/command/build.rb', line 189

def self.check_no_common_dependencies(pods_to_build, buildable_items)
  pods_to_build.each do |pod_to_build|
    pod_to_build.dependency_names.each do |dependency|
      buildable_items.each do |buildable_pod|
        unless !pod_to_build.dependency_names.include?(buildable_pod.name)
          next
        end

        if buildable_pod.dependency_names.include?(dependency) && !buildable_pod.has_subspec(dependency) && !buildable_pod.has_common_spec(dependency) then
          expected_pod_list = pods_to_build.map(&:root_name).uniq
          raise "\n\nCan't build #{pod_to_build.name} because it has common dependencies (#{dependency}) with #{buildable_pod.name}.\n\nUse `pod_builder build #{expected_pod_list.join(" ")} #{buildable_pod.name}` instead\n\n".red
        end
      end
    end
  end
end

.check_not_building_dependency(pods_to_build, buildable_items) ⇒ Object 



206
207
208
209
210
211
212
213
214
 
# File 'lib/pod_builder/command/build.rb', line 206

def self.check_not_building_dependency(pods_to_build, buildable_items)
  buildable_items_dependencies = buildable_items.map(&:dependency_names).flatten.uniq
  pods_to_build.each do |pod_to_build|
    if buildable_items_dependencies.include?(pod_to_build.name)
      parent = buildable_items.detect { |x| x.dependency_names.include?(pod_to_build.name) }
      raise "\n\nCan't build #{pod_to_build.name} because it is a dependency of #{parent.name}.\n\nUse `pod_builder build #{parent.name}` instead\n\n".red
    end
  end
end

.check_not_building_subspecs(pods_to_build) ⇒ Object 



216
217
218
219
220
221
222
 
# File 'lib/pod_builder/command/build.rb', line 216

def self.check_not_building_subspecs(pods_to_build)
  pods_to_build.each do |pod_to_build|
    if pod_to_build.include?("/")
      raise "\n\nCan't build subspec #{pod_to_build} refer to podspec name.\n\nUse `pod_builder build #{pods_to_build.map { |x| x.split("/").first }.uniq.join(" ")}` instead\n\n".red
    end
  end
end

.check_pods_exists(pods, buildable_items) ⇒ Object 



224
225
226
227
228
229
230
231
 
# File 'lib/pod_builder/command/build.rb', line 224

def self.check_pods_exists(pods, buildable_items)
  raise "Empty Podfile?" if buildable_items.nil?

  buildable_items = buildable_items.map(&:root_name)
  pods.each do |pod|
    raise "\n\nPod `#{pod}` wasn't found in Podfile.\n\nFound:\n#{buildable_items.join("\n")}\n\n".red if !buildable_items.include?(pod)
  end
end

.check_splitted_subspecs_are_static(all_buildable_items, options) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/pod_builder/command/build.rb', line 233

def self.check_splitted_subspecs_are_static(all_buildable_items, options)
  non_static_subspecs = all_buildable_items.select { |x| x.is_subspec && x.is_static == false }
  non_static_subspecs_names = non_static_subspecs.map(&:name)

  invalid_subspecs = Configuration.subspecs_to_split & non_static_subspecs_names # intersect

  unless invalid_subspecs.count > 0
    return
  end

  warn_message = "The following pods `#{invalid_subspecs.join(" ")}` are non static frameworks which are being splitted over different targets. Beware that this is an unsafe setup as per https://github.com/CocoaPods/CocoaPods/issues/5708 and https://github.com/CocoaPods/CocoaPods/issues/5643\n"
  if options[:allow_warnings]
    puts "\n\n⚠️  #{warn_message}".yellow
  else
    raise "\n\n🚨️  #{warn_message}".yellow
  end
end

.license_specifiers ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/pod_builder/command/build.rb', line 107

def self.license_specifiers
  acknowledge_files = Dir.glob("#{PodBuilder::Configuration.build_path}/Pods/**/*acknowledgements.plist")
  raise "Too many acknoledge file found" if acknowledge_files.count > 1

  if acknowledge_file = acknowledge_files.first
    plist = CFPropertyList::List.new(:file => acknowledge_file)
    data = CFPropertyList.native_types(plist.value)
    
    return data["PreferenceSpecifiers"]
  end

  return []
end

.other_subspecs(pods_to_build, buildable_items) ⇒ Object 



265
266
267
268
269
270
271
272
 
# File 'lib/pod_builder/command/build.rb', line 265

def self.other_subspecs(pods_to_build, buildable_items)
  buildable_subspecs = buildable_items.select { |x| x.is_subspec }
  pods_to_build_subspecs = pods_to_build.select { |x| x.is_subspec }.map(&:root_name)

  buildable_subspecs.select! { |x| pods_to_build_subspecs.include?(x.root_name) }

  return buildable_subspecs - pods_to_build
end

.sanity_checks(options) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/pod_builder/command/build.rb', line 274

def self.sanity_checks(options)
  lines = File.read(PodBuilder::project_path("Podfile")).split("\n")
  stripped_lines = lines.map { |x| Podfile.strip_line(x) }.select { |x| !x.start_with?("#")}

  expected_stripped = Podfile::POST_INSTALL_ACTIONS.map { |x| Podfile.strip_line(x) }

  if !expected_stripped.all? { |x| stripped_lines.include?(x) }
    warn_message = "PodBuilder's post install actions missing from application Podfile!\n"
    if options[:allow_warnings]
      puts "\n\n⚠️  #{warn_message}".yellow
    else
      raise "\n\n🚨️  #{warn_message}".red
    end
  end
end

.write_license_files(licenses, all_buildable_items) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/pod_builder/command/build.rb', line 121

def self.write_license_files(licenses, all_buildable_items)
  puts "Writing licenses".yellow
  license_file_path = PodBuilder::project_path(Configuration.license_filename) + ".plist"

  current_licenses = []
  if File.exist?(license_file_path)
    plist = CFPropertyList::List.new(:file => license_file_path)
    dict = CFPropertyList.native_types(plist.value)  
    current_licenses = dict["PreferenceSpecifiers"]          
    current_licenses.shift
    current_licenses.pop
  end

  licenses_header = licenses.shift
  raise "Unexpected license found in header" if licenses_header.has_key?("License")
  license_footer = licenses.pop
  raise "Unexpected license found in footer" if license_footer.has_key?("License")

  lincenses_titles = licenses.map { |x| x["Title"] }
  current_licenses.select! { |x| !lincenses_titles.include?(x["Title"]) }

  licenses += current_licenses # merge with existing license
  licenses.uniq! { |x| x["Title"] }
  licenses.sort_by! { |x| x["Title"] }
  licenses.select! { |x| !Configuration.skip_licenses.include?(x["Title"]) }
  licenses.select! { |x| all_buildable_items.map(&:root_name).include?(x["Title"]) } # Remove items that are no longer included

  license_dict = {}
  license_dict["PreferenceSpecifiers"] = [licenses_header, licenses, license_footer].flatten
  license_dict["StringsTable"] = "Acknowledgements"
  license_dict["Title"] = license_dict["StringsTable"]

  plist = CFPropertyList::List.new
  plist.value = CFPropertyList.guess(license_dict)
  plist.save(license_file_path, CFPropertyList::List::FORMAT_BINARY)

  write_markdown_licenses(license_file_path)
end

.write_markdown_licenses(plist_path) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/pod_builder/command/build.rb', line 160

def self.write_markdown_licenses(plist_path)
  plist = CFPropertyList::List.new(:file => plist_path)
  dict = CFPropertyList.native_types(plist.value)  
  licenses = dict["PreferenceSpecifiers"]
  header = licenses.shift

  markdown = []
  markdown += ["# #{header["Title"]}", header["FooterText"], ""]
  markdown += licenses.map { |x| ["## #{x["Title"]}", x["FooterText"], ""] }

  markdown.flatten!

  markdown_path = plist_path.chomp(File.extname(plist_path)) + ".md"

  File.write(markdown_path, markdown.join("\n"))
end