Class: Flr::CodeUtil

Inherits:
Object
  • Object
show all
Defined in:
lib/flr/util/code_util.rb

Overview

代码生成相关的工具类方法

Class Method Summary collapse

Class Method Details

.generate__R_FontFamily_class(font_family_config_array, package_name) ⇒ Object

generate__R_FontFamily_class(font_family_config_array, package_name) -> string

根据模板，为 font_family_config_array（字体家族配置数组）生成 _R_FontFamily class 的代码



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/flr/util/code_util.rb', line 533

def self.generate__R_FontFamily_class(font_family_config_array, package_name)

  all_g_AssetResource_property_code = ""

  font_family_config_array.each do |font_family_config|
    all_g_AssetResource_property_code += "\n"

    font_family_name = font_family_config["family"]

    font_family_id = generate_font_family_id(font_family_name)
    font_family_comment = "font family: #{font_family_name}"

    g_AssetResource_property_code = "  /// \#{font_family_comment}\n  // ignore: non_constant_identifier_names\n  final \#{font_family_id} = \"\#{font_family_name}\";\n    CODE\n\n    all_g_AssetResource_property_code += g_AssetResource_property_code\n  end\n\n  code = <<-CODE\n/// This `_R_FontFamily` class is generated and contains references to static font asset resources.\n// ignore: camel_case_types\nclass _R_FontFamily {\n  const _R_FontFamily();\n\#{all_g_AssetResource_property_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name, is_package_project_type) ⇒ Object

generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name, is_package_project_type) -> string

根据模板，为 non_svg_image_asset_array（非svg类的图片资产数组）生成 _R_Image_AssetResource class 的代码



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/flr/util/code_util.rb', line 305

def self.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name, is_package_project_type)

  all_g_AssetResource_property_code = ""

  non_svg_image_asset_array.each do |image_asset|
    all_g_AssetResource_property_code += "\n"
    g_AssetResource_property_code = generate_AssetResource_property(image_asset, non_svg_image_asset_id_dict, package_name, is_package_project_type, Flr::PRIOR_NON_SVG_IMAGE_FILE_TYPE)
    all_g_AssetResource_property_code += g_AssetResource_property_code
  end

  code = "// ignore: camel_case_types\nclass _R_Image_AssetResource {\n  const _R_Image_AssetResource();\n\#{all_g_AssetResource_property_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Image_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name) ⇒ Object

generate__R_Image_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name) -> string

根据模板，为 non_svg_image_asset_array（非svg类的图片资产数组）生成 _R_Image class 的代码



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
 
# File 'lib/flr/util/code_util.rb', line 380

def self.generate__R_Image_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name)

  all_g_Asset_method_code = ""

  non_svg_image_asset_array.each do |image_asset|
    all_g_Asset_method_code += "\n"

    asset_id = non_svg_image_asset_id_dict[image_asset]
    asset_comment = generate_asset_comment(image_asset, package_name)

    g_Asset_method_code = "  /// \#{asset_comment}\n  // ignore: non_constant_identifier_names\n  AssetImage \#{asset_id}() {\nreturn AssetImage(asset.\#{asset_id}.keyName);\n  }\n    CODE\n\n    all_g_Asset_method_code += g_Asset_method_code\n  end\n\n  code = <<-CODE\n/// This `_R_Image` class is generated and contains references to static non-svg type image asset resources.\n// ignore: camel_case_types\nclass _R_Image {\n  const _R_Image();\n\n  final asset = const _R_Image_AssetResource();\n\#{all_g_Asset_method_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict, package_name, is_package_project_type) ⇒ Object

generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict, package_name, is_package_project_type) -> string

根据模板，为 svg_image_asset_array（svg类的图片资产数组）生成 _R_Svg_AssetResource class 的代码



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/flr/util/code_util.rb', line 330

def self.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict, package_name, is_package_project_type)

  all_g_AssetResource_property_code = ""

  svg_image_asset_array.each do |image_asset|
    all_g_AssetResource_property_code += "\n"
    g_AssetResource_property_code = generate_AssetResource_property(image_asset, svg_image_asset_id_dict, package_name, is_package_project_type, Flr::PRIOR_SVG_IMAGE_FILE_TYPE)
    all_g_AssetResource_property_code += g_AssetResource_property_code
  end

  code = "// ignore: camel_case_types\nclass _R_Svg_AssetResource {\n  const _R_Svg_AssetResource();\n\#{all_g_AssetResource_property_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Svg_class(svg_image_asset_array, svg_image_asset_id_dict, package_name) ⇒ Object

generate__R_Svg_class(svg_image_asset_array, svg_image_asset_id_dict, package_name) -> string

根据模板，为 svg_image_asset_array（svg类的图片资产数组）生成 _R_Svg class 的代码



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
 
# File 'lib/flr/util/code_util.rb', line 419

def self.generate__R_Svg_class(svg_image_asset_array, svg_image_asset_id_dict, package_name)

  all_g_Asset_method_code = ""

  svg_image_asset_array.each do |image_asset|
    all_g_Asset_method_code += "\n"

    asset_id = svg_image_asset_id_dict[image_asset]
    asset_comment = generate_asset_comment(image_asset, package_name)

    g_Asset_method_code = "  /// \#{asset_comment}\n  // ignore: non_constant_identifier_names\n  AssetSvg \#{asset_id}({@required double width, @required double height}) {\nfinal imageProvider = AssetSvg(asset.\#{asset_id}.keyName, width: width, height: height);\nreturn imageProvider;\n  }\n    CODE\n\n    all_g_Asset_method_code += g_Asset_method_code\n  end\n\n  code = <<-CODE\n/// This `_R_Svg` class is generated and contains references to static svg type image asset resources.\n// ignore: camel_case_types\nclass _R_Svg {\n  const _R_Svg();\n\n  final asset = const _R_Svg_AssetResource();\n\#{all_g_Asset_method_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name, is_package_project_type) ⇒ Object

generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name, is_package_project_typ) -> string

根据模板，为 text_asset_array（文本资产数组）生成 _R_Text_AssetResource class 的代码



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/flr/util/code_util.rb', line 355

def self.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name, is_package_project_type)

  all_g_AssetResource_property_code = ""

  text_asset_array.each do |text_asset|
    all_g_AssetResource_property_code += "\n"
    g_AssetResource_property_code = generate_AssetResource_property(text_asset, text_asset_id_dict, package_name, is_package_project_type, Flr::PRIOR_TEXT_FILE_TYPE)
    all_g_AssetResource_property_code += g_AssetResource_property_code
  end

  code = "// ignore: camel_case_types\nclass _R_Text_AssetResource {\n  const _R_Text_AssetResource();\n\#{all_g_AssetResource_property_code}\n}\n  CODE\n\n  return code\nend\n"

.generate__R_Text_class(text_asset_array, text_asset_id_dict, package_name) ⇒ Object

generate__R_Text_class(text_asset_array, text_asset_id_dict, package_name) -> string

根据模板，为 text_asset_array（文本资产数组）生成 _R_Text class 的代码



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
485
486
487
488
489
490
491
492
493
 
# File 'lib/flr/util/code_util.rb', line 459

def self.generate__R_Text_class(text_asset_array, text_asset_id_dict, package_name)

  all_g_Asset_method_code = ""

  text_asset_array.each do |text_asset|
    all_g_Asset_method_code += "\n"

    asset_id = text_asset_id_dict[text_asset]
    asset_comment = generate_asset_comment(text_asset, package_name)

    g_Asset_method_code = "  /// \#{asset_comment}\n  // ignore: non_constant_identifier_names\n  Future<String> \#{asset_id}() {\nfinal str = rootBundle.loadString(asset.\#{asset_id}.keyName);\nreturn str;\n  }\n    CODE\n\n    all_g_Asset_method_code += g_Asset_method_code\n  end\n\n  code = <<-CODE\n/// This `_R_Text` class is generated and contains references to static text asset resources.\n// ignore: camel_case_types\nclass _R_Text {\n  const _R_Text();\n\n  final asset = const _R_Text_AssetResource();\n\#{all_g_Asset_method_code}\n}\n  CODE\n\n  return code\nend\n"

.generate_asset_comment(asset, package_name) ⇒ Object

generate_asset_comment (asset, package_name) -> string

为当前asset生成注释

Examples

package_name = “flutter_r_demo”

Example-1

asset = “packages/flutter_r_demo/assets/images/test.png” asset_comment = “asset: lib/assets/images/test.png”

Example-2

asset = “assets/images/test.png” asset_comment = “asset: assets/images/test.png”



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/flr/util/code_util.rb', line 223

def self.generate_asset_comment (asset, package_name)
  packages_prefix = "packages/#{package_name}/"

  if asset =~ /\A#{packages_prefix}/
    # asset: packages/flutter_r_demo/assets/images/test.png
    # to get assetName: assets/images/test.png
    asset_name = asset.dup
    asset_name[packages_prefix] = ""

    asset_comment = "asset: lib/#{asset_name}"
    return asset_comment
  else
    # asset: assets/images/test.png
    # to get assetName: assets/images/test.png
    asset_name = asset.dup

    asset_comment = "asset: #{asset_name}"
    return asset_comment
  end

end

.generate_asset_id(asset, used_asset_id_array, prior_asset_type = ".*") ⇒ Object

generate_asset_id (asset, used_asset_id_array, prior_asset_type) -> string

  • prior_asset_type: 优先的资源类型；默认值为 “.*”，意味当前不存在任何优先的资源类型

为当前 asset 生成 asset_id（资产ID）；asset_id 一般为 asset 的 file_basename_no_extension；但是为了保证 asset_id 的健壮性，需要对 file_basename_no_extension 做以下加工处理：

  • 处理非法字符：把除了字母（a-z, A-Z）、数字（0-9）、‘_’ 字符、‘$’ 字符之外的字符转换为 ‘_’ 字符

  • 首字母转化为小写

  • 处理首字符异常情况：检测首字符是不是数字、‘_’、‘$’，若是则添加前缀字符“a”

  • 处理 asset_id 重名的情况

Examples

Example-1

asset = “packages/flutter_r_demo/assets/images/test.png” asset = “packages/flutter_r_demo/assets/images/test.jpg” used_asset_id_array = [] prior_asset_type = “.png” asset_id = “test”

Example-2

asset = “packages/flutter_r_demo/assets/images/test.jpg” used_asset_id_array = [test] prior_asset_type = “.png” asset_id = “test_jpg”

Example-3

asset = “packages/flutter_r_demo/assets/home-images/test.jpg” used_asset_id_array = [test, test_jpg] prior_asset_type = “.png” asset_id = “test_jpg_1”

Example-4

asset = “packages/flutter_r_demo/assets/texts/test.json” used_asset_id_array = [] prior_asset_type = “.*” asset_id = “test_json”



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
 
# File 'lib/flr/util/code_util.rb', line 158

def self.generate_asset_id(asset, used_asset_id_array, prior_asset_type = ".*")
  file_extname = File.extname(asset).downcase

  dirname = File.dirname(asset)
  parent_dir_name = File.basename(dirname)
  file_basename = File.basename(asset)

  file_basename_no_extension = File.basename(asset, ".*")
  asset_id = file_basename_no_extension.dup
  if prior_asset_type.eql?(".*") or file_extname.eql?(prior_asset_type) == false
    ext_info = file_extname
    ext_info[0] = "_"
    asset_id = asset_id + ext_info
  end

  # 处理非法字符
  asset_id = asset_id.gsub(/[^a-zA-Z0-9_$]/, "_")

  # 首字母转化为小写
  capital = asset_id[0].downcase
  asset_id[0] = capital

  # 处理首字符异常情况
  if capital =~ /[0-9_$]/
    asset_id = "a" + asset_id
  end

  # 处理 asset_id 重名的情况
  if used_asset_id_array.include?(asset_id)
    # 当前asset_id重名次数，初始值为1
    repeat_count = 1

    # 查找当前asset_id衍生出来的asset_id_brother（id兄弟）
    # asset_id_brother = #{asset_id}$#{repeat_count}
    # 其中，repeat_count >= 1
    #
    # Example：
    # asset_id = test
    # asset_id_brother = test$1
    #
    id_brother_regx = /^#{asset_id}\$[1-9][0-9]*$/
    cur_asset_id_brothers = used_asset_id_array.select{ |id| id =~ id_brother_regx }

    repeat_count += cur_asset_id_brothers.size
    asset_id = "#{asset_id}$#{repeat_count}"
  end

  return asset_id
end

.generate_AssetResource_class(package_name) ⇒ Object

generate_AssetResource_class(package_name) -> string

根据模板生成 AssetResource class 的代码



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
 
# File 'lib/flr/util/code_util.rb', line 59

def self.generate_AssetResource_class(package_name)
  code = "/// Asset resource\u2019s metadata class.\n/// For example, here is the metadata of `packages/flutter_demo/assets/images/example.png` asset:\n/// - packageName\uFF1Aflutter_demo\n/// - assetName\uFF1Aassets/images/example.png\n/// - fileDirname\uFF1Aassets/images\n/// - fileBasename\uFF1Aexample.png\n/// - fileBasenameNoExtension\uFF1Aexample\n/// - fileExtname\uFF1A.png\nclass AssetResource {\n  /// Creates an object to hold the asset resource\u2019s metadata.\n  const AssetResource(this.assetName, {this.packageName}) : assert(assetName != null);\n\n  /// The name of the main asset from the set of asset resources to choose from.\n  final String assetName;\n\n  /// The name of the package from which the asset resource is included.\n  final String packageName;\n\n  /// The name used to generate the key to obtain the asset resource. For local assets\n  /// this is [assetName], and for assets from packages the [assetName] is\n  /// prefixed 'packages/<package_name>/'.\n  String get keyName => packageName == null ? assetName : \"packages/$packageName/$assetName\";\n\n  /// The file basename of the asset resource.\n  String get fileBasename {\nfinal basename = path.basename(assetName);\nreturn basename;\n  }\n\n  /// The no extension file basename of the asset resource.\n  String get fileBasenameNoExtension {\nfinal basenameWithoutExtension = path.basenameWithoutExtension(assetName);\nreturn basenameWithoutExtension;\n  }\n\n  /// The file extension name of the asset resource.\n  String get fileExtname {\nfinal extension = path.extension(assetName);\nreturn extension;\n  }\n\n  /// The directory path name of the asset resource.\n  String get fileDirname {\nvar dirname = assetName;\nif (packageName != null) {\n  final packageStr = \"packages/$packageName/\";\n  dirname = dirname.replaceAll(packageStr, \"\");\n}\nfinal filenameStr = \"$fileBasename/\";\ndirname = dirname.replaceAll(filenameStr, \"\");\nreturn dirname;\n  }\n}\n  CODE\n\n  return code\nend\n"

.generate_AssetResource_property(asset, asset_id_dict, package_name, is_package_project_type, prior_asset_type = ".*") ⇒ Object

generate_AssetResource_property(asset, asset_id_dict, package_name, is_package_project_type, prior_asset_type) -> string

为当前 asset 生成 AssetResource property 的代码



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
 
# File 'lib/flr/util/code_util.rb', line 249

def self.generate_AssetResource_property(asset, asset_id_dict, package_name, is_package_project_type, prior_asset_type = ".*")
  asset_id = asset_id_dict[asset]
  asset_comment = generate_asset_comment(asset, package_name)

  asset_name = ""
  needPackage = false

  packages_prefix = "packages/#{package_name}/"
  if asset =~ /\A#{packages_prefix}/
    # asset: packages/flutter_r_demo/assets/images/test.png
    # to get asset_name: assets/images/test.png
    asset_name = asset.dup
    asset_name[packages_prefix] = ""

    needPackage = true
  else
    # asset: assets/images/test.png
    # to get asset_name: assets/images/test.png
    asset_name = asset.dup

    if is_package_project_type
      needPackage = true
    else
      needPackage = false
    end

  end

  # 对字符串中的 '$' 进行转义处理：'$' -> '\$'
  # asset_name: assets/images/test$.png
  # to get escaped_asset_name: assets/images/test\$.png
  escaped_asset_name = asset_name.gsub(/[$]/, "\\$")

  if needPackage
    code = "  /// \#{asset_comment}\n  // ignore: non_constant_identifier_names\n  final \#{asset_id} = const AssetResource(\"\#{escaped_asset_name}\", packageName: R.package);\n    CODE\n\n    return code\n  else\n    code = <<-CODE\n  /// \#{asset_comment}\n  // ignore: non_constant_identifier_names\n  final \#{asset_id} = const AssetResource(\"\#{escaped_asset_name}\", packageName: null);\n    CODE\n\n    return code\n  end\nend\n"

.generate_font_family_id(font_family_name) ⇒ Object

generate_font_family_id(font_family_name) -> string

为当前 font_family_name 生成 font_family_id；font_family_id 一般为 asset 的 font_family_name；但是为了保证 font_family_id 的健壮性，需要对 font_family_name 做以下加工处理：

  • 处理非法字符：把除了字母（a-z, A-Z）、数字（0-9）、‘_’ 字符、‘$’ 字符之外的字符转换为 ‘_’ 字符

  • 首字母转化为小写

  • 处理首字符异常情况：检测首字符是不是数字、‘_’、‘$’，若是则添加前缀字符“a”

Examples

a_font_family_name = “Amiri” b_font_family_name = “Baloo-Thambi-2” a_font_family_id = “amiri” b_font_family_id = “baloo_Thambi_2”



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/flr/util/code_util.rb', line 510

def self.generate_font_family_id(font_family_name)

  font_family_id = font_family_name.dup

  # 处理非法字符
  font_family_id = font_family_id.gsub(/[^a-zA-Z0-9_$]/, "_")

  # 首字母转化为小写
  capital = font_family_id[0].downcase
  font_family_id[0] = capital

  # 处理首字符异常情况
  if capital =~ /[0-9_$]/
    font_family_id = "a" + font_family_id
  end

  return font_family_id
end

.generate_R_class(package_name) ⇒ Object

generate_R_class(package_name) -> string

根据模板生成 R class 的代码



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
 
# File 'lib/flr/util/code_util.rb', line 12

def self.generate_R_class(package_name)
  code = "// IT IS GENERATED BY FLR - DO NOT MODIFY BY HAND\n// YOU CAN GET MORE DETAILS ABOUT FLR FROM:\n// - https://github.com/Fly-Mix/flr-cli\n// - https://github.com/Fly-Mix/flr-vscode-extension\n// - https://github.com/Fly-Mix/flr-as-plugin\n//\n\n// ignore: unused_import\nimport 'package:flutter/widgets.dart';\n// ignore: unused_import\nimport 'package:flutter/services.dart' show rootBundle;\n// ignore: unused_import\nimport 'package:path/path.dart' as path;\n// ignore: unused_import\nimport 'package:flutter_svg/flutter_svg.dart';\n// ignore: unused_import\nimport 'package:r_dart_library/asset_svg.dart';\n\n/// This `R` class is generated and contains references to static asset resources.\nclass R {\n  /// package name: \#{package_name}\n  static const package = \"\#{package_name}\";\n\n  /// This `R.image` struct is generated, and contains static references to static non-svg type image asset resources.\n  static const image = _R_Image();\n\n  /// This `R.svg` struct is generated, and contains static references to static svg type image asset resources.\n  static const svg = _R_Svg();\n\n  /// This `R.text` struct is generated, and contains static references to static text asset resources.\n  static const text = _R_Text();\n\n  /// This `R.fontFamily` struct is generated, and contains static references to static font asset resources.\n  static const fontFamily = _R_FontFamily();\n}\n  CODE\n\n  return code\nend\n"