pprof 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8843e85a32a30167805e1aa3cef04d1626b05f7f1d1c130b1558d9e3bfaa809
-  data.tar.gz: 4ef87037d3779a327d32bb87fb73fc3501d94d4406bb9529fc1049775a23f93e
+  metadata.gz: 21276029f4a059802fcc59cdf37a843caa2b38cc11d6af22f76fa2969bf24975
+  data.tar.gz: 02eedbe630b35226f7a00c531d0b8075b11ab6f4c705434e2f4e4f3445251c8d
 SHA512:
-  metadata.gz: 19fe84e13c4007da01357055deb1350eb0108fe31dd45466827208d7d59f9a858dedc8450e1f0cc2f7863db567263638371ce97536d66b5db054c021c5caa612
-  data.tar.gz: 065fbe7cd8cc1af06ca4e739ca1e901694cf711039c345cd2bd9086090b80af503b616ce2babeedf0120bb692c8d425472e8ad8b2d645efb4569f42771cd63bc
+  metadata.gz: 48eb1f57db15c832e6a9acf454d9c6a5ce3be07dc7db4d5877cccb7c32c96f6cfddcf7b3be78a8af8c2c9374148961273a0a1e22a5f51e13b0d8df7359b20ed7
+  data.tar.gz: fdb8efa34984352bc61242ae6452c3e5f6a6e3c11708735c0061d202dae12d8c232458ad88f02d572579221e7d1b8e7e30b1c457048ad626097d80d9825e5aba

data/bin/pprof

@@ -40,6 +40,8 @@ parser = OptionParser.new do |opts|
     |Tips:
     |  - If you want to search for _exact_ match, you can use and anchored RegEx like `/^InHouse$/i`
     |  - To remove all expired certificates, you can use `#{opts.program_name} -e0 | xargs -0 rm`
+    |  - You can combine the `--json` output with `jq` to generate and filter using some powerful custom outputs.
+    |    e.g.: `#{opts.program_name} --name 'My App' --json --devices | jq '.[] | {uuid:.UUID, name:.AppIDName, nb_profiles: .ProvisionedDevices|length}'`
   BANNER
 
   opts.separator ''
@@ -64,6 +66,9 @@ parser = OptionParser.new do |opts|
   opts.on('-p', '--path', 'Print only the paths, one per line (instead of an ASCII table)') do
     list_options[:mode] = :path
   end
+  opts.on('-j', '--json', 'Print the output information as a JSON') do
+    list_options[:mode] = :json
+  end
   opts.on('-0', '--print0', 'Separate each found entry by \\0, to be used by `xargs -0`') do
     list_options[:zero] = true
   end
@@ -139,7 +144,7 @@ unless filters.empty? || ARGV.empty?
   exit
 end
 
-unless options.empty? || !ARGV.empty?
+unless list_options[:mode] == :json || options.empty? || !ARGV.empty?
   puts 'You should use option flags only when providing an specific path.'
   puts parser # Usage
   exit
@@ -151,14 +156,25 @@ o = PProf::OutputFormatter.new
 if ARGV.empty?
   # Print list of matching profiles
   list_options[:mode] = :path if list_options[:zero] && list_options[:mode] == :table
-  o.print_filtered_list(PProf::ProvisioningProfile::DEFAULT_DIR, filters, list_options)
+  filter_func = o.filter_proc(filters)
+  case list_options[:mode]
+  when :table
+    o.print_table(&filter_func)
+  when :json
+    o.print_json_list(options: options, &filter_func)
+  else
+    o.print_list(options: list_options, &filter_func)
+  end
 else
   begin
     # Print info about given profile path/UUID
     p = PProf::ProvisioningProfile.new(ARGV[0])
-
     options = { info: true } if options.empty?
-    o.print_info(p, options)
+    if list_options[:mode] == :json
+      o.print_json(p, options)
+    else
+      o.print_info(p, options)
+    end
   rescue StandardError => e
     o.print_error(e, ARGV[0])
   end

data/lib/pprof/output_formatter.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
+require 'json'
+
 # Module for the pprof tool to manipulate Provisioning Profiles
 module PProf
   # A helper tool to pretty-print Provisioning Profile informations
   class OutputFormatter
+    # List of properties of a `PProf::ProvisioningProfile` to print when using the `-i` flag
+    MAIN_PROFILE_KEYS = %i[name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name]
+
     # Initialize a new OutputFormatter
     #
     # @param [IO] output
@@ -63,8 +68,7 @@ module PProf
     def print_info(profile, options = nil)
       options ||= { info: true }
       if options[:info]
-        keys = %i[name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids
-                  team_name]
+        keys = MAIN_PROFILE_KEYS
         keys.each do |key|
           @output.puts "- #{key}: #{profile.send(key.to_sym)}"
         end
@@ -93,27 +97,57 @@ module PProf
       # rubocop:enable Style/GuardClause
     end
 
-    # Prints the filtered list of Provisioning Profiles
+    # Returns a Provisioning Profile hash ready to be printed as a JSON output
     #
-    # Convenience method. Calls self.print_list with a filter block build from a filter hash
+    # @param [Array<PProf::ProvisioningProfile>] profile
+    #        List of provisioning profiles to include in the JSON output
+    # @param [Hash] options
+    #        Options to indicate what to include in the generated JSON.
+    #        `:certs`: if set to `true`, output will also include the info about `DeveloperCertificates` in each profile
+    #        `:devices`: if set to `true`, output will also include the list of `ProvisionedDevices` for each profile
     #
-    # @param [String] dir
-    #        The directory to search for the provisioning profiles. Defaults to the standard directory on Mac
+    # @return [Hash] The hash ready to be `JSON.pretty_generate`'d
+    #
+    def as_json(profile, options = {})
+      hash = profile.to_hash.dup
+      hash.delete 'DER-Encoded-Profile'
+      hash.delete 'ProvisionedDevices' unless options[:devices]
+      if options[:certs]
+        hash['DeveloperCertificates'] = profile.developer_certificates.map do |cert|
+          {
+            subject: cert.subject,
+            issuer: cert.issuer,
+            serial: cert.serial,
+            expires: cert.not_after
+          }
+        end
+      else
+        hash.delete 'DeveloperCertificates'
+      end
+      hash
+    end
+
+    # Prints a Provisioning Profile as JSON
+    #
+    # @param [Array<PProf::ProvisioningProfile>] profile
+    #        List of provisioning profiles to include in the JSON output
+    # @param [Hash] options
+    #        Options to indicate what to include in the generated JSON.
+    #        `:certs`: if set to `true`, output will also include the info about `DeveloperCertificates` in each profile
+    #        `:devices`: if set to `true`, output will also include the list of `ProvisionedDevices` for each profile
+    #
+    def print_json(profile, options = {})
+      @output.puts JSON.pretty_generate(as_json(profile, options))
+    end
+
+    # Generates a lambda which takes a `PProf::ProvisioningProfile` and returns if it should be kept in our listing or not
     #
     # @param [Hash<Symbol,Any>] filters
     #        The hash describing the applied filters
+    # @return [Lambda] A lambda which takes a `PProf::ProvisioningProfile` and returns `true` if it matches the provided `filters`
     #
-    # @param [Hash<Symbol,Any>] list_options
-    #        The way to print the output.
-    #        * Valid values for key `:mode` are:
-    #          - `:table` (for ASCII table output)
-    #          - `:list` (for plain list of only the UUIDs, suitable for piping to `xargs`)
-    #          - `:path` (for plain list of only the paths, suitable for piping to `xargs`)
-    #        * Valid values for key `:zero` are `true` or `false` to decide if we print `\0` at the end of each output.
-    #          Only used by `:list` and `:path` modes
-    #
-    def print_filtered_list(dir = PProf::ProvisioningProfile::DEFAULT_DIR, filters = {}, list_options = { mode: :table })
-      filter_func = lambda do |p|
+    def filter_proc(filters = {})
+      lambda do |p|
         (filters[:name].nil? || p.name =~ filters[:name]) &&
           (filters[:appid_name].nil? || p.app_id_name =~ filters[:appid_name]) &&
           (filters[:appid].nil? || p.entitlements.app_id =~ filters[:appid]) &&
@@ -125,13 +159,6 @@ module PProf
           (filters[:aps_env].nil? || match_aps_env(p.entitlements.aps_environment, filters[:aps_env])) &&
           true
       end
-
-      case list_options[:mode]
-      when :table
-        print_table(dir, &filter_func)
-      else
-        print_list(dir, list_options, &filter_func)
-      end
     end
 
     # Prints the filtered list as a table
@@ -144,7 +171,7 @@ module PProf
     #        The block is given ProvisioningProfile object and should
     #        return true to display the row, false to filter it out
     #
-    def print_table(dir = PProf::ProvisioningProfile::DEFAULT_DIR)
+    def print_table(dir: PProf::ProvisioningProfile::DEFAULT_DIR)
       count = 0
       errors = []
 
@@ -181,21 +208,21 @@ module PProf
     #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     # @param [Hash] options
     #        The options hash typically filled while parsing the command line arguments.
-    #         - :mode: will print the UUIDs if set to `:uuid`, the file path otherwise
+    #         - :mode: will print the UUIDs if set to `:list`, the file path otherwise
     #         - :zero: will concatenate the entries with `\0` instead of `\n` if set
     #
     # @yield each provisioning profile for filtering/validation
     #        The block is given ProvisioningProfile object and should
     #        return true to display the row, false to filter it out
     #
-    def print_list(dir = PProf::ProvisioningProfile::DEFAULT_DIR, options) # rubocop:disable Style/OptionalArguments
+    def print_list(dir: PProf::ProvisioningProfile::DEFAULT_DIR, options:) # rubocop:disable Style/OptionalArguments
       errors = []
       Dir['*.mobileprovision', base: dir].each do |file_name|
         file = File.join(dir, file_name)
         p = PProf::ProvisioningProfile.new(file)
         next if block_given? && !yield(p)
 
-        @output.print options[:mode] == :uuid ? p.uuid.chomp : file.chomp
+        @output.print options[:mode] == :list ? p.uuid.chomp : file.chomp
         @output.print options[:zero] ? "\0" : "\n"
       rescue StandardError => e
         errors << { message: e, file: file }
@@ -203,6 +230,33 @@ module PProf
       errors.each { |e| print_error(e[:message], e[:file]) } unless errors.empty?
     end
 
+    # Prints the filtered list of profiles as a JSON array
+    #
+    # @param [String] dir
+    #        The directory containing the mobileprovision files to list.
+    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
+    # @param [Hash] options
+    #        The options hash typically filled while parsing the command line arguments.
+    #         - :certs: will print the UUIDs if set to `:list`, the file path otherwise
+    #         - :devices: will concatenate the entries with `\0` instead of `\n` if set
+    #
+    # @yield each provisioning profile for filtering/validation
+    #        The block is given ProvisioningProfile object and should
+    #        return true to display the row, false to filter it out
+    #
+    def print_json_list(dir: PProf::ProvisioningProfile::DEFAULT_DIR, options:) # rubocop:disable Style/OptionalArguments
+      errors = []
+      profiles = Dir['*.mobileprovision', base: dir].map do |file_name|
+        file = File.join(dir, file_name)
+        p = PProf::ProvisioningProfile.new(file)
+        as_json(p, options) unless block_given? && !yield(p)
+      rescue StandardError => e
+        errors << { message: e, file: file }
+      end.compact
+      errors.each { |e| print_error(e[:message], e[:file]) } unless errors.empty?
+      @output.puts JSON.pretty_generate(profiles)
+    end
+
     def self.match_aps_env(actual, expected)
       return false if actual.nil? # false if no Push entitlements
       return true if expected == true # true if Push present but we don't filter on specific env

data/lib/pprof/provisioning_profile.rb

@@ -146,7 +146,7 @@ module PProf
     #
     # @return [Hash]
     def to_hash
-      @dict
+      @plist
     end
 
     # The human-readable string representation of this Provisioning Profile

data/lib/pprof/version.rb

@@ -2,5 +2,5 @@
 
 module PProf
   # Module version
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pprof
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Olivier Halligon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -44,7 +44,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,15 +52,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.19
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A Provisioning Profiles library
 test_files: []