xapian_db 0.4.1 → 0.4.2

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+##0.4.2 (December 17th, 2010)
+
+Features:
+
+  - added a sample rails application to the repo
+  - added the id attribute for documents based on ActiveRecord and Datamapper objects
+
+Changes:
+
+  - removed the language_method option from the blueprint configuration since it gives
+    unpredictable results
+
+Bugfixes:
+
+  - fixed the initialization error in a Rails app ig there is no xapian_db.yml config file
+  - fixed the fallback to the global language when a model has an unsupported language and a
+    language method is configured in the blueprint
+  - fixed an issue with yaml deserialization of ActiveRecord objects (only the attributes hash
+    should be serialized)
+
 ##0.4.1 (December 16th, 2010)
 
 Bugfixes:

data/README.rdoc

@@ -108,12 +108,6 @@ If you config a class that has a language property, e.g.
     attr_reader :language
   end
 
-you can configure the blueprint to use the language of the object when indexing:
-
-  XapianDb::DocumentBlueprint.setup(Person) do |blueprint|
-    blueprint.language_method :language
-  end
-
 The method must return the iso code for the language (:en, :de, ...) as a symbol or a string. Don't worry if you have languages in your database that are not supported by Xapian. If the language is not supported, XapianDb will fall back to the global language configuration or none, if you haven't configured one.
 
 If you want to declare multiple attributes or indexes with default options, you can do this in one statement:

data/lib/xapian_db/adapters/active_record_adapter.rb

@@ -59,6 +59,15 @@ module XapianDb
          # @param [Module] a_module The module to add the helper methods to
          def add_doc_helper_methods_to(a_module)
            a_module.instance_eval do
+
+             # Implement access to the model id
+             define_method :id do
+               return @id unless @d.nil?
+               # retrieve the class and id from data
+               klass_name, id = data.split("-")
+               @id = id.to_i
+             end
+
              # Implement access to the indexed object
              define_method :indexed_object do
                return @indexed_object unless @indexed_object.nil?
@@ -67,6 +76,7 @@ module XapianDb
                klass = Kernel.const_get(klass_name)
                @indexed_object = klass.find(id.to_i)
              end
+
            end
 
          end

data/lib/xapian_db/adapters/datamapper_adapter.rb

@@ -58,6 +58,15 @@ module XapianDb
          # @param [Module] a_module The module to add the helper methods to
          def add_doc_helper_methods_to(a_module)
            a_module.instance_eval do
+
+             # Implement access to the model id
+             define_method :id do
+               return @id unless @d.nil?
+               # retrieve the class and id from data
+               klass_name, id = data.split("-")
+               @id = id.to_i
+             end
+
              # Implement access to the indexed object
              define_method :indexed_object do
                return @indexed_object unless @indexed_object.nil?

data/lib/xapian_db/document_blueprint.rb

@@ -129,13 +129,16 @@ module XapianDb
         end
       end
 
-      @attributes_hash.keys.sort.each_with_index do |field, index|
+      # Add an accessor for each attribute
+      attribute_names.each do |attribute|
+        index = value_index_for(attribute)
         @accessors_module.instance_eval do
-          define_method field do
-            YAML::load(self.values[index+1].value)
+          define_method attribute do
+            YAML::load(self.values[index].value)
           end
         end
       end
+
       # Let the adapter add its document helper methods (if any)
       adapter = @adapter || XapianDb::Config.adapter || XapianDb::Adapters::GenericAdapter
       adapter.add_doc_helper_methods_to(@accessors_module)
@@ -161,13 +164,6 @@ module XapianDb
       @indexed_methods_hash = {}
     end
 
-    # Set the name of the method to get the language for an indexed object
-    # @param [Symbol] lang The method name. The method must return an iso language code (:en, :de, ...)
-    #   see LANGUAGE_MAP for the supported lanugaes
-    def language_method(lang)
-      @lang_method = lang
-    end
-
     # Add an attribute to the blueprint. Attributes will be stored in the xapian documents an can be
     # accessed from a search result.
     # @param [String] name The name of the method that delivers the value for the attribute

data/lib/xapian_db/indexer.rb

@@ -42,19 +42,22 @@ module XapianDb
         else
           value = @obj.send(attribute)
         end
-        @xapian_doc.add_value(@blueprint.value_index_for(attribute), value.to_yaml)
+
+        # If we have an object that responds to attributes (e.g. an Active Record
+        # or a Datamapper model), we serialize only the attributes
+        yaml = value.respond_to?(:attributes) ? value.attributes.to_yaml : value.to_yaml
+        @xapian_doc.add_value(@blueprint.value_index_for(attribute), yaml)
       end
     end
 
     # Index all configured text methods
     def index_text
-      setup_language_helpers
       term_generator = Xapian::TermGenerator.new
       term_generator.database = @database.writer
       term_generator.document = @xapian_doc
-      if @stemmer
-        term_generator.stemmer  = @stemmer
-        term_generator.stopper  = @stopper unless @stopper.nil?
+      if XapianDb::Config.stemmer
+        term_generator.stemmer  = XapianDb::Config.stemmer
+        term_generator.stopper  = XapianDb::Config.stopper if XapianDb::Config.stopper
         # Enable the creation of a spelling dictionary if the database is not in memory
         term_generator.set_flags Xapian::TermGenerator::FLAG_SPELLING if @database.is_a? XapianDb::PersistentDatabase
       end
@@ -66,25 +69,6 @@ module XapianDb
       term_generator.index_text("#{@obj.class}".downcase, 1, "XINDEXED_CLASS")
       @xapian_doc.add_term("C#{@obj.class}")
 
-
-      # @blueprint.indexed_methods_hash.keys.sort.each do |method|
-      #   options = @blueprint.indexed_methods_hash[method]
-      #   if options.block
-      #     obj = @obj.instance_eval(&options.block)
-      #   else
-      #     obj = @obj.send(method)
-      #   end
-      #   unless obj.nil?
-      #     values = get_values_to_index_from obj
-      #     values.each do |value|
-      #       # Add value with field name
-      #       term_generator.index_text(value.to_s.downcase, options.weight, "X#{method.upcase}")
-      #       # Add value without field name
-      #       term_generator.index_text(value.to_s.downcase)
-      #     end
-      #   end
-      # end
-
       @blueprint.indexed_method_names.each do |method|
         options = @blueprint.options_for_indexed_method method
         if options.block
@@ -107,24 +91,6 @@ module XapianDb
 
     private
 
-    # Configure the stemmer and stopper to use
-    def setup_language_helpers
-      # Do we have a language config on the blueprint?
-      if @blueprint.lang_method
-        lang = @obj.send(@blueprint.lang_method)
-        if lang && LANGUAGE_MAP.has_key?(lang.to_sym)
-          @stemmer = XapianDb::Repositories::Stemmer.stemmer_for lang.to_sym
-          @stopper = XapianDb::Repositories::Stopper.stopper_for lang.to_sym
-          return
-        end
-      end
-
-      # Use the global config
-      @stemmer = XapianDb::Config.stemmer
-      @stopper = XapianDb::Config.stopper
-
-    end
-
     # Get the values to index from an object
     def get_values_to_index_from(obj)
 

data/lib/xapian_db/railtie.rb

@@ -35,7 +35,7 @@ module XapianDb
         end
         config.adapter adapter.to_sym
         config.writer writer.to_sym
-        config.language(env_config["language"]) if env_config["language"]
+        config.language(env_config["language"]) if env_config && env_config["language"]
       end
 
     end

data/lib/xapian_db/repositories/stopper.rb

@@ -21,14 +21,12 @@ module XapianDb
           # Do we already have a stopper for this language?
           return @stoppers[key] unless @stoppers[key].nil?
 
-          # Do we support this language?
-          unless (LANGUAGE_MAP.keys + [:none]).include?(key)
-            raise ArgumentError.new "Language #{iso_cd} is not supported by XapianDb (remember to use the language iso codes)"
-          end
-
           # build the stopper
           stopper = Xapian::SimpleStopper.new
           stopwords_file = File.join(File.dirname(__FILE__), '../stopwords', "#{iso_cd}.txt")
+
+          return nil unless File.exist? stopwords_file
+
           open(stopwords_file, "r") do |file|
             file.each do |word|
               stopper.add word.chomp

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 +01:00
+date: 2010-12-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency