app-info 3.0.0.beta1 → 3.0.0.beta3

data/lib/app_info/ipa.rb

@@ -6,125 +6,47 @@ require 'forwardable'
 require 'cfpropertylist'
 
 module AppInfo
-  # IPA parser
-  class IPA < File
-    include Helper::HumanFileSize
-    include Helper::Archive
-    extend Forwardable
-
-    attr_reader :file
-
-    # iOS Export types
-    module ExportType
-      DEBUG   = 'Debug'
-      ADHOC   = 'AdHoc'
-      ENTERPRISE = 'Enterprise'
-      RELEASE = 'Release'
-      UNKOWN  = nil
-
-      INHOUSE = 'Enterprise' # Rename and Alias to enterprise
-    end
-
-    # return file size
-    # @example Read file size in integer
-    #   aab.size                    # => 3618865
-    #
-    # @example Read file size in human readabale
-    #   aab.size(human_size: true)  # => '3.45 MB'
-    #
-    # @param [Boolean] human_size Convert integer value to human readable.
-    # @return [Integer, String]
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def file_type
-      Format::IPA
-    end
-
-    def platform
-      Platform::IOS
-    end
-
-    def_delegators :info, :iphone?, :ipad?, :universal?, :build_version, :name,
-                   :release_version, :identifier, :bundle_id, :display_name,
-                   :bundle_name, :min_sdk_version, :min_os_version, :device_type
-
-    def_delegators :mobileprovision, :devices, :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::RELEASE
-      else
-        build_type
-      end
-    end
-
-    def build_type
-      if mobileprovision?
-        if devices
-          ExportType::ADHOC
-        else
-          ExportType::ENTERPRISE
-        end
-      else
-        ExportType::DEBUG
-      end
-    end
-
-    def archs
-      return unless ::File.exist?(bundle_path)
-
-      file = MachO.open(bundle_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
-
+  class IPA < Apple
+    # Full icons metadata
+    # @example
+    #   aab.icons
+    #   # => [
+    #   #   {
+    #   #     name: 'icon.png',
+    #   #     file: '/path/to/icon.png',
+    #   #     uncrushed_file: '/path/to/uncrushed_icon.png',
+    #   #     dimensions: [64, 64]
+    #   #   },
+    #   #   {
+    #   #     name: 'icon1.png',
+    #   #     file: '/path/to/icon1.png',
+    #   #     uncrushed_file: '/path/to/uncrushed_icon1.png',
+    #   #     dimensions: [120, 120]
+    #   #   }
+    #   # ]
+    # @return [Array<Hash{Symbol => String, Array<Integer>}>] icons paths of icons
     def icons(uncrush: true)
       @icons ||= icons_path.each_with_object([]) do |file, obj|
         obj << build_icon_metadata(file, uncrush: uncrush)
       end
     end
 
+    # @return [Boolean]
     def stored?
       !!metadata?
     end
 
+    # @return [Array<Plugin>]
     def plugins
       @plugins ||= Plugin.parse(app_path)
     end
 
+    # @return [Array<Framework>]
     def frameworks
       @frameworks ||= Framework.parse(app_path)
     end
 
-    def hide_developer_certificates
-      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
-    end
-
-    def mobileprovision
-      return unless mobileprovision?
-      return @mobileprovision if @mobileprovision
-
-      @mobileprovision = MobileProvision.new(mobileprovision_path)
-    end
-
-    def mobileprovision?
-      ::File.exist?(mobileprovision_path)
-    end
-
+    # @return [String]
     def mobileprovision_path
       filename = 'embedded.mobileprovision'
       @mobileprovision_path ||= ::File.join(@file, filename)
@@ -135,39 +57,39 @@ module AppInfo
       @mobileprovision_path
     end
 
+    # @return [CFPropertyList]
     def metadata
       return unless metadata?
 
       @metadata ||= CFPropertyList.native_types(CFPropertyList::List.new(file: metadata_path).value)
     end
 
+    # @return [Boolean]
     def metadata?
       ::File.exist?(metadata_path)
     end
 
+    # @return [String]
     def metadata_path
       @metadata_path ||= ::File.join(contents, 'iTunesMetadata.plist')
     end
 
-    def bundle_path
-      @bundle_path ||= ::File.join(app_path, info.bundle_name)
-    end
-
-    def info
-      @info ||= InfoPlist.new(info_path)
+    # @return [String]
+    def binary_path
+      @binary_path ||= ::File.join(app_path, info.bundle_name)
     end
 
+    # @return [String]
     def info_path
       @info_path ||= ::File.join(app_path, 'Info.plist')
     end
 
+    # @return [String]
     def app_path
       @app_path ||= Dir.glob(::File.join(contents, 'Payload', '*.app')).first
     end
 
-    IPHONE_KEY = 'CFBundleIcons'
-    IPAD_KEY = 'CFBundleIcons~ipad'
-
+    # @return [Array<String>]
     def icons_path
       @icons_path ||= lambda {
         icon_keys.each_with_object([]) do |name, icons|
@@ -201,10 +123,6 @@ module AppInfo
       @icons = nil
     end
 
-    def contents
-      @contents ||= unarchive(@file, prefix: 'ios')
-    end
-
     private
 
     def build_icon_metadata(file, uncrush: true)
@@ -225,13 +143,16 @@ module AppInfo
       ::File.exist?(dest_file) ? dest_file : nil
     end
 
+    IPHONE_KEY = 'CFBundleIcons'
+    IPAD_KEY = 'CFBundleIcons~ipad'
+
     def icon_keys
-      @icon_keys ||= case device_type
-                     when 'iPhone'
+      @icon_keys ||= case device
+                     when Device::IPHONE
                        [IPHONE_KEY]
-                     when 'iPad'
+                     when Device::IPAD
                        [IPAD_KEY]
-                     when 'Universal'
+                     when Device::UNIVERSAL
                        [IPHONE_KEY, IPAD_KEY]
                      end
     end

data/lib/app_info/macos.rb

@@ -7,66 +7,37 @@ require 'cfpropertylist'
 
 module AppInfo
   # MacOS App parser
-  class Macos < File
-    include Helper::HumanFileSize
-    include Helper::Archive
-    extend Forwardable
-
-    attr_reader :file
-
-    # macOS Export types
-    module ExportType
-      DEBUG = 'Debug'
-      RELEASE = 'Release'
-      APPSTORE = 'AppStore'
-    end
-
-    # return file size
-    # @example Read file size in integer
-    #   aab.size                    # => 3618865
-    #
-    # @example Read file size in human readabale
-    #   aab.size(human_size: true)  # => '3.45 MB'
+  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',
+    #   #   }
+    #   # ]
     #
-    # @param [Boolean] human_size Convert integer value to human readable.
-    # @return [Integer, String]
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def file_type
-      Format::MACOS
-    end
-
-    def platform
-      Platform::MACOS
-    end
-
-    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
-
+    # @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
 
@@ -79,43 +50,22 @@ 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')
     end
 
+    # @return [String]
     def store_path
       @store_path ||= ::File.join(app_path, 'Contents', '_MASReceipt', 'receipt')
     end
 
+    # @return [String]
     def binary_path
       return @binary_path if @binary_path
 
@@ -126,14 +76,12 @@ module AppInfo
       @binary_path ||= Dir.glob(::File.join(base_path, '*')).first
     end
 
-    def info
-      @info ||= InfoPlist.new(info_path)
-    end
-
+    # @return [String]
     def info_path
       @info_path ||= ::File.join(app_path, 'Contents', 'Info.plist')
     end
 
+    # @return [String]
     def app_path
       @app_path ||= Dir.glob(::File.join(contents, '*.app')).first
     end
@@ -151,10 +99,6 @@ module AppInfo
       @icons = nil
     end
 
-    def contents
-      @contents ||= unarchive(@file, prefix: 'macos')
-    end
-
     private
 
     def icon_file

data/lib/app_info/mobile_provision.rb

@@ -4,20 +4,37 @@ require 'openssl'
 require 'cfpropertylist'
 
 module AppInfo
-  # .mobileprovision file parser
+  # Apple code signing: provisioning profile parser
+  # @see https://developer.apple.com/documentation/technotes/tn3125-inside-code-signing-provisioning-profiles
   class MobileProvision < File
-    def file_type
-      Format::MOBILEPROVISION
+    # @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,34 +52,37 @@ 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
@@ -87,40 +108,44 @@ module AppInfo
 
     # 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
@@ -128,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?
@@ -202,14 +228,17 @@ 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?(@file)