CloudSesame 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f970b1cf0438d0960afe37b8bded2fa6e8c6a8
-  data.tar.gz: 9807f2c701ddde033b69a81ac71eeea48d525585
+  metadata.gz: bdd6130e69369b19a8af9084c9fafeb23da57e10
+  data.tar.gz: 383e48e735e7ee99f3bc3ee31b550fa7603186dd
 SHA512:
-  metadata.gz: 86ce9ff3dd0530e1a2a46db0f9cd020b1d8156e34e39b0293cd83fcba32cb2838671d6864fb713510af4319541c2991de06c48f1c75928e9e883622eb5911363
-  data.tar.gz: 599aa1e9d8b3cf01cc0325d3467a0d2fc7e75454af9b63ff9c7e16c43b02514fba61f3aacd1d8ee70183c2c6514b2f6ae68e28f72696c46605b22facb43824cd
+  metadata.gz: 34a744413189cf8306b15bc968d671940e1d1258e50dec628a09273a820803224b4f6c2f3a3925ae1a2a58be34f1bda3977ea226b7d6396dc3d01ffe6c9e848f
+  data.tar.gz: 4da503890c410bf99d4ba05452156d1f6a36fce18442d19f1024260a9b8a7243bca6416875c50c8b201add9a2d362ec59f585d62fdc56062c446e4ba0b1488b3

data/Gemfile.lock

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

data/README.md

@@ -23,21 +23,61 @@ end
 ```
 
 #Model Setup
-##1. Mix CloudSesame into any class or model
 - `include CloudSesame` in a model or class
-- call `define_cloudsearch` and pass in a block to define the cloudsearch
+- `define_cloudsearch` with a block to setup class/modal specific setting
 
-#####define_cloudsearch(&block)
+####define_cloudsearch(&block)
 Includes all Model/Class specific cloudsearch configurations
-#####config.endpoint=(string)
+```
+class Product
+	include CloudSesame
+
+	define_cloudsearch do 
+		...
+	end
+end
+```
+
+####config.endpoint=(string)
 Set AWS CloudSearch instance search endpoint
-#####config.region=(string) 
+####config.region=(string) 
 Set AWS CloudSearch isntance region
-#####default_size(integer = 10) 
+```
+class Product
+	include CloudSesame
+
+	define_cloudsearch do 
+		config.endpoint = ENV[...]
+		config.region 	= ENV[...]
+	end
+end
+```
+
+####default_size(integer = 10) 
 Set default search size
-#####define_sloppiness(integer)
+```
+class Product
+	include CloudSesame
+
+	define_cloudsearch do 
+		default_size 100
+	end
+end
+```
+
+####define_sloppiness(integer)
 Setup sloppy query, it is turned off by default
-#####define_fuzziness(&block)
+```
+class Product
+	include CloudSesame
+
+	define_cloudsearch do 
+		define_sloppiness 3
+	end
+end
+```
+
+####define_fuzziness(&block)
 Setup fuzziness, it is turned off by default.
 the block can set 3 values 
 - **max_fuzziness(integer = 3)**
@@ -47,43 +87,104 @@ the block can set 3 values
 - **fuzzy_percent(float = 0.17)**
 	percent used to calculate the fuzziness based on the word length, fuzziness whill choose between the calculated result and maximum fizziness, whichever is smaller.
 	[(word.size * fuzzy_percent).round, max_fuzziness].min
+```
+class Product
+	include CloudSesame
+
+	define_cloudsearch do 
+		define_fuzziness do
+			max_fuzziness 3
+			min_char_size 6
+			fuzzy_percent 0.17
+		end
+	end
+end
+```
+
+####field(symbol, options = {})
+calling field and pass in a field_name will create an field expression accessor
+- simple usage
+```
+field :name
+```
+and field expression accessor can be called to create a field expression
+```
+Product.cloudsearch.name("user")
 
-#####field(symbol, options = {})
-calling field and pass in a field_name will create an literal method, which can be called to create a literal expression
+{ filter_query: "name:'user'" }
+```
+- aliase field name 
+```
+field :text1, as: :name
+```
+and field expression accessor method name will be `#name`
+```
+Product.cloudsearch.name("user")
+
+{ filter_query: "text1:'user'" }
+```
 
-**field examples with query options**
+- with query options is set to `true`
 ```
 field :name, query: true			
-# COMPILED: query_options[:fields] = ["name"]
 
+{ query_options: { fields: ['name'] } }
+```
+
+- with **weight** assigned to query options
+```
 field :tags, query: { weight: 2 }
-# COMPILED: query_options[:fields] = ["name", "tags^2"]
+
+{ query_options[:fields] = ['name', 'tags^2'] }
 ```
-**field example with facet**
+
+- with **facet options** passed in
 ```
-# To enable facet
 field :currency, facet: true
 
-# To enable facet with buckets
+{ facets: { currency:{} } }
+```
+
+- with facet **buckets**
+```
 field :discount, facet: { 				
 	buckets: %w([10,100] [25,100] [50,100] [70,100]), 
 	method: 'interval' 
 }
 
-# To enable facet with max size
+{ facets: { discount: { buckets:["[10,100]","[25,100]","[50,100]","[70,100]"], method:"interval"} } }
+```
+
+- with facet **size** set
+```
 field :manufacturer, facet: { size: 50 }
+```
 
-# To enable facet with sorting
+- with facet **sorting**
+```
 field :category, facet: { sort: 'bucket', size: 10_000 }	
-
 ```
 
-#####scope(symbol, proc, &block)
+
+####scope(symbol, proc, &block)
 ActiveRecord styled scope method. Scope allows you to specify commonly-used queries which can be referenced as method calls on cloudsearch or inside of operator block
+**set scope**
+```
+	...
+	define_cloudsearch do 
+		....
+
+		scope :popular, -> { or! { tags "popular"; popularity gt(70) } }
+	end
 
- 
 
-**complete example**
+```
+**call a scope**
+```
+Product.cloudsearch.query("shoes").popular
+```
+
+####Full Example
 ```
 class Product < ActiveRecord::Base
 	include CloudSesame
@@ -126,29 +227,51 @@ class Product < ActiveRecord::Base
 end
 ```
 
-#####load_definition_from(Class/Model)
-every cloud 
+##Inherit cloudsearch definition from another class/modal
+####load_definition_from(Class/Model)
 ```
 class ExclusiveProduct < Product
-	# load any define cloudsearch definition from class/model
 	load_definition_from Product
 end
 ```
-
+definition can be overrided by calling `#define_cloudsearch` again
 ```
-	
-	
-	# call define_cloudsearch again to override config 
-	# or map field to a different name
 	define_cloudsearch {
-		field :name, as: :product_name		# => it will use name as product_name's alias, so user can query with
-											# NewProduct.cloudsearch.name("shoes") instead of .product_name("shoes")
-											# but the output will still be filter_query="product_name:'shoes'"
+		field :name, as: :product_name
 	}
-end
 ```
 
-##3. Query DSL
+#Query DSL
+- `.cloudsearch` returns a CloudSesame::Domain::Base instance. It is the entry point to start building up the query
+- A CloudSesame::Query::Builder instance is expected to return from any query methods chained after `.cloudsearch` 
+```
+Product.cloudsearch #=> <CloudSesame::Domain::Base/>
+query = Product.cloudsearch.query("shoes") => <CloudSesame::Query::Builder query:'shoes'/>
+```
+**Query methods can be chained and build up**
+```
+query = Product.cloudsearch.query("shoes")
+	.and { 
+		manufacturer('puma')
+		or!.not {
+			manufacturer "nike", "adidas"
+		}
+	}
+	.sort(price: :desc)
+	.page(2)
+	.size(100)
+}
+```
+and `query.compile` will output the compiled hash
+```
+{
+	query:'shoes',
+	filter_query: "(and manufacturer:'puma' (not (or manufacturer:'nike' manufacturer:'adidas')))",
+	sort: "price desc"
+	start: 100
+	size: 100
+}
+```
 
 ###Simple Query
 ```

data/cloud_sesame.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'CloudSesame'
-  s.version     = '0.4.1'
+  s.version     = '0.4.2'
   s.date        = '2016-01-20'
   s.summary     = "AWS CloudSearch Query DSL"
   s.description = "AWS CloudSearch Query DSL"

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

@@ -3,9 +3,9 @@ module CloudSesame
 		module DSL
 			module QueryMethods
 
-				def query(input = nil)
-					if input
-						request.query.query = input
+				def query(input = false)
+					if input || input.nil?
+						request.query.query = input if input
 						return self
 					else
 						request.query.query

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CloudSesame
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Scott Chu