droxi 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c51dbec9e627b8b8b2e07e4ac8bf4464bee33dd
-  data.tar.gz: 480c18b2b62a8ec434cd6c8a8a481a40976f884b
+  metadata.gz: ad346e735c5106bff58480298a50a5c296e15542
+  data.tar.gz: f565510a170c8ad38066048d4cf7fe10bf09d51e
 SHA512:
-  metadata.gz: 5af1c7d1ab268567fa44508dad484090c6da945f1861e022c025e34dff7527525d81af89d03812b613c1d8aa008e9e33e806656d47832f95fa9ae37654b16655
-  data.tar.gz: bd890a7e5aa0c14d912181f7d80643a46c1d41dbf914b4556919f660fa1e67edec98d8e18f48c25d01b9b6d71c4555e3c4e34a18553a6a613838410fba431906
+  metadata.gz: d14ddec3bd6d7cb7bbd3ad82ece43f7f9cb3811868fa1ef82525fb3dcbf853aaecf30365c960ded970be82fbf26455d454a334e34c27a6b599b7eca50f56cbda
+  data.tar.gz: 337b45f2741a59ac04422264ce0452abcd69e62eea9e2ee38dea7a97dca309fc56e14d4c90b62e2244c7ce11a4e36c82ed9b4541e2505e5ce8a8e5a49a54dcc1

data/README.md

@@ -26,7 +26,24 @@ Features
 - Context-sensitive tab completion and path globbing
 - Upload, download, organize, search, and share files
 - File revision control
-- Man page and interactive help
+- Interactive help
+
+Usage
+-----
+	Usage: droxi [OPTION ...] [COMMAND [ARGUMENT ...]]
+
+	If invoked without arguments, run in interactive mode. If invoked with
+	arguments, parse the arguments as a command invocation, execute the
+	command, and exit.
+
+	For a list of commands, run `droxi help` or use the 'help' command in
+	interactive mode.
+
+	Options:
+			--debug                      Enable debug command
+		-f, --file FILE                  Specify path of config file
+		-h, --help                       Print help information and exit
+			--version                    Print version information and exit
 
 Examples
 --------

data/Rakefile

@@ -37,7 +37,7 @@ task :doc do
   sh 'rdoc `find lib -name *.rb`'
 end
 
-desc 'build executable and man page'
+desc 'build executable'
 task :build do
   def build_exe
     filenames = `find lib -name *.rb`.split + ['bin/droxi']
@@ -50,64 +50,29 @@ task :build do
     File.chmod(0755, 'build/droxi')
   end
 
-  def date(gemspec)
-    require 'time'
-    Time.parse(gemspec[/\d{4}-\d{2}-\d{2}/]).strftime('%B %Y')
-  end
-
-  def commands
-    require_relative 'lib/droxi/commands'
-    Commands::NAMES.sort.map do |name|
-      cmd = Commands.const_get(name.upcase.to_sym)
-      ".TP\n#{cmd.usage}\n#{cmd.description}\n"
-    end.join.strip
-  end
-
-  def build_page
-    gemspec = IO.read('droxi.gemspec')
-    main = IO.read('lib/droxi.rb')
-
-    contents = format(IO.read('droxi.1.template'),
-                      date: date(gemspec),
-                      version: main[/\d+\.\d+\.\d+/],
-                      commands: commands)
-
-    IO.write('build/droxi.1', contents)
-  end
-
   Dir.mkdir('build') unless Dir.exist?('build')
   build_exe
-  build_page
-end
-
-desc 'build html version of man page'
-task :html do
-  sh 'groff -man -T html build/droxi.1 > build/droxi.html'
 end
 
 PREFIX = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
 BIN_PATH = "#{PREFIX}/bin"
-MAN_PATH = "#{PREFIX}/share/man/man1"
 
-desc 'install executable and man page'
+desc 'install executable'
 task :install do
   require 'fileutils'
   begin
     FileUtils.mkdir_p(BIN_PATH)
     FileUtils.cp('build/droxi', BIN_PATH)
-    FileUtils.mkdir_p(MAN_PATH)
-    FileUtils.cp('build/droxi.1', MAN_PATH)
   rescue => error
     puts error
   end
 end
 
-desc 'uninstall executable and man page'
+desc 'uninstall executable'
 task :uninstall do
   require 'fileutils'
   begin
     FileUtils.rm("#{BIN_PATH}/droxi")
-    FileUtils.rm("#{MAN_PATH}/droxi.1")
   rescue => error
     puts error
   end

data/bin/droxi

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require_relative '../lib/droxi'
-Droxi.run(ARGV.dup)
+Droxi.run

data/droxi.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'droxi'
   s.version     = IO.read('lib/droxi.rb')[/VERSION = '(.+)'/, 1]
-  s.date        = '2015-05-09'
+  s.date        = '2015-05-31'
   s.summary     = 'An ftp-like command-line interface to Dropbox'
   s.description = "A command-line Dropbox interface based on GNU coreutils, \
                    GNU ftp, and lftp. Features include smart tab completion, \

data/lib/droxi.rb

@@ -1,10 +1,11 @@
 begin
   require 'dropbox_sdk'
 rescue LoadError
-  puts "droxi requires the dropbox-sdk gem."
-  puts "Run `gem install dropbox-sdk` to install it."
+  puts 'droxi requires the dropbox-sdk gem.'
+  puts 'Run `gem install dropbox-sdk` to install it.'
   exit
 end
+require 'optparse'
 require 'readline'
 
 require_relative 'droxi/commands'
@@ -16,24 +17,34 @@ require_relative 'droxi/text'
 # Command-line Dropbox client module.
 module Droxi
   # Version number of the program.
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 
   # Message to display when invoked with the --help option.
-  HELP_TEXT =
-    "If you've installed this program using Rake or the AUR package, you " \
-    'should also have the man page installed on your system. If you do not ' \
-    'have the man page, you can access it at http://jangler.info/man/droxi ' \
-    'in HTML form.'
+  HELP_TEXT = [
+    'If invoked without arguments, run in interactive mode. If invoked with ' \
+    'arguments, parse the arguments as a command invocation, execute the ' \
+    'command, and exit.',
+    "For a list of commands, run `droxi help` or use the 'help' command in " \
+    'interactive mode.'
+  ]
 
   # Run the client.
-  def self.run(args)
-    client = DropboxClient.new(access_token)
-    state = State.new(client)
+  def self.run
+    reenter = ARGV[0] == 'REENTER'
+    ARGV.delete_if { |arg| arg == 'REENTER' }
+    original_argv = ARGV.dup
+    options = handle_options
+    Settings.init
 
-    options = handle_options(args)
-    args.shift(options.size)
+    client = DropboxClient.new(access_token)
+    state = State.new(client, ARGV.empty?, original_argv)
+    state.debug_enabled = options[:debug]
 
-    args.empty? ? run_interactive(client, state) : invoke(args, client, state)
+    if ARGV.empty?
+      run_interactive(client, state, reenter)
+    else
+      invoke(ARGV, client, state)
+    end
   rescue DropboxAuthError => error
     warn error
     Settings.delete(:access_token)
@@ -43,15 +54,45 @@ module Droxi
 
   private
 
-  # Handles command-line options extracted from an +Array+ and returns an
-  # +Array+ of the extracted options.
-  def self.handle_options(args)
-    options = args.take_while { |s| s.start_with?('-') }
-    puts "droxi v#{VERSION}" if options.include?('--version')
-    if options.include?('-h') || options.include?('--help')
-      Text.wrap(HELP_TEXT).each { |s| puts s }
+  # Handles command-line options and returns a +Hash+ of the extracted options.
+  def self.handle_options
+    options = { debug: false }
+
+    parser = OptionParser.new do |opts|
+      opts.banner = 'Usage: droxi [OPTION ...] [COMMAND [ARGUMENT ...]]'
+
+      opts.separator ''
+      HELP_TEXT.each do |text|
+        Text.wrap(text).each { |s| opts.separator(s) }
+        opts.separator ''
+      end
+      opts.separator 'Options:'
+
+      opts.on('--debug', 'Enable debug command') { options[:debug] = true }
+
+      opts.on('-f', '--file FILE', String,
+              'Specify path of config file') do |path|
+        Settings.config_file_path = path
+      end
+
+      opts.on('-h', '--help', 'Print help information and exit') do
+        puts opts
+        exit
+      end
+
+      opts.on('--version', 'Print version information and exit') do
+        puts "droxi v#{VERSION}"
+        exit
+      end
     end
-    exit if %w(-h --help --version).any? { |s| options.include?(s) }
+
+    begin
+      parser.parse!
+    rescue OptionParser::ParseError => err
+      warn(err)
+      exit(1)
+    end
+
     options
   end
 
@@ -96,9 +137,13 @@ module Droxi
   end
 
   # Run the client in interactive mode.
-  def self.run_interactive(client, state)
+  def self.run_interactive(client, state, reenter)
     info = client.account_info
-    puts "Logged in as #{info['display_name']} (#{info['email']})"
+    if reenter
+      state.pwd = state.oldpwd
+    else
+      puts "Logged in as #{info['display_name']} (#{info['email']})"
+    end
 
     init_readline(state)
     with_interrupt_handling { do_interaction_loop(client, state, info) }

data/lib/droxi/commands.rb

@@ -51,7 +51,7 @@ module Commands
     # command, +false+ otherwise.
     def num_args_ok?(num_args)
       args = @usage.split.drop(1)
-      min_args = args.reject { |arg| arg[/[\[\]]/] }.size
+      min_args = args.count { |arg| !arg[/[\[\]]/] }
       max_args = if args.any? { |arg| arg.end_with?('...') }
                    num_args
                  else
@@ -118,12 +118,12 @@ module Commands
     '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|
-      if ARGV.include?('--debug')
+    # rubocop:disable Lint/Eval
+    lambda do |_client, state, args|
+      if state.debug_enabled
         begin
           p eval(args.join(' '))
-          # rubocop:enable Lint/UnusedBlockArgument, Lint/Eval
+          # rubocop:enable Lint/Eval
         rescue SyntaxError => error
           warn error
         rescue => error
@@ -135,6 +135,20 @@ module Commands
     end
   )
 
+  # Execute shell command.
+  EXEC = Command.new(
+    'exec STRING...',
+    "Executes the given string in the system shell. ! can be used as \
+     shorthand for exec, as in \"!ls\".",
+    lambda do |_client, state, args|
+      state.pwd = '/'
+      Settings.save
+      cmd = args.join(' ')
+      cmd += '; droxi REENTER ' + state.argv.join(' ') if state.interactive
+      Kernel.exec(cmd)
+    end
+  )
+
   # Terminate the session.
   EXIT = Command.new(
     'exit',
@@ -233,7 +247,6 @@ module Commands
       else
         try_and_handle(DropboxError) do
           client.revisions(path).each do |rev|
-
             size = rev['size'].sub(/ (.)B/, '\1').sub(' bytes', '').rjust(7)
             mtime = Time.parse(rev['modified'])
             current_year = (mtime.year == Time.now.year)
@@ -285,7 +298,8 @@ module Commands
     lambda do |_client, state, args|
       long = extract_flags(LS.usage, args, '-l' => 0).include?('-l')
 
-      files, dirs = [], []
+      files = []
+      dirs = []
       state.expand_patterns(args, true).each do |path|
         if path.is_a?(GlobError)
           warn "ls: #{path}: no such file or directory"
@@ -566,11 +580,11 @@ module Commands
 
   # 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.size - 1]) { |line| puts line }
-    elsif !input.empty?
+    unless input.empty?
+      input.sub!(/^!/, 'exec ')
       tokens = Text.tokenize(input)
-      cmd, args = tokens.first, tokens.drop(1)
+      cmd = tokens.first
+      args = tokens.drop(1)
       try_command(cmd, args, client, state)
     end
   end
@@ -700,7 +714,8 @@ module Commands
   # removed flags. Prints warnings if the flags are not in the given +String+
   # of valid flags (e.g. '-rf').
   def self.extract_flags(usage, args, flags)
-    extracted, index = [], 0
+    extracted = []
+    index = 0
     while index < args.size
       arg = args[index]
       extracted_flags =
@@ -742,7 +757,6 @@ module Commands
   end
 
   # Continuously try to upload until successful or interrupted.
-  # rubocop:disable Style/MethodLength
   def self.loop_upload(uploader, monitor_thread, tries)
     while tries != 0 && uploader.offset < uploader.total_size
       begin
@@ -756,7 +770,6 @@ module Commands
     monitor_thread.kill if monitor_thread
     raise error
   end
-  # rubocop:enable Style/MethodLength
 
   # Displays real-time progress for the a being uploaded.
   def self.monitor_upload(uploader, to_path)

data/lib/droxi/complete.rb

@@ -11,7 +11,7 @@ module Complete
     completion_options(type, tokens.last, state).map do |option|
       option.gsub(' ', '\ ').sub(/\\ $/, ' ')
         .split.drop(tokens.last.count(' ')).join(' ')
-        .sub(/[^\\\/]$/, '\0 ')
+        .sub(%r{[^\\/]$}, '\0 ')
     end
   end
 
@@ -36,6 +36,8 @@ module Complete
     index = tokens.drop_while { |token| token[/^-\w+$/] }.size
     if index <= 1
       'COMMAND'
+    elsif tokens[0].start_with?('!') || tokens[0].downcase == 'exec'
+      'LOCAL_FILE'
     elsif Commands::NAMES.include?(tokens.first)
       cmd = Commands.const_get(tokens.first.upcase.to_sym)
       cmd.type_of_arg(index - 2)
@@ -121,7 +123,7 @@ module Complete
   # Return the name of the directory indicated by a path.
   def self.strip_filename(path)
     return path if path == '/'
-    path.end_with?('/') ? path.sub(/\/$/, '') : File.dirname(path)
+    path.end_with?('/') ? path.sub(%r{/$}, '') : File.dirname(path)
   end
 
   # Return a version of a path with .. and . resolved to appropriate

data/lib/droxi/settings.rb

@@ -75,10 +75,14 @@ module Settings
   # setting data.
   def self.parse(line)
     return warn_invalid(line) unless /^(.+?)=(.+)$/ =~ line
-    key, value = Regexp.last_match[1].to_sym, Regexp.last_match[2]
+    key = Regexp.last_match[1].to_sym
+    value = Regexp.last_match[2]
     return warn_invalid(line) unless [:access_token, :oldpwd].include?(key)
     { key => value }
   end
 
-  self.settings = read
+  # Initialize settings by reading rc file.
+  def self.init
+    self.settings = read
+  end
 end

data/lib/droxi/state.rb

@@ -15,18 +15,30 @@ class State
   # The previous remote working directory path.
   attr_reader :oldpwd
 
+  # The actual/original command-line arguments
+  attr_reader :argv
+
+  # Whether the session is interactive.
+  attr_reader :interactive
+
   # The previous local working directory path.
   attr_accessor :local_oldpwd
 
   # +true+ if the client has requested to quit, +false+ otherwise.
   attr_accessor :exit_requested
 
+  # +true+ if the --debug option was given, +false+ otherwise.
+  attr_accessor :debug_enabled
+
   # Return a new application state that uses the given client. Starts at the
   # Dropbox root and with an empty cache.
-  def initialize(client)
+  def initialize(client, interactive = true, argv = ARGV)
+    @interactive = interactive
+    @argv = argv
     @cache = Cache.new
     @client = client
     @exit_requested = false
+    @debug_enabled = false
     @pwd = '/'
     @oldpwd = Settings[:oldpwd] || '/'
     @local_oldpwd = Dir.pwd
@@ -53,9 +65,10 @@ class State
     path = resolve_path(path)
     metadata(path)
     path = "#{path}/".sub('//', '/')
-    @cache.keys.select do |key|
+    keys = @cache.keys.select do |key|
       key.start_with?(path) && key != path && !key.sub(path, '').include?('/')
-    end.map { |key| @cache[key]['path'] }
+    end
+    keys.map { |key| @cache[key]['path'] }
   end
 
   # Return +true+ if the Dropbox path is a directory, +false+ otherwise.
@@ -80,7 +93,7 @@ class State
     path.gsub!('//', '/')
     nil while path.sub!(%r{/([^/]+?)/\.\.}, '')
     nil while path.sub!('./', '')
-    path.sub!(/\/\.$/, '')
+    path.sub!(%r{/\.$}, '')
     path.chomp!('/')
     path.gsub!('//', '/')
     path.empty? ? '/' : path
@@ -130,8 +143,8 @@ class State
     path = path.downcase
     dir = File.dirname(path)
     matches = contents(dir).select do |entry|
-                File.fnmatch(path, entry.downcase)
-              end
+      File.fnmatch(path, entry.downcase)
+    end
     return GlobError.new(pattern) if matches.empty?
     return matches unless preserve_root
     prefix = pattern.rpartition('/')[0, 2].join

data/lib/droxi/text.rb

@@ -8,7 +8,7 @@ module Text
   def self.table(items)
     return [] if items.empty?
     width = terminal_width
-    item_width = items.map { |item| item.size }.max + 2
+    item_width = items.map(&:size).max + 2
     items_per_line = [1, width / item_width].max
     format_table(items, item_width, items_per_line)
   end
@@ -16,7 +16,8 @@ module Text
   # Wrap a +String+ to fit the terminal and return an +Array+ of lines in the
   # result.
   def self.wrap(text)
-    width, position = terminal_width, 0
+    width = terminal_width
+    position = 0
     lines = []
     while position < text.size
       lines << get_wrap_segment(text[position, text.size], width)
@@ -52,7 +53,8 @@ module Text
 
   # Return an +Array+ of lines of the given items formatted as a table.
   def self.format_table(items, item_width, columns)
-    lines, items = [], items.dup
+    lines = []
+    items = items.dup
     until items.empty?
       lines << items.shift(columns).map { |item| item.ljust(item_width) }.join
     end

data/spec/testutils.rb

@@ -51,6 +51,7 @@ module TestUtils
 
   # Returns a new +DropboxClient+ and +State+.
   def self.create_client_and_state
+    Settings.init
     client = DropboxClient.new(Settings[:access_token])
     [client, State.new(client)]
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droxi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Brandon Mulcahy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-09 00:00:00.000000000 Z
+date: 2015-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk
@@ -42,7 +42,6 @@ files:
 - README.md
 - Rakefile
 - bin/droxi
-- droxi.1.template
 - droxi.gemspec
 - lib/droxi.rb
 - lib/droxi/cache.rb

data/droxi.1.template

@@ -1,30 +0,0 @@
-.TH DROXI 1 "%{date}" "droxi %{version}"
-.SH NAME
-droxi \- ftp-like command-line interface to Dropbox
-.SH SYNOPSIS
-droxi [OPTION]... [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
-.TP
-!STRING
-Pass a string to be executed by the local shell.
-%{commands}
-.SH OPTIONS
-.TP
---debug
-Enable the 'debug' command for the session.
-.TP
--h, --help
-Print help information and exit.
-.TP
---version
-Print version information and exit.
-.SH BUGS
-If you find one, please use https://github.com/jangler/droxi/issues to report
-it, or contact me via email.
-.SH AUTHOR
-Written by Brandon Mulcahy (brandon@jangler.info).