swishe 0.2 → 0.4.2

data/lib/swishe.rb

@@ -19,11 +19,15 @@ module SwishEWrapper
   alias swish_close SwishClose
   alias swish_query SwishQuery
   alias swish_next_result SwishNextResult
+  alias swish_seek_result SwishSeekResult
   alias swish_error SwishError
   alias swish_last_error_msg SwishLastErrorMsg
   alias swish_error_string SwishErrorString
   alias swish_result_property_str SwishResultPropertyStr
   alias swish_result_property_u_long SwishResultPropertyULong
+  alias new_search_object New_Search_Object
+  alias swish_execute SwishExecute
+  alias swish_set_sort SwishSetSort
 end
 
 
@@ -111,19 +115,50 @@ class SwishE
     swish_close(@handle)
   end
   
-  # Return an Array of Result instances. Raises SwishEError if the
-  def query(string)
+  # search is a replacement for the method _query_, which allows you to set parameters in a hash.
+  # Keys or the parameter hash are _query_, _start_, _limit_ and _order_. _query_ is the string you 
+  # are looking for, _start_ and _limit_ are the same as the command line parameters <tt>-b</tt> and <tt>-m</tt>
+  # and _order_ is the equivalent as the command line parameter <tt>-s</tt>. Example for the order are <tt>swishdocsize asc</tt>
+  # and <tt>swishrank desc</tt>. You see that you need to put the word "swish" in front of the properties.
+  def search(options)
+    raise(SwishEError, "No options given.") unless options
+    q = options["query"]
+    raise(SwishEError, "No query string given.") unless q
+    searchobject = new_search_object(@handle, q);
+    if options["order"]
+      swish_set_sort( searchobject,options["order"])
+    end
+    res = swish_execute(searchobject,q);
+    return query_internal(res,options["start"] || 1, options["limit"] || -1)
+  end
+  # Return an Array of Result instances. Raises SwischEError or IndexFileError in case
+  # of an error. _start_ is the result offset from the beginning (starting at 1, which is the default).
+  # _limit_ is the number of results returned, -1 indicates all results.
+  def query(string,start = 1,limit = -1, sort = nil )
+    # SW_SEARCH New_Search_Object(SW_HANDLE handle, const char *query);
+    # void SwishSetSort( SW_SEARCH srch, char *sort );
+    # void SwishSetQuery( SW_SEARCH srch, char *query );
     res=swish_query(@handle,string)
     check_error
+    return query_internal(res,start,limit)
+  end
+
+  private
+
+  def query_internal(res,start,count)
     results=[]
+    if start != 1
+      swish_seek_result(res,start - 1) # offset is 0
+    end
+    c = 0
     while result=swish_next_result(res)
       results << Result.new(result)
+      c = c + 1
+      if count == c then break end
     end
     return results
   end
 
-  private
-  
   def set_index(indexfile)
     @handle=swish_init indexfile
     check_error

data/test/tc_swishe.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require 'minitest'
+require "fileutils"
+
+$:.unshift  File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift  File.join(File.dirname(__FILE__), "..", "ext")
+
+# --pg: ./extconf.rb --with-swishe-dir=/opt/swishe/2.4.3
+
+require 'swishe'
+
+DIR=File.expand_path(File.dirname(__FILE__))
+IDX="#{DIR}/index.swish-e"
+
+class TestSwishe < Minitest::Test
+  def setup
+    unless File.exists?(IDX)
+      FileUtils::cd(DIR) do 
+        cmd="swish-e -c testcase.swishe"
+        puts "running `#{cmd}' for updating index"
+        system cmd
+      end
+    end
+    @sw=SwishE.new(IDX)
+  end
+  def test_single
+    res = @sw.query("another")
+    assert_equal(1,res.size)
+  end
+  def test_double
+    res = @sw.query("testing")
+    assert_equal(2,res.size)
+  end
+  def test_res_count
+    rcary=@sw.query("this").collect do |result|
+      result.reccount
+    end
+    assert_equal([1,2], rcary)
+  end
+  def test_offset
+    rcary=@sw.query("this",2).collect do |result|
+      result.reccount
+    end
+    assert_equal([2], rcary)
+  end
+
+  def test_limit
+    rcary=@sw.query("this",1,1).collect do |result|
+      result.reccount
+    end
+    assert_equal([1], rcary)
+  end
+
+  def test_limit_infinite
+    rcary=@sw.query("this",1,-1).collect do |result|
+      result.reccount
+    end
+    assert_equal([1,2], rcary)
+  end
+
+  def test_too_many
+    # this used to raise an exception: "Too many open files (SwishE::IndexFileError)"
+    1.upto(125) do
+      x=SwishE.new(IDX) 
+      x.close
+    end
+  end
+  
+  def test_search_no_options
+    assert_raise(SwishE::SwishEError) do
+      rcary=@sw.search(nil)
+    end
+  end
+  
+  def test_search
+    rcary=@sw.search({"query" => "this"})
+  end
+  
+  def test_search_order
+    results = @sw.search({"query" => "This is","order" => "swishdocsize asc"}).collect do |r| r.docpath end
+    assert_equal(results,["./idx/fileb.txt","./idx/filea.txt"])
+  end
+
+  def test_search_order_limit
+    results = @sw.search({"query" => "This is","order" => "swishdocsize asc","limit" => 1}).collect do |r| r.docpath end
+    assert_equal(results,["./idx/fileb.txt"])
+    results = @sw.search({"query" => "This is","order" => "swishdocsize asc","limit" => 1,"start" => 2}).collect do |r| r.docpath end
+    assert_equal(results,["./idx/filea.txt"])
+  end
+
+end

data/test/unittest.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'tc_swishe'

metadata

@@ -1,56 +1,65 @@
---- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
-specification_version: 1
+--- !ruby/object:Gem::Specification
 name: swishe
-version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2007-03-28 00:00:00 +02:00
-summary: Ruby bindings for swish-e.
-require_paths: 
-- lib
-email: patrick@gundla.ch
-homepage: http://rubyforge.org/projects/swishe/
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+version: !ruby/object:Gem::Version
+  version: 0.4.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
-authors: 
+authors:
 - Patrick Gundlach
-files: 
+- Neil Spring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper around libswish, a text indexing system.
+email:
+- nspring@cs.umd.edu
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
 - lib/swishe.rb
+- ext/swish-e.i
 - ext/swishe_base.c
 - ext/extconf.rb
-- ext/MANIFEST
 - setup.rb
-- README
+- test/tc_swishe.rb
+- test/unittest.rb
+- README.md
 - MIT-LICENSE
-test_files: []
-
-rdoc_options: 
+homepage: https://github.com/nspring/swish-e-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
 - --main
-- README
+- README.md
 - --title
 - swish-e ruby bindings documentation
-extra_rdoc_files: 
-- README
-- MIT-LICENSE
-executables: []
-
-extensions: 
-- ext/extconf.rb
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for swish-e.
+test_files:
+- test/tc_swishe.rb
+- test/unittest.rb
+has_rdoc: 

data/ext/MANIFEST

@@ -1,3 +0,0 @@
-extconf.rb
-swish-e.i
-swishe_base.c