poliqarpr 0.1.1 → 0.1.6

data/changelog.txt

@@ -1,3 +1,16 @@
+0.1.5
+- Raises exception if failed to open corpus
+- New PoliqarpException class as a base for all Poliqarp exception
+
+0.1.4
+- The logger data is automatically flushed.
+
+0.1.3
+- Alternative logger for debug
+
+0.1.2
+- IndexOutOfBounds includes info about index
+
 0.1.1
 - remove messy debug message
 - raise IndexOutOfBounds exception when the excerpt index is larger than the

data/lib/poliqarpr/client.rb

@@ -6,9 +6,12 @@ module Poliqarp
   # This class is the implementation of the Poliqarp server client.
   class Client
     # If debug is turned on, the communication between server and client
-    # is logged to standard output.
+    # is logged to logger.
     attr_writer :debug
 
+    # Logger used for debugging. STDOUT by default.
+    attr_accessor :logger
+
     # The configuration of the client.
     attr_reader :config
 
@@ -21,7 +24,8 @@ module Poliqarp
     def initialize(session_name="RUBY", debug=false)
       @session_name = session_name
       @debug = debug
-      @connector = Connector.new(debug)
+      @logger = STDOUT
+      @connector = Connector.new(self)
       @config = Config.new(self,500000)
       @answer_queue = Queue.new
       @waiting_mutext = Mutex.new
@@ -64,6 +68,19 @@ module Poliqarp
       talk "CLOSE"
     end
 
+    # Prints the debug +msg+ to the logger if debugging is turned on.
+    # Accepts both regular message and block with message. The second
+    # form is provided for messages which aren't cheep to build.
+    def debug(msg=nil)
+      if @debug
+        if block_given?
+          msg = yield
+        end
+        logger.puts msg
+        logger.flush
+      end
+    end
+
     # *Asynchronous* Opens the corpus given as +path+. To open the default
     # corpus pass +:default+ as the argument.
     #
@@ -73,7 +90,12 @@ module Poliqarp
       if path == :default
         open_corpus(DEFAULT_CORPUS, &handler)
       else
-        talk("OPEN #{path}", :async, &handler)
+        result = talk("OPEN #{path}", :async, &handler)
+        if result == "OPENED"
+          result
+        else
+          raise PoliqarpException.new(result)
+        end
       end
     end
 
@@ -210,7 +232,7 @@ protected
     def left_context=(value)
       result = talk("SET left-context-width #{value}")
       unless result =~ /^OK/
-        raise "Failed to set left context to #{value}: #{result}"
+        raise PoliqarpException.new("Failed to set left context to #{value}: #{result}")
       end
     end
 
@@ -218,7 +240,7 @@ protected
     def right_context=(value)
       result = talk("SET right-context-width #{value}")
       unless result =~ /^OK/
-        raise "Failed to set right context to #{value}: #{result}"
+        raise PoliqarpException.new("Failed to set right context to #{value}: #{result}")
       end
     end
 
@@ -241,7 +263,6 @@ protected
     # * +handler+ the handler of the assynchronous message.
     #   It is ignored when the mode is set to :sync.
     def talk(msg, mode = :sync, &handler)
-      puts msg if @debug
       if mode == :sync
         @connector.send_message(msg, mode, &handler)
       else
@@ -297,6 +318,10 @@ protected
     # * +index+ the index of the answer to be retrieved
     def find_one(query,index)
       make_async_query(query,index)
+      loop do
+        break unless should_wait?
+        sleep 0.01
+      end
       talk("GET-RESULTS #{index} #{index}")
       fetch_result(index,query)
     end
@@ -383,7 +408,7 @@ protected
     def do_wait
       loop {
         break unless should_wait?
-        puts "WAITING" if @debug
+        debug("WAITING")
         sleep 0.1
       }
       @answer_queue.shift
@@ -394,7 +419,7 @@ protected
       @waiting_mutext.synchronize {
         @should_wait = false
       }
-      puts "WAITING stopped" if @debug
+      debug("WAITING stopped")
     end
 
     # Check if the thread should still wait for the answer.
@@ -411,11 +436,11 @@ protected
       @waiting_mutext.synchronize {
         @should_wait = true
       }
-      puts "WAITING started" if @debug
+      debug("WAITING started")
     end
 
     def make_async_query(query,answer_offset)
-      raise IndexOutOfBounds if answer_offset > config.buffer_size
+      raise IndexOutOfBounds.new(answer_offset) if answer_offset > config.buffer_size
       start_waiting
       # we access the result count through BUFFER-STATE call
       make_query(query){|msg| stop_waiting}

data/lib/poliqarpr/config.rb

@@ -25,7 +25,7 @@ module Poliqarp
         @client.send(:left_context=,value)
         @left_context_size = value
       else
-        raise "Invalid argument: #{value}. It must be fixnum greater than 0."
+        raise PoliqarpException.new("Invalid argument: #{value}. It must be fixnum greater than 0.")
       end
     end
 
@@ -39,7 +39,7 @@ module Poliqarp
         @client.send(:right_context=,value)
         @right_context_size = value
       else
-        raise "Invalid argument: #{value}. It must be fixnum greater than 0."
+        raise PoliqarpException.new("Invalid argument: #{value}. It must be fixnum greater than 0.")
       end
     end
 

data/lib/poliqarpr/connector.rb

@@ -37,11 +37,11 @@ module Poliqarp
     UTF8 = "utf-8"
 
     # Creates new connector
-    def initialize(debug)
+    def initialize(client)
       @message_queue = Queue.new
       @socket_mutex = Mutex.new
       @loop_mutex = Mutex.new
-      @debug = debug
+      @client = client
     end
 
     # Opens connection with poliqarp server which runs
@@ -66,7 +66,7 @@ module Poliqarp
     # * +mode+ synchronous (+:sync:) or asynchronous (+:async+)
     # * +handler+ the handler of the asynchronous message
     def send_message(message, mode, &handler)
-      puts "send #{mode} #{message}" if @debug
+      @client.debug{"send #{mode} #{message}"}
       if ruby19?
         massage = message.encode(UTF8)
       end
@@ -87,10 +87,8 @@ module Poliqarp
         case code
         when 15
           raise JobInProgress.new()
-        when 17
-          raise IndexOutOfBounds.new()
         else
-          raise RuntimeError.new("Poliqarp Error: "+ERRORS[code])
+          raise PoliqarpException.new("Poliqarp Error: "+ERRORS[code])
         end
       else
         message
@@ -123,12 +121,12 @@ private
     end
 
     def receive_sync(message)
-      puts "receive sync: #{message}" if @debug
+      @client.debug{"receive sync: #{message}"}
       @message_queue << message
     end
 
     def receive_async(message)
-      puts "receive async: #{message}" if @debug
+      @client.debug{"receive async: #{message}"}
       Thread.new{
         @handler.call(message)
       }

data/lib/poliqarpr/exceptions.rb

@@ -1,13 +1,25 @@
 module Poliqarp
   # Author:: Aleksander Pohl (mailto:apohllo@o2.pl)
   # License:: MIT License
+  
+  # Base for all poliqarp exceptions.
+  class PoliqarpException < Exception; end
 
   # The JobInProgress exception is raised if there was asynchronous call
   # to the server which haven't finished, which is interrupted by another
   # asynchronous call.
-  class JobInProgress < Exception; end
+  class JobInProgress < PoliqarpException; end
 
   # The IndexOutOfBounds exception is raised if the index of given excerpt
   # is larger than the size of query buffer.
-  class IndexOutOfBounds < Exception; end
+  class IndexOutOfBounds < PoliqarpException
+    def initialize(index)
+      super
+      @index = index
+    end
+
+    def to_s
+      "Poliqarp::IndexOutOfBounds(#{@index})"
+    end
+  end
 end

data/poliqarpr.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "poliqarpr"
-  s.version = "0.1.1"
+  s.version = "0.1.6"
   s.date = Time.now.strftime("%Y-%m-%d")
   s.summary = "Ruby client for Poliqarp"
   s.email = "apohllo@o2.pl"

data/spec/client.rb

@@ -28,6 +28,32 @@ describe Poliqarp::Client do
       @client.version.should_not == nil
     end
 
+    it "should work with debug turned on" do
+      @client.debug = true
+      (proc do 
+        @client.ping
+      end).should_not raise_error(Exception)
+    end
+
+    it "should work with alternative logger" do
+      logger = ""
+      def logger.puts(str)
+        self << str
+      end
+      def logger.flush
+      end
+      @client.debug = true
+      @client.logger = logger
+      @client.ping
+      logger.size.should > 0
+    end
+
+    it "should raise error if failed to open corpus" do
+      (proc do 
+        @client.open_corpus("")
+      end).should raise_error(Poliqarp::PoliqarpException)
+    end
+
   end
 
   describe "(with 'sample' corpus)" do
@@ -48,13 +74,13 @@ describe Poliqarp::Client do
     it "should raise error if the size of right context is not number" do
       (proc do
         @client.config.right_context_size = "a"
-      end).should raise_error(RuntimeError)
+      end).should raise_error(Poliqarp::PoliqarpException)
     end
 
     it "should rais error if the size of right context is less or equal 0" do
       (proc do
         @client.config.right_context_size = 0
-      end).should raise_error(RuntimeError)
+      end).should raise_error(Poliqarp::PoliqarpException)
     end
 
     it "should allow to set and get the left context size" do
@@ -65,13 +91,13 @@ describe Poliqarp::Client do
     it "should raise error if the size of left context is not number" do
       (lambda do
         @client.config.left_context_size = "a"
-      end).should raise_error(RuntimeError)
+      end).should raise_error(Poliqarp::PoliqarpException)
     end
 
     it "should rais error if the size of left context is less or equal 0" do
       (lambda do
         @client.config.left_context_size = 0
-      end).should raise_error(RuntimeError)
+      end).should raise_error(Poliqarp::PoliqarpException)
     end
 
     it "should return corpus statistics" do
@@ -147,11 +173,11 @@ describe Poliqarp::Client do
         @result.to_s.should == @client.find("nachalny")[0].to_s
       end
 
-      it "should raise IndexOutOfBounds if the index is larger than the results count" do
+      it "should raise poliqarp error if the index is larger than the results count" do
         count = @client.count("nachalny")
         (proc do
           @client.find("nachalny",:index => count+1)
-        end).should raise_error(Poliqarp::IndexOutOfBounds)
+        end).should raise_error(Poliqarp::PoliqarpException)
       end
 
       it "should raise IndexOutOfBounds error if the index is larger than the buffer size" do

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: poliqarpr
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  prerelease: 
+  version: 0.1.6
 platform: ruby
 authors: 
 - Aleksander Pohl
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-18 00:00:00 +01:00
+date: 2011-02-21 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -59,21 +55,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby client for Poliqarp