cocoapods-privacy 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af764f50aa1f71cc51ccaf244e74058ebc3cb3a3b98e7ecfe108b49735a4ebe8
-  data.tar.gz: d53d311a76e6d9da2db85111b6fdc2337aecdb9d3c7a2c27f4ad520877fc09e6
+  metadata.gz: 94168860cf706b12ecc89c41a75635f23e11f5afcf0b775ebf5f927a16ab6cef
+  data.tar.gz: 8bf3705783a5023c2a6b9066029d9c8e1ec40c596101c0dcf832f5fda70b34de
 SHA512:
-  metadata.gz: 20cc27ab523c135e09b55fcf8fdaedc59c9f7847000c737a55c9bc565c8a9373be829e26a0c1f590e0e33dcef6f97008ddf76c88bf24b7332103a935fcb092bf
-  data.tar.gz: 890d80538261123f23019dffb0726d04997a6ecfed5f0b42ef04f45768b86e34b782f0d0d051d60dbf2d27eac56f526bb68bf63cc41d80afde757a06d7712293
+  metadata.gz: 1bfc8743f267c99b07afb734ef2584cd9c4ffe07960118fe2a4d2f8d82e2783dd86dd88dd716299f63ed3c373f1148d48900a9aeff24d8fef4a24257e99eecfc
+  data.tar.gz: 2b42d00dcb94b13b9bbb35df5979762e65c6ba781d1f3bc16fdf7c80988c5213b96cf7df31c05b3219170f0c16953b9c0f33f8cb7f7e490f765afbf7d6779804

data/README.md

@@ -1,35 +1,59 @@
 # cocoapods-privacy
 
-Apple 2024 will review the App's privacy list in the spring, and any apps that don't submit a privacy list may be called back. For now, the privacy list is broken down by component, to facilitate the maintenance of component privacy, cocoapods-privacy is developed for management.
+Apple 2024 will review the App's privacy manifests in the spring, and any apps that don't submit a privacy list may be called back. For now, the privacy list is broken down by component, to facilitate the maintenance of component privacy, cocoapods-privacy is developed for management.
 [Click to view details on Apple](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files)
 
+# Introduction
+As name as,cocoapods-privacy is a plugin for privacy manifests, and focus on cocoapods!
+
 ## Installation
 ```
 $ gem install cocoapods-privacy
 ```
 
 ## Usage
-#### init
+### init
 First of all, you must set a json config to cocoapods-privacy, this is a defalut config.json
 ```
 $ pod privacy config https://raw.githubusercontent.com/ymoyao/cocoapods-privacy/main/resources/config.json
 ```
 
-There has 3 keys in defalut config, you should custom it!
-* source.white.list : a white list of source, defalut is empty, so, you should add you self component sources, and it work in command 'pod privacy install' or 'pod install --privacy', will search white list for NSPrivacyAccessedAPITypes.
-* source.black.list : a black list of source, defalut is empty, it work in command 'pod privacy install' or 'pod install --privacy'.
-* api.template.url : its required, a template for search NSPrivacyAccessedAPITypes
+There has 3 keys in defalut config, defalut rule is ：To exclude retrieval a component that git source contains certain ‘github.com’ keywords
+```
+"source.white.list": [],
+"source.black.list": ["github.com"], 
+"api.template.url": "https://raw.githubusercontent.com/ymoyao/cocoapods-privacy/main/resources/NSPrivacyAccessedAPITypes.plist"
+```
+* source.white.list : a white list of source, it effective in command 'pod privacy install' or 'pod install --privacy', will search white list for NSPrivacyAccessedAPITypes.
+  * when the whitelist is an empty array, it means all components are whitelist(default config).
+  * when the whitelist is not empty, it means only the components in the whitelist array are retrieved.
+* source.black.list : a black list of source, defalut is ‘github.com’, based on the whitelist, the components need to be excluded。 it effective in command 'pod privacy install' or 'pod install --privacy'. 
+* api.template.url : its required, a template for search NSPrivacyAccessedAPITypes, you can use the provided by default。
+
+If your needs are not met, you can custom! For example, there has some components，and it‘s your local config
 ```
-"source.white.list": ["replace me with yourserver"], 
-"source.black.list": ["replace me such as github.com"],
+"source.white.list": ["https://github.com/ReactiveCocoa/ReactiveObjC.git","git.yourserver.com","git.otherserver.com"],
+"source.black.list": ["github.com","https://github.com/AFNetworking/AFNetworking.git"], 
 "api.template.url": "https://raw.githubusercontent.com/ymoyao/cocoapods-privacy/main/resources/NSPrivacyAccessedAPITypes.plist"
 ```
-After custom,you can set local config like this
+
+```
+https://github.com/AFNetworking/AFNetworking.git ❌ (it's in 'github.com' black list)
+https://github.com/ReactiveCocoa/ReactiveObjC.git ❌ (it's in 'github.com' black list, although also on the white list,but the blacklist priority is high when conflict)
+https://git.yourserver.com/xxx/xxxx.git ✅
+https://git.yourserver.com/mmm/mmm.git ✅
+https://git.otherserver.com/ssss/ssss.git ✅
+https://git.yourserver.com/AFNetworking/AFNetworking.git ✅
+```
+
+After custom,you just update config by local like this
 ```
 $ pod privacy config /yourfilepath/config.json
 ```
+In a word, if you define both white and black lists ,final search range: white list minus black list, and empty white list means all!
 
-#### To Component
+
+### To Component
 ```
 $ pod privacy spec [podspec_file_path]
 ```
@@ -71,7 +95,7 @@ end
 
 
     
-#### To Project
+### To Project
 ```
 $ pod install --privacy
 or
@@ -83,6 +107,8 @@ After command, a PrivacyInfo.xcprivacy will create to you project Resources if e
 
 ## Notice
 The plugin is focus on NSPrivacyAccessedAPITypes and automatically search and create workflow.
-you should manager NSPrivacyCollectedDataTypes by yourself！
-    
+you should manager NSPrivacyCollectedDataTypes by yourself！ 
+
+##
+Could you please consider giving our repository a star🌟🌟🌟? It would mean a lot to us and help our project gain more visibility. Thank you! 
 

data/lib/cocoapods-privacy/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsPrivacy
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

data/lib/cocoapods-privacy/privacy/PrivacyHunter.rb

@@ -187,18 +187,139 @@ module PrivacyHunter
       File.utime(File.atime(local_file_path), Time.parse(remote_file_time), local_file_path)
     end
 
+
+
+    #💡💡💡以下是 invalid byte sequence in UTF-8 错误复现 的数据代码
+    # File.write("/Users/xxx/.cache/cocoapods-privacy/privacy/file.txt", "vandflyver \xC5rhus \n
+    
+    # \n
+
+    # \\n
+
+    # vandflyver 
+    # \xC5rhus
+    # ")
     # 文件是否包含内容
     def self.contains_apis?(file_path, apis)
-      file_content = File.read(file_path)
+
+      #使用UTF-8 读取，无法读取的会被默认处理，修复 https://github.com/ymoyao/cocoapods-privacy/issues/7 
+      file_content = File.read(file_path, encoding: 'UTF-8', invalid: :replace, undef: :replace)
+
+      #核心文件检查段落注释 /* */
+      file_extension = File.extname(file_path).downcase
+      need_check_paragraph_comment = ['.m', '.c', '.swift', '.mm', '.h', '.hap', '.hpp', '.cpp'].include?(file_extension)
+
+      if need_check_paragraph_comment 
+        # 计算段注释 /**/
+        apis_found = contains_apis_ignore_all_comment(file_content.lines,apis)
+      else
+        # 计算单独行注释 //
+        apis_found = contains_apis_ignore_line_comment(file_content.lines,apis)
+      end
+      apis_found
+    end
+
+    def self.contains_apis_ignore_line_comment(lines,apis) 
       apis_found = {}
-      apis.each do |keyword, value|
-        if file_content.include?(keyword)
-          apis_found[keyword] = value
+      # 初始化状态机，表示不在注释块内
+      in_block_comment_count = 0  
+      in_block_comment = false
+      lines.each do |line|
+        next if line.strip.empty? #忽略空行
+        next if line.strip.start_with?('//') #忽略单行
+
+        apis.each do |keyword, value|
+          if line.include?(keyword)
+            apis_found[keyword] = value
+          end
         end
       end
 
       apis_found
     end
+    
+    def self.contains_apis_ignore_all_comment(lines,apis) 
+      apis_found = {}
+
+      # 段注释和单行注释标志
+      in_block_comment = false
+      in_line_comment = false
+
+      # 是否可以触发注释标识，当为true 时可以触发 /*段注释 或者 //单行注释
+      can_trigger_comments_flag = true
+
+      # 统计计数器
+      count_comments = 0
+
+      lines.each do |line|
+        next if line.strip.empty? #忽略空行
+        next if line.strip.start_with?('//') && !in_block_comment  #忽略单行
+
+        chars = line.chars
+        index = 0
+        while index < chars.size
+          char = chars[index]
+
+          if char == '/'
+            if chars[index + 1] == '*'
+              # 检测到 /* 且can_trigger_comments_flag标识为true时，判定为进入 段注释
+              if can_trigger_comments_flag 
+                in_line_comment = false #重置行标识
+                in_block_comment = true #标记正在段注释中
+                can_trigger_comments_flag = false #回收头部重置标识
+              end
+
+              #段注释每次 遇到 /* 都累加1
+              if in_block_comment
+                count_comments += 1
+              end
+
+              #跳过当前 /* 两个字符
+              index += 2
+              next
+            # 检测到 can_trigger_comments_flag 为true,且 // 时，说明触发了段注释之后的单行注释 ==》 /**///abcd
+            elsif chars[index + 1] == '/' && can_trigger_comments_flag 
+                in_line_comment = true
+                in_block_comment = false
+                can_trigger_comments_flag = true
+                break            
+            end
+          # 检测到段注释的end 标识 */
+          elsif in_block_comment && char == '*' && chars[index + 1] == '/'
+
+            #段注释每次 遇到 */ 都累减1
+            count_comments -= 1
+
+            #当/* */ 配对时，说明当前段注释结束了
+            if count_comments == 0
+              in_line_comment = false
+              in_block_comment = false 
+              can_trigger_comments_flag = true
+            end
+
+            #跳过当前 */ 两个字符
+            index += 2
+            next
+          end
+
+          # 其他情况，前进一个字符
+          index += 1
+        end
+
+        if !in_block_comment && !in_line_comment
+          apis.each do |keyword, value|
+            if line.include?(keyword)
+              apis_found[keyword] = value
+            end
+          end
+        end
+
+        #每行结束时，重置行标识
+        in_line_comment = false
+      end
+      apis_found
+    end
+
 
     #搜索所有子文件夹
     def self.search_files(folder_paths, exclude_folders, apis)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-privacy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - youhui
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler