droxi 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed8c5f6d9c0df8aff83fc755d298fda9dda25adf
-  data.tar.gz: f882a46c0a98a0f4f69cb88f3610fc403abc23e3
+  metadata.gz: 244170f34242a9088ac104e483683219845ac012
+  data.tar.gz: eb1dab3e763e6749171ae587ef288dd466d74700
 SHA512:
-  metadata.gz: c5cbb62624375b1515ff9e7de15167ead211bb535dd427a87954c3a585865e5d25ba90236a0f717c4a491b307d6bbb01fdd430dbee3c4edfaf43e8c49a30b3da
-  data.tar.gz: 4c9b4bc88008c441cb8f7284be5c90470b147233f134dceb035e9dc681e3ce303168220ecfdea5deb27f2bac94fad43109aeb52b3da18d23bafa730ba8b5580d
+  metadata.gz: 92865a868baf0e3efbbf0bf57cb844c12f89c58f500aa2151eea276d3cf3cd899aade5c80e4c10468e6e6c8bc542141bba88bea7786efcf2e924643ac944f426
+  data.tar.gz: eeda04ec25143e42c8e185aa2e88b71aee7d7be4facbe49e5bd3b2f2c80256a5e44e82e01d1963e05566498fe73368ea9ed8f09f3b71cb737c722a569cdbc1e2

data/README.md

@@ -28,5 +28,13 @@ features
   [GNU ftp](http://www.gnu.org/software/inetutils/), and
   [lftp](http://lftp.yar.ru/)
 - context-sensitive tab completion and path globbing
-- upload, download, and share files
+- upload, download, organize, and share files
 - man page and interactive help
+
+developer features
+------------------
+
+- extensive spec-style unit tests using
+  [MiniTest](https://github.com/seattlerb/minitest)
+- [RuboCop](https://github.com/bbatsov/rubocop)-approved
+- fully [RDoc](http://rdoc.sourceforge.net/) documented

data/Rakefile

@@ -5,10 +5,24 @@ task :test do
   sh 'ruby spec/all.rb'
 end
 
+desc 'run unit tests in verbose mode'
+task :verbose_test do
+  sh 'ruby -w spec/all.rb'
+end
+
+desc 'check code with rubocop'
+task :cop do
+  sh 'rubocop bin lib spec'
+end
+
 desc 'run program'
 task :run do
-  require_relative 'lib/droxi'
-  Droxi.run
+  sh 'ruby bin/droxi'
+end
+
+desc 'run program in debug mode'
+task :debug do
+  sh 'ruby bin/droxi --debug'
 end
 
 desc 'install gem'
@@ -30,8 +44,7 @@ task :build do
 
     contents = "#!/usr/bin/env ruby\n\n"
     contents << `cat -s #{filenames.join(' ')} \
-                 | grep -v require_relative \
-                 | grep -v "require 'droxi'"`
+                 | grep -v require_relative`
 
     IO.write('build/droxi', contents)
     File.chmod(0755, 'build/droxi')
@@ -96,5 +109,5 @@ end
 
 desc 'remove files generated by other targets'
 task :clean do
-  sh 'rm -rf build doc droxi-*.gem'
+  sh 'rm -rf build coverage doc droxi-*.gem'
 end

data/bin/droxi

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
-
-require 'droxi'
-Droxi.run(*ARGV)
+require_relative '../lib/droxi'
+Droxi.run(*(ARGV.reject { |arg| arg == '--debug' }))

data/droxi.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'droxi'
-  s.version     = '0.0.5'
-  s.date        = '2014-06-04'
+  s.version     = '0.1.0'
+  s.date        = '2014-06-05'
   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 include smart tab \

data/lib/droxi.rb

@@ -8,18 +8,16 @@ require_relative 'droxi/state'
 
 # Command-line Dropbox client module.
 module Droxi
-
   # Run the client.
   def self.run(*args)
-    client = DropboxClient.new(get_access_token)
+    client = DropboxClient.new(access_token)
     state = State.new(client)
 
     if args.empty?
       run_interactive(client, state)
     else
       with_interrupt_handling do
-        cmd = args.map { |arg| arg.gsub(' ', '\ ') }.join(' ')
-        Commands.exec(cmd, client, state)
+        Commands.exec(join_cmd(args), client, state)
       end
     end
 
@@ -28,6 +26,12 @@ module Droxi
 
   private
 
+  # Return a +String+ of joined command-line args, adding backslash escapes for
+  # spaces.
+  def self.join_cmd(args)
+    args.map { |arg| arg.gsub(' ', '\ ') }.join(' ')
+  end
+
   # Attempt to authorize the user for app usage.
   def self.authorize
     app_key = '5sufyfrvtro9zp7'
@@ -35,7 +39,7 @@ module Droxi
 
     flow = DropboxOAuth2FlowNoRedirect.new(app_key, app_secret)
 
-    authorize_url = flow.start()
+    authorize_url = flow.start
     code = get_auth_code(authorize_url)
 
     begin
@@ -47,8 +51,8 @@ module Droxi
 
   # Return the access token for the user, requesting authorization if no saved
   # token exists.
-  def self.get_access_token
-    authorize() until Settings.include?(:access_token)
+  def self.access_token
+    authorize until Settings.include?(:access_token)
     Settings[:access_token]
   end
 
@@ -69,37 +73,45 @@ module Droxi
     state.pwd = '/'
   end
 
+  # Return an +Array+ of potential tab-completion options for a given
+  # completion type, word, and client state.
+  def self.completion_options(type, word, state)
+    case type
+    when 'COMMAND'     then Complete.command(word, Commands::NAMES)
+    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
+  end
+
+  # Return a +String+ representing the type of tab-completion that should be
+  # performed, given the current line buffer state.
+  def self.completion_type
+    words = Readline.line_buffer.split
+    index = words.length
+    index += 1 if Readline.line_buffer.end_with?(' ')
+    if index <= 1
+      'COMMAND'
+    elsif Commands::NAMES.include?(words[0])
+      cmd = Commands.const_get(words[0].upcase.to_sym)
+      cmd.type_of_arg(index - 2)
+    end
+  end
+
   # Set up the Readline library's completion capabilities.
   def self.init_readline(state)
     Readline.completion_proc = proc do |word|
-      words = Readline.line_buffer.split
-      index = words.length
-      index += 1 if Readline.line_buffer.end_with?(' ')
-      if index <= 1
-        type = 'COMMAND'
-      elsif Commands::NAMES.include?(words[0])
-        cmd = Commands.const_get(words[0].upcase.to_sym)
-        type = cmd.type_of_arg(index - 2)
-      end
-
-      options = case type
-      when 'COMMAND'
-        Commands::NAMES.select { |name| name.start_with? word }.map do |name|
-          name + ' '
-        end
-      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 []
+      completion_options(completion_type, word, state).map do |option|
+        option.gsub(' ', '\ ').sub(/\\ $/, ' ')
       end
-
-      options.map { |option| option.gsub(' ', '\ ').sub(/\\ $/, ' ') }
     end
 
     begin
       Readline.completion_append_character = nil
     rescue NotImplementedError
+      nil
     end
   end
 
@@ -114,11 +126,12 @@ module Droxi
   # Run the main loop of the program, getting user input and executing it as a
   # command until an getting input fails or an exit is requested.
   def self.do_interaction_loop(client, state, info)
-    while !state.exit_requested &&
-          line = Readline.readline(prompt(info, state), true)
+    until state.exit_requested
+      line = Readline.readline(prompt(info, state), true)
+      break unless line
       with_interrupt_handling { Commands.exec(line.chomp, client, state) }
     end
-    puts if !line
+    puts unless line
   end
 
   # Instruct the user to enter an authorization code and return the code. If
@@ -131,5 +144,4 @@ module Droxi
     code = $stdin.gets
     code ? code.strip! : exit
   end
-
 end

data/lib/droxi/commands.rb

@@ -4,7 +4,6 @@ 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
@@ -12,7 +11,6 @@ module Commands
 
   # A client command. Contains metadata as well as execution procedure.
   class Command
-
     # 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.
@@ -36,12 +34,9 @@ module Commands
     # 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? }
-        @procedure.yield(client, state, args, block)
-      else
-        fail UsageError, @usage
-      end
+      fail UsageError, @usage unless num_args_ok?(args.length)
+      block = proc { |line| yield line if block_given? }
+      @procedure.yield(client, state, args, block)
     end
 
     # Return a +String+ describing the type of argument at the given index.
@@ -49,12 +44,9 @@ module Commands
     # the +Command+ takes no arguments, return +nil+.
     def type_of_arg(index)
       args = @usage.split.drop(1).reject { |arg| arg.include?('-') }
-      if args.empty?
-        nil
-      else
-        index = [index, args.length - 1].min
-        args[index].tr('[].', '')
-      end
+      return nil if args.empty?
+      index = [index, args.length - 1].min
+      args[index].tr('[].', '')
     end
 
     private
@@ -64,13 +56,11 @@ module Commands
     def num_args_ok?(num_args)
       args = @usage.split.drop(1)
       min_args = args.reject { |arg| arg.start_with?('[') }.length
-      if args.empty?
-        max_args = 0
-      elsif args.any? { |arg| arg.end_with?('...') }
-        max_args = num_args
-      else
-        max_args = args.length
-      end
+      max_args = if args.any? { |arg| arg.end_with?('...') }
+                   num_args
+                 else
+                   args.length
+                 end
       (min_args..max_args).include?(num_args)
     end
   end
@@ -82,17 +72,16 @@ module Commands
      Dropbox root. With a remote directory name as the argument, changes to \
      that directory. With - as the argument, changes to the previous working \
      directory.",
-    lambda do |client, state, args, output|
-      if args.empty?
-        state.pwd = '/'
-      elsif args[0] == '-'
-        state.pwd = state.oldpwd
+    lambda do |_client, state, args, output|
+      case
+      when args.empty? then state.pwd = '/'
+      when args[0] == '-' then state.pwd = state.oldpwd
       else
         path = state.resolve_path(args[0])
         if state.directory?(path)
           state.pwd = path
         else
-          output.call('Not a directory')
+          output.call("cd: #{args[0]}: no such directory")
         end
       end
     end
@@ -106,15 +95,35 @@ module Commands
      final argument is a directory, copies each remote file or folder into \
      that directory.",
     lambda do |client, state, args, output|
-      cp_mv(client, state, args, output, 'cp', :file_copy)
+      cp_mv(client, state, args, output, 'cp')
+    end
+  )
+
+  # Execute arbitrary code.
+  DEBUG = Command.new(
+    'debug STRING...',
+    "Evaluates the given string as Ruby code and prints the result. Won't \
+     work unless the program was invoked with the --debug flag.",
+    # rubocop:disable Lint/UnusedBlockArgument, Lint/Eval
+    lambda do |client, state, args, output|
+      if ARGV.include?('--debug')
+        begin
+          output.call(eval(args.join(' ')).inspect)
+          # rubocop:enable Lint/UnusedBlockArgument, Lint/Eval
+        rescue => error
+          output.call(error.inspect)
+        end
+      else
+        output.call('Debug not enabled.')
+      end
     end
   )
 
   # Terminate the session.
   EXIT = Command.new(
     'exit',
-    "Exit the program.",
-    lambda do |client, state, args, output|
+    'Exit the program.',
+    lambda do |_client, state, _args, _output|
       state.exit_requested = true
     end
   )
@@ -125,7 +134,7 @@ module Commands
     "Clear the client-side cache of remote filesystem metadata. With no \
      arguments, clear the entire cache. If given directories as arguments, \
      (recursively) clear the cache of those directories only.",
-    lambda do |client, state, args, output|
+    lambda do |_client, state, args, output|
       if args.empty?
         state.cache.clear
       else
@@ -144,14 +153,13 @@ module Commands
     lambda do |client, state, args, output|
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("get: #{path}: No such file or directory")
+          output.call("get: #{path}: no such file or directory")
         else
           try_and_handle(DropboxError, output) do
             contents = client.get_file(path)
-            File.open(File.basename(path), 'wb') do |file|
-              file.write(contents)
-            end
-            output.call("#{File.basename(path)} <- #{path}")
+            basename = File.basename(path)
+            File.open(basename, 'wb') { |file| file.write(contents) }
+            output.call("#{basename} <- #{path}")
           end
         end
       end
@@ -163,7 +171,7 @@ module Commands
     '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|
+    lambda do |_client, _state, args, output|
       if args.empty?
         Text.table(NAMES).each { |line| output.call(line) }
       else
@@ -186,20 +194,23 @@ module Commands
      home directory. With a local directory name as the argument, changes to \
      that directory. With - as the argument, changes to the previous working \
      directory.",
-    lambda do |client, state, args, output|
-      path = if args.empty?
-        File.expand_path('~')
-      elsif args[0] == '-'
-        state.local_oldpwd
-      else
-        File.expand_path(args[0])
-      end
-
-      if Dir.exists?(path)
+    lambda do |_client, state, args, output|
+      path = case
+             when args.empty? then File.expand_path('~')
+             when args[0] == '-' then state.local_oldpwd
+             else
+               begin
+                 File.expand_path(args[0])
+               rescue ArgumentError
+                 args[0]
+               end
+             end
+
+      if Dir.exist?(path)
         state.local_oldpwd = Dir.pwd
         Dir.chdir(path)
       else
-        output.call("lcd: #{args[0]}: No such file or directory")
+        output.call("lcd: #{args[0]}: no such file or directory")
       end
     end
   )
@@ -212,13 +223,13 @@ module Commands
      arguments, list the contents of the directories. When given remote files \
      as arguments, list the files. If the -l option is given, display \
      information about the files.",
-    lambda do |client, state, args, output|
-      long = args.delete('-l') != nil
+    lambda do |_client, state, args, output|
+      long = args.delete('-l')
 
       files, dirs = [], []
       state.expand_patterns(args, true).each do |path|
         if path.is_a?(GlobError)
-          output.call("ls: #{path}: No such file or directory")
+          output.call("ls: #{path}: no such file or directory")
         else
           type = state.directory?(path) ? dirs : files
           type << path
@@ -229,7 +240,7 @@ module Commands
 
       # First list files
       list(state, files, files, long) { |line| output.call(line) }
-      output.call('') if !(dirs.empty? || files.empty?)
+      output.call('') unless dirs.empty? || files.empty?
 
       # Then list directory contents
       dirs.each_with_index do |dir, i|
@@ -250,7 +261,7 @@ module Commands
     lambda do |client, state, args, output|
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("media: #{path}: No such file or directory")
+          output.call("media: #{path}: no such file or directory")
         else
           try_and_handle(DropboxError, output) do
             url = client.media(path)['url']
@@ -264,12 +275,13 @@ module Commands
   # Create a remote directory.
   MKDIR = Command.new(
     'mkdir REMOTE_DIR...',
-    "Create remote directories.",
+    'Create remote directories.',
     lambda do |client, state, args, output|
       args.each do |arg|
         try_and_handle(DropboxError, output) do
           path = state.resolve_path(arg)
-          state.cache[path] = client.file_create_folder(path)
+          metadata = client.file_create_folder(path)
+          state.cache.add(metadata)
         end
       end
     end
@@ -283,7 +295,7 @@ module Commands
      final argument is a directory, moves each remote file or folder into \
      that directory.",
     lambda do |client, state, args, output|
-      cp_mv(client, state, args, output, 'mv', :file_move)
+      cp_mv(client, state, args, output, 'mv')
     end
   )
 
@@ -296,17 +308,13 @@ module Commands
      remote working directory.",
     lambda do |client, state, args, output|
       from_path = args[0]
-      if args.length == 2
-        to_path = args[1]
-      else
-        to_path = File.basename(from_path)
-      end
+      to_path = (args.length == 2) ? args[1] : File.basename(from_path)
       to_path = state.resolve_path(to_path)
 
-      try_and_handle(Exception, output) do 
+      try_and_handle(Exception, output) do
         File.open(File.expand_path(from_path), 'rb') do |file|
           data = client.put_file(to_path, file)
-          state.cache[data['path']] = data
+          state.cache.add(data)
           output.call("#{from_path} -> #{data['path']}")
         end
       end
@@ -316,15 +324,15 @@ module Commands
   # Remove remote files.
   RM = Command.new(
     'rm REMOTE_FILE...',
-    "Remove each specified remote file or directory.",
+    'Remove each specified remote file or directory.',
     lambda do |client, state, args, output|
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("rm: #{path}: No such file or directory")
+          output.call("rm: #{path}: no such file or directory")
         else
           try_and_handle(DropboxError, output) do
             client.file_delete(path)
-            state.cache_remove(path)
+            state.cache.remove(path)
           end
         end
       end
@@ -342,7 +350,7 @@ module Commands
     lambda do |client, state, args, output|
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("share: #{path}: No such file or directory")
+          output.call("share: #{path}: no such file or directory")
         else
           try_and_handle(DropboxError, output) do
             url = client.shares(path)['url']
@@ -353,16 +361,20 @@ module Commands
     end
   )
 
+  # Return an +Array+ of all command names.
+  def self.names
+    symbols = constants.select { |sym| const_get(sym).is_a?(Command) }
+    symbols.map { |sym| sym.to_s.downcase }
+  end
+
   # +Array+ of all command names.
-  NAMES = constants.select do |sym|
-     const_get(sym).is_a?(Command)
-  end.map { |sym| sym.to_s.downcase }
+  NAMES = names
 
   # 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 }
-    elsif not input.empty?
+    elsif !input.empty?
       tokens = tokenize(input)
       cmd, args = tokens[0], tokens.drop(1)
       try_command(cmd, args, client, state)
@@ -399,10 +411,10 @@ module Commands
   def self.tokenize(string)
     string.split.reduce([]) do |list, token|
       list << if !list.empty? && list.last.end_with?('\\')
-        "#{list.pop.chop} #{token}"
-      else
-        token
-      end
+                "#{list.pop.chop} #{token}"
+              else
+                token
+              end
     end
   end
 
@@ -432,16 +444,17 @@ module Commands
       pipe.each_line { |line| yield line.chomp if block_given? }
     end
   rescue Interrupt
-  rescue Exception => error
+    yield ''
+  rescue Errno::ENOENT => error
     yield error.to_s if block_given?
   end
 
   # Return an +Array+ of paths from an +Array+ of globs, passing error messages
   # to the output +Proc+ for non-matches.
-  def self.expand(state, paths, preserve_root, output, cmd_name)
-    state.expand_patterns(paths, true).map do |item|
+  def self.expand(state, paths, preserve_root, output, cmd)
+    state.expand_patterns(paths, preserve_root).map do |item|
       if item.is_a?(GlobError)
-        output.call("#{cmd_name}: #{item}: no such file or directory")
+        output.call("#{cmd}: #{item}: no such file or directory") if output
         nil
       else
         item
@@ -449,41 +462,48 @@ module Commands
     end.compact
   end
 
-  # Copies or moves the file at +source+ to +dest+ and passes a description of
-  # the operation to the output +Proc+.
-  def self.copy_move(method, source, dest, client, state, output)
-    from_path, to_path = [source, dest].map { |p| state.resolve_path(p) }
+  # Copies or moves a file and passes a description of the operation to the
+  # output +Proc+.
+  def self.copy_move(method, args, client, state, output)
+    from_path, to_path = args.map { |p| state.resolve_path(p) }
     try_and_handle(DropboxError, output) do
       metadata = client.send(method, from_path, to_path)
-      state.cache_remove(from_path) if method == :file_move
-      state.cache_add(metadata)
-      output.call("#{source} -> #{dest}")
+      state.cache.remove(from_path) if method == :file_move
+      state.cache.add(metadata)
+      output.call("#{args[0]} -> #{args[1]}")
     end
   end
 
   # Execute a 'mv' or 'cp' operation depending on arguments given.
-  def self.cp_mv(client, state, args, output, cmd, method)
+  def self.cp_mv(client, state, args, output, cmd)
     sources = expand(state, args.take(args.length - 1), true, output, cmd)
+    method = (cmd == 'cp') ? :file_copy : :file_move
     dest = state.resolve_path(args.last)
 
     if sources.length == 1 && !state.directory?(dest)
-      copy_move(method, sources[0], args.last, client, state, output)
+      copy_move(method, [sources[0], args.last], client, state, output)
     else
-      if state.metadata(dest)
-        sources.each do |source|
-          to_path = args.last.chomp('/') + '/' + File.basename(source)
-          copy_move(method, source, to_path, client, state, output)
-        end
-      else
-        output.call("#{cmd}: #{args.last}: no such directory")
+      cp_mv_to_dir(args, client, state, cmd, output)
+    end
+  end
+
+  # Copies or moves files into a directory.
+  def self.cp_mv_to_dir(args, client, state, cmd, output)
+    sources = expand(state, args.take(args.length - 1), true, nil, cmd)
+    method = (cmd == 'cp') ? :file_copy : :file_move
+    if state.metadata(state.resolve_path(args.last))
+      sources.each do |source|
+        to_path = args.last.chomp('/') + '/' + File.basename(source)
+        copy_move(method, [source, to_path], client, state, output)
       end
+    else
+      output.call("#{cmd}: #{args.last}: no such directory")
     end
   end
 
   # If the remote working directory does not exist, move up the directory
   # tree until at a real location.
   def self.check_pwd(state)
-    state.pwd = File.dirname(state.pwd) until state.metadata(state.pwd)
+    (state.pwd = File.dirname(state.pwd)) until state.metadata(state.pwd)
   end
-
 end