-
Notifications
You must be signed in to change notification settings - Fork 0
/
convert.min.py
486 lines (350 loc) · 13.4 KB
/
convert.min.py
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
#################### Configurations ####################
config = {
"filesSearch": [
".html",
".css"
],
"filesIgnore": [
".min"
],
"dirsSearch": [
"examples"
],
"dirsIgnore": [
".",
"packages",
"src",
"dist",
"build",
"source"
],
"suffix": ".min",
"prefix": "_",
"patternCSS": "[\\.\\#]-?([_a-zA-Z]+[_a-zA-Z0-9-]*)\\s*\\{",
"patternHTML": "class[\t]*=[\t]*\"[^\"]+",
"patternCSSClear": "\\/\\*.*\\*\\/",
"patternHTMLClear": "[^><a-zA-Z0-9\"',._-] ( *)|(<!--(.*?)-->)",
"patternHTMLLinks": "(?<=<link).*(?<=href..)(?!http)(\\S+)(?=\"|\\')",
"patternHTMLLinksAlt": "(?<=<link)(.href=\"|\\')(?!http)(\\S+)(?=\"|\\')",
"patternHTMLHead": "<head>(?:.|\\n|\\r)+?</head>",
"hashLength": 6,
"overwriteFiles": True,
"minimize": True,
"console": True
}
#################### Utils ####################
import json
import sys
import os
import random
import re
import string
from os.path import isfile, join
def confirmPath(path):
"""Confirm if a path is a valid directory path.
Args:
path (str): path to dir
Raises:
OSError: if path is not dir or does not exists
Returns:
string: the same path, if valid
"""
if not os.path.isdir(path):
raise OSError(
f'{path}: Path is not a directory path or it does not exists.')
return path
def confirmFile(path):
"""Confirm if a path is a valid file path.
Args:
path (str): path to file
Raises:
OSError: if path is not file or does not exists
Returns:
str: the same path, if valid
"""
if not os.path.isfile(path):
raise OSError(
f'{path}: Path is not a file path or it does not exists.')
return path
def loadConfig():
"""Initialize the config.json file and config var
Returns:
dict: config dictionary
"""
# Side tweak to fix file path for testing (and running script and build docs)
if not 'src' == os.path.basename(sys.path[0]):
_localdir = os.path.join(sys.path[0], 'src')
else:
_localdir = sys.path[0]
# if there is no config file (then it's .min), get the global config var for converter.min.py
if not os.path.exists(os.path.join(_localdir, 'config.json')):
global config
else:
# Load config.json
with open(f"{os.path.join(_localdir, 'config.json')}") as json_data_file:
config = json.load(json_data_file)
return config
def loadPath(path=''):
"""Loads the PATH to the dir with the files to convert
Args:
path (str, optional): path of the dir (in config.json defaults to 'examples'). Defaults to ''.
Returns:
str: the path of the dir to convert the files
"""
# Doesn't need load for the config in main loads in the global scope
# But it does have to put on the tests
config = loadConfig()
if path:
_PATH = confirmPath(path)
else:
# Configure the PATH arg to run the script on
if config["dirsSearch"]:
_PATH = os.path.join(os.getcwd(), str(config["dirsSearch"][0]))
else:
_PATH = os.getcwd()
return _PATH
def read(file):
"""Basic functions to read contents of files.
Args:
file (str): path of the file
Returns:
list: lines of the file
"""
if confirmFile(file):
with open(file, "r") as f:
lines = f.readlines()
f.close()
return lines
def write(root, new_name, lines):
"""Basic functions to write in a file.
Args:
root (str): path of the root for the file
new_name (str): new name of the file
lines (list): list of the string to write
"""
if confirmPath(root):
with open(os.path.join(root, new_name), "w") as exf:
exf.writelines(lines)
exf.close()
def getVars(file):
"""Get and prepare the vars to use for a single file;
Being the name, extension, new name and content (based on the proper regex) on the file.
Args:
file (str): path to the file
Returns:
tuple: (new_name, classes_file)
- new_name (str): the new name with the minifier extension
- classes_file (list): the content of the file extracted from the regex
"""
if confirmFile(file):
# Get the extension and use as a flag e.g.: HTML, CSS...
ext = os.path.splitext(file)[1].replace('.', '')
filename = os.path.basename(file)
onlyName = filename.split('.')[0]
type_file = ext.upper()
lines = read(file)
# Use the right regex to find the classes on the file
classes_file = re.findall(config["pattern" + type_file], str(lines))
if not '.min' in filename:
new_name = onlyName + config["suffix"] + '.' + ext
else:
raise Exception(f'file: {filename} is a .min file')
return new_name, classes_file
def lookFiles(path):
"""Look for the files to convert. Find all files with matching extensions out of config.json
- Use _PATH as the root.
- Ignore the dirs as specified in config['dirsIgnore']
- Select files with extensions as specified in config['filesSearch']
- Ignore files with extensions as specified in config['filesIgnore']
Args:
path (str): path to convert the files
Returns:
list: list of tuples [(root, file)] of all the files founded (given the extension on config.json)
"""
_PATH = confirmPath(path)
search_files = []
# Look for files
for root, subdirectories, files in os.walk(_PATH):
# Comprehension to break outer loop
if any(
[dirsIgnore for dirsIgnore in config["dirsIgnore"] if dirsIgnore in root]
):
continue
# And all its files
for index, file in enumerate(files):
for filesSearch in config["filesSearch"]:
for filesIgnore in config["filesIgnore"]:
if filesSearch in file and filesIgnore not in file:
search_files.append((root, file))
return search_files
def getFiles(search_files, extension):
"""Get the list of files, separate and filter them by the extension and returns a tuple of (root, file)
Args:
search_files (list): list of all files searched
extension (str): extension type
Returns:
list: list of tuples [(root, file)] of the selected extension
- root (str): root path for the file (without the filename)
- file (str): filename
"""
type_files = [
(root, file) for root, file in search_files if file.endswith(extension)
]
return type_files
def cssHash(search_files):
"""Hash the css classes and return a tuple
Args:
search_files (list): list of all files founded
Returns:
tuple: (classes_dict, css_files, count)
- classes_dict (list): list of dicts ({class: hashed}) of the hashed css classes
- css_files (list): list of tuples ([(root, file)]) of css files
- count (int): counter of the files altered
"""
classes_dict = {}
count = 0
# Get all the files with the '.css' extension
css_files = getFiles(search_files, ".css")
# Copy the files of the search
for root, file_name in css_files:
lines = read(os.path.join(root, file_name))
new_name, classes = getVars(os.path.join(root, file_name))
# If the file doesn't exist, create a new one
if config["overwriteFiles"] or not isfile(join(root, new_name)):
# Create the dictionary with the classes hashes of the CSS
for css_class in classes:
name_hash_file = "-".join([file_name, css_class])
hash_number = ""
for _ in range(config["hashLength"]):
hash_number += str(
"".join(
random.choice(
string.ascii_uppercase
+ string.ascii_lowercase
+ string.digits
)
)
)
classes_dict.update({name_hash_file: hash_number})
# CSS WRITE
# Copy the hashes to the copied lines of the file
for index, single_line in enumerate(lines):
for key, value in classes_dict.items():
key = key.split("-", 1)[1]
if key in single_line:
single_line = single_line.replace(
key, config["prefix"] + value)
if config["minimize"]:
single_line = re.sub(
config["patternCSSClear"], "", str(single_line)
).strip()
lines[index] = "".join(single_line.split())
else:
lines[index] = single_line
write(root, new_name, lines)
count += 1
if config["console"]:
print(f"{10*'*'} \t {new_name.split('/')[-1]} \t {10*'*'}")
# If it exists, pass
else:
print(f"!! file already existed: {new_name}")
return classes_dict, css_files, count
def htmlHash(search_files, classes_dict, css_files):
"""Hash the html files and return a count of files altered
Args:
search_files (list): list of all files founded
classes_dict (list): list of dicts ({class: hashed}) of the hashed css classes
css_files (list): list of tuples ([(root, file)]) of css files
Returns:
int: count of the html files altered
"""
count = 0
# Overwrite HTML classes
html_files = getFiles(search_files, ".html")
# Copy the files of the search
for root, file_name in html_files:
lines = read(os.path.join(root, file_name))
new_name, substring = getVars(os.path.join(root, file_name))
# HTML WRITE
# HTML overwrite link tags
if config["overwriteFiles"] or not isfile(join(root, new_name)):
css_found = set()
# Search only the files (set) contained by the html
for index, single_line in enumerate(lines):
# look only the head lines - 'in' for minimized files
if "</head>" in single_line:
break
for _, css_file_name in css_files:
# if css_file_name in single_line and 'link' in single_line:
if css_file_name in single_line:
class_strip_name = re.findall(
config["patternHTMLLinks"], str(single_line)
)[0].split("/")[-1]
css_found.add(class_strip_name)
single_line = single_line.replace(
css_file_name,
f"{css_file_name.split('.')[0]}{config['suffix']}.css",
)
lines[index] = single_line
# Overwrite html lines with the hashed css classes
for index, single_line in enumerate(lines):
temp_dict = {}
for key, value in classes_dict.items():
if key.split("-")[0] in css_found:
temp_dict.update({key: value})
for key, value in temp_dict.items():
css_class = key.split("-", 1)[1]
if css_class in single_line:
single_line = single_line.replace(
css_class, config["prefix"] + value
)
if config["minimize"]:
lines[index] = re.sub(
config["patternHTMLClear"], "", str(single_line)
).strip()
else:
lines[index] = single_line
write(root, new_name, lines)
count += 1
if config["console"]:
print(f"{10*'*'} \t {new_name.split('/')[-1]} \t {10*'*'}")
# If it exists, pass
else:
print(f"!! file already existed: {new_name}")
return count
#################### Converter ####################
import os
import sys
def main(args):
"""Main function to run the script.
More details explained on the `functions` docs
"""
# Load config before path for the global variable scope
config = loadConfig()
if args:
_PATH = loadPath(args[0])
else:
_PATH = loadPath()
_PATH = os.path.realpath(_PATH)
search_files = lookFiles(_PATH)
if search_files:
if config["console"]:
# print(f'files: {search_files}\n')
print("CSS Hashfy found files:", end="\n\n")
for root, file in search_files:
print(os.path.join(root, file))
print()
print("Starting hashing...", end="\n\n")
# Initializing algo vars
classes_dict, css_files, css_count = cssHash(search_files)
html_count = htmlHash(search_files, classes_dict, css_files)
if config["console"]:
print()
print(
f"finished! {str(int((html_count + css_count)/len(search_files))*100)}% done."
)
else:
print("!!! No files found!")
################ Main ################
if __name__ == "__main__":
main(sys.argv[1:])