pprof 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7691660bb69c7c6f6f4fedb4722dc0e647183378e5aa79cfa0ce2a80f7e4cef
-  data.tar.gz: ae54346cc1d76c10a89468b605a698727ff38909f683bed7ff8a6d779c6605b0
+  metadata.gz: ae8d524121a74832a72453cd1e7b7a9ab1ca9d109fbca14d8cb1ce1ef8e77747
+  data.tar.gz: 682cfa8a82f248b977c384af168129a5395f65fb440411e7d1a919726ec7bfe6
 SHA512:
-  metadata.gz: 9b2490137336562c025610bbfc7de8b0fe1a177005b9a7c7cfea21310fedb3f77164745303dc08b1816d3e8dd5a0f7a5aaa71373a71c784921982d36da4e876f
-  data.tar.gz: 22665cd4ba32a996577a8ed8099348f29193fb88589a32b1faaf8ca03298a971902373d23cdad568c59a1b6e23f59f81e3c0a3e543e8173c18ddd71f098379a5
+  metadata.gz: b740f1dd3808135315ea487366acb9f884c43b58067fa96e2c3272591528394371b1102a2db1445f2223aa461a28ba2d077838137b888aadc7b43063c366ccd3
+  data.tar.gz: 7e0f924bb2d451bc6fe6aaf4a200f0cdf0dfae5b84b841a9cfc0d2499cdb914cac8fc52074e5c9c7ebfe55fefa9aa305d97b18c91c345208906aab6335f18509

data/README.md

@@ -6,7 +6,9 @@
 
 `pprof` is a ruby library and binary to manipulate Provisioning Profiles.
 
-It can help you create ruby scripts to list, get information, find and filter local Provisioning Profiles easily.
+It can help you manage the Provisioning Profiles installed on your Mac (find the profiles UUIDs from the app names or bundle IDs, find detailed information on a given profile, clean up expired profiles from your Mac…) directly from the command line.
+
+It also supports printing the output in JSON format so you can pipe the result of printing provisioning profiles info into `jq` or similar tools.
 
 ## Installation
 
@@ -32,6 +34,8 @@ _(You might need to run this command with `sudo` if your gem home is a system di
 
 ### Using it from the command line
 
+#### Listing (and filtering) provisioning profiles
+
 ```sh
 # List all provisioning profiles
 $ pprof 
@@ -65,6 +69,8 @@ $ pprof --has-devices --aps --appid com.foo
 $ pprof --exp -0 | xargs -0 rm
 ```
 
+#### Printing info for a given Provisioning Profile
+
 ```sh
 # Print info for a given Provisioning Profile
 $ pprof '12345678-ABCD-EF90-1234-567890ABCDEF'
@@ -80,6 +86,25 @@ $ pprof --certs --devices --info '12345678-ABCD-EF90-1234-567890ABCDEF'
 $ pprof -cdi '12345678-ABCD-EF90-1234-567890ABCDEF'
 ```
 
+#### Printing output in JSON
+
+```sh
+# Print info about all your provisioning profiles as a JSON array
+$ pprof --json
+# Print info about all your provisioning profiles whose name contains "Foo", as a JSON array
+$ pprof --name "Foo" --json
+# Print info about all your provisioning profiles as a JSON array, including list of devices and certificates in each profile
+$ pprof --json --devices --certs
+
+# Print info about a specific provisioning profile as JSON object
+$ pprof --json '12345678-ABCD-EF90-1234-567890ABCDEF'
+# Print info about a specific provisioning profile as JSON object, including list of devices and certificates
+$ pprof --json -c -d '12345678-ABCD-EF90-1234-567890ABCDEF'
+
+# Use `jq` (https://stedolan.github.io/jq/) to post-process the JSON output and generate some custom JSON array of objects from it
+$ pprof --name 'My App' --json --devices | jq '.[] | {uuid:.UUID, name:.AppIDName, nb_profiles: .ProvisionedDevices|length}'
+```
+
 ### Using it in Ruby
 
 ```ruby
@@ -105,7 +130,8 @@ end
 
 # And you can easily loop on all provisioning profiles and manipulate each
 dir = PProf::ProvisioningProfile::DEFAULT_DIR
-Dir["#{dir}/*.mobileprovision"].each do |file|
+# `*.mobileprovision` are typically for iOS profiles, `*.provisionprofile` for Mac profiles
+Dir["#{dir}/*.{mobileprovision,provisionprofile}"].each do |file|
   p = PProf::ProvisioningProfile.new(file)
   puts p.name
 end

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 ''
@@ -86,6 +88,10 @@ parser = OptionParser.new do |opts|
     filters[:appid] = matcher(appid)
   end
 
+  opts.on('--platform PLATFORM', 'Filter by Platform (OSX, iOS, xrOS/visionOS, …)') do |platform|
+    filters[:platform] = platform
+  end
+
   opts.on('--uuid UUID', 'Filter by UUID') do |uuid|
     filters[:uuid] = matcher(uuid)
   end
@@ -142,7 +148,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
@@ -154,7 +160,15 @@ 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

data/lib/pprof/output_formatter.rb

@@ -7,7 +7,7 @@ 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]
+    MAIN_PROFILE_KEYS = %i[name uuid app_id_name app_id_prefix creation_date expiration_date ttl team_ids team_name].freeze
 
     # Initialize a new OutputFormatter
     #
@@ -113,7 +113,7 @@ module PProf
       hash.delete 'DER-Encoded-Profile'
       hash.delete 'ProvisionedDevices' unless options[:devices]
       if options[:certs]
-        hash['DeveloperCertificates'] = developer_certificates.map do |cert|
+        hash['DeveloperCertificates'] = profile.developer_certificates.map do |cert|
           {
             subject: cert.subject,
             issuer: cert.issuer,
@@ -140,27 +140,14 @@ module PProf
       @output.puts JSON.pretty_generate(as_json(profile, options))
     end
 
-    # Prints the filtered list of Provisioning Profiles
-    #
-    # Convenience method. Calls self.print_list with a filter block build from a filter hash
-    #
-    # @param [String] dir
-    #        The directory to search for the provisioning profiles. Defaults to the standard directory on Mac
+    # 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]) &&
@@ -170,30 +157,22 @@ module PProf
           (filters[:has_devices].nil? || !(p.provisioned_devices || []).empty? == filters[:has_devices]) &&
           (filters[:all_devices].nil? || p.provisions_all_devices == filters[:all_devices]) &&
           (filters[:aps_env].nil? || match_aps_env(p.entitlements.aps_environment, filters[:aps_env])) &&
+          (filters[:platform].nil? || p.platform.include?(filters[:platform])) &&
           true
       end
-
-      case list_options[:mode]
-      when :table
-        print_table(dir, &filter_func)
-      when :json
-        print_json_list(dir, list_options, &filter_func)
-      else
-        print_list(dir, list_options, &filter_func)
-      end
     end
 
     # Prints the filtered list as a table
     #
     # @param [String] dir
-    #        The directory containing the mobileprovision files to list.
+    #        The directory containing the mobileprovision/provisionprofile files to list.
     #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     #
     # @yield each provisioning provile for filtering/validation
     #        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 = []
 
@@ -202,7 +181,7 @@ module PProf
       @output.puts table.row('UUID', 'Name', 'AppID', 'Expiration Date', ' ', 'Team Name')
       @output.puts table.separator
 
-      Dir['*.mobileprovision', base: dir].each do |file_name|
+      Dir['*.{mobileprovision,provisionprofile}', base: dir].each do |file_name|
         file = File.join(dir, file_name)
         begin
           p = PProf::ProvisioningProfile.new(file)
@@ -225,21 +204,21 @@ module PProf
 
     # Prints the filtered list of UUIDs or Paths only
     #
-    # @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.
     #         - :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
+    # @param [String] dir
+    #        The directory containing the mobileprovision/provisionprofile files to list.
+    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     #
     # @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(options:, dir: PProf::ProvisioningProfile::DEFAULT_DIR)
       errors = []
-      Dir['*.mobileprovision', base: dir].each do |file_name|
+      Dir['*.{mobileprovision,provisionprofile}', base: dir].each do |file_name|
         file = File.join(dir, file_name)
         p = PProf::ProvisioningProfile.new(file)
         next if block_given? && !yield(p)
@@ -254,21 +233,21 @@ module PProf
 
     # 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.
-    #         - :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
+    #         - :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
+    # @param [String] dir
+    #        The directory containing the mobileprovision/provisionprofile files to list.
+    #        Defaults to '~/Library/MobileDevice/Provisioning Profiles'
     #
     # @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
+    def print_json_list(options:, dir: PProf::ProvisioningProfile::DEFAULT_DIR)
       errors = []
-      profiles = Dir['*.mobileprovision', base: dir].map do |file_name|
+      profiles = Dir['*.{mobileprovision,provisionprofile}', 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)

data/lib/pprof/provisioning_profile.rb

@@ -21,11 +21,13 @@ module PProf
     #        File path or UUID of the ProvisioningProfile
     #
     def initialize(file)
-      path = if file =~ /^[0-9A-F-]*$/i
-               "#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.mobileprovision"
+      path = if file.match?(/^[0-9A-F-]*$/i)
+               Dir["#{PProf::ProvisioningProfile::DEFAULT_DIR}/#{file}.{mobileprovision,provisionprofile}"].first
              else
                file
              end
+      raise "Unable to find Provisioning Profile with UUID #{file}." if file.nil?
+
       xml = nil
       begin
         pkcs7 = OpenSSL::PKCS7.new(File.read(path))
@@ -41,7 +43,7 @@ module PProf
         xml = `security cms -D -i "#{path}" 2> /dev/null`
       end
       @plist = Plist.parse_xml(xml)
-      raise "Unable to parse file #{file}." if @plist.nil?
+      raise "Unable to parse file #{path}." if @plist.nil?
     end
 
     # The name of the Provisioning Profile
@@ -58,6 +60,14 @@ module PProf
       @plist['UUID']
     end
 
+    # The list of Platforms the Provisioning Profile is for.
+    # Typical values include `OSX`, `iOS`, `xrOS`, `visionOS`, …
+    #
+    # @return [Array<String>]
+    def platform
+      @plist['Platform']
+    end
+
     # The name of the Application Identifier associated with this Provisioning Profile
     #
     # @note This is not the AppID itself, but rather the name you associated to that

data/lib/pprof/version.rb

@@ -2,5 +2,5 @@
 
 module PProf
   # Module version
-  VERSION = '0.5.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pprof
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Olivier Halligon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: A Provisioning Profiles library