headdesk 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32bd2bbb779c1bf25077fcbe9680c62e66237ca200b0d37c8d38a637ee0a80a4
-  data.tar.gz: ba38100146dbaab98d4c355548980ca9133e5ba4fa1bc192b1ac6c2cfd7ea27a
+  metadata.gz: 7556187a87dbdfa6c3f9cec106695a8043091cd0c3cf43cfeb8d1b59bae32f2c
+  data.tar.gz: f968c92aa363c253af156ecf84e46b7319015ff1356e6cd4fbb550bbf06c360f
 SHA512:
-  metadata.gz: c8998523ae8fc26ed6717b871399b0810435efab9bf88d900af6b61746b9dc5f6563b04c4e299dc33e0204adee5c8788b8d7fdd2127297d9e5f94fc972aa0c74
-  data.tar.gz: fbd63dd5c57e087e658bfb487abbd7c690ee6c8aa137dd773b92c0e35a68f0c3fae23c59b85d834dd3b7035469ebe9b4bc4f0fda0e356506792bd2fc47595090
+  metadata.gz: 9690e535090b5c68192ff6fb04898f6517d47891c1f2196f2d926b1a8c7cdfe34a2795b28412c26bac5d29a0845ea76bef030ed53551da3a092859b06b78710c
+  data.tar.gz: ed9291760f36a5390a1bb5b867e663dd238915e6c0e1bc6e6deee31e273aee2e861aaa184864b10f79a15b8cc936783b5be2511c1f58e155004395971efd16d6

data/.gitignore

@@ -7,4 +7,6 @@
 /spec/reports/
 /tmp/
 
+coverage
+
 .DS_Store

data/Gemfile.lock

@@ -25,6 +25,7 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
+    docile (1.3.1)
     equalizer (0.0.11)
     gem-release (2.0.1)
     gems (1.1.1)
@@ -73,6 +74,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thor (0.20.3)
     thread_safe (0.3.6)
     unicode-display_width (1.4.1)
@@ -93,6 +99,7 @@ DEPENDENCIES
   reek (~> 5.0)
   rspec (~> 3.8)
   rubocop (~> 0, >= 0.49.0)
+  simplecov (~> 0, >= 0.16.0)
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -21,7 +21,6 @@ This is output from the check that ensures that the version of the Facebook SDK
 * [facebook](docs/facebook.md)
 * [receiver](docs/receiver.md)
 * [teak/api21_icon](docs/teak/api21_icon.md)
-* [teak/caching](docs/teak/caching.md)
 * [teak/configuration](docs/teak/configuration.md)
 
 ## Installation

data/docs/firebase_messaging_event.md

@@ -0,0 +1,43 @@
+# firebase_messaging_event
+Ensures that there is only one `<service>` with `<intent-filter` for `com.google.firebase.MESSAGING_EVENT` declared in the `AndroidManifest.xml` 
+
+## Will Fail If
+* More than one `<service>` has an `<intent-filter>` for `com.google.firebase.MESSAGING_EVENT` without specifying an `android:priority`
+
+## Exports
+The services which have an `<intent-filter>` for `com.google.firebase.MESSAGING_EVENT` present in `AndroidManifest.xml`
+
+### Example
+```json
+{
+  "filters":[
+    {
+      "name":"com.google.firebase.messaging.FirebaseMessagingService",
+      "priority":-500
+    },
+    {
+      "name":"com.leanplum.LeanplumPushFirebaseMessagingService",
+      "priority":0
+    },
+    {
+      "name":"io.teak.sdk.push.FCMPushProvider",
+      "priority":0
+    }
+  ]
+}
+```
+
+## Reason
+If multiple listeners for `com.google.firebase.MESSAGING_EVENT` exist, only the highest priority `<service>` will receive the message. This can cause unexpected behavior.
+
+## Resolution
+Remove the `<service>` blocks which have `<intent-filter>` for `com.google.firebase.MESSAGING_EVENT`, or add `android:priority` to the `<intent-filter>` to manually specify which `<service>` will process the message.
+
+For example, this gets inserted by Firebase automatically, and sets its priority to `-500`:
+```xml
+<service android:exported="false" android:name="com.google.firebase.messaging.FirebaseMessagingService">
+  <intent-filter android:priority="-500">
+    <action android:name="com.google.firebase.MESSAGING_EVENT"/>
+  </intent-filter>
+</service>
+```

data/headdesk.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/GoCarrot/headdesk'
   spec.license       = 'MIT'
 
-  spec.post_install_message = 'For breaking change announcements...'
+  # spec.post_install_message = 'For breaking change announcements...'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'reek', '~> 5.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0', '>= 0.49.0'
+  spec.add_development_dependency 'simplecov', '~> 0', '>= 0.16.0'
 
   spec.add_dependency 'awesome_print', '~> 1.8'
   spec.add_dependency 'gems', '~> 1.1'

data/lib/headdesk/apktool.rb

@@ -9,7 +9,7 @@ module Headdesk
   class ApkTool
     def self.apktool_jar
       File.join(File.dirname(__FILE__), '..', '..',
-        "ext/apktool_#{APKTOOL_VERSION}.jar")
+                "ext/apktool_#{APKTOOL_VERSION}.jar")
     end
 
     #

data/lib/headdesk/check.rb

@@ -53,7 +53,7 @@ module Headdesk
         status: @status
       }
       @report[:name] = self.class.check_name if self.class.respond_to?(:check_name)
-      @report[:doc] = "https://github.com/GoCarrot/headdesk/blob/#{Headdesk::VERSION}/docs/#{self.class.doc}" if self.class.respond_to?(:check_name)
+      @report[:doc] = "https://github.com/GoCarrot/headdesk/blob/v#{Headdesk::VERSION}/docs/#{self.class.doc}" if self.class.respond_to?(:check_name)
     end
 
     def describe(desc = nil)

data/lib/headdesk/checks/activity_alias.rb

@@ -16,18 +16,21 @@ module Headdesk
       include Check::APK
 
       check_name 'activity_alias'
-      describe "<activity-alias> is used to preserve app shortcuts"
+      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?
+          old_activity = activity_alias.attributes['name']
+          new_activity = activity_alias.attributes['targetActivity']
 
-          describe "<activity-alias> '#{activity_alias.attributes['name']}' -> '#{activity_alias.attributes['targetActivity']}' has '<intent-filter>'"
-          fail_check if: activity_alias.xpath("intent-filter").empty?
+          describe "AndroidManifest.xml contains <activity> '#{new_activity}'"
+          fail_check if: apk.android_manifest.xpath("application/activity[@android:name='#{new_activity}']").empty?
+
+          describe "<activity-alias> '#{old_activity}' -> '#{new_activity}' 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?
@@ -36,8 +39,8 @@ module Headdesk
           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']
+            name: old_activity,
+            targetActivity: new_activity
           }
         end
         export aliases: aliases

data/lib/headdesk/checks/facebook.rb

@@ -29,8 +29,13 @@ module Headdesk
           sdk[:major] == major && sdk[:minor] == minor && sdk[:patch] == patch
         end).first
 
-        describe "Found Facebook SDK version #{sdk_in_use[:version]}"
-        fail_check if: -> { !sdk_in_use }
+        begin
+          describe "Found Facebook SDK version #{sdk_in_use[:version]}"
+          fail_check if: -> { !sdk_in_use }
+        rescue NoMethodError => _e
+          describe "Facebook SDK version #{major}.#{minor}.#{patch} not found, run 'bundle exec bin/facebook_sdk_versions'"
+          fail_check
+        end
 
         export facebook_sdk: sdk_in_use
 

data/lib/headdesk/checks/firebase_messaging_event.rb

@@ -0,0 +1,36 @@
+# 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.
+    #
+    # com.google.firebase.MESSAGING_EVENT
+    #
+    class FirebaseMessagingEvent
+      include Check::APK
+
+      check_name 'firebase_messaging_event'
+      describe '<intent-filter> for \'com.google.firebase.MESSAGING_EVENT\''
+      def call
+        intent_filters = apk.android_manifest.xpath("application/service/intent-filter/action[@android:name='com.google.firebase.MESSAGING_EVENT']")
+        describe 'AndroidManifest.xml contains one or more <service> with <intent-filter> for \'com.google.firebase.MESSAGING_EVENT\''
+        skip_check if: intent_filters.empty?
+
+        filters = []
+        intent_filters.each do |filter|
+          filters << {
+            name: filter.parent.parent.attributes['name'].to_s,
+            priority: filter.parent.attributes['priority'].to_s.to_i
+          }
+        end
+        export filters: filters
+
+        max_priority = filters.max_by { |elem| elem[:priority].to_i }[:priority]
+        describe 'AndroidManifest.xml contains only one <service> with highest \'android:priority\' <intent-filter>'
+        fail_check if: filters.select { |elem| elem[:priority] == max_priority }.size > 1
+      end
+    end
+  end
+end

data/lib/headdesk/checks/teak.rb

@@ -31,21 +31,22 @@ module Headdesk
         #
         module InstanceMethods
           def preconditions?
-            apk.class?('io.teak.sdk.Teak')
+            begin
+              major, minor, revision = apk.find_class('io.teak.sdk.Teak')
+                                          .field('SDKVersion')
+                                          .value
+                                          .to_version
+              @teak_sdk = OpenStruct.new(
+                version: "#{major}.#{minor}.#{revision}",
+                major: major, minor: minor, revision: revision
+              )
+            rescue NoMethodError => _e
+              return false
+            end
+            true
           end
 
           def teak_sdk
-            return @teak_sdk if @teak_sdk
-
-            major, minor, revision = apk.find_class('io.teak.sdk.Teak')
-                                        .field('SDKVersion')
-                                        .value
-                                        .to_version
-            @teak_sdk = OpenStruct.new(
-              version: "#{major}.#{minor}.#{revision}",
-              major: major, minor: minor, revision: revision
-            )
-
             @teak_sdk
           end
         end

data/lib/headdesk/cli.rb

@@ -12,6 +12,7 @@ module Headdesk
   #
   class CLI < Thor
     no_commands do
+      # :reek:UtilityFunction
       def print_update_message(stream = STDERR)
         stream.puts "Latest version is #{Headdesk::Versions.latest_version}, please run 'bundle update headdesk'".red
       end

data/lib/headdesk/cli_commands/blame.rb

@@ -9,6 +9,7 @@ module Headdesk
     #
     # Find out which JAR/AAR is bringing in symbols
     #
+    # :reek:NilCheck, :reek:NestedIterators
     module Blame
       include Headdesk::CliCommand
 
@@ -56,7 +57,7 @@ module Headdesk
             all_matches.each do |package, symbols|
               STDOUT.puts '📦 ' + package
               symbols.each do |match|
-                STDOUT.puts "  ↳ #{match[0]}#{match[1].green}#{match[2].chomp('.') if match[2]}"
+                STDOUT.puts "  ↳ #{match[0]}#{match[1].green}#{match[2]&.chomp('.')}"
               end
             end
 
@@ -72,7 +73,7 @@ module Headdesk
               .each(&:strip!)
               .map { |line| matcher.match(line) }
               .compact
-              .map { |match| match.captures.map { |capture| capture.tr('/', '.') if capture } }
+              .map { |match| match.captures.map { |capture| capture&.tr('/', '.') } }
       end
     end
   end

data/lib/headdesk/cli_commands/unpack.rb

@@ -55,8 +55,8 @@ module Headdesk
               CLI.command_help(Thor::Base.shell.new, 'unpack')
               exit 1
             rescue StandardError => rb_err
-              STDERR.puts err.message.red
-              STDERR.puts err.backtrace.ai
+              STDERR.puts rb_err.message.red
+              STDERR.puts rb_err.backtrace.ai
               exit 1
             end
           end

data/lib/headdesk/data/facebook_sdk_versions.yaml

@@ -1,4 +1,19 @@
 ---
+- :major: 4
+  :minor: 41
+  :patch: 0
+  :version: 4.41.0
+  :date: 2019-03-08
+- :major: 4
+  :minor: 40
+  :patch: 0
+  :version: 4.40.0
+  :date: 2019-01-22
+- :major: 4
+  :minor: 39
+  :patch: 0
+  :version: 4.39.0
+  :date: 2018-12-05
 - :major: 4
   :minor: 38
   :patch: 1

data/lib/headdesk/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Headdesk
-  VERSION = '0.12.0'
+  VERSION = '0.13.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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Pat Wilson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-08 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -195,9 +215,9 @@ files:
 - docs/activity_alias.md
 - docs/api26.md
 - docs/facebook.md
+- docs/firebase_messaging_event.md
 - docs/receiver.md
 - docs/teak/api21_icon.md
-- docs/teak/caching.md
 - docs/teak/configuration.md
 - exe/headdesk
 - ext/apktool_2.3.4.jar
@@ -214,10 +234,10 @@ files:
 - lib/headdesk/checks/activity_alias.rb
 - lib/headdesk/checks/api26.rb
 - lib/headdesk/checks/facebook.rb
+- lib/headdesk/checks/firebase_messaging_event.rb
 - lib/headdesk/checks/receiver.rb
 - lib/headdesk/checks/teak.rb
 - lib/headdesk/checks/teak/api21_icon.rb
-- lib/headdesk/checks/teak/caching.rb
 - lib/headdesk/checks/teak/teak.rb
 - lib/headdesk/cli.rb
 - lib/headdesk/cli_commands/analyze.rb
@@ -234,7 +254,7 @@ homepage: https://github.com/GoCarrot/headdesk
 licenses:
 - MIT
 metadata: {}
-post_install_message: For breaking change announcements...
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -250,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: headdesk helps identify and solve common issues in mobile development by

data/docs/teak/caching.md

@@ -1,24 +0,0 @@
-# teak/caching
-Ensures that the APK contains a notification icon for both Android 5+ (API 21+) as well as pre-Android 5, and that these are different icons.
-
-## Will Skip If
-* The Teak SDK is not present.
-* The version of the Teak SDK is greater or equal to 2.0.0.
-
-## Will Fail If
-* `io_teak_enable_caching` is not specified.
-* `io_teak_enable_caching` is not set to `true`.
-
-## Exports
-None.
-
-## Reason
-The Teak SDK uses [Android HTTP Caching](https://developer.android.com/training/efficient-downloads/redundant_redundant#ResponseCache) to prevent downloading redundant Notification assets.
-
-The `io_teak_enable_caching` setting allows you to disable this behavior, however it should be enabled unless your app, or an SDK that you use, makes uncommon assumptions.
-
-## Resolution
-Upgrade to the Teak 2.0 SDK, or add this to your Android resources XML:
-```xml
-    <bool name="io_teak_enable_caching">true</bool>
-```

data/lib/headdesk/checks/teak/caching.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Headdesk
-  module Checks
-    module Teak
-      #
-      # Check to make sure that an APK, which uses Teak, has caching enabled.
-      #
-      class Caching
-        include Checks::Teak::APK
-
-        check_name 'caching'
-        describe 'Check for io_teak_enable_caching'
-        def call
-          describe 'Teak SDK version is lower than 2.0.0'
-          major, = apk.find_class('io.teak.sdk.Teak')
-                      .field('SDKVersion')
-                      .value
-                      .to_version
-          skip_check if: major.to_i >= 2
-
-          describe "APK enables caching of Teak notification content (via 'io_teak_enable_caching')"
-          fail_check unless: apk.resources
-                                .values
-                                .bool
-                                .io_teak_enable_caching
-        end
-      end
-    end
-  end
-end