headdesk 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9067a4b373fd01b502fd6cb77fafc2bd1c60e9d18aef42390832e855bf6437e8
-  data.tar.gz: 3eccbb70deffe105e84a5ae0bfd6aecf8977ae9d9399665863570681fa92933a
+  metadata.gz: 1cb06518f9ed0ec0293c645af5598133a19791c575093359b56cf87e787233de
+  data.tar.gz: 6a0bd907a2c18c63098029cb30956c8ebe903529b34738cf61a2b1b61d3b0983
 SHA512:
-  metadata.gz: 046264add67d0b39f07a5d57eb95372fd5b0ba5278443c17768aade9932a3c2a868454f25a239df242644f61b4ec766370aed860ef8944a64012c8de6726dace
-  data.tar.gz: eac8f28b1aa2ddc80bb30369f9b384dc2c6928a611720b16b914705498d448feaa10e66a90cf19c98e646f64d17595f33df2d3d24e2468f2eeeb3249c0082f87
+  metadata.gz: bf63bee2c75af483978333022c08fcdcdd61d3abab31f979445ef2766287baf9a750d3303e9538358d29c7152ea44e76a8a0aadd429cf8a671f7b4b6c4ef0f00
+  data.tar.gz: 20d878b5cf28dbe13ad88b838143a9da3ca62ee3693b39db205c2975f3edecc3f1e81ca9ef1657c1efa9052446e299c59bcd50c9672d6dcf7655637b097c73a5

data/.reek.yml

@@ -5,6 +5,8 @@ detectors:
     - 'apk.resources'
     - 'Thor::Base.shell'
     - 'CLI.command_help'
+    - 'exit'
   TooManyStatements:
     exclude:
     - 'Headdesk::Checks'
+    - 'Headdesk::CliCommands'

data/Gemfile

@@ -4,8 +4,5 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'reek'
-gem 'rubocop'
-
 # Specify your gem's dependencies in headdesk.gemspec
 gemspec

data/Gemfile.lock

@@ -26,6 +26,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
     equalizer (0.0.11)
+    gem-release (2.0.1)
     gems (1.1.1)
       json
     ice_nine (0.11.2)
@@ -37,7 +38,7 @@ GEM
       mini_portile2 (~> 2.4.0)
     oily_png (1.2.1)
       chunky_png (~> 1.3.7)
-    parallel (1.12.1)
+    parallel (1.13.0)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
@@ -63,7 +64,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.62.0)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
@@ -86,11 +87,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  gem-release (~> 2.0)
   headdesk!
   rake (~> 10.0)
-  reek
+  reek (~> 5.0)
   rspec (~> 3.8)
-  rubocop
+  rubocop (~> 0)
 
 BUNDLED WITH
    2.0.1

data/headdesk.gemspec

@@ -17,15 +17,6 @@ Gem::Specification.new do |spec|
 
   spec.post_install_message = 'For breaking change announcements...'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
-  #     'public gem pushes.'
-  # end
-
   # 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.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -36,8 +27,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'gem-release', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'reek', '~> 5.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0'
 
   spec.add_dependency 'awesome_print', '~> 1.8'
   spec.add_dependency 'gems', '~> 1.1'

data/lib/headdesk/cli.rb

@@ -1,114 +1,24 @@
 # frozen_string_literal: true
 
-require 'tmpdir'
 require 'thor'
 require 'headdesk'
 require 'awesome_print'
 
+Dir[File.dirname(__FILE__) + '/cli_commands/*.rb'].each { |file| require file }
+
 module Headdesk
   #
   # headdesk CLI
   #
-  # :reek:TooManyStatements
   class CLI < Thor
     no_commands do
-      def print_update_message
-        STDOUT.puts format("\e[36m%s\e[0m", "Latest version is #{Headdesk::Versions.latest_version}, please run 'bundle update headdesk'")
-      end
-    end
-
-    desc 'unpack FILE [DESTINATION]', 'Unpack an APK or IPA to [DESTINATION] or to the current directory'
-    method_option :analyze, type: :boolean, aliases: '-a'
-    def unpack(file, destination = nil)
-      # Make sure the input file exists
-      unless File.exist?(file)
-        STDERR.puts "Could not find: #{file}"
-        CLI.command_help(Thor::Base.shell.new, 'unpack')
-        return 1
-      end
-
-      # Make sure destination exists, if specified
-      unless !destination || Dir.exist?(destination)
-        STDERR.puts "Could not find destination path: #{destination}"
-        CLI.command_help(Thor::Base.shell.new, 'unpack')
-        return 1
-      end
-
-      begin
-        stdout = nil
-        output_path = destination
-
-        if !destination
-          # Output to tempdir, then copy to cwd if no destination specified
-          Dir.mktmpdir do |tmp_dir|
-            output_path = tmp_dir
-            stdout = Headdesk::ApkTool.unpack_to(file, tmp_dir)
-            FileUtils.cp_r("#{tmp_dir}/.", Dir.pwd)
-          end
-        else
-          stdout = Headdesk::ApkTool.unpack_to(file, destination)
-        end
-
-        # analyze if requested
-        Headdesk::Analyze.at(output_path) if options[:analyze]
-      rescue CliError => cli_err
-        STDERR.puts cli_err.message
-        CLI.command_help(Thor::Base.shell.new, 'unpack')
-        return 1
-      rescue StandardError => rb_err
-        STDERR.puts err.message.red
-        STDERR.puts err.backtrace.ai
-        return 1
+      def print_update_message(stream = STDERR)
+        stream.puts "Latest version is #{Headdesk::Versions.latest_version}, please run 'bundle update headdesk'".red
       end
     end
 
-    desc 'analyze [FILE]', 'Analyze an APK or IPA'
-    method_option :path, type: :string
-    method_option :json, type: :boolean
-    def analyze(file = nil)
-      # Make sure input file exsts, if specified
-      unless !file || File.exist?(file)
-        STDERR.puts "Could not find input file: #{file}"
-        CLI.command_help(Thor::Base.shell.new, 'analyze')
-        return 1
-      end
-
-      # Unpack APK if needed
-      path = options[:path]
-      tmp_dir = nil
-      if file
-        path = tmp_dir = Dir.mktmpdir
-        Headdesk::ApkTool.unpack_to(file, tmp_dir)
-      end
-
-      # Make sure path exists
-      unless Dir.exist?(path)
-        STDERR.puts "Could not find path: #{path}"
-        CLI.command_help(Thor::Base.shell.new, 'analyze')
-        return 1
-      end
-
-      # analyze
-      begin
-        report = Headdesk::Analyze.at(path)
-
-        if options[:json]
-          STDOUT.puts report.to_json
-        else
-          STDOUT.puts report.to_s
-          print_update_message unless Headdesk::Versions.latest_version?
-        end
-      rescue CliError => cli_err
-        STDERR.puts cli_err.message
-        CLI.command_help(Thor::Base.shell.new, 'analyze')
-        return 1
-      rescue StandardError => err
-        STDERR.puts err.message.red
-        STDERR.puts err.backtrace.ai
-        return 1
-      end
-    ensure
-      FileUtils.remove_entry(tmp_dir) if tmp_dir
+    Headdesk::CliCommand.each do |cmd|
+      include cmd
     end
   end
 end

data/lib/headdesk/cli_commands/analyze.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'headdesk'
+require 'tmpdir'
+
+module Headdesk
+  module CliCommands
+    #
+    # Analyze an APK/IPA file
+    #
+    module Analyze
+      include Headdesk::CliCommand
+
+      def self.included(thor)
+        thor.class_eval do
+          desc 'analyze [FILE]', 'Analyze an APK or IPA'
+          method_option :path, type: :string
+          method_option :json, type: :boolean
+          def analyze(file = nil)
+            # Make sure input file exsts, if specified
+            unless !file || File.exist?(file)
+              STDERR.puts "Could not find input file: #{file}"
+              CLI.command_help(Thor::Base.shell.new, 'analyze')
+              exit 1
+            end
+
+            # Unpack APK if needed
+            path = options[:path]
+            tmp_dir = nil
+            if file
+              path = tmp_dir = Dir.mktmpdir
+              Headdesk::ApkTool.unpack_to(file, tmp_dir)
+            end
+
+            # Make sure path exists
+            unless Dir.exist?(path)
+              STDERR.puts "Could not find path: #{path}"
+              CLI.command_help(Thor::Base.shell.new, 'analyze')
+              exit 1
+            end
+
+            # analyze
+            begin
+              report = Headdesk::Analyze.at(path)
+
+              if options[:json]
+                STDOUT.puts report.to_json
+              else
+                STDOUT.puts report.to_s
+                CLI.print_update_message unless Headdesk::Versions.latest_version?
+              end
+            rescue CliError => cli_err
+              STDERR.puts cli_err.message
+              CLI.command_help(Thor::Base.shell.new, 'analyze')
+              exit 1
+            rescue StandardError => err
+              STDERR.puts err.message.red
+              STDERR.puts err.backtrace.ai
+              exit 1
+            end
+          ensure
+            FileUtils.remove_entry(tmp_dir) if tmp_dir
+          end
+        end
+      end
+    end
+  end
+end

data/lib/headdesk/cli_commands/blame.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'headdesk'
+require 'English'
+
+module Headdesk
+  module CliCommands
+    #
+    # Find out which JAR/AAR is bringing in symbols
+    #
+    module Blame
+      include Headdesk::CliCommand
+
+      def self.included(thor)
+        thor.class_eval do
+          desc 'blame SYMBOL [PATH]', 'Recursivly search for JARs and AARs which define a given symbol.'
+          method_option :json, type: :boolean
+          def blame(in_symbol, path = '.')
+            unless Dir.exist?(path)
+              STDERR.puts "Could not find path: #{path}"
+              CLI.command_help(Thor::Base.shell.new, 'blame')
+              exit 1
+            end
+
+            symbol_matcher = /(.*)(#{Regexp.escape(in_symbol.tr('.', '/'))})([^\.]*)?(\.class)?/
+
+            # Match inside JAR files
+            jar_matches = {}
+            Dir[File.join(path, '**', '*.jar')].each do |jar|
+              stdout = `jar -tf #{jar}`
+              exit $CHILD_STATUS.to_i unless $CHILD_STATUS.success?
+
+              matches = Blame.match_lines(stdout, symbol_matcher)
+              jar_matches[jar] = matches unless matches.empty?
+            end
+
+            # Match inside AAR files
+            aar_matches = {}
+            Dir[File.join(path, '**', '*.aar')].each do |aar|
+              stdout = `unzip -p -j #{aar} classes.jar | jar -t`
+              exit $CHILD_STATUS.to_i unless $CHILD_STATUS.success?
+
+              matches = Blame.match_lines(stdout, symbol_matcher)
+              aar_matches[aar] = matches unless matches.empty?
+            end
+
+            # JSON output if requested
+            if options[:json]
+              STDOUT.puts({ jar: jar_matches, aar: aar_matches }.to_json)
+              exit 0
+            end
+
+            # Pretty output
+            all_matches = jar_matches.merge(aar_matches)
+            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]}"
+              end
+            end
+
+            CLI.print_update_message unless Headdesk::Versions.latest_version?
+
+            exit !all_matches.empty?
+          end
+        end
+      end
+
+      def self.match_lines(stdout, matcher)
+        stdout.lines
+              .each(&:strip!)
+              .map { |line| matcher.match(line) }
+              .compact
+              .map { |match| match.captures.map { |capture| capture.tr('/', '.') if capture } }
+      end
+    end
+  end
+end

data/lib/headdesk/cli_commands/unpack.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'headdesk'
+require 'tmpdir'
+
+module Headdesk
+  module CliCommands
+    #
+    # Unpack an APK/IPA
+    #
+    module Unpack
+      include Headdesk::CliCommand
+
+      def self.included(thor)
+        thor.class_eval do
+          desc 'unpack FILE [DESTINATION]', 'Unpack an APK or IPA to [DESTINATION] or to the current directory'
+          method_option :analyze, type: :boolean, aliases: '-a'
+          def unpack(file, destination = nil)
+            # Make sure the input file exists
+            unless File.exist?(file)
+              STDERR.puts "Could not find: #{file}"
+              CLI.command_help(Thor::Base.shell.new, 'unpack')
+              exit 1
+            end
+
+            # Make sure destination exists, if specified
+            unless !destination || Dir.exist?(destination)
+              STDERR.puts "Could not find destination path: #{destination}"
+              CLI.command_help(Thor::Base.shell.new, 'unpack')
+              exit 1
+            end
+
+            begin
+              stdout = nil
+              output_path = destination
+
+              if !destination
+                # Output to tempdir, then copy to cwd if no destination specified
+                Dir.mktmpdir do |tmp_dir|
+                  output_path = tmp_dir
+                  stdout = Headdesk::ApkTool.unpack_to(file, tmp_dir)
+                  FileUtils.cp_r("#{tmp_dir}/.", Dir.pwd)
+                end
+              else
+                stdout = Headdesk::ApkTool.unpack_to(file, destination)
+              end
+
+              # analyze if requested
+              Headdesk::Analyze.at(output_path) if options[:analyze]
+
+              CLI.print_update_message unless Headdesk::Versions.latest_version?
+            rescue CliError => cli_err
+              STDERR.puts cli_err.message
+              CLI.command_help(Thor::Base.shell.new, 'unpack')
+              exit 1
+            rescue StandardError => rb_err
+              STDERR.puts err.message.red
+              STDERR.puts err.backtrace.ai
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/headdesk/cli_commands/version.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'headdesk'
+
+module Headdesk
+  module CliCommands
+    #
+    # Print/compare version
+    #
+    module Version
+      include Headdesk::CliCommand
+
+      def self.included(thor)
+        thor.class_eval do
+          map %w[--version] => :__version
+          desc '--version [COMPARE_VERSION]', 'Print, and optionally compare version.'
+          long_desc <<~LONGDESC
+            `--version` will print the version to STDOUT, and if a newer version is available it will print out an update message to STDERR.
+
+            You can optionally specify a version number as a second argument, in which case  will compare the current version with that version exit with code 1 if the current version is less than the provided version. It will exit with code 0 if the current version is less than, or equal to the provided version.
+          LONGDESC
+          def __version(cmp_version = nil)
+            STDOUT.puts Headdesk::VERSION
+            print_update_message unless Headdesk::Versions.latest_version?
+
+            exit (Headdesk::Versions.version <=> Gem::Version.new(cmp_version)) > 0 if cmp_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/headdesk/version.rb

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

data/lib/headdesk/versions.rb

@@ -7,6 +7,10 @@ module Headdesk
   # Version information from RubyGems.org
   #
   class Versions
+    def self.version
+      Gem::Version.new(VERSION)
+    end
+
     def self.versions
       Gems.versions('headdesk').collect do |version|
         Gem::Version.new(version['number'])

data/lib/headdesk.rb

@@ -22,4 +22,20 @@ module Headdesk
   #
   class CliError < StandardError
   end
+
+  #
+  # Helper for CLI command modules
+  #
+  module CliCommand
+    extend Enumerable
+
+    def self.each(&block)
+      @commands.each(&block)
+    end
+
+    def self.included(cmd)
+      @commands ||= []
+      @commands << cmd
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headdesk
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Pat Wilson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-21 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +211,10 @@ files:
 - lib/headdesk/checks/teak/caching.rb
 - lib/headdesk/checks/teak/teak.rb
 - lib/headdesk/cli.rb
+- lib/headdesk/cli_commands/analyze.rb
+- lib/headdesk/cli_commands/blame.rb
+- lib/headdesk/cli_commands/unpack.rb
+- lib/headdesk/cli_commands/version.rb
 - lib/headdesk/data/facebook_sdk_versions.yaml
 - lib/headdesk/descriptionator.rb
 - lib/headdesk/descriptionator/resources.rb