droxi 0.0.5 → 0.1.0

data/spec/complete_spec.rb

@@ -1,6 +1,8 @@
 require 'dropbox_sdk'
 require 'minitest/autorun'
 
+require_relative 'testutils'
+require_relative '../lib/droxi/commands'
 require_relative '../lib/droxi/complete'
 require_relative '../lib/droxi/settings'
 require_relative '../lib/droxi/state'
@@ -12,99 +14,162 @@ describe Complete do
     rand(length).times.map { CHARACTERS.sample }.join
   end
 
-  describe "when resolving a local search path" do
-    it "must resolve unqualified string to working directory" do
+  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
+    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
+    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
+    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
+    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
+    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')
+    it 'must resolve a bogus string to working directory' do
+      Complete.local_search_path('~bogus/bogus').must_equal Dir.pwd
     end
   end
 
-  describe "when finding potential local tab completions" do
+  describe 'when finding potential local tab completions' do
     def check(path)
-      100.times.all? do |i|
+      100.times.all? do
         prefix = path + random_string(5)
         Complete.local(prefix).all? { |match| match.start_with?(prefix) }
       end.must_equal true
-      1000.times.any? do |i|
+      1000.times.any? do
         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 '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
+  describe 'when finding local directory tab completions' do
+    it 'must include all directories and only directories' do
+      entries = Dir.entries(Dir.pwd).select do |entry|
+        File.directory?(entry) && !/^..?$/.match(entry)
+      end
+      matches = Complete.local_dir('').map { |match| match.chomp('/') }
+      matches.sort.must_equal entries.sort
     end
+
+    it 'must append a / to the end of options' do
+      Complete.local_dir('').all? { |option| option.end_with?('/') }
+    end
+  end
+
+  describe 'when resolving a remote search path' do
+    client = DropboxClient.new(Settings[:access_token])
+    TestUtils.ignore(DropboxError) { client.file_create_folder('/testing') }
     state = State.new(client)
     state.pwd = '/testing'
 
-    it "must resolve unqualified string to working directory" do
+    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
+    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
+    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
+    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
+    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
+
+  describe 'when finding remote tab completions' do
+    client = DropboxClient.new(Settings[:access_token])
+    state = State.new(client)
+    state.pwd = '/testing'
+    Commands::RM.exec(client, state, '/testing/*')
+    %w(/testing /testing/one /testing/two).each do |dir|
+      Commands::MKDIR.exec(client, state, dir) unless state.metadata(dir)
+    end
+    `echo hello > test.txt`
+    Commands::PUT.exec(client, state, 'test.txt')
+    `rm test.txt`
+
+    it 'must return only matches of which the string is a prefix' do
+      Complete.remote('t', state).must_equal ['two/', 'test.txt ']
+    end
+
+    it 'must return only directories if requested' do
+      Complete.remote_dir('', state).must_equal %w(one/ two/)
+    end
+  end
+
+  describe 'when resolving command names' do
+    before do
+      @words = %w(plank plague plonk lake lag lock)
+    end
+
+    it 'must return matches if and only if the string is a prefix' do
+      Complete.command('pla', @words).length.must_equal 2
+    end
+
+    it 'must return matches that end with a space' do
+      Complete.command('plank', @words).must_equal ['plank ']
+    end
+  end
 end

data/spec/settings_spec.rb

@@ -1,14 +1,23 @@
+require 'fileutils'
 require 'minitest/autorun'
 
-require_relative '../lib/droxi/settings'
+def suppress_warnings
+  prev_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+  $VERBOSE = prev_verbose
+end
+
+suppress_warnings { require_relative '../lib/droxi/settings' }
 
 describe Settings do
   KEY, VALUE = :test_key, :test_value
+  RC_PATH = File.expand_path('~/.config/droxi/testrc')
+  Settings.config_file_path = RC_PATH
 
   describe 'when attempting access with a bogus key' do
     it 'must return nil' do
       Settings.delete(KEY)
-      Settings[KEY].must_equal nil
+      Settings[KEY].must_be_nil
     end
   end
 
@@ -16,6 +25,7 @@ describe Settings do
     it 'must return the associated value' do
       Settings[KEY] = VALUE
       Settings[KEY].must_equal VALUE
+      Settings.delete(KEY)
     end
   end
 
@@ -30,7 +40,7 @@ describe Settings do
   describe 'when deleting a bogus key' do
     it 'must return nil' do
       Settings.delete(KEY)
-      Settings.delete(KEY).must_equal nil
+      Settings.delete(KEY).must_be_nil
     end
   end
 
@@ -38,7 +48,7 @@ describe Settings do
     it 'must delete the key and return the associated value' do
       Settings[KEY] = VALUE
       Settings.delete(KEY).must_equal VALUE
-      Settings[KEY].must_equal nil
+      Settings[KEY].must_be_nil
     end
   end
 
@@ -46,6 +56,7 @@ describe Settings do
     it 'must return true for valid keys' do
       Settings[KEY] = VALUE
       Settings.include?(KEY).must_equal true
+      Settings.delete(KEY)
     end
 
     it 'must return false for bogus keys' do
@@ -53,4 +64,26 @@ describe Settings do
       Settings.include?(KEY).must_equal false
     end
   end
+
+  describe 'when reading settings from disk' do
+    it 'must return an empty hash when rc file is missing' do
+      FileUtils.rm(RC_PATH) if File.exist?(RC_PATH)
+      Settings.read.must_equal({})
+    end
+
+    it 'must parse options correctly for valid rc file' do
+      IO.write(RC_PATH, "access_token=x\noldpwd=y\nbogus=z\nnonsense\n")
+      suppress_warnings do
+        Settings.read.must_equal(access_token: 'x', oldpwd: 'y')
+      end
+    end
+
+    it 'must restore identical settings from previous save' do
+      hash = { access_token: 'x', oldpwd: 'y' }
+      hash.each { |key, value| Settings[key] = value }
+      Settings.save.must_be_nil
+      hash.each_key { |key| Settings.delete(key) }
+      Settings.read.must_equal hash
+    end
+  end
 end

data/spec/state_spec.rb

@@ -1,9 +1,15 @@
+require 'dropbox_sdk'
 require 'minitest/autorun'
 
-require_relative '../lib/droxi/state'
+require_relative 'testutils'
+require_relative '../lib/droxi/commands'
 require_relative '../lib/droxi/settings'
+require_relative '../lib/droxi/state'
 
 describe State do
+  client = DropboxClient.new(Settings[:access_token])
+  state = State.new(client)
+
   describe 'when initializing' do
     it 'must set pwd to root' do
       State.new(nil).pwd.must_equal '/'
@@ -18,7 +24,6 @@ describe State do
 
   describe 'when setting pwd' do
     it 'must change pwd and set oldpwd to previous pwd' do
-      state = State.new(nil)
       state.pwd = '/testing'
       state.pwd.must_equal '/testing'
       state.pwd = '/'
@@ -27,8 +32,6 @@ describe State do
   end
 
   describe 'when resolving path' do
-    state = State.new(nil)
-
     it 'must resolve root to itself' do
       state.resolve_path('/').must_equal '/'
     end
@@ -56,44 +59,69 @@ describe State do
 
   describe 'when forgetting directory contents' do
     before do
-      @state = State.new(nil)
-      ['/', '/dir'].each { |dir| @state.cache[dir] = { 'contents' => nil } }
-      2.times { |i| @state.cache["/dir/file#{i}"] = {} }
+      state.cache.add('path' => '/', 'contents' => [], 'is_dir' => true)
+      state.cache.add('path' => '/dir', 'contents' => [], 'is_dir' => true)
+      2.times { |i| state.cache.add('path' => "/dir/file#{i}") }
     end
 
     it 'must yield an error for a bogus path' do
-      lines = []
-      @state.forget_contents('bogus') { |line| lines << line }
-      lines.length.must_equal 1
+      TestUtils.output_of(state, :forget_contents, 'bogus').length.must_equal 1
     end
 
     it 'must yield an error for a non-directory path' do
-      lines = []
-      @state.forget_contents('/dir/file0') { |line| lines << line }
-      lines.length.must_equal 1
+      TestUtils.output_of(state, :forget_contents, '/dir/file0')
+        .length.must_equal 1
     end
 
     it 'must yield an error for an already forgotten path' do
-      lines = []
-      @state.forget_contents('dir')
-      @state.forget_contents('dir') { |line| lines << line }
-      lines.length.must_equal 1
+      state.forget_contents('/dir')
+      TestUtils.output_of(state, :forget_contents, '/dir')
+        .length.must_equal 1
     end
 
     it 'must forget contents of given directory' do
-      @state.forget_contents('dir')
-      @state.cache['/dir'].include?('contents').must_equal false
-      @state.cache.keys.any? do |key|
+      state.forget_contents('/dir')
+      state.cache['/dir'].include?('contents').must_equal false
+      state.cache.keys.any? do |key|
         key.start_with?('/dir/')
       end.must_equal false
     end
 
     it 'must forget contents of subdirectories' do
-      @state.forget_contents('/')
-      @state.cache['/'].include?('contents').must_equal false
-      @state.cache.keys.any? do |key|
+      state.forget_contents('/')
+      state.cache['/'].include?('contents').must_equal false
+      state.cache.keys.any? do |key|
         key.length > 1
       end.must_equal false
     end
   end
+
+  describe 'when querying metadata' do
+    it 'must return metadata for a valid path' do
+      state.metadata('/testing').must_be_instance_of Hash
+    end
+
+    it 'must return nil for an invalid path' do
+      state.metadata('/bogus').must_be_nil
+    end
+  end
+
+  describe 'when expanding patterns' do
+    before do
+      TestUtils.exact_structure(client, state, 'sub1', 'sub2')
+      state.pwd = '/testing'
+    end
+
+    it 'must not preserve relative paths by default' do
+      state.expand_patterns(['*1']).must_equal ['/testing/sub1']
+    end
+
+    it 'must preserve relative paths if requested' do
+      state.expand_patterns(['*2'], true).must_equal ['sub2']
+    end
+
+    it 'must return GlobErrors for non-matches' do
+      state.expand_patterns(['*3']).must_equal [GlobError.new('*3')]
+    end
+  end
 end

data/spec/testutils.rb

@@ -0,0 +1,65 @@
+require_relative '../lib/droxi/commands'
+
+# Module of helper methods for testing.
+module TestUtils
+  # The remote directory under which all test-related file manipulation should
+  # take place.
+  TEST_ROOT = '/testing'
+
+  # Run the attached block, rescuing the given +Exception+ class.
+  def self.ignore(error_class)
+    yield
+  rescue error_class
+    nil
+  end
+
+  # Call the method on the reciever with the given args and return an +Array+
+  # of lines of output from the method.
+  def self.output_of(receiver, method, *args)
+    lines = []
+    receiver.send(method, *args) { |line| lines << line }
+    lines
+  end
+
+  # Ensure that the remote directory structure under +TEST_ROOT+ contains the
+  # given +Array+ of paths.
+  def self.structure(client, state, *paths)
+    paths.map { |path| "#{TEST_ROOT}/#{path}" }.each do |path|
+      next if state.metadata(path)
+      if File.extname(path).empty?
+        Commands::MKDIR.exec(client, state, path)
+      else
+        put_temp_file(client, state, path)
+      end
+    end
+  end
+
+  # Ensure that the given remote paths under +TEST_ROOT+ do NOT exist.
+  def self.not_structure(client, state, *paths)
+    paths.map! { |path| "#{TEST_ROOT}/#{path}" }
+    dead_paths = state.contents(TEST_ROOT).select { |p| paths.include?(p) }
+    return if dead_paths.empty?
+    Commands::RM.exec(client, state, *dead_paths)
+  end
+
+  # Ensure that the remote directory structure under +TEST_ROOT+ exactly
+  # matches the given +Array+ of paths.
+  def self.exact_structure(client, state, *paths)
+    structure(client, state, *paths)
+    paths.map! { |path| "#{TEST_ROOT}/#{path}" }
+    dead_paths = state.contents(TEST_ROOT).reject { |p| paths.include?(p) }
+    return if dead_paths.empty?
+    Commands::RM.exec(client, state, *dead_paths)
+  end
+
+  private
+
+  # Creates a remote file at the given path.
+  def self.put_temp_file(client, state, path)
+    `mkdir testing`
+    basename = File.basename(path)
+    `touch testing/#{basename}`
+    Commands::PUT.exec(client, state, "testing/#{basename}", path)
+    `rm -rf testing`
+  end
+end