solr_query 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [Matthew Rudy Jacobs]
+
+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

@@ -0,0 +1,46 @@
+SolrQuery
+=========
+
+SolrQuery is a ruby library designed to make building nested Solr queries simple and standardized.
+
+It does everything for you,
+it deals with escaping characters,
+matching ActiveRecord objects by id.
+
+It'll take an array of strings,
+an array of ActiveRecords.
+
+Give it a Hash or a Range, and it'll sort out lucene range queries for you!
+
+Example
+=======
+
+build a query for solr;
+
+  SolrQuery.build(:keyword => "Feather duster")
+  #=> "feather duster"
+
+  SolrQuery.build(:keyword => "clean", :organisation => [organisation1, organisation2])
+  #=> "clean AND organisation:(275 OR 6534)"
+
+  SolrQuery.build(:colour => ["red", "pink"], :item_type => ["Toy", "Train"])
+  #=> "colour:(red OR pink) AND item_type:(Toy OR Train)"
+
+or you can specify a different magical key for keyword;
+
+  SolrQuery.build({:keyword => "old one", :new_keyword => "new one"}, :new_keyword)
+  #=> "new one AND keyword:(old one)"
+
+if you need to do range queries;
+
+  SolrQuery.build(:salary => {:min => "010000", :max => "050000"})
+  #=> "salary:([010000 TO 050000])"
+
+  SolrQuery.build(:salary => "010000".."050000")
+  #=> "salary:([010000 TO 050000])"
+
+  SolrQuery.build(:surname => {:min => "jacobs")
+  #=> "surname:([jacobs TO *])"
+
+
+Copyright (c) 2008 [Matthew Rudy Jacobs], released under the MIT license

data/Rakefile

@@ -0,0 +1,79 @@
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run the specs.'
+task :default => :spec
+
+desc 'Run specs for SolrQuery'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate documentation for the solr_query plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SolrQuery'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require "rubygems"
+require "rake/gempackagetask"
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "solr_query"
+  s.version           = "1.0.0"
+  s.description       = "Build SOLR queries, properly escaped, with a nice API"
+  s.summary           = "a ruby library designed to make building nested Solr queries simple and standardized. "
+  s.author            = "Matthew Rudy"
+  s.email             = "matthewrudyjacobs@gmail.com"
+  s.homepage          = "http://github.com/matthewrudy/solr_query"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(MIT-LICENSE Rakefile README) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+

data/lib/blank.rb

@@ -0,0 +1,58 @@
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, "", " ", +nil+, [], and {} are blank.
+  #
+  # This simplifies
+  #
+  # if !address.nil? && !address.empty?
+  #
+  # to
+  #
+  # if !address.blank?
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+    
+  # An object is present if it's not blank.
+  def present?
+    !blank?
+  end
+end
+ 
+class NilClass #:nodoc:
+  def blank?
+    true
+  end
+end
+ 
+class FalseClass #:nodoc:
+  def blank?
+    true
+  end
+end
+ 
+class TrueClass #:nodoc:
+  def blank?
+    false
+  end
+end
+ 
+class Array #:nodoc:
+  alias_method :blank?, :empty?
+end
+ 
+class Hash #:nodoc:
+  alias_method :blank?, :empty?
+end
+ 
+class String #:nodoc:
+  def blank?
+    self !~ /\S/
+  end
+end
+ 
+class Numeric #:nodoc:
+  def blank?
+    false
+  end
+end

data/lib/solr_query.rb

@@ -0,0 +1,108 @@
+unless nil.respond_to?(:blank?)
+  require File.join(File.dirname(__FILE__), "blank")
+end
+
+module SolrQuery
+  class << self
+    # build a query for solr
+    #
+    #   SolrQuery.build(:keyword => "Feather duster")
+    #   => "feather duster"
+    #
+    #   SolrQuery.build(:keyword => "clean", :organisation => [organisation1, organisation2])
+    #   => "clean AND organisation:(275 OR 6534)"
+    #
+    #   SolrQuery.build(:colour => ["red", "pink"], :item_type => ["Toy", "Train"])
+    #   => "colour:(red OR pink) AND item_type:(Toy OR Train)"
+    # 
+    # or you can specify a different magical key for keyword;
+    #
+    #   SolrQuery.build({:keyword => "old one", :new_keyword => "new one"}, :new_keyword)
+    #   => "new one AND keyword:(old one)"
+    # if you need to do range queries;
+    # 
+    #   SolrQuery.build(:salary => {:min => "010000", :max => "050000"})
+    #   => "salary:([010000 TO 050000])"
+    # 
+    #   SolrQuery.build(:salary => "010000".."050000")
+    #   => "salary:([010000 TO 050000])"
+    # 
+    #   SolrQuery.build(:surname => {:min => "jacobs")
+    #   => "surname:([jacobs TO *])"
+    def build(conditions = {}, keyword_key=:keyword)
+      conditions = conditions.dup # let's not accidentally kill our original params
+      query_parts = []
+      keyword = conditions.delete(keyword_key) # keyword is magical
+      unless keyword.blank?
+        query_parts << "#{solr_value(keyword, true)}"
+      end
+    
+      conditions.each do |field, value|
+        unless value.nil?
+          query_parts << "#{field}:(#{solr_value(value)})"
+        end
+      end
+      
+      if query_parts.empty?
+        return ""
+      else
+        return query_parts.join(" AND ")
+      end
+    end
+  
+    def solr_value(object, downcase=false)
+      if object.is_a?(Array) # case when Array will break for has_manys
+        if object.empty?
+          string = "NIL" # an empty array should be equivalent to "don't match anything"
+        else
+          string = object.map do |element|
+            solr_value(element, downcase)
+          end.join(" OR ")
+          downcase = false # don't downcase the ORs
+        end
+      elsif object.is_a?(Hash) || object.is_a?(Range)
+        return solr_range(object) # avoid escaping the *
+      elsif defined?(ActiveRecord) && object.is_a?(ActiveRecord::Base)
+        string = object.id.to_s
+      elsif object.is_a?(String)
+        if downcase && (bits = object.split(" OR ")) && bits.length > 1
+          return "(#{solr_value(bits, downcase)})"
+        else
+          string = object
+        end
+      else
+        string = object.to_s
+      end
+      string.downcase! if downcase
+      return escape_solr_string(string)
+    end
+    protected :solr_value
+    
+    def solr_range(object)
+      min = max = nil
+      if object.is_a?(Hash)
+        min = object[:min]
+        max = object[:max]
+      else
+        min = object.first
+        max = object.last
+      end
+      min = solr_value(min) if min
+      max = solr_value(max) if max
+      
+      min ||= "*"
+      max ||= "*"
+      
+      return "[#{min} TO #{max}]"
+    end
+    protected :solr_range
+
+    def escape_solr_string(string)
+      string.gsub(SOLR_ESCAPE_REGEXP, "\\\\\\0").strip
+    end
+    protected :escape_solr_string
+  end
+  
+  SOLR_ESCAPE_CHARACTERS = %w" \ + - ! ( ) : ; ^ [ ] { } ~ * ? "
+  SOLR_ESCAPE_REGEXP = Regexp.new(SOLR_ESCAPE_CHARACTERS.map{|char| Regexp.escape(char)}.join("|"))
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: solr_query
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Matthew Rudy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-26 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Build SOLR queries, properly escaped, with a nice API
+email: matthewrudyjacobs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- lib/blank.rb
+- lib/solr_query.rb
+has_rdoc: true
+homepage: http://github.com/matthewrudy/solr_query
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: a ruby library designed to make building nested Solr queries simple and standardized.
+test_files: []
+