apohllo-poliqarpr 0.0.2

data/README.txt

@@ -0,0 +1,69 @@
+= poliqarpr
+
+* http://github.com/apohllo/poliqarpr
+
+== DESCRIPTION:
+
+Poliqarpr is Ruby client for Poliqarp server.
+
+
+== FEATURES/PROBLEMS:
+
+* asynchronous communication is implemented in synchronous manner 
+* only partial implementation of server protocol
+
+== SYNOPSIS:
+
+Poliqarpr is Ruby client for Poliqarp corpus server (see
+http://poliqarp.sourceforge.net/), which is used to store large texts used in
+Natural Language Processing.
+ 
+
+== REQUIREMENTS:
+
+Poliqarp server (only C implementation http://poliqarp.sourceforge.net/)
+
+== INSTALL:
+ 
+You need RubyGems v. 1.2 
+
+* gem -v 
+* 1.2.0 #=> ok
+
+You need the github.com repository to be added to your sources list:
+
+* gem sources -a http://gems.github.com
+
+Then you can type:
+
+* sudo gem install apohllo-poliqarpr
+
+
+== LICENSE:
+ 
+(The MIT License)
+
+Copyright (c) 2008 Aleksander Pohl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== FEEDBACK
+
+* mailto:apohllo@o2.pl

data/Rakefile

@@ -0,0 +1,23 @@
+task :default => [:install]
+
+$gem_name = "poliqarpr"
+
+desc "Build the gem"
+task :build do
+  sh "gem build #$gem_name.gemspec"
+end
+
+desc "Install the library at local machnie"
+task :install => :build do 
+  sh "sudo gem install #$gem_name -l"
+end
+
+desc "Uninstall the library from local machnie"
+task :uninstall do
+  sh "sudo gem uninstall #$gem_name"
+end
+
+desc "Clean"
+task :clean do
+  sh "rm #$gem_name*.gem" 
+end

data/changelog.txt

@@ -0,0 +1,15 @@
+0.0.2
+- query result is full blown class
+- source divided into client, excerpt and query resutl
+- specs for client, excerpt and query result
+- namespace changed to POLIQARP
+- default corpus included
+- singular results properly fatched
+- valid result for queries containing many words
+- same queries which are run in sequence are called only once
+- README.txt included in gem
+- specs included in gem
+
+0.0.1 
+- initiali implementation
+- synchorous querying for terms

data/corpus/frek.cdf

@@ -0,0 +1,4 @@
+version = 1
+endianness = little-endian
+indices = oda
+index-granularity = 1024

data/corpus/frek.cfg

@@ -0,0 +1,100 @@
+# Config file format for Oasis release
+# Config version 1.0
+
+# The new startup section may contain any command normally accepted by the shell
+
+[ALIASES]
+
+masc = m1|m2|m3
+verb = pact|ppas|winien|praet|bedzie|fin|impt|aglt|ger|imps|inf|pant|pcon
+noun = subst|depr|xxs|ger|ppron12|ppron3
+pron = ppron12|ppron3|siebie
+
+
+[ATTR]
+
+number			= sg pl
+case			= nom gen dat acc inst loc voc
+gender			= m1 m2 m3 f n
+person			= pri sec ter
+degree			= pos comp sup
+aspect			= imperf perf
+negation		= aff neg
+accommodability		= congr rec
+accentability		= akc nakc
+post-prepositionality	= npraep praep
+agglutination		= agl nagl
+vocalicity		= nwok wok
+
+# Parts of speech no longer need forward declarations, this was inconvenient and ugly.
+# Also, any attribute may be optional so a declaration such as:
+# foo = [bar] [froz] fred [wilma]
+# should no longer cause problems and ctags with such attributes now parse correctly regardless
+# of presence or absence of any optional attribute
+
+[POS]
+
+adja	=
+adjp	=
+conj	=
+interp	= 
+pred	=
+xxx	=
+adv	= degree
+imps	= aspect
+inf	= aspect
+pant	= aspect
+pcon	= aspect
+qub	= [vocalicity]
+prep	= case [vocalicity]
+siebie	= case
+subst	= number case gender
+depr	= number case gender
+xxs	= number case gender
+ger	= number case gender aspect negation
+ppron12	= number case gender person [accentability]
+ppron3	= number case gender person [accentability] [post-prepositionality]
+num	= number case gender [accommodability]
+adj	= number case gender degree
+pact	= number case gender aspect negation
+ppas	= number case gender aspect negation
+winien	= number gender aspect
+praet	= number gender aspect [agglutination]
+bedzie	= number person aspect
+fin	= number person aspect
+impt	= number person aspect
+aglt	= number person aspect vocalicity
+ign     =
+
+# Named entities replaced old 'special' attributes, name changed mostly because of
+# unification of 'named-thing' handling code into one named-entity thing
+# Entity aliasing allows for any existing entity to be seen under different name
+#
+# FCQP provides four builtin entities:
+#    entity-current
+#    entity-base
+#    entity-tag
+#    entity-pos
+
+[NAMED-ENTITY]
+
+entity-orth		= orth
+entity-base		= base
+entity-tag		= tag
+entity-pos		= pos
+
+# Old 'aliases' for attribute names
+
+pos			= flex
+number			= numb nmb
+case			= cas
+gender			= gnd gend
+person			= per pers
+degree			= deg degr
+aspect			= asp
+negation		= neg
+accommodability		= acco acom acm
+accentability		= acce acen acn
+post-prepositionality	= ppr ppre
+agglutination		= agg aggl
+vocalicity		= vcl

data/corpus/frek.cfg~

@@ -0,0 +1,100 @@
+# Config file format for Oasis release
+# Config version 1.0
+
+# The new startup section may contain any command normally accepted by the shell
+
+[STARTUP]
+
+/alias masc = m1 m2 m3
+/alias verb = pact ppas winien praet bedzie fin impt aglt ger imps inf pant pcon 
+/alias noun = subst depr xxs ger ppron12 ppron3
+/alias pron = ppron12 ppron3 siebie
+
+
+[ATTR]
+
+number			= sg pl
+case			= nom gen dat acc inst loc voc
+gender			= m1 m2 m3 f n
+person			= pri sec ter
+degree			= pos comp sup
+aspect			= imperf perf
+negation		= aff neg
+accommodability		= congr rec
+accentability		= akc nakc
+post-prepositionality	= npraep praep
+agglutination		= agl nagl
+vocalicity		= nwok wok
+
+# Parts of speech no longer need forward declarations, this was inconvenient and ugly.
+# Also, any attribute may be optional so a declaration such as:
+# foo = [bar] [froz] fred [wilma]
+# should no longer cause problems and ctags with such attributes now parse correctly regardless
+# of presence or absence of any optional attribute
+
+[POS]
+
+adja	=
+adjp	=
+conj	=
+interp	= 
+pred	=
+xxx	=
+adv	= degree
+imps	= aspect
+inf	= aspect
+pant	= aspect
+pcon	= aspect
+qub	= [vocalicity]
+prep	= case [vocalicity]
+siebie	= case
+subst	= number case gender
+depr	= number case gender
+xxs	= number case gender
+ger	= number case gender aspect negation
+ppron12	= number case gender person [accentability]
+ppron3	= number case gender person [accentability] [post-prepositionality]
+num	= number case gender [accommodability]
+adj	= number case gender degree
+pact	= number case gender aspect negation
+ppas	= number case gender aspect negation
+winien	= number gender aspect
+praet	= number gender aspect [agglutination]
+bedzie	= number person aspect
+fin	= number person aspect
+impt	= number person aspect
+aglt	= number person aspect vocalicity
+ign     =
+
+# Named entities replaced old 'special' attributes, name changed mostly because of
+# unification of 'named-thing' handling code into one named-entity thing
+# Entity aliasing allows for any existing entity to be seen under different name
+#
+# FCQP provides four builtin entities:
+#    entity-current
+#    entity-base
+#    entity-tag
+#    entity-pos
+
+[NAMED-ENTITY]
+
+entity-orth		= orth
+entity-base		= base
+entity-tag		= tag
+entity-pos		= pos
+
+# Old 'aliases' for attribute names
+
+pos			= flex
+number			= numb nmb
+case			= cas
+gender			= gnd gend
+person			= per pers
+degree			= deg degr
+aspect			= asp
+negation		= neg
+accommodability		= acco acom acm
+accentability		= acce acen acn
+post-prepositionality	= ppr ppre
+agglutination		= agg aggl
+vocalicity		= vcl

data/corpus/frek.meta.cfg

@@ -0,0 +1 @@
+S sample

data/corpus/frek.meta.lisp

@@ -0,0 +1,4 @@
+(single	"sample"
+        "/cesHeader/fileDesc/(sourceDesc/biblFull/)*sourceDesc/biblStruct/monogr/h.title")
+
+

data/lib/poliqarpr.rb

@@ -0,0 +1,5 @@
+path = File.join(File.dirname(__FILE__), 'poliqarpr')
+require File.join(path, 'client')
+require File.join(path, 'query_result')
+require File.join(path, 'excerpt')
+

data/lib/poliqarpr/client.rb

@@ -0,0 +1,272 @@
+module Poliqarp
+  class Client
+    DEFAULT_CORPUS = File.join(File.expand_path(File.dirname(__FILE__)),"..", "..", "corpus", "frek")
+    ERRORS = {
+      1 =>   "Incorrect number of arguments",
+      3 =>   "No session opened",
+      4 =>   "Cannot create a session for a connection that",
+      5 =>   "Not enough memory",
+      6 =>   "Invalid session ID",
+      7 =>   "Session with this ID is already bound",
+      8 =>   "Session user ID does not match the argument",
+      10 =>   "Session already has an open corpus",
+      12 =>   "System error while opening the corpus",
+      13 =>   "No corpus opened",
+      14 =>   "Invalid job ID",
+      15 =>   "A job is already in progress",
+      16 =>   "Incorrect query",
+      17 =>   "Invalid result range",
+      18 =>   "Incorrect session option",
+      19 =>   "Invalid session option value",
+      20 =>   "Invalid sorting criteria"
+    }
+    attr_writer :debug
+
+    def initialize(session_name="RUBY", debug=false)
+      @session_name = session_name
+      @left_context = 5
+      @right_context = 5
+      @debug = debug
+      @buffer_size = 500000
+      new_session
+    end
+
+    def new_session
+      close if @session
+      @socket = TCPSocket.new("localhost",4567)
+      talk "MAKE-SESSION #{@session_name}"
+      rcv_sync
+      talk("BUFFER-RESIZE #{@buffer_size}")
+      rcv_sync
+      @session = true
+      self.tags = {}
+      self.lemmata = {}
+    end
+
+    def talk(msg)
+      puts msg if @debug
+      @socket.puts(msg)
+    end
+
+    def close
+      #talk "CLOSE"
+      #rcv_sync
+      talk "CLOSE-SESSION" 
+      rcv_sync
+      #@socket.close
+      @session = false
+    end
+
+    def left_context=(value)
+      if value.is_a? Fixnum
+        talk "SET left-context-width #{value}" 
+        result = rcv_sync 
+        @left_context = value if result =~ /^R OK/
+      end
+    end
+
+    def right_context=(value)
+      if value.is_a? Fixnum
+        talk "SET right-context-width #{value}"     
+        result = rcv_sync 
+        @right_context = value if result =~ /^R OK/
+      end
+    end
+
+    def tags=(options={})
+      flags = ""
+      [:left_context_tags, :leftM_tags, 
+        :rightM_tags, :right_context_tags].each do |flag|
+        flags << (options[flag] ? "1" : "0")
+        end
+      talk "SET retrieve-tags #{flags}"
+      rcv_sync
+    end
+
+    def lemmata=(options={})
+      flags = ""
+      [:left_context_lemmata, :leftM_lemmata, 
+        :rightM_lemmata, :right_context_lemmata].each do |flag|
+        flags << (options[flag] ? "1" : "0")
+        end
+      talk "SET retrieve-lemmata #{flags}"
+      rcv_sync
+    end
+
+
+    def open_corpus(path)
+      if path == :default
+        open_corpus(DEFAULT_CORPUS)
+      else
+        talk("OPEN #{path}")
+        rcv_sync
+        rcv_async
+      end
+    end
+
+    def find(query,options={})
+      if options[:index]
+        find_one(query, options[:index])
+      else
+        find_many(query, options)
+      end
+    end
+
+    alias query find 
+
+    def count(query)
+      count_results(make_query(query)) 
+    end
+
+    def context(query,index)
+      make_query(query)
+      result = []
+      talk "GET-CONTEXT #{index}"
+      # R OK
+      rcv_sync
+      # 1st part
+      result << read_word 
+      # 2nd part
+      result << read_word 
+      # 3rd part
+      result << read_word 
+      # 4th part
+      result << read_word 
+      result
+    end
+
+    def metadata(query, index)
+      make_query(query)
+      result = {}
+      talk "METADATA #{index}"
+      count = rcv_sync.split(" ")[2].to_i
+      count.times do |index|
+        type = read_word.gsub(/[^a-zA-Z]/,"").to_sym
+        value = rcv_sync[4..-2]
+        unless value.nil?
+          result[type] ||= []
+          result[type] << value
+        end
+      end
+      result
+    end
+
+protected
+    def find_many(query, options)
+      page_size = (options[:page_size] || 0)
+      page_index = (options[:page_index] || 1)
+      answers = make_query(query)
+      #talk("GET-COLUMN-TYPES")
+      #rcv_sync
+      result_count = count_results(answers)
+      answer_offset = page_size * (page_index - 1)
+      if page_size > 0
+        answers_limit = answer_offset + page_size > result_count ?  
+          result_count - answer_offset : page_size
+      else
+        answers_limit = result_count
+      end
+      page_count = if page_size > 0
+                     result_count / page_size + (result_count % page_size > 0 ? 1 : 0)
+                   else
+                     1
+                   end
+      result = QueryResult.new(page_index, page_count,page_size,self,query)
+      if answers_limit > 0
+        talk("GET-RESULTS #{answer_offset} #{answer_offset + answers_limit - 1}") 
+        # R OK              1
+        rcv_sync
+
+        answers_limit.times do |answer_index|
+          result << fetch_result(answer_offset + answer_index, query)
+        end
+      end
+      result 
+    end
+
+    def find_one(query,index)
+      make_query(query)
+      talk("GET-RESULTS #{index} #{index}") 
+      # R OK              1
+      rcv_sync
+      fetch_result(index,query) 
+    end
+
+    # Fetches one result of the query
+    #
+    # MAKE-QUERY and GET-RESULTS must be called on server before 
+    # this method is called
+    def fetch_result(index, query)
+      result = Excerpt.new(index, self, query)
+      # left_context
+      result << read_segments
+      # matched query
+      result << read_segments
+      # right context
+      result << read_segments
+
+      result
+    end
+
+    def read_segments
+      answer = rcv_sync
+      size = answer.match(/\d+/)[0].to_i
+      segments = []
+      size.times do |segment_index|
+        segments << read_word
+      end
+      segments.join("")
+    end
+
+    def count_results(answer)
+      answer.split(" ")[2].to_i
+    end
+
+    def make_query(query)
+      if @last_query != query
+        @last_query = query
+        talk("MAKE-QUERY #{query}")
+        rcv_sync
+        talk("RUN-QUERY #{@buffer_size}")
+        @last_query_result = rcv_async
+      end
+      @last_query_result 
+    end
+
+    def read_word
+      rcv_sync[2..-2]
+    end
+
+    def read_line
+      line = ""
+      begin
+        chars = @socket.recvfrom(1)
+        line << chars[0]
+      end while chars[0] != "\n"
+      line
+    end
+
+    def error_message(line)
+      RuntimeError.new("Poliqarp Error: "+ERRORS[line.match(/\d+/)[0].to_i])
+    end
+
+    # XXX
+    def rcv_sync
+      result = read_line
+      puts result if @debug
+      raise error_message(result) if result =~ /^R ERR/
+      result
+      #    @socket.recvfrom(1024)
+    end
+
+    # XXX
+    def rcv_async
+      begin
+        line = read_line
+        raise error_message(line) if line =~ /^. ERR/
+        puts line if @debug
+      end until line =~ /^M/
+      line
+    end
+  end 
+end

data/lib/poliqarpr/excerpt.rb

@@ -0,0 +1,47 @@
+module Poliqarp
+  class Excerpt
+    attr_reader :index, :base_form, :short_context
+
+    def initialize(index, client, base_form)
+      @index = index
+      @client = client
+      @base_form = base_form
+      @short_context = []
+    end
+
+    def <<(value)
+      @short_context << value
+    end
+
+
+    def word
+      #@short_context[0].split(/\s+/)[-1]
+      @short_context[1].to_s
+    end
+
+    alias inflected_form word
+
+    def to_s
+      @short_context.join("")
+    end
+
+    def context
+      return @context unless @context.nil?
+      @context = @client.context(@base_form, @index)
+    end
+
+    { :medium => :medium, :style => :styl, :date => :data_wydania,
+      :city => :miejsce_wydania, :publisher => :wydawca, :title => :tytu,
+      :author => :autor}.each do |method, keyword|
+      define_method method do 
+        self.metadata[keyword]
+      end
+      end
+
+    protected
+    def metadata
+      return @metadata unless @metadata.nil?
+      @metadata = @client.metadata(@base_form, @index)
+    end
+  end
+end

data/lib/poliqarpr/query_result.rb

@@ -0,0 +1,59 @@
+module Poliqarp
+  class QueryResult
+    include Enumerable
+
+    attr_accessor :page, :page_count, :query, :page_size
+
+    def initialize(page, page_count, page_size, client, query)
+      @page = page
+      @page_count = page_count
+      @page_size = page_size
+      @client = client
+      @query = query
+      @excerpts = []
+    end
+
+    def <<(excerpt)
+      @excerpts << excerpt
+    end
+
+    def each
+      @excerpts.each{|e| yield e}
+    end
+
+    [:first, :last, :empty?].each do |method|
+      define_method method do
+        @excerpts.send(method)
+      end
+    end
+
+    def [](index)
+      @excerpts[index]
+    end
+
+    def ==(other)
+      return false unless other.is_a? QueryResult
+      @page == other.page && @page_count == other.page_count &&
+        @query == other.query && @page_size == other.page_size
+    end
+
+    def previous_page
+      if @page > 1
+        @client.find(@query, :page_size => @page_size, 
+                     :page_index => @page - 1) 
+      end
+    end
+
+    def next_page
+      if @page < @page_count
+        @client.find(@query, :page_size => @page_size, 
+                     :page_index => @page + 1) 
+      end
+    end
+
+    def size
+      @excerpts.size
+    end
+
+  end
+end

data/poliqarpr.gemspec

@@ -0,0 +1,63 @@
+#require 'rake'
+
+Gem::Specification.new do |s|
+  s.name = "poliqarpr"
+  s.version = "0.0.2"
+  s.date = "2008-12-15"
+  s.summary = "Ruby client for Poliqarp"
+  s.email = "apohllo@o2.pl"
+  s.homepage = "http://www.apohllo.pl/projekty/poliqarpr"
+  s.description = "Ruby client for Poliqarp (NLP corpus server)"
+  s.authors = ['Aleksander Pohl']
+  s.files = ["Rakefile", "poliqarpr.gemspec", 'lib/poliqarpr.rb',
+    "changelog.txt", 
+    "lib/poliqarpr/client.rb", 
+    "lib/poliqarpr/query_result.rb", 
+    "lib/poliqarpr/excerpt.rb", 
+    "README.txt",
+    "corpus/frek.cdf",
+    "corpus/frek.poliqarp.base1.image",
+    "corpus/frek.poliqarp.corpus.image",
+    "corpus/frek.poliqarp.meta-value.offset",
+    "corpus/frek.poliqarp.rindex.amb",
+    "corpus/frek.poliqarp.rindex.orth.offset",
+    "corpus/frek.poliqarp.subpos1.offset",
+    "corpus/frek.cfg",
+    "corpus/frek.poliqarp.base1.offset",
+    "corpus/frek.poliqarp.meta.image",
+    "corpus/frek.poliqarp.orth.image",
+    "corpus/frek.poliqarp.rindex.amb.offset",
+    "corpus/frek.poliqarp.subchunk.image",
+    "corpus/frek.poliqarp.subpos2.image",
+    "corpus/frek.cfg~",
+    "corpus/frek.poliqarp.base2.image",
+    "corpus/frek.poliqarp.meta-key.image",
+    "corpus/frek.poliqarp.orth.index.alpha",
+    "corpus/frek.poliqarp.rindex.disamb",
+    "corpus/frek.poliqarp.subchunk.item.ch",
+    "corpus/frek.poliqarp.subpos2.offset",
+    "corpus/frek.meta.cfg",
+    "corpus/frek.poliqarp.base2.offset",
+    "corpus/frek.poliqarp.meta-key.offset",
+    "corpus/frek.poliqarp.orth.index.atergo",
+    "corpus/frek.poliqarp.rindex.disamb.offset",
+    "corpus/frek.poliqarp.subchunk.offset",
+    "corpus/frek.poliqarp.tag.image",
+    "corpus/frek.meta.lisp",
+    "corpus/frek.poliqarp.chunk.image",
+    "corpus/frek.poliqarp.meta-value.image",
+    "corpus/frek.poliqarp.orth.offset",
+    "corpus/frek.poliqarp.rindex.orth",
+    "corpus/frek.poliqarp.subpos1.image",
+    "corpus/frek.poliqarp.tag.offset"
+  ]
+  s.test_files = [
+    "spec/client.rb",
+    "spec/query_result.rb",
+    "spec/excerpt.rb"
+  ]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.txt"]
+end
+

data/spec/client.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), '..','lib','poliqarpr')
+
+describe Poliqarp::Client do
+  describe "(general test)" do
+    before(:each) do
+      @client = Poliqarp::Client.new("TEST")
+    end
+    
+    after(:each) do 
+      @client.close
+    end
+  
+    it "should allow to open corpus" do
+      @client.open_corpus("/home/fox/local/poliqarp/2.sample.30/sample")
+    end
+  
+    it "should allow to open :default corpus" do
+      @client.open_corpus(:default)
+    end
+  end
+
+  describe "(with 'sample' corpus)" do
+    before(:all) do
+      @client = Poliqarp::Client.new("TEST")
+      @client.open_corpus("/home/fox/local/poliqarp/2.sample.30/sample")
+    end
+
+    after(:all) do
+      @client.close
+    end
+
+    it "should allow to find 'kot'" do 
+      @client.find("kot").size.should_not == 0
+    end
+
+    it "should contain 'kot' in query result for [base=kot]" do
+      @client.find("[base=kot]")[0].to_s.should match(/\bkot\b/)
+    end
+
+    it "should allow to find 'Afrodyta [] od" do
+      @client.find("Afrodyta [] od").size.should_not == 0
+    end
+
+    it "should contain 'Afrodyta .* od' for 'Afrodyta [] od' query " do
+      @client.find("Afrodyta [] od")[0].to_s.should match(/Afrodyta .* od/)
+    end
+
+    it "should return collection for find without index specified" do
+      @client.find("kot").should respond_to(:[])
+    end
+
+    it "should allow to query for term occurences" do
+      @client.count("kot").should_not == nil
+    end
+
+    it "should return 188 occurences of 'kot'" do
+      @client.count("kot").should == 188
+    end
+
+    it "should allow to find first occurence of 'kot'" do
+      @client.find("kot",:index => 0).should_not == nil
+    end
+
+    it "should return different results for different queries" do
+      @client.find("kot").should_not ==
+        @client.find("kita")
+    end
+
+    it "should return same results for same queries" do
+      @client.find("kita").should == @client.find("kita")
+    end
+
+    describe("(with index specified in find)") do
+      before(:each) do 
+        @result = @client.find("nachalny",:index => 0)
+      end
+
+      it "should not return collection for find" do
+        @result.should_not respond_to(:[])
+      end
+
+      it "should fetch the same excerpt as in find without index " do
+        @result.to_s.should == @client.find("nachalny")[0].to_s
+      end
+    end
+  end
+
+end

data/spec/excerpt.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), '..','lib','poliqarpr')
+
+describe Poliqarp::Excerpt do
+  before(:all) do
+    @client = Poliqarp::Client.new("TEST")
+  end
+
+  after(:all) do
+    @client.close
+  end
+
+  describe "(unspecified excerpt)" do
+    before(:all) do
+      @client.open_corpus(:default)
+      @excerpt = @client.find("kot").first
+    end
+
+    it "should have index" do
+      @excerpt.index.should_not == nil
+    end
+
+    it "should have base form" do 
+      @excerpt.base_form.should_not == nil
+    end
+
+    it "should allow to add short context" do
+      @excerpt << "abc"
+    end
+
+    it "should contain the exact form which it was created for" do
+      @excerpt.inflected_form.should_not == nil
+    end
+
+    it "should contain the long context of the word" do
+      @excerpt.context.should_not == nil
+    end
+  end
+
+  describe "(first exceprt for 'kot' in 'sample' corpus)" do
+    before(:all) do
+      @client.open_corpus("/home/fox/local/poliqarp/2.sample.30/sample")
+      @excerpt = @client.find("kot").first
+    end
+
+    it "should have index set to 0" do
+      @excerpt.index.should == 0 
+    end
+
+    it "should have base form set to 'kot'" do 
+      @excerpt.base_form.should == "kot"
+    end
+
+    it "should have 'kot' as inflected form  " do
+      @excerpt.inflected_form.should_not == nil
+    end
+
+    it "should contain the long context of the word" do
+      @excerpt.context.to_s.size.should >  10
+    end
+
+    it "should have one 'medium' set to 'książka'" do
+      @excerpt.medium.size.should == 1
+      @excerpt.medium[0].should == "książka"
+    end
+
+    it "should have 2 'styles' set to 'naukowo-dydaktyczny' and 'naukowo-humanistyczny'" do
+      @excerpt.style.size.should == 2
+      @excerpt.style.include?("naukowo-dydaktyczny")
+      @excerpt.style.include?("naukowo-humanistyczny")
+    end
+
+    it "should have 'date' set to nil" do
+      @excerpt.date.should == nil
+    end
+
+    it "should have 'city' set to nil" do
+      @excerpt.city.should == nil
+    end
+    
+    it "should have one 'publisher' set to 'Wydawnictwo Naukowe Akademii Pedagogicznej'" do
+      @excerpt.publisher.size.should == 1
+      @excerpt.publisher[0].should == "Wydawnictwo Naukowe Akademii Pedagogicznej"
+    end
+
+    it "should have one 'title' set to 'Wczesne nauczanie języków obcych. Integracja języka obcego z przedmiotami artystycznymi w młodszych klasach szkoły podstawowej'" do
+      @excerpt.title.size.should == 1
+      @excerpt.title[0].should == "Wczesne nauczanie języków obcych. Integracja języka obcego z przedmiotami artystycznymi w młodszych klasach szkoły podstawowej"
+    end
+
+    it "should have one 'author' set to 'Małgorzata Pamuła'" do
+      @excerpt.author.size.should == 1
+      @excerpt.author[0].should == "Małgorzata Pamuła"
+    end
+  end
+end

data/spec/query_result.rb

@@ -0,0 +1,134 @@
+require File.join(File.dirname(__FILE__), '..','lib','poliqarpr')
+
+describe Poliqarp::QueryResult do
+  before(:all) do
+    @client = Poliqarp::Client.new("TEST")
+    @client.open_corpus(:default)
+  end
+
+  after(:all) do
+    @client.close
+  end
+
+  describe "(for unspecified query)" do 
+    before(:all) do
+      @result = @client.find("kita")
+    end
+
+    it "should not be nil" do
+      @result.should_not == nil
+    end
+
+    it "should containt its size" do
+      @result.size.should_not == nil
+    end
+
+    it "should be iterable" do
+      @result.each do |excerpt|
+        excerpt.should_not == nil
+      end
+    end
+
+    it "should allow to add excerpt" do
+      @result << Poliqarp::Excerpt.new(0,@client, "abc")
+    end
+
+    it "should contain current page" do
+      @result.page.should_not == nil
+    end
+
+    it "should contain the page count" do
+      @result.page_count.should_not == nil
+    end
+
+    it "should allow to call previous page" do
+      @result.previous_page
+    end
+
+    it "should allow to call next page" do
+      @result.next_page
+    end
+
+    it "should be the same if the query is the same" do
+      @result.should == @client.find("kita")
+    end
+  end
+
+  describe "(for 'kot' in :default corpus)" do
+    before(:all) do 
+      @result = @client.find("kot")
+    end
+
+    it "should have size == 6" do 
+      @result.size.should == 6
+    end
+
+    it "should have page set to 1" do
+      @result.page.should == 1
+    end
+
+    it "should contain only one page" do
+      @result.page_count.should == 1
+    end
+
+    it "should not have previous page" do
+      @result.previous_page.should == nil
+    end
+
+    it "should not have next page" do
+      @result.next_page.should == nil
+    end
+  end
+
+  describe "(for 'kot' with page_size set to 5 in :default corpus)" do
+    before(:all) do 
+      @result = @client.find("kot", :page_size => 5)
+    end
+
+    it "should have size == 5" do  
+      @result.size.should == 5
+    end
+
+    it "should have page set to 1" do
+      @result.page.should == 1
+    end
+
+    it "should contain 2 pages" do
+      @result.page_count.should == 2
+    end
+
+    it "should not have previous page" do
+      @result.previous_page.should == nil
+    end
+
+    it "should have next page" do
+      @result.next_page.should_not == nil
+    end
+  end
+
+  describe "(next for 'kot' with page_size set to 5 in :default corpus)" do
+    before(:all) do 
+      @result = @client.find("kot", :page_size => 5).next_page
+    end
+
+    it "should have size == 1" do  
+      @result.size.should == 1
+    end
+
+    it "should have page set to 2" do
+      @result.page.should == 2
+    end
+
+    it "should contain 2 pages" do
+      @result.page_count.should == 2
+    end
+
+    it "should have previous page" do
+      @result.previous_page.should_not == nil
+    end
+
+    it "should not have next page" do
+      @result.next_page.should == nil
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: apohllo-poliqarpr
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Aleksander Pohl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-15 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Ruby client for Poliqarp (NLP corpus server)
+email: apohllo@o2.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- Rakefile
+- poliqarpr.gemspec
+- lib/poliqarpr.rb
+- changelog.txt
+- lib/poliqarpr/client.rb
+- lib/poliqarpr/query_result.rb
+- lib/poliqarpr/excerpt.rb
+- README.txt
+- corpus/frek.cdf
+- corpus/frek.poliqarp.base1.image
+- corpus/frek.poliqarp.corpus.image
+- corpus/frek.poliqarp.meta-value.offset
+- corpus/frek.poliqarp.rindex.amb
+- corpus/frek.poliqarp.rindex.orth.offset
+- corpus/frek.poliqarp.subpos1.offset
+- corpus/frek.cfg
+- corpus/frek.poliqarp.base1.offset
+- corpus/frek.poliqarp.meta.image
+- corpus/frek.poliqarp.orth.image
+- corpus/frek.poliqarp.rindex.amb.offset
+- corpus/frek.poliqarp.subchunk.image
+- corpus/frek.poliqarp.subpos2.image
+- corpus/frek.cfg~
+- corpus/frek.poliqarp.base2.image
+- corpus/frek.poliqarp.meta-key.image
+- corpus/frek.poliqarp.orth.index.alpha
+- corpus/frek.poliqarp.rindex.disamb
+- corpus/frek.poliqarp.subchunk.item.ch
+- corpus/frek.poliqarp.subpos2.offset
+- corpus/frek.meta.cfg
+- corpus/frek.poliqarp.base2.offset
+- corpus/frek.poliqarp.meta-key.offset
+- corpus/frek.poliqarp.orth.index.atergo
+- corpus/frek.poliqarp.rindex.disamb.offset
+- corpus/frek.poliqarp.subchunk.offset
+- corpus/frek.poliqarp.tag.image
+- corpus/frek.meta.lisp
+- corpus/frek.poliqarp.chunk.image
+- corpus/frek.poliqarp.meta-value.image
+- corpus/frek.poliqarp.orth.offset
+- corpus/frek.poliqarp.rindex.orth
+- corpus/frek.poliqarp.subpos1.image
+- corpus/frek.poliqarp.tag.offset
+has_rdoc: true
+homepage: http://www.apohllo.pl/projekty/poliqarpr
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby client for Poliqarp
+test_files: 
+- spec/client.rb
+- spec/query_result.rb
+- spec/excerpt.rb