danger-apkstats 0.0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc1a0db0fe161e8b61abb00fd8a12a7040af81ef0b525d3c5a2a06267e2e0d9f
-  data.tar.gz: 36c1d0ab4947c4fae224f5f35d8449415c73de6981f01a1f49602597acae8724
+  metadata.gz: 206a4a16c43f2e18507ab485cce2947c1e932fbee471db57e4f43b20b9e4aa02
+  data.tar.gz: f38876905c1095c7da969bbb6d6e43ea5a09ab0cce2941544263137c2ffa3a1e
 SHA512:
-  metadata.gz: 965a9ddd9979aef4ad646489d10402695686d8260d3a86fb4c666370f491d1b5cc76ece977db67d6216408ba87ccaf15e1ab29322ddab9ac85e6273a99b23531
-  data.tar.gz: 71130099a63a8f8d347c647e4ecff86cc8964600118e9bdd30ed771e5441372de7f1acd270b53247d54d29558b1422676d879eb8a303893681b21daa72c328c7
+  metadata.gz: a9490b757975f4ed708ce6e2df907cea5594cd1fdd8bd338cd6eff111f8d75148c41ad442c1756af7aca9f78992d908fb76905bbcd7cddb0fb3f4ea4e6ab4d04
+  data.tar.gz: 73c01476155e698d19655affd292bbdebfffad6e4615bb96257280a57deced379b7a4fedc3bcd43d049460a8d0f2da6925d9fae7e08c048e4fd0b7eb6e3fbbd8

data/.circleci/android-sdk-license

@@ -0,0 +1,3 @@
+
+d56f5187479451eabf01fb78af6dfcb131a6481e
+24333f8a63b6825ea9c5514f83c2829b004d1fee

data/.circleci/config.yml

@@ -0,0 +1,104 @@
+version: 2.1
+
+executors:
+  base:
+    docker:
+    - image: circleci/android:api-29
+    working_directory: ~/workspace
+    environment:
+      ANDROID_SDK_ROOT: /home/circleci/sdk
+      APKANALYZER_PATH: /home/circleci/sdk/cmdline-tools/tools/bin/apkanalyzer
+
+  ruby:
+    docker:
+      - image: circleci/ruby:2.7.1
+    working_directory: ~/workspace
+
+commands:
+  install-android-sdk:
+    parameters:
+      zip-version:
+        type: string
+        description: the version of the zip archive
+      build-tools:
+        type: string
+    steps:
+      - restore_cache:
+          key: v1-android-sdk-{{ arch }}-<< parameters.zip-version >>-<< parameters.build-tools >>
+      - run: |
+          version="<< parameters.zip-version >>"
+          if [ "$(cat $ANDROID_SDK_ROOT/.sdk_tools_version || echo)" != "$version" ]; then	
+            rm -fr $ANDROID_SDK_ROOT || :
+            mkdir -p $ANDROID_SDK_ROOT/licenses	$ANDROID_SDK_ROOT/cmdline-tools
+            curl -o sdk-tools-linux.zip "https://dl.google.com/android/repository/commandlinetools-linux-${version}_latest.zip"	
+            unzip "sdk-tools-linux.zip" -d $ANDROID_SDK_ROOT/cmdline-tools
+            echo "$version" > $ANDROID_SDK_ROOT/.sdk_tools_version
+          fi
+          mkdir -p $ANDROID_SDK_ROOT/licenses
+          cp .circleci/android-sdk-license $ANDROID_SDK_ROOT/licenses/
+          $ANDROID_SDK_ROOT/cmdline-tools/tools/bin/sdkmanager "build-tools;<< parameters.build-tools >>" 
+      - save_cache:
+          key: v1-android-sdk-{{ arch }}-<< parameters.zip-version >>-<< parameters.build-tools >>
+          paths:
+            - ~/sdk
+  install-ruby:
+    parameters:
+      ruby-version:
+        type: string
+    steps:
+      - run: |
+          sudo apt-get update && \
+          cd /tmp && wget -O ruby-install-0.6.1.tar.gz https://github.com/postmodern/ruby-install/archive/v0.6.1.tar.gz && \
+          tar -xzvf ruby-install-0.6.1.tar.gz && \
+          cd ruby-install-0.6.1 && \
+          sudo make install && \
+          ruby-install --cleanup ruby << parameters.ruby-version >> && \
+          rm -r /tmp/ruby-install-* && \
+          sudo rm -rf /var/lib/apt/lists/*
+
+          echo "export PATH=${HOME}/.rubies/ruby-<< parameters.ruby-version >>/bin:\${PATH}" >> $BASH_ENV
+      - run: ruby --version
+  bundle-install:
+    steps:
+      - restore_cache:
+          key: v1-bundle-{{ arch }}-{{ checksum "./Gemfile.lock" }}
+      - run: gem install bundler -v 2.1.4
+      - run: bundle install --path=vendor/bundle
+      - save_cache:
+          key: v1-bundle-{{ arch }}-{{ checksum "./Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+jobs:
+  lint:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle-install
+      - run: bundle exec rake rubocop
+
+  test:
+    parameters:
+      ruby_version:
+        type: string
+        description: 'Ruby version to be used'
+    executor: base
+    
+    steps:
+      - checkout
+      - install-ruby:
+          ruby-version: << parameters.ruby_version >>
+      - install-android-sdk:
+          zip-version: "6514223"
+          build-tools: 29.0.2
+      - bundle-install
+      - run: bundle exec rake specs spec_docs
+
+workflows:
+  materix_test:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              ruby_version: [2.5.8, 2.6.6, 2.7.1]

data/.gitignore

@@ -4,3 +4,4 @@ pkg
 .yardoc
 **/vendor/bundle/
 *.gem
+.bundle/

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.7.1
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+  Enabled: true
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -13,20 +22,16 @@ Style/StringLiterals:
 Style/ClassCheck:
   EnforcedStyle: kind_of?
 
-# It's better to be more explicit about the type
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 # specs sometimes have useless assignments, which is fine
 Lint/UselessAssignment:
   Exclude:
     - '**/spec/**/*'
 
 # We could potentially enable the 2 below:
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 # HoundCI doesn't like this rule
@@ -76,7 +81,7 @@ Metrics/CyclomaticComplexity:
   Max: 17
 
 # Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 370
 
 # Configuration parameters: CountKeywordArgs.
@@ -127,16 +132,16 @@ Metrics/BlockLength:
 Style/MixinGrouping:
   Enabled: false
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Style/SpecialGlobalVars:
   Enabled: false
 
-PercentLiteralDelimiters:
+Department/PercentLiteralDelimiters:
   PreferredDelimiters:
     "%":  ()
     "%i": ()
@@ -150,3 +155,51 @@ PercentLiteralDelimiters:
 
 Security/YAMLLoad:
   Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/Dangerfile.sample

@@ -0,0 +1,17 @@
+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)
+message("#{apkstats.reference_count}")
+message("#{apkstats.dex_count}")
+
+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,145 @@
+PATH
+  remote: .
+  specs:
+    danger-apkstats (0.3.0)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.0.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (>= 0.9.0, < 2.0)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    guard (2.16.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)
+    kramdown (2.2.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  danger-apkstats!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.1.4

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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Jumpei Matsuda <jmatsu.drm@gmail.com>
+Copyright (c) 2018-2020 Jumpei Matsuda <jmatsu.drm@gmail.com>
 
 MIT License
 

data/README.md

@@ -1,26 +1,65 @@
+[![jmatsu](https://circleci.com/gh/jmatsu/danger-apkstats.svg?style=shield)](https://circleci.com/gh/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.
+This is a plugin of [Danger](https://github.com/danger/danger) for Android projects.
+This allows you to get attributes of your application file (apk) and report a summary of comparison between two application files.
 
 ## Installation
 
-    $ gem install danger-apkstats
+`gem install danger-apkstats` or add `danger-apkstats` to your Gemfile.
+
+Please specify the path of apkanalyzer in your Dangerfile.
+
+```ruby
+apkstats.apkanalyzer_path='/path/to/apkanalyzer'
+```
+
+`ANDROID_HOME` has been officially deprecated. `ANDROID_SDK_ROOT` is similar to `ANDROID_HOME` but differs actually. And also, the change indicated the possibility of further deprecations and/or breaking changes in the Android SDK structure.
 
 ## Usage
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `apkstats` namespace.
+`apkstats` namespace is available under Dangerfile.
+    
+### Required preparation
 
-# Sample
+```
+apkstats.apk_filepath='app-debug.apk' # required.
+```
+
+### Show attributes
 
 ```
-apkstats.command_type=:apk_analyzer # 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
+apkstats.reference_count #=> Fixnum
+apkstats.dex_count #=> Fixnum
 ```
 
+### Get a comparison report
+
+```
+apkstats.compare_with(String, do_report: Boolean)
+```
+
+For example, the report will be like below.
+
+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
+New Number of dex file(s) | 15720
+Number of dex file(s) Change | 1
+
 ## Development
 
 1. Clone this repo
@@ -28,3 +67,9 @@ apkstats.downloadsize
 3. Run `bundle exec rake spec` to run the tests.
 4. Use `bundle exec guard` to automatically have tests run as you make changes.
 5. Make your changes.
+
+### Supported ruby versions
+
+Support only versions which are in normal and/or security maintenance.
+
+ref: https://www.ruby-lang.org/en/downloads/branches/