xapian_db 0.5.4 → 0.5.5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+##0.5.5 (February 25th, 2011)
+
+Fixes:
+
+  - ":memory:" as a configuration option for a database works again (was broken in 0.5.4)
+  - forcing utf-8 encoding on a spelling suggestion returned by the xapian query parser
+
+Features:
+
+  - configure only those environments in xapian_db.yml where you want to override the defaults
+  - XapianDb.rebuild_xapian_index rebuilds the index for all blueprints
+
 ##0.5.4 (February 22th, 2011)
 
 Fixes:

data/README.rdoc

@@ -32,8 +32,8 @@ I tried hard but I couldn't find such a thing so I decided to write it, based on
 
 == Requirements
 
-* ruby 1.9.2 or better
-* rails 3.0 or better (if you want to use it with rails)
+* ruby 1.9.2 or newer
+* rails 3.0 or newer (if you want to use it with rails)
 
 == Getting started
 
@@ -69,6 +69,8 @@ You can override these defaults by placing a config file named 'xapian_db.yml' i
     database: db/xapian_db/production
     <<: *defaults
 
+If you do not configure settings for an environment in this file, xapian_db applies the defaults.
+
 === Configure an index blueprint
 
 In order to get your models indexed, you must configure a document blueprint for each class you want to index:
@@ -131,6 +133,10 @@ To get info about the reindex process, use the verbose option:
 
 In verbose mode, XapianDb will use the progressbar gem if available.
 
+To rebuild the index for all blueprints, use
+
+  XapianDb.rebuild_xapian_index
+
 === Query the index
 
 A simple query looks like this:

data/lib/xapian_db/document_blueprint.rb

@@ -45,6 +45,12 @@ module XapianDb
         @searchable_prefixes = nil # force rebuild of the searchable prefixes
       end
 
+      # Get all configured classes
+      # @return [Array<Class>]
+      def configured_classes
+        @blueprints ? @blueprints.keys : []
+      end
+
       # Get the blueprint for a class
       # @return [DocumentBlueprint]
       def blueprint_for(klass)

data/lib/xapian_db/index_writers/direct_writer.rb

@@ -47,7 +47,7 @@ module XapianDb
             if defined?(ProgressBar)
               show_progressbar = true
             end
-            puts "Reindexing #{obj_count} objects..."
+            puts "reindexing #{obj_count} objects of #{klass}..."
             pbar = ProgressBar.new("Status", obj_count) if show_progressbar
           end
 
@@ -65,6 +65,7 @@ module XapianDb
             end
           end
           XapianDb.database.commit
+          true
         end
 
       end

data/lib/xapian_db/query_parser.rb

@@ -40,7 +40,7 @@ module XapianDb
       # (like "name:Kogler")
       XapianDb::DocumentBlueprint.searchable_prefixes.each{|prefix| parser.add_prefix(prefix.to_s.downcase, "X#{prefix.to_s.upcase}") }
       query = parser.parse_query(expression, @query_flags)
-      @spelling_suggestion = parser.get_corrected_query_string
+      @spelling_suggestion = parser.get_corrected_query_string.force_encoding("UTF-8")
       @spelling_suggestion = nil if @spelling_suggestion.empty?
       query
     end

data/lib/xapian_db/railtie.rb

@@ -21,29 +21,23 @@ module XapianDb
       if File.exist?(config_file_path)
         db_config = YAML::load_file config_file_path
         env_config = db_config[Rails.env]
-        database_path    = File.expand_path(env_config["database"]) || ":memory:"
-        adapter          = env_config["adapter"]  || :active_record
-        writer           = env_config["writer"]   || :direct
-        beanstalk_daemon = env_config["beanstalk_daemon"]
+        env_config ? configure_from(env_config) : configure_defaults
       else
         # No config file, set the defaults
-        Rails.env == "test" ? database_path = ":memory:" : database_path = File.expand_path("db/xapian_db/#{Rails.env}")
-        adapter          = :active_record
-        writer           = :direct
-        beanstalk_daemon = nil
+        configure_defaults
       end
 
       # Do the configuration
       XapianDb::Config.setup do |config|
-        if database_path == ":memory:"
+        if @database_path == ":memory:"
           config.database :memory
         else
-          config.database database_path
+          config.database File.expand_path @database_path
         end
-        config.adapter adapter.to_sym
-        config.writer writer.to_sym
-        config.beanstalk_daemon_url beanstalk_daemon
-        config.language(env_config["language"]) if env_config && env_config["language"]
+        config.adapter @adapter.to_sym
+        config.writer @writer.to_sym
+        config.beanstalk_daemon_url @beanstalk_daemon
+        config.language @language
       end
 
     end
@@ -55,5 +49,25 @@ module XapianDb
       load blueprints_file_path if File.exist?(blueprints_file_path)
     end
 
+  private
+
+  # use the config options from the config file
+  def self.configure_from(env_config)
+    @database_path    = env_config["database"] || ":memory:"
+    @adapter          = env_config["adapter"]  || :active_record
+    @writer           = env_config["writer"]   || :direct
+    @beanstalk_daemon = env_config["beanstalk_daemon"]
+    @language         = env_config["language"]
+  end
+
+  # set default config options
+  def self.configure_defaults
+    Rails.env == "test" ? @database_path = ":memory:" : @database_path = "db/xapian_db/#{Rails.env}"
+    @adapter          = :active_record
+    @writer           = :direct
+    @beanstalk_daemon = nil
+    @language         = :en
+  end
+
   end
 end

data/lib/xapian_db.rb

@@ -84,6 +84,19 @@ module XapianDb
     XapianDb::Config.database.facets(expression)
   end
 
+  # Rebuild the xapian index for all configured blueprints
+  # @param [Hash] options Options for reindexing
+  # @option options [Boolean] :verbose (false) Should the reindexing give status informations?
+  # @return [Boolean] Did we reindex anything?
+  def self.rebuild_xapian_index(options={})
+    configured_classes = XapianDb::DocumentBlueprint.configured_classes
+    return false unless configured_classes.size > 0
+    configured_classes.each do |klass|
+      XapianDb::Config.writer.reindex_class(klass, options)
+    end
+    true
+  end
+
 end
 
 do_not_require = %w(update_stopwords.rb railtie.rb base_adapter.rb beanstalk_writer.rb)

metadata

@@ -2,7 +2,7 @@
 name: xapian_db
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 +01:00
+date: 2011-02-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Ruby library to use a Xapian db as a key/value store with high performance fulltext search