CloudSesame 0.1.6 → 0.2.0

data/spec/cloud_sesame/query/dsl/field_methods_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module CloudSesame
+	module Query
+		module DSL
+			describe FieldMethods do
+
+				# Setup Test Class
+				class Product
+					include CloudSesame
+					define_cloudsearch {
+						field :name
+						field :tags
+					}
+				end
+
+				subject(:cloudsearch) { Product.cloudsearch }
+
+				after { subject.clear_request }
+
+				context 'when field is registered' do
+					it 'should create a literal node' do
+						expect(AST::Literal).to receive(:new).with(:name, "my name", {})
+						subject.name "my name"
+					end
+					it 'should belong to the dsl context' do
+						expect{ subject.name "name" }.to change{ subject.request.filter_query.root.children.size }.by(1)
+					end
+					it 'should return the dsl scope if called from the root' do
+						expect(subject.tags "men").to eq subject
+					end
+					it 'should return the field array if called from inside a block' do
+						array = nil
+						subject.and { array = tags("men") }
+						expect(array).to be_kind_of(AST::FieldArray)
+						expect(array).to include(AST::Literal)
+					end
+					it 'shoudl set the field array#field' do
+						array = nil
+						subject.and { array = tags("men") }
+						expect(array.field).to eq :tags
+					end
+				end
+
+				context 'when field is not registered' do
+					it 'should raise an error' do
+						expect{ subject.description("description") }.to raise_error NoMethodError
+					end
+				end
+
+			end
+		end
+	end
+end

data/spec/cloud_sesame/query/node/query_spec.rb

@@ -10,31 +10,38 @@ module CloudSesame
         describe '#initialize' do
           context 'when arguments passed in' do
             let(:arguments) {{ query: "" }}
-            it 'should initalize an empty terms if query is empty' do
-              expect(node.terms).to eq []
+            it 'should initalize an empty string if query is empty' do
+              expect(node.query).to eq ""
             end
-            it 'should accept query as args and initialize terms' do
+            it 'should accept query as args and initialize query' do
               arguments[:query] = "hello world"
-              expect(node.terms).to eq ["hello", "world"]
+              expect(node.query).to eq "hello world"
             end
           end
           context 'when arguments not passed in' do
             it 'should initialize an empty terms' do
-              expect(node.terms).to eq []
+              expect(node.query).to eq nil
             end
           end
         end
 
         describe '#query' do
-          it 'should return a string with all the terms added' do
-            node.terms = ["term1", " term2", "term3 ", "-term4"]
+          it 'should return the query string' do
+            node.query = ["term1", "term2", "term3", "-term4"].join(' ')
             expect(node.query).to eq "term1 term2 term3 -term4"
           end
         end
 
-        describe '#run' do
+        describe '#compile' do
+          it 'should parse with fuzziness if fuzziness is defined' do
+            fuzziness = Fuzziness.new
+            node = Query.new(fuzziness: fuzziness)
+            node.query = ["term1", "term2", "term3", "-term4"].join(' ')
+            expect(fuzziness).to receive(:parse).with(node.query)
+            node.compile
+          end
           it 'should return a serialized hash contains query string' do
-            node.terms = ["term1", " term2", "term3 ", "-term4"]
+            node.query = ["term1", "term2", "term3", "-term4"].join(' ')
             expect(node.compile).to eq({ query: "term1 term2 term3 -term4" })
           end
         end

data/spec/cloud_sesame_spec.rb

@@ -2,74 +2,85 @@ require 'spec_helper'
 
 describe CloudSesame do
 
-	# # AWS initializer
-	# require 'yaml'
-	# YAML.load_file('aws.yml').each do |key, value|
-	# 	ENV["AWS_#{ key }"] = value
-	# end
-
-	# # Domain Initializer /config/initializers/cloudsearch.rb
-	# 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
-
-	# # Usage Example
-	# class Product
-	# 	include CloudSesame
-
-	# 	define_cloudsearch do
-	# 		# Product CloudSesame Config
-	# 		config.endpoint = ENV['AWS_ENDPOINT']
-	# 		config.region 	= ENV['AWS_REGION']
-
-	# 		default_size 100
-
-	# 		# describe_fuzziness do
-	# 		# 	max_fuzziness 3
-	# 		# 	min_word_length 6
-	# 		# 	fuzzy_percentage 0.17
-	# 		# end
-
-	# 		field :searchable_text, 		query: { weight: 2 }
-	# 		field :description, 				query: true
-	# 		field :tags
-
-	# 		field :affiliate_advertiser_ext_id, facet: { size: 50 }
-	# 		field :currency, 						facet: true
-	# 		field :discount_percentage, facet: { buckets: %w([10,100] [25,100] [50,100] [70,100]), method: 'interval' }
-	# 		field :manufacturer_name, 	facet: { size: 50 }
-	# 		field :price, 							facet: { buckets: %w([0,25] [25,50] [50,100] [100,200] [200,}), method: 'interval' }
-	# 		field :category_string, 		facet: { sort: 'bucket', size: 10_000 }
-	# 		field :created_at
-
-	# 		scope :men_tag, ->(date) { created_at date }
-	# 		scope :and_mens do
-	# 			and! { tags "men"}
-	# 		end
-	# 		scope :men_stuff, -> { query("men").sort().page }
-
-	# 	end
-
-	# end
-
-	# class NewProduct < Product
-	# 	load_definition_from Product
-
-	# 	define_cloudsearch do
-	# 		field :searchable_text, 		query: { weight: 4 }
-	# 		field :name, as: :text1
-	# 	end
-	# end
-
-
-
-
-	# # Example Query
-	# query = Product.cloudsearch.query("nike pants").create_at(Date.today)
-
+	# AWS initializer
+	require 'yaml'
+	YAML.load_file('aws.yml').each do |key, value|
+		ENV["AWS_#{ key }"] = value
+	end
+
+	# Domain Initializer /config/initializers/cloudsearch.rb
+	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
+
+	# Usage Example
+	class Product
+		include CloudSesame
+
+		define_cloudsearch do
+			# Product CloudSesame Config
+			config.endpoint = ENV['AWS_ENDPOINT']
+			config.region 	= ENV['AWS_REGION']
+
+			default_size 100
+
+			define_sloppiness 3
+
+			define_fuzziness do
+				max_fuzziness 3
+				min_char_size 6
+				fuzzy_percent 0.17
+			end
+
+			field :searchable_text, 		query: { weight: 2 }
+			field :description, 				query: true
+			field :tags
+
+			field :affiliate_advertiser_ext_id, facet: { size: 50 }
+			field :currency, 						facet: true
+			field :discount_percentage, facet: { buckets: %w([10,100] [25,100] [50,100] [70,100]), method: 'interval' }
+			field :manufacturer_name, 	facet: { size: 50 }
+			field :price, 							facet: { buckets: %w([0,25] [25,50] [50,100] [100,200] [200,}), method: 'interval' }
+			field :category_string, 		facet: { sort: 'bucket', size: 10_000 }
+			field :created_at
+
+			scope :men_tag, ->(date) { created_at date }
+			scope :and_mens do
+				and! { tags "men"}
+			end
+
+		end
+
+	end
+
+	class NewProduct < Product
+		load_definition_from Product
+
+		define_cloudsearch do
+			field :searchable_text, 		query: { weight: 4 }
+			field :name, as: :text1
+		end
+	end
+
+	# Example Query
+	query = Product.cloudsearch.query("children panasonic")
+	.and {
+		or!(boost: 2) {
+			# tags.not start_with "flash_deal"
+			tags.not.start_with "flash_deal"
+			# tags.near"sales"
+			# tags start_with("flash_deal"), near("sales")
+		}
+		or!.not {
+			currency "CAD", "EUR"
+		}
+		and! {
+			price r.gte(100).lt(200)
+		}
+	}.created_at(Date.today).description("wasup")
 
 	# binding.pry
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CloudSesame
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Scott Chu
@@ -108,38 +108,40 @@ files:
 - lib/cloud_sesame/domain/config.rb
 - lib/cloud_sesame/domain/context.rb
 - lib/cloud_sesame/query/ast/and.rb
-- lib/cloud_sesame/query/ast/compound_array.rb
+- lib/cloud_sesame/query/ast/block_chaining_relation.rb
 - lib/cloud_sesame/query/ast/date_value.rb
-- lib/cloud_sesame/query/ast/leaf.rb
+- lib/cloud_sesame/query/ast/field_array.rb
 - lib/cloud_sesame/query/ast/literal.rb
-- lib/cloud_sesame/query/ast/multi_branch.rb
 - lib/cloud_sesame/query/ast/multi_expression_operator.rb
 - lib/cloud_sesame/query/ast/near.rb
 - lib/cloud_sesame/query/ast/not.rb
+- lib/cloud_sesame/query/ast/operator.rb
 - lib/cloud_sesame/query/ast/or.rb
 - lib/cloud_sesame/query/ast/phrase.rb
 - lib/cloud_sesame/query/ast/prefix.rb
 - lib/cloud_sesame/query/ast/range_value.rb
 - lib/cloud_sesame/query/ast/root.rb
-- lib/cloud_sesame/query/ast/single_branch.rb
 - lib/cloud_sesame/query/ast/single_expression_operator.rb
 - lib/cloud_sesame/query/ast/term.rb
 - lib/cloud_sesame/query/ast/value.rb
 - lib/cloud_sesame/query/builder.rb
-- lib/cloud_sesame/query/dsl/and.rb
 - lib/cloud_sesame/query/dsl/base.rb
-- lib/cloud_sesame/query/dsl/boost.rb
-- lib/cloud_sesame/query/dsl/filter_query.rb
-- lib/cloud_sesame/query/dsl/literal.rb
-- lib/cloud_sesame/query/dsl/or.rb
-- lib/cloud_sesame/query/dsl/page.rb
-- lib/cloud_sesame/query/dsl/query.rb
-- lib/cloud_sesame/query/dsl/return.rb
-- lib/cloud_sesame/query/dsl/scope.rb
-- lib/cloud_sesame/query/dsl/sort.rb
-- lib/cloud_sesame/query/dsl/value.rb
+- lib/cloud_sesame/query/dsl/block_chaining_methods.rb
+- lib/cloud_sesame/query/dsl/block_methods.rb
+- lib/cloud_sesame/query/dsl/field_array_methods.rb
+- lib/cloud_sesame/query/dsl/field_methods.rb
+- lib/cloud_sesame/query/dsl/filter_query_methods.rb
+- lib/cloud_sesame/query/dsl/operator_methods.rb
+- lib/cloud_sesame/query/dsl/page_methods.rb
+- lib/cloud_sesame/query/dsl/query_methods.rb
+- lib/cloud_sesame/query/dsl/return_methods.rb
+- lib/cloud_sesame/query/dsl/scope_methods.rb
+- lib/cloud_sesame/query/dsl/sort_methods.rb
+- lib/cloud_sesame/query/dsl/value_methods.rb
+- lib/cloud_sesame/query/error/invalid_syntax.rb
 - lib/cloud_sesame/query/error/missing_operator_symbol.rb
 - lib/cloud_sesame/query/error/missing_query.rb
+- lib/cloud_sesame/query/fuzziness.rb
 - lib/cloud_sesame/query/node/abstract.rb
 - lib/cloud_sesame/query/node/facet.rb
 - lib/cloud_sesame/query/node/filter_query.rb
@@ -154,16 +156,12 @@ files:
 - spec/abstract_object_spec.rb
 - spec/cloud_sesame/domain/base_spec.rb
 - spec/cloud_sesame/domain/context_spec.rb
-- spec/cloud_sesame/query/ast/and_spec.rb
-- spec/cloud_sesame/query/ast/literal_spec.rb
-- spec/cloud_sesame/query/ast/multi_branch_spec.rb
-- spec/cloud_sesame/query/ast/multi_expression_operator_spec.rb
-- spec/cloud_sesame/query/ast/or_spec.rb
-- spec/cloud_sesame/query/ast/root_spec.rb
-- spec/cloud_sesame/query/ast/value_spec.rb
 - spec/cloud_sesame/query/builder_spec.rb
 - spec/cloud_sesame/query/dsl/base_spec.rb
-- spec/cloud_sesame/query/dsl/filter_query_spec.rb
+- spec/cloud_sesame/query/dsl/block_chaining_methods_spec.rb
+- spec/cloud_sesame/query/dsl/block_methods_spec.rb
+- spec/cloud_sesame/query/dsl/field_array_methods_spec.rb
+- spec/cloud_sesame/query/dsl/field_methods_spec.rb
 - spec/cloud_sesame/query/dsl_spec.rb
 - spec/cloud_sesame/query/node/abstract_spec.rb
 - spec/cloud_sesame/query/node/facet_spec.rb
@@ -173,7 +171,6 @@ files:
 - spec/cloud_sesame/query/node/query_options_spec.rb
 - spec/cloud_sesame/query/node/query_parser_spec.rb
 - spec/cloud_sesame/query/node/query_spec.rb
-- spec/cloud_sesame/query/node/request_spec.rb
 - spec/cloud_sesame/query/node/sort_spec.rb
 - spec/cloud_sesame_spec.rb
 - spec/spec_helper.rb
@@ -205,16 +202,12 @@ test_files:
 - spec/abstract_object_spec.rb
 - spec/cloud_sesame/domain/base_spec.rb
 - spec/cloud_sesame/domain/context_spec.rb
-- spec/cloud_sesame/query/ast/and_spec.rb
-- spec/cloud_sesame/query/ast/literal_spec.rb
-- spec/cloud_sesame/query/ast/multi_branch_spec.rb
-- spec/cloud_sesame/query/ast/multi_expression_operator_spec.rb
-- spec/cloud_sesame/query/ast/or_spec.rb
-- spec/cloud_sesame/query/ast/root_spec.rb
-- spec/cloud_sesame/query/ast/value_spec.rb
 - spec/cloud_sesame/query/builder_spec.rb
 - spec/cloud_sesame/query/dsl/base_spec.rb
-- spec/cloud_sesame/query/dsl/filter_query_spec.rb
+- spec/cloud_sesame/query/dsl/block_chaining_methods_spec.rb
+- spec/cloud_sesame/query/dsl/block_methods_spec.rb
+- spec/cloud_sesame/query/dsl/field_array_methods_spec.rb
+- spec/cloud_sesame/query/dsl/field_methods_spec.rb
 - spec/cloud_sesame/query/dsl_spec.rb
 - spec/cloud_sesame/query/node/abstract_spec.rb
 - spec/cloud_sesame/query/node/facet_spec.rb
@@ -224,7 +217,6 @@ test_files:
 - spec/cloud_sesame/query/node/query_options_spec.rb
 - spec/cloud_sesame/query/node/query_parser_spec.rb
 - spec/cloud_sesame/query/node/query_spec.rb
-- spec/cloud_sesame/query/node/request_spec.rb
 - spec/cloud_sesame/query/node/sort_spec.rb
 - spec/cloud_sesame_spec.rb
 - spec/spec_helper.rb

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

@@ -1,77 +0,0 @@
-module CloudSesame
-  module Query
-    module AST
-      class CompoundArray < Array
-
-        attr_reader :scope, :field
-
-        def for_field(field)
-          parents.clear
-          @field = field
-        end
-
-        def parents
-          @parents ||= []
-        end
-
-        def scope_to(scope)
-          @scope = scope
-          return self
-        end
-
-        # SINGLE BRANCH OPERATOR
-        # =======================================
-
-        # NEAR
-        # =======================================
-        def near(*values)
-          parents[1] = AST::Near
-          insert_and_return_children values
-        end
-
-        alias_method :sloppy, :near
-
-        # NOT
-        # =======================================
-        def not(*values)
-          parents[0] = AST::Not
-          insert_and_return_children values
-        end
-
-        alias_method :is_not, :not
-
-        # PREFIX
-        # =======================================
-        def prefix(*values)
-          parents[1] = AST::Prefix
-          insert_and_return_children values
-        end
-
-        alias_method :start_with, :prefix
-        alias_method :begin_with, :prefix
-
-        def insert_and_return_children(values = [])
-          values.each do |value|
-            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
-
-        private
-
-        def options
-          scope.context[:fields][field]
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-module CloudSesame
-  module Query
-    module AST
-      class MultiBranch
-        include DSL::Base
-        include DSL::FilterQuery
-        include DSL::Scope
-
-        attr_reader :context
-
-        def initialize(context, &block)
-          @context = context
-          instance_eval &block if block_given?
-        end
-
-        def children
-          @children ||= CompoundArray.new.scope_to self
-        end
-
-        def compile_children
-          children.map(&:compile).join(' ')
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-module CloudSesame
-  module Query
-    module AST
-      class SingleBranch
-        attr_accessor :child
-      	attr_reader :context
-
-      	def initialize(context, &block)
-      	  @context = context
-      	  instance_eval &block if block_given?
-      	end
-
-        def child=(object)
-          if object.kind_of? Literal
-            (object.options[:excluded] ||= []) << object.options[:included].delete(object.value)
-          end
-          @child = object
-        end
-
-        def <<(object)
-          self.child= object
-        end
-
-      end
-    end
-  end
-end

data/lib/cloud_sesame/query/dsl/and.rb

@@ -1,19 +0,0 @@
-module CloudSesame
-	module Query
-		module DSL
-			module And
-
-				# CLAUSE: AND
-				# =========================================
-				def and(&block)
-				  method_scope.children << AST::And.new(method_context, &block)
-				  method_return
-				end
-
-				alias_method :all,  :and
-				alias_method :and!, :and
-
-			end
-		end
-	end
-end

data/lib/cloud_sesame/query/dsl/boost.rb

@@ -1,20 +0,0 @@
-module CloudSesame
-	module Query
-		module DSL
-			module Boost
-
-				def compile_boost
-					" boost=#{ @boost }" if @boost
-				end
-
-				def boost(value)
-					@boost = value.to_i
-					return self
-				end
-
-				alias_method :weight, :boost
-
-			end
-		end
-	end
-end

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

@@ -1,72 +0,0 @@
-module CloudSesame
-	module Query
-		module DSL
-			module Literal
-
-				# LITERAL: creates a single LITERAL node
-				# =======================================
-				def literal(value)
-					field = method_scope.children.field
-					AST::Literal.new field, value, fields[field]
-				end
-
-				alias_method :l,			    :literal
-				alias_method :field,  	  :literal
-
-				# NEAR: creates a single NEAR node
-				# =======================================
-				def near(value)
-					create_literal_with_operator AST::Near, value
-				end
-
-				alias_method :n,			    :near
-				alias_method :sloppy,     :near
-
-				# PREFIX: creates a single PREFIX node
-				# =======================================
-				def prefix(value)
-					create_literal_with_operator AST::Prefix, value
-				end
-
-				alias_method :p,					:prefix
-				alias_method :start_with,	:prefix
-				alias_method :begin_with, :prefix
-
-				# PHRASE: creates a single PHRASE node
-				# =======================================
-				def phrase(value)
-					create_literal_with_operator AST::Phrase, value
-				end
-
-				# TERM: creates a single TERM node
-				# =======================================
-				def term(value)
-					create_literal_with_operator AST::Term, value
-				end
-
-				private
-
-				def fields
-					method_context[:fields]
-				end
-
-				def create_literal_with_operator(klass, value)
-					field = method_scope.children.field
-					literal = AST::Literal.new field, value, fields[field]
-					(node = klass.new method_context) << literal
-					node
-				end
-
-				def method_missing(field, *values, &block)
-				  if fields && (options = fields[field])
-				  	method_scope.children.for_field field
-				  	method_scope.children.insert_and_return_children values
-				  else
-				    super
-				  end
-				end
-
-			end
-		end
-	end
-end

data/lib/cloud_sesame/query/dsl/or.rb

@@ -1,19 +0,0 @@
-module CloudSesame
-	module Query
-		module DSL
-			module Or
-
-				# CLAUSE: OR
-				# =========================================
-				def or(&block)
-				  method_scope.children << AST::Or.new(method_context, &block)
-				  method_return
-				end
-
-				alias_method :any, :or
-				alias_method :or!, :or
-
-			end
-		end
-	end
-end

data/spec/cloud_sesame/query/ast/and_spec.rb

@@ -1,13 +0,0 @@
-require "spec_helper"
-
-module CloudSesame
-  module Query
-    module AST
-      describe And do
-        it 'should set the symbol to :and' do
-          expect(And.symbol).to eq :and
-        end
-      end
-    end
-  end
-end