picky-client 2.1.2 → 2.2.0

data/lib/picky-client/aux/terminal.rb

@@ -0,0 +1,225 @@
+module Picky
+
+  # A simple terminal based search.
+  #
+  class Terminal
+
+    attr_reader :client
+
+    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
+    end
+    def check_highline_gem # :nodoc:
+      require "highline/system_extensions"
+      extend HighLine::SystemExtensions
+    rescue LoadError
+      warn_gem_missing 'highline', 'the terminal interface'
+      exit 1
+    end
+    def check_picky_client_gem # :nodoc:
+      require 'picky-client'
+    rescue LoadError
+      warn_gem_missing 'picky-client', 'the terminal interface'
+      exit 1
+    end
+
+    # Install the Ctrl-C handler.
+    #
+    def install_trap
+      Signal.trap('INT') do
+        print "\e[100D"
+        flush
+        puts "\n"
+        puts "You performed #{@searches} searches, totalling #{"%.3f" % @durations} seconds."
+        print "\e[100D"
+        flush
+        exit
+      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
+        right relative
+      else
+        left relative
+      end
+      @cursor_offset = position
+      flush
+    end
+
+    # Delete one character.
+    #
+    def backspace
+      chop_text
+      print "\e[1D \e[1D"
+      flush
+    end
+
+    # Write the text to the input area.
+    #
+    def write 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
+      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 12 + @current_text.size
+    end
+
+    # Write the result ids.
+    #
+    def write_ids results
+      move_to_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 @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 ? @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
+
+      log results
+
+      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 #{@id_amount} result ids."
+      puts "Break with Ctrl-C."
+
+      search_and_write
+
+      loop do
+        input = get_character
+
+        case input
+        when 127
+          backspace
+          search_and_write
+        when 13
+          search_and_write true
+        else # All other.
+          type_search input.chr
+          search_and_write
+        end
+      end
+    end
+
+  end
+
+end

data/spec/picky-client/aux/terminal_spec.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# We need to load the Statistics file explicitly as the Statistics
+# are not loaded with the Loader (not needed in the server, only for script runs).
+#
+require File.expand_path '../../../../lib/picky-client/aux/terminal', __FILE__
+
+describe Picky::Terminal do
+  
+  let(:terminal) { described_class.new('/some/url') }
+  
+  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
+    it 'moves by amount' do
+      terminal.should_receive(:print).once.ordered.with "\e[13D"
+      terminal.should_receive(:flush).once.ordered
+      
+      terminal.left 13
+    end
+    it 'default is 1' do
+      terminal.should_receive(:print).once.ordered.with "\e[1D"
+      terminal.should_receive(:flush).once.ordered
+      
+      terminal.left
+    end
+  end
+  
+  describe 'right' do
+    it 'moves by amount' do
+      terminal.should_receive(:print).once.ordered.with "\e[13C"
+      terminal.should_receive(:flush).once.ordered
+      
+      terminal.right 13
+    end
+    it 'default is 1' do
+      terminal.should_receive(:print).once.ordered.with "\e[1C"
+      terminal.should_receive(:flush).once.ordered
+      
+      terminal.right
+    end
+  end
+  
+  describe 'flush' do
+    it 'flushes STDOUT' do
+      STDOUT.should_receive(:flush).once.with()
+      
+      terminal.flush
+    end
+  end
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: picky-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 +10:00
+date: 2011-04-14 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- lib/picky-client/aux/terminal.rb
 - lib/picky-client/client.rb
 - lib/picky-client/convenience.rb
 - lib/picky-client/helper.rb
@@ -45,6 +46,7 @@ files:
 - javascripts/jquery-1.5.0.min.js
 - javascripts/picky.min.js
 - README.rdoc
+- spec/picky-client/aux/terminal_spec.rb
 - spec/picky-client/client_spec.rb
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/helper_spec.rb
@@ -77,6 +79,7 @@ signing_key:
 specification_version: 3
 summary: picky Ruby Search Engine Client
 test_files: 
+- spec/picky-client/aux/terminal_spec.rb
 - spec/picky-client/client_spec.rb
 - spec/picky-client/convenience_spec.rb
 - spec/picky-client/helper_spec.rb