droxi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5303c28f4ee1e364769a554be98314b4c3c953
-  data.tar.gz: 5170d5affcbf11282c0a2c8e305c0c553ca961b6
+  metadata.gz: dd71a917fd5c4fd91e3193c2805df9759505ac95
+  data.tar.gz: b5a4517dbc2ff604120b559919bc2750616acbfb
 SHA512:
-  metadata.gz: 335e2e4caa00193fb73a0f912ac819ba23b677ba42bb0185de8a143fc7fdb98bf9c5d51724df7ef7da4bd238b231e052f13b686ea17c52f0da4960a947aef294
-  data.tar.gz: ea91d29b4b67e3384f3605bb884f4ea07edb828bf6fac7e3c084d6e7320af748c9af878f378330dfd5b81cec1a92c4bd0f0a8f07113be46a61f65f6f4751d040
+  metadata.gz: b547ebc0138aa9e79bcfd97b47a6809d2b63af71493b45e8cca19136b063f2f8fcf91c45216cdbdb617e7e05c1dbffb68d0bc33409ec6efae73ae5c91c21d658
+  data.tar.gz: 43011ae5570b2eafcfbe7124a56f0422fe84136b6937e8a72d782e96887b952433f7f2ba1519912bc2c501e15e4e934f09dbbe0c0698dceffa4c0699cf875c77

data/Rakefile

@@ -18,10 +18,13 @@ task :gem do
   sh 'gem install ./droxi-*.gem'
 end
 
+desc 'create rdoc documentation'
+task :doc do
+  sh 'rdoc `find lib -name *.rb`'
+end
+
 desc 'install man page (must have root permissions)'
 task :man do
-  gemspec = IO.read('droxi.gemspec')
-
   def date(gemspec)
     require 'time'
     Time.parse(/\d{4}-\d{2}-\d{2}/.match(gemspec)[0]).strftime('%B %Y')
@@ -35,22 +38,31 @@ task :man do
     end.join.strip
   end
 
-  contents = IO.read('droxi.1.template').
-    sub('{date}', date(gemspec)).
-    sub('{version}', /\d+\.\d+\.\d+/.match(gemspec)[0]).
-    sub('{commands}', commands)
+  def build_page
+    gemspec = IO.read('droxi.gemspec')
 
-  Dir.mkdir('build') unless Dir.exists?('build')
-  IO.write('build/droxi.1', contents)
+    contents = IO.read('droxi.1.template').
+      sub('{date}', date(gemspec)).
+      sub('{version}', /\d+\.\d+\.\d+/.match(gemspec)[0]).
+      sub('{commands}', commands)
 
-  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
-  install_path = "#{prefix}/share/man/man1"
+    Dir.mkdir('build') unless Dir.exists?('build')
+    IO.write('build/droxi.1', contents)
+  end
+
+  def install_page
+    prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+    install_path = "#{prefix}/share/man/man1"
 
-  require 'fileutils'
-  begin
-    FileUtils.mkdir_p(install_path)
-    FileUtils.cp('build/droxi.1', install_path)
-  rescue
-    puts 'Failed to install man page. This target must be run as root.'
+    require 'fileutils'
+    begin
+      FileUtils.mkdir_p(install_path)
+      FileUtils.cp('build/droxi.1', install_path)
+    rescue
+      puts 'Failed to install man page. This target must be run as root.'
+    end
   end
+
+  build_page
+  install_page
 end

data/bin/droxi

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'droxi'
-Droxi.run
+Droxi.run(*ARGV)

data/droxi.1.template

@@ -2,7 +2,12 @@
 .SH NAME
 droxi \- ftp-like command-line interface to Dropbox
 .SH SYNOPSIS
-droxi
+droxi [COMMAND] [ARGUMENT]...
+.SH DESCRIPTION
+A command-line Dropbox interface inspired by GNU coreutils, GNU ftp, and lftp.
+Features include smart tab completion, globbing, and interactive help. If
+invoked without arguments, runs in interactive mode. If invoked with arguments,
+parses the arguments as a command invocation, executes the command, and exits.
 .SH COMMANDS
 {commands}
 .SH AUTHOR

data/droxi.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'droxi'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2014-06-02'
   s.summary     = 'ftp-like command-line interface to Dropbox'
-  s.description = "a command-line Dropbox interface inspired by GNU \
-                   coreutils, GNU ftp, and lftp. features smart tab \
+  s.description = "A command-line Dropbox interface inspired by GNU \
+                   coreutils, GNU ftp, and lftp. Features include smart tab \
                    completion, globbing, and interactive help.".squeeze(' ')
   s.authors     = ['Brandon Mulcahy']
   s.email       = 'brandon@jangler.info'

data/lib/droxi/commands.rb

@@ -1,18 +1,38 @@
-require 'readline'
+require_relative 'text'
 
+# Module containing definitions for client commands.
 module Commands
+
+  # Exception indicating that a client command was given the wrong number of
+  # arguments.
   class UsageError < ArgumentError
   end
 
+  # A client command. Contains metadata as well as execution procedure.
   class Command
-    attr_reader :usage, :description
 
+    # A +String+ specifying the usage of the command in the style of a man page
+    # synopsis. Optional arguments are enclosed in brackets; varargs-style
+    # arguments are suffixed with an ellipsis.
+    attr_reader :usage
+
+    # A complete description of the command, suitable for display to the end
+    # user.
+    attr_reader :description
+
+    # Create a new +Command+ with the given metadata and a +Proc+ specifying
+    # its behavior. The +Proc+ will receive four arguments: the
+    # +DropboxClient+, the +State+, an +Array+ of command-line arguments, and
+    # a +Proc+ to be called for output.
     def initialize(usage, description, procedure)
       @usage = usage
       @description = description.squeeze(' ')
       @procedure = procedure
     end
 
+    # Attempt to execute the +Command+, yielding lines of output if a block is
+    # given. Raises a +UsageError+ if an invalid number of command-line
+    # arguments is given.
     def exec(client, state, *args)
       if num_args_ok?(args.length)
         block = proc { |line| yield line if block_given? }
@@ -22,6 +42,21 @@ module Commands
       end
     end
 
+    # Return a +String+ describing the type of argument at the given index.
+    # If the index is out of range, return the type of the final argument. If
+    # the +Command+ takes no arguments, return +nil+.
+    def type_of_arg(index)
+      args = @usage.split.drop(1)
+      if args.empty?
+        nil
+      else
+        index = [index, args.length - 1].min
+        args[index].tr('[].', '')
+      end
+    end
+
+    private
+
     def num_args_ok?(num_args)
       args = @usage.split.drop(1)
       min_args = args.reject { |arg| arg.start_with?('[') }.length
@@ -34,14 +69,9 @@ module Commands
       end
       (min_args..max_args).include?(num_args)
     end
-
-    def type_of_arg(index)
-      args = @usage.split.drop(1)
-      index = [index, args.length - 1].min
-      args[index].tr('[].', '')
-    end
   end
 
+  # Change the remote working directory.
   CD = Command.new(
     'cd [REMOTE_DIR]',
     "Change the remote working directory. With no arguments, changes to the \
@@ -55,7 +85,7 @@ module Commands
         state.pwd = state.oldpwd
       else
         path = state.resolve_path(args[0])
-        if state.is_dir?(client, path)
+        if state.directory?(path)
           state.pwd = path
         else
           output.call('Not a directory')
@@ -64,6 +94,7 @@ module Commands
     end
   )
 
+  # Terminate the session.
   EXIT = Command.new(
     'exit',
     "Exit the program.",
@@ -72,17 +103,19 @@ module Commands
     end
   )
 
+  # Download remote files.
   GET = Command.new(
     'get REMOTE_FILE...',
     "Download each specified remote file to a file of the same name in the \
      local working directory.",
     lambda do |client, state, args, output|
-      state.expand_patterns(client, args).each do |path|
+      state.expand_patterns(args).each do |path|
         begin
           contents = client.get_file(path)
           File.open(File.basename(path), 'wb') do |file|
             file.write(contents)
           end
+          output.call("#{File.basename(path)} <- #{path}")
         rescue DropboxError => error
           output.call(error.to_s)
         end
@@ -90,19 +123,20 @@ module Commands
     end
   )
 
+  # List commands, or print information about a specific command.
   HELP = Command.new(
     'help [COMMAND]',
     "Print usage and help information about a command. If no command is \
      given, print a list of commands instead.",
     lambda do |client, state, args, output|
       if args.empty?
-        table_output(NAMES).each { |line| output.call(line) }
+        Text.table(NAMES).each { |line| output.call(line) }
       else
         cmd_name = args[0]
         if NAMES.include?(cmd_name)
           cmd = const_get(cmd_name.upcase.to_s)
           output.call(cmd.usage)
-          wrap_output(cmd.description).each { |line| output.call(line) }
+          Text.wrap(cmd.description).each { |line| output.call(line) }
         else
           output.call("Unrecognized command: #{cmd_name}")
         end
@@ -110,6 +144,7 @@ module Commands
     end
   )
 
+  # Change the local working directory.
   LCD = Command.new(
     'lcd [LOCAL_DIR]',
     "Change the local working directory. With no arguments, changes to the \
@@ -134,6 +169,7 @@ module Commands
     end
   )
 
+  # List remote files.
   LS = Command.new(
     'ls [REMOTE_FILE]...',
     "List information about remote files. With no arguments, list the \
@@ -147,7 +183,7 @@ module Commands
         args.map do |path|
           path = state.resolve_path(path)
           begin
-            if state.is_dir?(client, path)
+            if state.directory?(path)
               "#{path}/*".sub('//', '/')
             else
               path
@@ -162,17 +198,35 @@ module Commands
       patterns.each do |pattern|
         begin
           dir = File.dirname(pattern)
-          state.contents(client, dir).each do |path|
+          state.contents(dir).each do |path|
             items << File.basename(path) if File.fnmatch(pattern, path)
           end
         rescue DropboxError => error
           output.call(error.to_s)
         end
       end
-      table_output(items).each { |item| output.call(item) }
+      Text.table(items).each { |item| output.call(item) }
     end
   )
 
+  # Get temporary links to remote files.
+  MEDIA = Command.new(
+    'media REMOTE_FILE...',
+    "Create Dropbox links to publicly share remote files. The links are \
+     time-limited and link directly to the files themselves.",
+    lambda do |client, state, args, output|
+      state.expand_patterns(args).each do |path|
+        begin
+          url = client.media(path)['url']
+          output.call("#{File.basename(path)} -> #{url}")
+        rescue DropboxError => error
+          output.call(error.to_s)
+        end
+      end
+    end
+  )
+
+  # Create a remote directory.
   MKDIR = Command.new(
     'mkdir REMOTE_DIR...',
     "Create remote directories.",
@@ -188,6 +242,7 @@ module Commands
     end
   )
 
+  # Upload a local file.
   PUT = Command.new(
     'put LOCAL_FILE [REMOTE_FILE]',
     "Upload a local file to a remote path. If a remote file of the same name \
@@ -205,7 +260,9 @@ module Commands
 
       begin
         File.open(File.expand_path(from_path), 'rb') do |file|
-          state.cache[to_path] = client.put_file(to_path, file)
+          data = client.put_file(to_path, file)
+          state.cache[data['path']] = data
+          output.call("#{from_path} -> #{data['path']}")
         end
       rescue Exception => error
         output.call(error.to_s)
@@ -213,11 +270,12 @@ module Commands
     end
   )
 
+  # Remove remote files.
   RM = Command.new(
     'rm REMOTE_FILE...',
     "Remove each specified remote file or directory.",
     lambda do |client, state, args, output|
-      state.expand_patterns(client, args).each do |path|
+      state.expand_patterns(args).each do |path|
         begin
           client.file_delete(path)
           state.cache.delete(path)
@@ -228,6 +286,7 @@ module Commands
     end
   )
 
+  # Get permanent links to remote files.
   SHARE = Command.new(
     'share REMOTE_FILE...',
     "Create Dropbox links to publicly share remote files. The links are \
@@ -235,9 +294,10 @@ module Commands
      this method are set to expire far enough in the future so that \
      expiration is effectively not an issue.",
     lambda do |client, state, args, output|
-      state.expand_patterns(client, args).each do |path|
+      state.expand_patterns(args).each do |path|
         begin
-          output.call("#{path}: #{client.shares(path)['url']}")
+          url = client.shares(path)['url']
+          output.call("#{File.basename(path)} -> #{url}")
         rescue DropboxError => error
           output.call(error.to_s)
         end
@@ -245,10 +305,12 @@ module Commands
     end
   )
 
+  # +Array+ of all command names.
   NAMES = constants.select do |sym|
      const_get(sym).is_a?(Command)
   end.map { |sym| sym.to_s.downcase }
 
+  # Parse and execute a line of user input in the given context.
   def self.exec(input, client, state)
     if input.start_with?('!')
       shell(input[1, input.length - 1]) { |line| puts line }
@@ -283,14 +345,6 @@ module Commands
 
   private
 
-  def self.get_screen_size
-    begin
-      Readline.get_screen_size[1]
-    rescue NotImplementedError
-      72
-    end
-  end
-
   def self.shell(cmd)
     begin
       IO.popen(cmd) do |pipe|
@@ -302,39 +356,4 @@ module Commands
     end
   end
 
-  def self.table_output(items)
-    return [] if items.empty?
-    columns = get_screen_size
-    item_width = items.map { |item| item.length }.max + 2
-    column = 0
-    lines = ['']
-    items.each do |item|
-      if column != 0 && column + item_width >= columns
-        lines << ''
-        column = 0
-      end
-      lines.last << item.ljust(item_width)
-      column += item_width
-    end
-    lines
-  end
-
-  def self.wrap_output(text)
-    columns = get_screen_size
-    column = 0
-    lines = ['']
-    text.split.each do |word|
-      if column != 0 && column + word.length >= columns
-        lines << ''
-        column = 0
-      end
-      if column != 0
-        lines.last << ' '
-        column += 1
-      end
-      lines.last << word
-      column += word.length
-    end
-    lines
-  end
 end

data/lib/droxi/complete.rb

@@ -0,0 +1,82 @@
+# Module containing tab-completion logic and methods.
+module Complete
+
+  # Return the directory in which to search for potential local tab-completions
+  # for a +String+. Defaults to working directory in case of bogus input.
+  def self.local_search_path(string)
+    begin
+      File.expand_path(strip_filename(string))
+    rescue
+      Dir.pwd
+    end
+  end
+
+  # Returns an +Array+ of potential local tab-completions for a +String+.
+  def self.local(string)
+    dir = local_search_path(string)
+    name = string.end_with?('/') ? '' : File.basename(string)
+
+    Dir.entries(dir).select do |entry|
+      entry.start_with?(name) && !/^\.{1,2}$/.match(entry)
+    end.map do |entry|
+      entry << (File.directory?(dir + '/' + entry) ? '/' : ' ')
+      string + entry[name.length, entry.length]
+    end
+  end
+
+  # Returns an +Array+ of potential local tab-completions for a +String+,
+  # including only directories.
+  def self.local_dir(string)
+    local(string).select { |result| result.end_with?('/') }
+  end
+
+  # Return the directory in which to search for potential remote
+  # tab-completions for a +String+.
+  def self.remote_search_path(string, state)
+    path = case
+    when string.empty? then state.pwd + '/'
+    when string.start_with?('/') then string
+    else state.pwd + '/' + string
+    end
+
+    strip_filename(collapse(path))
+  end
+
+  # Returns an +Array+ of potential remote tab-completions for a +String+.
+  def self.remote(string, state)
+    dir = remote_search_path(string, state)
+    name = string.end_with?('/') ? '' : File.basename(string)
+
+    state.contents(dir).map do |entry|
+      File.basename(entry) 
+    end.select do |entry|
+      entry.start_with?(name) && !/^\.{1,2}$/.match(entry)
+    end.map do |entry|
+      entry << (state.directory?(dir + '/' + entry) ? '/' : ' ')
+      string + entry[name.length, entry.length]
+    end
+  end
+
+  # Returns an +Array+ of potential remote tab-completions for a +String+,
+  # including only directories.
+  def self.remote_dir(string, state)
+    remote(string, state).select { |result| result.end_with?('/') }
+  end
+
+  private
+
+  def self.strip_filename(path)
+    if path != '/'
+      path.end_with?('/') ? path.sub(/\/$/, '') : File.dirname(path)
+    else
+      path
+    end
+  end
+
+  def self.collapse(path)
+    nil while path.sub!(/[^\/]+\/\.\.\//, '/')
+    nil while path.sub!('./', '')
+    path
+  end
+
+end

data/lib/droxi/settings.rb

@@ -1,12 +1,15 @@
-require 'fileutils'
+# Manages persistent (session-independent) application state.
+class Settings
 
-CONFIG_FILE_PATH = File.expand_path('~/.config/droxi/droxirc')
+  # The path of the application's rc file.
+  CONFIG_FILE_PATH = File.expand_path('~/.config/droxi/droxirc')
 
-class Settings
+  # Return the value of a setting, or +nil+ if the setting does not exist.
   def Settings.[](key)
     @@settings[key]
   end
 
+  # Set the value of a setting.
   def Settings.[]=(key, value)
     if value != @@settings[key]
       @@dirty = true
@@ -14,10 +17,12 @@ class Settings
     end
   end
 
+  # Return +true+ if the setting exists, +false+ otherwise.
   def Settings.include?(key)
     @@settings.include?(key)
   end
 
+  # Delete the setting and return its value.
   def Settings.delete(key)
     if @@settings.include?(key)
       @@dirty = true
@@ -25,14 +30,17 @@ class Settings
     end
   end
 
-  def Settings.write
+  # Write settings to disk.
+  def Settings.save
     if @@dirty
       @@dirty = false
+      require 'fileutils'
       FileUtils.mkdir_p(File.dirname(CONFIG_FILE_PATH))
       File.open(CONFIG_FILE_PATH, 'w') do |file|
         @@settings.each_pair { |k, v| file.write("#{k}=#{v}\n") }
       end
     end
+    nil
   end
 
   private
@@ -67,4 +75,5 @@ class Settings
 
   @@settings = read
   @@dirty = false
+
 end

data/lib/droxi/state.rb

@@ -1,32 +1,46 @@
 require_relative 'settings'
 
+# Encapsulates the session state of the client.
 class State
-  attr_reader :oldpwd, :pwd, :cache
-  attr_accessor :local_oldpwd, :exit_requested
 
-  def initialize
+  # +Hash+ of remote file paths to cached file metadata.
+  attr_reader :cache
+
+  # The remote working directory path.
+  attr_reader :pwd
+
+  # The previous remote working directory path.
+  attr_reader :oldpwd
+
+  # The previous local working directory path.
+  attr_accessor :local_oldpwd
+  
+  # +true+ if the client has requested to quit, +false+ otherwise.
+  attr_accessor :exit_requested
+
+  # Return a new application state that uses the given client. Starts at the
+  # Dropbox root and with an empty cache.
+  def initialize(client)
+    @cache = {}
+    @client = client
+    @exit_requested = false
     @pwd = '/'
     @oldpwd = Settings[:oldpwd] || '/'
     @local_oldpwd = Dir.pwd
-    @cache = {}
-    @exit_requested = false
   end
 
-  def have_all_info_for(path)
-    @cache.include?(path) &&
-    (@cache[path].include?('contents') || !@cache[path]['is_dir'])
-  end
-
-  def metadata(client, path)
+  # Return a +Hash+ of the Dropbox metadata for a file, or +nil+ if the file
+  # does not exist.
+  def metadata(path)
     tokens = path.split('/').drop(1)
 
     for i in 0..tokens.length
       partial_path = '/' + tokens.take(i).join('/')
       unless have_all_info_for(partial_path)
         begin
-          data = @cache[partial_path] = client.metadata(partial_path)
+          data = @cache[partial_path] = @client.metadata(partial_path)
         rescue DropboxError
-          return
+          return nil
         end
         if data.include?('contents')
           data['contents'].each do |datum|  
@@ -39,24 +53,30 @@ class State
     @cache[path]
   end
 
-  def contents(client, path)
-    metadata(client, path)
+  # Return an +Array+ of paths of files in a Dropbox directory.
+  def contents(path)
+    metadata(path)
     path = "#{path}/".sub('//', '/')
     @cache.keys.select do |key|
       key.start_with?(path) && key != path && !key.sub(path, '').include?('/')
     end
   end
 
-  def is_dir?(client, path)
-    metadata(client, File.dirname(path))
+  # Return +true+ if the Dropbox path is a directory, +false+ otherwise.
+  def directory?(path)
+    path = path.sub('//', '/')
+    metadata(File.dirname(path))
     @cache.include?(path) && @cache[path]['is_dir']
   end
 
+  # Set the remote working directory, and set the previous remote working
+  # directory to the old value.
   def pwd=(value)
     @oldpwd, @pwd = @pwd, value
     Settings[:oldpwd] = @oldpwd
   end
 
+  # Expand a Dropbox file path and return the result.
   def resolve_path(path)
     path = "#{@pwd}/#{path}" unless path.start_with?('/')
     path.gsub!('//', '/')
@@ -67,12 +87,14 @@ class State
     path
   end
 
-  def expand_patterns(client, patterns)
+  # Expand an +Array+ of file globs into an an +Array+ of Dropbox file paths
+  # and return the result.
+  def expand_patterns(patterns)
     patterns.map do |pattern|
       final_pattern = resolve_path(pattern)
 
       matches = []
-      client.metadata(File.dirname(final_pattern))['contents'].each do |data|
+      @client.metadata(File.dirname(final_pattern))['contents'].each do |data|
         path = data['path']
         matches << path if File.fnmatch(final_pattern, path)
       end
@@ -85,43 +107,11 @@ class State
     end.flatten
   end
 
-  def file_complete(client, word)
-    tab_complete(client, word, false)
-  end
-
-  def dir_complete(client, word)
-    tab_complete(client, word, true)
-  end
-
   private
 
-  def complete(path, prefix_length, dir_only)
-    @cache.keys.select do |key|
-      key.start_with?(path) && key != path &&
-      !(dir_only && !@cache[key]['is_dir'])
-    end.map do |key|
-      if @cache[key]['is_dir']
-        key += '/' 
-      else
-        key += ' '
-      end
-      key[prefix_length, key.length]
-    end
+  def have_all_info_for(path)
+    @cache.include?(path) &&
+    (@cache[path].include?('contents') || !@cache[path]['is_dir'])
   end
 
-  def tab_complete(client, word, dir_only)
-    path = resolve_path(word)
-    prefix_length = path.length - word.length
-
-    if word.end_with?('/')
-      # Treat word as directory
-      metadata(client, path)
-      prefix_length += 1
-    else
-      # Treat word as file
-      metadata(client, File.dirname(path))
-    end
-
-    complete(path, prefix_length, dir_only)
-  end
 end

data/lib/droxi/text.rb

@@ -0,0 +1,67 @@
+# Module containing text-manipulation methods.
+module Text
+
+  # The assumed width of the terminal if GNU Readline can't retrieve it.
+  DEFAULT_WIDTH = 72
+  
+  # Format an +Array+ of +Strings+ as a table and return an +Array+ of lines
+  # in the result.
+  def self.table(items)
+    if items.empty?
+      []
+    else
+      columns = get_columns
+      item_width = items.map { |item| item.length }.max + 2
+      items_per_line = [1, columns / item_width].max
+      num_lines = (items.length.to_f / items_per_line).ceil
+      format_table(items, item_width, items_per_line, num_lines)
+    end
+  end
+
+  # Wrap a +String+ to fit the terminal and return an +Array+ of lines in the
+  # result.
+  def self.wrap(text)
+    columns = get_columns
+    position = 0
+    lines = []
+    while position < text.length
+      lines << get_wrap_segment(text[position, text.length], columns)
+      position += lines.last.length + 1
+    end
+    lines
+  end
+
+  private
+
+  def self.get_columns
+    require 'readline'
+    begin
+      columns = Readline.get_screen_size[1]
+      columns > 0 ? columns : DEFAULT_WIDTH
+    rescue NotImplementedError
+      DEFAULT_WIDTH
+    end
+  end
+
+  def self.format_table(items, item_width, items_per_line, num_lines)
+    num_lines.times.map do |i|
+      items[i * items_per_line, items_per_line].map do |item|
+        item.ljust(item_width)
+      end.join
+    end
+  end
+
+  def self.get_wrap_segment(text, columns)
+    segment, sep, text = text.partition(' ')
+    while !text.empty? && segment.length < columns
+      head, sep, text = text.partition(' ')
+      segment << " #{head}"
+    end
+    if segment.length > columns && segment.include?(' ')
+      segment.rpartition(' ')[0]
+    else
+      segment
+    end
+  end
+
+end

data/lib/droxi.rb

@@ -2,15 +2,19 @@ require 'dropbox_sdk'
 require 'readline'
 
 require_relative 'droxi/commands'
+require_relative 'droxi/complete'
 require_relative 'droxi/settings'
 require_relative 'droxi/state'
 
+# Command-line Dropbox client module.
 module Droxi
-  APP_KEY = '5sufyfrvtro9zp7'
-  APP_SECRET = 'h99ihzv86jyypho'
 
+  # Attempt to authorize the user for app usage.
   def self.authorize
-    flow = DropboxOAuth2FlowNoRedirect.new(APP_KEY, APP_SECRET)
+    app_key = '5sufyfrvtro9zp7'
+    app_secret = 'h99ihzv86jyypho'
+
+    flow = DropboxOAuth2FlowNoRedirect.new(app_key, app_secret)
 
     authorize_url = flow.start()
 
@@ -34,8 +38,12 @@ module Droxi
     rescue DropboxError
       puts 'Invalid authorization code.'
     end
+
+    nil
   end
 
+  # Get the access token for the user, requesting authorization if no token
+  # exists.
   def self.get_access_token
     until Settings.include?(:access_token)
       authorize()
@@ -43,52 +51,16 @@ module Droxi
     Settings[:access_token]
   end
 
+  # Print a prompt message reflecting the current state of the application.
   def self.prompt(info, state)
     "droxi #{info['email']}:#{state.pwd}> "
   end
 
-  def self.file_complete(word, dir_only=false)
-    begin
-      path = File.expand_path(word)
-    rescue ArgumentError
-      return []
-    end
-    if word.empty? || (word.length > 1 && word.end_with?('/'))
-      dir = path
-    else
-      dir = File.dirname(path)
-    end
-    Dir.entries(dir).map do |file|
-      (dir + '/').sub('//', '/') + file
-    end.select do |file|
-      file.start_with?(path) && !(dir_only && !File.directory?(file))
-    end.map do |file|
-      if File.directory?(file)
-        file << '/'
-      else
-        file << ' '
-      end
-      if word.start_with?('/')
-        file
-      elsif word.start_with?('~')
-        file.sub(/\/home\/[^\/]+/, '~')
-      else
-        file.sub(Dir.pwd + '/', '')
-      end
-    end
-  end
-
-  def self.dir_complete(word)
-    file_complete(word, true)
-  end
-
-  def self.run
-    client = DropboxClient.new(get_access_token)
+  # Run the client in interactive mode.
+  def self.run_interactive(client, state)
     info = client.account_info
     puts "Logged in as #{info['display_name']} (#{info['email']})"
 
-    state = State.new
-
     Readline.completion_proc = proc do |word|
       words = Readline.line_buffer.split
       index = words.length
@@ -105,24 +77,11 @@ module Droxi
         Commands::NAMES.select { |name| name.start_with? word }.map do |name|
           name + ' '
         end
-      when 'LOCAL_FILE'
-        file_complete(word)
-      when 'LOCAL_DIR'
-        dir_complete(word)
-      when 'REMOTE_FILE'
-        begin
-          state.file_complete(client, word)
-        rescue DropboxError
-          []
-        end
-      when 'REMOTE_DIR'
-        begin
-          state.dir_complete(client, word)
-        rescue DropboxError
-          []
-        end
-      else
-        []
+      when 'LOCAL_FILE'  then Complete.local(word)
+      when 'LOCAL_DIR'   then Complete.local_dir(word)
+      when 'REMOTE_FILE' then Complete.remote(word, state)
+      when 'REMOTE_DIR'  then Complete.remote_dir(word, state)
+      else []
       end
 
       options.map { |option| option.gsub(' ', '\ ').sub(/\\ $/, ' ') }
@@ -143,7 +102,26 @@ module Droxi
       puts
     end
 
+    # Set pwd so that the oldpwd setting is set to pwd
     state.pwd = '/'
-    Settings.write
+    Settings.save
+  end
+
+  # Run the client.
+  def self.run(*args)
+    client = DropboxClient.new(get_access_token)
+    state = State.new(client)
+
+    if args.empty?
+      run_interactive(client, state)
+    else
+      cmd = args.map { |arg| arg.gsub(' ', '\ ') }.join(' ')
+      begin
+        Commands.exec(cmd, client, state)
+      rescue Interrupt
+        puts
+      end
+    end
   end
+
 end

data/spec/commands_spec.rb

@@ -35,7 +35,7 @@ describe Commands do
   original_dir = Dir.pwd
 
   client = DropboxClient.new(Settings[:access_token])
-  state = State.new
+  state = State.new(client)
 
   TEMP_FILENAME = 'test.txt'
   TEMP_FOLDER = 'test'
@@ -44,6 +44,10 @@ describe Commands do
   ignore(DropboxError) { client.file_delete("/#{TEST_FOLDER}") }
   ignore(DropboxError) { client.file_create_folder("/#{TEST_FOLDER}") }
 
+  before do
+    Dir.chdir(original_dir)
+  end
+
   describe 'when executing a shell command' do
     it 'must yield the output' do
       lines = []
@@ -88,7 +92,6 @@ describe Commands do
 
   describe 'when executing the get command' do
     it 'must get a file of the same name when given args' do
-      Dir.chdir(original_dir)
       put_temp_file(client, state)
       Commands::GET.exec(client, state, '/testing/test.txt')
       delete_temp_file(client, state)
@@ -99,26 +102,22 @@ describe Commands do
 
   describe 'when executing the lcd command' do
     it 'must change to home directory when given no args' do
-      Dir.chdir(original_dir)
       Commands::LCD.exec(client, state)
       Dir.pwd.must_equal File.expand_path('~')
     end
 
     it 'must change to specific directory when specified' do
-      Dir.chdir(original_dir)
       Commands::LCD.exec(client, state, '/home')
       Dir.pwd.must_equal File.expand_path('/home')
     end
 
     it 'must set oldpwd correctly' do
-      Dir.chdir(original_dir)
       oldpwd = Dir.pwd
       Commands::LCD.exec(client, state, '/')
       state.local_oldpwd.must_equal oldpwd
     end
 
     it 'must change to previous directory when given -' do
-      Dir.chdir(original_dir)
       oldpwd = Dir.pwd
       Commands::LCD.exec(client, state, '/')
       Commands::LCD.exec(client, state, '-')
@@ -126,7 +125,6 @@ describe Commands do
     end
 
     it 'must fail if given bogus directory name' do
-      Dir.chdir(original_dir)
       pwd = Dir.pwd
       oldpwd = state.local_oldpwd
       Commands::LCD.exec(client, state, '/bogus_dir')
@@ -155,6 +153,17 @@ describe Commands do
     end
   end
 
+  describe 'when executing the media command' do
+    it 'must yield URL when given file path' do
+      put_temp_file(client, state)
+      to_path = "/#{TEST_FOLDER}/#{TEMP_FILENAME}"
+      lines = get_output(:MEDIA, client, state, to_path)
+      delete_temp_file(client, state)
+      lines.length.must_equal 1
+      /https:\/\/.+\..+\//.match(lines[0]).wont_equal nil
+    end
+  end
+
   describe 'when executing the mkdir command' do
     it 'must create a directory when given args' do
       Commands::MKDIR.exec(client, state, '/testing/test')
@@ -165,7 +174,6 @@ describe Commands do
 
   describe 'when executing the put command' do
     it 'must put a file of the same name when given 1 arg' do
-      Dir.chdir(original_dir)
       state.pwd = '/testing'
       `echo hello > test.txt`
       Commands::PUT.exec(client, state, 'test.txt')
@@ -175,7 +183,6 @@ describe Commands do
     end
 
     it 'must put a file with the stated name when given 2 args' do
-      Dir.chdir(original_dir)
       state.pwd = '/testing'
       `echo hello > test.txt`
       Commands::PUT.exec(client, state, 'test.txt', 'dest.txt')

data/spec/complete_spec.rb

@@ -0,0 +1,114 @@
+require 'dropbox_sdk'
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/complete'
+require_relative '../lib/droxi/settings'
+require_relative '../lib/droxi/state'
+
+describe Complete do
+  CHARACTERS = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+
+  def random_character
+    CHARACTERS[rand(CHARACTERS.length)]
+  end
+
+  def random_string(length)
+    rand(length).times.map { random_character }.join
+  end
+
+  describe "when resolving a local search path" do
+    it "must resolve unqualified string to working directory" do
+      Complete.local_search_path('').must_equal Dir.pwd
+      Complete.local_search_path('f').must_equal Dir.pwd
+    end
+
+    it "must resolve / to root directory" do
+      Complete.local_search_path('/').must_equal '/'
+      Complete.local_search_path('/f').must_equal '/'
+    end
+
+    it "must resolve directory name to named directory" do
+      Complete.local_search_path('/home/').must_equal '/home'
+      Complete.local_search_path('/home/f').must_equal '/home'
+    end
+
+    it "must resolve ~/ to home directory" do
+      Complete.local_search_path('~/').must_equal Dir.home
+      Complete.local_search_path('~/f').must_equal Dir.home
+    end
+
+    it "must resolve ./ to working directory" do
+      Complete.local_search_path('./').must_equal Dir.pwd
+      Complete.local_search_path('./f').must_equal Dir.pwd
+    end
+
+    it "must resolve ../ to parent directory" do
+      Complete.local_search_path('../').must_equal File.dirname(Dir.pwd)
+      Complete.local_search_path('../f').must_equal File.dirname(Dir.pwd)
+    end
+
+    it "won't raise an exception on a bogus string" do
+      Complete.local_search_path('~bogus')
+    end
+  end
+
+  describe "when finding potential local tab completions" do
+    def check(path)
+      100.times.all? do |i|
+        prefix = path + random_string(5)
+        Complete.local(prefix).all? { |match| match.start_with?(prefix) }
+      end.must_equal true
+      1000.times.any? do |i|
+        prefix = path + random_string(5)
+        !Complete.local(prefix).empty?
+      end.must_equal true
+    end
+
+    it "seed must prefix results for unqualified string" do check('') end
+    it "seed must prefix results for /" do check('/') end
+    it "seed must prefix results for named directory" do check('/home/') end
+    it "seed must prefix results for ~/" do check('~/') end
+    it "seed must prefix results for ./" do check('./') end
+    it "seed must prefix results for ../" do check('../') end
+
+    it "won't raise an exception on a bogus string" do
+      Complete.local('~bogus')
+    end
+  end
+
+  describe "when resolving a remote search path" do
+    client = DropboxClient.new(Settings[:access_token])
+    begin
+      client.file_create_folder('/testing')
+    rescue DropboxError
+    end
+    state = State.new(client)
+    state.pwd = '/testing'
+
+    it "must resolve unqualified string to working directory" do
+      Complete.remote_search_path('', state).must_equal state.pwd
+      Complete.remote_search_path('f', state).must_equal state.pwd
+    end
+
+    it "must resolve / to root directory" do
+      Complete.remote_search_path('/', state).must_equal '/'
+      Complete.remote_search_path('/f', state).must_equal '/'
+    end
+
+    it "must resolve directory name to named directory" do
+      Complete.remote_search_path('/testing/', state).must_equal '/testing'
+      Complete.remote_search_path('/testing/f', state).must_equal '/testing'
+    end
+
+    it "must resolve ./ to working directory" do
+      Complete.remote_search_path('./', state).must_equal state.pwd
+      Complete.remote_search_path('./f', state).must_equal state.pwd
+    end
+
+    it "must resolve ../ to parent directory" do
+      parent = File.dirname(state.pwd)
+      Complete.remote_search_path('../', state).must_equal parent
+      Complete.remote_search_path('../f', state).must_equal parent
+    end
+  end
+end

data/spec/state_spec.rb

@@ -6,19 +6,19 @@ require_relative '../lib/droxi/settings'
 describe State do
   describe 'when initializing' do
     it 'must set pwd to root' do
-      State.new.pwd.must_equal '/'
+      State.new(nil).pwd.must_equal '/'
     end
 
     it 'must set oldpwd to saved oldpwd' do
       if Settings.include?(:oldpwd)
-        State.new.oldpwd.must_equal Settings[:oldpwd]
+        State.new(nil).oldpwd.must_equal Settings[:oldpwd]
       end
     end
   end
 
   describe 'when setting pwd' do
     it 'must change pwd and set oldpwd to previous pwd' do
-      state = State.new
+      state = State.new(nil)
       state.pwd = '/testing'
       state.pwd.must_equal '/testing'
       state.pwd = '/'
@@ -27,7 +27,7 @@ describe State do
   end
 
   describe 'when resolving path' do
-    state = State.new
+    state = State.new(nil)
 
     it 'must resolve root to itself' do
       state.resolve_path('/').must_equal '/'

data/spec/text_spec.rb

@@ -0,0 +1,60 @@
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/text'
+
+describe Text do
+  before do
+    @columns = Text::DEFAULT_WIDTH
+    @paragraph = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, \
+                  sed do eiusmod tempor incididunt ut labore et dolore \
+                  magna aliqua. Ut enim ad minim veniam, quis nostrud \
+                  exercitation ullamco laboris nisi ut aliquip ex ea \
+                  commodo consequat. Duis aute irure dolor in reprehenderit \
+                  in voluptate velit esse cillum dolore eu fugiat nulla \
+                  pariatur. Excepteur sint occaecat cupidatat non proident, \
+                  sunt in culpa qui officia deserunt mollit anim id est \
+                  laborum.".squeeze(' ')
+    @big_word = "Lopadotemachoselachogaleokranioleipsanodrimhypotrimmatosilphi\
+                 oparaomelitokatakechymenokichlepikossyphophattoperisteralektr\
+                 yonoptekephalliokigklopeleiolagoiosiraiobaphetraganopterygon".
+                   gsub(' ', '')
+  end
+
+  describe "when wrapping text" do
+    it "won't return any line larger than the screen width if unnecessary" do
+      Text.wrap(@paragraph).all? do |line|
+        line.length <= @columns
+      end.must_equal true
+    end
+
+    it "won't split a word larger than the screen width" do
+      Text.wrap(@big_word).length.must_equal 1
+    end
+  end
+
+  describe "when tabulating text" do
+    it "must space items equally" do
+      lines = Text.table(@paragraph.split)
+      lines = lines[0, lines.length - 1]
+
+      space_positions = [0]
+      while lines.first.index(/  \S/, space_positions.last + 3)
+        space_positions << lines.first.index(/  \S/, space_positions.last + 3)
+      end
+
+      space_positions.drop(1).all? do |position|
+        lines.all? { |line| /  \S/.match(line[position, 3]) }
+      end.must_equal true
+    end
+
+    it "won't return any line larger than the screen width if unnecessary" do
+      Text.table(@paragraph.split).all? do |line|
+        line.length <= @columns
+      end.must_equal true
+    end
+
+    it "won't split a word larger than the screen width" do
+      Text.table([@big_word]).length.must_equal 1
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: droxi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brandon Mulcahy
@@ -30,8 +30,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.1
-description: a command-line Dropbox interface inspired by GNU coreutils, GNU ftp,
-  and lftp. features smart tab completion, globbing, and interactive help.
+description: A command-line Dropbox interface inspired by GNU coreutils, GNU ftp,
+  and lftp. Features include smart tab completion, globbing, and interactive help.
 email: brandon@jangler.info
 executables:
 - droxi
@@ -46,12 +46,16 @@ files:
 - droxi.gemspec
 - lib/droxi.rb
 - lib/droxi/commands.rb
+- lib/droxi/complete.rb
 - lib/droxi/settings.rb
 - lib/droxi/state.rb
+- lib/droxi/text.rb
 - spec/all.rb
 - spec/commands_spec.rb
+- spec/complete_spec.rb
 - spec/settings_spec.rb
 - spec/state_spec.rb
+- spec/text_spec.rb
 homepage: https://github.com/jangler/droxi
 licenses:
 - MIT