stretchy 0.4.6 → 0.4.7

data/lib/stretchy/clauses/boost_where_clause.rb

@@ -2,13 +2,13 @@ require 'stretchy/clauses/boost_clause'
 
 module Stretchy
   module Clauses
-      # 
+      #
       # Boosts documents that match certain filters. Most filters will
-      # be passed into {#initialize}, but you can also use `.range` and 
+      # be passed into {#initialize}, but you can also use `.range` and
       # `.geo` .
-      # 
+      #
       # @author [atevans]
-      # 
+      #
     class BoostWhereClause < BoostClause
 
       def boost_where(params = {}, options = {})
@@ -20,18 +20,18 @@ module Stretchy
         self
       end
 
-      # 
+      #
       # Returns to the base context; filters passed here
       # will be used to filter documents.
-      # 
+      #
       # @example Returning to base context
       #   query.boost.where(number_field: 33).where(other_field: 64)
-      # 
+      #
       # @example Staying in boost context
       #   query.boost.where(number_field: 33).boost.where(other_field: 99)
-      # 
+      #
       # @see {WhereClause#initialize}
-      # 
+      #
       # @return [WhereClause] Query with where clause applied
       def where(*args)
         WhereClause.new(base).where(*args)
@@ -42,64 +42,82 @@ module Stretchy
         boost_where(params, options)
       end
 
-      # 
+      #
+      # Boosts documents that match a filter composed of arbitrary json
+      # passed into the method.
+      #
+      # @param [Hash] Parameters for the filter. See {WhereClause#filter}
+      # @param [Hash] Options for Stretchy to determine behavior of this boost
+      #
+      # @see {WhereClause#query}
+      #
+      # @return [Base] Query with filter boost applied
+      def filter(params = {}, options = {})
+        weight = params.delete(:weight) || options[:weight]
+        clause = WhereClause.new.filter(params)
+        boost = clause.to_boost
+        base.boost_builder.add_boost(boost) if boost
+        Base.new(base)
+      end
+
+      #
       # Returns to the base context. Queries passed here
       # will be used to filter documents.
-      # 
+      #
       # @example Returning to base context
       #   query.boost.where(number_field: 89).match('username')
-      # 
+      #
       # @example Staying in boost context
       #   query.boost.where(number_field: 89).boost.match('love')
-      # 
+      #
       # @see {MatchClause#initialize}
-      # 
+      #
       # @return [MatchClause] Base context with match queries applied
       def match(*args)
         MatchClause.new(base).match(*args)
       end
 
-      # 
+      #
       # Applies a range filter with a min or max
       # as a boost.
-      # 
+      #
       # @see {WhereClause#range}
-      # 
+      #
       # @see {Filters::RangeFilter}
-      # 
+      #
       # @see http://www.elastic.co/guide/en/elasticsearch/guide/master/_ranges.html Elastic Guides - Ranges
-      # 
+      #
       # @return [Base] Query in base context with range boost applied
       def range(field, options = {})
         weight = options[:weight]
         options[:inverse] = true if inverse?
-        
+
         clause = WhereClause.new.range(field, options)
         boost  = clause.to_boost(weight)
         base.boost_builder.add_boost(boost) if boost
-        
+
         Base.new(base)
       end
 
-      # 
+      #
       # Boosts a document if it matches a geo filter.
       # This is different than {BoostClause#near} -
       # while `.near` applies a decay function that boosts
       # based on how close a field is to a geo point,
       # `.geo` applies a filter that either boosts or doesn't
       # boost the document.
-      # 
+      #
       # @see {WhereFunction#geo}
-      # 
+      #
       # @see {Filters::GeoFilter}
-      # 
+      #
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-geo-distance-filter.html Elastic Docs - Geo Distance Filter
-      # 
+      #
       # @return [Base] Query in base context with geo filter boost applied
       def geo(field, options = {})
         weight = options[:weight]
         options[:inverse] = true if inverse?
-        
+
         clause = WhereClause.new.geo(field, options)
         boost  = clause.to_boost(weight)
         base.boost_builder.add_boost(boost) if boost
@@ -107,4 +125,4 @@ module Stretchy
       end
     end
   end
-end
+end

data/lib/stretchy/clauses/match_clause.rb

@@ -2,13 +2,13 @@ require 'stretchy/clauses/base'
 
 module Stretchy
   module Clauses
-      # 
+      #
       # A Match clause inherits the same state as any clause.
       # There aren't any more specific methods to chain, as
       # this clause only handles basic full-text searches.
-      # 
+      #
       # @author [atevans]
-      # 
+      #
     class MatchClause < Base
 
       FULLTEXT_SLOP = 50
@@ -20,14 +20,27 @@ module Stretchy
         self
       end
 
-      # 
+      #
+      # Add arbitrary json as a query in the appropriate context.
+      # This can be used to add query types that are not currently
+      # supported by Stretchy to be used in the final query.
+      #
+      # @param params = {} [Hash] Query to be applied to the new state
+      # @option  options [true, false] :inverse (nil) Ignore query state and add to the `not` query
+      # @option  options [true, false] :should (nil) Ignore query state and add to the `should` query
+      def query(params = {}, options = {})
+        base.add_query(Queries::ParamsQuery.new(params), merge_state(options))
+        self
+      end
+
+      #
       # Specifies that values for this field should be
       # matched with a proximity boost, rather than as
       # a generic match query.
-      # 
+      #
       # This means searching for "quick brown fox" will
       # return matches in the following order:
-      # 
+      #
       # * "the quick brown fox jumped over"
       # * "the brown quick fox jumped over"
       # * "the fox, brown & quick jumped over"
@@ -35,23 +48,23 @@ module Stretchy
       # * "the quick green and purple sparkly fox jumped over"
       # * "the quick dog jumped over"
       # * "the adoreable puppy jumped over" **not returned**
-      # 
+      #
       # @overload phrase(params)
-      #   @param params = {} [String] A phrase that will 
+      #   @param params = {} [String] A phrase that will
       #     be matched anywhere in the document
-      # 
+      #
       # @overload phrase(params)
       #   @param params = {} [Hash] A hash of fields and phrases
       #     that should be matched in those fields
-      # 
+      #
       # @example Matching multiple words together
       #   query.match.phrase('hugs and love')
-      # 
+      #
       # @example Not matching a phrase
       #   query.match.not.phrase(comment: 'offensive words to hide')
-      # 
+      #
       # @return [self] Allows continuing the query chain
-      # 
+      #
       # @see https://www.elastic.co/guide/en/elasticsearch/guide/current/proximity-relevance.html Elasticsearch guide: proximity for relevance
       def fulltext(params = {})
         add_params(params)
@@ -59,8 +72,8 @@ module Stretchy
         self
       end
 
-      # 
-      # Adds a MoreLikeThis query to the chain. Pass in document ids, 
+      #
+      # Adds a MoreLikeThis query to the chain. Pass in document ids,
       # an array of index/name/ids, or a string to get documents that
       # have similar terms.
       #
@@ -81,9 +94,9 @@ module Stretchy
       #     Defaults to '_all'
       #   @option params [Array] :include Whether the source documents should be
       #     included in the result set. Defaults to `false`
-      # 
+      #
       # @return [MatchClause] allows continuing the query chain
-      # 
+      #
       # @example Getting more like a document by id
       #   query.more_like(ids: other_result_id)
       #
@@ -92,32 +105,29 @@ module Stretchy
       #
       # @example Getting more like a document from a string
       #   query.more_like(like_text: 'puppies and kittens are great')
-      # 
+      #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-mlt-query.html Elasticsearch more-like-this query documentation
       #
       def more_like(params = {}, options = {})
         query = Queries::MoreLikeThisQuery.new(params)
-        options[:inverse] = true if inverse?
-        options[:should]  = true if should?
-
-        base.add_query(query, options)
+        base.add_query(query, merge_state(options))
         self
       end
 
-      # 
+      #
       # Switches to inverted context. Matches applied here work the same way as
       # {#initialize}, but returned documents must **not** match these filters.
-      # 
+      #
       # @overload not(params)
       #   @param [String] A string that must not be matched anywhere in the document
       # @overload not(params)
       #   @param [Hash] A hash of fields and strings that must not be matched in those fields
-      # 
+      #
       # @return [MatchClause] inverted query state with match filters applied
-      # 
+      #
       # @example Inverted full-text
       #   query.match.not("hello")
-      # 
+      #
       # @example Inverted full-text matching for specific fields
       #   query.match.not(
       #     my_field: "not_match_1",
@@ -129,35 +139,35 @@ module Stretchy
         self
       end
 
-      # 
+      #
       # Switches to `should` context. Applies full-text matches
       # that are not required, but boost the relevance score for
       # matching documents.
-      # 
+      #
       # Can be chained with {#not}
-      # 
+      #
       # @overload should(params)
       #   @param [String] A string that should be matched anywhere in the document
       # @overload should(params)
       #   @param [Hash] A hash of fields and strings that should be matched in those fields
-      # 
+      #
       # @return [MatchClause] query state with should filters added
-      # 
+      #
       # @example Should match with full-text
       #   query.match.should("anywhere")
-      # 
+      #
       # @example Should match specific fields
       #   query.match.should(
       #     field_one: "one",
       #     field_two: "two"
       #   )
-      # 
+      #
       # @example Should not match
       #   query.match.should.not(
       #     field_one: "one",
       #     field_two: "two"
       #   )
-      # 
+      #
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html Elastic Docs - Bool Query
       def should(params = {}, options = {})
         @should  = true
@@ -166,16 +176,16 @@ module Stretchy
         self
       end
 
-      # 
+      #
       # Converts this match context to a set of boosts
       # to use in a {Stretchy::Queries::FunctionScoreQuery}
-      # 
+      #
       # @param weight = nil [Numeric] Weight of generated boost
-      # 
+      #
       # @return [Stretchy::Boosts::FilterBoost] boost containing these match parameters
       def to_boost(weight = nil)
         weight ||= Stretchy::Boosts::FilterBoost::DEFAULT_WEIGHT
-        
+
         Stretchy::Boosts::FilterBoost.new(
           filter: Stretchy::Filters::QueryFilter.new(
             base.match_builder.to_query
@@ -184,9 +194,9 @@ module Stretchy
         )
       end
 
-      # 
+      #
       # Accessor for `@should`
-      # 
+      #
       # @return [true, false] `@should`
       def should?
         !!@should
@@ -213,4 +223,4 @@ module Stretchy
 
     end
   end
-end
+end