elasticord 1.0.0 → 1.0.1

data/spec/elasticord/base_spec.rb

@@ -2,69 +2,68 @@ require 'spec_helper'
 require 'elasticsearch'
 
 describe Elasticord::Base, elasticsearch: true do
+  ElasticordChildClass1 = Class.new(described_class)
+
   def elastic_search_client
     @elastic_search_client ||= Elasticsearch::Client.new
   end
 
+  def get_one_elastic_search_record(id)
+    result = elastic_search_client.get \
+      id: id,
+      type: ElasticordChildClass1.type,
+      index: ElasticordChildClass1.index,
+      ignore: 404
+
+    result
+  end
+
   describe '.index' do
     it 'described_class should return the current env' do
       expect(described_class.index).to eq ENV['ENV']
     end
 
     context 'given a child class' do
-      ChildClass1 = Class.new(described_class)
-
-      it 'ChildClass1 should return the same current env' do
-        expect(ChildClass1.index).to eq ENV['ENV']
+      it 'ElasticordChildClass1 should return the same current env' do
+        expect(ElasticordChildClass1.index).to eq ENV['ENV']
       end
 
       context 'given that the child class sets a new index' do
-        before { ChildClass1.index = 'child_class_new_index' }
+        before { ElasticordChildClass1.index = 'child_class_new_index' }
 
         it 'described_class should return the current env' do
           expect(described_class.index).to eq ENV['ENV']
         end
 
-        it 'ChildClass1 should return child_class_new_index' do
-          expect(ChildClass1.index).to eq 'child_class_new_index'
+        it 'ElasticordChildClass1 should return "child_class_new_index"' do
+          expect(ElasticordChildClass1.index).to eq 'child_class_new_index'
         end
       end
     end
   end
 
   describe '.type' do
-    it 'described_class should return _all' do
+    it 'described_class should return "_all"' do
       expect(described_class.type).to eq '_all'
     end
 
     context 'given a child class' do
-      ChildClass2 = Class.new(described_class)
-
-      it 'ChildClass2 should return child_class2' do
-        expect(ChildClass2.type).to eq 'child_class2'
+      it 'ElasticordChildClass1 should return "elasticord_child_class1"' do
+        expect(ElasticordChildClass1.type).to eq 'elasticord_child_class1'
       end
     end
   end
 
   describe '.create' do
-    ChildClass3 = Class.new(described_class)
-
-    def get_one(id)
-      result = elastic_search_client.get \
-        index: ChildClass3.index, type: ChildClass3.type, ignore: 404, id: id
-
-      result
-    end
-
-    context 'Given an id' do
+    context 'given an ID' do
       let(:id) { '123' }
 
       before do
-        @child_class = ChildClass3.create id: id, title: 'child class'
+        @child_class = ElasticordChildClass1.create id: id, title: 'child class'
       end
 
       it 'ElasticSearch should contain a record with that specific id' do
-        result = get_one id
+        result = get_one_elastic_search_record id
 
         expect(result['found']).to be true
       end
@@ -73,18 +72,18 @@ describe Elasticord::Base, elasticsearch: true do
         expect(@child_class.id).to eq id
       end
 
-      it '@child_class should be an instance of ChildClass3' do
-        expect(@child_class).to be_an_instance_of ChildClass3
+      it '@child_class should be an instance of ElasticordChildClass1' do
+        expect(@child_class).to be_an_instance_of ElasticordChildClass1
       end
     end
 
-    context 'Given no id' do
+    context 'given no ID' do
       before do
-        @child_class = ChildClass3.create title: 'child class'
+        @child_class = ElasticordChildClass1.create title: 'child class'
       end
 
-      it 'ElasticSearch should contain a record with that specific id' do
-        result = get_one @child_class.id
+      it 'ElasticSearch DB should contain a record with that specific id' do
+        result = get_one_elastic_search_record @child_class.id
 
         expect(result['found']).to be true
       end
@@ -92,149 +91,37 @@ describe Elasticord::Base, elasticsearch: true do
   end
 
   describe '.search' do
-    ChildClass4 = Class.new(described_class)
-
-    context 'Given that no record has been created' do
-      before do
-        ChildClass4.delete_all
-        ChildClass4.refresh_index
-
-        @search_result = ChildClass4.search({})
-      end
+    it 'should pass all params to a SearchBuilder instance' do
+      attributes = { query: { match: { brand: 'oficial' } } }
 
-      it 'should return a hash with total_results: 0 and an empty data' do
-        expect(@search_result).to match a_hash_including({
-          data: [],
-          total_results: 0
-        })
-      end
-    end
-
-    context 'Given that 5 recrod have been created' do
-      before do
-        ChildClass4.delete_all
-        5.times { ChildClass4.create(title: 'child class')  }
-        ChildClass4.refresh_index
-
-        @search_result = ChildClass4.search({})
-      end
-
-      it 'should return a hash with total_results: 5' do
-        expect(@search_result[:total_results]).to be 5
-      end
+      expect_any_instance_of(Elasticord::ORM::SearchBuilder).to \
+        receive(:load).with(attributes)
 
-      it 'should return a hash with 5 instances of the class' do
-        expect(@search_result[:data].length).to be 5
-
-        @search_result[:data].each do |child_class|
-          expect(child_class).to be_an_instance_of ChildClass4
-        end
-      end
-    end
-
-    context 'Given that 30 records have been created' do
-      before do
-        ChildClass4.delete_all
-
-        24.times do
-          ChildClass4.create \
-            title: 'child class', brand: 'oficial', locked: false
-        end
-
-        ChildClass4.create(title: 'class', brand: 'oficial', locked: true)
-
-        5.times do
-          ChildClass4.create(title: 'child', brand: 'unoficial', locked: false)
-        end
-
-        ChildClass4.refresh_index
-      end
-
-      context 'when no pagination params are passed' do
-        before do
-          @search_result = ChildClass4.search({})
-        end
-
-        it 'should return a hash with total_results: 30' do
-          expect(@search_result[:total_results]).to be 30
-        end
-
-        it 'should return a hash with 10 instances of the class' do
-          expect(@search_result[:data].length).to be 10
-
-          @search_result[:data].each do |child_class|
-            expect(child_class).to be_an_instance_of ChildClass4
-          end
-        end
-      end
-
-      context 'when single query params are passed' do
-        before do
-          @search_result = ChildClass4.search \
-            query: {
-              match: { brand: 'oficial' }
-            }
-        end
-
-        it 'should return a hash with total_results: 25' do
-          expect(@search_result[:total_results]).to be 25
-        end
-
-        it 'should return a hash with 10 elements' do
-          expect(@search_result[:data].length).to be 10
-        end
-      end
-
-      context 'when multi query params are passed' do
-        before do
-          @search_result = ChildClass4.search \
-            query: {
-              bool: {
-                must: [
-                  { match: { title: 'child class' } }
-                ],
-                filter: [
-                  { term: { brand: 'oficial' } },
-                  { term: { locked: false } }
-                ]
-              }
-            }
-        end
-
-        it 'should return a hash with total_results: 24' do
-          expect(@search_result[:total_results]).to be 24
-        end
-
-        it 'should return a hash with 10 elements' do
-          expect(@search_result[:data].length).to be 10
-        end
-      end
+      ElasticordChildClass1.search(attributes)
     end
   end
 
   describe '.get' do
-    ChildClass5 = Class.new(described_class)
-
-    context 'When the record does not exist' do
+    context 'when the record does not exist' do
       it 'should return false' do
-        result = ChildClass5.get '-1'
+        result = ElasticordChildClass1.get '-1'
 
         expect(result).to be false
       end
     end
 
-    context 'When the record exists' do
+    context 'when the record exists' do
       before do
-        @child_class = ChildClass5.create title: 'child class'
+        @child_class = ElasticordChildClass1.create title: 'child class'
 
-        @result = ChildClass5.get @child_class.id
+        @result = ElasticordChildClass1.get @child_class.id
       end
 
-      it 'should return an instance of ChildClass5' do
-        expect(@result).to be_an_instance_of ChildClass5
+      it 'should return an instance of ElasticordChildClass1' do
+        expect(@result).to be_an_instance_of ElasticordChildClass1
       end
 
-      it 'should return the same id it requested' do
+      it 'should return the same ID it requested' do
         expect(@result.id).to be @child_class.id
       end
     end

data/spec/elasticord/orm/search_builder_spec.rb

@@ -0,0 +1,269 @@
+require 'spec_helper'
+require 'elasticsearch'
+
+describe Elasticord::ORM::SearchBuilder, elasticsearch: true do
+  ElasticordChildClass2 = Class.new(Elasticord::Base)
+
+  def new_search_builder
+    described_class.new \
+      ElasticordChildClass2,
+      ElasticordChildClass2.index,
+      ElasticordChildClass2.type
+  end
+
+  describe '#current_page' do
+    it 'should have a default value set' do
+      expect(new_search_builder.current_page).to \
+        be described_class::PAGE_DEFAULT
+    end
+  end
+
+  describe '#per_page' do
+    it 'should have a default value set' do
+      expect(new_search_builder.per_page).to \
+        be described_class::PER_PAGE_DEFAULT
+    end
+  end
+
+  describe '#body_params' do
+    it 'should have pagination params set' do
+      expect(new_search_builder.body_params).to match a_hash_including({
+        size: described_class::PER_PAGE_DEFAULT,
+        from: 0
+      })
+    end
+
+    context 'when setting #page with 2' do
+      before do
+        @search_builder = new_search_builder
+        @search_builder.page(2)
+      end
+
+      context 'when setting #per with 3' do
+        before do
+          @search_builder.per(3)
+        end
+
+        it 'should have pagination params set' do
+          expect(@search_builder.body_params).to match a_hash_including({
+            size: 3,
+            from: 3
+          })
+        end
+      end
+    end
+  end
+
+  describe '#result' do
+    it 'should return a SearchBuilder instance' do
+      expect(new_search_builder.result(distinct: true)).to \
+        be_an_instance_of described_class
+    end
+  end
+
+  describe '#page' do
+    def search_builder
+      @search_builder ||= new_search_builder
+    end
+
+    context 'sending 3 as an argument' do
+      before do
+        @result = search_builder.page(3)
+      end
+
+      it 'should return a SearchBuilder instance' do
+        expect(@result).to be_an_instance_of described_class
+      end
+
+      it 'should set the #body_params used in #load' do
+        expect(@result.body_params[:from]).to be 20
+      end
+
+      it 'should set the #current_page to 3' do
+        expect(@result.current_page).to be 3
+      end
+    end
+  end
+
+  describe '#per' do
+    def search_builder
+      @search_builder ||= new_search_builder
+    end
+
+    context 'sending 15 as an argument' do
+      before do
+        @result = search_builder.per(15)
+      end
+
+      it 'should return a SearchBuilder instance' do
+        expect(@result).to be_an_instance_of described_class
+      end
+
+      it 'should set the #body_params used in #load' do
+        expect(@result.body_params[:size]).to be 15
+      end
+
+      it 'should set the #per_page to 15' do
+        expect(@result.per_page).to be 15
+      end
+    end
+  end
+
+  context 'given that no record has been created' do
+    before do
+      ElasticordChildClass2.delete_all
+      ElasticordChildClass2.refresh_index
+    end
+
+    describe '#load' do
+      before do
+        @search_result = new_search_builder.load
+      end
+
+      it 'should return a pagination object with empty resources' do
+        expect(@search_result).to be_empty
+        expect(@search_result.total_results).to be 0
+      end
+    end
+  end
+
+  context 'given that 5 records have been created' do
+    before do
+      ElasticordChildClass2.delete_all
+      5.times { ElasticordChildClass2.create(title: 'child class')  }
+      ElasticordChildClass2.refresh_index
+    end
+
+    describe '#load' do
+      before do
+        @search_result = new_search_builder.load
+      end
+
+      it 'should find 5 total_results' do
+        expect(@search_result.total_results).to be 5
+      end
+
+      it 'should return a pagination object with 5 instances of the class' do
+        expect(@search_result.length).to be 5
+
+        @search_result.each do |child_class|
+          expect(child_class).to be_an_instance_of ElasticordChildClass2
+        end
+      end
+    end
+  end
+
+  context 'given that 30 records have been created' do
+    before do
+      ElasticordChildClass2.delete_all
+
+      24.times do
+        ElasticordChildClass2.create \
+          title: 'child class', brand: 'oficial', locked: false
+      end
+
+      ElasticordChildClass2.create(title: 'class', brand: 'oficial', locked: true)
+
+      5.times do
+        ElasticordChildClass2.create(title: 'child', brand: 'unoficial', locked: false)
+      end
+
+      ElasticordChildClass2.refresh_index
+    end
+
+    describe '#load' do
+      context 'when no pagination params are passed' do
+        before do
+          @search_result = new_search_builder.load({})
+        end
+
+        it 'should find 30 total_results' do
+          expect(@search_result.total_results).to be 30
+        end
+
+        it 'should return a pagination object with 10 instances of the class' do
+          expect(@search_result.length).to be 10
+
+          @search_result.each do |child_class|
+            expect(child_class).to be_an_instance_of ElasticordChildClass2
+          end
+        end
+      end
+
+      context 'when #page(2) was called' do
+        before do
+          @search_builder = new_search_builder.page(2)
+        end
+
+        context 'when #per(15) was called' do
+          before do
+            @search_builder = @search_builder.per(15)
+          end
+
+          context 'when #ransack with multiple query params was called' do
+            before do
+              @search_builder = @search_builder.ransack({
+                brand_eq: 'oficial',
+                locked_eq: false
+              })
+
+              @search_builder = @search_builder.result(distinct: true)
+
+              @search_result = @search_builder.load
+            end
+
+            it 'should return a pagination with the current data' do
+              expect(@search_result.per_page).to be 15
+              expect(@search_result.total_pages).to be 2
+              expect(@search_result.current_page).to be 2
+              expect(@search_result.total_results).to be 24
+              expect(@search_result.length).to be 9
+            end
+          end
+        end
+      end
+
+      context 'when single query params are passed' do
+        before do
+          @search_result = new_search_builder.load \
+            query: {
+              match: { brand: 'oficial' }
+            }
+        end
+
+        it 'should find 25 total_results' do
+          expect(@search_result.total_results).to be 25
+        end
+
+        it 'should return a pagination object with 10 resources' do
+          expect(@search_result.length).to be 10
+        end
+      end
+
+      context 'when multi query params are passed' do
+        before do
+          @search_result = new_search_builder.load \
+            query: {
+              bool: {
+                must: [
+                  { match: { title: 'child class' } }
+                ],
+                filter: [
+                  { term: { brand: 'oficial' } },
+                  { term: { locked: false } }
+                ]
+              }
+            }
+        end
+
+        it 'should find 24 total_results' do
+          expect(@search_result.total_results).to be 24
+        end
+
+        it 'should return a pagination object with 10 resources' do
+          expect(@search_result.length).to be 10
+        end
+      end
+    end
+  end
+end