app-info 3.0.0.beta1 → 3.0.0.beta3

data/lib/app_info/pe.rb

@@ -24,14 +24,21 @@ module AppInfo
       0x5128 => 'RISC-v 128'
     }.freeze
 
-    def file_type
-      Format::PE
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::MICROSOFT
     end
 
+    # @return [Symbol] {Platform}
     def platform
       Platform::WINDOWS
     end
 
+    # @return [Symbol] {Device}
+    def device
+      Device::WINDOWS
+    end
+
     # return file size
     # @example Read file size in integer
     #   aab.size                    # => 3618865
@@ -49,23 +56,75 @@ module AppInfo
       file_to_human_size(binary_file, human_size: human_size)
     end
 
-    def_delegators :version_info, :product_name, :product_version, :company_name, :assembly_version
+    # @!method product_name
+    #   @see VersionInfo#product_name
+    #   @return [String]
+    # @!method product_version
+    #   @see VersionInfo#product_version
+    #   @return [String]
+    # @!method company_name
+    #   @see VersionInfo#company_name
+    #   @return [String]
+    # @!method assembly_version
+    #   @see VersionInfo#assembly_version
+    #   @return [String]
+    # @!method file_version
+    #   @see VersionInfo#file_version
+    #   @return [String]
+    # @!method file_description
+    #   @see VersionInfo#file_description
+    #   @return [String]
+    # @!method copyright
+    #   @see VersionInfo#copyright
+    #   @return [String]
+    #   @return [String]
+    # @!method special_build
+    #   @see VersionInfo#special_build
+    #   @return [String]
+    # @!method private_build
+    #   @see VersionInfo#private_build
+    #   @return [String]
+    # @!method original_filename
+    #   @see VersionInfo#original_filename
+    #   @return [String]
+    # @!method internal_name
+    #   @see VersionInfo#internal_name
+    #   @return [String]
+    # @!method legal_trademarks
+    #   @see VersionInfo#legal_trademarks
+    #   @return [String]
+    def_delegators :version_info, :product_name, :product_version, :company_name, :assembly_version,
+                   :file_version, :file_description, :copyright, :special_build, :private_build,
+                   :original_filename, :internal_name, :legal_trademarks
 
     alias name product_name
-    alias release_version product_version
-    alias build_version assembly_version
 
+    # Find {#product_version} then fallback to {#file_version}
+    # @return [String, nil]
+    def release_version
+      product_version || file_version
+    end
+
+    # Find {#special_build}, {#private_build} then fallback to {#assembly_version}
+    # @return [String, nil]
+    def build_version
+      special_build || private_build || assembly_version
+    end
+
+    # @return [String]
     def archs
       ARCH[image_file_header.Machine] || 'unknown'
     end
     alias architectures archs
 
+    # @return [Hash{String => String}] imports imports of libraries
     def imports
       @imports ||= pe.imports.each_with_object({}) do |import, obj|
         obj[import.module_name] = import.first_thunk.map(&:name).compact
       end
     end
 
+    # @return [Array{String}] icons paths of bmp image icons
     def icons
       @icons ||= lambda {
         # Fetch the largest size icon
@@ -105,6 +164,7 @@ module AppInfo
       }.call
     end
 
+    # @return [PEdump]
     def pe
       @pe ||= lambda {
         pe = PEdump.new(io)
@@ -113,6 +173,7 @@ module AppInfo
       }.call
     end
 
+    # @return [VersionInfo]
     def version_info
       @version_info ||= VersionInfo.new(pe.version_info)
     end
@@ -124,6 +185,7 @@ module AppInfo
       @imports = nil
     end
 
+    # @return [String] binary_file path
     def binary_file
       @binary_file ||= lambda {
         file_io = ::File.open(@file, 'rb')
@@ -131,7 +193,7 @@ module AppInfo
 
         zip_file = Zip::File.open(@file)
         zip_entry = zip_file.glob('*.exe').first
-        raise NotFoundWinBinraryError, 'Not found .exe file in archive file' if zip_entry.nil?
+        raise NotFoundError, 'Not found .exe file in archive file' if zip_entry.nil?
 
         exe_file = tempdir(zip_entry.name, prefix: 'pe-exe', system: true)
         zip_entry.extract(exe_file)
@@ -147,6 +209,7 @@ module AppInfo
       @image_file_header ||= pe.pe.image_file_header
     end
 
+    # @return [Hash{Symbol => String}]
     def icon_metadata(file, mask_file: nil)
       {
         name: ::File.basename(file),
@@ -156,42 +219,75 @@ module AppInfo
       }
     end
 
+    # @return [File]
     def io
       @io ||= ::File.open(binary_file, 'rb')
     end
 
     # VersionInfo class
     #
-    # Ref: https://learn.microsoft.com/zh-cn/windows/win32/menurc/versioninfo-resource
+    # @see https://learn.microsoft.com/zh-cn/windows/win32/menurc/versioninfo-resource
     class VersionInfo
       def initialize(raw)
         @raw = raw
       end
 
+      # @return [String]
       def company_name
         @company_name ||= value_of('CompanyName')
       end
 
+      # @return [String]
       def product_name
         @product_name ||= value_of('ProductName')
       end
 
+      # @return [String]
       def product_version
         @product_version ||= value_of('ProductVersion')
       end
 
+      # @return [String]
       def assembly_version
         @assembly_version ||= value_of('Assembly Version')
       end
 
+      # @return [String]
       def file_version
         @file_version ||= value_of('FileVersion')
       end
 
+      # @return [String, nil]
       def file_description
         @file_description ||= value_of('FileDescription')
       end
 
+      # @return [String, nil]
+      def special_build
+        @special_build ||= value_of('SpecialBuild')
+      end
+
+      # @return [String, nil]
+      def private_build
+        @private_build ||= value_of('PrivateBuild')
+      end
+
+      # @return [String]
+      def original_filename
+        @original_filename ||= value_of('OriginalFilename')
+      end
+
+      # @return [String]
+      def internal_name
+        @internal_name ||= value_of('InternalName')
+      end
+
+      # @return [String]
+      def legal_trademarks
+        @legal_trademarks ||= value_of('LegalTrademarks')
+      end
+
+      # @return [String]
       def copyright
         @copyright ||= value_of('LegalCopyright')
       end

data/lib/app_info/png_uncrush.rb

@@ -32,18 +32,24 @@ module AppInfo
         @data = String.new
       end
 
+      # @return [Integer]
       def size
         @io.size
       end
 
+      # @param [String] format
+      # @return [String]
+      # @see IO package data
       def unpack(format)
         @io.unpack(format)
       end
 
+      # @return [String]
       def header
         @header ||= self[0, 8]
       end
 
+      # @return [Boolean]
       def png?
         header.bytes == PNG_HEADER
       end
@@ -61,10 +67,17 @@ module AppInfo
       end
     end
 
+    # Decompress crushed png file.
+    # @param [String] input path of png file
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def self.decompress(input, output)
       new(input).decompress(output)
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def self.dimensions(input)
       new(input).dimensions
     end
@@ -74,10 +87,16 @@ module AppInfo
       raise FormatError, 'not a png file' unless @io.png?
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def dimensions
       _dump_sections(dimensions: true)
     end
 
+    # Decompress crushed png file.
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def decompress(output)
       content = _remap(_dump_sections)
       return false unless content

data/lib/app_info/proguard.rb

@@ -10,41 +10,54 @@ module AppInfo
 
     NAMESPACE = UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, 'icyleaf.com')
 
-    def file_type
-      Format::PROGUARD
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::GOOGLE
     end
 
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::ANDROID
+    end
+
+    # @return [String]
     def uuid
       # Similar to https://docs.sentry.io/workflow/debug-files/#proguard-uuids
       UUIDTools::UUID.sha1_create(NAMESPACE, ::File.read(mapping_path)).to_s
     end
     alias debug_id uuid
 
+    # @return [Boolean]
     def mapping?
       ::File.exist?(mapping_path)
     end
 
+    # @return [Boolean]
     def manifest?
       ::File.exist?(manifest_path)
     end
 
+    # @return [Boolean]
     def symbol?
       ::File.exist?(symbol_path)
     end
     alias resource? symbol?
 
+    # @return [String, nil]
     def package_name
       return unless manifest?
 
       manifest.root.attributes['package']
     end
 
+    # @return [String, nil]
     def releasd_version
       return unless manifest?
 
       manifest.root.attributes['package']
     end
 
+    # @return [String, nil]
     def version_name
       return unless manifest?
 
@@ -52,6 +65,7 @@ module AppInfo
     end
     alias release_version version_name
 
+    # @return [String, nil]
     def version_code
       return unless manifest?
 
@@ -59,25 +73,30 @@ module AppInfo
     end
     alias build_version version_code
 
+    # @return [REXML::Document]
     def manifest
       return unless manifest?
 
       @manifest ||= REXML::Document.new(::File.new(manifest_path))
     end
 
+    # @return [String]
     def mapping_path
       @mapping_path ||= Dir.glob(::File.join(contents, '*mapping*.txt')).first
     end
 
+    # @return [String]
     def manifest_path
       @manifest_path ||= ::File.join(contents, 'AndroidManifest.xml')
     end
 
+    # @return [String]
     def symbol_path
       @symbol_path ||= ::File.join(contents, 'R.txt')
     end
     alias resource_path symbol_path
 
+    # @return [String] contents path of contents
     def contents
       @contents ||= unarchive(@file, prefix: 'proguard')
     end

data/lib/app_info/protobuf/manifest.rb

@@ -6,6 +6,7 @@ require 'app_info/core_ext'
 
 module AppInfo
   module Protobuf
+    # AAB Protobuf Base class
     class Base
       include Helper::GenerateClass
 
@@ -21,6 +22,7 @@ module AppInfo
       end
     end
 
+    # AAB Protobuf Attribute
     class Attribute < Base
       attr_reader :namespace, :name, :value, :resource_id
 
@@ -47,6 +49,8 @@ module AppInfo
       end
     end
 
+    # AAB Protobuf Node class.
+    #   example: manifest,activity, activity-alias, service, receiver, provider, application
     class Node < Base
       attr_reader :name, :attributes, :children
 
@@ -106,6 +110,7 @@ module AppInfo
       end
     end
 
+    # AAB Protobuf Manifest
     class Manifest < Node
       def self.parse(io, resources = nil)
         doc = Aapt::Pb::XmlNode.decode(io)
@@ -170,7 +175,6 @@ module AppInfo
         end.flatten.uniq
       end
 
-      # :nodoc:
       # Workaround ruby always return true by called `Object.const_defined?(Data)`
       class Data < Node; end
 

data/lib/app_info/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppInfo
-  VERSION = '3.0.0.beta1'
+  VERSION = '3.0.0.beta3'
 end

data/lib/app_info.rb

@@ -11,18 +11,19 @@ require 'app_info/file'
 require 'app_info/info_plist'
 require 'app_info/mobile_provision'
 
+require 'app_info/apple'
+require 'app_info/macos'
 require 'app_info/ipa'
 require 'app_info/ipa/plugin'
 require 'app_info/ipa/framework'
 
-require 'app_info/android/signature'
+require 'app_info/android'
 require 'app_info/apk'
 require 'app_info/aab'
 
 require 'app_info/proguard'
 require 'app_info/dsym'
 
-require 'app_info/macos'
 require 'app_info/pe'
 
 # fix invaild date format warnings
@@ -45,7 +46,7 @@ module AppInfo
                when Format::MACOS then Macos.new(file)
                when Format::PE then PE.new(file)
                else
-                 raise UnknownFileTypeError, "Do not detect file type: #{file}"
+                 raise UnknownFormatError, "Do not detect file format: #{file}"
                end
 
       return parser unless block_given?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app-info
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta3
 platform: ruby
 authors:
 - icyleaf
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -226,6 +226,7 @@ files:
 - lib/app-info.rb
 - lib/app_info.rb
 - lib/app_info/aab.rb
+- lib/app_info/android.rb
 - lib/app_info/android/signature.rb
 - lib/app_info/android/signatures/base.rb
 - lib/app_info/android/signatures/info.rb
@@ -234,6 +235,7 @@ files:
 - lib/app_info/android/signatures/v3.rb
 - lib/app_info/android/signatures/v4.rb
 - lib/app_info/apk.rb
+- lib/app_info/apple.rb
 - lib/app_info/certificate.rb
 - lib/app_info/const.rb
 - lib/app_info/core_ext.rb