app-info 2.8.2 → 3.0.0

data/lib/app_info/macos.rb

@@ -7,63 +7,42 @@ require 'cfpropertylist'
 
 module AppInfo
   # MacOS App parser
-  class Macos
-    include Helper::HumanFileSize
-    include Helper::Archive
-    extend Forwardable
-
-    attr_reader :file
-
-    # macOS Export types
-    module ExportType
-      DEBUG = 'Debug'
-      RELEASE = 'Release'
-      APPSTORE = 'AppStore'
-    end
-
-    def initialize(file)
-      @file = file
-    end
-
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def os
-      Platform::MACOS
-    end
-    alias file_type os
-
-    def_delegators :info, :macos?, :iphone?, :ipad?, :universal?, :build_version, :name,
-                   :release_version, :identifier, :bundle_id, :display_name,
-                   :bundle_name, :min_system_version, :min_os_version, :device_type
-
-    def_delegators :mobileprovision, :team_name, :team_identifier,
-                   :profile_name, :expired_date
-
-    def distribution_name
-      "#{profile_name} - #{team_name}" if profile_name && team_name
-    end
-
-    def release_type
-      if stored?
-        ExportType::APPSTORE
-      elsif mobileprovision?
-        ExportType::RELEASE
-      else
-        ExportType::DEBUG
-      end
-    end
-
-    def stored?
-      File.exist?(store_path)
-    end
-
+  class Macos < Apple
+    # @!method min_sdk_version
+    #   @see InfoPlist#min_sdk_version
+    def_delegators :info, :min_system_version
+
+    # Full icons metadata
+    # @param [Boolean] convert Convert .icons to .png format
+    # @example uncovert .icons
+    #   macos.icons
+    #   # => [
+    #   #   {
+    #   #     name: 'icon.icns',
+    #   #     file: '/path/to/icon.icns',
+    #   #   }
+    #   # ]
+    #
+    # @example coverted .icons
+    #   macos.icons(convert: true)
+    #   # => [
+    #   #   {
+    #   #     name: 'converted_icon_32x32.png',
+    #   #     file: '/path/to/converted_icon_32x32.png',
+    #   #     dimensions: [32, 32]
+    #   #   },
+    #   #   {
+    #   #     name: 'converted_icon_120x120.png',
+    #   #     file: '/path/to/converted_icon_120x120.png',
+    #   #     dimensions: [120, 120]
+    #   #   },
+    #   # ]
+    # @return [Array<Hash{Symbol => String, Array<Integer>}>] icons paths of icons
     def icons(convert: true)
       return unless icon_file
 
       data = {
-        name: File.basename(icon_file),
+        name: ::File.basename(icon_file),
         file: icon_file
       }
 
@@ -71,63 +50,40 @@ module AppInfo
       data
     end
 
-    def archs
-      return unless File.exist?(binary_path)
-
-      file = MachO.open(binary_path)
-      case file
-      when MachO::MachOFile
-        [file.cpusubtype]
-      else
-        file.machos.each_with_object([]) do |arch, obj|
-          obj << arch.cpusubtype
-        end
-      end
-    end
-    alias architectures archs
-
-    def hide_developer_certificates
-      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
-    end
-
-    def mobileprovision
-      return unless mobileprovision?
-
-      @mobileprovision ||= MobileProvision.new(mobileprovision_path)
-    end
-
-    def mobileprovision?
-      File.exist?(mobileprovision_path)
+    # @return [Boolean]
+    def stored?
+      ::File.exist?(store_path)
     end
 
+    # @return [String]
     def mobileprovision_path
-      @mobileprovision_path ||= File.join(app_path, 'Contents', 'embedded.provisionprofile')
+      @mobileprovision_path ||= ::File.join(app_path, 'Contents', 'embedded.provisionprofile')
     end
 
+    # @return [String]
     def store_path
-      @store_path ||= File.join(app_path, 'Contents', '_MASReceipt', 'receipt')
+      @store_path ||= ::File.join(app_path, 'Contents', '_MASReceipt', 'receipt')
     end
 
+    # @return [String]
     def binary_path
       return @binary_path if @binary_path
 
-      base_path = File.join(app_path, 'Contents', 'MacOS')
+      base_path = ::File.join(app_path, 'Contents', 'MacOS')
       binary = info['CFBundleExecutable']
-      return File.join(base_path, binary) if binary
+      return ::File.join(base_path, binary) if binary
 
-      @binary_path ||= Dir.glob(File.join(base_path, '*')).first
-    end
-
-    def info
-      @info ||= InfoPlist.new(info_path)
+      @binary_path ||= Dir.glob(::File.join(base_path, '*')).first
     end
 
+    # @return [String]
     def info_path
-      @info_path ||= File.join(app_path, 'Contents', 'Info.plist')
+      @info_path ||= ::File.join(app_path, 'Contents', 'Info.plist')
     end
 
+    # @return [String]
     def app_path
-      @app_path ||= Dir.glob(File.join(contents, '*.app')).first
+      @app_path ||= Dir.glob(::File.join(contents, '*.app')).first
     end
 
     def clear!
@@ -137,16 +93,12 @@ module AppInfo
 
       @contents = nil
       @app_path = nil
-      @binrary_path = nil
+      @binary_path = nil
       @info_path = nil
       @info = nil
       @icons = nil
     end
 
-    def contents
-      @contents ||= unarchive(@file, path: 'macos')
-    end
-
     private
 
     def icon_file
@@ -155,8 +107,8 @@ module AppInfo
       info.icons.each do |key|
         next unless value = info[key]
 
-        file = File.join(app_path, 'Contents', 'Resources', "#{value}.icns")
-        next unless File.file?(file)
+        file = ::File.join(app_path, 'Contents', 'Resources', "#{value}.icns")
+        next unless ::File.file?(file)
 
         return @icon_file = file
       end
@@ -173,14 +125,14 @@ module AppInfo
       file = data[:file]
       reader = Icns::Reader.new(file)
       Icns::SIZE_TO_TYPE.each do |size, _|
-        dest_filename = "#{File.basename(file, '.icns')}_#{size}x#{size}.png"
-        dest_file = tempdir(File.join(File.dirname(file), dest_filename), prefix: 'converted')
+        dest_filename = "#{::File.basename(file, '.icns')}_#{size}x#{size}.png"
+        dest_file = tempdir(::File.join(::File.dirname(file), dest_filename), prefix: 'converted')
         next unless icon_data = reader.image(size: size)
 
-        File.write(dest_file, icon_data, encoding: Encoding::BINARY)
+        ::File.write(dest_file, icon_data, encoding: Encoding::BINARY)
 
         data[:sets] << {
-          name: File.basename(dest_filename),
+          name: ::File.basename(dest_filename),
           file: dest_file,
           dimensions: ImageSize.path(dest_file).size
         }

data/lib/app_info/mobile_provision.rb

@@ -4,20 +4,37 @@ require 'openssl'
 require 'cfpropertylist'
 
 module AppInfo
-  # .mobileprovision file parser
-  class MobileProvision
-    def initialize(path)
-      @path = path
+  # Apple code signing: provisioning profile parser
+  # @see https://developer.apple.com/documentation/technotes/tn3125-inside-code-signing-provisioning-profiles
+  class MobileProvision < File
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::APPLE
     end
 
+    # @return [Symbol] {Platform}
+    def platform
+      case platforms[0]
+      when :macos
+        Platform::MACOS
+      when :ios
+        Platform::IOS
+      else
+        raise NotImplementedError, "Unkonwn platform: #{platforms[0]}"
+      end
+    end
+
+    # @return [String, nil]
     def name
       mobileprovision.try(:[], 'Name')
     end
 
+    # @return [String, nil]
     def app_name
       mobileprovision.try(:[], 'AppIDName')
     end
 
+    # @return [Symbol, nil]
     def type
       return :development if development?
       return :adhoc if adhoc?
@@ -25,6 +42,7 @@ module AppInfo
       return :enterprise if enterprise?
     end
 
+    # @return [Array<Symbol>]
     def platforms
       return unless platforms = mobileprovision.try(:[], 'Platform')
 
@@ -34,83 +52,100 @@ module AppInfo
       end
     end
 
-    def platform
-      platforms[0]
-    end
-
+    # @return [Array<String>, nil]
     def devices
       mobileprovision.try(:[], 'ProvisionedDevices')
     end
 
+    # @return [String, nil]
     def team_identifier
       mobileprovision.try(:[], 'TeamIdentifier')
     end
 
+    # @return [String, nil]
     def team_name
       mobileprovision.try(:[], 'TeamName')
     end
 
+    # @return [String, nil]
     def profile_name
       mobileprovision.try(:[], 'Name')
     end
 
+    # @return [String, nil]
     def created_date
       mobileprovision.try(:[], 'CreationDate')
     end
 
+    # @return [String, nil]
     def expired_date
       mobileprovision.try(:[], 'ExpirationDate')
     end
 
+    # @return [Array<String>, nil]
     def entitlements
       mobileprovision.try(:[], 'Entitlements')
     end
 
+    # return developer certificates.
+    #
+    # @deprecated Use {#certificates} instead of this method.
     def developer_certs
+      certificates
+    end
+
+    # return developer certificates.
+    #
+    # @return [Array<Certificate>]
+    def certificates
       certs = mobileprovision.try(:[], 'DeveloperCertificates')
       return if certs.empty?
 
-      certs.each_with_object([]) do |cert, obj|
-        obj << DeveloperCertificate.new(cert)
+      certs.each_with_object([]) do |cert_data, obj|
+        obj << Certificate.parse(cert_data)
       end
     end
 
     # Detect is development type of mobileprovision
     #
-    # related link: https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    # @see https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    # @return [Boolea]
     def development?
-      case platform.downcase.to_sym
-      when :ios
+      case platform
+      when Platform::IOS
         entitlements['get-task-allow'] == true
-      when :macos
+      when Platform::MACOS
         !devices.nil?
       else
-        raise Error, "Not implement with platform: #{platform}"
+        raise NotImplementedError, "Unknown platform: #{platform}"
       end
     end
 
     # Detect app store type
     #
-    # related link: https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    # @see https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    # @return [Boolea]
     def appstore?
-      case platform.downcase.to_sym
-      when :ios
+      case platform
+      when Platform::IOS
         !development? && entitlements.key?('beta-reports-active')
-      when :macos
+      when Platform::MACOS
         !development?
       else
-        raise Error, "Not implement with platform: #{platform}"
+        raise NotImplementedError, "Unknown platform: #{platform}"
       end
     end
 
+    # @return [Boolea]
     def adhoc?
-      return false if platform == :macos # macOS no need adhoc
+      return false if platform == Platform::MACOS # macOS no need adhoc
 
       !development? && !devices.nil?
     end
 
+    # @return [Boolea]
     def enterprise?
-      return false if platform == :macos # macOS no need adhoc
+      return false if platform == Platform::MACOS # macOS no need adhoc
 
       !development? && !adhoc? && !appstore?
     end
@@ -118,7 +153,8 @@ module AppInfo
 
     # Enabled Capabilites
     #
-    # Related link: https://developer.apple.com/support/app-capabilities/
+    # @see https://developer.apple.com/support/app-capabilities/
+    # @return [Array<String>]
     def enabled_capabilities
       capabilities = []
       capabilities << 'In-App Purchase' << 'GameKit' if adhoc? || appstore?
@@ -142,10 +178,10 @@ module AppInfo
         when 'com.apple.developer.networking.vpn.api'
           capabilities << 'Personal VPN'
         when 'com.apple.developer.healthkit',
-             'com.apple.developer.healthkit.access'
+            'com.apple.developer.healthkit.access'
           capabilities << 'HealthKit' unless capabilities.include?('HealthKit')
         when 'com.apple.developer.icloud-services',
-             'com.apple.developer.icloud-container-identifiers'
+            'com.apple.developer.icloud-container-identifiers'
           capabilities << 'iCloud' unless capabilities.include?('iCloud')
         when 'com.apple.developer.in-app-payments'
           capabilities << 'Apple Pay'
@@ -192,18 +228,21 @@ module AppInfo
       capabilities
     end
 
+    # @return [String, nil]
     def [](key)
       mobileprovision.try(:[], key.to_s)
     end
 
+    # @return [Boolea]
     def empty?
       mobileprovision.nil?
     end
 
+    # @return [CFPropertyList]
     def mobileprovision
-      return @mobileprovision = nil unless File.exist?(@path)
+      return @mobileprovision = nil unless ::File.exist?(@file)
 
-      data = File.read(@path)
+      data = ::File.read(@file)
       data = strip_plist_wrapper(data) unless bplist?(data)
       list = CFPropertyList::List.new(data: data).value
       @mobileprovision = CFPropertyList.native_types(list)
@@ -235,26 +274,5 @@ module AppInfo
       end_point = raw.index(end_tag) + end_tag.size - 1
       raw[start_point..end_point]
     end
-
-    # Developer Certificate
-    class DeveloperCertificate
-      attr_reader :raw
-
-      def initialize(data)
-        @raw = OpenSSL::X509::Certificate.new(data)
-      end
-
-      def name
-        @raw.subject.to_a.find { |name, _, _| name == 'CN' }[1].force_encoding('UTF-8')
-      end
-
-      def created_date
-        @raw.not_after
-      end
-
-      def expired_date
-        @raw.not_before
-      end
-    end
   end
 end