stretchy 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9296a4a37e2bf84e553b9b5757132c71d0bfca0c
-  data.tar.gz: 8e9eea9e347fb728f3a779bc0ba32713c52549c9
+  metadata.gz: 53b93c00801430b33a5fe52f6ad1327b25049979
+  data.tar.gz: 238e3d9edb267bd9ddfe03706fc6ffc28f4ce820
 SHA512:
-  metadata.gz: 23721cc1bee9c018e53c3ca34f68e5c9c46d6e9e593c59fcdb3eb27b32bc869fccd36e6ac64736a62e5993d9ddd2da4eaff3d1d43e70ec48cd2a2d2f166c9b4e
-  data.tar.gz: 020882eeb4e78a3bc16a6749d963ab9850cfc6d2fd2727dc218312078e917f6a4c2738fb4b66b16dc861a89fa141f9ca88d063c94c21bc838f870d67ba85fc46
+  metadata.gz: e9699a839cbbb7808d1fcedd217744bb45661804be0d14f5d729cce0986f43f1653698db9fb3aa2267ce9a9cc19450a02e21e390acd6e3772b8ee4d7545b40fe
+  data.tar.gz: 7f865b3f1d4c7fb0e61d58b33bbe808aa0c6cc1c44d93545c2000f4819cc43b27b909e29e751745b0d8d002ade78c24b41d04099f10be7f5b4c15e75b2a45984

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 .rspec
-*.gem
+*.gem
+TODO*

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/lib/stretchy/boosts/base.rb

@@ -1,13 +1,12 @@
-require 'stretchy/utils/contract'
+require 'stretchy/utils/validation'
 
 module Stretchy
   module Boosts
     class Base
 
-      include Stretchy::Utils::Contract
+      include Stretchy::Utils::Validation
 
       DEFAULT_WEIGHT    = 1.2
-      DEFAULT_DECAY_FN  = :gauss
 
       def initialize
         raise "Override this in subclass"

data/lib/stretchy/boosts/field_decay_boost.rb

@@ -5,39 +5,43 @@ module Stretchy
   module Boosts
     class FieldDecayBoost < Base
 
-      attr_reader :field, :origin, :scale, :offset, :decay, :decay_amount, :weight
+      DEFAULT_DECAY_FN = :gauss
 
-      contract field: {type: :field, required: true},
-              origin: {required: true, type: [Numeric, Time, Date, Stretchy::Types::GeoPoint]},
-               scale: {required: true},
-               decay: {type: Numeric},
-                type: {type: :decay}
+      attribute :field
+      attribute :origin
+      attribute :scale
+      attribute :offset
+      attribute :decay,         Symbol, default: DEFAULT_DECAY_FN
+      attribute :decay_amount,  Float,  default: DEFAULT_WEIGHT
+      attribute :weight
+
+      validations do
+        rule :field,        :field
+        rule :origin,        type: {classes: [Numeric, Time, Date, Stretchy::Types::GeoPoint], required: true}
+        rule :scale,        :required
+        rule :decay,        :decay
+        rule :decay_amount,  type: {classes: Numeric}
+      end
 
       def initialize(options = {})
-        @field        = options[:field]
-        @origin       = options[:origin]
-        @scale        = options[:scale]
-        
-        @offset       = options[:offset]
-        @type         = options[:type]    || DEFAULT_DECAY_FN
-        @weight       = options[:weight]  || DEFAULT_WEIGHT
-        @decay        = options[:decay]
-        
+        self.class.attribute_set.set(self, options) if options
+        set_default_attributes
+
         validate!
       end
 
       def to_search
         json = {scale: @scale}
-        if @origin.is_a?(Stretchy::Types::Base)
+        if @origin.is_a?(Types::Base)
           json[:origin] = @origin.to_search
         else
           json[:origin] = @origin
         end
-        json[:offset] = @offset  if @offset
-        json[:decay]  = @decay   if @decay
+        json[:offset]   = @offset  if @offset
+        json[:decay]    = @decay_amount   if @decay_amount
 
         {
-          @type => {
+          @decay => {
             @field => json
           },
           weight: @weight

data/lib/stretchy/boosts/filter_boost.rb

@@ -5,10 +5,13 @@ module Stretchy
   module Boosts
     class FilterBoost < Base
 
-      attr_reader :filter, :weight
+      attribute :filter
+      attribute :weight, Numeric, default: DEFAULT_WEIGHT
 
-      contract filter: {type: Stretchy::Filters::Base},
-               weight: {type: Numeric}
+      validations do
+        rule :filter, type: {classes: Filters::Base}
+        rule :weight, type: {classes: Numeric}
+      end
 
       def initialize(options = {})
         @filter = options[:filter]

data/lib/stretchy/boosts/random_boost.rb

@@ -4,14 +4,17 @@ module Stretchy
   module Boosts
     class RandomBoost < Base
 
-      DEFAULT_WEIGHT = 1.2
+      attribute :seed,    Numeric
+      attribute :weight,  Numeric, default: DEFAULT_WEIGHT
 
-      contract seed: {type: Numeric},
-             weight: {type: Numeric}
+      validations do
+        rule :seed,   type: {classes: Numeric, required: true}
+        rule :weight, type: {classes: Numeric, required: true}
+      end
 
       # randomizes order (somewhat) consistently per-user
       # http://www.elastic.co/guide/en/elasticsearch/guide/current/random-scoring.html
-
+      
       def initialize(seed, weight = nil)
         @seed   = seed
         @weight = weight || DEFAULT_WEIGHT

data/lib/stretchy/builders/boost_builder.rb

@@ -16,7 +16,7 @@ module Stretchy
         @functions.any?
       end
 
-      def build(query_or_filter)
+      def to_search(query_or_filter)
         options = { 
           functions:  @functions,
           score_mode: @score_mode,

data/lib/stretchy/builders/filter_builder.rb

@@ -0,0 +1,55 @@
+module Stretchy
+  module Builders
+    class FilterBuilder
+
+      attr_reader :terms, :ranges, :geos, :exists, :inverse, :should
+
+      def initialize(options = {})
+        @terms    = Hash.new { [] }
+        @ranges   = Hash.new { [] }
+        @geos     = Hash.new { [] }
+        @exists   = []
+        @inverse  = !!options[:inverse]
+        @should   = !!options[:should]
+      end
+
+      def any?
+        @terms.any? || @ranges.any? || @geos.any? || @exists.any?
+      end
+
+      def add_terms(field, terms)
+        @terms[field] += Array(terms)
+        @terms[field].uniq!
+      end
+
+      def add_range(field, options)
+        @ranges[field] = Filters::RangeFilter.new(field, options)
+      end
+
+      def add_geo(field, distance, geo_point)
+        @geos[field] = Filters::GeoFilter.new(field, distance, geo_point)
+      end
+
+      def add_exists(fields)
+        @exists += clean_string_array(fields)
+        @exists.uniq!
+      end
+
+      def to_filters
+        filters = @ranges.values + @geos.values
+        filters += @terms.map do |field, values|
+          Filters::TermsFilter.new(field, values)
+        end
+
+        filters += @exists.map {|field| Filters::ExistsFilter.new(field) }
+        filters
+      end
+
+      private
+        def clean_string_array(values)
+          Array(values).map(&:to_s).map(&:strip).reject(&:empty?)
+        end
+
+    end
+  end
+end

data/lib/stretchy/builders/match_builder.rb

@@ -2,69 +2,67 @@ module Stretchy
   module Builders
     class MatchBuilder
 
-      attr_accessor :matches,           :matchops, 
-                    :antimatches,       :antimatchops,
-                    :shouldmatches,     :shouldmatchops,
-                    :shouldnotmatches,  :shouldnotmatchops
+      attr_accessor :must, :must_not, :should, :should_not
 
       def initialize
-        @matches           = Hash.new { [] }
-        @matchops          = Hash.new { 'and' }
-        
-        @antimatches       = Hash.new { [] }
-        @antimatchops      = Hash.new { 'and' }
-        
-        @shouldmatches     = Hash.new { [] }
-        @shouldmatchops    = Hash.new { 'and' }
-        
-        @shouldnotmatches  = Hash.new { [] }
-        @shouldnotmatchops = Hash.new { 'and' }
+        @must       = QueryBuilder.new
+        @must_not   = QueryBuilder.new
+        @should     = QueryBuilder.new
+        @should_not = QueryBuilder.new
       end
 
       def any?
-        @matches.any? || @antimatches.any? || @shouldmatches.any? || @shouldnotmatches.any?
+        must.any? || must_not.any? || should.any? || should_not.any?
+      end
+
+      def add_matches(field, matches, options = {})
+        builder_from_options(options).add_matches(field, matches, options)
       end
 
-      def build
+      def to_query
         return Stretchy::Queries::MatchAllQuery.new unless any?
 
-        if @matches.count > 1   || @antimatches.any? || 
-           @shouldmatches.any?  || @shouldnotmatches.any?
-          
+        if use_bool?
           bool_query
         else
-          to_queries(@matches, @matchops).first
+          must.to_query.first
         end
       end
 
-      def bool_query
-        Stretchy::Queries::BoolQuery.new(
-          must:     to_queries(@matches, @matchops),
-          must_not: to_queries(@antimatches, @antimatchops),
-          should:   build_should
-        )
-      end
+      private
+
+        def builder_from_options(options = {})
+          if options[:inverse] && options[:should]
+            should_not
+          elsif options[:inverse]
+            must_not
+          elsif options[:should]
+            should
+          else
+            must
+          end
+        end
+        
+        def use_bool?
+          must.count > 1 || must_not.any? || should.any? || should_not.any?
+        end
 
-      def build_should
-        if @shouldnotmatches.any?
+        def bool_query
           Stretchy::Queries::BoolQuery.new(
-            must:     to_queries(@shouldmatches, @shouldmatchops),
-            must_not: to_queries(@shouldnotmatches, @shouldnotmatchops)
+            must:     must.to_query,
+            must_not: must_not.to_query,
+            should:   build_should
           )
-        else
-          to_queries(@shouldmatches, @shouldmatchops)
         end
-      end
-
-      private
 
-        def to_queries(matches, operators)
-          matches.map do |field, strings|
-            Stretchy::Queries::MatchQuery.new(
-              field:    field,
-              string:   strings.join(' '),
-              operator: operators[field]
+        def build_should
+          if should.count > 1 || should_not.any?
+            Stretchy::Queries::BoolQuery.new(
+              must:     should.to_query,
+              must_not: should_not.to_query
             )
+          else
+            should.to_query.first
           end
         end
 

data/lib/stretchy/builders/query_builder.rb

@@ -0,0 +1,37 @@
+module Stretchy
+  module Builders
+    class QueryBuilder
+
+      extend Forwardable
+
+      delegate [:any?, :count, :length] => :matches
+
+      attr_reader :matches, :operators
+
+      def initialize
+        @matches    = Hash.new { [] }
+        @operators  = Hash.new { 'and' }
+      end
+
+      def add_matches(field, new_matches, options)
+        @matches[field] += Array(new_matches).map(&:to_s).map(&:strip).reject(&:empty?)
+        if options[:operator]
+          @operators[field] = options[:operator]
+        elsif options[:or]
+          @operators[field] = 'or'
+        end
+      end
+
+      def to_query
+        matches.map do |field, matches_for_field|
+          Queries::MatchQuery.new(
+            field:    field,
+            string:   matches_for_field.join(' '),
+            operator: operators[field]
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/stretchy/builders/shell_builder.rb

@@ -0,0 +1,53 @@
+module Stretchy
+  module Builders
+    class ShellBuilder
+
+      DEFAULT_LIMIT   = 30
+      DEFAULT_OFFSET  = 0
+
+      attr_accessor :index, :type, :limit, :offset, :explain,
+                    :match_builder, :where_builder, :boost_builder, 
+                    :aggregate_builder, :fields
+
+      def initialize(options = {})
+        @index              = options[:index] || Stretchy.index_name
+        @match_builder      = Stretchy::Builders::MatchBuilder.new
+        @where_builder      = Stretchy::Builders::WhereBuilder.new
+        @boost_builder      = Stretchy::Builders::BoostBuilder.new
+        @aggregate_builder  = {}
+        @limit              = options[:limit]  || DEFAULT_LIMIT
+        @offset             = options[:offset] || DEFAULT_OFFSET
+        @fields             = options[:fields]
+        @type               = options[:type]
+      end
+
+      def page
+        (offset.to_f / limit).ceil + 1
+      end
+      alias :current_page :page
+
+      # 
+      # Compiles the internal representation of your filters,
+      # full-text queries, and boosts into the JSON to be 
+      # passed to Elastic. If you want to know exactly what
+      # your query generated, you can call this method.
+      # 
+      # @return [Hash] the query hash to be compiled to json 
+      #   and sent to Elastic
+      def to_search
+        _to_search = if where_builder.any?
+          Stretchy::Queries::FilteredQuery.new(
+            query:  match_builder.to_query,
+            filter: where_builder.to_filter
+          )
+        else
+          match_builder.to_query
+        end
+
+        _to_search = boost_builder.to_search(_to_search) if boost_builder.any?
+        _to_search.to_search
+      end
+
+    end
+  end
+end