app-info 2.8.2 → 3.0.0

data/lib/app_info/helper.rb

@@ -1,130 +1,7 @@
 # frozen_string_literal: true
 
-module AppInfo
-  # App Platform
-  module Platform
-    MACOS = 'macOS'
-    IOS = 'iOS'
-    ANDROID = 'Android'
-    DSYM = 'dSYM'
-    PROGUARD = 'Proguard'
-  end
-
-  # Device Type
-  module Device
-    MACOS = 'macOS'
-    IPHONE = 'iPhone'
-    IPAD = 'iPad'
-    UNIVERSAL = 'Universal'
-  end
-
-  module AndroidDevice
-    PHONE   = 'Phone'
-    TABLET  = 'Tablet'
-    WATCH   = 'Watch'
-    TV      = 'Television'
-  end
-
-  # Icon Key
-  ICON_KEYS = {
-    Device::IPHONE => ['CFBundleIcons'],
-    Device::IPAD => ['CFBundleIcons~ipad'],
-    Device::UNIVERSAL => ['CFBundleIcons', 'CFBundleIcons~ipad'],
-    Device::MACOS => %w[CFBundleIconFile CFBundleIconName]
-  }.freeze
-
-  module Helper
-    module HumanFileSize
-      def file_to_human_size(file, human_size:)
-        number = File.size(file)
-        human_size ? number_to_human_size(number) : number
-      end
-
-      FILE_SIZE_UNITS = %w[B KB MB GB TB].freeze
-
-      def number_to_human_size(number)
-        if number.to_i < 1024
-          exponent = 0
-        else
-          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)))
-        end
-
-        "#{number} #{FILE_SIZE_UNITS[exponent]}"
-      end
-    end
-
-    module Archive
-      require 'zip'
-      require 'fileutils'
-      require 'securerandom'
-
-      # Unarchive zip file
-      #
-      # source: https://github.com/soffes/lagunitas/blob/master/lib/lagunitas/ipa.rb
-      def unarchive(file, path: nil)
-        path = path ? "#{path}-" : ''
-        root_path = "#{Dir.mktmpdir}/AppInfo-#{path}#{SecureRandom.hex}"
-        Zip::File.open(file) do |zip_file|
-          if block_given?
-            yield root_path, zip_file
-          else
-            zip_file.each do |f|
-              f_path = File.join(root_path, f.name)
-              FileUtils.mkdir_p(File.dirname(f_path))
-              zip_file.extract(f, f_path) unless File.exist?(f_path)
-            end
-          end
-        end
-
-        root_path
-      end
-
-      def tempdir(file, prefix:)
-        dest_path ||= File.join(File.dirname(file), prefix)
-        dest_file = File.join(dest_path, File.basename(file))
-
-        Dir.mkdir(dest_path, 0_700) unless Dir.exist?(dest_path)
-
-        dest_file
-      end
-    end
-
-    module Defines
-      def create_class(klass_name, parent_class, namespace:)
-        klass = Class.new(parent_class) do
-          yield if block_given?
-        end
-
-        name = namespace.to_s.empty? ? klass_name : "#{namespace}::#{klass_name}"
-        if Object.const_get(namespace).const_defined?(klass_name)
-          Object.const_get(namespace).const_get(klass_name)
-        elsif Object.const_defined?(name)
-          Object.const_get(name)
-        else
-          Object.const_get(namespace).const_set(klass_name, klass)
-        end
-      end
-
-      def define_instance_method(key, value)
-        instance_variable_set("@#{key}", value)
-        self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{key}
-            @#{key}
-          end
-        RUBY
-      end
-    end
-
-    module ReferenceParser
-      def reference_segments(value)
-        new_value = value.is_a?(Aapt::Pb::Reference) ? value.name : value
-        return new_value.split('/', 2) if new_value.include?('/')
-
-        [nil, new_value]
-      end
-    end
-  end
-end
+require 'app_info/helper/archive'
+require 'app_info/helper/file_size'
+require 'app_info/helper/generate_class'
+require 'app_info/helper/protobuf'
+require 'app_info/helper/signatures'

data/lib/app_info/info_plist.rb

@@ -6,97 +6,131 @@ require 'app_info/png_uncrush'
 
 module AppInfo
   # iOS Info.plist parser
-  class InfoPlist
+  class InfoPlist < File
     extend Forwardable
 
-    def initialize(file)
-      @file = file
+    # Icon Key
+    ICON_KEYS = {
+      Device::IPHONE => ['CFBundleIcons'],
+      Device::IPAD => ['CFBundleIcons~ipad'],
+      Device::UNIVERSAL => ['CFBundleIcons', 'CFBundleIcons~ipad'],
+      Device::MACOS => %w[CFBundleIconFile CFBundleIconName]
+    }.freeze
+
+    # @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'
@@ -105,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)
@@ -126,17 +163,17 @@ module AppInfo
     private
 
     def info
-      return unless File.file?(@file)
+      return unless ::File.file?(@file)
 
       @info ||= CFPropertyList.native_types(CFPropertyList::List.new(file: @file).value)
     end
 
     def app_path
-      @app_path ||= case device_type
+      @app_path ||= case device
                     when Device::MACOS
-                      File.dirname(@file)
+                      ::File.dirname(@file)
                     else
-                      File.expand_path('../', @file)
+                      ::File.expand_path('../', @file)
                     end
     end
   end

data/lib/app_info/ipa/framework.rb

@@ -8,7 +8,7 @@ module AppInfo
     extend Forwardable
 
     def self.parse(path, name = 'Frameworks')
-      files = Dir.glob(File.join(path, name.to_s, '*'))
+      files = Dir.glob(::File.join(path, name.to_s, '*'))
       return [] if files.empty?
 
       files.sort.each_with_object([]) do |file, obj|
@@ -26,7 +26,7 @@ module AppInfo
     end
 
     def name
-      File.basename(file)
+      ::File.basename(file)
     end
 
     def macho
@@ -37,11 +37,11 @@ module AppInfo
     end
 
     def lib?
-      File.file?(file)
+      ::File.file?(file)
     end
 
     def info
-      @info ||= InfoPlist.new(File.join(file, 'Info.plist'))
+      @info ||= InfoPlist.new(::File.join(file, 'Info.plist'))
     end
 
     def to_s

data/lib/app_info/ipa.rb

@@ -6,179 +6,106 @@ require 'forwardable'
 require 'cfpropertylist'
 
 module AppInfo
-  # IPA parser
-  class IPA
-    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
-
-    def initialize(file)
-      @file = file
-    end
-
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def os
-      Platform::IOS
-    end
-    alias file_type os
-
-    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)
-      unless File.exist?(@mobileprovision_path)
-        @mobileprovision_path = File.join(app_path, filename)
+      @mobileprovision_path ||= ::File.join(@file, filename)
+      unless ::File.exist?(@mobileprovision_path)
+        @mobileprovision_path = ::File.join(app_path, filename)
       end
 
       @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)
+      ::File.exist?(metadata_path)
     end
 
+    # @return [String]
     def metadata_path
-      @metadata_path ||= File.join(contents, 'iTunesMetadata.plist')
+      @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')
+      @info_path ||= ::File.join(app_path, 'Info.plist')
     end
 
+    # @return [String]
     def app_path
-      @app_path ||= Dir.glob(File.join(contents, 'Payload', '*.app')).first
+      @app_path ||= Dir.glob(::File.join(contents, 'Payload', '*.app')).first
     end
 
-    IPHONE_KEY = 'CFBundleIcons'
-    IPAD_KEY = 'CFBundleIcons~ipad'
-
+    # @return [Array<String>]
     def icons_path
-      return @icons_path if @icons_path
-
-      @icons_path = []
-      icon_keys.each do |name|
-        filenames = info.try(:[], name)
-                        .try(:[], 'CFBundlePrimaryIcon')
-                        .try(:[], 'CFBundleIconFiles')
-
-        next if filenames.nil? || filenames.empty?
-
-        filenames.each do |filename|
-          Dir.glob(File.join(app_path, "#{filename}*")).find_all.each do |file|
-            @icons_path << file
+      @icons_path ||= lambda {
+        icon_keys.each_with_object([]) do |name, icons|
+          filenames = info.try(:[], name)
+                          .try(:[], 'CFBundlePrimaryIcon')
+                          .try(:[], 'CFBundleIconFiles')
+
+          next if filenames.nil? || filenames.empty?
+
+          filenames.each do |filename|
+            Dir.glob(::File.join(app_path, "#{filename}*")).find_all.each do |file|
+              icons << file
+            end
           end
         end
-      end
-
-      @icons_path
+      }.call
     end
 
     def clear!
@@ -196,17 +123,13 @@ module AppInfo
       @icons = nil
     end
 
-    def contents
-      @contents ||= unarchive(@file, path: 'ios')
-    end
-
     private
 
     def build_icon_metadata(file, uncrush: true)
       uncrushed_file = uncrush ? uncrush_png(file) : nil
 
       {
-        name: File.basename(file),
+        name: ::File.basename(file),
         file: file,
         uncrushed_file: uncrushed_file,
         dimensions: PngUncrush.dimensions(file)
@@ -217,16 +140,19 @@ module AppInfo
     def uncrush_png(src_file)
       dest_file = tempdir(src_file, prefix: 'uncrushed')
       PngUncrush.decompress(src_file, dest_file)
-      File.exist?(dest_file) ? dest_file : nil
+      ::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