-
Notifications
You must be signed in to change notification settings - Fork 7
/
cocoapod-to-cordova.rb
270 lines (245 loc) · 8.92 KB
/
cocoapod-to-cordova.rb
1
2
3
4
5
6
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
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
require 'rexml/document'
# Public CocoapodToCordovaBuilder: Helps to build an Plugman compatible Apache
# Cordova plugin.
#
# Examples
#
# build = CocoapodToCordovaBuilder.new('MyPod', my_xcode_project)
# build.root_path = File.expand_path(File.join('.', '..'))
# build.destination = "src/ios/vendor"
# build.update_plugin!
class CocoapodToCordovaBuilder
attr_accessor :config
attr_reader :target, :plugin_xml
attr_writer :destination, :sourced_attribute, :root_path
# Public: initialize - setup a new plugin builder.
#
# pod_name - string that is the exact name of the pod specified in the podfile
# xcode_project - See: https://github.com/CocoaPods/Xcodeproj
# The xcode_project object that is passed into the post_install
# hook in a cocoapod podfile.
#
# Examples
#
# In podfile~
# post_install |installer| do
# build = PluginmanCocoapodBuilder.new('podName', installer.project)
# end
#
# returns an instance of this class ready to be configured
# raises an error if the xcode_project doesn't contain a target for the pod
def initialize(pod_name, xcode_project)
@config = {}
@pod_name = pod_name
@target = xcode_project.targets
.find{|t| t.display_name == "Pods-#{@pod_name}"}
return raise "Could not find a build target in xcodeproj" unless target
end
# Public: root_path - Set the root_path of the project. This is the same
# directory where the plugin.xml file is located
#
# setter - A string representing the path to the directory with plugin.xml
#
# Examples
#
# build.root_path = "~/Workspace/cordova-plugin"
#
def root_path
@root_path ||= File.expand_path(File.join('.', '../..'))
end
# Public: desination - The build output directory. Usually 'src/ios/vendor'
#
# setter - A string representing the build output path. The path is
# relative sub directory of the root_path of the project.
#
# Examples
#
# build.destination = 'src/ios/my-pod-source'
#
def destination
@destination ||= 'src/ios/vendor'
end
# Public: configure - configures the build process.
#
# options - a hash of configuration options
#
# Examples
#
# build.configure({
# product: { name: 'libmypod.a', sub_dir: 'lib'},
# localization: 'es',
# headers: { exclude: ['header-1.h', 'header-5.h'] },
# resources: { sub_dir: 'assets' }
# })
#
def configure(options)
@config.merge!(options) if options.is_a? Hash
end
# Public: update_plugin! - runs the build tool. Will overwrite previously
# written elements in plugin.xml and setup extra build phases in
# the xcode_project. Copies files to their destination. This will
# not build / compile the xcodeproject. To do that, run `make build`
#
# Examples
#
# build.update_plugin!
#
def update_plugin!
reset_xml
include_frameworks @config[:frameworks] || {}
include_headers @config[:headers] || {}
resource_options = @config[:resources] || {}
resource_options[:localization] = @config[:localization] if @config[:localization]
include_resources resource_options
include_product @config[:product] || {}
write_plugin_xml! @config[:plugin_xml]
write_build_target_file!
end
private
def include_product(options={})
options[:sub_dir] ||= ''
original_product_name = File.basename(@target.product_reference.path)
new_product_name = options[:name] || original_product_name
original_product_path = File.join(dst_path, @target.product_reference.path)
copy_to_product_path = File.join(dst_path, options[:sub_dir], original_product_name)
new_product_path = File.join(dst_path, options[:sub_dir], new_product_name)
new_product_path_relative = File.join(destination, options[:sub_dir], new_product_name)
if copy_files?(options)
copy_phase = create_new_copy_files_build_phase(File.dirname(copy_to_product_path))
copy_phase.add_file_reference(@target.product_reference)
end
if write_xml?(options)
ios_xml_element.add_element(pod_element 'source-file',
{'framework' => 'true',
'src' => new_product_path_relative})
end
if new_product_path != original_product_path
shell_phase = @target.new_shell_script_build_phase
shell_phase.show_env_vars_in_log = "0"
shell_phase.shell_script = "mv #{copy_to_product_path} #{new_product_path}"
end
File.open('product_path.txt', 'w') do |f|
f.puts new_product_path
end
end
def include_headers(options = {})
options[:sub_dir] ||= 'headers'
excluded_files = options[:exclude] || []
if copy_files?(options)
copy_phase = create_new_copy_files_build_phase(File.join(dst_path, options[:sub_dir]))
end
@target.headers_build_phase.files.each do |header|
header_name = File.basename(header.file_ref.path)
unless excluded_files.include?(header_name)
if write_xml?(options)
header_path = File.join(destination,
options[:sub_dir],
header_name)
ios_xml_element.add_element(pod_element('header-file',
{'src' => header_path}))
end
if copy_files?(options)
copy_phase.add_file_reference(header.file_ref)
end
end
end
end
def include_frameworks(options={})
excluded_files = options[:exclude] || []
@target.frameworks_build_phase.files.each do |framework|
unless excluded_files.include?(framework.display_name)
ios_xml_element.add_element(pod_element 'framework',
{'src' => framework.display_name})
end
end
end
# Cordova will fail on when adding plugins that contain a filename that allready
# exists inside the project. This always happens with *.lproj files.
def include_resources(options={})
options[:sub_dir] ||= 'resources'
options[:localization] ||= 'en'
excluded_files = options[:exclude] || []
resource_group = target.project.pod_group(@pod_name)
.groups
.find{|g| g.display_name == "Resources"}
resource_files = []
if resource_group
resource_files = resource_group.files
.reject{|f| excluded_files.include?(f.display_name)}
end
if copy_files?(options)
copy_resources = create_new_copy_files_build_phase(File.join(dst_path, options[:sub_dir]))
end
resource_files.each do |resource|
if write_xml?(options)
res_path = File.join(destination, options[:sub_dir], resource.display_name)
if resource.display_name.end_with?('.lproj')
if resource.display_name == "#{options[:localization]}.lproj"
resource.real_path.each_child do |localization_file|
localization_path = File.join(res_path, File.basename(localization_file))
ios_xml_element.add_element(pod_element('resource-file',
{'src' => localization_path}))
end
end
else
ios_xml_element.add_element(pod_element('resource-file', {'src' => res_path}))
end
end
if copy_files?(options)
copy_resources.add_file_reference(resource)
end
end
end
def reset_xml
ios_xml_element.each_element_with_attribute(sourced_attribute, "true") do |h|
h.remove
end
end
def write_plugin_xml!(out_name=nil)
out_name ||= 'plugin.xml'
File.open(File.join(root_path, out_name), 'w') do |file|
plugin_xml.write(file, 2)
end
end
# This doesn't work from inside the post_install callback. The xcode
# project is not build yet. Instead we write the target and use the shell.
# def exec_xcodebuild!
# exec("cd Pods && xcodebuild -target #{@target.display_name} && cd ..")
# end
def write_build_target_file!
File.open('build_target_name.txt', 'w') do |f|
f.puts @target.display_name
end
end
def sourced_attribute
@sourced_attribute ||= 'autogen'
end
# Setup paths
def dst_path
@dst_path ||= File.join(root_path, destination)
end
def plugin_xml
@plugin_xml ||= REXML::Document.new(File.new(File.join(root_path, 'plugin.xml')))
end
def ios_xml_element
@ios_xml_element ||= REXML::XPath.first(plugin_xml, "//platform[@name='ios']")
end
def copy_files?(options)
options[:copy_files] != false
end
def write_xml?(options)
options[:write_xml] != false
end
def create_new_copy_files_build_phase(copy_to_path)
copy_phase = @target.new_copy_files_build_phase
copy_phase.dst_subfolder_spec = nil
copy_phase.dst_path = copy_to_path
copy_phase
end
def pod_element(tag_name, attrs={})
attrs[sourced_attribute] = "true"
element = REXML::Element.new(tag_name)
element.add_attributes(attrs)
element
end
end