replicant-adb 0.0.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm: 
+  - "1.9.3"
+script: "bundle exec rake test"

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "activesupport-core-ext", "~> 4.0", :require => false
+
+group :development do
+  gem "rake", "~> 10.1"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+end
+
+group :test do
+  gem "minitest", "~> 5.0", :require => 'minitest/autorun'
+  gem "mocha", "~> 0.14.0", :require => 'mocha/setup'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Matthias Kaeppler
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+replicant - a repl for adb
+==========================
+
+`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.
+
+![repl](https://raw.github.com/mttkay/replicant/master/screenshots/01_repl.png)
+
+Overview
+-------
+Working with the `adb` tool directly to target connected emulators and devices is
+verbose and cumbersome. `replicant` simplifies this process in a number of ways:
+
+- being a repl, you're now working with `adb` in interactive mode
+- allows fixing devices and package IDs for subsequent `adb` commands
+- auto-detection of target package by project folder inspection
+- command history and tab-completion via `rlwrap` (see below)
+
+### Example
+In this example session, we start `replicant` from the folder of an existing Android
+application. It detects the manifest file and sets a default package ID.
+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
+                                dP oo                              dP
+                                88                                 88
+     88d888b. .d8888b. 88d888b. 88 dP .d8888b. .d8888b. 88d888b. d8888P
+     88'  `88 88ooood8 88'  `88 88 88 88'  `"" 88'  `88 88'  `88   88
+     88       88.  ... 88.  .88 88 88 88.  ... 88.  .88 88    88   88
+     dP       `88888P' 88Y888P' dP dP `88888P' `88888P8 dP    dP   dP
+                       88
+                       dP                    (c) 2013 Matthias Kaeppler
+    
+    
+     Type !list to see a list of commands.
+     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
+    !device               -- set a default device to work with
+    !devices              -- print a list of connected devices
+    !list                 -- print a list of available commands
+    !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]
+    
+    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]
+    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
+-------
+`replicant` requires Ruby 1.9 and a UNIX/Linux compatible shell such as `bash` or `zsh`.
+For the best experience, I strongly recommend to install [rlwrap][1] to get
+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
+
+
+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!
+
+* 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.
+* Fork the project.
+* Start a feature branch to implement your bugfix or idea.
+* Write an executable spec. See existing specs in the test/ folder for examples.
+* Commit and push until you are happy with your contribution.
+
+Copyright
+---------
+
+Copyright (c) 2013 Matthias Kaeppler. See LICENSE.txt for
+further details.
+
+[0]: https://github.com/defunkt/repl
+[1]: http://utopia.knoware.nl/~hlub/rlwrap/
+[2]: http://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop
+[3]: http://bundler.io/

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require './lib/replicant/version'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "replicant-adb"
+  gem.version = Replicant::VERSION
+  gem.homepage = "https://github.com/mttkay/replicant"
+  gem.license = "MIT"
+  gem.summary = "A REPL for the Android Debug Bridge"
+  gem.description = "replicant is an interactive shell (a REPL) for ADB, the Android Debug Bridge"
+  gem.email = "m.kaeppler@gmail.com"
+  gem.authors = ["Matthias Kaeppler"]
+  gem.files.exclude 'screenshots/**'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_spec.rb'
+  test.verbose = true
+end
+
+task :default => :test
+

data/bin/replicant

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+begin
+  require 'replicant'
+rescue LoadError
+  begin
+    require 'rubygems'
+    require 'replicant'
+  end
+end
+
+Replicant::REPL.new.run

data/lib/replicant.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/object/blank.rb'
+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/device'
+require 'replicant/repl'

data/lib/replicant/command.rb

@@ -0,0 +1,352 @@
+require 'stringio'
+
+class Command
+
+  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)
+    puts message unless @options[:silent]
+  end
+
+end
+
+class AdbCommand < Command
+
+  # the command line program
+  ADB = 'adb'
+
+  def run
+    begin
+      cmd = "#{adb} #{args}"
+
+      if interactive?
+        system cmd
+      else
+        cmd << " #{@repl.default_package}" if @repl.default_package && package_dependent?
+        output cmd if @repl.debug?
+        result = `#{cmd}`
+        output result
+        result
+      end
+    end
+  end
+
+  private
+
+  def adb
+    adb = "#{ADB}"
+    adb << " -s #{@repl.default_device.id}" if @repl.default_device
+    adb
+  end
+
+  def interactive?
+    args == "shell" || args.start_with?("logcat")
+  end
+
+  def package_dependent?
+    ["uninstall"].include?(args)
+  end
+end
+
+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.lines.to_a.reject do |line|
+      line.strip.empty? || line.include?("daemon") || line.include?("List of devices")
+    end
+
+    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
+
+    devices = device_ids.zip(device_names, device_products).map do |id, name, product|
+      Device.new(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
+      indices = (0..devices.length - 1).to_a
+      indices.zip(devices).map { |i, d| "[#{i}] #{d.name}#{' ' * (padding - d.name.length)} | #{d.id}" }
+    else
+      "No devices found"
+    end
+  end
+end
+
+class PackageCommand < Command
+
+  def description
+    "set a default package to work with"
+  end
+
+  def usage
+    "#{name} com.mydomain.mypackage"
+  end
+
+  def valid_args?
+    args.present? && /^\w+(\.\w+)*$/ =~ args
+  end
+
+  def run
+    output "Setting default package to #{args.inspect}"
+    @repl.default_package = args
+  end
+end
+
+class DeviceCommand < Command
+  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?
+      # user selected by index
+      devices[args.to_i]
+    else
+      # user selected by device ID
+      devices.detect { |d| d.id == args }
+    end
+
+    if default_device
+      output "Setting default device to #{default_device.inspect}"
+      @repl.default_device = default_device
+    else
+      output "No such device"
+    end
+  end
+
+  private
+
+  def index?
+    /^\d+$/ =~ args
+  end
+
+  def devices
+    @devices ||= DevicesCommand.new(@repl, nil, :silent => true).execute
+  end
+
+end
+
+class ResetCommand < Command
+
+  def description
+    "clear current device and package"
+  end
+
+  def valid_args?
+    args.blank?
+  end
+
+  def run
+    @repl.default_device = nil
+    @repl.default_package = nil
+  end
+
+end
+
+class ListCommand < Command
+  def valid_args?
+    args.blank?
+  end
+
+  def description
+    "print a list of available commands"
+  end
+
+  def run
+    command_list = Command.all.sort_by {|c| c.name}.map do |command|
+      padding = 20 - command.name.length
+      desc = "#{command.name} #{' ' * padding} -- #{command.description}"
+      desc
+    end
+    output command_list.join("\n")
+  end
+end
+
+class RestartCommand < Command
+  def description
+    "restart ADB"
+  end
+
+  def run
+    # Faster than kill-server, and also catches ADB instances launched by
+    # IntelliJ. Moreover, start-server after kill-server sometimes makes the
+    # server fail to start up unless you sleep for a second or so
+    `killall adb`
+    AdbCommand.new(@repl, "start-server").execute
+  end
+end
+
+class LogcatCommand < Command
+
+  def description
+    "access device logs"
+  end
+
+  def valid_args?
+    args.blank?
+  end
+
+  def run
+    pid = if @repl.default_package
+      processes = AdbCommand.new(@repl, "shell ps", :silent => true).execute
+      pid_line = processes.lines.detect {|l| l.include?(@repl.default_package)}
+      pid_line.split[1].strip if pid_line
+    end
+
+    logcat = "logcat -v time"
+    logcat << " | grep -E '\(\s*#{pid}\)'"
+    AdbCommand.new(@repl, logcat).execute
+  end
+end
+
+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
+
+class EnvCommand < Command
+
+  def valid_args?
+    args.blank?
+  end
+
+  def run
+    env = "Package: #{@repl.default_package || 'Not set'}\n"
+    env << "Device: "
+    device = @repl.default_device
+    env << if device
+      "#{device.name} (#{device.id})"
+    else
+      'Not set'
+    end
+    output env
+  end
+end

data/lib/replicant/device.rb

@@ -0,0 +1,20 @@
+class Device
+  attr_reader :id, :name
+
+  def initialize(id, name)
+    @id = id
+    @name = name
+  end
+
+  def emulator?
+    @id.start_with?('emulator-')
+  end
+
+  def physical_device?
+    !emulator?
+  end
+
+  def to_s
+    "#{@id} [#{@name}]"
+  end
+end

data/lib/replicant/repl.rb

@@ -0,0 +1,156 @@
+require 'find'
+require 'rexml/document'
+
+module Replicant
+  class REPL
+
+    include Styles
+
+    # for auto-complete via rlwrap; should probably go in Rakefile at some point
+    ADB_COMMANDS = %w(devices connect disconnect push pull sync shell emu logcat
+      forward jdwp install uninstall bugreport backup restore help version
+      wait-for-device start-server kill-server get-state get-serialno get-devpath
+      status-window remount reboot reboot-bootloader root usb tcpip ppp)
+
+    attr_accessor :default_package
+    attr_accessor :default_device
+
+    def initialize
+    end
+
+    def run
+      # must be the first thing to execute, since it wraps the script
+      setup_rlwrap
+
+      show_greeting
+      if ARGV.any? { |arg| %w( -h --help -help help ).include?(arg) }
+        show_help
+      end
+
+      # try to detect a default package to work with from an AndroidManifest
+      # file somewhere close by
+      if manifest_path = detect_android_manifest_path
+        app_package = get_package_from_manifest(manifest_path)
+        PackageCommand.new(self, app_package).execute
+      end
+
+      # reset terminal colors on exit
+      at_exit { puts unstyled }
+
+      loop do
+        command_loop
+      end
+    end
+
+    def command_loop
+      print prompt
+
+      begin
+        command_line = $stdin.gets.chomp
+      rescue NoMethodError, Interrupt
+        exit
+      end
+
+      return if command_line.strip.empty?
+
+      command = Command.load(self, command_line)
+      if command
+        command.execute
+        puts span("OK.", :white_fg, :bold) { unstyled }
+      else
+        puts "No such command"
+      end
+    end
+
+    def debug?
+      ARGV.include?('--debug')
+    end
+
+    private
+
+    def prompt
+      prompt = ENV['REPL_PROMPT'] || begin
+        span('>> ', :white_fg, :bold) { styled(:green_fg) }
+      end.lstrip
+    end
+
+    def show_greeting
+      style = styled(:white_fg, :black_bg, :bold)
+      green = lambda { |text| span(text, :green_fg) { style } }
+
+      logo = <<-logo
+                            dP oo                              dP
+                            88                                 88
+ 88d888b. .d8888b. 88d888b. 88 dP .d8888b. .d8888b. 88d888b. d8888P
+ 88'  `88 88ooood8 88'  `88 88 88 88'  `"" 88'  `88 88'  `88   88
+ 88       88.  ... 88.  .88 88 88 88.  ... 88.  .88 88    88   88
+ dP       `88888P' 88Y888P' dP dP `88888P' `88888P8 dP    dP   dP
+                   88
+                   dP                    (c) 2013 Matthias Kaeppler
+      logo
+      puts style + ("~" * 70)
+      puts " v" + Replicant::VERSION
+      puts green[logo]
+      puts ""
+      puts " Type '#{green['!']}' to see a list of commands, '#{green['?']}' for environment info."
+      puts " Commands not starting in '#{green['!']}' are sent to adb verbatim."
+      puts " Use #{green['Ctrl-D']} (i.e. EOF) to exit."
+      puts ("~" * 70) + unstyled
+    end
+
+    def show_help
+      puts <<-help
+    Usage: replicant [options]
+
+    Options:
+      --help    Display this message
+      --debug   Display debug info
+
+    Bug reports, suggestions, updates:
+    http://github.com/mttkay/replicant/issues
+    help
+      exit
+    end
+
+    def setup_rlwrap
+      if !ENV['__REPL_WRAPPED'] && system("which rlwrap > /dev/null 2> /dev/null")
+        ENV['__REPL_WRAPPED'] = '0'
+
+        # set up auto-completion commands
+        completion_file = File.expand_path('~/.adb_completion')
+        File.open(completion_file, 'w') { |file| file.write(ADB_COMMANDS.join(' ')) }
+
+        # set up command history
+        if File.exists?(history_dir = File.expand_path(ENV['REPL_HISTORY_DIR'] || "~/"))
+          history_file = "#{history_dir}/.adb_history"
+        end
+
+        rlargs = "-c" # complete file names
+        rlargs << " --break-chars=" # we don't want to break any of the commands
+        rlargs << " -f #{completion_file}" if completion_file
+        rlargs << " -H #{history_file}" if history_file
+
+        exec "rlwrap #{rlargs} #$0 #{ARGV.join(' ')}"
+      end
+    end
+
+    # best effort function to detect the manifest path.
+    # checks for well known locations and falls back to a recursive search with
+    # a maximum depth of 2 directory levels
+    def detect_android_manifest_path
+      manifest_file = 'AndroidManifest.xml'
+      known_locations = %W(./#{manifest_file} ./src/main/#{manifest_file})
+      known_locations.find {|loc| File.exist?(loc)} || begin
+        Find.find('.') do |path|
+          Find.prune if path.start_with?('./.') || path.split('/').size > 3
+          return path if path.include?(manifest_file)
+        end
+      end
+    end
+
+    def get_package_from_manifest(manifest_path)
+      manifest = REXML::Document.new(File.new(manifest_path))
+      manifest.root.attributes['package']
+    end  
+  end
+end

data/lib/replicant/styles.rb

@@ -0,0 +1,30 @@
+module Styles
+
+  STYLES = {
+    # foreground text
+    :white_fg => 37,
+    :black_fg => 30,
+    :green_fg => 32,
+
+    # background
+    :white_bg => 47,
+
+    # text styles
+    :bold => 1
+  }
+
+  def span(text, *styles)
+    styled = "\e[#{STYLES.values_at(*styles).join(';')}m#{text}"
+    styled << yield if block_given?
+    styled
+  end
+
+  def styled(*styles)
+    "\e[#{STYLES.values_at(*styles).join(';')}m"
+  end
+
+  def unstyled
+    "\e[0m"
+  end
+
+end

data/lib/replicant/version.rb

@@ -0,0 +1,3 @@
+module Replicant
+  VERSION = "0.0.1"
+end

data/test/commands/adb_command_spec.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+class AdbCommandSpec < CommandSpecBase
+
+  describe "a basic adb command" do
+    before do
+      @command = silent AdbCommand.new(@repl, "devices")
+      @command.execute
+    end
+
+    it "sends a command to adb and captures the output" do
+      @command.backtick_capture.must_equal "adb devices"
+    end
+
+    it "does not use Kernel#system" do
+      @command.system_capture.must_be_nil
+    end
+  end
+
+  describe "an interactive command" do
+    before do
+      @command = AdbCommand.new(@repl, "shell")
+      @command.execute
+    end
+
+    it "is executed using a Kernel#system call" do
+      @command.system_capture.must_equal "adb shell"
+    end
+
+    describe "when it's 'shell'" do
+      it "is not treated as interactive when arguments are present" do
+        command = AdbCommand.new(@repl, "shell ps")
+        command.execute
+        command.system_capture.must_be_nil
+        command.backtick_capture.must_equal "adb shell ps"
+      end
+    end
+  end
+
+  describe "with a default package set" do
+    before do
+      @repl.stubs(:default_package).returns("com.myapp")
+    end
+
+    it "does not set the default package if command is not package dependent" do
+      command = silent AdbCommand.new(@repl, "devices")
+      command.execute
+      command.backtick_capture.must_equal "adb devices"
+    end
+
+    it "adds the default package if command is package dependent" do
+      command = silent AdbCommand.new(@repl, "uninstall")
+      command.execute
+      command.backtick_capture.must_equal "adb uninstall com.myapp"
+    end
+  end
+
+end

data/test/commands/command_spec.rb

@@ -0,0 +1,90 @@
+require 'helper'
+
+class CommandSpec < CommandSpecBase
+
+  describe "command loading" do
+    it "loads the EnvCommand when command is '?'" do
+      command = Command.load(@repl, "?")
+      command.must_be_instance_of EnvCommand
+    end
+
+    it "loads the ListCommand when command is '!'" do
+      command = Command.load(@repl, "!")
+      command.must_be_instance_of ListCommand
+    end
+
+    it "returns nil if !-command cannot be resolved" do
+      Command.load(@repl, "!unknown").must_be_nil
+    end
+
+    it "loads the AdbCommand for commands not starting in '!'" do
+      command = Command.load(@repl, "shell ps")
+      command.must_be_instance_of AdbCommand
+    end
+
+    describe "arguments" do
+      it "injects the arguments for loaded command objects" do
+        command = Command.load(@repl, "shell ps")
+        command.args.must_equal "shell ps"
+      end
+    end
+  end
+
+  describe "command listing" do
+    it "does not include the ListCommand" do
+      Command.all.map{|c|c.class}.wont_include(ListCommand)
+    end
+
+    it "does not include the AdbCommand" do
+      Command.all.map{|c|c.class}.wont_include(AdbCommand)
+    end
+
+    it "does not include the EnvCommand" do
+      Command.all.map{|c|c.class}.wont_include(EnvCommand)
+    end
+  end
+
+  describe "the command interface" do
+    before do
+      class ::TestCommand < Command; end
+      @command = silent TestCommand.new(@repl)
+    end
+
+    it "allows resolving the command name via type inspection" do
+      @command.name.must_equal "!test"
+    end
+
+    it "triggers the run method when calling 'execute'" do
+      @command.expects(:run).once
+      @command.execute
+    end
+
+    it "does not trigger the run method when arguments are invalid" do
+      @command.expects(:valid_args?).returns(false)
+      @command.expects(:run).never
+      @command.execute
+    end
+  end
+
+  describe "command options" do
+    before do
+      class ::TestCommand < Command
+        def run
+          output "this is a test"
+        end
+      end
+    end
+
+    it "can silence console output" do
+      command = TestCommand.new(@repl, nil, :silent => true)
+      lambda { command.execute }.must_be_silent
+    end
+  end
+
+  describe "arguments" do
+    it "strips argument whitespace when creating command instance" do
+      command = TestCommand.new(@repl, " ")
+      command.args.must_equal ""
+    end
+  end
+end

data/test/commands/command_spec_base.rb

@@ -0,0 +1,30 @@
+class Command
+  attr_reader :backtick_capture
+  attr_reader :system_capture
+  # capture system calls on all commands
+  def `(cmd)
+    @backtick_capture = cmd
+    nil
+  end
+  def system(cmd)
+    @system_capture = cmd
+    nil
+  end
+end
+
+class CommandSpecBase < MiniTest::Spec
+
+  before do
+    @repl = Replicant::REPL.new
+  end
+
+  def silent(command)
+    def command.output(s)
+      @output = s
+    end
+    def command.output_capture
+      @output
+    end
+    command
+  end
+end

data/test/commands/device_command_spec.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+class DeviceCommandSpec < CommandSpecBase
+
+  describe "given a valid list of devices" do
+    before do
+      @device0 = Device.new("emulator-5554", "Emulator 1")
+      @device1 = Device.new("emulator-5556", "Emulator 2")
+      DevicesCommand.any_instance.stubs(:execute).returns([@device0, @device1])
+    end
+
+    it "can select a device by index" do
+      silent(DeviceCommand.new(@repl, "0")).execute
+      @repl.default_device.must_equal @device0
+      silent(DeviceCommand.new(@repl, "1")).execute
+      @repl.default_device.must_equal @device1
+    end
+
+    it "can select a device by device id" do
+      silent(DeviceCommand.new(@repl, "emulator-5554")).execute
+      @repl.default_device.must_equal @device0
+      silent(DeviceCommand.new(@repl, "emulator-5556")).execute
+      @repl.default_device.must_equal @device1
+    end
+
+    it "outputs an error message if selected device doesn't exist" do
+      command = DeviceCommand.new(@repl, "emulator-bogus")
+      lambda { command.execute }.must_output "No such device\n"
+    end
+  end
+
+  describe "given an empty list of devices" do
+    it "outputs an error message when selecting a device" do
+      DevicesCommand.any_instance.stubs(:execute).returns([])
+      command = DeviceCommand.new(@repl, "emulator-5554")
+      lambda { command.execute }.must_output "No such device\n"
+    end
+  end
+
+end

data/test/commands/devices_command_spec.rb

@@ -0,0 +1,65 @@
+require 'helper'
+
+ADB_NO_DEVICES = <<-OUTPUT
+* daemon not running. starting it now on port 5037 *
+* daemon started successfully *
+List of devices attached
+
+OUTPUT
+
+ADB_DEVICES = <<-OUTPUT
+* daemon not running. starting it now on port 5037 *
+* daemon started successfully *
+List of devices attached
+192.168.56.101:5555    device product:vbox86p model:Nexus_4___4_3___API_18___768x1280 device:vbox86p
+005de387d71505d6       device usb:1D110000 product:occam model:Nexus_4 device:mako
+emulator-5554          device
+
+OUTPUT
+
+REPLICANT_DEVICES = <<-OUTPUT
+
+[0] Genymotion Nexus 4 API 18 768x1280 | 192.168.56.101:5555
+[1] Nexus 4                            | 005de387d71505d6
+[2] Android emulator                   | emulator-5554
+
+OUTPUT
+
+class DevicesCommandSpec < CommandSpecBase
+
+  describe "when no devices were found" do
+    before do
+      AdbCommand.any_instance.expects(:execute).returns(ADB_NO_DEVICES)
+    end
+
+    it "returns an empty device list" do
+      command = silent DevicesCommand.new(@repl)
+      command.execute.must_equal []
+    end
+
+    it "prints a message and exits" do
+      command = DevicesCommand.new(@repl)
+      lambda { command.execute }.must_output("\nNo devices found\n\n")
+    end
+  end
+
+  describe "when devices were found" do
+    before do
+      AdbCommand.any_instance.expects(:execute).returns(ADB_DEVICES)
+    end
+
+    it "returns the list of devices" do
+      command = silent DevicesCommand.new(@repl)
+      devices = command.execute
+      devices.map { |d| d.id }.must_equal [
+        "192.168.56.101:5555", "005de387d71505d6", "emulator-5554"
+      ]
+    end
+
+    it "outputs a prettified, indexed list of devices" do
+      command = DevicesCommand.new(@repl)
+      lambda { command.execute }.must_output(REPLICANT_DEVICES)
+    end
+  end
+
+end

data/test/commands/env_command_spec.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+class EnvCommandSpec < CommandSpecBase
+
+  BLANK_ENV_OUTPUT = <<-OUT
+Package: Not set
+Device: Not set
+  OUT
+
+  ACTIVE_ENV_OUTPUT = <<-OUT
+Package: com.myapp
+Device: Emulator 1 (emulator-5554)
+  OUT
+
+  describe "with no device and no package fixed" do
+    it "lists no devices and packages as selected" do
+      command = EnvCommand.new(@repl)
+      lambda { command.execute }.must_output(BLANK_ENV_OUTPUT)
+    end
+  end
+
+  describe "with a device and package fixed" do
+    it "lists no devices and packages as selected" do
+      @repl.default_device = Device.new("emulator-5554", "Emulator 1")
+      @repl.default_package = 'com.myapp'
+      command = EnvCommand.new(@repl)
+      lambda { command.execute }.must_output(ACTIVE_ENV_OUTPUT)
+    end
+  end
+end

data/test/commands/list_command_spec.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class ListCommandSpec < CommandSpecBase
+
+  describe "listing commands" do
+    it "prints a list of available commands" do
+      command = silent ListCommand.new(@repl)
+      command.execute
+      command.output_capture.must_match /^!\w+/
+    end
+  end
+
+end

data/test/commands/package_command_spec.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+class PackageCommandSpec < CommandSpecBase
+
+  describe "with valid arguments" do
+    it "accepts a package with one element" do
+      command = silent PackageCommand.new(@repl, "myapp")
+      command.execute
+      @repl.default_package.must_equal "myapp"
+    end
+
+    it "accepts a package with two elements" do
+      command = silent PackageCommand.new(@repl, "com.myapp")
+      command.execute
+      @repl.default_package.must_equal "com.myapp"
+    end
+  end
+
+  describe "with invalid arguments" do
+    it "refuses a package not starting with alphanumeric characters" do
+      command = silent PackageCommand.new(@repl, "%myapp")
+      command.expects(:run).never
+      command.execute
+      @repl.default_package.must_be_nil
+    end
+
+    it "refuses a package containing non-alphanumeric characters" do
+      command = silent PackageCommand.new(@repl, "myapp.some$thing")
+      command.expects(:run).never
+      command.execute
+      @repl.default_package.must_be_nil
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,16 @@
+begin
+  Bundler.require(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+# additional test modules
+require 'minitest/pride'
+require 'commands/command_spec_base'
+
+# application module
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'replicant'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: replicant-adb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthias Kaeppler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport-core-ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: replicant is an interactive shell (a REPL) for ADB, the Android Debug
+  Bridge
+email: m.kaeppler@gmail.com
+executables:
+- replicant
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/replicant
+- lib/replicant.rb
+- lib/replicant/command.rb
+- lib/replicant/device.rb
+- lib/replicant/repl.rb
+- lib/replicant/styles.rb
+- lib/replicant/version.rb
+- test/commands/adb_command_spec.rb
+- test/commands/command_spec.rb
+- test/commands/command_spec_base.rb
+- test/commands/device_command_spec.rb
+- test/commands/devices_command_spec.rb
+- test/commands/env_command_spec.rb
+- test/commands/list_command_spec.rb
+- test/commands/package_command_spec.rb
+- test/helper.rb
+homepage: https://github.com/mttkay/replicant
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4199582713992118202
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A REPL for the Android Debug Bridge
+test_files: []