xapian_db 1.3.2 → 1.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2a9d352e0fa6f589c5296ea5ed0c25c050595c0
+  data.tar.gz: 359d8dd4cfc388bafe0fba2348ddd1a588ded103
+SHA512:
+  metadata.gz: 315ca9a190b3d69b17ee58c9a768842a9fa6b57b7a2fcaf6e58dde4fd6ce1881103efb63d4247ea2d011d805229febf5a92220abbcbcbedd0fca624f976a7c9b
+  data.tar.gz: 7c87c96b7e63d2ae451ef5b7d7630ce4a9c8a12da80a9faac226983c27dd66da8b4deec50c990712e80a68d40cf2b0c50ed0bb92b7aa1a0bafbcc73a9426838e

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+##1.3.3 (June 23th, 2013)
+
+Changes:
+
+  - xapian query parser flags are now configurable (see README)
+
+Breaking Changes:
+
+- enable_phrase_search config option is no longer supported (use config.enable_query_flag Xapian::QueryParser::FLAG_PHRASE instead)
+
 ##1.3.2 (April 10th, 2013)
 
 Changes:

data/README.rdoc

@@ -1,14 +1,5 @@
 = XapianDb
 
-{<img src="https://secure.travis-ci.org/garaio/xapian_db.png" />}[http://travis-ci.org/garaio/xapian_db]
-
-== Important Information
-
-Version 1.3 does not support YAML serialization for attributes anymore. If you don't apply a type information for an attribute (like attribute :birth, as: :date) in your blueprint,
-the attribute gets stored as a string. The new preferred type for complex attributes is JSON. Why the change? We were experiencing a unacceptable performance hit when we switched from Syck to Psych. The new philosophy for blueprints is therefore explicit type information. lib/type_codec.rb contains the most common codecs and of course, you can add your own (see examples/custom_serialization.rb).
-
-<b>Please note: You may want to fine tune your blueprints and you MUST rebuild your xapian index when switching to version 1.3</b>
-
 == 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.
@@ -73,6 +64,7 @@ You can override these defaults by placing a config file named 'xapian_db.yml' i
     adapter: datamapper # Avaliable adapters: :active_record, :datamapper
     language: de        # Global language; can be overridden for specific blueprints
     term_min_length: 2  # Ignore single character terms
+    enable_query_flags: FLAG_PHRASE, FLAG_SPELLING_CORRECTION
 
   development:
     database: db/xapian_db/development
@@ -91,8 +83,18 @@ You can override these defaults by placing a config file named 'xapian_db.yml' i
   - adapter: :active_record|:datamapper, default: :active_record
   - language: any iso language code, default: :none (activates spelling corrections, stemmer and stop words if an iso language code ist set)
   - term_min_length: <n>, default: 1 (do not index terms shorter than n)
-  - enable_phrase_search: true|false, default: false (see the xapian docs for an intro to phrase searching)
   - term_splitter_count: <n>, default: 0 (see chapter Term Splitting)
+  - enable_query_flags: <list of flags, separated by colons>
+  - disable_query_flags: <list of flags, separated by colons>
+
+  The following query flags are enabled by default:
+
+    - FLAG_WILDCARD
+    - FLAG_BOOLEAN
+    - FLAG_BOOLEAN_ANY_CASE
+    - FLAG_SPELLING_CORRECTION
+
+  See the xapian docs for all available query flags
 
 If you do not configure settings for an environment in this file, xapian_db applies the defaults.
 
@@ -248,7 +250,7 @@ You can query objects of a specific class:
 
   results = Person.search "name:Foo"
 
-You can search for exact phrases:
+You can search for exact phrases (if the query flag is turned on):
 
   results = XapianDb.search('"this exact sentence"')
 

data/lib/xapian_db/config.rb

@@ -53,21 +53,25 @@ module XapianDb
         @config.instance_variable_get("@_term_min_length") || 1
       end
 
-      def phrase_search_enabled?
-        @config.instance_variable_get("@_phrase_search_enabled") || false
-      end
-
       def term_splitter_count
         @config.instance_variable_get("@_term_splitter_count") || 0
       end
+
+      def query_flags
+        @config.instance_variable_get("@_enabled_query_flags") || [ Xapian::QueryParser::FLAG_WILDCARD,
+                                                                    Xapian::QueryParser::FLAG_BOOLEAN,
+                                                                    Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE,
+                                                                    Xapian::QueryParser::FLAG_SPELLING_CORRECTION
+                                                                  ]
+      end
     end
 
     # ---------------------------------------------------------------------------------
     # DSL methods
     # ---------------------------------------------------------------------------------
 
-    attr_reader :_database, :_adapter, :_writer, :_beanstalk_daemon, :_resque_queue, :_stemmer, :_stopper, :_term_min_length,
-                :_phrase_search_enabled, :_term_splitter_count
+    attr_reader :_database, :_adapter, :_writer, :_beanstalk_daemon, :_resque_queue, :_stemmer, :_stopper,
+                :_term_min_length, :_term_splitter_count, :_enabled_query_flags
 
     # Set the global database to use
     # @param [String] path The path to the database. Either apply a file sytem path or :memory
@@ -153,19 +157,20 @@ module XapianDb
       @_term_min_length = length
     end
 
-    # Enable phrase search support ("search this exact sentence")
-    def enable_phrase_search
-      @_phrase_search_enabled = true
+    def term_splitter_count(count)
+      @_term_splitter_count = count
     end
 
-    # Disable phrase search support ("search this exact sentence")
-    def disable_phrase_search
-      @_phrase_search_enabled = false
+    def enable_query_flag(flag)
+      @_enabled_query_flags ||= []
+      @_enabled_query_flags << flag
+      @_enabled_query_flags.uniq!
     end
 
-    def term_splitter_count(count)
-      @_term_splitter_count = count
+    def disable_query_flag(flag)
+      @_enabled_query_flags ||= []
+      @_enabled_query_flags.delete flag
     end
-  end
 
+  end
 end

data/lib/xapian_db/query_parser.rb

@@ -17,11 +17,7 @@ module XapianDb
 
       # Set the parser options
       @query_flags = 0
-      @query_flags |= Xapian::QueryParser::FLAG_WILDCARD            # enable wildcards
-      @query_flags |= Xapian::QueryParser::FLAG_BOOLEAN             # enable boolean operators
-      @query_flags |= Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE    # enable case insensitive boolean operators
-      @query_flags |= Xapian::QueryParser::FLAG_SPELLING_CORRECTION # enable spelling corrections
-      @query_flags |= Xapian::QueryParser::FLAG_PHRASE if XapianDb::Config.phrase_search_enabled?
+      XapianDb::Config.query_flags.each { |flag| @query_flags |= flag }
     end
 
     # Parse an expression

data/lib/xapian_db/railtie.rb

@@ -51,12 +51,9 @@ module XapianDb
         config.resque_queue @resque_queue
         config.language @language.try(:to_sym)
         config.term_min_length @term_min_length
-        if @enable_phrase_search
-          config.enable_phrase_search
-        else
-          config.disable_phrase_search
-        end
         config.term_splitter_count @term_splitter_count
+        @enabled_query_flags.each  { |flag| config.enable_query_flag flag }
+        @disabled_query_flags.each { |flag| config.disable_query_flag flag }
       end
 
     end
@@ -81,6 +78,24 @@ module XapianDb
       @term_min_length      = env_config["term_min_length"]
       @enable_phrase_search = env_config["enable_phrase_search"] == true
       @term_splitter_count  = env_config["term_splitter_count"] || 0
+
+      if env_config["enabled_query_flags"]
+        @enabled_query_flags = []
+        env_config["enabled_query_flags"].split(",").each { |flag_name| @enabled_query_flags << const_get("Xapian::QueryParser::%s" % flag_name.strip) }
+      else
+        @enabled_query_flags = [ Xapian::QueryParser::FLAG_WILDCARD,
+                                 Xapian::QueryParser::FLAG_BOOLEAN,
+                                 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE,
+                                 Xapian::QueryParser::FLAG_SPELLING_CORRECTION
+                               ]
+      end
+
+      if env_config["disabled_query_flags"]
+        @disabled_query_flags = []
+        env_config["disabled_query_flags"].split(",").each { |flag_name| @disabled_query_flags << const_get("Xapian::QueryParser::%s" % flag_name.strip) }
+      else
+        @disabled_query_flags = []
+      end
     end
 
     # set default config options
@@ -92,7 +107,11 @@ module XapianDb
       @term_min_length      = 1
       @enable_phrase_search = false
       @term_splitter_count  = 0
+      @enabled_query_flags  = [ Xapian::QueryParser::FLAG_WILDCARD,
+                                Xapian::QueryParser::FLAG_BOOLEAN,
+                                Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE,
+                                Xapian::QueryParser::FLAG_SPELLING_CORRECTION
+                              ]
     end
-
   end
 end

metadata

@@ -1,174 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: xapian_db
 version: !ruby/object:Gem::Version
-  version: 1.3.2
-  prerelease: 
+  version: 1.3.3
 platform: ruby
 authors:
 - Gernot Kogler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.10
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.3.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.3.7
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: xapian-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.7.1
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: XapianDb is a ruby gem that combines features of nosql databases and
@@ -228,6 +207,7 @@ files:
 - Rakefile
 homepage: https://github.com/garaio/xapian_db
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --line-numbers
@@ -239,25 +219,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1707289322926959795
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby library to use a Xapian db as a key/value store with high performance
   fulltext search
 test_files: []