cocoapods-entitlements-statistics 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18c67b431404139e32390800cee36de2c9443a053716f29832d32d22424954a
-  data.tar.gz: be771fb8171db38589b66f32155b946958d5d34b79b4ace92f8e8e6ea146bbd5
+  metadata.gz: 78d44f3a0db351e7ad3cb4bbb426580cffcf959a9cf4621d989458a1e2cc657f
+  data.tar.gz: 4245ab156cf2c05355ce391493dbd5fd58266dd038e3d9e75ecead3c6c74ead0
 SHA512:
-  metadata.gz: e3596496a3b67f9ae0cb268fe08118f415ca5e9073cea82017bb8176cef932158b44768cfbcebb9b7185b74ff293420895f2221c8aa02d069ebae6dc04305c70
-  data.tar.gz: 9c740e1c280ab955be62a9f51a7678bc07a50c5a28d16049cedf1964283f17ec0c12d87a6cab6710c0540821f6da7a888130264b3e7ca0d72b63a2288951f1a1
+  metadata.gz: e07b6ba5362321dfcb4edffa1431ef56bf95d4ee3bf40a287e45e1853ce6d8a88675c024bd2a802d7c7bae09f29f83d63915c182b03d21a12de1674d21979997
+  data.tar.gz: '0956de16c391e87cfd659e3310d24904f5c234a171580a40f4f9c335a343d87ba26df231ad0edd703230e334a3d1898761e572f47aa9a455c18e3fdd6d30fb3f'

data/Gemfile

@@ -2,8 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cocoapods-entitlements-statistics.gemspec
 gemspec
-gem 'crimp'
-gem 'zip'
+
 
 group :development do
   gem 'cocoapods'
@@ -14,5 +13,6 @@ group :development do
   gem 'prettybacon'
   gem 'crimp'
   gem 'zip'
+  gem 'terminal-table'
 
 end

data/README.md

@@ -6,16 +6,25 @@ iOS app 权限统计, 使用cocoapods plugin 触发
 ## 安装
 
 ```shell
-# 下载Releases v0.0.1 gem文件，然后进入下载目录执行下面命令
-sudo gem install cocoapods-entitlements-statistics-0.0.1.gem
+sudo gem install cocoapods-entitlements-statistics
 ```
 
 ## 使用
 
+在Gemfile中声明插件
+
+```ruby
+source "https://rubygems.org"
+#声明
+gem 'cocoapods-entitlements-statistics'
+...
+```
+
+
 在 Podfile 文件添加插件引用
 
 ```ruby
-#引入插件, 可以自定义 report_path, 默认在(iOS)项目根目录
+#引入, 可以自定义 report_path, 默认在(iOS)项目根目录
 plugin 'cocoapods-entitlements-statistics', :report_path => '/Users/rd01/Desktop'
 #plugin 'cocoapods-entitlements-statistics'
 
@@ -34,6 +43,10 @@ Pod installation complete! There are 75 dependencies from the Podfile and 116 to
 
 ```
 
+> 也可以手动执行cli 命令
+>
+> 仓库地址： https://github.com/olaola-chat/cli-app_permission_statistics
+
 ## 说明
 
 ##### 版本权限统计
@@ -102,11 +115,19 @@ remove capabilitys :
 #### 涉及的文件 
 
 * info.plist 
-* Runner.entitlements  Capabilitys被添加后的，Xcode自动创建plist格式文件，里面包含相关Capability的声明、设置
+* Runner.entitlements 
+
+  Capabilitys被添加后的，Xcode自动创建plist格式文件，里面包含相关Capability的声明、设置
+
 * {embedded/xxx-xx-xx}.mobileprovision
-包括里面的Entitlements字段, 保存一些 Capabilitys被添加后的 声明、设置
+
+   embedded.mobileprovision 存在于IPA包中,被发送到Appstore，真正安装的app 却没有这个文件
+
+   xxx-xx-xx.mobileprovision 在打包成IPA前用于工程签名的描述文件
+两者基本一致，包括里面的Entitlements字段, 保存一些 Capabilitys被添加后的 声明、设置
 * Runner.xcodeproj 
-工程文件SystemCapabilities字段包含了一些Capabilitys声明
+
+    工程文件SystemCapabilities字段包含了一些Capabilitys 的开关字段 
 
 相关文档：
 

data/lib/cocoapods-entitlements-statistics/app_entitlements_statistics/analyze.rb

@@ -3,6 +3,7 @@
 require_relative "helper"
 require 'fileutils'
 require 'yaml'
+require 'terminal-table'
 
 module AppEntitlementsStatistics
 
@@ -13,25 +14,27 @@ module AppEntitlementsStatistics
         attr_reader :report_path
         attr_reader :identifier
 
-        def initialize(identifier,report_path: nil, store_path: nil)
+        def initialize(identifier,report_path = nil,store_path = nil)
             @identifier = identifier
             @report_path = report_path 
             @store_path = store_path
         end
 
-        def analyze
-            load_version
-            return singleGenerate unless @versions.length > 1
-            pre_version = @versions[1]
-            cur_version = @versions[0]
-            pre_entitlements = load_entitlements_yaml(pre_version)
-            cur_entitlements = load_entitlements_yaml(cur_version)
+        def analyze(versions=[])
+            versions.sort{|x,y| y<=>x } unless versions.size < 2
+            if versions.length < 2
+                load_version
+                return singleGenerate unless @versions.length > 1
+            else
+                @versions = versions
+            end
+            pre_entitlements = load_entitlements_yaml(@versions[1])
+            cur_entitlements = load_entitlements_yaml(@versions[0])
             return "" unless pre_entitlements.any?
             return "" unless cur_entitlements.any?
 
-            capabilities_diff = analyze_capabilities_diff(pre_entitlements,cur_entitlements)
-            usage_descs_diff = analyze_usage_descs_diff(pre_entitlements,cur_entitlements);
-            report_path = generate(capabilities_diff,usage_descs_diff)
+            capabilities_diff = analyze_diff(pre_entitlements,cur_entitlements)
+            report_path = generate(capabilities_diff)
             report_path
         end
 
@@ -48,28 +51,26 @@ module AppEntitlementsStatistics
             report_path
         end
 
-        def generate(capabilities_diff,usage_descs_diff)
+
+        def generate(capabilities_diff)
             return unless @versions.length > 1
             cur_version = @versions[0]
             pre_version = @versions[1]
-
-            output =  "\n" + "compared #{cur_version}  #{pre_version}"
+            output = ""
             output += "\n" + capabilities_diff unless capabilities_diff.empty?
-            output += "\n" + usage_descs_diff unless usage_descs_diff.empty?
-            output += "\n\nThere is no difference between the two versions \n\n" unless (!capabilities_diff.empty? && !usage_descs_diff.empty?)
+            output += "\n\nThere is no difference between the two versions  【 #{@versions[0]} vs #{@versions[1]}】\n\n" unless !capabilities_diff.empty?
             # puts output
-
             output += "\n\n\n#{cur_version} entitlements list: "
             output += "\n" + read_each_line(cur_version)
             output += "\n" + "----------------------------------------"
             output += "\n\n#{pre_version} entitlements list: "
             output += "\n" + read_each_line(pre_version)
-            output += "\n" + "----------------------------------------"
 
             report_path = report_file_name(path: @report_path)
             File.open(report_path, 'w') { |file|
                 file.write(output)
             }
+            # puts "detail file: #{File.expand_path(report_path)}"
             report_path
         end
 
@@ -99,120 +100,97 @@ module AppEntitlementsStatistics
             yaml_content
         end
 
-        def analyze_capabilities_diff(pre,cur)
+        def analyze_diff(pre,cur)
             output = ""
             cur_capabilities_summary =  cur['Capabilities_Summary']
             pre_capabilities_summary = pre['Capabilities_Summary']
-            cur_capabilities = cur['Capabilities']
-            pre_capabilities = pre['Capabilities']
-            output = ""
+
+            cur_usage_descs_summary =  cur['PermissionsUsageDescription_Summary']
+            pre_usage_descs_summary = pre['PermissionsUsageDescription_Summary']
+
+            # cur_capabilities = cur['Capabilities']
+            # pre_capabilities = pre['Capabilities']
+
+            # cur_usage_descs = cur['PermissionsUsageDescription']
+            # pre_usage_descs = pre['PermissionsUsageDescription']
+
             # 修改
             comm_capabilities = cur_capabilities_summary.keys & pre_capabilities_summary.keys
-            modifys = modifys_cur = modifys_pre = ""
+            modifyed_rows = []
             comm_capabilities.each do |key|
                 if cur_capabilities_summary[key] != pre_capabilities_summary[key]
-                    modifys_cur +=  "\n" + '- ' + key + ': ' + cur_capabilities[key].to_s
-                    modifys_pre +=  "\n" + '- ' + key + ': ' + pre_capabilities[key].to_s
+                    modifyed_rows << [ '- ' + key ]
                 end
             end
 
-            modifys +=  "\n" + @versions[0] unless modifys_cur.empty?
-            modifys +=  modifys_cur unless modifys_cur.empty?
-            modifys +=  "\n" + @versions[1] unless modifys_pre.empty?
-            modifys +=  modifys_pre unless modifys_pre.empty?
-
-            #新增
-            add_capabilities = cur_capabilities_summary.keys - pre_capabilities_summary.keys
-            adds = ""
-            add_capabilities.each do |key|
-                adds +=  "\n" + '- ' + key + ': ' + cur_capabilities[key].to_s
-            end
-
-            #移除
-            remove_capabilities = pre_capabilities_summary.keys - cur_capabilities_summary.keys
-            removes = ""
-            remove_capabilities.each do |key|
-                removes +=  "\n" + '- ' + key + ': ' + pre_capabilities[key].to_s
-            end
-            
-            if !modifys.empty?
-                output +=  "\n" + "modify capabilitys : " 
-                output +=  modifys 
-                output +=  "\n------------------------------"     
-            end
-
-            if !adds.empty?
-                output +=  "\n" + "add capabilitys : " 
-                output +=  adds 
-                output +=  "\n------------------------------"     
-            end
-
-            if !removes.empty?
-                output +=  "\n" + "remove capabilitys : " 
-                output +=  removes 
-                output +=  "\n------------------------------" 
-            end
-
-            output
-        end 
-
-        def analyze_usage_descs_diff(pre,cur)
-            output = ""
-            cur_usage_descs_summary =  cur['PermissionsUsageDescription_Summary']
-            pre_usage_descs_summary = pre['PermissionsUsageDescription_Summary']
-    
-            cur_usage_descs = cur['PermissionsUsageDescription']
-            pre_usage_descs = pre['PermissionsUsageDescription']
-    
-            # 修改
             comm_usage_descs = cur_usage_descs_summary.keys & pre_usage_descs_summary.keys
-            modifys = modifys_cur = modifys_pre = ""
             comm_usage_descs.each do |key|
                 if cur_usage_descs_summary[key] != pre_usage_descs_summary[key]
-                    modifys_cur += "\n" + '- ' + key + ': ' + cur_usage_descs[key].to_s
-                    modifys_pre += "\n" +  '- ' + key + ': ' + pre_usage_descs[key].to_s
+                    modifyed_rows << [ '- ' + key  ]
                 end
             end
 
-            modifys +=  "\n" + @versions[0] unless modifys_cur.empty?
-            modifys +=  modifys_cur unless modifys_cur.empty?
-            modifys +=  "\n" + @versions[1] unless modifys_pre.empty?
-            modifys +=  modifys_pre unless modifys_pre.empty?
 
             #新增
+            add_capabilities = cur_capabilities_summary.keys - pre_capabilities_summary.keys
+            added_rows = []
+            add_capabilities.each do |key|
+                added_rows << ['- ' + key ] #+ ': ' + cur_capabilities[key].to_s
+            end
+
             add_usage_descs = cur_usage_descs_summary.keys - pre_usage_descs_summary.keys
-            adds = ""
             add_usage_descs.each do |key|
-                adds += "\n" +  '- ' + key + ': ' + cur_usage_descs[key].to_s
+                added_rows << [ '- ' + key ] #+ ': ' + cur_usage_descs[key].to_s 
             end
 
             #移除
+            remove_capabilities = pre_capabilities_summary.keys - cur_capabilities_summary.keys
+            removed_rows = []
+            remove_capabilities.each do |key|
+                removed_rows << ['- ' + key ] #+ ': ' + pre_capabilities[key].to_s
+            end
+
             remove_usage_descs = pre_usage_descs_summary.keys - cur_usage_descs_summary.keys
-            removes = ""
             remove_usage_descs.each do |key|
-                removes += "\n" +  '- ' + key + ': ' + pre_usage_descs[key].to_s
+                removed_rows << [  '- ' + key ] #+ ': ' + pre_usage_descs[key].to_s 
             end
 
-            if !modifys.empty?
-                output += "\n" + "modify permissions usage description : " 
-                output +=  modifys 
-                output +=  "\n------------------------------"     
+            # Summary
+            max_count = [modifyed_rows.size,added_rows.size,removed_rows.size].max
+            if max_count == 0
+                return output
             end
 
-            if !adds.empty?
-                output += "\n" + "add permissions usage description : " 
-                output +=  adds 
-                output +=  "\n------------------------------"     
+            table = Terminal::Table.new do |t|
+                t.title = "Compared #{@versions[0]} to #{@versions[1]} Summary"
+                t.add_row ["Modifyed", modifyed_rows.size ]
+                t.add_row ["New", added_rows.size ]
+                t.add_row ["Remove", removed_rows.size ]
             end
+            output += table.to_s + "\n\n"
 
-            if !removes.empty?
-                output += "\n" + "remove permissions usage description : " 
-                output +=  removes 
-                output +=  "\n------------------------------" 
+            def get_value(arr,n)
+                return "" unless arr.length > n
+                return arr[n].first unless arr.length == 0
+                return ""
             end
 
+            detail_table = Terminal::Table.new do |t|
+                t.headings = ['Modifyed', 'New', 'Remove']
+                (0..max_count-1).each do |n|
+                    t.add_row [
+                        get_value(modifyed_rows,n),
+                        get_value(added_rows,n),
+                        get_value(removed_rows,n),
+                    ]
+                end
+            end
+            output += detail_table.to_s + "\n\n"    
             output
-        end
+        end 
+
     end
+end
 
-end
+obj = AppEntitlementsStatistics::Analyzer.new('com.ola.chat')
+obj.analyze(["5.3.0","5.2.0"])

data/lib/cocoapods-entitlements-statistics/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsEntitlementsStatistics
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-entitlements-statistics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - bin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -106,6 +106,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A short description of cocoapods-entitlements-statistics.
 email:
 - tang.bin@olaola.chat
@@ -118,7 +132,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- cocoapods-entitlements-statistics.gemspec
 - lib/cocoapods-entitlements-statistics.rb
 - lib/cocoapods-entitlements-statistics/app_entitlements_statistics/analyze.rb
 - lib/cocoapods-entitlements-statistics/app_entitlements_statistics/core_ext/inflector.rb

data/cocoapods-entitlements-statistics.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cocoapods-entitlements-statistics/gem_version.rb'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'cocoapods-entitlements-statistics'
-  spec.version       = CocoapodsEntitlementsStatistics::VERSION
-  spec.authors       = ['bin']
-  spec.email         = ['tang.bin@olaola.chat']
-  spec.description   = %q{A short description of cocoapods-entitlements-statistics.}
-  spec.summary       = %q{A longer description of cocoapods-entitlements-statistics.}
-  spec.homepage      = 'https://github.com/EXAMPLE/cocoapods-entitlements-statistics'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency "yaml"
-  spec.add_runtime_dependency "crimp"
-  spec.add_dependency 'CFPropertyList', '< 3.1.0', '>= 2.3.4'
-  spec.add_development_dependency 'bundler', '>= 1.12'
-  spec.add_dependency 'rubyzip', '>= 1.2', '< 3.0'
-  spec.add_development_dependency 'rake'
-end