cyx-solr_query 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril David
+
+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/README.rdoc

@@ -0,0 +1,7 @@
+= solr_query
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Cyril David. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "solr_query"
+    gem.summary = %Q{TODO}
+    gem.email = "cyx.ucron@gmail.com"
+    gem.homepage = "http://github.com/cyx/solr_query"
+    gem.authors = ["Cyril David"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "solr_query #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/solr_query.rb

@@ -0,0 +1,78 @@
+require 'activesupport'
+
+class SolrQuery
+  AND = ' AND '
+  OR  = ' OR '
+  
+  def self.escape( str )
+    str.to_s.gsub(/([!+\-\(\)\{\}\[\]^\"\~\*\?\:\\])/, '\\\\\1')
+  end
+  
+  def self.create( operator = AND )
+    solr_query = new
+    yield solr_query
+    solr_query.to_s( operator )
+  end
+  
+  attr_reader :conditions
+  
+  def initialize
+    @conditions = []
+    @stream     = [ [] ]
+  end
+  
+  def union( &block )
+    do_operation( OR, &block )
+  end
+  
+  def intersection( &block )
+    do_operation( AND, &block )
+  end
+  
+  def push( condition )
+    stream.push( condition )
+  end
+  
+  def stream
+    @stream[-1]
+  end
+  
+  def condition( field, value, escaping = true )
+    return if value.blank?
+    stream.push("#{field}:#{escape(value, escaping)}")
+  end
+  
+  def term( value, escaping = true )
+    return if value.to_s.strip.blank?
+    stream.push( escape(value, escaping) )
+  end
+  
+  def like( value, escaping = true )
+    "#{escape(value.downcase, escaping)}*"
+  end
+  
+  def to_s( operator = AND )
+    stream.join( operator )
+  end
+  
+  protected
+    def parenthesize( str )
+      "( #{str} )"
+    end
+    
+    def do_operation( op )
+      solr_query = SolrQuery.new
+      @stream    << solr_query
+      yield
+      generated = @stream.pop.to_s( op )
+      stream.push(parenthesize(generated)) if generated.present?
+    end
+    
+    def escape( str, escaping = true )
+      if escaping
+        self.class.escape( str )
+      else
+        str
+      end
+    end
+end

data/test/solr_query_test.rb

@@ -0,0 +1,156 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SolrQueryTest < Test::Unit::TestCase
+  context "given term 'quick brown'" do
+    should "be quick brown" do
+      result = SolrQuery.create do |q|
+        q.term 'quick brown'
+      end
+      
+      assert_equal 'quick brown', result
+    end
+  end
+  
+  context "given term ' '" do 
+    should "be ''" do
+      result = SolrQuery.create { |q| q.term ' ' }
+      assert_equal '', result
+    end
+  end
+  
+  context "given term '' condition 'category_id', nil" do
+    should " be '' " do
+      result = SolrQuery.create do |q|
+        q.term ''
+        q.condition 'category_id', nil
+      end
+      
+      assert_equal '', result
+    end
+  end
+  # GIVEN: 
+  #
+  # SolrQuery.create do |q|
+  #     q.union {
+  #       q.condition 'allowed', 'all'
+  # 
+  #       q.union {
+  #         q.condition 'allowed', 'contacts'
+  #         q.condition 'poster_contact_ids', 1
+  #       }
+  #     }
+  #   end
+  context "given the query above" do 
+    should "be allowed:all OR (allowed:contacts OR poster_contact_ids:1)" do
+      result = SolrQuery.create do |q|
+        q.union {
+          q.condition 'allowed', 'all'
+  
+          q.union {
+            q.condition 'allowed', 'contacts'
+            q.condition 'poster_contact_ids', 1
+          }
+        }
+      end
+      
+      assert_equal '( allowed:all OR ( allowed:contacts OR poster_contact_ids:1 ) )', result
+    end
+  end
+  
+  context "given condition 'allowed', 'all'" do
+      should "be allowed:all" do
+        result = SolrQuery.create do |q|
+          q.condition 'allowed', 'all'
+        end
+        assert_equal 'allowed:all', result
+      end
+    end
+    
+    context "given condition 'allowed', 'all' then condition 'poster_contact_ids', 1" do
+      should "be allowed:all AND poster_contact_ids:1" do
+        result = SolrQuery.create do |q|
+          q.condition 'allowed', 'all'
+          q.condition 'poster_contact_ids', 1
+        end
+        
+        assert_equal 'allowed:all AND poster_contact_ids:1', result
+      end
+    end
+    
+  context "given condition 'allowed', 'all' union { condition 'poster_contact_ids', 1 condition 'hoy', 'hey' }" do
+    should "be allowed:all AND (poster_contact_ids:1 OR hoy:hey)" do
+      result = SolrQuery.create do |q|
+        q.condition 'allowed', 'all'
+        q.union {
+          q.condition 'poster_contact_ids', 1
+          q.condition 'hoy', 'hey'
+        }
+      end
+      
+      assert_equal 'allowed:all AND ( poster_contact_ids:1 OR hoy:hey )', result
+    end
+  end
+
+  context "given condition 'allowed', 'all' intersection { condition 'poster_contact_ids', 1 condition 'hoy', 'hey' }" do
+    should "be allowed:all AND (poster_contact_ids:1 AND hoy:hey)" do
+      result = SolrQuery.create do |q|
+        q.condition 'allowed', 'all'
+        q.intersection {
+          q.condition 'poster_contact_ids', 1
+          q.condition 'hoy', 'hey'
+        }
+      end
+      
+      assert_equal 'allowed:all AND ( poster_contact_ids:1 AND hoy:hey )', result
+    end
+  end
+  
+  #   union {
+  #     set :allowed, 'all'
+  #   
+  #     intersection {
+  #       set :allowed, 'contacts'
+  #       set :poster_contact_ids, 1
+  #     }
+  #   
+  #     union {
+  #       set :allowed, 1
+  #       set :allowed, 2
+  #     }
+  #   }
+  #   
+  context "given the pseudo code above" do
+    should "be (allowed:all OR (allowed:contacts AND poster_contact_ids:1) OR (allowed:1 OR allowed:2)" do
+      result = SolrQuery.create do |q|
+        q.union {
+          q.condition 'allowed', 'all'
+          
+          q.intersection {
+            q.condition 'allowed', 'contacts'
+            q.condition 'poster_contact_ids', 1
+          }
+          
+          q.union {
+            q.condition 'allowed', 1
+            q.condition 'allowed', 2
+          }
+        }
+      end
+      
+      assert_equal '( allowed:all OR ( allowed:contacts AND poster_contact_ids:1 ) OR ( allowed:1 OR allowed:2 ) )', result
+    end
+  end
+  
+  context "given condition 'allowed', 'all' intersection { }" do
+    should "be allowed:all" do
+      result = SolrQuery.create do |q|
+        q.condition 'allowed', 'all'
+        q.intersection {
+          
+        }
+      end
+      
+      assert_equal 'allowed:all', result
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'solr_query'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: cyx-solr_query
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: cyx.ucron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/solr_query.rb
+- test/solr_query_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/cyx/solr_query
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: TODO
+test_files: 
+- test/solr_query_test.rb
+- test/test_helper.rb