stretchy 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6b9494adc6453711289b4e3c5321c683d190ab7
-  data.tar.gz: 0d8832b4787080dff61db37429c7cf8d021a0074
+  metadata.gz: 9296a4a37e2bf84e553b9b5757132c71d0bfca0c
+  data.tar.gz: 8e9eea9e347fb728f3a779bc0ba32713c52549c9
 SHA512:
-  metadata.gz: 5b3bb35dcdeec2eb3745b29c4adfa127e6055c02ed3273a8c308f25135f1dd5a9498b0f3de3c1684934b78f60687a2c56caed3bac45da8a7a0b127f8d7b299cf
-  data.tar.gz: aa4e00a5abda4a8ca7e581ecc5b84a513283deeacc8b295412d4bc561c388c3895562612a0b9a041d9938ab99fa8e8f53cfcefa7ae1c1cdce403b40fe71eef37
+  metadata.gz: 23721cc1bee9c018e53c3ca34f68e5c9c46d6e9e593c59fcdb3eb27b32bc869fccd36e6ac64736a62e5993d9ddd2da4eaff3d1d43e70ec48cd2a2d2f166c9b4e
+  data.tar.gz: 020882eeb4e78a3bc16a6749d963ab9850cfc6d2fd2727dc218312078e917f6a4c2738fb4b66b16dc861a89fa141f9ca88d063c94c21bc838f870d67ba85fc46

data/lib/stretchy/clauses/base.rb

@@ -48,10 +48,11 @@ module Stretchy
           @where_builder      = base.where_builder
           @boost_builder      = base.boost_builder
           @aggregate_builder  = base.aggregate_builder
-          @inverse            = options[:inverse] || base.inverse
+          @inverse            = options[:inverse]
           @limit              = base.get_limit
           @offset             = base.get_offset
           @explain            = base.get_explain
+          @fields             = base.get_fields
         else
           options = Hash(base_or_opts).merge(options)
           @index_name         = options[:index] || Stretchy.index_name
@@ -63,6 +64,7 @@ module Stretchy
           @inverse            = options[:inverse]
           @limit              = DEFAULT_LIMIT
           @offset             = DEFAULT_OFFSET
+          @fields             = nil
         end
       end
 
@@ -133,6 +135,34 @@ module Stretchy
       end
       alias :current_page :get_page
 
+      # 
+      # Select fields for Elasticsearch to return
+      # 
+      # By default, Stretchy will return the entire _source 
+      # for each document. If you call `.fields` with no
+      # arguments or an empty array, Stretchy will pass
+      # an empty array and only the "_type" and "_id"
+      # fields will be returned.
+      # 
+      # @see  https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-fields.html Elastic Docs - Fields
+      # 
+      # @param new_fields [Array] Fields elasticsearch should return
+      # 
+      # @return [self] Allows continuing the query chain
+      def fields(*args)
+        @fields ||= []
+        @fields += args.flatten if args.any?
+        self
+      end
+
+      # 
+      # Accessor for fields Elasticsearch will return
+      # 
+      # @return [Array] List of fields in the current query
+      def get_fields
+        @fields
+      end
+
       # 
       # Tells the search to explain the scoring
       # mechanism for each document.
@@ -183,17 +213,21 @@ module Stretchy
 
       # 
       # Used for boosting the relevance score of
-      # search results. Options passed here correspond
-      # to `where`-style filters which boost a document
-      # if matched.
+      # search results. `match` and `where` clauses
+      # added after `boost` will be applied as
+      # boosting functions instead of filters
+      # 
+      # @example Boost documents that match a filter
+      #   query.boost.where('post.user_id' => current_user.id)
       # 
-      # @param options = {} [type] [description]
+      # @example Boost documents that match fulltext search
+      #   query.boost.match('user search terms')
       # 
       # @return [BoostClause] query in boost context
       # 
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html Elastic Docs - Function Score Query
-      def boost(options = {})
-        BoostClause.new(self, options)
+      def boost
+        BoostClause.new(self)
       end
 
       # 
@@ -213,9 +247,9 @@ module Stretchy
       #   is given (ie, doing a full-text search across the whole document)
       def not(opts_or_string = {}, opts = {})
         if opts_or_string.is_a?(Hash)
-          WhereClause.new(self, opts_or_string.merge(inverse: true))
+          WhereClause.new(self).not(opts_or_string)
         else
-          MatchClause.new(self, opts_or_string, opts.merge(inverse: true))
+          MatchClause.new(self).not(opts_or_string)
         end
       end
 
@@ -239,9 +273,9 @@ module Stretchy
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-filter.html Elastic Docs - Bool Filter
       def should(opts_or_string = {}, opts = {})
         if opts_or_string.is_a?(Hash)
-          WhereClause.new(self, opts_or_string.merge(should: true))
+          WhereClause.new(self).should(opts_or_string)
         else
-          MatchClause.new(self, opts_or_string, opts.merge(should: true))
+          MatchClause.new(self).should(opts_or_string)
         end
       end
 

data/lib/stretchy/clauses/boost_clause.rb

@@ -31,9 +31,8 @@ module Stretchy
       # @param options = {} [Hash] Options for the boost clause
       # @option options [true, false] :inverse (nil) If this boost should also be in the inverse state
       # 
-      def initialize(base, options = {})
+      def initialize(base)
         super(base)
-        @inverse = options.delete(:inverse)
       end
 
       # 
@@ -199,7 +198,8 @@ module Stretchy
       # 
       # @return [BoostClause] Boost clause in inverse context
       def not(options = {})
-        self.class.new(self, options.merge(inverse: !inverse?))
+        @inverse = true
+        self
       end
 
     end

data/lib/stretchy/clauses/boost_match_clause.rb

@@ -30,10 +30,8 @@ module Stretchy
       def initialize(base, opts_or_string = {}, options = {})
         super(base)
         if opts_or_string.is_a?(Hash)
-          @inverse = opts_or_string.delete(:inverse) || options.delete(:inverse)
           match_function(opts_or_string.merge(options))
         else
-          @inverse = options.delete(:inverse)
           match_function(options.merge('_all' => opts_or_string))
         end
       end
@@ -50,8 +48,14 @@ module Stretchy
       #   @param opts_or_string [Hash] Fields and values that should not match in the document
       # 
       # @return [BoostMatchClause] Query with inverse matching boost function applied
-      def not(opts_or_string = {}, options = {})
-        self.class.new(self, opts_or_string, options.merge(inverse: !inverse?))
+      def not(opts_or_string = {})
+        @inverse = true
+        if opts_or_string.is_a?(Hash)
+          match_function(opts_or_string)
+        else
+          match_function('_all' => opts_or_string)
+        end
+        self
       end
 
       # 

data/lib/stretchy/clauses/boost_where_clause.rb

@@ -21,8 +21,8 @@ module Stretchy
       # 
       # @return [BoostWhereClause] Query with filter boosts applied
       def initialize(base, options = {})
-        super(base, options)
-        where_function(:init, options)
+        super(base)
+        where_function(:init, options) if options.any?
         self
       end
 

data/lib/stretchy/clauses/match_clause.rb

@@ -21,7 +21,11 @@ module Stretchy
       # 
       # @return [MatchClause] Temporary clause outside current state
       def self.tmp(options = {})
-        self.new(Base.new, options)
+        if options.delete(:inverse)
+          self.new(Base.new).not(options)
+        else
+          self.new(Base.new, options)
+        end
       end
 
       # 
@@ -77,8 +81,10 @@ module Stretchy
       #     my_field: "not_match_1",
       #     other_field: "not_match_2"
       #   )
-      def not(opts_or_str = {}, options = {})
-        self.class.new(self, opts_or_str, options.merge(inverse: true, should: should?))
+      def not(opts_or_str = {})
+        @inverse = true
+        add_params(opts_or_str)
+        self
       end
 
       # 
@@ -88,9 +94,9 @@ module Stretchy
       # 
       # Can be chained with {#not}
       # 
-      # @overload not(opts_or_str)
+      # @overload should(opts_or_str)
       #   @param [String] A string that should be matched anywhere in the document
-      # @overload not(opts_or_str)
+      # @overload should(opts_or_str)
       #   @param [Hash] A hash of fields and strings that should be matched in those fields
       # 
       # @param opts_or_str = {} [type] [description]
@@ -114,8 +120,11 @@ module Stretchy
       #   )
       # 
       # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html Elastic Docs - Bool Query
-      def should(opts_or_str = {}, options = {})
-        self.class.new(self, opts_or_str, options.merge(should: true))
+      def should(opts_or_str = {})
+        @should  = true
+        @inverse = false
+        add_params(opts_or_str)
+        self
       end
 
       # 

data/lib/stretchy/clauses/where_clause.rb

@@ -31,7 +31,11 @@ module Stretchy
       # 
       # @return [WhereClause] A clause outside the main query context
       def self.tmp(options = {})
-        self.new(Base.new, options)
+        if options.delete(:inverse)
+          self.new(Base.new).not(options)
+        else
+          self.new(Base.new, options)
+        end
       end
 
       # 
@@ -60,8 +64,6 @@ module Stretchy
       # 
       def initialize(base, options = {})
         super(base)
-        @inverse = options.delete(:inverse)
-        @should  = options.delete(:should)
         add_params(options)
       end
 
@@ -153,7 +155,9 @@ module Stretchy
       #     match_field: [:these, "options"]
       #   )
       def not(options = {})
-        self.class.new(self, options.merge(inverse: true, should: should?))
+        @inverse = true
+        add_params(options)
+        self
       end
 
       # 
@@ -178,7 +182,10 @@ module Stretchy
       #     exists_field: nil
       #   ) 
       def should(options = {})
-        self.class.new(self, options.merge(should: true))
+        @inverse = false
+        @should  = true
+        add_params(options)
+        self
       end
 
       # 
@@ -190,7 +197,7 @@ module Stretchy
       # @return [Boosts::FilterBoost] A boost including all the current filters
       def to_boost(weight = nil)
         weight ||= Stretchy::Boosts::FilterBoost::DEFAULT_WEIGHT
-        
+
         if @match_builder.any? && @where_builder.any?
           Stretchy::Boosts::FilterBoost.new(
             filter: Stretchy::Filters::QueryFilter.new(

data/lib/stretchy/results/base.rb

@@ -19,6 +19,10 @@ module Stretchy
       alias :per_page :limit
       alias :limit_value :limit
 
+      def fields
+        clause.get_fields
+      end
+
       def offset
         clause.get_offset
       end
@@ -45,7 +49,8 @@ module Stretchy
           from: offset,
           size: limit
         }
-        params[:explain] = true                 if clause.get_explain
+        params[:fields]  = fields   if fields
+        params[:explain] = true     if clause.get_explain
         @response ||= Stretchy.search(params)
       end
 
@@ -55,8 +60,16 @@ module Stretchy
 
       def hits
         @hits ||= response['hits']['hits'].map do |hit|
-          merge_fields = hit.reject{|field, _| field == '_source' }
-          hit['_source'].merge(merge_fields)
+          merge_fields = hit.reject{|field, _| ['_source', 'fields'].include?(field) }
+          
+          source_fields = {}
+          if hit['fields']
+            source_fields = Stretchy::Utils::DotHandler.convert_from_dotted_keys(hit['fields'])
+          elsif hit['_source']
+            source_fields = hit['_source']
+          end
+          
+          source_fields.merge(merge_fields)
         end
       end
       alias :results :hits

data/lib/stretchy/utils/dot_handler.rb

@@ -0,0 +1,44 @@
+module Stretchy
+  module Utils
+    module DotHandler
+
+      module_function
+
+      def self.convert_from_dotted_keys(hash)
+        new_hash = {}
+
+        hash.each do |key, value|
+          h = new_hash
+
+          parts = key.to_s.split('.')
+          while parts.length > 0
+            new_key = parts[0]
+            rest = parts[1..-1]
+
+            if not h.instance_of? Hash
+              raise ArgumentError, "Trying to set key #{new_key} to value #{value} on a non hash #{h}\n"
+            end
+
+            if rest.length == 0
+              if h[new_key].instance_of? Hash
+                raise ArgumentError, "Replacing a hash with a scalar. key #{new_key}, value #{value}, current value #{h[new_key]}\n"
+              end
+
+              h.store(new_key, value)
+              break
+            end
+
+            if h[new_key].nil?
+              h[new_key] = {}
+            end
+
+            h = h[new_key]
+            parts = rest
+          end
+        end
+
+        new_hash
+      end
+    end
+  end
+end

data/lib/stretchy/utils.rb

@@ -1,5 +1,6 @@
 require 'stretchy/utils/contract'
 require 'stretchy/utils/colorize'
 require 'stretchy/utils/logger'
+require 'stretchy/utils/dot_handler'
 require 'stretchy/utils/configuration'
 require 'stretchy/utils/client_actions'

data/lib/stretchy/version.rb

@@ -1,3 +1,3 @@
 module Stretchy
-  VERSION = "0.3.8"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - agius
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -200,6 +200,7 @@ files:
 - lib/stretchy/utils/colorize.rb
 - lib/stretchy/utils/configuration.rb
 - lib/stretchy/utils/contract.rb
+- lib/stretchy/utils/dot_handler.rb
 - lib/stretchy/utils/logger.rb
 - lib/stretchy/version.rb
 - stretchy.gemspec