flr 1.0.0

data/lib/flr/constant.rb

@@ -0,0 +1,22 @@
+module Flr
+  # Flr支持的图片文件类型
+  IMAGE_FILE_TYPES = %w(.png .jpg .jpeg .gif .webp .icon .bmp .wbmp .svg)
+  # Flr支持的文本文件类型
+  TEXT_FILE_TYPES = %w(.txt .json .yaml .xml)
+  # Flr支持的字体文件类型
+  FONT_FILE_TYPES = %w(.ttf .otf .ttc)
+
+  # Flr优先考虑的非SVG类图片文件类型
+  PRIOR_NON_SVG_IMAGE_FILE_TYPE = ".png"
+  # Flr优先考虑的SVG类图片文件类型
+  PRIOR_SVG_IMAGE_FILE_TYPE = ".svg"
+  # Flr优先考虑的文本文件类型
+  # 当前值为 ".*"， 意味所有文本文件类型的优先级都一样
+  PRIOR_TEXT_FILE_TYPE = ".*"
+  # Flr优先考虑的字体文件类型
+  # 当前值为 ".*"， 意味所有文本文件类型的优先级都一样
+  PRIOR_FONT_FILE_TYPE = ".*"
+
+  # dartfmt工具的默认行长
+  DARTFMT_LINE_LENGTH = 80
+end

data/lib/flr/string_extensions.rb

@@ -0,0 +1,102 @@
+# 参考：https://gist.github.com/lnznt/2663516
+class String
+  def black
+    "\e[30m#{self}\e[m"
+  end
+
+  def red
+    "\e[31m#{self}\e[m"
+  end
+
+  def green
+    "\e[32m#{self}\e[m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[m"
+  end
+
+  def blue
+    "\e[34m#{self}\e[m"
+  end
+
+  def magenta
+    "\e[35m#{self}\e[m"
+  end
+
+  def cyan
+    "\e[36m#{self}\e[m"
+  end
+
+  def white
+    "\e[37m#{self}\e[m"
+  end
+
+  def bg_black
+    "\e[40m#{self}\e[m"
+  end
+
+  def bg_red
+    "\e[41m#{self}\e[m"
+  end
+
+  def bg_green
+    "\e[42m#{self}\e[m"
+  end
+
+  def bg_yellow
+    "\e[43m#{self}\e[m"
+  end
+
+  def bg_blue
+    "\e[44m#{self}\e[m"
+  end
+
+  def bg_magenta
+    "\e[45m#{self}\e[m"
+  end
+
+  def bg_cyan
+    "\e[46m#{self}\e[m"
+  end
+
+  def bg_white
+    "\e[47m#{self}\e[m"
+  end
+
+  def bold
+    "\e[1m#{self}\e[m"
+  end
+
+  def bright
+    "\e[2m#{self}\e[m"
+  end
+
+  def italic
+    "\e[3m#{self}\e[m"
+  end
+
+  def underline
+    "\e[4m#{self}\e[m"
+  end
+
+  def blink
+    "\e[5m#{self}\e[m"
+  end
+
+  def reverse_color
+    "\e[7m#{self}\e[m"
+  end
+
+  def error_style
+    self.red
+  end
+
+  def warning_style
+    self.yellow
+  end
+
+  def tips_style
+    self.green
+  end
+end

data/lib/flr/util/asset_util.rb

@@ -0,0 +1,94 @@
+require 'yaml'
+require 'flr/constant'
+
+module Flr
+
+  # 资产相关的工具类方法
+  class AssetUtil
+
+    # generate_image_assets(legal_image_file_array, resource_dir, package_name) -> image_asset_array
+    #
+    # 遍历指定资源目录下扫描找到的legal_image_file数组生成image_asset数组
+    #
+    # === Examples
+    # legal_image_file_array = ["lib/assets/images/test.png"]
+    # resource_dir = "lib/assets/images"
+    # package_name = "flutter_r_demo"
+    # image_asset_array = ["packages/flutter_r_demo/assets/images/test.png"]
+    #
+    def self.generate_image_assets(legal_image_file_array, resource_dir, package_name)
+
+      image_asset_array = []
+
+      # implied_resource_dir = "assets/images"
+      implied_resource_dir = resource_dir
+      if resource_dir.include?("lib/")
+        implied_resource_dir = resource_dir.split("lib/")[1]
+      end
+
+      legal_image_file_array.each do |legal_image_file|
+        file_basename = File.basename(legal_image_file)
+        image_asset = "packages/#{package_name}/#{implied_resource_dir}/#{file_basename}"
+        image_asset_array.push(image_asset)
+      end
+
+      return image_asset_array
+    end
+
+    # generate_text_assets(legal_text_file_array, resource_dir, package_name) -> text_asset_array
+    #
+    # 遍历指定资源目录下扫描找到的legal_text_file数组生成text_asset数组
+    #
+    # === Examples
+    # legal_text_file_array = ["lib/assets/jsons/test.json"]
+    # resource_dir = "lib/assets/jsons"
+    # package_name = "flutter_r_demo"
+    # text_asset_array = ["packages/flutter_r_demo/assets/jsons/test.json"]
+    #
+    def self.generate_text_assets(legal_text_file_array, resource_dir, package_name)
+
+      text_asset_array = []
+
+      legal_text_file_array.each do |legal_text_file|
+        # implied_resource_file = "assets/jsons/test.json"
+        implied_resource_file = legal_text_file
+        if legal_text_file.include?("lib/")
+          implied_resource_file = legal_text_file.split("lib/")[1]
+        end
+        text_asset = "packages/#{package_name}/#{implied_resource_file}"
+        text_asset_array.push(text_asset)
+      end
+
+      return text_asset_array
+    end
+
+    # generate_font_asset_configs(legal_font_file_array, resource_dir, package_name) -> font_asset_config_array
+    #
+    # 遍历指定资源目录下扫描找到的legal_font_file数组生成font_asset_config数组
+    #
+    # === Examples
+    # legal_font_file_array = ["lib/assets/fonts/Amiri/Amiri-Regular.ttf"]
+    # resource_dir = "lib/assets/fonts/Amiri"
+    # package_name = "flutter_r_demo"
+    # font_asset_config_array -> [{"asset": "packages/flutter_r_demo/assets/fonts/Amiri/Amiri-Regular.ttf"}]
+    #
+    def self.generate_font_asset_configs(legal_font_file_array, resource_dir, package_name)
+
+      font_asset_config_array = []
+
+      legal_font_file_array.each do |legal_font_file|
+        # implied_resource_file = "assets/fonts/Amiri/Amiri-Regular.ttf"
+        implied_resource_file = legal_font_file
+        if legal_font_file.include?("lib/")
+          implied_resource_file = legal_font_file.split("lib/")[1]
+        end
+        font_asset = "packages/#{package_name}/#{implied_resource_file}"
+        font_asset_config = Hash["asset" => font_asset]
+        font_asset_config_array.push(font_asset_config)
+      end
+
+      return font_asset_config_array
+    end
+
+  end
+end

data/lib/flr/util/code_util.rb

@@ -0,0 +1,482 @@
+require 'flr/constant'
+
+module Flr
+
+  # 代码生成相关的工具类方法
+  class CodeUtil
+
+    # generate_R_class(package_name) -> string
+    #
+    # 根据模板生成 R class 的代码
+    #
+    def self.generate_R_class(package_name)
+      code = <<-CODE
+// IT IS GENERATED BY FLR - DO NOT MODIFY BY HAND
+// YOU CAN GET MORE DETAILS ABOUT FLR FROM:
+// - https://github.com/Fly-Mix/flr-cli
+// - https://github.com/Fly-Mix/flr-vscode-extension
+// - https://github.com/Fly-Mix/flr-as-plugin
+//
+
+// ignore: unused_import
+import 'package:flutter/widgets.dart';
+// ignore: unused_import
+import 'package:flutter/services.dart' show rootBundle;
+// ignore: unused_import
+import 'package:path/path.dart' as path;
+// ignore: unused_import
+import 'package:flutter_svg/flutter_svg.dart';
+// ignore: unused_import
+import 'package:r_dart_library/asset_svg.dart';
+
+/// This `R` class is generated and contains references to static asset resources.
+class R {
+  /// package name: #{package_name}
+  static const package = "#{package_name}";
+
+  /// This `R.image` struct is generated, and contains static references to static non-svg type image asset resources.
+  static const image = _R_Image();
+
+  /// This `R.svg` struct is generated, and contains static references to static svg type image asset resources.
+  static const svg = _R_Svg();
+
+  /// This `R.text` struct is generated, and contains static references to static text asset resources.
+  static const text = _R_Text();
+
+  /// This `R.fontFamily` struct is generated, and contains static references to static font asset resources.
+  static const fontFamily = _R_FontFamily();
+}
+      CODE
+
+      return code
+    end
+
+
+    # generate_AssetResource_class(package_name) -> string
+    #
+    # 根据模板生成 AssetResource class 的代码
+    #
+    def self.generate_AssetResource_class(package_name)
+      code = <<-CODE
+/// Asset resource’s metadata class.
+/// For example, here is the metadata of `packages/flutter_demo/assets/images/example.png` asset:
+/// - packageName：flutter_demo
+/// - assetName：assets/images/example.png
+/// - fileDirname：assets/images
+/// - fileBasename：example.png
+/// - fileBasenameNoExtension：example
+/// - fileExtname：.png
+class AssetResource {
+  /// Creates an object to hold the asset resource’s metadata.
+  const AssetResource(this.assetName, {this.packageName}) : assert(assetName != null);
+
+  /// The name of the main asset from the set of asset resources to choose from.
+  final String assetName;
+
+  /// The name of the package from which the asset resource is included.
+  final String packageName;
+
+  /// The name used to generate the key to obtain the asset resource. For local assets
+  /// this is [assetName], and for assets from packages the [assetName] is
+  /// prefixed 'packages/<package_name>/'.
+  String get keyName => packageName == null ? assetName : "packages/$packageName/$assetName";
+
+  /// The file basename of the asset resource.
+  String get fileBasename {
+    final basename = path.basename(assetName);
+    return basename;
+  }
+
+  /// The no extension file basename of the asset resource.
+  String get fileBasenameNoExtension {
+    final basenameWithoutExtension = path.basenameWithoutExtension(assetName);
+    return basenameWithoutExtension;
+  }
+
+  /// The file extension name of the asset resource.
+  String get fileExtname {
+    final extension = path.extension(assetName);
+    return extension;
+  }
+
+  /// The directory path name of the asset resource.
+  String get fileDirname {
+    var dirname = assetName;
+    if (packageName != null) {
+      final packageStr = "packages/$packageName/";
+      dirname = dirname.replaceAll(packageStr, "");
+    }
+    final filenameStr = "$fileBasename/";
+    dirname = dirname.replaceAll(filenameStr, "");
+    return dirname;
+  }
+}
+      CODE
+
+      return code
+    end
+
+    # generate_asset_id (asset, prior_asset_type) -> string
+    #
+    # - prior_asset_type: 优先的资源类型；默认值为 ".*"，意味当前不存在任何优先的资源类型
+    #                     对于优先的资源类型，其 asset_id 不会携带类型信息，详细见例子
+    #
+    # 为当前 asset 生成 asset_id（资产ID）；asset_id 一般为 asset 的 file_basename_no_extension；
+    # 但是为了保证 asset_id 的健壮性，需要对 file_basename_no_extension 做以下加工处理：
+    # - 处理非法字符：把除了字母（a-z, A-Z）、数字（0-9）、'_' 字符、'$' 字符之外的字符转换为 '_' 字符
+    # - 首字母转化为小写
+    # - 处理首字符异常情况：检测首字符是不是数字、'_'、'$'，若是则添加前缀字符"a"
+    #
+    # === Examples
+    #
+    # ===== Example-1
+    # a_asset = "packages/flutter_r_demo/assets/images/test.png"
+    # b_asset = "packages/flutter_r_demo/assets/images/test.jpg"
+    # prior_asset_type = ".png"
+    # a_asset_id = "test"
+    # b_asset_id = "test_jpg"
+    #
+    # ===== Example-2
+    # a_asset = "packages/flutter_r_demo/assets/texts/test.json"
+    # b_asset = "packages/flutter_r_demo/assets/texts/test.yaml"
+    # prior_asset_type = ".*"
+    # a_asset_id = "test_json"
+    # b_asset_id = "test_yaml"
+    #
+    def self.generate_asset_id(asset, prior_asset_type = ".*")
+      file_extname = File.extname(asset).downcase
+
+      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
+
+      return asset_id
+    end
+
+    # generate_asset_comment (asset, package_name) -> string
+    #
+    # 为当前asset生成注释
+    #
+    # === Examples
+    # asset = "packages/flutter_r_demo/assets/images/test.png"
+    # package_name = "flutter_r_demo"
+    # asset_comment = "asset: assets/images/test.png"
+    #
+    def self.generate_asset_comment (asset, package_name)
+
+      asset_name = asset.dup
+      asset_name["packages/#{package_name}/"] = ""
+
+      asset_comment = "asset: #{asset_name}"
+
+      return asset_comment
+    end
+
+    # generate_AssetResource_property(asset, package_name, prior_asset_type) -> string
+    #
+    # 为当前 asset 生成 AssetResource property 的代码
+    #
+    def self.generate_AssetResource_property(asset, package_name, prior_asset_type = ".*")
+
+      asset_id = generate_asset_id(asset, prior_asset_type)
+      asset_comment = generate_asset_comment(asset, package_name)
+
+      asset_name = asset.dup
+      asset_name["packages/#{package_name}/"] = ""
+      # 对字符串中的 '$' 进行转义处理：'$' -> '\$'
+      escaped_asset_name = asset_name.gsub(/[$]/, "\\$")
+
+      code = <<-CODE
+  /// #{asset_comment}
+  // ignore: non_constant_identifier_names
+  final #{asset_id} = const AssetResource("#{escaped_asset_name}", packageName: R.package);
+      CODE
+
+      return code
+    end
+
+    # generate__R_Image_AssetResource_class(non_svg_image_asset_array, package_name) -> string
+    #
+    # 根据模板，为 non_svg_image_asset_array（非svg类的图片资产数组）生成 _R_Image_AssetResource class 的代码
+    #
+    def self.generate__R_Image_AssetResource_class(non_svg_image_asset_array, package_name)
+
+      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, package_name, Flr::PRIOR_NON_SVG_IMAGE_FILE_TYPE)
+        all_g_AssetResource_property_code += g_AssetResource_property_code
+      end
+
+      code = <<-CODE
+// ignore: camel_case_types
+class _R_Image_AssetResource {
+  const _R_Image_AssetResource();
+#{all_g_AssetResource_property_code}
+}
+      CODE
+
+      return code
+    end
+
+    # generate__R_Svg_AssetResource_class(image_asset_array, package_name) -> string
+    #
+    # 根据模板，为 svg_image_asset_array（svg类的图片资产数组）生成 _R_Svg_AssetResource class 的代码
+    #
+    def self.generate__R_Svg_AssetResource_class(svg_image_asset_array, package_name)
+
+      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, package_name, Flr::PRIOR_SVG_IMAGE_FILE_TYPE)
+        all_g_AssetResource_property_code += g_AssetResource_property_code
+      end
+
+      code = <<-CODE
+// ignore: camel_case_types
+class _R_Svg_AssetResource {
+  const _R_Svg_AssetResource();
+#{all_g_AssetResource_property_code}
+}
+      CODE
+
+      return code
+    end
+
+    # generate__R_Text_AssetResource_class(text_asset_array, package_name) -> string
+    #
+    # 根据模板，为 text_asset_array（文本资产数组）生成 _R_Text_AssetResource class 的代码
+    #
+    def self.generate__R_Text_AssetResource_class(text_asset_array, package_name)
+
+      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, package_name, Flr::PRIOR_TEXT_FILE_TYPE)
+        all_g_AssetResource_property_code += g_AssetResource_property_code
+      end
+
+      code = <<-CODE
+// ignore: camel_case_types
+class _R_Text_AssetResource {
+  const _R_Text_AssetResource();
+#{all_g_AssetResource_property_code}
+}
+      CODE
+
+      return code
+    end
+
+    # generate__R_Image_class(non_svg_image_asset_array, package_name) -> string
+    #
+    # 根据模板，为 non_svg_image_asset_array（非svg类的图片资产数组）生成 _R_Image class 的代码
+    #
+    def self.generate__R_Image_class(non_svg_image_asset_array, package_name)
+
+      all_g_Asset_method_code = ""
+
+      non_svg_image_asset_array.each do |image_asset|
+        all_g_Asset_method_code += "\n"
+
+        asset_id = generate_asset_id(image_asset, Flr::PRIOR_NON_SVG_IMAGE_FILE_TYPE)
+        asset_comment = generate_asset_comment(image_asset, package_name)
+
+        g_Asset_method_code = <<-CODE
+  /// #{asset_comment}
+  // ignore: non_constant_identifier_names
+  AssetImage #{asset_id}() {
+    return AssetImage(asset.#{asset_id}.keyName);
+  }
+        CODE
+
+        all_g_Asset_method_code += g_Asset_method_code
+      end
+
+      code = <<-CODE
+/// This `_R_Image` class is generated and contains references to static non-svg type image asset resources.
+// ignore: camel_case_types
+class _R_Image {
+  const _R_Image();
+
+  final asset = const _R_Image_AssetResource();
+#{all_g_Asset_method_code}
+}
+      CODE
+
+      return code
+    end
+
+    # generate__R_Svg_class(image_asset_array, package_name) -> string
+    #
+    # 根据模板，为 svg_image_asset_array（svg类的图片资产数组）生成 _R_Svg class 的代码
+    #
+    def self.generate__R_Svg_class(svg_image_asset_array, package_name)
+
+      all_g_Asset_method_code = ""
+
+      svg_image_asset_array.each do |image_asset|
+        all_g_Asset_method_code += "\n"
+
+        asset_id = generate_asset_id(image_asset, Flr::PRIOR_SVG_IMAGE_FILE_TYPE)
+        asset_comment = generate_asset_comment(image_asset, package_name)
+
+        g_Asset_method_code = <<-CODE
+  /// #{asset_comment}
+  // ignore: non_constant_identifier_names
+  AssetSvg #{asset_id}({@required double width, @required double height}) {
+    final imageProvider = AssetSvg(asset.#{asset_id}.keyName, width: width, height: height);
+    return imageProvider;
+  }
+        CODE
+
+        all_g_Asset_method_code += g_Asset_method_code
+      end
+
+      code = <<-CODE
+/// This `_R_Svg` class is generated and contains references to static svg type image asset resources.
+// ignore: camel_case_types
+class _R_Svg {
+  const _R_Svg();
+
+  final asset = const _R_Svg_AssetResource();
+#{all_g_Asset_method_code}
+}
+      CODE
+
+      return code
+    end
+
+    # generate__R_Text_class(text_asset_array, package_name) -> string
+    #
+    # 根据模板，为 text_asset_array（文本资产数组）生成 _R_Text class 的代码
+    #
+    def self.generate__R_Text_class(text_asset_array, package_name)
+
+      all_g_Asset_method_code = ""
+
+      text_asset_array.each do |text_asset|
+        all_g_Asset_method_code += "\n"
+
+        asset_id = generate_asset_id(text_asset, Flr::PRIOR_TEXT_FILE_TYPE)
+        asset_comment = generate_asset_comment(text_asset, package_name)
+
+        g_Asset_method_code = <<-CODE
+  /// #{asset_comment}
+  // ignore: non_constant_identifier_names
+  Future<String> #{asset_id}() {
+    final str = rootBundle.loadString(asset.#{asset_id}.keyName);
+    return str;
+  }
+        CODE
+
+        all_g_Asset_method_code += g_Asset_method_code
+      end
+
+      code = <<-CODE
+/// This `_R_Text` class is generated and contains references to static text asset resources.
+// ignore: camel_case_types
+class _R_Text {
+  const _R_Text();
+
+  final asset = const _R_Text_AssetResource();
+#{all_g_Asset_method_code}
+}
+      CODE
+
+      return code
+    end
+
+    # 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"
+    #
+    #
+    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_FontFamily_class(font_family_config_array, package_name) -> string
+    #
+    # 根据模板，为 font_family_config_array（字体家族配置数组）生成 _R_FontFamily class 的代码
+    #
+    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 = <<-CODE
+  /// #{font_family_comment}
+  // ignore: non_constant_identifier_names
+  final #{font_family_id} = "#{font_family_name}";
+        CODE
+
+        all_g_AssetResource_property_code += g_AssetResource_property_code
+      end
+
+      code = <<-CODE
+/// This `_R_FontFamily` class is generated and contains references to static font asset resources.
+// ignore: camel_case_types
+class _R_FontFamily {
+  const _R_FontFamily();
+#{all_g_AssetResource_property_code}
+}
+      CODE
+
+      return code
+    end
+  end
+
+end