xapian_db 0.5.2 → 0.5.3

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+##0.5.3 (February 15th, 2011)
+
+Fixes:
+
+  - index blueprints can now handle inheritance. If a class does not have its own index blueprint,
+    xapian_db uses the index blueprint from its super class (if defined)
+  - Added an ignore option to the blueprint definition to filter out objects that should not go into the index
+
+##0.5.2 (January 11th, 2011)
+
+Features:
+
+  - xapian-core and xapian-ruby-bindings sources are now included and will be compiled and installed with the gem
+
 ##0.5.1 (December 22th, 2010)
 
 Features:
@@ -29,7 +43,7 @@ Changes:
 
 Bugfixes:
 
-  - fixed the initialization error in a Rails app ig there is no xapian_db.yml config file
+  - fixed the initialization error in a Rails app if 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

data/README.rdoc

@@ -28,33 +28,16 @@ So I started to rethink fulltext indexing again. I looked for something that
 
 I tried hard but I couldn't find such a thing so I decided to write it, based on the Xapian library.
 
-== Getting started
-
-If you want to use xapian_db in a Rails app, you need Rails 3 or newer.
-
-=== Install Xapian if not already installed
+<b>If you found a bug or are looking for a missing feature, please post to the {Google  Group}[http://groups.google.com/group/xapian_db]</b>
 
-To use xapian_db, make sure you have the Xapian library and ruby bindings installed. At the time of this writing, the newest release of Xapian was 1.2.4. You might
-want to adjust the URLs below to load the most current release of Xapian.
-The example code works for OSX. On linux you might want to use wget instead of curl.
+== Requirements
 
-A future release of xapian_db might include the Xapian binaries and make this step obsolete.
+* ruby 1.9.2 or better
+* rails 3.0 or better (if you want to use it with rails)
 
-==== Install Xapian
-  curl -O http://oligarchy.co.uk/xapian/1.2.4/xapian-core-1.2.4.tar.gz
-  tar xzvf xapian-core-1.2.4.tar.gz
-  cd xapian-core-1.2.4
-  ./configure --prefix=/usr/local
-  make
-  sudo make install
+== Getting started
 
-==== Install ruby bindings for Xapian
-  curl -O http://oligarchy.co.uk/xapian/1.2.2/xapian-bindings-1.2.4.tar.gz
-  tar xzvf xapian-bindings-1.2.4.tar.gz
-  cd xapian-bindings-1.2.4
-  ./configure --prefix=/usr/local XAPIAN_CONFIG=/usr/local/bin/xapian-config
-  make
-  sudo make install
+If you want to use xapian_db in a Rails app, you need Rails 3 or newer.
 
 For a first look, look at the examples in the examples folder. There's the simple ruby script basic.rb that shows the basic
 usage of XapianDB without rails. In the basic_rails folder you'll find a very simple Rails app unsing XapianDb.
@@ -123,6 +106,14 @@ Use blocks for complex evaluations of attributes or indexed values:
     end
   end
 
+You may add a filter expression to exclude objects from the index. This is handy to skip objects that are not active, for example:
+
+    XapianDb::DocumentBlueprint.setup(Person) do |blueprint|
+      blueprint.attributes :name, :first_name, :profession
+      blueprint.index      :notes, :remarks, :cv
+      blueprint.ignore_if {active == false}
+    end
+
 place these configurations either into the corresponding class or - I prefer to have the index configurations outside
 the models - into the file config/xapian_blueprints.rb.
 
@@ -267,7 +258,7 @@ The easiest way is to use macports or homebrew:
 
 === 4. start the beanstalk daemon
 
-  beanstalk -d
+  beanstalkd -d
 
 === 5. start the beanstalk worker from within your Rails app root directory
 

data/lib/xapian_db/adapters/active_record_adapter.rb

@@ -39,7 +39,12 @@ module XapianDb
 
              # add the after save logic
              after_save do
-               XapianDb::Config.writer.index(self)
+               blueprint = XapianDb::DocumentBlueprint.blueprint_for klass
+               if blueprint.should_index?(self)
+                 XapianDb::Config.writer.index(self)
+               else
+                 XapianDb::Config.writer.unindex(self)
+               end
              end
 
              # add the after destroy logic

data/lib/xapian_db/adapters/datamapper_adapter.rb

@@ -38,7 +38,12 @@ module XapianDb
 
              # add the after save logic
              after :save do
-               XapianDb::Config.writer.index(self)
+               blueprint = XapianDb::DocumentBlueprint.blueprint_for klass
+               if blueprint.should_index?(self)
+                 XapianDb::Config.writer.index(self)
+               else
+                 XapianDb::Config.writer.unindex(self)
+               end
              end
 
              # add the after destroy logic

data/lib/xapian_db/document_blueprint.rb

@@ -32,7 +32,6 @@ module XapianDb
 
       # Configure the blueprint for a class.
       # Available options:
-      # - language_method (see {#language_method} for details)
       # - adapter (see {#adapter} for details)
       # - attribute (see {#attribute} for details)
       # - index (see {#index} for details)
@@ -49,7 +48,15 @@ module XapianDb
       # Get the blueprint for a class
       # @return [DocumentBlueprint]
       def blueprint_for(klass)
-        @blueprints[klass] if @blueprints
+        if @blueprints
+          key = klass
+          while key != Object
+            return @blueprints[key] unless @blueprints[key].nil?
+            key = key.superclass
+          end
+          raise "Blueprint for class #{klass} is not defined"
+        end
+        raise "Blueprint for class #{klass} is not defined"
       end
 
       # Return an array of all configured text methods in any blueprint
@@ -116,6 +123,13 @@ module XapianDb
       @prefixes ||= @indexed_methods_hash.keys
     end
 
+    # Should the object go into the index? Evaluates an ignore expression,
+    # if defined
+    def should_index? obj
+      return obj.instance_eval(&@ignore_expression) == false if @ignore_expression
+      true
+    end
+
     # Lazily build and return a module that implements accessors for each field
     # @return [Module] A module containing all accessor methods
     def accessors_module
@@ -236,6 +250,11 @@ module XapianDb
       end
     end
 
+    # Add a block of code that evaluates if a model should not be indexed
+    def ignore_if &block
+      @ignore_expression = block
+    end
+
     # Options for an indexed method
     class IndexOptions
 

data/lib/xapian_db/index_writers/direct_writer.rb

@@ -55,8 +55,12 @@ module XapianDb
           nr_of_batches = (obj_count / 1000) + 1
           nr_of_batches.times do |batch|
             klass.all(:offset => batch * 1000, :limit => 1000) .each do |obj|
-              doc = indexer.build_document_for(obj)
-              XapianDb.database.store_doc(doc)
+              if blueprint.should_index? obj
+                doc = indexer.build_document_for(obj)
+                XapianDb.database.store_doc(doc)
+              else
+                XapianDb.database.delete_doc_with_unique_term(obj.xapian_id)
+              end
               pbar.inc if show_progressbar
             end
           end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: xapian_db
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 2
-  version: 0.5.2
+  prerelease: 
+  version: 0.5.3
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 +01:00
+date: 2011-02-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 1
         version: 2.3.1
   type: :development
   version_requirements: *id001
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 7
         version: 0.3.7
   type: :development
   version_requirements: *id002
@@ -55,10 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 0
         version: 1.1.0
   type: :development
   version_requirements: *id003
@@ -129,23 +113,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby library to use a Xapian db as a key/value store with high performance fulltext search