replicant-adb 0.0.1 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25ff78db9805a61866c8ba3be4c9d404ca666858
+  data.tar.gz: 44c65677a410f9bf4b78c3b8d44ccf97ce6c00bd
+SHA512:
+  metadata.gz: 636cc5f837bb35dc349c5af94d908368ee9ea8a23172d2ab525ec32e5495000ca190305d864fa83df12f770afaa0a5c57ff9a58be4a2f1389e53de7089fe25fe
+  data.tar.gz: 9acc12a4f28448766545489786faf6ed5b0dc527560dd347bd4b616125fc2ebe723ba84e866aed4993dd81758f6482bfc2d44d756baf293e12e7bd8959ac3101

data/README.md

@@ -1,5 +1,7 @@
 replicant - a repl for adb
 ==========================
+[![Gem Version](https://badge.fury.io/rb/replicant-adb.png)](http://badge.fury.io/rb/replicant-adb)
+[![Build Status](https://travis-ci.org/mttkay/replicant.png)](https://travis-ci.org/mttkay/replicant)
 
 `replicant` is an interactive shell (a [REPL][2]) for `adb`, the Android Debug Bridge.
 It is partially based on Chris Wanstrath's excellent [repl][0] command line wrapper.
@@ -23,7 +25,7 @@ From here on we list the available commands, fix the device to the first listed
 emulator, uninstall the app, then reset the session.
 
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-     v1.0.0
+     v0.0.1
                                 dP oo                              dP
                                 88                                 88
      88d888b. .d8888b. 88d888b. 88 dP .d8888b. .d8888b. 88d888b. d8888P
@@ -32,45 +34,34 @@ emulator, uninstall the app, then reset the session.
      dP       `88888P' 88Y888P' dP dP `88888P' `88888P8 dP    dP   dP
                        88
                        dP                    (c) 2013 Matthias Kaeppler
-    
-    
-     Type !list to see a list of commands.
+
+
+     Type '!' to see a list of commands, '?' for environment info.
      Commands not starting in '!' are sent to adb verbatim.
      Use Ctrl-D (i.e. EOF) to exit.
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     Setting default package to "com.soundcloud.android"
-    -- com.soundcloud.android, No device set
-    >> !list
+    >> !
+    !clear                -- clear application data
     !device               -- set a default device to work with
     !devices              -- print a list of connected devices
-    !list                 -- print a list of available commands
+    !logcat               -- access device logs
     !package              -- set a default package to work with
     !reset                -- clear current device and package
     !restart              -- restart ADB
     OK.
-    -- com.soundcloud.android, No device set
     >> !devices
-    
-    005de387d71505d6     [Nexus 4]
-    emulator-5554        [Android SDK built for x86]
-    
+
+    [0] Nexus 4                            | 005de387d71505d6
+    [1] Genymotion Nexus 4 API 18 768x1280 | 192.168.56.101:5555
+
     OK.
-    -- com.soundcloud.android, No device set
-    >> !device emu1
-    
-    005de387d71505d6     [Nexus 4]
-    emulator-5554        [Android SDK built for x86]
-    
-    Setting default device to emulator-5554 [Android SDK built for x86]
+    >> !device 0
+    Setting default device to 005de387d71505d6 [Nexus 4]
     OK.
-    -- com.soundcloud.android, emulator-5554 [Android SDK built for x86]
     >> uninstall
     Success
     OK.
-    -- com.soundcloud.android, emulator-5554 [Android SDK built for x86]
-    >> !reset
-    OK.
-    -- No package set, No device set
     >> 
 
 Install
@@ -81,22 +72,15 @@ command history and tab-completion, although it's not a requirement.
 `replicant` integrates with `rlwrap` automatically;
 it's sufficient for it to just be installed.
 
-Replicant hasn't seen a stable release yet, so for now, has to be installed as a local Ruby gem.
-To proceed, make sure that [bundler][3] is installed on your system. (e.g. `$gem install bundler`)
-
-Clone this repository, then:
-
-    $ cd replicant
-    $ bundle install
-    $ rake install
+If all requirements are met, you can install `replicant` as a Ruby gem:
 
+    $ gem install replicant-adb
 
 Contributing
 ------------
 
-[![Build Status](https://travis-ci.org/mttkay/replicant.png)](https://travis-ci.org/mttkay/replicant)
-
 Please hack on replicant and make it better and more feature complete!
+Here's a general list of guidelines you should follow:
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -105,6 +89,20 @@ Please hack on replicant and make it better and more feature complete!
 * Write an executable spec. See existing specs in the test/ folder for examples.
 * Commit and push until you are happy with your contribution.
 
+After checking out the project, change into the project dir and do
+
+    $ bundle install
+
+to make sure all dependencies are installed. After making local changes, you can
+install locally using
+
+    $ rake install
+
+And don't forget to regularly
+
+    $ rake test
+
+
 Copyright
 ---------
 

data/lib/replicant.rb

@@ -3,7 +3,9 @@ require 'active_support/core_ext/string/filters.rb'
 require 'active_support/core_ext/object/try.rb'
 
 require 'replicant/version'
-require 'replicant/command'
 require 'replicant/styles'
+require 'replicant/process_muncher'
+require 'replicant/log_muncher'
+require 'replicant/commands'
 require 'replicant/device'
 require 'replicant/repl'

data/lib/replicant/commands.rb

@@ -0,0 +1,10 @@
+require_relative "commands/command"
+require_relative "commands/adb_command"
+require_relative "commands/clear_command"
+require_relative "commands/device_command"
+require_relative "commands/devices_command"
+require_relative "commands/env_command"
+require_relative "commands/list_command"
+require_relative "commands/package_command"
+require_relative "commands/reset_command"
+require_relative "commands/restart_command"

data/lib/replicant/commands/adb_command.rb

@@ -0,0 +1,47 @@
+class AdbCommand < Command
+
+  class Result
+    attr_accessor :pid, :code, :output
+
+    def to_s
+      "result: pid=#{pid} code=#{code} output=#{output}"
+    end
+  end
+
+  def run
+    Result.new.tap do |result|
+      cmd = "#{command}"
+
+      putsd cmd
+
+      if interactive?
+        system cmd
+      else
+        result.output = `#{cmd}`
+        output result.output
+      end
+      result.pid  = $?.pid
+      result.code = $?.exitstatus
+      putsd "Command returned with exit status #{result.code}"
+    end
+  end
+
+  def command
+    adb = "adb"
+    adb << " -s #{@repl.default_device.id}" if @repl.default_device
+    adb << " #{args}"
+    adb << " #{@repl.default_package}" if @repl.default_package && package_dependent?
+    adb << " 2>&1" # redirect stderr to stdout so that we can silence it
+    adb
+  end
+
+  private
+
+  def interactive?
+    args == "shell" || args.start_with?("logcat")
+  end
+
+  def package_dependent?
+    ["uninstall"].include?(args)
+  end
+end

data/lib/replicant/commands/clear_command.rb

@@ -0,0 +1,23 @@
+class ClearCommand < Command
+
+  def description
+    "clear application data"
+  end
+
+  # TODO: this is not a very good argument validator
+  def valid_args?
+    args.present? || @repl.default_package
+  end
+
+  def usage
+    "#{name} [com.example.package|<empty>(when default package is set)]"
+  end
+
+  def run
+    package = args.present? ? args : @repl.default_package
+    # Clear app data - cache, SharedPreferences, Databases
+    AdbCommand.new(@repl, "shell su -c \"rm -r /data/data/#{package}/*\"").execute
+    # Force application stop to recreate shared preferences, databases with new launch
+    AdbCommand.new(@repl, "shell am force-stop #{package}").execute
+  end
+end

data/lib/replicant/commands/command.rb

@@ -0,0 +1,85 @@
+require 'stringio'
+
+class Command
+
+  include Styles
+
+  def self.inherited(subclass)
+    @@subclasses ||= []
+    @@subclasses << subclass
+  end
+
+  def self.all
+    (@@subclasses - [AdbCommand, ListCommand, EnvCommand]).map do |clazz|
+      clazz.new(nil)
+    end
+  end
+
+  def self.load(repl, command_line)
+    if command_line == '!'
+      # load command that lists available commands
+      ListCommand.new(repl)
+    elsif command_line == '?'
+      EnvCommand.new(repl)
+    elsif command_line.start_with?('!')
+      # load custom command
+      command_parts = command_line[1..-1].split
+      command_name = command_parts.first
+      command_args = command_parts[1..-1].join(' ')
+      command_class = "#{command_name.capitalize}Command"
+      begin
+        clazz = Object.const_get(command_class)
+        clazz.new(repl, command_args)
+      rescue NameError => e
+        nil
+      end
+    else
+      # forward command to ADB
+      AdbCommand.new(repl, command_line.strip)
+    end
+  end
+
+  attr_reader :args
+
+  def initialize(repl, args = nil, options = {})
+    @repl = repl
+    @args = args.strip if args
+    @options = options
+  end
+
+  def name
+    "!#{self.class.name.gsub("Command", "").downcase}"
+  end
+
+  # subclasses override this to provide a description of their functionality
+  def description
+    "TODO: description missing"
+  end
+
+  # subclasses override this to provide a usage example
+  def usage
+  end
+
+  def execute
+    if valid_args?
+      run
+    else
+      output "Invalid arguments. Ex.: #{usage}"
+    end
+  end
+
+  private
+
+  def valid_args?
+    true
+  end
+
+  def output(message)
+    @repl.output(message) unless @options[:silent]
+  end
+
+  def putsd(message)
+    puts "[DEBUG] #{message}" if @repl.debug?
+  end
+
+end

data/lib/replicant/commands/device_command.rb

@@ -0,0 +1,87 @@
+class DeviceCommand < Command
+
+  @@threads = []
+
+  def initialize(repl, args = nil, options = {})
+    super
+    @process_muncher = ProcessMuncher.new(repl)
+    @log_muncher = LogMuncher.new(repl)
+  end
+
+  def description
+    "set a default device to work with"
+  end
+
+  def usage
+    "#{name} [<index>|<device_id>]"
+  end
+
+  def valid_args?
+    args.present? && /\S+/ =~ args
+  end
+
+  def run
+    default_device = if index? && (1..devices.size).include?(args.to_i)
+      # user selected by index
+      devices[args.to_i - 1]
+    else
+      # user selected by device ID
+      devices.detect { |d| d.id == args }
+    end
+
+    if default_device
+      @repl.default_device = default_device
+      output "Default device set to #{default_device.name}"
+
+      # kill any existing threads
+      putsd "Found #{@@threads.size} zombie threads, killing..." unless @@threads.empty?
+      @@threads.select! { |t| t.exit }
+      
+      @@threads << @log_muncher.munch_logs do |logfile|
+        observe_pid_changes(logfile)
+      end
+
+      output "Logs are available at #{LogMuncher::LOGFILE}"
+    else
+      output "No such device"
+    end
+
+    default_device
+  end
+
+  private
+
+  def index?
+    /^\d+$/ =~ args
+  end
+
+  def devices
+    @devices ||= DevicesCommand.new(@repl, nil, :silent => true).execute
+  end
+
+  def observe_pid_changes(logfile)
+    @@threads << @process_muncher.scan_pid do |new_pid|
+      @log_muncher.current_pid = new_pid
+      if new_pid
+        log_state_change!(logfile, "#{@repl.default_package} (pid = #{new_pid})")
+      else
+        log_state_change!(logfile, "<all>")
+      end
+    end    
+  end
+
+  def log_message!(o, message)
+    o.puts "*" * Styles::CONSOLE_WIDTH
+    o.puts " #{message}"
+    o.puts "*" * Styles::CONSOLE_WIDTH
+    o.flush
+  end
+
+  def log_state_change!(o, change)
+    msg = "Detected change in device or target package\n"
+    msg << "-" * Styles::CONSOLE_WIDTH
+    msg << "\n   --> device  = #{@repl.default_device.name}"
+    msg << "\n   --> process = #{change}"
+    log_message!(o, msg)
+  end
+end

data/lib/replicant/commands/devices_command.rb

@@ -0,0 +1,57 @@
+class DevicesCommand < Command
+  def description
+    "print a list of connected devices"
+  end
+
+  def run
+    adb = AdbCommand.new(@repl, "devices -l", :silent => true)
+    device_lines = adb.execute.output.lines.to_a.reject do |line|
+      line.strip.empty? || line.include?("daemon") || line.include?("List of devices")
+    end
+
+    device_lines.reject! { |l| l =~ /offline/ }
+    device_ids = device_lines.map { |l| /([\S]+)\s+device/.match(l)[1] }
+    device_products = device_lines.map { |l| /product:([\S]+)/.match(l).try(:[], 1) }
+
+    device_names = device_lines.zip(device_ids).map do |l, id|
+      /model:([\S]+)/.match(l).try(:[], 1) || detect_device_name(id)
+    end
+
+    device_indices = (1..device_ids.size).to_a
+    devices = device_indices.zip(device_ids, device_names, device_products).map do |idx, id, name, product|
+      Device.new(idx, id, humanize_name(name, product))
+    end
+
+    output ""
+    output devices_string(devices)
+    output ""
+    devices
+  end
+
+  private
+
+  def detect_device_name(id)
+    if id.start_with?("emulator-")
+      "Android emulator"
+    else
+      "Unknown device"
+    end
+  end
+
+  def humanize_name(name_string, product)
+    if product == "vbox86p"
+      "Genymotion " + name_string.gsub(/___[\d_]+___/, "_")
+    else
+      name_string
+    end.gsub('_', ' ').squish
+  end
+
+  def devices_string(devices)
+    device_string = if devices.any?
+      padding = devices.map { |d| d.name.length }.max
+      devices.map { |d| "[#{d.idx}] #{d.name}#{' ' * (padding - d.name.length)} | #{d.id}" }.join("\n")
+    else
+      "No devices found"
+    end
+  end
+end