app-info 3.0.0.beta1 → 3.0.0.beta3

data/lib/app_info/apple.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'macho'
+require 'fileutils'
+require 'forwardable'
+require 'cfpropertylist'
+
+module AppInfo
+  # Apple base parser for ipa and macos file
+  class Apple < File
+    extend Forwardable
+    include Helper::HumanFileSize
+    include Helper::Archive
+
+    # Export types
+    module ExportType
+      # debug configuration
+      DEBUG = :debug
+      # adhoc configuration (iOS only)
+      ADHOC = :adhoc
+      # enterprise configuration (iOS only)
+      ENTERPRISE = :enterprise
+      # release configuration
+      RELEASE = :release
+      # release configuration but download from App Store
+      APPSTORE = :appstore
+    end
+
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::APPLE
+    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
+
+    # @!method device
+    #   @see InfoPlist#device
+    # @!method platform
+    #   @see InfoPlist#platform
+    # @!method iphone?
+    #   @see InfoPlist#iphone?
+    # @!method ipad?
+    #   @see InfoPlist#ipad?
+    # @!method universal?
+    #   @see InfoPlist#universal?
+    # @!method build_version
+    #   @see InfoPlist#build_version
+    # @!method name
+    #   @see InfoPlist#name
+    # @!method release_version
+    #   @see InfoPlist#release_version
+    # @!method identifier
+    #   @see InfoPlist#identifier
+    # @!method bundle_id
+    #   @see InfoPlist#bundle_id
+    # @!method display_name
+    #   @see InfoPlist#display_name
+    # @!method bundle_name
+    #   @see InfoPlist#bundle_name
+    # @!method min_sdk_version
+    #   @see InfoPlist#min_sdk_version
+    # @!method min_os_version
+    #   @see InfoPlist#min_os_version
+    def_delegators :info, :device, :platform, :iphone?, :ipad?, :universal?, :macos?,
+                   :build_version, :name, :release_version, :identifier, :bundle_id,
+                   :display_name, :bundle_name, :min_sdk_version, :min_os_version
+
+    # @!method devices
+    #   @see MobileProvision#devices
+    # @!method team_name
+    #   @see MobileProvision#team_name
+    # @!method team_identifier
+    #   @see MobileProvision#team_identifier
+    # @!method profile_name
+    #   @see MobileProvision#profile_name
+    # @!method expired_date
+    #   @see MobileProvision#expired_date
+    def_delegators :mobileprovision, :devices, :team_name, :team_identifier,
+                   :profile_name, :expired_date
+
+    # @return [String, nil]
+    def distribution_name
+      "#{profile_name} - #{team_name}" if profile_name && team_name
+    end
+
+    # @return [String]
+    def release_type
+      if stored?
+        ExportType::APPSTORE
+      else
+        build_type
+      end
+    end
+
+    # return iOS build configuration, not correct in macOS app.
+    # @return [String]
+    def build_type
+      if mobileprovision?
+        return ExportType::RELEASE if macos?
+
+        devices ? ExportType::ADHOC : ExportType::ENTERPRISE
+      else
+        ExportType::DEBUG
+      end
+    end
+
+    # @return [Array<MachO>, nil]
+    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
+
+    # @abstract Subclass and override {#icons} to implement.
+    def icons(_uncrush: true)
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#stored?} to implement.
+    def stored?
+      not_implemented_error!(__method__)
+    end
+
+    # force remove developer certificate data from {#mobileprovision} method
+    # @return [nil]
+    def hide_developer_certificates
+      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
+    end
+
+    # @return [MobileProvision]
+    def mobileprovision
+      return unless mobileprovision?
+
+      @mobileprovision ||= MobileProvision.new(mobileprovision_path)
+    end
+
+    # @return [Boolean]
+    def mobileprovision?
+      ::File.exist?(mobileprovision_path)
+    end
+
+    # @abstract Subclass and override {#mobileprovision_path} to implement.
+    def mobileprovision_path
+      not_implemented_error!(__method__)
+    end
+
+    # @return [InfoPlist]
+    def info
+      @info ||= InfoPlist.new(info_path)
+    end
+
+    # @abstract Subclass and override {#info_path} to implement.
+    def info_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#app_path} to implement.
+    def app_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#clear!} to implement.
+    def clear!
+      not_implemented_error!(__method__)
+    end
+
+    # @return [String] contents path of contents
+    def contents
+      @contents ||= unarchive(@file, prefix: format.to_s)
+    end
+  end
+end

data/lib/app_info/certificate.rb

@@ -6,6 +6,7 @@ module AppInfo
   class Certificate
     # Parse Raw data into X509 cerificate wrapper
     # @param [String] certificate raw data
+    # @return [AppInfo::Certificate]
     def self.parse(data)
       cert = OpenSSL::X509::Certificate.new(data)
       new(cert)
@@ -54,18 +55,22 @@ module AppInfo
       convert_cert_name(raw.subject, format: format)
     end
 
+    # @return [Time]
     def created_at
       raw.not_before
     end
 
+    # @return [Time]
     def expired_at
       raw.not_after
     end
 
+    # @return [Boolean]
     def expired?
       expired_at < Time.now.utc
     end
 
+    # @return [String] format always be :x509.
     def format
       :x509
     end
@@ -113,36 +118,25 @@ module AppInfo
       end
     end
 
-    # return size of public key
-    def size
+    # return length of public key
+    # @return [Integer]
+    # @raise NotImplementedError
+    def length
       case public_key
       when OpenSSL::PKey::RSA
         public_key.n.num_bits
       when OpenSSL::PKey::DSA, OpenSSL::PKey::DH
         public_key.p.num_bits
       when OpenSSL::PKey::EC
-        raise NotImplementedError, "key size for #{public_key.inspect} not implemented"
+        raise NotImplementedError, "key length for #{public_key.inspect} not implemented"
       end
     end
+    alias size length
 
     # return fingerprint of certificate
+    # @return [String]
     def fingerprint(name = :sha256, transform: :lower, delimiter: nil)
       digest = OpenSSL::Digest.new(name.to_s.upcase)
-      # digest = case name.to_sym
-      #          when :sha1
-      #            OpenSSL::Digest::SHA1.new
-      #          when :sha224
-      #            OpenSSL::Digest::SHA224.new
-      #          when :sha384
-      #            OpenSSL::Digest::SHA384.new
-      #          when :sha512
-      #            OpenSSL::Digest::SHA512.new
-      #          when :md5
-      #            OpenSSL::Digest::MD5.new
-      #          else
-      #            OpenSSL::Digest::SHA256.new
-      #          end
-
       digest.update(raw.to_der)
       fingerprint = digest.to_s
       fingerprint = fingerprint.upcase if transform.to_sym == :upper
@@ -152,6 +146,7 @@ module AppInfo
     end
 
     # Orginal OpenSSL X509 certificate
+    # @return [OpenSSL::X509::Certificate]
     def raw
       @cert
     end
@@ -175,7 +170,7 @@ module AppInfo
     end
 
     def respond_to_missing?(method, *args)
-      @cert.include?(method.to_sym) || super
+      @cert.respond_to?(method.to_sym) || super
     end
   end
 end

data/lib/app_info/const.rb

@@ -3,39 +3,74 @@
 module AppInfo
   # Full Format
   module Format
-    # iOS
-    IPA = :ipa
+    # Apple
+
     INFOPLIST = :infoplist
     MOBILEPROVISION = :mobileprovision
     DSYM = :dsym
 
+    # macOS
+
+    MACOS = :macos
+
+    # iOS
+
+    IPA = :ipa
+
     # Android
+
     APK = :apk
     AAB = :aab
     PROGUARD = :proguard
 
-    # macOS
-    MACOS = :macos
-
     # Windows
+
     PE = :pe
 
     UNKNOWN = :unknown
   end
 
+  # Manufacturer
+  module Manufacturer
+    APPLE = :apple
+    GOOGLE = :google
+    MICROSOFT = :microsoft
+  end
+
   # Platform
   module Platform
-    WINDOWS = 'Windows'
-    MACOS = 'macOS'
-    IOS = 'iOS'
-    ANDROID = 'Android'
+    MACOS = :macos
+    IOS = :ios
+    ANDROID = :android
+    WINDOWS = :windows
   end
 
   # Apple Device Type
   module Device
-    MACOS = 'macOS'
-    IPHONE = 'iPhone'
-    IPAD = 'iPad'
-    UNIVERSAL = 'Universal'
+    # macOS
+    MACOS = :macos
+
+    # Apple iPhone
+    IPHONE = :iphone
+    # Apple iPad
+    IPAD = :ipad
+    # Apple Watch
+    IWATCH = :iwatch # not implemented yet
+    # Apple Universal (iPhone and iPad)
+    UNIVERSAL = :universal
+
+    # Android Phone
+    PHONE = :phone
+    # Android Tablet (not implemented yet)
+    TABLET = :tablet
+    # Android Watch
+    WATCH = :watch
+    # Android TV
+    TELEVISION = :television
+    # Android Car Automotive
+    AUTOMOTIVE = :automotive
+
+    # Windows
+    WINDOWS = :windows
   end
 end

data/lib/app_info/dsym.rb

@@ -7,16 +7,18 @@ module AppInfo
   class DSYM < File
     include Helper::Archive
 
-    def file_type
-      Format::DSYM
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::APPLE
     end
 
     def each_file(&block)
       files.each { |file| block.call(file) }
     end
 
+    # @return [Array<DebugInfo>] dsym_files files by alphabetical order
     def files
-      @files ||= Dir.children(contents).each_with_object([]) do |file, obj|
+      @files ||= Dir.children(contents).sort.each_with_object([]) do |file, obj|
         obj << DebugInfo.new(::File.join(contents, file))
       end
     end
@@ -30,6 +32,7 @@ module AppInfo
       @files = nil
     end
 
+    # @return [String] contents path of dsym
     def contents
       @contents ||= lambda {
         return @file if ::File.directory?(@file)

data/lib/app_info/error.rb

@@ -9,13 +9,7 @@ module AppInfo
 
   class NotFoundError < Error; end
 
-  class NotFoundWinBinraryError < NotFoundError; end
-
   class ProtobufParseError < Error; end
 
-  class UnknownFileTypeError < Error; end
-
-  # @deprecated Correct to the new {UnknownFileTypeError} class because typo.
-  #   It will remove since 2.7.0.
-  class UnkownFileTypeError < Error; end
+  class UnknownFormatError < Error; end
 end

data/lib/app_info/file.rb

@@ -10,14 +10,40 @@ module AppInfo
       @logger = logger
     end
 
-    # @abstract Subclass and override {#file_type} to implement
-    def file_type
-      Platform::UNKNOWN
+    # @return [Symbol] {Format}
+    def format
+      @format ||= lambda {
+        if instance_of?(AppInfo::File) || instance_of?(AppInfo::Apple) ||
+           instance_of?(AppInfo::Android)
+          not_implemented_error!(__method__)
+        end
+
+        self.class.name.split('::')[-1].downcase.to_sym
+      }.call
+    end
+
+    # @abstract Subclass and override {#platform} to implement.
+    def platform
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#manufacturer} to implement.
+    def manufacturer
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#device} to implement.
+    def device
+      not_implemented_error!(__method__)
     end
 
     # @abstract Subclass and override {#size} to implement
     def size(human_size: false)
-      raise NotImplementedError, ".#{__method__} method implantation required in #{self.class}"
+      not_implemented_error!(__method__)
+    end
+
+    def not_implemented_error!(method)
+      raise NotImplementedError, ".#{method} method implantation required in #{self.class}"
     end
   end
 end

data/lib/app_info/helper/file_size.rb

@@ -16,7 +16,7 @@ module AppInfo::Helper
         max_exp = FILE_SIZE_UNITS.size - 1
         exponent = (Math.log(number) / Math.log(1024)).to_i
         exponent = max_exp if exponent > max_exp
-        number = format('%<number>.2f', number: (number / (1024**exponent.to_f)))
+        number = Kernel.format('%<number>.2f', number: (number / (1024**exponent.to_f)))
       end
 
       "#{number} #{FILE_SIZE_UNITS[exponent]}"

data/lib/app_info/info_plist.rb

@@ -17,94 +17,120 @@ module AppInfo
       Device::MACOS => %w[CFBundleIconFile CFBundleIconName]
     }.freeze
 
-    def file_type
-      Format::INFOPLIST
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::APPLE
+    end
+
+    # @return [Symbol] {Platform}
+    def platform
+      case device
+      when Device::MACOS
+        Platform::MACOS
+      when Device::IPHONE, Device::IPAD, Device::UNIVERSAL
+        Platform::IOS
+      end
+    end
+
+    # @return [Symbol] {Device}
+    def device
+      if device_family == [1]
+        Device::IPHONE
+      elsif device_family == [2]
+        Device::IPAD
+      elsif device_family == [1, 2]
+        Device::UNIVERSAL
+      elsif !info.try(:[], 'DTSDKName').nil? || !info.try(:[], 'DTManufacturerName').nil?
+        Device::MACOS
+      else
+        raise NotImplementedError, "Unkonwn device: #{device_family}"
+      end
     end
 
+    # @return [String, nil]
     def version
       release_version || build_version
     end
 
+    # @return [String, nil]
     def build_version
       info.try(:[], 'CFBundleVersion')
     end
 
+    # @return [String, nil]
     def release_version
       info.try(:[], 'CFBundleShortVersionString')
     end
 
+    # @return [String, nil]
     def identifier
       info.try(:[], 'CFBundleIdentifier')
     end
     alias bundle_id identifier
 
+    # @return [String, nil]
     def name
       display_name || bundle_name
     end
 
+    # @return [String, nil]
     def display_name
       info.try(:[], 'CFBundleDisplayName')
     end
 
+    # @return [String, nil]
     def bundle_name
       info.try(:[], 'CFBundleName')
     end
 
+    # @return [String, nil]
     def min_os_version
       min_sdk_version || min_system_version
     end
 
-    #
     # Extract the Minimum OS Version from the Info.plist (iOS Only)
-    #
+    # @return [String, nil]
     def min_sdk_version
       info.try(:[], 'MinimumOSVersion')
     end
 
-    #
     # Extract the Minimum OS Version from the Info.plist (macOS Only)
-    #
+    # @return [String, nil]
     def min_system_version
       info.try(:[], 'LSMinimumSystemVersion')
     end
 
+    # @return [Array<String>]
     def icons
-      @icons ||= ICON_KEYS[device_type]
-    end
-
-    def device_type
-      device_family = info.try(:[], 'UIDeviceFamily')
-      if device_family == [1]
-        Device::IPHONE
-      elsif device_family == [2]
-        Device::IPAD
-      elsif device_family == [1, 2]
-        Device::UNIVERSAL
-      elsif !info.try(:[], 'DTSDKName').nil? || !info.try(:[], 'DTPlatformName').nil?
-        Device::MACOS
-      end
+      @icons ||= ICON_KEYS[device]
     end
 
+    # @return [Boolean]
     def iphone?
-      device_type == Device::IPHONE
+      device == Device::IPHONE
     end
 
+    # @return [Boolean]
     def ipad?
-      device_type == Device::IPAD
+      device == Device::IPAD
     end
 
+    # @return [Boolean]
     def universal?
-      device_type == Device::UNIVERSAL
+      device == Device::UNIVERSAL
     end
 
+    # @return [Boolean]
     def macos?
-      device_type == Device::MACOS
+      device == Device::MACOS
     end
 
+    # @return [Array<String>]
     def device_family
       info.try(:[], 'UIDeviceFamily') || []
     end
 
+    # @return [String]
     def release_type
       if stored?
         'Store'
@@ -113,10 +139,13 @@ module AppInfo
       end
     end
 
+    # @return [String, nil]
     def [](key)
       info.try(:[], key.to_s)
     end
 
+    # @!method to_h
+    #   @see CFPropertyList#to_h
     def_delegators :info, :to_h
 
     def method_missing(method_name, *args, &block)
@@ -140,7 +169,7 @@ module AppInfo
     end
 
     def app_path
-      @app_path ||= case device_type
+      @app_path ||= case device
                     when Device::MACOS
                       ::File.dirname(@file)
                     else