headdesk 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b32f9efbc0414b9e7d1e10dbbb3bfed5bcbbf9b8f5a6375f37d546fed4f71ba
-  data.tar.gz: e560426b394c8e1cfefe63ac4c3b0323316f544bca2ec9a470003c5f62e8b2a2
+  metadata.gz: 32bd2bbb779c1bf25077fcbe9680c62e66237ca200b0d37c8d38a637ee0a80a4
+  data.tar.gz: ba38100146dbaab98d4c355548980ca9133e5ba4fa1bc192b1ac6c2cfd7ea27a
 SHA512:
-  metadata.gz: fb1a6c4b85f0969811414af5daae9e6ea7d2ccff2c6441f37fb1d22e102efccbfd56c2d81ec02615d39f0c3e6c176894245c0804789e041a0cb65d67c988aea0
-  data.tar.gz: d38442d793b4a7873dcd574a881de6d1a8a3d5a8cb07ed7f4da60e46998ed3aa3905d66e4b3c09cac040fbb97163a0a537ded5b84fe1b69e736bd67b93020f31
+  metadata.gz: c8998523ae8fc26ed6717b871399b0810435efab9bf88d900af6b61746b9dc5f6563b04c4e299dc33e0204adee5c8788b8d7fdd2127297d9e5f94fc972aa0c74
+  data.tar.gz: fbd63dd5c57e087e658bfb487abbd7c690ee6c8aa137dd773b92c0e35a68f0c3fae23c59b85d834dd3b7035469ebe9b4bc4f0fda0e356506792bd2fc47595090

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headdesk (0.11.3)
+    headdesk (0.12.0)
       awesome_print (~> 1.8)
       gems (~> 1.1)
       nokogiri (~> 1.10)

data/docs/activity_alias.md

@@ -0,0 +1,46 @@
+# activity_alias
+Ensures that each `<activity-alias>` declared in the `AndroidManifest.xml` is valid.
+
+## Will Skip If
+* `AndroidManifest.xml` does not contain any `<activity-alias>` nodes.
+
+## Will Fail If
+* An `<activity-alias>` has a `targetActivity` which does not exist in the `AndroidManifest.xml`.
+* An `<activity-alias>` does not contain an `<intent-filter>` or...
+    * An `<intent-filter>` does not include `<action android:name="android.intent.action.MAIN" />`.
+    * An `<intent-filter>` does not include `<category android:name="android.intent.category.LAUNCHER" />`.
+
+## Exports
+The `<activity-alias>` nodes present.
+
+### Example
+```json
+{  
+  "aliases":[
+    {
+      "name":"com.unity3d.player.UnityPlayerActivity",
+      "targetActivity":"io.teak.sdk.wrapper.unity.TeakUnityPlayerActivity"
+    }
+  ]
+}
+```
+
+## Reason
+When an app changes the class of its main `<activity>` any shortcut that the app, or the user, has created will be removed.
+
+To avoid this, apps can use `<activity-alias>` to redirect any reference to the old activity to a new activity.
+
+An `<activity-alias>` must point to a valid `<activity>` and must include intent filters which will redirect the `android.intent.action.MAIN` action and `android.intent.category.LAUNCHER` category, otherwise shortcuts will not be preserved.
+
+## Resolution
+Make sure your `<activity-alias>` has a `targetActivity` which points to an `<activity>` defined in `AndroidManifest.xml`
+```xml
+<activity-alias
+    android:name="your.old.activity.name"
+    android:targetActivity="your.new.activity.name" >
+    <intent-filter>
+        <action android:name="android.intent.action.MAIN" />
+        <category android:name="android.intent.category.LAUNCHER" />
+    </intent-filter>
+</activity-alias>
+```

data/docs/teak/api21_icon.md

@@ -13,10 +13,10 @@ Also verifies following files have the specified image dimensions:
 
 ## Will Fail If
 * There is no drawable resource for `io_teak_small_notification_icon`.
-* There is no v21 drawable resource for `io_teak_small_notification_icon`
+* There is no v21 drawable resource for `io_teak_small_notification_icon`.
 * The drawable resources point to the same image.
-* The v21 drawable resources do not exist, or are the incorrect size
-    * `drawable-mdpi/[icon_v21].png` does not exist, or is not 24x24
+* The v21 drawable resources do not exist, or are the incorrect size...
+    * `drawable-mdpi/[icon_v21].png` does not exist, or is not 24x2
     * `drawable-hdpi/[icon_v21].png` does not exist, or is not 36x36
     * `drawable-xhdpi/[icon_v21].png` does not exist, or is not 48x48
     * `drawable-xxhdpi/[icon_v21].png` does not exist, or is not 72x72

data/lib/headdesk/apk.rb

@@ -17,21 +17,27 @@ module Headdesk
     attr_reader :yaml, :sdk_info, :android_manifest, :resources
 
     # :reek:TooManyStatements
-    def initialize(path)
+    def initialize(path, manifest_contents = nil, yaml_contents = nil)
       @path = path
 
       android_manifest_xml = File.join(@path, 'AndroidManifest.xml').freeze
       apktool_yml = File.join(@path, 'apktool.yml').freeze
 
-      throw CliError.new('Path did not contain AndroidManifest.xml and/or apktool.yml') unless File.exist?(android_manifest_xml) && File.exist?(apktool_yml)
+      throw CliError.new('Path did not contain AndroidManifest.xml') unless File.exist?(android_manifest_xml) || manifest_contents
+      throw CliError.new('Path did not contain apktool.yml') unless File.exist?(apktool_yml) || yaml_contents
 
-      @yaml = YAML.load_file(apktool_yml)
+      @yaml = yaml_contents || YAML.load_file(apktool_yml)
       @sdk_info = @yaml['sdkInfo']
       @resources = Resources.new(@path)
 
-      @android_manifest = File.open(android_manifest_xml) do |file|
+      manifest = Nokogiri::XML(manifest_contents) if manifest_contents
+      manifest ||= File.open(android_manifest_xml) do |file|
         Nokogiri::XML(file)
       end
+
+      @android_manifest = manifest.xpath('manifest')
+      throw CliError.new('Invalid Android manifest') if @android_manifest.empty?
+      @android_manifest = @android_manifest.first
     end
 
     def analyze

data/lib/headdesk/checks/activity_alias.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Headdesk
+  module Checks
+    #
+    # An <activity-alias> is most commonly used to change the class of the MAIN
+    # activity, while preserving shortcuts.
+    #
+    # <intent-filter> must include both:
+    #   <action android:name="android.intent.action.MAIN" />
+    #   <category android:name="android.intent.category.LAUNCHER" />
+    #
+    # and must point to an <activity> that has been defined
+    #
+    class ActivityAlias
+      include Check::APK
+
+      check_name 'activity_alias'
+      describe "<activity-alias> is used to preserve app shortcuts"
+      def call
+        describe 'AndroidManifest.xml contains one or more <activity-alias>'
+        skip_check if: apk.android_manifest.xpath('application/activity-alias').empty?
+
+        aliases = []
+        apk.android_manifest.xpath('application/activity-alias').each do |activity_alias|
+          describe "AndroidManifest.xml contains <activity> '#{activity_alias.attributes['targetActivity']}'"
+          fail_check if: apk.android_manifest.xpath("application/activity[@android:name='#{activity_alias.attributes['targetActivity']}']").empty?
+
+          describe "<activity-alias> '#{activity_alias.attributes['name']}' -> '#{activity_alias.attributes['targetActivity']}' has '<intent-filter>'"
+          fail_check if: activity_alias.xpath("intent-filter").empty?
+
+          describe "<intent-filter> contains '<action android:name=\"android.intent.action.MAIN\" />'"
+          fail_check if: activity_alias.xpath("intent-filter/action[@android:name='android.intent.action.MAIN']").empty?
+
+          describe "<intent-filter> contains '<category android:name=\"android.intent.category.LAUNCHER\" />'"
+          fail_check if: activity_alias.xpath("intent-filter/category[@android:name='android.intent.category.LAUNCHER']").empty?
+
+          aliases << {
+            name: activity_alias.attributes['name'],
+            targetActivity: activity_alias.attributes['targetActivity']
+          }
+        end
+        export aliases: aliases
+      end
+    end
+  end
+end

data/lib/headdesk/checks/teak.rb

@@ -31,7 +31,7 @@ module Headdesk
         #
         module InstanceMethods
           def preconditions?
-            false unless apk.class?('io.teak.sdk.Teak')
+            apk.class?('io.teak.sdk.Teak')
           end
 
           def teak_sdk

data/lib/headdesk/report.rb

@@ -73,7 +73,7 @@ module Headdesk
   class APKReport < Report
     def initialize(apk)
       super()
-      @bundle_id = apk.android_manifest.xpath('//manifest').first.attributes['package']
+      @bundle_id = apk.android_manifest.attributes['package']
       @file_name = apk.yaml['apkFileName']
       @android_sdk = apk.sdk_info
     end

data/lib/headdesk/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Headdesk
-  VERSION = '0.11.3'
+  VERSION = '0.12.0'
   APKTOOL_VERSION = '2.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headdesk
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Pat Wilson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,6 +180,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".reek.yml"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -191,6 +192,7 @@ files:
 - bin/console
 - bin/facebook_sdk_versions
 - bin/setup
+- docs/activity_alias.md
 - docs/api26.md
 - docs/facebook.md
 - docs/receiver.md
@@ -209,6 +211,7 @@ files:
 - lib/headdesk/apk/resources.rb
 - lib/headdesk/apktool.rb
 - lib/headdesk/check.rb
+- lib/headdesk/checks/activity_alias.rb
 - lib/headdesk/checks/api26.rb
 - lib/headdesk/checks/facebook.rb
 - lib/headdesk/checks/receiver.rb