pprof 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d476948086afa6ea5bb7de05378c7e384bf85b14a42f083c2850b5b497ce0f45
-  data.tar.gz: 158efbc09babce572ced4074c231793af16ed2c7db3567bd5b60fb1c8c7a66b0
+  metadata.gz: f7691660bb69c7c6f6f4fedb4722dc0e647183378e5aa79cfa0ce2a80f7e4cef
+  data.tar.gz: ae54346cc1d76c10a89468b605a698727ff38909f683bed7ff8a6d779c6605b0
 SHA512:
-  metadata.gz: 224f0d480b357a04a6e3dc2e13f1962b337b100ee599fd36a9a937060056cba90f7fcdf49080b87334ad79d62a61a4e80d817737c7680725e6ded84f506580b2
-  data.tar.gz: 04b13e78ae4a7b133d21c5786bb9f4bd4ccb4238bff33b3007bcf11dfe520b26af4157168883a7456766f93ad9efa9ed37087a0b5cb8ad5cf9d64ec4e4b91efb
+  metadata.gz: 9b2490137336562c025610bbfc7de8b0fe1a177005b9a7c7cfea21310fedb3f77164745303dc08b1816d3e8dd5a0f7a5aaa71373a71c784921982d36da4e876f
+  data.tar.gz: 22665cd4ba32a996577a8ed8099348f29193fb88589a32b1faaf8ca03298a971902373d23cdad568c59a1b6e23f59f81e3c0a3e543e8173c18ddd71f098379a5

data/bin/pprof

@@ -64,6 +64,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
@@ -156,9 +159,12 @@ 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,6 +97,49 @@ module PProf
       # rubocop:enable Style/GuardClause
     end
 
+    # Returns a Provisioning Profile hash ready to be printed as a JSON output
+    #
+    # @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
+    #
+    # @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'] = 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
+
     # Prints the filtered list of Provisioning Profiles
     #
     # Convenience method. Calls self.print_list with a filter block build from a filter hash
@@ -129,6 +176,8 @@ module PProf
       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
@@ -181,7 +230,7 @@ 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
@@ -195,7 +244,7 @@ module PProf
         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 +252,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.
+    #         - :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_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.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pprof
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 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
@@ -59,8 +59,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: []