waistband 0.2.0 → 0.2.1

data/README.md

@@ -145,6 +145,7 @@ index = Waistband::Index.new('search')
 query = index.query('shopping')
 query.add_fields('name', 'description') # look for the search term `shopping` in the attributes `name` and `description`
 query.add_term('task', 'true')          # only in documents where the attribute task is set to true
+query.add_optiona_term('task', 'true')  # prefers documents where the attribute task is set to true
 
 query.results # => returns an array of Waistband::QueryResult
 

data/lib/waistband/query.rb

@@ -9,15 +9,16 @@ module Waistband
     attr_accessor :page, :page_size
 
     def initialize(index, search_term, options = {})
-      @index        = index
-      @search_term  = search_term
-      @wildcards    = []
-      @fields       = []
-      @ranges       = []
-      @sorts        = []
-      @terms        = {}
-      @page         = (options[:page] || 1).to_i
-      @page_size    = (options[:page_size] || 20).to_i
+      @index          = index
+      @search_term    = search_term
+      @wildcards      = []
+      @fields         = []
+      @ranges         = []
+      @sorts          = []
+      @terms          = {}
+      @optional_terms = {}
+      @page           = (options[:page] || 1).to_i
+      @page_size      = (options[:page_size] || 20).to_i
     end
 
     def paginated_results
@@ -68,10 +69,18 @@ module Waistband
       @terms[key] ||= {
         keywords: []
       }
-      @terms[key][:keywords] += words.gsub(/ +/, ' ').strip.split(' ').uniq
+      @terms[key][:keywords] += prep_words_uniquely(words)
     end
     alias :add_term :add_terms
 
+    def add_optional_terms(key, words)
+      @optional_terms[key] ||= {
+        keywords: []
+      }
+      @optional_terms[key][:keywords] += prep_words_uniquely(words)
+    end
+    alias :add_optional_term :add_optional_terms
+
     def add_sort(key, ord)
       @sorts << {
         key: key,
@@ -93,9 +102,9 @@ module Waistband
         {
           query: {
             bool: {
-              must: must_to_hash,
+              must:     must_to_hash,
               must_not: [],
-              should: []
+              should:   should_to_hash
             }
           },
           from: from,
@@ -158,6 +167,16 @@ module Waistband
         must
       end
 
+      def should_to_hash
+        should = []
+
+        optional_terms.each do |term|
+          should << term
+        end
+
+        should
+      end
+
       def terms
         @terms.map do |key, term|
           {
@@ -168,10 +187,24 @@ module Waistband
         end
       end
 
+      def optional_terms
+        @optional_terms.map do |key, term|
+          {
+            terms: {
+              key.to_sym => term[:keywords]
+            }
+          }
+        end
+      end
+
       def from
         @page_size * (@page - 1)
       end
 
+      def prep_words_uniquely(str)
+        str.gsub(/ +/, ' ').strip.split(' ').uniq
+      end
+
     # /private
 
   end

data/lib/waistband/version.rb

@@ -1,3 +1,3 @@
 module Waistband
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/lib/query_spec.rb

@@ -12,22 +12,42 @@ describe Waistband::Query do
 
   describe '#execute!' do
 
-    it "gets results from elastic search" do
-      add_result!
+    before { add_result! }
 
+    it "gets results from elastic search" do
       json = query.send(:execute!)
+
       json['hits'].should be_a Hash
       json['hits']['total'].should > 0
-      json['hits']['hits'].size.should eql 1
-
-      json['hits']['hits'].each do |hit|
-        hit['_id'].should match(/^task_.*/)
-        hit['_source'].should be_a Hash
-        hit['_source']['id'].should eql 123123
-        hit['_source']['name'].should eql 'some shopping in ikea'
-        hit['_source']['user_id'].should eql 999
-        hit['_source']['description'].should eql 'i need you to pick up some stuff in ikea'
-      end
+      json['hits']['hits'].size.should eql 2
+
+      hit = json['hits']['hits'].first
+
+      hit['_id'].should match(/^task_.*/)
+      hit['_source'].should be_a Hash
+      hit['_source']['id'].should eql 123123
+      hit['_source']['name'].should eql 'some shopping in ikea'
+      hit['_source']['user_id'].should eql 999
+      hit['_source']['description'].should eql 'i need you to pick up some stuff in ikea'
+    end
+
+    it "boosts results with optional terms" do
+      query = index.query('shopping ikea')
+      query.add_field('name')
+      query.add_optional_term('internal', 'true')
+
+      json = query.send(:execute!)
+
+      json['hits']['hits'].size.should eql 2
+
+      hit = json['hits']['hits'].first
+
+      hit['_id'].should match(/^task_.*/)
+      hit['_source'].should be_a Hash
+      hit['_source']['id'].should eql 234234
+      hit['_source']['name'].should eql "some shopping in ikea and trader joe's"
+      hit['_source']['user_id'].should eql 987
+      hit['_source']['description'].should eql 'pick me up some eggs'
     end
 
   end
@@ -81,6 +101,20 @@ describe Waistband::Query do
 
   end
 
+  describe '#add_optional_term' do
+
+    it "adds the term on the key" do
+      query.add_optional_term('metro', 'boston')
+      query.instance_variable_get('@optional_terms')['metro'][:keywords].should eql ['boston']
+    end
+
+    it "adds several terms on multiple words" do
+      query.add_optional_term('metro', 'sf bay area')
+      query.instance_variable_get('@optional_terms')['metro'][:keywords].should eql ['sf', 'bay', 'area']
+    end
+
+  end
+
   describe '#terms' do
 
     it "builds an array of all terms" do
@@ -213,6 +247,7 @@ describe Waistband::Query do
     it 'constructs the query with several terms' do
       query.add_term('metro', 'sf bay area')
       query.add_term('geography', 'San Francisco')
+      query.add_optional_term('internal', 'true')
       query.add_field('name')
       query.add_field('description')
       
@@ -238,7 +273,13 @@ describe Waistband::Query do
               }
             ],
             must_not: [],
-            should: []
+            should: [
+              {
+                terms: {
+                  internal: ['true']
+                }
+              }
+            ]
           }
         },
         from: 0,
@@ -270,7 +311,8 @@ describe Waistband::Query do
   end
 
   def add_result!
-    index.store!("task_123123", {id: 123123, name: 'some shopping in ikea', user_id: 999, description: 'i need you to pick up some stuff in ikea'})
+    index.store!("task_123123", {id: 123123, name: 'some shopping in ikea',                   user_id: 999, description: 'i need you to pick up some stuff in ikea',  internal: false})
+    index.store!("task_234234", {id: 234234, name: "some shopping in ikea and trader joe's",  user_id: 987, description: 'pick me up some eggs',                      internal: true})
     index.refresh
 
     query.add_field('name')

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: waistband
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
+  prerelease: 
 platform: ruby
 authors:
 - David Jairala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,15 +78,17 @@ dependencies:
 - !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'
 description: Ruby interface to Elastic Search
@@ -121,26 +132,27 @@ files:
 homepage: https://github.com/taskrabbit/waistband
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Elastic Search all the things!
 test_files:
 - spec/config/waistband/waistband.yml

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 0bb1048847e31a803f414112221ee12f51ec7df9
-  data.tar.gz: 2ba18a9f7eb6ab073ce1a2c0f20b06fa4006b90f
-SHA512:
-  metadata.gz: e6e394da1f1941fcba5487e59debe69f063c4eb7893e33fb9bbfcf1c8fdc9017baceeaba2ada6b2ecdfb04fb2ffa943905439aea31855c4f7a4b7a2bd06094be
-  data.tar.gz: f45002b13606503854402badae133138e67cc351f6eae142b0e49c130023e71253bc0bed174ea65e79a30c8d97eb4bb8d0fd4070d957eec1131d1c5c0ad68ab7