picky 2.1.1 → 2.1.2

data/lib/picky/auxiliary/terminal.rb

@@ -2,21 +2,31 @@ class Terminal
 
   attr_reader :client
 
-  def initialize given_uri
+  def initialize given_uri, id_amount = nil
     check_highline_gem
     check_picky_client_gem
 
     require 'uri'
     uri = URI.parse given_uri
+
+    # If the user gave a whole url without http, add that and reparse.
+    #
     unless uri.path
       uri = URI.parse "http://#{given_uri}"
     end
+
+    # If the user gave a path without / in front, add one.
+    #
     unless uri.path =~ /^\//
       uri.path = "/#{uri.path}"
     end
 
     @searches  = 0
     @durations = 0
+    @current_text  = ''
+    @cursor_offset = 0
+    @last_ids      = ''
+    @id_amount     = id_amount && Integer(id_amount) || 20
     @client = Picky::Client.new :host => (uri.host || 'localhost'), :port => (uri.port || 8080), :path => uri.path
 
     install_trap
@@ -35,6 +45,8 @@ class Terminal
     exit 1
   end
 
+  # Install the Ctrl-C handler.
+  #
   def install_trap
     Signal.trap('INT') do
       print "\e[100D"
@@ -47,17 +59,28 @@ class Terminal
     end
   end
 
+  # Flush to STDOUT.
+  #
   def flush
     STDOUT.flush
   end
+
+  # Position cursor amount to the left.
+  #
   def left amount = 1
     print "\e[#{amount}D"
     flush
   end
+
+  # Position cursor amount to the right.
+  #
   def right amount = 1
     print "\e[#{amount}C"
     flush
   end
+
+  # Move cursor to position.
+  #
   def move_to position
     relative = position - @cursor_offset
     if relative > 0
@@ -68,45 +91,90 @@ class Terminal
     @cursor_offset = position
     flush
   end
+
+  # Delete one character.
+  #
   def backspace
-    @current_text.chop!
-    print "\e[1D"
-    print " "
-    print "\e[1D"
+    chop_text
+    print "\e[1D \e[1D"
     flush
   end
+
+  # Write the text to the input area.
+  #
   def write text
-    print text
     @cursor_offset += text.size
+    print text
     flush
   end
+
+  # Chop off one character.
+  #
+  def chop_text
+    @current_text.chop!
+  end
+
+  # Add the given text to the current text.
+  #
+  def add_text text
+    @current_text << text
+  end
+
+  # Type the given text into the input area.
+  #
   def type_search character
-    @current_text << character
+    add_text character
     write character
   end
+
+  # Write the amount of result ids.
+  #
   def write_results results
     move_to 0
     write "%9d" % (results && results.total || 0)
     move_to 10 + @current_text.size
   end
+
+  # Move to the id area.
+  #
   def move_to_ids
-    move_to 10 + @current_text.size + 2
+    move_to 12 + @current_text.size
   end
+
+  # Write the result ids.
+  #
   def write_ids results
     move_to_ids
-    write "=> #{results.total ? results.ids : []}"
+    write "=> #{results.total ? results.ids(@id_amount) : []}"
+  rescue StandardError => e
+    p e.message
+    p e.backtrace
   end
+
+  # Clear the result ids.
+  #
   def clear_ids
     move_to_ids
-    write " "*200
+    write @ids_clearing_string ||= " "*200
   end
+
+  # Log a search.
+  #
   def log results
     @searches += 1
     @durations += (results[:duration] || 0)
   end
+
+  # Perform a search.
+  #
   def search full = false
-    client.search @current_text, :ids => (full ? 20 : 0)
+    client.search @current_text, :ids => (full ? @id_amount : 0)
   end
+
+  # Perform a search and write the results.
+  #
+  # Handles 404s and connection problems.
+  #
   def search_and_write full = false
     results = search full
     results.extend Picky::Convenience
@@ -116,16 +184,20 @@ class Terminal
     full ? write_ids(results) : clear_ids
 
     write_results results
+  rescue Errno::ECONNREFUSED => e
+    write "Please start a Picky server listening to #{@client.path}."
+  rescue Yajl::ParseError => e
+    write "Got a 404. Maybe the path #{@client.path} isn't a correct one?"
   end
 
+  # Run the terminal.
+  #
+  # Note: Uses a simple loop to handle input.
+  #
   def run
-    puts "Type and see the result count update. Press enter for the first 20 result ids."
+    puts "Type and see the result count update. Press enter for the first #{@id_amount} result ids."
     puts "Break with Ctrl-C."
 
-    @current_text  = ''
-    @cursor_offset = 0
-    @last_ids      = ''
-    move_to 10
     search_and_write
 
     loop do
@@ -137,7 +209,7 @@ class Terminal
         search_and_write
       when 13
         search_and_write true
-      else
+      else # All other.
         type_search input.chr
         search_and_write
       end

data/lib/tasks/routes.rake

@@ -1,6 +1,6 @@
 # Routing tasks.
 #
-desc "Shows the available URL paths"
+desc "Shows the available URL paths."
 task :routes => :application do
   Application.apps.each do |app|
     puts app.to_routes

data/lib/tasks/search.rake

@@ -1,7 +1,10 @@
 # Tasks for testing your engine configuration in the terminal.
 #
+desc 'Simple terminal search - pass it an URL to search on, e.g. /books.'
 task :search do
   load File.expand_path '../../picky/auxiliary/terminal.rb', __FILE__
-  terminal = Terminal.new ARGV[1] || raise("Usage:\n  rake search <URL>\n  E.g. rake search /books\n       rake search localhost:8080/books")
+  url_or_path = ARGV[1] || raise("Usage:\n  rake search <URL> [<result ids>]\n  E.g. rake search /books\n       rake search localhost:8080/books 10")
+  ids         = ARGV[2]
+  terminal = Terminal.new url_or_path, ids
   terminal.run
 end

data/spec/lib/auxiliary/terminal_spec.rb

@@ -11,8 +11,102 @@ describe Terminal do
   
   let(:terminal) { described_class.new('/some/url') }
   
-  before(:each) do
-    terminal.stub! :search => { :total => 0, :duration => 0.01 }
+  describe 'backspace' do
+    it 'works correctly' do
+      terminal.should_receive(:chop_text).once.ordered.with()
+      terminal.should_receive(:print).once.ordered.with "\e[1D \e[1D"
+      terminal.should_receive(:flush).once.ordered.with()
+      
+      terminal.backspace
+    end
+  end
+  
+  describe 'write_results' do
+    it 'works correctly' do
+      terminal.should_receive(:move_to).once.ordered.with 0
+      terminal.should_receive(:write).once.ordered.with "        0"
+      terminal.should_receive(:move_to).once.ordered.with 10
+      
+      terminal.write_results nil
+    end
+    it 'works correctly' do
+      terminal.should_receive(:move_to).once.ordered.with 0
+      terminal.should_receive(:write).once.ordered.with "123456789"
+      terminal.should_receive(:move_to).once.ordered.with 10
+      
+      terminal.write_results stub(:results, :total => 123456789)
+    end
+  end
+  
+  describe 'search' do
+    before(:each) do
+      @client = stub :client
+      terminal.stub! :client => @client
+      
+      terminal.add_text 'hello'
+    end
+    it 'searches full correctly' do
+      @client.should_receive(:search).once.with 'hello', :ids => 20
+      
+      terminal.search true
+    end
+    it 'searches full correctly' do
+      terminal = described_class.new('/some/url', 33)
+      terminal.stub! :client => @client
+      
+      @client.should_receive(:search).once.with '', :ids => 33
+      
+      terminal.search true
+    end
+    it 'searches live correctly' do
+      @client.should_receive(:search).once.with 'hello', :ids => 0
+      
+      terminal.search
+    end
+    it 'searches live correctly' do
+      @client.should_receive(:search).once.with 'hello', :ids => 0
+      
+      terminal.search false
+    end
+  end
+  
+  describe 'clear_ids' do
+    it 'moves to the ids, then clears all' do
+      terminal.should_receive(:move_to_ids).once.with()
+      terminal.should_receive(:write).once.with " "*200
+      
+      terminal.clear_ids
+    end
+  end
+  
+  describe 'write_ids' do
+    it 'writes the result\'s ids' do
+      terminal.should_receive(:move_to_ids).once.with()
+      terminal.should_receive(:write).once.with "=> []"
+      
+      terminal.write_ids stub(:results, :total => nil)
+    end
+    it 'writes the result\'s ids' do
+      terminal.should_receive(:move_to_ids).once.with()
+      terminal.should_receive(:write).once.with "=> [1, 2, 3]"
+      
+      terminal.write_ids stub(:results, :total => 3, :ids => [1, 2, 3])
+    end
+  end
+  
+  describe 'move_to_ids' do
+    it 'moves to a specific place' do
+      terminal.should_receive(:move_to).once.with 12
+      
+      terminal.move_to_ids
+    end
+    it 'moves to a specific place' do
+      terminal.add_text 'test'
+      
+      terminal.should_receive(:move_to).once.with 16
+      
+      terminal.move_to_ids
+    end
   end
   
   describe 'left' do

metadata

@@ -2,7 +2,7 @@
 name: picky
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors: 
 - Florian Hanke