flr 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf8e0a359356f8ea371d681026c47f7e4e649d144a0c1cda4acc051f07404cbd
-  data.tar.gz: fbf661e81c360e715695c2b9906ccb0328ed07163a208aab3b1d50ef024a5423
+  metadata.gz: 4e7b9ee5330233ba9aac3017cd51d403139365b6f95bd0729e188671dfadfb35
+  data.tar.gz: 8be015c230dc9581326c39f7b5dd53074779e7f6291c911a18f9e9afac20ef7c
 SHA512:
-  metadata.gz: 6263917c0732cc4b6e772fe024267b8854d9b0f99c6868f2326caa6986dc68015db43f5e24be2bf0f06a3478d84de900099289c6b6ae2780542eb492d50ff93a
-  data.tar.gz: 87218e5d6f9d85fbce53246077b8a2e74e7e9df84fc45e221635b2b0c5980373177530b5bb6f4996d8cae1576f3ffc2d3beb741c49a99ee18f2a4c081f0444a8
+  metadata.gz: 3ae44108a8e59cd1680700276f5b1d47a6235c5624566c6195f17bd522d901b02182faecee8dba056c200723f57f54e379ca37a8483c0493dc6dfe5a3678e7e2
+  data.tar.gz: 98b5bf07ab3bce3305572555d58ef71037d9c6822aa1f4842fcb1d07e8090bf9a198b40cd269e08bbdd18103c4419d6b2b30f38b8cff6ce7300c9c2c613e937d

data/.gitignore

@@ -7,6 +7,7 @@
 .rbenv-version
 .rbx/
 /concatenated.*
+build/
 
 # Yardoc
 /.yardoc

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 3.0.0
+
+- Support for processing non-implied resource file
+
+   > - non-implied resource file:  the resource file which is outside of `lib/` directory, for example:
+   >    - `~/path/to/flutter_r_demo/assets/images/test.png` 
+   >    - `~/path/to/flutter_r_demo/assets/images/3.0x/test.png`
+   > - implied resource file:  the resource file which is inside of  `lib/` directory, for example:
+   >    - `~/path/to/flutter_r_demo/lib/assets/images/hot_foot_N.png` 
+   >    - `~/path/to/flutter_r_demo/lib/assets/images/3.0x/hot_foot_N.png`
+
+- New recommended flutter resource structure
+
 ## 2.0.0
 
 - New asset generation algorithm to support all kinds of standard or nonstandard image/text resource structure

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flr (2.0.0)
+    flr (3.0.0)
       bundler (~> 2.0, >= 2.0.2)
       listen (~> 3.0, >= 3.2.1)
       thor (~> 1.0, >= 1.0.1)

data/lib/flr/checker.rb

@@ -4,7 +4,7 @@ module Flr
   # 条件检测器，提供检测各种条件是否合法的方法
   class Checker
 
-    # check_pubspec_file_is_existed(flutter_dir)  ->  true
+    # check_pubspec_file_is_existed(flutter_project_dir)  ->  true
     #
     # 检测当前flutter工程目录是否存在pubspec.yaml文件
     # 若存在，返回true
@@ -12,16 +12,16 @@ module Flr
     #
     # === Examples
     #
-    # flutter_dir = "~path/to/flutter_r_demo"
-    # Checker.check_pubspec_file_is_existed(flutter_dir)
+    # flutter_project_dir = "~path/to/flutter_r_demo"
+    # Checker.check_pubspec_file_is_existed(flutter_project_dir)
     #
-    def self.check_pubspec_file_is_existed(flutter_dir)
-      pubspec_file_path = flutter_dir + "/pubspec.yaml"
+    def self.check_pubspec_file_is_existed(flutter_project_dir)
+      pubspec_file_path = flutter_project_dir + "/pubspec.yaml"
 
       if File.exist?(pubspec_file_path) == false
         message = <<-MESSAGE
 #{"[x]: #{pubspec_file_path} not found".error_style}
-#{"[*]: please make sure pubspec.yaml is existed in #{flutter_dir}".tips_style}
+#{"[*]: please make sure pubspec.yaml is existed in #{flutter_project_dir}".tips_style}
         MESSAGE
 
         raise(message)
@@ -63,7 +63,7 @@ module Flr
       return true
     end
 
-    # check_flr_assets_is_legal(flutter_dir, flr_config)  ->  resource_dir_result_tuple
+    # check_flr_assets_is_legal(flutter_project_dir, flr_config)  ->  resource_dir_result_tuple
     #
     # 检测当前flr配置信息中的assets配置是否合法
     # 若合法，返回资源目录结果三元组 resource_dir_result_triplet
@@ -88,12 +88,12 @@ module Flr
     # 判断flr的assets配置合法的标准是：assets配置的resource_dir数组中的legal_resource_dir数量大于0。
     #
     # === Examples
-    # flutter_dir = "~/path/to/flutter_r_demo"
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
     # assets_legal_resource_dir_array = ["~/path/to/flutter_r_demo/lib/assets/images", "~/path/to/flutter_r_demo/lib/assets/texts"]
     # fonts_legal_resource_dir_array = ["~/path/to/flutter_r_demo/lib/assets/fonts"]
     # illegal_resource_dir_array = ["~/path/to/flutter_r_demo/to/non-existed_folder"]
     #
-    def self.check_flr_assets_is_legal(flutter_dir, flr_config)
+    def self.check_flr_assets_is_legal(flutter_project_dir, flr_config)
       core_version = flr_config["core_version"]
       dartfmt_line_length = flr_config["dartfmt_line_length"]
       assets_resource_dir_array = flr_config["assets"]
@@ -121,7 +121,7 @@ module Flr
       illegal_resource_dir_array = []
 
       assets_resource_dir_array.each do |relative_resource_dir|
-        resource_dir = flutter_dir + "/" + relative_resource_dir
+        resource_dir = flutter_project_dir + "/" + relative_resource_dir
         if File.exist?(resource_dir) == true
           assets_legal_resource_dir_array.push(resource_dir)
         else
@@ -130,7 +130,7 @@ module Flr
       end
 
       fonts_resource_dir_array.each do |relative_resource_dir|
-        resource_dir = flutter_dir + "/" + relative_resource_dir
+        resource_dir = flutter_project_dir + "/" + relative_resource_dir
         if File.exist?(resource_dir) == true
           fonts_legal_resource_dir_array.push(resource_dir)
         else

data/lib/flr/command.rb

@@ -36,7 +36,9 @@ module Flr
     # display recommended flutter resource structure
     def self.display_recommended_flutter_resource_structure
       message = <<-MESSAGE
-Flr recommends the following flutter resource structure:
+Flr recommends the following flutter resource structure schemes:
+
+#{"------------------------------ scheme 1 ------------------------------".bold.bg_red}
 
   flutter_project_root_dir
   ├── build
@@ -84,6 +86,54 @@ Flr recommends the following flutter resource structure:
     #{"fonts:".tips_style}
       #{"- lib/assets/fonts".tips_style}
 
+#{"------------------------------ scheme 2 ------------------------------".bold.bg_red}
+
+  flutter_project_root_dir
+  ├── build
+  │   ├── ..
+  ├── lib
+  │   ├── ..
+  ├── assets
+  │   ├── images #{"// image resource directory of all modules".red}
+  │   │   ├── \#{module} #{"// image resource directory of a module".red}
+  │   │   │   ├── \#{main_image_asset}
+  │   │   │   ├── \#{variant-dir} #{"// image resource directory of a variant".red}
+  │   │   │   │   ├── \#{image_asset_variant}
+  │   │   │
+  │   │   ├── home #{"// image resource directory of home module".red}
+  │   │   │   ├── home_badge.svg
+  │   │   │   ├── home_icon.png
+  │   │   │   ├── 3.0x #{"// image resource directory of a 3.0x-ratio-variant".red}
+  │   │   │   │   ├── home_icon.png
+  │   │   │		
+  │   ├── texts #{"// text resource directory".red}
+  │   │   │     #{"// (you can also break it down further by module)".red}
+  │   │   └── test.json
+  │   │   └── test.yaml
+  │   │   │
+  │   ├── fonts #{"// font resource directory of all font-families".red}
+  │   │   ├── \#{font-family} #{"// font resource directory of a font-family".red}
+  │   │   │   ├── \#{font-family}-\#{font_weight_or_style}.ttf
+  │   │   │
+  │   │   ├── Amiri #{"// font resource directory of Amiri font-family".red}
+  │   │   │   ├── Amiri-Regular.ttf
+  │   │   │   ├── Amiri-Bold.ttf
+  │   │   │   ├── Amiri-Italic.ttf
+  │   │   │   ├── Amiri-BoldItalic.ttf
+  │   ├── ..
+
+#{"[*]: Then config the resource directories that need to be scanned as follows：".tips_style}
+
+  #{"flr:".tips_style}
+    #{"core_version: #{Flr::CORE_VERSION}".tips_style}
+    #{"dartfmt_line_length: #{Flr::DARTFMT_LINE_LENGTH}".tips_style}
+    #{"# config the image and text resource directories that need to be scanned".tips_style}
+    #{"assets:".tips_style}
+      #{"- assets/images".tips_style}
+      #{"- assets/texts".tips_style}
+    #{"# config the font resource directories that need to be scanned".tips_style}
+    #{"fonts:".tips_style}
+      #{"- assets/fonts".tips_style}
       MESSAGE
 
       puts(message)
@@ -126,7 +176,7 @@ Flr recommends the following flutter resource structure:
       begin
         Checker.check_pubspec_file_is_existed(flutter_project_root_dir)
 
-        pubspec_file_path = FileUtil.get_pubspec_file_path
+        pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)
 
         pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)
 
@@ -278,7 +328,7 @@ Flr recommends the following flutter resource structure:
       begin
         Checker.check_pubspec_file_is_existed(flutter_project_root_dir)
 
-        pubspec_file_path = FileUtil.get_pubspec_file_path
+        pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)
 
         pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)
 
@@ -293,6 +343,7 @@ Flr recommends the following flutter resource structure:
         return
       end
 
+      is_package_project_type = FileUtil.is_package_project_type?(flutter_project_root_dir)
       package_name = pubspec_config["name"]
 
       # ----- Step-1 End -----
@@ -588,7 +639,7 @@ Flr recommends the following flutter resource structure:
       #
 
       r_dart_file.puts("\n")
-      g__R_Image_AssetResource_class_code = CodeUtil.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name)
+      g__R_Image_AssetResource_class_code = CodeUtil.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name, is_package_project_type)
       r_dart_file.puts(g__R_Image_AssetResource_class_code)
 
       # ----- Step-13 End -----
@@ -598,7 +649,7 @@ Flr recommends the following flutter resource structure:
       #
 
       r_dart_file.puts("\n")
-      g__R_Svg_AssetResource_class_code = CodeUtil.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict,  package_name)
+      g__R_Svg_AssetResource_class_code = CodeUtil.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict,  package_name, is_package_project_type)
       r_dart_file.puts(g__R_Svg_AssetResource_class_code)
 
       # ----- Step-14 End -----
@@ -608,7 +659,7 @@ Flr recommends the following flutter resource structure:
       #
 
       r_dart_file.puts("\n")
-      g__R_Text_AssetResource_class_code = CodeUtil.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name)
+      g__R_Text_AssetResource_class_code = CodeUtil.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name, is_package_project_type)
       r_dart_file.puts(g__R_Text_AssetResource_class_code)
 
       # ----- Step-15 End -----
@@ -726,7 +777,7 @@ Flr recommends the following flutter resource structure:
       begin
         Checker.check_pubspec_file_is_existed(flutter_project_root_dir)
 
-        pubspec_file_path = FileUtil.get_pubspec_file_path
+        pubspec_file_path = FileUtil.get_pubspec_file_path(flutter_project_root_dir)
 
         pubspec_config = FileUtil.load_pubspec_config_from_file(pubspec_file_path)
 

data/lib/flr/util/asset_util.rb

@@ -34,12 +34,12 @@ module Flr
       return false
     end
 
-    # generate_main_asset(flutter_dir, package_name, legal_resource_file) -> main_asset
+    # generate_main_asset(flutter_project_dir, package_name, legal_resource_file) -> main_asset
     #
     # 为当前资源文件生成 main_asset
     #
     # === Examples
-    # flutter_dir = "~/path/to/flutter_r_demo"
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
     # package_name = "flutter_r_demo"
     #
     # === Example-1
@@ -58,7 +58,15 @@ module Flr
     # legal_resource_file = "~/path/to/flutter_r_demo/lib/assets/fonts/Amiri/Amiri-Regular.ttf"
     # main_asset = "packages/flutter_r_demo/fonts/Amiri/Amiri-Regular.ttf"
     #
-    def self.generate_main_asset(flutter_dir, package_name, legal_resource_file)
+    # === Example-4
+    # legal_resource_file = "~/path/to/flutter_r_demo/assets/images/test.png"
+    # main_asset = "assets/images/test.png"
+    #
+    # === Example-5
+    # legal_resource_file = "~/path/to/flutter_r_demo/assets/images/3.0x/test.png"
+    # main_asset = "assets/images/test.png"
+    #
+    def self.generate_main_asset(flutter_project_dir, package_name, legal_resource_file)
       # legal_resource_file: ~/path/to/flutter_r_demo/lib/assets/images/3.0x/test.png
       # to get main_resource_file: ~/path/to/flutter_r_demo/lib/assets/images/test.png
       main_resource_file = legal_resource_file
@@ -74,39 +82,55 @@ module Flr
       end
 
       # main_resource_file:  ~/path/to/flutter_r_demo/lib/assets/images/test.png
-      # main_relative_resource_file: lib/assets/images/test.png
-      # to get main_implied_relative_resource_file: assets/images/test.png
-      flutter_dir_prefix = "#{flutter_dir}/"
+      # to get main_relative_resource_file: lib/assets/images/test.png
+      flutter_project_dir_prefix = "#{flutter_project_dir}/"
       main_relative_resource_file = main_resource_file
-      if main_relative_resource_file =~ /\A#{flutter_dir_prefix}/
-        main_relative_resource_file["#{flutter_dir_prefix}"] = ""
+      if main_relative_resource_file =~ /\A#{flutter_project_dir_prefix}/
+        main_relative_resource_file["#{flutter_project_dir_prefix}"] = ""
       end
+
+      # 判断 main_relative_resource_file 是不是 implied_resource_file 类型
+      # implied_resource_file 的定义是：放置在 "lib/" 目录内 resource_file
+      # 具体实现是：main_relative_resource_file 的前缀若是 "lib/" ，则其是 implied_resource_file 类型；
+      #
+      # implied_relative_resource_file 生成 main_asset 的算法是： main_asset = "packages/#{package_name}/#{asset_name}"
+      # non-implied_relative_resource_file 生成 main_asset 的算法是： main_asset = "#{asset_name}"
+      #
       lib_prefix = "lib/"
-      main_implied_relative_resource_file = main_relative_resource_file;
-      if main_implied_relative_resource_file =~ /\A#{lib_prefix}/
-        main_implied_relative_resource_file[lib_prefix] = ""
+      if main_relative_resource_file =~ /\A#{lib_prefix}/
+        # main_relative_resource_file: lib/assets/images/test.png
+        # to get asset_name: assets/images/test.png
+        asset_name = main_relative_resource_file
+        asset_name[lib_prefix] = ""
+
+        main_asset = "packages/#{package_name}/#{asset_name}"
+        return main_asset
+      else
+        # main_relative_resource_file: assets/images/test.png
+        # to get asset_name: assets/images/test.png
+        asset_name = main_relative_resource_file
+
+        main_asset = asset_name
+        return main_asset
       end
-
-      main_asset = "packages/#{package_name}/#{main_implied_relative_resource_file}"
-      return main_asset
     end
 
-    # generate_image_assets(flutter_dir, package_name, legal_image_file_array) -> image_asset_array
+    # generate_image_assets(flutter_project_dir, package_name, legal_image_file_array) -> image_asset_array
     #
     # 遍历指定资源目录下扫描找到的legal_image_file数组生成image_asset数组
     #
     # === Examples
-    # flutter_dir = "~/path/to/flutter_r_demo"
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
     # package_name = "flutter_r_demo"
     # legal_image_file_array = ["~/path/to/flutter_r_demo/lib/assets/images/test.png", "~/path/to/flutter_r_demo/lib/assets/images/3.0x/test.png"]
     # image_asset_array = ["packages/flutter_r_demo/assets/images/test.png"]
     #
-    def self.generate_image_assets(flutter_dir, package_name, legal_image_file_array)
+    def self.generate_image_assets(flutter_project_dir, package_name, legal_image_file_array)
 
       image_asset_array = []
 
       legal_image_file_array.each do |legal_image_file|
-        image_asset = generate_main_asset(flutter_dir, package_name, legal_image_file)
+        image_asset = generate_main_asset(flutter_project_dir, package_name, legal_image_file)
         image_asset_array.push(image_asset)
       end
 
@@ -114,22 +138,22 @@ module Flr
       return image_asset_array
     end
 
-    # generate_text_assets(flutter_dir, package_name, legal_text_file_array) -> text_asset_array
+    # generate_text_assets(flutter_project_dir, package_name, legal_text_file_array) -> text_asset_array
     #
     # 遍历指定资源目录下扫描找到的legal_text_file数组生成text_asset数组
     #
     # === Examples
-    # flutter_dir = "~/path/to/flutter_r_demo"
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
     # package_name = "flutter_r_demo"
     # legal_text_file_array = ["~path/to/flutter_r_demo/lib/assets/jsons/test.json"]
     # text_asset_array = ["packages/flutter_r_demo/assets/jsons/test.json"]
     #
-    def self.generate_text_assets(flutter_dir, package_name, legal_text_file_array)
+    def self.generate_text_assets(flutter_project_dir, package_name, legal_text_file_array)
 
       text_asset_array = []
 
       legal_text_file_array.each do |legal_text_file|
-        text_asset = generate_main_asset(flutter_dir, package_name, legal_text_file)
+        text_asset = generate_main_asset(flutter_project_dir, package_name, legal_text_file)
         text_asset_array.push(text_asset)
       end
 
@@ -137,22 +161,22 @@ module Flr
       return text_asset_array
     end
 
-    # generate_font_asset_configs(flutter_dir, package_name, legal_font_file_array) -> font_asset_config_array
+    # generate_font_asset_configs(flutter_project_dir, package_name, legal_font_file_array) -> font_asset_config_array
     #
     # 遍历指定资源目录下扫描找到的legal_font_file数组生成font_asset_config数组
     #
     # === Examples
-    # flutter_dir = "~/path/to/flutter_r_demo"
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
     # package_name = "flutter_r_demo"
     # legal_font_file_array = ["~path/to/flutter_r_demo/lib/assets/fonts/Amiri/Amiri-Regular.ttf"]
     # font_asset_config_array -> [{"asset": "packages/flutter_r_demo/assets/fonts/Amiri/Amiri-Regular.ttf"}]
     #
-    def self.generate_font_asset_configs(flutter_dir, package_name, legal_font_file_array)
+    def self.generate_font_asset_configs(flutter_project_dir, package_name, legal_font_file_array)
 
       font_asset_config_array = []
 
       legal_font_file_array.each do |legal_font_file|
-        font_asset = generate_main_asset(flutter_dir, package_name, legal_font_file)
+        font_asset = generate_main_asset(flutter_project_dir, package_name, legal_font_file)
         font_asset_config = Hash["asset" => font_asset]
         font_asset_config_array.push(font_asset_config)
       end

data/lib/flr/util/code_util.rb

@@ -210,54 +210,105 @@ class AssetResource {
     # 为当前asset生成注释
     #
     # === Examples
-    # asset = "packages/flutter_r_demo/assets/images/test.png"
     # 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"
     #
     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
 
-      asset_name = asset.dup
-      asset_name["packages/#{package_name}/"] = ""
-
-      asset_comment = "asset: #{asset_name}"
-
-      return asset_comment
     end
 
-    # generate_AssetResource_property(asset, asset_id_dict, package_name, prior_asset_type) -> string
+    # generate_AssetResource_property(asset, asset_id_dict, package_name, is_package_project_type, prior_asset_type) -> string
     #
     # 为当前 asset 生成 AssetResource property 的代码
     #
-    def self.generate_AssetResource_property(asset, asset_id_dict, package_name, prior_asset_type = ".*")
-
+    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 = asset.dup
-      asset_name["packages/#{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(/[$]/, "\\$")
 
-      code = <<-CODE
+      if needPackage
+        code = <<-CODE
   /// #{asset_comment}
   // ignore: non_constant_identifier_names
   final #{asset_id} = const AssetResource("#{escaped_asset_name}", packageName: R.package);
-      CODE
+        CODE
 
-      return code
+        return code
+      else
+        code = <<-CODE
+  /// #{asset_comment}
+  // ignore: non_constant_identifier_names
+  final #{asset_id} = const AssetResource("#{escaped_asset_name}", packageName: null);
+        CODE
+
+        return code
+      end
     end
 
-    # generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name) -> string
+    # 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 的代码
     #
-    def self.generate__R_Image_AssetResource_class(non_svg_image_asset_array, non_svg_image_asset_id_dict, package_name)
+    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, Flr::PRIOR_NON_SVG_IMAGE_FILE_TYPE)
+        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
 
@@ -272,17 +323,17 @@ class _R_Image_AssetResource {
       return code
     end
 
-    # generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict, package_name) -> string
+    # 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 的代码
     #
-    def self.generate__R_Svg_AssetResource_class(svg_image_asset_array, svg_image_asset_id_dict, package_name)
+    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, Flr::PRIOR_SVG_IMAGE_FILE_TYPE)
+        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
 
@@ -297,17 +348,17 @@ class _R_Svg_AssetResource {
       return code
     end
 
-    # generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name) -> string
+    # 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 的代码
     #
-    def self.generate__R_Text_AssetResource_class(text_asset_array, text_asset_id_dict, package_name)
+    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, Flr::PRIOR_TEXT_FILE_TYPE)
+        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
 

data/lib/flr/util/file_util.rb

@@ -15,13 +15,16 @@ module Flr
       return flutter_project_root_dir
     end
 
-    # get_pubspec_file_path -> String
+    # get_pubspec_file_path(flutter_project_dir) -> String
     #
     # 获取当前flutter工程的pubspec.yaml文件的路径
     #
-    def self.get_pubspec_file_path
-      flutter_project_root_dir = self.get_cur_flutter_project_root_dir
-      file_path = flutter_project_root_dir + "/pubspec.yaml"
+    # === Examples
+    # flutter_project_dir = "~/path/to/flutter_r_demo"
+    # pubspec_file_path = "~/path/to/flutter_r_demo/pubspec.yaml"
+    #
+    def self.get_pubspec_file_path(flutter_project_dir)
+      file_path = flutter_project_dir + "/pubspec.yaml"
       return file_path
     end
 
@@ -79,6 +82,65 @@ module Flr
       return true
     end
 
+    # is_package_project_type?(flutter_project_dir) -> true or false
+    #
+    # 判断当前flutter工程的工程类型是不是Package工程类型
+    #
+    # flutter工程共有4种工程类型：
+    # - app：Flutter App工程，用于开发纯Flutter的App
+    # - module：Flutter Component工程，用于开发Flutter组件以嵌入iOS和Android原生工程
+    # - package：General Dart Package工程，用于开发一个供应用层开发者使用的包
+    # - plugin：Plugin Package工程（属于特殊的Dart Package工程），用于开发一个调用特定平台API的包
+    #
+    # flutter工程的工程类型可从flutter工程目录的 .metadata 文件中读取获得
+    # 如果不存在 .metadata 文件，则判断 pubspec.yaml 是否存在 author 配置，若存在，说明是一个 Package工程
+    #
+    def self.is_package_project_type?(flutter_project_dir)
+      metadata_file_path = flutter_project_dir + "/.metadata"
+
+      if File.exist?(metadata_file_path)
+        begin
+          metadata_file = File.open(metadata_file_path, 'r')
+          metadata_config = YAML.load(metadata_file)
+          project_type = metadata_config["project_type"]
+          if project_type.nil?
+            project_type = "unknown"
+          end
+          project_type = project_type.downcase
+
+          if project_type == "package" || project_type == "plugin"
+            return true
+          end
+
+        rescue YAML::SyntaxError => e
+          puts("YAML Syntax Error: #{e}".error_style)
+          puts("")
+        ensure
+          metadata_file.close
+        end
+      else
+        message = <<-MESSAGE
+#{"[!]: warning, metadata file is missed, flr can not make sure to get a right project type of this flutter project".warning_style}
+#{"[!]: then flr maybe generate buggy r.g.dart".warning_style}
+#{"[*]: to fix it, you can manually copy the metadata file of a flutter project with same project type to #{metadata_file_path}".tips_style}
+
+        MESSAGE
+        puts(message)
+
+        begin
+          pubspec_file_path = get_pubspec_file_path(flutter_project_dir)
+          pubspec_config = load_pubspec_config_from_file(pubspec_file_path)
+          if pubspec_config.has_key?("author")
+            return true
+          end
+        rescue Exception => e
+          puts(e.message)
+        end
+      end
+
+      return false
+    end
+
     # 判断当前文件是不是非SVG类图片资源文件
     def self.is_non_svg_image_resource_file?(file)
       file_extname = File.extname(file).downcase

data/lib/flr/version.rb

@@ -1,9 +1,9 @@
 module Flr
   # 工具版本号
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 
   # 核心逻辑版本号
-  CORE_VERSION = "2.0.0"
+  CORE_VERSION = "3.0.0"
 
   class Version < Array
     def initialize str

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flr
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - York
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler