danger-apkstats 0.1.0 → 0.3.1

data/danger-apkstats.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.version       = Apkstats::VERSION
   spec.authors       = ["Jumpei Matsuda"]
   spec.email         = ["jmatsu.drm@gmail.com"]
-  spec.description   = "To inpsect android application file with danger."
+  spec.description   = "To inspect android application file with danger."
   spec.summary       = "This is a danger plugin to inspect android application file."
   spec.homepage      = "https://github.com/jmatsu/danger-apkstats"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files | grep -v 'fixture/'`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -22,8 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
 
   # General ruby development
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
 
   # Testing support
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/apkstats/command/apk_analyzer.rb

@@ -5,7 +5,7 @@ module Apkstats::Command
     include Apkstats::Command::Executable
 
     def initialize(opts)
-      @command_path = opts[:command_path] || "#{ENV.fetch('ANDROID_HOME')}/tools/bin/apkanalyzer"
+      @command_path = opts.fetch(:command_path)
     end
 
     def file_size(apk_filepath)
@@ -37,6 +37,17 @@ module Apkstats::Command
       run_command("manifest", "target-sdk", apk_filepath)
     end
 
+    def method_reference_count(apk_filepath)
+      ApkAnalyzer.parse_reference_to_map(run_command("dex", "references", apk_filepath))
+        .values
+        .map(&:to_i)
+        .inject(:+)
+    end
+
+    def dex_count(apk_filepath)
+      ApkAnalyzer.parse_reference_to_map(run_command("dex", "references", apk_filepath)).size
+    end
+
     def self.parse_permissions(command_output)
       command_output.split(/\r?\n/).map { |s| to_permission(s) }
     end
@@ -59,11 +70,19 @@ module Apkstats::Command
       ::Apkstats::Entity::Feature.new(name, not_required: kind == "not-required", implied_reason: kind == "implied:" && tail)
     end
 
+    def self.parse_reference_to_map(command_output)
+      command_output.split(/\r?\n/).each_with_object({}) do |s, acc|
+        dex_file, method_count = s.strip.split(/\t/, 2)
+        acc[dex_file] = method_count
+      end
+    end
+
     private
 
     def run_command(*args)
-      out, err, status = Open3.capture3("#{command_path} #{args.join(' ')}")
+      out, err, status = Open3.capture3(command_path, *args)
       raise err unless status.success?
+
       out.rstrip
     end
   end

data/lib/apkstats/command/executable.rb

@@ -21,6 +21,8 @@ module Apkstats::Command
     #     permissions: Array<String>,
     #     min_sdk: String,
     #     target_sdk: String,
+    #     method_reference_count: Integer,
+    #     dex_count: Integer,
     #   },
     #   other: {
     #     file_size: Integer,
@@ -30,6 +32,8 @@ module Apkstats::Command
     #     permissions: Array<String>,
     #     min_sdk: String,
     #     target_sdk: String,
+    #     method_reference_count: Integer,
+    #     dex_count: Integer,
     #   },
     #   diff: {
     #     file_size: Integer,
@@ -48,6 +52,8 @@ module Apkstats::Command
     #     },
     #     min_sdk: Array<String>,
     #     target_sdk: Array<String>,
+    #     method_reference_count: Integer,
+    #     dex_count: Integer,
     #   }
     # }
     #

data/lib/apkstats/entity/apk_info.rb

@@ -10,10 +10,12 @@ module Apkstats::Entity
       permissions
       min_sdk
       target_sdk
+      method_reference_count
+      dex_count
     ).freeze
 
     # Integer
-    attr_accessor :file_size, :download_size
+    attr_accessor :file_size, :download_size, :method_reference_count, :dex_count
 
     # String
     attr_accessor :min_sdk, :target_sdk

data/lib/apkstats/entity/apk_info_diff.rb

@@ -63,5 +63,15 @@ module Apkstats::Entity
       # String
       [@base[__method__], @other[__method__]].uniq
     end
+
+    def method_reference_count
+      # Integer
+      @base[__method__].to_i - @other[__method__].to_i
+    end
+
+    def dex_count
+      # Integer
+      @base[__method__].to_i - @other[__method__].to_i
+    end
   end
 end

data/lib/apkstats/entity/feature.rb

@@ -84,6 +84,7 @@ module Apkstats::Entity
 
     def eql?(other)
       return if !other || other.class == Features
+
       other.values == values
     end
 

data/lib/apkstats/entity/permission.rb

@@ -70,6 +70,7 @@ module Apkstats::Entity
 
     def eql?(other)
       return if !other || other.class == Permissions
+
       other.values == values
     end
 

data/lib/apkstats/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apkstats
-  VERSION = "0.1.0"
+  VERSION = "0.3.1"
 end

data/lib/apkstats/plugin.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "gem_version"
 require_relative "helper/bytes"
 
 require_relative "entity/apk_info"
@@ -51,28 +52,46 @@ module Danger
   #
   #         apkstats.target_sdk
   #
+  # @example Show the methods reference count of your apk file.
+  #
+  #         apkstats.method_reference_count
+  #
+  # @example Show the number of dex of your apk file.
+  #
+  #         apkstats.dex_count
+  #
   # @see  Jumpei Matsuda/danger-apkstats
   # @tags android, apk_stats
   #
   class DangerApkstats < Plugin
+    class Error < StandardError; end
+
+    # @deprecated this field have no effect
     COMMAND_TYPE_MAP = {
       apk_analyzer: Apkstats::Command::ApkAnalyzer,
     }.freeze
 
     private_constant(:COMMAND_TYPE_MAP)
 
-    # *Optional*
-    # A command type to be run.
-    # One of keys of COMMAND_TYPE_MAP
+    # @deprecated this field have no effect
+    # This will be removed in further versions
     #
-    # @return [Symbol, Nil] _
+    # @return [String] _
     attr_accessor :command_type
 
-    # *Optional*
-    # A custom command path
+    # *Required*
+    # A path of apkanalyzer command
     #
-    # @return [Symbol, Nil] _
-    attr_accessor :command_path
+    # @return [String] _
+    attr_accessor :apkanalyzer_path
+
+    # @deprecated Use apkanalyzer_path instead
+    # @return [String] _
+    alias command_path apkanalyzer_path
+
+    # @deprecated Use apkanalyzer_path= instead
+    # @return [String] _
+    alias command_path= apkanalyzer_path=
 
     # *Required*
     # Your target apk filepath.
@@ -80,7 +99,7 @@ module Danger
     # @return [String]
     attr_accessor :apk_filepath
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # Get stats of two apk files and calculate diffs between them.
     #
@@ -90,84 +109,102 @@ module Danger
     def compare_with(other_apk_filepath, do_report: true)
       raise "apk filepaths must be specified" if apk_filepath.nil? || apk_filepath.empty?
 
-      base_apk = Apkstats::Entity::ApkInfo.new(command, apk_filepath)
-      other_apk = Apkstats::Entity::ApkInfo.new(command, other_apk_filepath)
+      base_apk = Apkstats::Entity::ApkInfo.new(apkanalyzer_command, apk_filepath)
+      other_apk = Apkstats::Entity::ApkInfo.new(apkanalyzer_command, other_apk_filepath)
 
-      return {
+      result = {
           base: base_apk.to_h,
           other: base_apk.to_h,
           diff: Apkstats::Entity::ApkInfoDiff.new(base_apk, other_apk).to_h,
-      }.tap do |result|
-        break unless do_report
+      }
 
-        diff = result[:diff]
+      return result unless do_report
 
-        md = +"### Apk comparision results" << "\n\n"
-        md << "Property | Summary" << "\n"
-        md << ":--- | :---" << "\n"
+      diff = result[:diff]
 
-        diff[:min_sdk].tap do |min_sdk|
-          break if min_sdk.size == 1
+      md = +"### Apk comparison results" << "\n\n"
+      md << "Property | Summary" << "\n"
+      md << ":--- | :---" << "\n"
 
-          md << "Min SDK Change | Before #{min_sdk[1]} / After #{min_sdk[0]}" << "\n"
-        end
+      diff[:min_sdk].tap do |min_sdk|
+        break if min_sdk.size == 1
 
-        diff[:target_sdk].tap do |target_sdk|
-          break if target_sdk.size == 1
+        md << "Min SDK Change | Before #{min_sdk[1]} / After #{min_sdk[0]}" << "\n"
+      end
 
-          md << "Target SDK Change | Before #{target_sdk[1]} / After #{target_sdk[0]}" << "\n"
-        end
+      diff[:target_sdk].tap do |target_sdk|
+        break if target_sdk.size == 1
 
-        result[:base][:file_size].tap do |file_size|
-          size = Apkstats::Helper::Bytes.from_b(file_size)
+        md << "Target SDK Change | Before #{target_sdk[1]} / After #{target_sdk[0]}" << "\n"
+      end
 
-          md << "New File Size | #{size.to_b} Bytes. (#{size.to_mb} MB " << "\n"
-        end
+      result[:base][:file_size].tap do |file_size|
+        size = Apkstats::Helper::Bytes.from_b(file_size)
 
-        diff[:file_size].tap do |file_size|
-          size = Apkstats::Helper::Bytes.from_b(file_size)
+        md << "New File Size | #{size.to_b} Bytes. (#{size.to_mb} MB) " << "\n"
+      end
 
-          md << "File Size Change | #{size.to_s_b} Bytes. (#{size.to_s_kb} KB) " << "\n"
-        end
+      diff[:file_size].tap do |file_size|
+        size = Apkstats::Helper::Bytes.from_b(file_size)
 
-        diff[:download_size].tap do |download_size|
-          size = Apkstats::Helper::Bytes.from_b(download_size)
+        md << "File Size Change | #{size.to_s_b} Bytes. (#{size.to_s_kb} KB) " << "\n"
+      end
 
-          md << "Download Size Change | #{size.to_s_b} Bytes. (#{size.to_s_kb} KB) " << "\n"
-        end
+      diff[:download_size].tap do |download_size|
+        size = Apkstats::Helper::Bytes.from_b(download_size)
 
-        report_hash_and_arrays = lambda { |key, name|
-          list_up_entities = lambda { |type_key, label|
-            diff[key][type_key].tap do |features|
-              break if features.empty?
+        md << "Download Size Change | #{size.to_s_b} Bytes. (#{size.to_s_kb} KB) " << "\n"
+      end
 
-              md << "#{label} | " << features.map { |f| "- #{f}" }.join("<br>").to_s << "\n"
-            end
-          }
+      result[:base][:method_reference_count].tap do |method_reference_count|
+        md << "New Method Reference Count | #{method_reference_count}" << "\n"
+      end
 
-          list_up_entities.call(:new, "New #{name}")
-          list_up_entities.call(:removed, "Removed #{name}")
-        }
+      diff[:method_reference_count].tap do |method_reference_count|
+        md << "Method Reference Count Change | #{method_reference_count}" << "\n"
+      end
 
-        report_hash_and_arrays.call(:required_features, "Required Features")
-        report_hash_and_arrays.call(:non_required_features, "Non-required Features")
-        report_hash_and_arrays.call(:permissions, "Permissions")
+      result[:base][:dex_count].tap do |dex_count|
+        md << "New Number of dex file(s) | #{dex_count}" << "\n"
+      end
 
-        markdown(md)
+      diff[:dex_count].tap do |dex_count|
+        md << "Number of dex file(s) Change | #{dex_count}" << "\n"
       end
+
+      report_hash_and_arrays = lambda { |key, name|
+        list_up_entities = lambda { |type_key, label|
+          diff[key][type_key].tap do |features|
+            break if features.empty?
+
+            md << "#{label} | " << features.map { |f| "- #{f}" }.join("<br>").to_s << "\n"
+          end
+        }
+
+        list_up_entities.call(:new, "New #{name}")
+        list_up_entities.call(:removed, "Removed #{name}")
+      }
+
+      report_hash_and_arrays.call(:required_features, "Required Features")
+      report_hash_and_arrays.call(:non_required_features, "Non-required Features")
+      report_hash_and_arrays.call(:permissions, "Permissions")
+
+      markdown(md)
+      true
     rescue StandardError => e
       warn("apkstats failed to execute the command due to #{e.message}")
 
-      e.backtrace&.each { |line| STDOUT.puts line }
+      on_error(e)
+      false
     end
 
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # Show the file size of your apk file.
     #
     # @return [Fixnum] return positive value if exists, otherwise -1.
     def file_size(_opts = {})
-      result = run_command(__method__)
+      result = run_command(apkanalyzer_command, __method__)
       result ? result.to_i : -1
     end
 
@@ -175,7 +212,7 @@ module Danger
     #
     # @return [Fixnum] return positive value if exists, otherwise -1.
     def download_size(_opts = {})
-      result = run_command(__method__)
+      result = run_command(apkanalyzer_command, __method__)
       result ? result.to_i : -1
     end
 
@@ -184,7 +221,7 @@ module Danger
     #
     # @return [Array<String>, Nil] return nil unless retrieved.
     def required_features(_opts = {})
-      result = run_command(__method__)
+      result = run_command(apkanalyzer_command, __method__)
       result ? result.to_a : nil
     end
 
@@ -193,7 +230,7 @@ module Danger
     #
     # @return [Array<String>, Nil] return nil unless retrieved.
     def non_required_features(_opts = {})
-      result = run_command(__method__)
+      result = run_command(apkanalyzer_command, __method__)
       result ? result.to_a : nil
     end
 
@@ -201,7 +238,7 @@ module Danger
     #
     # @return [Array<String>, Nil] return nil unless retrieved.
     def permissions(_opts = {})
-      result = run_command(__method__)
+      result = run_command(apkanalyzer_command, __method__)
       result ? result.to_a : nil
     end
 
@@ -209,33 +246,78 @@ module Danger
     #
     # @return [String, Nil] return nil unless retrieved.
     def min_sdk(_opts = {})
-      run_command(__method__)
+      run_command(apkanalyzer_command, __method__)
     end
 
     # Show the target sdk version of your apk file.
     #
     # @return [String, Nil] return nil unless retrieved.
     def target_sdk(_opts = {})
-      run_command(__method__)
+      run_command(apkanalyzer_command, __method__)
+    end
+
+    # Show the methods reference count of your apk file.
+    #
+    # @return [Fixnum] return positive value if exists, otherwise -1.
+    def method_reference_count(_opts = {})
+      result = run_command(apkanalyzer_command, __method__)
+      result || -1
+    end
+
+    # Show the number of dex of your apk file.
+    #
+    # @return [Fixnum] return positive value if exists, otherwise -1.
+    def dex_count(_opts = {})
+      result = run_command(apkanalyzer_command, __method__)
+      result || -1
     end
 
     private
 
-    def run_command(name)
+    # @param [Apkstats::Command::Executable] command a wrapper class of a command
+    # @param [String] name an attribute name
+    def run_command(command, name)
       raise "#{command.command_path} is not found or is not executable" unless command.executable?
 
       return command.send(name, apk_filepath)
     rescue StandardError => e
       warn("apkstats failed to execute the command #{name} due to #{e.message}")
 
-      e.backtrace&.each { |line| puts line }
+      on_error(e)
+    end
 
-      nil
+    def apkanalyzer_command
+      return @apkanalyzer_command if defined?(@apkanalyzer_command)
+
+      command_path = apkanalyzer_path || `which apkanalyzer`.chomp
+
+      if command_path.empty?
+        sdk_path = ENV["ANDROID_HOME"] || ENV["ANDROID_SDK_ROOT"]
+
+        if sdk_path
+          tmp_path = File.join(sdk_path, "cmdline-tools/tools/bin/apkanalyzer")
+          tmp_path = File.join(sdk_path, "tools/bin/apkanalyzer") unless File.executable?(tmp_path)
+
+          command_path = tmp_path if File.executable?(tmp_path)
+        else
+          warn("apkstats will not infer the apkanalyzer path in further versions so please include apkanalyer in your PATH or specify it explicitly.")
+        end
+      end
+
+      command_path = command_path.chomp
+
+      raise Error, "Please include apkanalyer in your PATH or specify it explicitly." if command_path.empty?
+      raise Error, "#{command_path} is not executable." unless File.executable?(command_path)
+
+      @apkanalyzer_command = Apkstats::Command::ApkAnalyzer.new(command_path: command_path)
     end
 
-    def command
-      command_type ||= :apk_analyzer
-      @command ||= COMMAND_TYPE_MAP[command_type.to_sym].new(command_path: command_path)
+    # @param [StandardError] err a happened error
+    # @return [NilClass]
+    def on_error(err)
+      warn err.message
+      err.backtrace&.each { |line| warn line }
+      nil
     end
   end
 end