stellr 0.1.0

data/lib/stellr/utils.rb

@@ -0,0 +1,24 @@
+require 'stellr/utils/shutdown'
+require 'stellr/utils/observable'
+
+class String
+
+  # Constantize tries to find a declared constant with the name specified
+  # in the string. It raises a NameError when the name is not in CamelCase
+  # or is not initialized.
+  #
+  # Examples
+  #   "Module".constantize #=> Module
+  #   "Class".constantize #=> Class
+  #
+  # Blatantly stolen from rails' activesupport
+  def constantize
+    unless /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/ =~ self
+      raise NameError, "#{self.inspect} is not a valid constant name!"
+    end
+    classname = $1
+    classname.untaint
+    Object.module_eval("::#{classname}", __FILE__, __LINE__)
+  end
+
+end

data/lib/stellr/utils/observable.rb

@@ -0,0 +1,20 @@
+module Stellr
+  module Utils
+    module Observable
+
+      def listeners
+        @listeners ||= []
+      end
+
+      def add_listener( &block )
+        listeners << block
+      end
+
+      def notify_listeners( event )
+        listeners.each do |l|
+          l.call event
+        end
+      end
+    end
+  end
+end

data/lib/stellr/utils/shutdown.rb

@@ -0,0 +1,30 @@
+module Stellr
+  module Utils
+    module Shutdown
+
+      # shutdown modes:
+      #   - :abort - stops immediately
+      #   - :graceful process all remaining queue entries and stop
+      def shutdown( mode = :abort )
+        @shutdown = mode
+        on_shutdown mode
+      end
+      
+      def shutting_down?( mode = nil )
+        if defined? @shutdown
+          mode.nil? || @shutdown == mode
+        else
+          false
+        end
+      end
+
+      protected
+
+      # override to hook into the shutdown process
+      def on_shutdown
+      end
+
+    
+    end
+  end
+end

data/test/fixtures/movies.yml

@@ -0,0 +1,4 @@
+caligari:
+  title: The Cabinet of Dr. Caligari
+  year: 1920-02-06
+  

data/test/stellr_test.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require 'stellr'
+require 'fileutils'
+require 'test_helper'
+
+class StellrTest < Test::Unit::TestCase
+  INDEX_TMP_TEST_DIR = "/tmp/stellr/test"
+
+  @@data = {}
+
+  def setup
+    FileUtils.rm_rf INDEX_TMP_TEST_DIR
+  end
+  
+  def teardown
+  end
+  
+  def test_truth
+    assert true
+  end
+  
+  def self.fixtures( fixture_name )
+    file_name = File.join( File.dirname(__FILE__), "/fixtures/#{fixture_name}.yml" )
+    @@data[fixture_name] = YAML.load( IO.read( file_name ) )
+    define_method( fixture_name.to_sym ) do |key|
+      @@data[fixture_name][key.to_s].symbolize_keys
+    end
+  end
+end
+
+class Hash
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_sym] = value
+      options
+    end
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'simple_collection_tests'
+
+require 'stellr/client'
+
+class ClientTest < StellrTest
+  include SimpleCollectionTests
+  fixtures :movies
+  
+  DRB_URI = "druby://localhost:99999"
+  def setup
+    super
+    @server_obj = Stellr::Server.new Stellr::Config.new( nil, :base_dir => INDEX_TMP_TEST_DIR )
+    @server = DRb.start_service DRB_URI, @server_obj
+
+    @client = Stellr::Client.new DRB_URI
+    @collection = @client.connect 'default', :collection => :static, :fields => { :title => {}}
+  end
+
+  def teardown
+    @server_obj.send :shutdown, :abort
+    @server.stop_service
+    @server.thread.join
+  end
+  
+  
+end

data/test/test_collections_base.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class CollectionsBaseTest < StellrTest
+  
+  def test_create_without_strategy
+    %w( Static RSync ).each do |coll_class|
+      c = Stellr::Collections::Base.create('test', :collection_class => "Stellr::Collections::#{coll_class}",
+                                                   :path             => INDEX_TMP_TEST_DIR )
+      assert c.class.name =~ /#{coll_class}$/
+      c.close
+    end
+  end
+
+  def test_create_with_strategy
+    %w( Static RSync ).each do |coll_class|
+      %w( Queueing Blocking ).each do |strategy_class|
+        c = Stellr::Collections::Base.create('test', :collection_class => "Stellr::Collections::#{coll_class}",
+                                                     :strategy_class   => "Stellr::Strategies::#{strategy_class}",
+                                                     :path             => INDEX_TMP_TEST_DIR )
+        assert c.class.name =~ /#{strategy_class}$/
+        c.close
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'stellr_test'

data/test/test_rsync_collection.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+class RSyncCollectionTest < StellrTest
+  fixtures :movies
+  
+  def setup
+    super
+    @collection = Stellr::Collections::RSync.new( 'default', default_collection_options )
+  end
+
+  def teardown
+    super
+    @collection.close
+  end
+
+  def test_create
+    @collection.close
+    c = Stellr::Collections::Base.create('test', default_collection_options(:collection => :rsync))
+    assert_equal Stellr::Collections::RSync, c.class
+    c.close
+  end
+
+  def test_create_index
+    assert_equal Ferret::Index::IndexWriter, @collection.send(:writer).class
+  end
+  
+  def test_create_index_directories
+    @collection.send(:writer)
+    assert File.directory?( File.join( INDEX_TMP_TEST_DIR, '0' ) )
+    assert File.directory?( File.join( INDEX_TMP_TEST_DIR, '1' ) )
+    assert File.symlink?(   File.join( INDEX_TMP_TEST_DIR, 'searching' ) )
+    assert File.symlink?(   File.join( INDEX_TMP_TEST_DIR, 'indexing' ) )
+  end
+  
+  def test_switch_index
+    @collection.send(:writer)
+    assert File.symlink?( File.join( INDEX_TMP_TEST_DIR, 'indexing') )
+    target = File.readlink( File.join( INDEX_TMP_TEST_DIR, 'indexing') )
+    @collection.switch
+    assert_equal target, File.readlink( File.join( INDEX_TMP_TEST_DIR, 'searching') )
+  end
+  
+  def test_index
+    assert_equal 0, @collection.size
+    @collection << { :id => 1, :title => movies(:caligari)[:title] }
+    @collection << { :id => 1, :title => movies(:caligari)[:title] }
+    @collection << { :id => 2, :title => movies(:caligari)[:title] }
+    assert_equal 0, @collection.size
+    @collection.switch
+    assert_equal 2, @collection.size
+    @collection.switch
+    assert_equal 2, @collection.size
+  end
+  
+  def test_delete
+    @collection << { :id => 1, :title => movies(:caligari)[:title] }
+    @collection << { :id => 2, :title => movies(:caligari)[:title] }
+    @collection.switch
+    assert_equal 2, @collection.size
+    @collection.delete_record  :id => 1 
+    assert_equal 2, @collection.size
+    @collection.switch
+    assert_equal 1, @collection.size
+    @collection.switch
+    assert_equal 1, @collection.size
+  end
+  
+  def default_collection_options( options = {} )
+    { :recreate => false,
+      :path     => INDEX_TMP_TEST_DIR }.update( options )
+  end
+end

data/test/test_server.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class Stellr::Strategies::Queueing
+
+  # used in test cases to give the queueing thread some time for
+  # auto-rotating the indexes
+  def wait_for
+    sleep 0.1 while !@queue.empty?
+    sleep 0.1
+  end
+
+end
+
+class ServerTest < StellrTest
+  
+  def setup
+    super
+    @server = Stellr::Server.new Stellr::Config.new( nil, :base_dir => INDEX_TMP_TEST_DIR )
+  end
+
+  def teardown
+    @server.send :shutdown, :abort
+    @server = nil
+  end
+
+  def test_register_collection_defaults
+    c = @server.register 'default'
+    assert c
+    assert_equal Stellr::Collections::RSync, c.class
+  end
+
+  def test_register_static_collection
+    c = @server.register 'static', :collection_class => 'Stellr::Collections::Static'
+    assert c
+    assert_equal Stellr::Collections::Static, c.class
+  end
+
+  def test_register_queueing_collection
+    c = @server.register 'queue', :strategy_class => 'Stellr::Strategies::Queueing'
+    assert c
+    assert_equal Stellr::Strategies::Queueing, c.class
+  end
+  
+  def test_default_options
+    @server.register 'default'
+    config = @server.instance_variable_get "@config"
+    assert_equal 9010, config.port
+    assert_equal Stellr::Collections::RSync, @server.collection( 'default' ).class
+  end
+  
+  def test_index_data
+    @server.register 'default'
+    @server.add_record 'default', { :id => 1, :text => 'hello world' }
+    @server.add_record 'default', { :id => 2, :text => 'hello world' }
+    @server.batch_finished 'default'
+    assert_equal 2, @server.size( 'default' )
+  end
+  
+  def test_delete_data_queued
+    coll = "del-queued"
+    @server.register coll, :strategy => :queueing
+    assert_equal 0, @server.size( coll )
+    @server.add_record coll, { :id => 1, :text => 'hello world' }
+    @server.add_record coll, { :id => 2, :text => 'hello world' }
+    @server.wait_for coll
+    assert_equal 2, @server.size( coll )
+    @server.delete_record coll, { :id => 2, :text => 'hello world' }
+    assert_equal 2, @server.size( coll )
+    @server.wait_for coll
+    assert_equal 1, @server.size( coll )
+  end
+
+  def test_delete_data_blocking
+    coll = "del-blocking"
+    @server.register coll, :strategy => nil
+    assert_equal 0, @server.size( coll )
+    @server.add_record coll, { :id => 1, :text => 'hello world' }
+    @server.add_record coll, { :id => 2, :text => 'hello world' }
+    @server.switch coll
+    assert_equal 2, @server.size( coll )
+    @server.delete_record coll, { :id => 2, :text => 'hello world' }
+    assert_equal 2, @server.size( coll )
+    @server.switch coll
+    assert_equal 1, @server.size( coll )
+  end
+  
+  def test_data_require_id_field
+    @server.register 'default'
+    assert_raise ArgumentError do
+      @server.add_record 'default', { :text => 'hello world' }
+    end
+  end
+  
+end

data/test/test_static_collection.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'simple_collection_tests'
+
+class StaticCollectionTest < StellrTest
+  include SimpleCollectionTests
+  fixtures :movies
+  
+  def setup
+    super
+    @collection = Stellr::Collections::Static.new( 'default', default_collection_options )
+  end
+  
+  def test_create
+    c = Stellr::Collections::Base.create( 'test', default_collection_options(:collection_class => 'Stellr::Collections::Static') )
+    assert_equal Stellr::Collections::Static, c.class
+    c.close
+    c = Stellr::Collections::Base.create( 'test', default_collection_options(:collection => :static) )
+    assert_equal Stellr::Collections::Static, c.class
+  end
+
+  def test_switch
+    #assert_equal 0, @collection.size
+    index_something
+    assert_equal 0, @collection.size
+    @collection.switch
+    assert_equal 2, @collection.size
+    
+    # switchen ohne vorheriges indizieren leert index
+    @collection.switch
+    assert_equal 0, @collection.size
+    @collection.switch
+    assert_equal 0, @collection.size
+  end
+  
+  protected
+
+  def default_collection_options( options = {} )
+    { :path     => INDEX_TMP_TEST_DIR, :logger => Logger.new('/tmp/stellr/test.log') }.update( options )
+  end
+end

data/test/test_stellr.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+
+class TestStellr < Test::Unit::TestCase
+  
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: stellr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Benjamin Krause
+- "Jens Kr\xC3\xA4mer"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: "== FEATURES:  * DRb frontend * easy to use client library (see below) * multi index search * Index rotation Stellr always keeps two versions of your index around - one is used in a multi threaded, read only way to handle incoming search requests, while the other one is written to when you index something. Using the switch function you may decide when to switch over searching from  the old index to the new one. Then, changes will be synced, and searches will see the new or updated data from before the switch call. * Index synchronization Two kinds of synchronization methods are supported for now: rsync, using rsync two copy over the changes from one index to the other, and static, which will completely replace the old index with the new one. While the latter is suitable for indexes which you rebuild completely from time to time, the former is good for large indexes that are updated frequently or that are too large for frequent rebuilds.  == SYNOPSIS:  * start the server:"
+email: 
+- bk@benjaminkrause.com
+- jk@jkraemer.net
+executables: 
+- stellr
+- stellr-search
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/stellr
+- bin/stellr-search
+- config/stellr.yml
+- lib/stellr.rb
+- lib/stellr/client.rb
+- lib/stellr/collections.rb
+- lib/stellr/collections/base.rb
+- lib/stellr/collections/searchable_collection.rb
+- lib/stellr/collections/writeable_collection.rb
+- lib/stellr/collections/rsync.rb
+- lib/stellr/collections/static.rb
+- lib/stellr/collections/multi_collection.rb
+- lib/stellr/config.rb
+- lib/stellr/search.rb
+- lib/stellr/search/search_result.rb
+- lib/stellr/search/search_results.rb
+- lib/stellr/server.rb
+- lib/stellr/strategies.rb
+- lib/stellr/strategies/base.rb
+- lib/stellr/strategies/blocking.rb
+- lib/stellr/strategies/queueing.rb
+- lib/stellr/utils.rb
+- lib/stellr/utils/shutdown.rb
+- lib/stellr/utils/observable.rb
+- test/fixtures/movies.yml
+- test/stellr_test.rb
+- test/test_collections_base.rb
+- test/test_helper.rb
+- test/test_rsync_collection.rb
+- test/test_server.rb
+- test/test_static_collection.rb
+- test/test_stellr.rb
+has_rdoc: true
+homepage: "    by Jens Kraemer and Benjamin Krause"
+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: stellr
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Stellr is a Ferret based standalone search server.
+test_files: 
+- test/test_client.rb
+- test/test_collections_base.rb
+- test/test_helper.rb
+- test/test_rsync_collection.rb
+- test/test_server.rb
+- test/test_static_collection.rb
+- test/test_stellr.rb