CloudSesame 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7aad854d12632f7a254e4d4130381ecf2c1e468
-  data.tar.gz: d150f9b6a91d47da8fd83df34b967c78507221bf
+  metadata.gz: d640359762a517c60a26d82969d821678bb14871
+  data.tar.gz: 7d9e1082e91951cd4d61061de81cba3416f8c93b
 SHA512:
-  metadata.gz: 1a2374d616b59d412dcc228f51343ce56e0d9686ffc322f272a7ded656976ffeaab5492cd83547feec36619279bea6a97d094f66b8377692f3e509f89122ce2b
-  data.tar.gz: 816abf070d875a9d1d2df1e54bd0b1aa23618d09c1bcbf0d4e067c6abb6170667c8889b649066bd5fbe3d1aa4be712ce5251bfc73562fdd9a0f5c4ccac1f2ceb
+  metadata.gz: 392b5a7c410506f2a4c0547853c31e1ce282063191251eb3fa0f30b64cf3aa503d41bdb13e52ebaec879fa9de7f8dce00a34f846d667d6e0ea334d9b8dc4b55c
+  data.tar.gz: 064717d64e27d0ae3f172b7ab0d0bd870dd40240b93d17b5e4ff6fb6f75b7dd9cd6c4b5e0d1352dc9934997ef1c460a0ffab50c5f4b65a85736f34a7493ea1a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    CloudSesame (0.1.4)
+    CloudSesame (0.1.6)
       aws-sdk (~> 2)
 
 GEM

data/README.md

@@ -0,0 +1,57 @@
+#CloudSesame
+Light and Flexible CloudSearch Query Interface
+
+#Install
+* In terminal
+	```gem install CloudSesame```
+* In Gemfile
+	```gem 'CloudSesame```
+
+#Setup 
+
+2. Initalize the gem 
+* Inside the Rails `config/initializers` folder, create a file called `cloud_sesame.rb`
+* In the file, enter in your AWS credentials
+
+```
+require 'cloud_sesame'
+CloudSesame::Domain::Client.configure do |config|
+	config.access_key = ENV['AWS_ACCESS_KEY_ID']
+	config.secret_key = ENV['AWS_SECRET_ACCESS_KEY']
+end
+```
+
+3. Setup your searchable model
+
+* `include CloudSesame`
+* call `define_cloudsearch` to setup your CloudSearch config, default size (optional), fields, and scopes (optional).
+
+```
+class Product
+  include CloudSesame  
+  
+  define_cloudsearch do 
+    config.endpoint = ENV[AWS_ENDPOINT]
+    config.region = END[AWS_REGION]
+    
+    default_size 100  #will default to 10 if not defined
+    
+    field :description, query: true 
+    field :name, query: { weight: 2 }
+    field :currency, facet: true 
+    field :manufacturer, facet: { size: 50 }
+    field :price, facet: { buckets: %w([0, 25], [25, 50], [50, 100]), method: 'interval'}
+    
+    scope :puma_shoes, -> { query("shoes").and { manufacturer "Puma" } } 
+    scope :puma_shoes do 
+      query("shoes").and { manufacturer "Puma" } 
+    end
+
+  end
+end
+```
+
+4. How to define search fields 
+* to add a field to query_options, set `query: true` 
+* to add a field to query_options with a weight, set `query: { weight: <any integer> }`
+* to add a field to filter_query, set `facet : true`

data/cloud_sesame.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'CloudSesame'
-  s.version     = '0.1.5'
+  s.version     = '0.1.6'
   s.date        = '2016-01-14'
   s.summary     = "AWS CloudSearch Query Interface"
   s.description = "AWS CloudSearch Query Interface"

data/lib/cloud_sesame.rb

@@ -21,26 +21,29 @@ require 'cloud_sesame/query/dsl/page'
 require 'cloud_sesame/query/dsl/sort'
 require 'cloud_sesame/query/dsl/and'
 require 'cloud_sesame/query/dsl/or'
-require 'cloud_sesame/query/dsl/range'
 require 'cloud_sesame/query/dsl/literal'
-require 'cloud_sesame/query/dsl/literal_helper'
+require 'cloud_sesame/query/dsl/value'
 require 'cloud_sesame/query/dsl/scope'
 require 'cloud_sesame/query/dsl/filter_query'
+require 'cloud_sesame/query/dsl/boost'
+require 'cloud_sesame/query/dsl/return'
 
 # Query Query Filter Query AST Tree
 # ===============================================
 require 'cloud_sesame/query/ast/multi_branch'
 require 'cloud_sesame/query/ast/single_branch'
-require 'cloud_sesame/query/ast/root'
-require 'cloud_sesame/query/ast/leaf'
 require 'cloud_sesame/query/ast/multi_expression_operator'
+require 'cloud_sesame/query/ast/single_expression_operator'
 require 'cloud_sesame/query/ast/and'
 require 'cloud_sesame/query/ast/or'
-require 'cloud_sesame/query/ast/single_expression_operator'
 require 'cloud_sesame/query/ast/not'
 require 'cloud_sesame/query/ast/near'
+require 'cloud_sesame/query/ast/phrase'
 require 'cloud_sesame/query/ast/prefix'
+require 'cloud_sesame/query/ast/term'
 require 'cloud_sesame/query/ast/compound_array'
+require 'cloud_sesame/query/ast/root'
+require 'cloud_sesame/query/ast/leaf'
 require 'cloud_sesame/query/ast/literal'
 require 'cloud_sesame/query/ast/value'
 require 'cloud_sesame/query/ast/date_value'
@@ -58,6 +61,7 @@ require 'cloud_sesame/query/node/filter_query'
 require 'cloud_sesame/query/node/facet'
 require 'cloud_sesame/query/node/page'
 require 'cloud_sesame/query/node/sort'
+require 'cloud_sesame/query/node/return'
 
 # Query Builder Interface
 # ===============================================

data/lib/cloud_sesame/domain/base.rb

@@ -2,17 +2,13 @@ module CloudSesame
 	module Domain
 		class Base
 			extend Forwardable
-			include Query::DSL::Scope
+			include Query::Builder
 
 			attr_accessor :definition
-			attr_reader :searchable
+			attr_reader :searchable, :result
 
 			def_delegator :client, :config
 
-			def_delegators 	:builder, :query, :page, :size, :sort,
-																:and, :or, :included?, :excluded?,
-																:method_context, :method_return, :method_scope
-
 			def initialize(searchable)
 				@searchable = searchable
 			end
@@ -21,17 +17,13 @@ module CloudSesame
 				@client ||= Client.new
 			end
 
-			def builder
-				@builder ||= CloudSesame::Query::Builder.new context, searchable
+			def context
+				@context ||= Context.new
 			end
 
 			# DEFAULT CONTEXT METHODS
 			# =========================================
 
-			def context
-				@context ||= Context.new
-			end
-
 			def default_size(value)
 				context[:page, true][:size] = value
 			end

data/lib/cloud_sesame/query/ast/compound_array.rb

@@ -2,70 +2,65 @@ module CloudSesame
   module Query
     module AST
       class CompoundArray < Array
-        # include Range
 
-        attr_accessor :scope, :parent, :literal
-        attr_reader :field
+        attr_reader :scope, :field
 
-        def field=(field)
-          self.parent = nil
+        def for_field(field)
+          parents.clear
           @field = field
         end
 
-        def set_scope(scope)
-          self.scope = scope
+        def parents
+          @parents ||= []
+        end
+
+        def scope_to(scope)
+          @scope = scope
           return self
         end
 
         # SINGLE BRANCH OPERATOR
         # =======================================
 
-        # NOT
+        # NEAR
         # =======================================
-        def not(*values)
-          self.parent = AST::Not
-          insert_and_return_children(values)
+        def near(*values)
+          parents[1] = AST::Near
+          insert_and_return_children values
         end
 
-        alias_method :is_not, :not
+        alias_method :sloppy, :near
 
-        # NEAR
+        # NOT
         # =======================================
-        def near(*values)
-          self.parent = AST::Near
-          insert_and_return_children(values)
+        def not(*values)
+          parents[0] = AST::Not
+          insert_and_return_children values
         end
 
-        alias_method :sloppy, :near
+        alias_method :is_not, :not
 
-        # PREFIX LITERAL
+        # PREFIX
         # =======================================
         def prefix(*values)
-          self.parent = AST::Prefix
-          insert_and_return_children(values)
+          parents[1] = AST::Prefix
+          insert_and_return_children values
         end
 
         alias_method :start_with, :prefix
         alias_method :begin_with, :prefix
 
-        # RANGE LITERAL
-        # =======================================
-        # def range
-        #   self.literal = AST::PrefixLiteral
-        #   insert_and_return_children(values)
-        #   return self
-        # end
-
-        # alias_method :start_with, :prefix
-
         def insert_and_return_children(values = [])
           values.each do |value|
-            if parent
-              self << (node = parent.new scope.context)
-              node.child = AST::Literal.new(field, value, options)
-            else
-              self << AST::Literal.new(field, value, options)
+            value.child.field = field if value.kind_of?(AST::SingleExpressionOperator)
+            child = value.kind_of?(AST::SingleExpressionOperator) || value.kind_of?(AST::Literal) ? value : AST::Literal.new(field, value, options)
+
+            current_scope = self
+            parents.compact.each do |parent|
+              current_scope << (node = parent.new scope.context)
+              current_scope = node
             end
+            current_scope << child
           end
           return self
         end

data/lib/cloud_sesame/query/ast/date_value.rb

@@ -3,16 +3,8 @@ module CloudSesame
     module AST
       class DateValue < Value
 
-        def initialize(data)
-          @data = data
-        end
-
         def compile
-          strip escape @data.strftime('%FT%TZ')
-        end
-
-        def to_s
-          compile
+          strip escape data.strftime '%FT%TZ'
         end
 
       end

data/lib/cloud_sesame/query/ast/literal.rb

@@ -4,41 +4,41 @@ module CloudSesame
       class Literal < SingleBranch
 
         attr_accessor :field
-        attr_reader :value, :options
+        attr_reader :options, :value
 
-        def initialize(field, value, options = {})
-          self.field = field
-          self.value = value
-
-          @options = options
-          (options[:included] ||= []) << value
-        end
-
-        def detailed
-          options[:detailed] = true
-          return self
+        def initialize(field = nil, value = nil, options = {})
+          @field = field
+          @value = to_value value
+          ((@options = options || {})[:included] ||= []) << @value
         end
 
-        def value=(value)
-          @value = value.kind_of?(Value) ? value : Value.new(value)
+        def as_field
+          options[:as] || field
         end
 
         def compile
-          options[:detailed] ? long_format : short_format
+          options[:detailed] ? detailed_format : standard_format
         end
 
-        def as_field
-          options[:as] || field
+        def detailed
+          options[:detailed] = true
+          return self
         end
 
         private
 
-        def short_format
-          "#{ as_field }:#{ value.compile }"
+        def to_value(value)
+          return value if value.kind_of? Value
+          return RangeValue.new value if value.kind_of? Range
+          return DateValue.new(value) if value.kind_of?(Date) || value.kind_of?(Time)
+          Value.new value
         end
 
+        def standard_format
+          "#{ as_field }:#{ value.compile }"
+        end
 
-        def long_format
+        def detailed_format
           "field=#{ escape as_field } #{ value.compile }"
         end
 

data/lib/cloud_sesame/query/ast/multi_branch.rb

@@ -14,7 +14,7 @@ module CloudSesame
         end
 
         def children
-          @children ||= CompoundArray.new.set_scope self
+          @children ||= CompoundArray.new.scope_to self
         end
 
         def compile_children

data/lib/cloud_sesame/query/ast/multi_expression_operator.rb

@@ -2,20 +2,18 @@ module CloudSesame
   module Query
     module AST
       class MultiExpressionOperator < MultiBranch
+        include DSL::Boost
 
-        # Operator Symbol Writer
         def self.symbol=(symbol)
           @symbol = symbol
         end
 
-        # Operator Symbol Getter
         def self.symbol
           @symbol
         end
 
         def compile
-          raise Error::MissingOperatorSymbol if self.class.symbol.nil?
-          "(#{ self.class.symbol  } #{ compile_children })" unless children.empty?
+          "(#{ self.class.symbol  }#{ compile_boost } #{ compile_children })" unless children.empty?
         end
 
       end

data/lib/cloud_sesame/query/ast/near.rb

@@ -5,10 +5,19 @@ module CloudSesame
 				self.symbol = :near
 
 				def compile
-					child.detailed
-					super
+					child.detailed if child.kind_of?(Literal)
+          "(#{ self.class.symbol  }#{ compile_boost }#{ compile_distance } #{ child.compile })" if child
 				end
 
+        def distance(value)
+          @distance = value.to_i
+          return self
+        end
+
+        def compile_distance
+          " distance=#{ @distance }" if @distance
+        end
+
       end
     end
   end

data/lib/cloud_sesame/query/ast/phrase.rb

@@ -0,0 +1,14 @@
+module CloudSesame
+  module Query
+    module AST
+      class Phrase < SingleExpressionOperator
+				self.symbol = :phrase
+
+				def compile
+					child.detailed if child.kind_of?(Literal)
+					super
+				end
+      end
+    end
+  end
+end

data/lib/cloud_sesame/query/ast/prefix.rb

@@ -5,10 +5,9 @@ module CloudSesame
 				self.symbol = :prefix
 
 				def compile
-					child.detailed
+					child.detailed if child.kind_of?(Literal)
 					super
 				end
-
       end
     end
   end

data/lib/cloud_sesame/query/ast/range_value.rb

@@ -3,73 +3,48 @@ module CloudSesame
     module AST
       class RangeValue < Value
 
-        attr_accessor :lower_bound_included,
-                      :upper_bound_included
-
-        def initialize
-          @data = [nil, nil]
+        def initialize(range = nil)
+          @data = range ? [true, to_value(range.begin), to_value(range.end), !range.exclude_end?] : [false, nil, nil, false]
         end
 
         def compile
-          strip "#{ lower_bound }#{ lower.compile if lower },#{ upper.compile if upper }#{ upper_bound }"
-        end
-
-        def to_s
-          compile
+          "#{ lb }#{ data[1].to_s },#{ data[2].to_s }#{ ub }"
         end
 
         def gt(value)
-          self.lower = value
-          self.lower_bound_included = false
+          data[0], data[1] = false, to_value(value)
           return self
         end
 
         def gte(value)
-          self.lower = value
-          self.lower_bound_included = true
+          data[0], data[1] = true, to_value(value)
           return self
         end
 
         def lt(value)
-          self.upper = value
-          self.upper_bound_included = false
+          data[2], data[3] = to_value(value), false
           return self
         end
 
         def lte(value)
-          self.upper = value
-          self.upper_bound_included = true
+          data[2], data[3] = to_value(value), true
           return self
         end
 
-        def lower
-          data[0]
-        end
-
-        def lower=(value)
-          data[0] = to_value(value)
-        end
-
-        def upper
-          data[1]
-        end
-
-        def upper=(value)
-          data[1] = to_value(value)
-        end
+        private
 
-        def lower_bound
-          lower && lower_bound_included ? '[' : '{'
+        def to_value(value)
+          return value if value.kind_of? Value
+          return DateValue.new(value) if value.kind_of?(Date) || value.kind_of?(Time)
+          Value.new value
         end
 
-        def upper_bound
-          upper && upper_bound_included ? ']' : '}'
+        def lb
+          data[1] && data[0] ? '[' : '{'
         end
 
-        private
-
-        def to_value(value)
-          value.kind_of?(Value) ? value : Value.new(value)
+        def ub
+          data[2] && data[3] ? ']' : '}'
         end
 
       end