pms 0.0.1

data/lib/pms/version.rb

@@ -0,0 +1,27 @@
+class PMS
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end

data/spec/pms/ext_spec.rb

@@ -0,0 +1,70 @@
+require 'pms/ext'
+
+shared_examples_for 'any Searchable' do
+
+  before :each do
+    @args ||= []
+  end
+
+  it 'should be searchable by a String' do
+    @searchable.search(*@args << 'fox').results.sort.should == [0, 3, 4, 6]
+  end
+
+  it 'should be searchable by a Regexp' do
+    @searchable.search(*@args << /[au]ck/).results.sort.should == [1, 2, 5]
+  end
+
+  it 'should allow boolean combination with AND' do
+    @searchable.search(*@args << 'fox').and('goose').results.sort.should == [3, 6]
+  end
+
+  it 'should allow boolean combination with OR' do
+    @searchable.search(*@args << 'fox').or('goose').results.sort.should == [0, 2, 3, 4, 6]
+  end
+
+  it 'should allow boolean combination with NOT' do
+    @searchable.search(*@args << 'fox').not('goose').results.sort.should == [0, 4]
+  end
+
+end
+
+describe String, ' when extended by pms' do
+
+  before :each do
+    @searchable = File.read(FOX)
+  end
+
+  it_should_behave_like 'any Searchable'
+
+end
+
+describe IO, ' when extended by pms' do
+
+  before :each do
+    @searchable = File.open(FOX)
+  end
+
+  it_should_behave_like 'any Searchable'
+
+end
+
+describe Array, ' when extended by pms' do
+
+  before :each do
+    @searchable = File.readlines(FOX)
+  end
+
+  it_should_behave_like 'any Searchable'
+
+end
+
+describe File, ' when extended by pms' do
+
+  before :each do
+    @searchable = File
+    @args = [FOX]
+  end
+
+  it_should_behave_like 'any Searchable'
+
+end

data/spec/pms/index_spec.rb

@@ -0,0 +1,30 @@
+describe PMS::Index do
+
+  before :each do
+    @index = PMS::Index.new(File.read(FOX))
+  end
+
+  it 'should raise an error for an invalid token in #results_with_positions' do
+    lambda {
+      @index.results_with_positions(123)
+    }.should raise_error(TypeError)
+  end
+
+  it 'should return the document for a given doc_num' do
+    @index.doc(3).should == File.readlines(FOX)[3]
+  end
+
+end
+
+describe PMS::Index, ' with exhaustable input' do
+
+  before :each do
+    # already seeks to EOF in #build_index
+    @index = PMS::Index.new(File.open(FOX))
+  end
+
+  it 'should return the documents anyway' do
+    @index.documents.size.should == 7
+  end
+
+end

data/spec/pms/proxy_spec.rb

@@ -0,0 +1,13 @@
+describe PMS::Proxy do
+
+  before :each do
+    @proxy = PMS::Proxy.new(PMS.new(File.read(FOX)))
+  end
+
+  it 'should raise an error for an invalid operator in #apply_operator' do
+    lambda {
+      @proxy.send(:apply_operator, 'foo', [])
+    }.should raise_error(ArgumentError)
+  end
+
+end

data/spec/pms_spec.rb

@@ -0,0 +1,65 @@
+describe PMS do
+
+  before :each do
+    @pms = PMS.new(File.read(FOX))
+  end
+
+  it 'should return the original documents' do
+    @pms.matches.should == File.readlines(FOX)
+  end
+
+  it 'should return the query matches (with token)' do
+    @pms.search('fox').and('goose').matches.sort.should == File.readlines(FOX).values_at(3, 6).sort
+  end
+
+  it 'should return the query matches (with sub-query)' do
+    @pms.search { |q| q.search('goose').or('night') }.matches.sort.should == File.readlines(FOX).values_at(0, 2, 3, 6).sort
+  end
+
+  it 'should support boolean operator AND' do
+    @pms.search('fox').and('goose').results.sort.should == [3, 6]
+  end
+
+  it 'should support boolean operator OR' do
+    @pms.search('fox').or('goose').results.sort.should == [0, 2, 3, 4, 6]
+  end
+
+  it 'should support boolean operator NOT' do
+    @pms.search('fox').not('goose').results.sort.should == [0, 4]
+  end
+
+  it 'should allow chaining of operators' do
+    @pms.search('fox').and('goose').not('knife').results.sort.should == [3]
+  end
+
+  it 'should allow grouping in sub-queries (for AND)' do
+    @pms.search('fox').and { |q| q.search('goose').or('night') }.results.sort.should == [0, 3, 6]
+  end
+
+  it 'should allow grouping in sub-queries (for OR)' do
+    @pms.search('fox').or { |q| q.search('geese').and('ran') }.results.sort.should == [0, 1, 3, 4, 6]
+  end
+
+  it 'should allow grouping in sub-queries (for NOT)' do
+    @pms.search('fox').not { |q| q.search('goose').or('night') }.results.sort.should == [4]
+  end
+
+  it 'should allow grouping in sub-queries (w/o token)' do
+    @pms.search { |q| q.search('goose').or('night') }.results.sort.should == [0, 2, 3, 6]
+  end
+
+  it 'should raise an error when block returns an invalid sub-query in #apply_operator_with_block' do
+    lambda {
+      @pms.search('fox').and { |q| q.class }
+    }.should raise_error(RuntimeError)
+  end
+
+  it 'should support proximity operator NEAR' do
+    @pms.search('fox').near('goose', 10).results.sort.should == [3, 6]
+  end
+
+  it 'should support proximity operator ADJACENT' do
+    @pms.search('fox').adjacent('goose', 10).results.sort.should == [6]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+unless Object.const_defined?(:BASE)
+  BASE = File.join(File.dirname(__FILE__), '..')
+
+  $: << File.join(BASE, 'lib')
+  require 'pms'
+
+  FOX = File.join(BASE, 'test_data', 'fox.txt')
+end

data/test_data/fox.txt

@@ -0,0 +1,7 @@
+The fox went out on a chilly night / Prayed for the moon to give him light / For he had many a mile to go that night / Before he reached the town o
+He ran til he came to a great big bin / Where the ducks and the geese were kept therein / Said, a couple of you are going to grease my chin / Before I leave this town o
+He grabbed the grey goose by the neck / Throwed a duck across his back / He didn't mind the quack, quack, quack / And the legs all dangling down o
+Then old mother Flipper-flopper jumped out of bed / Out of the window she cocked her head / Crying, John, John the grey goose is gone / and the fox is on the town o
+Then John he went to the top of the hill / Blew his horn both loud and shrill / The fox, he said, I better flee with my kill / Or they'll soon be on my trail o
+He ran till he came to his cozy den / There were the little ones, eight, nine, ten / Saying, Daddy, daddy, Better go back again / For it must be a mighty fine town o
+Then the fox and his wife, without any strife / Cut up the goose with a carving knife / They never had such a supper in their life / And the little ones chewed on the bones o

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pms
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jens Wille
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Poor Man's Search
+email: jens.wille@uni-koeln.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- COPYING
+- ChangeLog
+- README
+files: 
+- lib/pms.rb
+- lib/pms/proxy.rb
+- lib/pms/ext.rb
+- lib/pms/version.rb
+- lib/pms/index.rb
+- Rakefile
+- COPYING
+- ChangeLog
+- README
+- spec/spec_helper.rb
+- spec/pms/proxy_spec.rb
+- spec/pms/index_spec.rb
+- spec/pms/ext_spec.rb
+- spec/pms_spec.rb
+- test_data/fox.txt
+has_rdoc: true
+homepage: http://pms.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- pms Application documentation
+- --main
+- README
+- --charset
+- UTF-8
+- --all
+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: pms
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Poor Man's Search
+test_files: []
+