flr 1.0.0 → 3.2.0

data/lib/flr/util/file_util.rb

@@ -8,20 +8,36 @@ module Flr
 
     # get_cur_flutter_project_root_dir -> String
     #
-    # 获取当前flutter工程的根目录
+    # 获取flutter主工程的根目录
     #
-    def self.get_cur_flutter_project_root_dir
+    def self.get_flutter_main_project_root_dir
       flutter_project_root_dir = "#{Pathname.pwd}"
       return flutter_project_root_dir
     end
 
-    # get_pubspec_file_path -> String
+    # get_flutter_sub_project_root_dirs -> [sub_project_root_dir]
+    #
+    # 获取flutter主工程的所有子工程的根目录
+    #
+    def self.get_flutter_sub_project_root_dirs(flutter_main_project_root_dir)
+      flutter_sub_project_root_dir_array = []
+      Dir.glob(["#{flutter_main_project_root_dir}/*/pubspec.yaml"]).each do |file|
+        flutter_project_root_dir = File.dirname(file)
+        flutter_sub_project_root_dir_array.push(flutter_project_root_dir)
+      end
+      return flutter_sub_project_root_dir_array
+    end
+
+    # 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 +95,120 @@ 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
+
+      if Flr::NON_SVG_IMAGE_FILE_TYPES.include?(file_extname)
+        return true;
+      end
+
+      return false
+    end
+
+    # 判断当前文件是不是SVG类图片资源文件
+    def self.is_svg_image_resource_file?(file)
+      file_extname = File.extname(file).downcase
+
+      if Flr::SVG_IMAGE_FILE_TYPES.include?(file_extname)
+        return true;
+      end
+
+      return false
+    end
+
+    # 判断当前文件是不是图片资源文件
+    def self.is_image_resource_file?(file)
+      file_extname = File.extname(file).downcase
+
+      if Flr::IMAGE_FILE_TYPES.include?(file_extname)
+        return true;
+      end
+
+      return false
+    end
+
+    # 判断当前文件是不是文本资源文件
+    def self.is_text_resource_file?(file)
+      file_extname = File.extname(file).downcase
+
+      if Flr::TEXT_FILE_TYPES.include?(file_extname)
+        return true;
+      end
+
+      return false
+    end
+
+    # 判断当前文件是不是字体资源文件
+    def self.is_font_resource_file?(file)
+      file_extname = File.extname(file).downcase
+
+      if Flr::FONT_FILE_TYPES.include?(file_extname)
+        return true;
+      end
+
+      return false
+    end
+
     # is_legal_resource_file??(file) -> true or false
     #
     # 判断当前资源文件是否合法
@@ -87,8 +217,8 @@ module Flr
     # 其file_basename_no_extension 由字母（a-z、A-Z）、数字（0-9）、其他合法字符（'_', '+', '-', '.', '·', '!', '@', '&', '$', '￥'）组成
     #
     # === Examples
-    # good_file = "lib/assets/images/test.png"
-    # bad_file = "lib/assets/images/~.png"
+    # good_file = "~/path/to/flutter_project/lib/assets/images/test.png"
+    # bad_file = "~/path/to/flutter_project/lib/assets/images/~.png"
     # is_legal_resource_file?(good_file) -> true
     # is_legal_resource_file?(bad_file) -> false
     #
@@ -105,25 +235,26 @@ module Flr
 
     # find_image_files(resource_dir)  ->  image_file_result_tuple
     #
-    # 扫描指定的资源目录和其第1级子目录，查找所有图片文件
+    # 扫描指定的资源目录和其所有层级的子目录，查找所有图片文件
     # 返回图片文件结果二元组 image_file_result_tuple
     # image_file_result_tuple = [legal_image_file_array, illegal_image_file_array]
     #
     # 判断文件合法的标准参考 self.is_legal_resource_file? 方法
     #
     # === Examples
-    # resource_dir = "lib/assets/images"
-    # legal_image_file_array = ["lib/assets/images/test.png", "lib/assets/images/2.0x/test.png"]
-    # illegal_image_file_array = ["lib/assets/images/~.png"]
+    # resource_dir = "~/path/to/flutter_project/lib/assets/images"
+    # legal_image_file_array = ["~/path/to/flutter_project/lib/assets/images/test.png", "~/path/to/flutter_project/lib/assets/images/2.0x/test.png"]
+    # illegal_image_file_array = ["~/path/to/flutter_project/lib/assets/images/~.png"]
     #
     def self.find_image_files(resource_dir)
       legal_image_file_array = []
       illegal_image_file_array = []
 
       pattern_file_types = Flr::IMAGE_FILE_TYPES.join(",")
-      # dir/*{.png.,.jpg} : 查找当前目录的指定类型文件
-      # dir/*/*{.png.,.jpg}: 查找当前目录的第1级子目录的指定类型文件
-      Dir.glob(["#{resource_dir}/*{#{pattern_file_types}}", "#{resource_dir}/*/*{#{pattern_file_types}}"]).each do |file|
+      # dir/*{.png,.jpg} : 查找当前目录的指定类型文件
+      # dir/*/*{.png,.jpg}: 查找当前目录的第1级子目录的指定类型文件
+      # dir/**/*{.png,.jpg}:  查找当前目录和其所有子目录的指定类型文件
+      Dir.glob(["#{resource_dir}/**/*{#{pattern_file_types}}"]).each do |file|
         if is_legal_resource_file?(file)
           legal_image_file_array.push(file)
         else
@@ -144,9 +275,9 @@ module Flr
     # 判断文件合法的标准参考 self.is_legal_resource_file? 方法
     #
     # === Examples
-    # resource_dir = "lib/assets/jsons"
-    # legal_text_file_array = ["lib/assets/jsons/city.json", "lib/assets/jsons/mock/city.json"]
-    # illegal_text_file_array = ["lib/assets/jsons/~.json"]
+    # resource_dir = "~/path/to/flutter_project/lib/assets/jsons"
+    # legal_text_file_array = ["~/path/to/flutter_project/lib/assets/jsons/city.json", "~/path/to/flutter_project/lib/assets/jsons/mock/city.json"]
+    # illegal_text_file_array = ["~/path/to/flutter_project/lib/assets/jsons/~.json"]
     #
     def self.find_text_files(resource_dir)
       legal_text_file_array = []
@@ -171,7 +302,8 @@ module Flr
     # 扫描指定的资源目录，返回其所有第一级子目录
     #
     # === Examples
-    # top_child_dir_array = ["lib/assets/fonts/Amiri", "lib/assets/fonts/Open_Sans"]
+    # resource_dir = "~/path/to/flutter_project/lib/assets/fonts"
+    # top_child_dir_array = ["~/path/to/flutter_project/lib/assets/fonts/Amiri", "~/path/to/flutter_project/lib/assets/fonts/Open_Sans"]
     #
     def self.find_top_child_dirs(resource_dir)
       top_child_dir_array = []
@@ -194,9 +326,9 @@ module Flr
     # 判断文件合法的标准参考 self.is_legal_resource_file? 方法
     #
     # === Examples
-    # font_family_dir = "lib/assets/fonts/Amiri"
-    # legal_font_file_array = ["lib/assets/fonts/Amiri/Amiri-Regular.ttf", "lib/assets/fonts/Amiri/Amiri-Bold.ttf"]
-    # illegal_font_file_array = ["lib/assets/fonts/Amiri/~.ttf"]
+    # font_family_dir = "~/path/to/flutter_project/lib/assets/fonts/Amiri"
+    # legal_font_file_array = ["~/path/to/flutter_project/lib/assets/fonts/Amiri/Amiri-Regular.ttf", "~/path/to/flutter_project/lib/assets/fonts/Amiri/Amiri-Bold.ttf"]
+    # illegal_font_file_array = ["~/path/to/flutter_project/lib/assets/fonts/Amiri/~.ttf"]
     #
     def self.find_font_files_in_font_family_dir(font_family_dir)
       legal_font_file_array = []

data/lib/flr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - York
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: 'Flr(Flutter-R): A Flutter Resource Manager CLI TooL.'