lucene_query 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jeremy Voorhis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+end
+
+task :default => :examples

data/examples/lucene_query.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../lib/lucene_query'
+
+describe LuceneQuery do
+  
+  it "should passthru most primitives" do
+    lambda { :example }.should generate_query("example")
+    lambda { 42 }.should generate_query("42")
+    lambda { 3.14159 }.should generate_query("3.14159")
+    lambda { true }.should generate_query("true")
+    lambda { false }.should generate_query("false")
+  end
+  
+  it "should cope with empty Arrays" do
+    lambda { Array.new }.should generate_query("")
+  end
+  
+  it "should cope with empty Hashes" do
+    lambda { Hash.new }.should generate_query("")
+  end
+  
+  it "should quote Strings" do
+    lambda { "example" }.should generate_query("'example'")
+  end
+  
+  it "should escape Strings" do
+    lambda { "this || that" }.should generate_query("'this \\|| that'")
+    lambda { "this && that" }.should generate_query("'this \\&& that'")
+    lambda { "Query builder for the Lucene (and Solr) search engine." }.should generate_query("'Query builder for the Lucene \\(and Solr\\) search engine.'")
+    lambda { "~jvoorhis" }.should generate_query("'\\~jvoorhis'")
+    lambda { "-spam" }.should generate_query("'\\-spam'")
+    lambda { "+ham" }.should generate_query("'\\+ham'")
+    lambda { '\d{10}' }.should generate_query("'\\\\d\\{10\\}'")
+  end
+  
+  it "should group Arrays" do
+    lambda { [:red, :green, :blue] }.should generate_query("(red green blue)")
+  end
+  
+  it "should join terms with AND" do
+    lambda { And(:symbol, 42, "string") }.should generate_query("(symbol AND 42 AND 'string')")
+  end
+  
+  it "should join terms with OR" do
+    lambda { Or(:symbol, 42, "string") }.should generate_query("(symbol OR 42 OR 'string')")
+  end
+  
+  it "should support fields" do
+    lambda { Field(:city, "Portland") }.should generate_query("city:'Portland'")
+    lambda { Field("city", "Portland") }.should generate_query("'city':'Portland'")
+  end
+  
+  it "should AND together Hash terms" do
+    lambda { { :city => "Portland", :state => "Oregon" } }.should generate_query("(state:'Oregon' AND city:'Portland')")
+  end
+  
+  it "should OR together IN terms" do
+    lambda { In(:id, [110, 220, 330]) }.should generate_query("(id:110 OR id:220 OR id:330)")
+  end
+  
+  it "should require terms" do
+    lambda { Required("lucene") }.should generate_query("+'lucene'")
+    lambda { { :marine_life => [Required("fish"), Required("dolphins")] } }.should generate_query("(marine_life:(+'fish' +'dolphins'))")
+  end
+  
+  it "should prohibit terms" do
+    lambda { Prohibit("bugs") }.should generate_query("-'bugs'")
+    lambda { { :marine_life => [Required("fish"), Prohibit("eels")] } }.should generate_query("(marine_life:(+'fish' -'eels'))")
+  end
+  
+  it "should produce fuzzy terms" do
+    lambda { Fuzzy("term") }.should generate_query("term~")
+    lambda { Fuzzy("multiple terms") }.should generate_query("multiple~ terms~")
+    lambda { Fuzzy("term", 0.7) }.should generate_query("term~0.7")
+    lambda { Fuzzy("*") }.should generate_query("\\*~")
+  end
+end
+
+class QueryMatcher
+  def initialize(expected)
+    @expected = expected
+  end
+  
+  def matches?(target)
+    @target = target
+    @actual = LuceneQuery.new(&@target).to_s
+    @expected == @actual
+  end
+  
+  def failure_message
+    "\tExpected\n#@expected\n\tbut received\n#@actual"
+  end
+end
+
+def generate_query(query)
+  QueryMatcher.new(query)
+end

data/lib/lucene_query.rb

@@ -0,0 +1,152 @@
+class LuceneQuery
+  
+  VERSION = '0.1'
+  
+  ## Syntax Nodes
+  ::String.class_eval do
+    def to_lucene; "'#{escape_lucene}'" end
+    
+    def parens
+      if self =~ /^\s*$/
+        self
+      else
+        "(#{self})"
+      end
+    end
+    
+    # The Lucene documentation declares special characters to be:
+    #   + - && || ! ( ) { } [ ] ^ " ~ * ? : \
+    RE_ESCAPE_LUCENE = /
+      ( [-+!\(\)\{\}\[\]^"~*?:\\] # A special character
+      | &&                        # Boolean &&
+      | \|\|                      # Boolean ||
+      )
+    /x unless defined?(RE_ESCAPE_LUCENE)
+    
+    def escape_lucene
+      gsub(RE_ESCAPE_LUCENE) { |m| "\\#{m}" }
+    end
+  end
+  
+  ::Symbol.class_eval do
+    def to_lucene; to_s end
+  end
+  
+  ::Array.class_eval do
+    def to_lucene
+      map { |t| t.to_lucene }.join(" ").parens
+    end
+  end
+  
+  ::Hash.class_eval do
+    def to_lucene
+      inner = map { |k,v| Field.new(k, v) }
+      LuceneQuery::And.new(*inner).to_lucene
+    end
+  end
+  
+  ::Numeric.module_eval do
+    def to_lucene; to_s end
+  end
+  
+  ::TrueClass.class_eval do
+    def to_lucene; to_s end
+  end
+  
+  ::FalseClass.class_eval do
+    def to_lucene; to_s end
+  end
+  
+  class Field
+    def initialize(key, val)
+      @key, @val = key, val
+    end
+    
+    def to_lucene
+      @key.to_lucene + ":" + @val.to_lucene
+    end
+  end
+  
+  class InfixOperator
+    def initialize(*terms) @terms = terms end
+    
+    def to_lucene
+      @terms.map { |t| t.to_lucene }.join(" #{operator} ").parens
+    end
+  end
+  
+  class And < InfixOperator
+    def operator; "AND" end
+  end
+  
+  class Or < InfixOperator
+    def operator; "OR" end
+  end
+  
+  class Not
+    def initialize(term) @term = term end
+    
+    def to_lucene
+      "NOT #{@term.to_lucene}"
+    end
+  end
+  
+  class Required
+    def initialize(term) @term = term end
+    
+    def to_lucene
+      "+" + @term.to_lucene
+    end
+  end
+  
+  class Prohibit
+    def initialize(term) @term = term end
+    
+    def to_lucene
+      "-" + @term.to_lucene
+    end
+  end
+  
+  class Fuzzy
+    def initialize(term, boost=nil)
+      @term, @boost = term, boost
+    end
+    
+    def to_lucene
+      @term.split(/\s+/).map { |t|
+        @boost ? "%s~%1.1f" % [t.escape_lucene, @boost] : "%s~" % t.escape_lucene
+      } * " "
+    end
+  end
+  
+  ## DSL Helpers
+  class QueryBuilder
+    def self.generate(*args, &block)
+      new.generate(*args, &block)
+    end
+    
+    def generate(&block)
+      instance_eval(&block)
+    end
+    
+    def Field(key, val) Field.new(key, val) end
+    def And(*terms) And.new(*terms) end
+    def Or(*terms) Or.new(*terms) end
+    def In(field, terms)
+      Or.new(*terms.map { |term| Field.new(field, term) })
+    end
+    def Not(term) Not.new(term) end
+    def Required(term) Required.new(term) end
+    def Prohibit(term) Prohibit.new(term) end
+    def Fuzzy(*args) Fuzzy.new(*args) end
+  end
+  
+  def initialize(&block)
+    @term = QueryBuilder.generate(&block)
+  end
+  
+  def to_s; @term.to_lucene end
+  alias :to_str :to_s
+end
+
+SolrQuery = LuceneQuery unless defined?(SolrQuery)

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: lucene_query
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Jeremy Voorhis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jvoorhis@elevatedrails.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- lib/lucene_query.rb
+- examples/lucene_query.rb
+has_rdoc: true
+homepage: http://www.elevatedrails.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Query builder for the Lucene (and Solr) search engine.
+test_files: []
+