danger-apkstats 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc1a0db0fe161e8b61abb00fd8a12a7040af81ef0b525d3c5a2a06267e2e0d9f
-  data.tar.gz: 36c1d0ab4947c4fae224f5f35d8449415c73de6981f01a1f49602597acae8724
+  metadata.gz: 06da284025d85c4baf756df842fef7ed035bbc6a4b51e3869b03df48f851b480
+  data.tar.gz: ed4436f89c1b65211bd338aa4e48095df59c7f518c69a185836cdde7655d2149
 SHA512:
-  metadata.gz: 965a9ddd9979aef4ad646489d10402695686d8260d3a86fb4c666370f491d1b5cc76ece977db67d6216408ba87ccaf15e1ab29322ddab9ac85e6273a99b23531
-  data.tar.gz: 71130099a63a8f8d347c647e4ecff86cc8964600118e9bdd30ed771e5441372de7f1acd270b53247d54d29558b1422676d879eb8a303893681b21daa72c328c7
+  metadata.gz: d67745379004649774230e918514f09ac792050190540f23efab90c29308b9b3fe098884288c975f2c74a37e1aab2d9434881224a4e9682a0be1bf58859a17a4
+  data.tar.gz: 869be5736265bffec15b3468846b346a6a45c3b4796e7a80b4cf1448845009f22d9c6e5fb12bebc4c4d7a6e363bffa62a386cd4be18b39eeeeb9c31de139cd8c

data/.rubocop.yml

@@ -3,7 +3,16 @@
 # If you don't like these settings, just delete this file :)
 
 AllCops:
-  TargetRubyVersion: 2.0
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.3.7
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+  Enabled: true
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -150,3 +159,12 @@ PercentLiteralDelimiters:
 
 Security/YAMLLoad:
   Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,25 @@
 language: ruby
 cache:
   directories:
-    - bundle
+    - vendor/bundle
+    - sdk
 
 rvm:
-  - 2.0
-  - 2.1.3
-  - 2.3.1
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
 
 script:
-    - bundle exec rake spec
+  - |
+    version='4333796'
+
+    if [ "$(cat sdk/.sdk_tools_version || echo)" != "$version" ]; then
+      rm -fr sdk || :
+      mkdir -p sdk/licenses
+      curl -o sdk-tools-linux.zip "https://dl.google.com/android/repository/sdk-tools-linux-$version.zip"
+      unzip "sdk-tools-linux.zip" -d sdk
+    fi
+
+    echo "d56f5187479451eabf01fb78af6dfcb131a6481e" > sdk/licenses/android-sdk-license
+    sdk/tools/bin/sdkmanager "build-tools;27.0.3"
+  - ANDROID_HOME="$PWD/sdk" bundle exec rake spec

data/Dangerfile.sample

@@ -0,0 +1,15 @@
+apkstats.command_type=:apk_analyzer
+apkstats.apk_filepath='./spec/fixture/app-base.apk'
+
+# custom command path
+# apkstats.command_path='/path/to/analysis_command'
+
+message(apkstats.file_size)
+message(apkstats.download_size)
+message(apkstats.required_features)
+message(apkstats.non_required_features)
+message(apkstats.permissions)
+message(apkstats.min_sdk)
+message(apkstats.target_sdk)
+
+apkstats.compare_with('/spec/fixture/app-other5.apk', do_report: true)

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in danger-apkstats.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    danger-apkstats (0.1.0)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.6.4)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    git (1.4.0)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.1)
+    kramdown (1.17.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.9.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+    yard (0.9.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-apkstats!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # A guardfile for making Danger Plugins
 # For more info see https://github.com/guard/guard#readme
 
 # To run, use `bundle exec guard`.
 
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.com/jmatsu/danger-apkstats.svg?branch=master)](https://travis-ci.com/jmatsu/danger-apkstats) [![Gem Version](https://badge.fury.io/rb/danger-apkstats.svg)](https://badge.fury.io/rb/danger-apkstats)
+
 # danger-apkstats
 
 A description of danger-apkstats.
@@ -14,13 +16,32 @@ A description of danger-apkstats.
 # Sample
 
 ```
-apkstats.command_type=:apk_analyzer # required
-apkstats.apk_filepath='app-debug.apk' # required
+apkstats.apk_filepath='app-debug.apk' # required.
 apkstats.compare_with('app-other.apk', do_report: true)
-apkstats.filesize
-apkstats.downloadsize
+apkstats.file_size #=> Fixnum
+apkstats.download_size #=> Fixnum
+apkstats.required_features #=> Array<String> | Nil
+apkstats.non_required_features #=> Array<String> | Nil
+apkstats.permissions #=> Array<String> | Nil
+apkstats.min_sdk #=> String | Nil
+apkstats.target_sdk #=> String | Nils
 ```
 
+## Compare apk files
+
+The report will be like below.
+
+### Apk comparision results
+
+Property | Summary  
+:--- | :---
+New File Size | 1621248 Bytes. (1.55 MB
+File Size Change | -13352 Bytes. (-13.04 KB)
+Download Size Change | +41141 Bytes. (+40.18 KB)
+Removed Required Features | - android.hardware.camera
+Removed Non-required Features | - android.hardware.camera.front (not-required)
+Removed Permissions | - android.permission.INTERNET<br>- android.permission.CAMERA
+
 ## Development
 
 1. Clone this repo

data/Rakefile

@@ -1,23 +1,25 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:specs)
 
 task default: :specs
 
 task :spec do
-  Rake::Task['specs'].invoke
-  Rake::Task['rubocop'].invoke
-  Rake::Task['spec_docs'].invoke
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
 end
 
-desc 'Run RuboCop on the lib/specs directory'
+desc "Run RuboCop on the lib/specs directory"
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
 end
 
-desc 'Ensure that the plugin passes `danger plugins lint`'
+desc "Ensure that the plugin passes `danger plugins lint`"
 task :spec_docs do
-  sh 'bundle exec danger plugins lint'
+  sh "bundle exec danger plugins lint"
 end

data/danger-apkstats.gemspec

@@ -1,42 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'apkstats/gem_version.rb'
+require "apkstats/gem_version.rb"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'danger-apkstats'
+  spec.name          = "danger-apkstats"
   spec.version       = Apkstats::VERSION
-  spec.authors       = ['Jumpei Matsuda']
-  spec.email         = ['jmatsu.drm@gmail.com']
-  spec.description   = %q{To inpsect android application file with danger.}
-  spec.summary       = %q{This is a danger plugin to inspect android application file.}
-  spec.homepage      = 'https://github.com/jmatsu/danger-apkstats'
-  spec.license       = 'MIT'
+  spec.authors       = ["Jumpei Matsuda"]
+  spec.email         = ["jmatsu.drm@gmail.com"]
+  spec.description   = "To inpsect 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.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
 
   # Testing support
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency "rspec", "~> 3.4"
 
   # Linting code and docs
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "yard"
 
   # Makes testing easy via `bundle exec guard`
-  spec.add_development_dependency 'guard', '~> 2.14'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
 
   # If you want to work on older builds of ruby
-  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency "listen", "3.0.7"
 
   # This gives you the chance to run a REPL inside your tests
   # via:
@@ -45,5 +46,5 @@ Gem::Specification.new do |spec|
   #    binding.pry
   #
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "pry"
 end

data/lib/apkstats/command/apk_analyzer.rb

@@ -1,35 +1,70 @@
-module Danger::Apkstats
+# frozen_string_literal: true
+
+module Apkstats::Command
   class ApkAnalyzer
-    include Danger::Apkstats::ExecutableCommand
+    include Apkstats::Command::Executable
 
-    def compare_with(apk_filepath, other_apk_filepath)
-      out, err = run_command('apk', 'compare', '--different-only', apk_filepath, other_apk_filepath)
+    def initialize(opts)
+      @command_path = opts[:command_path] || "#{ENV.fetch('ANDROID_HOME')}/tools/bin/apkanalyzer"
+    end
 
-      if out
-        return out.partition("\n").first.strip, nil
-      else
-        return nil, err
-      end
+    def file_size(apk_filepath)
+      run_command("apk", "file-size", apk_filepath)
     end
 
-    def filesize(apk_filepath)
-      run_command('apk', 'file-size', apk_filepath)
+    def download_size(apk_filepath)
+      run_command("apk", "download-size", apk_filepath)
     end
 
-    def downloadsize(apk_filepath)
-      run_command('apk', 'download-size', apk_filepath)
+    def required_features(apk_filepath)
+      ::Apkstats::Entity::Features.new(ApkAnalyzer.parse_features(run_command("apk", "features", apk_filepath)))
     end
 
-    private
+    def non_required_features(apk_filepath)
+      all_features = ApkAnalyzer.parse_features(run_command("apk", "features", "--not-required", apk_filepath))
+      Apkstats::Entity::Features.new(all_features.select(&:not_required?))
+    end
 
-    def run_command(*args)
-      out, err, status = Open3.capture3("#{command} #{args.join(' ')}")
-      return out, nil if status == 0
-      return nil, (err || 'failed due while executing a command')
+    def permissions(apk_filepath)
+      ::Apkstats::Entity::Permissions.new(ApkAnalyzer.parse_permissions(run_command("manifest", "permissions", apk_filepath)))
+    end
+
+    def min_sdk(apk_filepath)
+      run_command("manifest", "min-sdk", apk_filepath)
+    end
+
+    def target_sdk(apk_filepath)
+      run_command("manifest", "target-sdk", apk_filepath)
+    end
+
+    def self.parse_permissions(command_output)
+      command_output.split(/\r?\n/).map { |s| to_permission(s) }
     end
 
-    def command
-      @command ||= "#{ENV.fetch('ANDROID_HOME')}/tools/bin/apkanalyzer"
+    def self.to_permission(str)
+      # If maxSdkVersion is specified, the output is like `android.permission.INTERNET' maxSdkVersion='23`
+      name_seed, max_sdk_seed = str.strip.split(/\s/)
+      ::Apkstats::Entity::Permission.new(name_seed.gsub(/'$/, ""), max_sdk: max_sdk_seed && max_sdk_seed[/[0-9]+/])
+    end
+
+    def self.parse_features(command_output)
+      command_output.split(/\r?\n/).map { |s| to_feature(s) }
+    end
+
+    def self.to_feature(str)
+      # format / name implied: xxxx
+      # not-required and implied cannot co-exist so it's okay to parse them like this
+      name, kind, tail = str.strip.split(/\s/, 3)
+
+      ::Apkstats::Entity::Feature.new(name, not_required: kind == "not-required", implied_reason: kind == "implied:" && tail)
+    end
+
+    private
+
+    def run_command(*args)
+      out, err, status = Open3.capture3("#{command_path} #{args.join(' ')}")
+      raise err unless status.success?
+      out.rstrip
     end
   end
-end
+end