xapian_db 0.5.0 → 0.5.1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+##0.5.1 (December 22th, 2010)
+
+Features:
+
+  - simple facet support for indexed classes. Any attribute can be used in a facet search
+
+Fixes:
+
+  - attribute names that match a Xapian::Document method are not allowed
+
 ##0.5.0 (December 19th, 2010)
 
 Features:

data/README.rdoc

@@ -2,9 +2,7 @@
 
 == What's in the box?
 
-XapianDb is a ruby gem that combines features of nosql databases and fulltext indexing into one piece. The result: Rich documents and very fast queries.
-It is based on {Xapian}[http://xapian.org/], an efficient and powerful indexing library.
-The gem is in very early development and not production ready yet.
+XapianDb is a ruby gem that combines features of nosql databases and fulltext indexing into one piece. The result: Rich documents and very fast queries. It is based on {Xapian}[http://xapian.org/], an efficient and powerful indexing library.
 
 XapianDb is inspired by {xapian-fu}[https://github.com/johnl/xapian-fu] and {xapit}[https://github.com/ryanb/xapit].
 Thank you John and Ryan for your great work. It helped me learning to understand the xapian library and I borrowed an idea
@@ -133,7 +131,7 @@ Use blocks for complex evaluations of attributes or indexed values:
     end
   end
 
-place these configurations either into the corrsepondig class or - I prefer to have the index configurations outside
+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.
 
 === Update the index
@@ -209,7 +207,7 @@ Use a search result with will_paginate in a view:
 
 === Facets
 
-If you want to implement a simple drilldown for your searches, you can use a facets query:
+If you want to implement a simple drilldown for your searches, you can use a global facets query:
 
   search_expression = "Foo"
   facets = XapianDb.facets(search_expression)
@@ -220,7 +218,15 @@ If you want to implement a simple drilldown for your searches, you can use a fac
     # doc = klass.search search_expression
   end
 
-Facet support in XapianDb is very limited. The only available facet is the class of the indexed objects. In many cases that's all that's needed. Therefore, it is very likely that I won't add more options for facets (since I'm not a fan of facets anyway). However, if you desperately need advanced facets, let me know. Or - even better - send me a pull request with a nice implementation ;-)
+A global facet search always groups the results by the class of the indexed objects. There is a class level facet query syntax available, too:
+
+  search_expression = "Foo"
+  facets = Person.facets(:name, search_expression)
+  facets.each do |name, count|
+    puts "#{name}: #{count} hits"
+  end
+
+At the class level, any attribute can be used for a facet query.
 
 == Production setup
 

data/lib/xapian_db/adapters/base_adapter.rb

@@ -46,6 +46,32 @@ module XapianDb
                result
              end
 
+             # Add a method to search atribute facets of this class
+             define_singleton_method(:facets) do |attr_name, expression|
+
+               # return an empty hash if no search expression is given
+               return {} if expression.nil? || expression.strip.empty?
+
+               class_scope = "indexed_class:#{klass.name.downcase}"
+               blueprint   = XapianDb::DocumentBlueprint.blueprint_for klass
+               value_index = blueprint.value_index_for attr_name.to_sym
+
+               query_parser        = QueryParser.new(XapianDb.database)
+               query                = query_parser.parse("#{class_scope} and (#{expression})")
+               enquiry              = Xapian::Enquire.new(XapianDb.database.reader)
+               enquiry.query        = query
+               enquiry.collapse_key = value_index
+               facets = {}
+               enquiry.mset(0, XapianDb.database.size).matches.each do |match|
+                 facet_value = YAML::load match.document.values[value_index].value
+                 # We must add 1 to the collapse_count since collapse_count means
+                 # "how many other matches are there?"
+                 facets[facet_value] = match.collapse_count + 1
+               end
+               facets
+
+             end
+
            end
          end
        end

data/lib/xapian_db/document_blueprint.rb

@@ -182,6 +182,7 @@ module XapianDb
     #   end
     # @todo Make sure the name does not collide with a method name of Xapian::Document
     def attribute(name, options={}, &block)
+      raise ArgumentError.new("You cannot use #{name} as an attribute name since it is a reserved method name of Xapian::Document") if reserved_method_name?(name)
       opts = {:index => true}.merge(options)
       if block_given?
         @attributes_hash[name] = block
@@ -197,6 +198,7 @@ module XapianDb
     # @todo Make sure the name does not collide with a method name of Xapian::Document
     def attributes(*attributes)
       attributes.each do |attr|
+        raise ArgumentError.new("You cannot use #{attr} as an attribute name since it is a reserved method name of Xapian::Document") if reserved_method_name?(attr)
         @attributes_hash[attr] = nil
         self.index attr
       end
@@ -258,6 +260,11 @@ module XapianDb
       end
     end
 
+    # Check if the attribute name does not collide with a method name of Xapian::Document
+    def reserved_method_name?(attr_name)
+      @reserved_method_names ||= Xapian::Document.instance_methods
+      @reserved_method_names.include?(attr_name.to_sym)
+    end
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Gernot Kogler
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-19 00:00:00 +01:00
+date: 2010-12-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,9 +27,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
+        - 3
         - 1
-        - 0
-        version: 2.1.0
+        version: 2.3.1
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -43,11 +43,26 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 2
-        version: 0.3.2
+        - 7
+        version: 0.3.7
   type: :development
   version_requirements: *id002
-description: Ruby library to use a Xapian db as a key/value store with high performance fulltext search
+- !ruby/object:Gem::Dependency 
+  name: beanstalk-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id003
+description: XapianDb is a ruby gem that combines features of nosql databases and fulltext indexing. It is based on Xapian, an efficient and powerful indexing library
 email: gernot.kogler (at) garaio (dot) com
 executables: []