CloudSesame 0.6.8 → 0.7.0

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

@@ -5,30 +5,12 @@ module CloudSesame
     module Node
       describe Sort do
 
-        let(:arguments) {{ }}
-        let(:node) { Sort.new(arguments) }
-
-        describe '#initialize' do
-          context 'when arguments passed in' do
-            let(:arguments) {{ sort: "score asc,price desc" }}
-            it 'should accept sort argument and initialize sorting_attributes' do
-              expect(node.sorting_attributes).to eq({ score: :asc, price: :desc })
-            end
-            it 'should initialize an empty sorting_attributes when arguments sort is empty' do
-              arguments[:sort] = ""
-              expect(node.sorting_attributes).to eq({ })
-            end
-          end
-          context 'when arguments not passed in' do
-            it 'should initialize an empty sorting_attributes' do
-              expect(node.sorting_attributes).to eq({ })
-            end
-          end
-        end
+        let(:context) {{ fields: {} }}
+        let(:node) { Sort.new(context) }
 
         describe '#[]' do
           context 'with existing attribute' do
-            let(:arguments) {{ sort: "score asc,price desc" }}
+            before { node.attributes = { score: :asc, price: :desc }}
             it 'should return the sorting order of the attribute' do
               expect(node[:score]).to eq :asc
               expect(node[:price]).to eq :desc
@@ -44,7 +26,7 @@ module CloudSesame
 
         describe '#[]=' do
           context 'with existing attribute' do
-            let(:arguments) {{ sort: "score asc,price desc" }}
+            before { node.attributes = { score: :asc, price: :desc }}
             it 'should override the sorting order of the attribute' do
               expect{ node[:score] = :desc }.to change{ node[:score] }.from(:asc).to(:desc)
             end
@@ -56,16 +38,25 @@ module CloudSesame
           end
         end
 
-        describe '#run' do
+        describe '#compile' do
           context 'with existing sorting attributes' do
-            let(:arguments) {{ sort: "score asc,price desc" }}
-            it 'should return a hash with serialized sort attributes' do
-              expect(node.compile).to eq arguments
+            context 'when context contains aliase field' do
+              let(:context) {{ fields: { aliased: { as: :real_name } } }}
+              before { node.attributes = { aliased: :asc, price: :desc }}
+              it 'should return serialized sort attributes with actual field name' do
+                expect(node.compile).to eq "real_name asc,price desc"
+              end
+            end
+            context 'when context contains no alias field' do
+              before { node.attributes = { score: :asc, price: :desc }}
+              it 'should return serialized sort attributes' do
+                expect(node.compile).to eq "score asc,price desc"
+              end
             end
           end
           context 'with empty sorting attributes' do
-            it 'should return an empty hash' do
-              expect(node.compile).to eq({})
+            it 'should return nil' do
+              expect(node.compile).to eq nil
             end
           end
         end

data/spec/cloud_sesame_spec.rb

@@ -1,158 +1,4 @@
-# require 'spec_helper'
-# require 'ruby-prof'
-# require 'benchmark'
+describe CloudSesame do
 
-# describe CloudSesame do
 
-# 	# FAKE RAILS AND RAILS CACHE
-# 	# =====================================
-# 	class ::Rails
-# 		def self.cache
-# 			@cache ||= FakeCache.new
-# 		end
-# 	end
-
-# 	class ::FakeCache
-# 		def table
-# 			@table ||= {}
-# 		end
-# 		def fetch(key, &block)
-# 			table[key] ||= (block.call if block_given?)
-# 		end
-# 	end
-
-# 	# 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
-
-# 		def self.greeting
-# 			"hello world!"
-# 		end
-
-# 		define_cloudsearch do
-# 			# Product CloudSesame Config
-# 			config.endpoint = ENV['AWS_ENDPOINT']
-# 			config.region 	= ENV['AWS_REGION']
-
-#       caching_with :RailsCache
-
-# 			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
-
-# 		end
-
-# 	end
-
-# 	class Coupon
-# 	  include CloudSesame
-
-# 	  VALID_COUPON_RANK = 20
-
-# 	  define_cloudsearch do
-# 	    config.endpoint = ENV['AWS_ENDPOINT']
-# 	    config.region   = ENV['AWS_REGION']
-
-# 	    default_size 10
-
-# 	    define_sloppiness 3
-
-# 	    define_fuzziness do
-# 	      max_fuzziness 3
-# 	      min_char_size 6
-# 	      fuzzy_percent 0.17
-# 	    end
-
-# 	    field :end_date,                            as: :date1
-# 	    field :rank,                                as: :num1, default: -> { gte VALID_COUPON_RANK }
-# 	    field :searchable_text,                     query: true
-# 	    field :affiliate_advertiser_search_ext_id,  as: :string1, facet: { size: 50 }
-# 	    field :countries,                           as: :string_array1
-# 	    field :deal_types,                          as: :string_array2, facet: {}
-# 	    field :tags,                                as: :string_array3, facet: {}
-# 	    field :type,                                default: -> { 'Catalog::CouponSearchable' }
-# 	  end
-
-# 	end
-
-# 	# @tags = [1, 2]
-# 	# n = 10_000
-#  #  q = nil
-# 	# result = RubyProf.profile do
-# 	#   n.times do
-# 			q = Product.cloudsearch.query("black jacket").sort(price: :asc).page(1).size(1000)
-# 				.price { gt 100 }
-# 				.and {
-# 					or! {
-# 					tags *@tags
-# 					tags
-# 					tags nil
-# 					and! {
-# 						tags.not "3", "4"
-# 					}
-# 					and!.not {
-# 						tags.start_with "5", "6"
-# 						tags.not.start_with("7")
-# 						tags.not.near("8", distance: 7)
-# 						tags start_with("9"), near("10")
-# 						tags term("11", boost: 2)
-# 						tags.not phrase "12"
-# 					}
-# 					or!.not {
-# 						price(25..100)
-# 						price 100...200
-# 						price gte(200).lt(300)
-# 						price gte(300)
-# 					}
-# 					or! {
-# 						created_at Date.today - 7
-# 						created_at gte(Date.today)
-# 						created_at gte(Date.today).lt(Date.today + 3)
-# 					}
-# 				}
-# 			}
-
-# 	#   end
-# 	# end
-# 	# printer = RubyProf::FlatPrinter.new(result)
-# 	# printer.print(STDOUT, {})
-
-# 	binding.pry
-
-
-# end
+end

data/spec/helpers/benchmark_helper.rb

@@ -0,0 +1,12 @@
+require 'ruby-prof'
+require 'benchmark'
+
+module BenchmarkHelper
+
+	def profile(n, &block)
+		result = RubyProf.profile { n.times(&block) }
+		printer = RubyProf::FlatPrinter.new(result)
+		printer.print(STDOUT, {})
+	end
+
+end

data/spec/profiling_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+fdescribe CloudSesame do
+  # FAKE RAILS AND RAILS CACHE
+  # =====================================
+  class ::Rails
+  	def self.cache
+  		@cache ||= FakeCache.new
+  	end
+  end
+
+  class ::FakeCache
+  	def table
+  		@table ||= {}
+  	end
+  	def fetch(key, &block)
+  		table[key] ||= (block.call if block_given?)
+  	end
+  end
+
+  # 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
+
+  	def self.greeting
+  		"hello world!"
+  	end
+
+  	define_cloudsearch do
+  		# Product CloudSesame Config
+  		config.endpoint = ENV['AWS_ENDPOINT']
+  		config.region 	= ENV['AWS_REGION']
+
+      caching_with :RailsCache
+
+  		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 }, type: :string
+  		field :description, 				query: true, type: :string
+  		field :tags,								type: :string
+
+  		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,					type: :datetime
+
+  	end
+
+  end
+
+  class Coupon
+    include CloudSesame
+
+    VALID_COUPON_RANK = 20
+
+    define_cloudsearch do
+      config.endpoint = ENV['AWS_ENDPOINT']
+      config.region   = ENV['AWS_REGION']
+
+      default_size 10
+
+      define_sloppiness 3
+
+      define_fuzziness do
+        max_fuzziness 3
+        min_char_size 6
+        fuzzy_percent 0.17
+      end
+
+      field :end_date,                            as: :date1
+      field :rank,                                as: :num1, default: -> { gte VALID_COUPON_RANK }
+      field :searchable_text,                     query: true
+      field :affiliate_advertiser_search_ext_id,  as: :string1, facet: { size: 50 }
+      field :countries,                           as: :string_array1
+      field :deal_types,                          as: :string_array2, facet: {}
+      field :tags,                                as: :string_array3, facet: {}
+      field :type,                                default: -> { 'Catalog::CouponSearchable' }
+    end
+
+  end
+
+  @tags = [1, 2]
+  q = nil
+  profile 1 do
+  	q = Product.cloudsearch
+  						.query("black leather jacket")
+  						.sort(price: :asc, created_at: :desc)
+  						.page(3)
+  						.size(1000)
+  						.price { gt 1 }
+  						.tags { "2" }
+  						.and {
+  							or! {
+  								tags *@tags
+  								tags nil
+  								and! {
+  									tags.not 3, 4
+  								}
+  								and!.not {
+  									tags.start_with "5", "6"
+  									tags.not.start_with("7")
+  									tags.not.near("8", distance: 7)
+  									tags start_with("9"), near("10")
+  									tags term("11", boost: 2)
+  									tags.not phrase "12"
+  								}
+  								or!.not {
+  									price(25..100)
+  									price 100...200
+  									price gte(200).lt(300)
+  									price gte(300)
+  								}
+  								or! {
+  									created_at Date.today - 7
+  									created_at gte(Date.today)
+  									created_at gte(Date.today).lt(Date.today + 3)
+  								}
+  							}
+  						}
+
+  	q.compile
+
+  end
+
+  binding.pry
+
+end

data/spec/services/class_specific_spec.rb

@@ -0,0 +1,135 @@
+describe ClassSpecific do
+
+  class SearchableClass; end
+
+  let(:searchable) { :SearchableClass }
+
+  describe '.construct_class' do
+    let(:specific_class) { SearchableClass }
+    let(:klass) { Class.new { extend ClassSpecific } }
+
+    context 'when sub-class has not being defined previously' do
+      context 'and specific class passed in has a constant name' do
+        it 'should define a sub-class under the extended class' do
+          expect{ klass.construct_class(specific_class) }.to change{ klass.constants.size }.by(1)
+        end
+        it 'should name the sub-class after the class passed in' do
+          expect{ klass.construct_class(specific_class) }.to change{ klass.constants }.by([searchable])
+        end
+      end
+
+      context 'and specific class passed in does not have constant name' do
+        let(:specific_class) { Class.new }
+        it 'should not define a sub-class under the extended class' do
+          expect{ klass.construct_class(specific_class) }.to_not change{ klass.constants.size }
+        end
+      end
+
+      context 'and callback is given' do
+        context 'and callback args is not given' do
+          it 'should invoke callback after construct' do
+            expect do |b|
+              klass.after_construct(&b)
+              klass.construct_class(specific_class)
+            end.to yield_with_args(specific_class)
+          end
+        end
+        context 'and callback is not given' do
+          let(:callback_args) { [1, 2, 3] }
+          it 'should invoke callback and yield callback args after construct' do
+            expect do |b|
+              klass.after_construct(&b)
+              klass.construct_class(specific_class, callback_args: callback_args)
+            end.to yield_with_args(specific_class, *callback_args)
+          end
+        end
+      end
+
+    end
+
+    context 'when sub-class has being defined previously' do
+      it 'should not define a sub-class again' do
+        klass.construct_class(specific_class)
+        expect(Class).to_not receive(:new).with(klass)
+        expect{ klass.construct_class(specific_class) }.to_not change{ klass.constants.size }
+      end
+      it 'should not invoke callback twice' do
+        expect do |b|
+          klass.after_construct(&b)
+          klass.construct_class(specific_class)
+          klass.construct_class(specific_class)
+        end.to yield_control.exactly(1).times
+      end
+    end
+
+  end
+
+  describe '.construct_module' do
+    let(:specific_class) { SearchableClass }
+    let(:custom_module) { Module.new { extend ClassSpecific } }
+
+    context 'when sub-class has not being defined previously' do
+      context 'and specific class passed in has a constant name' do
+        it 'should define a sub-class under the extended class' do
+          expect{ custom_module.construct_module(specific_class) }.to change{ custom_module.constants.size }.by(1)
+        end
+        it 'should name the sub-class after the class passed in' do
+          expect{ custom_module.construct_module(specific_class) }.to change{ custom_module.constants }.by([searchable])
+        end
+      end
+
+      context 'and specific class passed in does not have constant name' do
+        let(:specific_class) { Class.new }
+        it 'should not define a sub-class under the extended class' do
+          expect{ custom_module.construct_module(specific_class) }.to_not change{ custom_module.constants.size }
+        end
+      end
+
+      context 'and callback is given' do
+        context 'and callback args is not given' do
+          it 'should invoke callback after construct' do
+            expect do |b|
+              custom_module.after_construct(&b)
+              custom_module.construct_module(specific_class)
+            end.to yield_with_args(specific_class)
+          end
+        end
+        context 'and callback is not given' do
+          let(:callback_args) { [1, 2, 3] }
+          it 'should invoke callback and yield callback args after construct' do
+            expect do |b|
+              custom_module.after_construct(&b)
+              custom_module.construct_module(specific_class, callback_args: callback_args)
+            end.to yield_with_args(specific_class, *callback_args)
+          end
+        end
+      end
+
+    end
+
+    context 'when sub-class has being defined previously' do
+      it 'should not define a sub-class again' do
+        custom_module.construct_module(specific_class)
+        expect(Module).to_not receive(:new).with(custom_module)
+        expect{ custom_module.construct_module(specific_class) }.to_not change{ custom_module.constants.size }
+      end
+      it 'should not invoke callback twice' do
+        expect do |b|
+          custom_module.after_construct(&b)
+          custom_module.construct_module(specific_class)
+          custom_module.construct_module(specific_class)
+        end.to yield_control.exactly(1).times
+      end
+    end
+  end
+
+  describe '.after_construct' do
+    let(:specific_class) { SearchableClass }
+    let(:klass) { Class.new { extend ClassSpecific } }
+    let(:block) { Proc.new {} }
+    it 'should store the block as __construct_callback__' do
+      expect{ klass.after_construct(&block) }.to change{ klass.instance_variable_get(:@__construct_callback__) }.from(nil).to(block)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,10 +6,13 @@ require 'bundler/setup'
 Bundler.setup
 
 require 'pry'
+require 'helpers/benchmark_helper'
 require 'cloud_sesame'
 
 RSpec.configure do |config|
   # For running just wanted tests in guard
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
+
+  config.extend BenchmarkHelper
 end