')
+ .search()
+ } else if (calls === 2) {
+ t.equal(content.hits[0]._highlightResult.facet[0].value,
+ 'f1',
+ 'should be hightlighted with strong (setting)')
+ t.equal(content.hits[1]._highlightResult.facet[0].value,
+ 'f1',
+ 'should be hightlighted with strong (setting)')
+ client.deleteIndex(indexName)
+ t.end()
}
- else if( calls === 2 ) {
- t.equal( content.hits[0]._highlightResult.facet[0].value,
- "f1",
- "should be hightlighted with strong (setting)" );
- t.equal( content.hits[1]._highlightResult.facet[0].value,
- "f1",
- "should be hightlighted with strong (setting)" );
- client.deleteIndex( indexName );
- t.end();
- }
- } );
-
- helper.setQuery( "f1" )
- .search();
- } );
-} );
+ })
+ helper.setQuery('f1')
+ .search()
+ })
+})
diff --git a/test/integration-spec/helper.tags.js b/test/integration-spec/helper.tags.js
index 747c577cf8..d4b424ee3e 100644
--- a/test/integration-spec/helper.tags.js
+++ b/test/integration-spec/helper.tags.js
@@ -1,76 +1,82 @@
-"use strict";
+'use strict'
-var random = require( "lodash/number/random" );
-var test = require( "tape" );
-var map = require( "lodash/collection/map" );
+var random = require('lodash/number/random')
+var test = require('tape')
+var map = require('lodash/collection/map')
-var algoliasearchHelper = process.browser ? window.algoliasearchHelper : require( "../../" );
-var setup = require( "../integration-utils.js" ).setup;
+var algoliasearchHelper = process.browser ? window.algoliasearchHelper : require('../../')
+var setup = require('../integration-utils.js').setup
-test( "[INT][TAGS]Test tags operations on the helper and their results on the algolia API", function( t ) {
- var indexName = ( process.env.TRAVIS_BUILD_NUMBER ||
- "helper-integration-tests-" ) + "helper_refinements" + random( 0, 5000 );
+test('[INT][TAGS]Test tags operations on the helper and their results on the algolia API', function(t) {
+ var indexName = (process.env.TRAVIS_BUILD_NUMBER ||
+ 'helper-integration-tests-') + 'helper_refinements' + random(0, 5000)
- setup( indexName, function( client, index ) {
- return index.addObjects( [
- { objectID : "0", _tags : [ "t1", "t2" ] },
- { objectID : "1", _tags : [ "t1", "t3" ] },
- { objectID : "2", _tags : [ "t2", "t3" ] },
- { objectID : "3", _tags : [ "t3", "t4" ] }
- ] )
- .then( function( content ) {
- return index.waitTask( content.taskID );
- } ).then( function() {
- return client;
- } );
- } ).then( function( client ) {
- var helper = algoliasearchHelper( client, indexName, {} );
+ setup(indexName, function(client, index) {
+ return index.addObjects([
+ {objectID: '0', _tags: ['t1', 't2']},
+ {objectID: '1', _tags: ['t1', 't3']},
+ {objectID: '2', _tags: ['t2', 't3']},
+ {objectID: '3', _tags: ['t3', 't4']}
+ ])
+ .then(function(content) {
+ return index.waitTask(content.taskID)
+ }).then(function() {
+ return client
+ })
+ }).then(function(client) {
+ var helper = algoliasearchHelper(client, indexName, {})
- var calls = 0;
- helper.on( "error", function( err ) {
- t.fail( err );
- t.end();
- } );
- helper.on( "result", function( content ) {
- calls++;
- var hitsToParsedID = function( h ) { return parseInt( h.objectID ); };
- if( calls === 1 ) {
- t.equal( content.hits.length, 4, "No tags : 3 results" );
- t.deepEqual( map( content.hits, hitsToParsedID ).sort(),
- [0, 1, 2, 3],
- "No tags expected ids : 0, 1, 2, 3" );
- helper.addTag( "t1" ).search();
- }
- if( calls === 2 ) {
- t.equal( content.hits.length, 2, "One tag (t1) : 2 results" );
- t.deepEqual( map( content.hits, hitsToParsedID ).sort(),
- [0, 1],
- "One tag (t1) expected ids : 0, 1" );
- helper.addTag( "t2" ).search();
+ var calls = 0
+
+ helper.on('error', function(err) {
+ t.fail(err)
+ t.end()
+ })
+
+ helper.on('result', function(content) {
+ calls++
+ var hitsToParsedID = function(h) { return parseInt(h.objectID, 10) }
+
+ if (calls === 1) {
+ t.equal(content.hits.length, 4, 'No tags: 3 results')
+ t.deepEqual(map(content.hits, hitsToParsedID).sort(),
+ [0, 1, 2, 3],
+ 'No tags expected ids: 0, 1, 2, 3')
+ helper.addTag('t1').search()
}
- if( calls === 3 ) {
- t.equal( content.hits.length, 1, "Two tags (t1, t2) : 1 result" );
- t.deepEqual( map( content.hits, hitsToParsedID ).sort(),
- [0],
- "Two tags (t1, t2) expected ids : 0" );
- helper.removeTag( "t2" ).toggleTag( "t3" ).toggleTag( "t1" ).search();
+
+ if (calls === 2) {
+ t.equal(content.hits.length, 2, 'One tag (t1): 2 results')
+ t.deepEqual(map(content.hits, hitsToParsedID).sort(),
+ [0, 1],
+ 'One tag (t1) expected ids: 0, 1')
+ helper.addTag('t2').search()
}
- if( calls === 4 ) {
- t.equal( content.hits.length, 3, "One tag (t3) : 3 results" );
- t.deepEqual( map( content.hits, hitsToParsedID ).sort(),
- [1, 2, 3],
- "One tag (t3) expected ids : 1, 2, 3" );
- helper.clearTags().setQueryParameter( "tagFilters", "t3,(t1,t2)" ).search();
+
+ if (calls === 3) {
+ t.equal(content.hits.length, 1, 'Two tags (t1, t2): 1 result')
+ t.deepEqual(map(content.hits, hitsToParsedID).sort(),
+ [0],
+ 'Two tags (t1, t2) expected ids: 0')
+ helper.removeTag('t2').toggleTag('t3').toggleTag('t1').search()
}
- if( calls === 5 ) {
- t.equal( content.hits.length, 2, "filter should result in two item again" );
- t.deepEqual( map( content.hits, hitsToParsedID ).sort(), [ 1, 2 ] );
- client.deleteIndex( indexName );
- t.end();
+
+ if (calls === 4) {
+ t.equal(content.hits.length, 3, 'One tag (t3): 3 results')
+ t.deepEqual(map(content.hits, hitsToParsedID).sort(),
+ [1, 2, 3],
+ 'One tag (t3) expected ids: 1, 2, 3')
+ helper.clearTags().setQueryParameter('tagFilters', 't3,(t1,t2)').search()
}
- } );
- helper.search();
- } );
+ if (calls === 5) {
+ t.equal(content.hits.length, 2, 'filter should result in two item again')
+ t.deepEqual(map(content.hits, hitsToParsedID).sort(), [1, 2])
+ client.deleteIndex(indexName)
+ t.end()
+ }
+ })
-} );
+ helper.search()
+ })
+})
diff --git a/test/integration-utils.js b/test/integration-utils.js
index 7b1b8888ff..029ca0a1bb 100644
--- a/test/integration-utils.js
+++ b/test/integration-utils.js
@@ -1,21 +1,21 @@
-"use strict";
+'use strict'
-var algoliasearch = require( "algoliasearch" );
+var algoliasearch = require('algoliasearch')
-function setup( indexName, fn ) {
- /* eslint-disable */
- var appID = process.env.INTEGRATION_TEST_APPID;
- var key = process.env.INTEGRATION_TEST_API_KEY;
- /* eslint-enable */
+function setup(indexName, fn) {
+ var appID = process.env.INTEGRATION_TEST_APPID
+ var key = process.env.INTEGRATION_TEST_API_KEY
- var client = algoliasearch( appID, key, { protocol : "https:" } );
- return client.deleteIndex( indexName )
- .then( function( ) {
- var index = client.initIndex( indexName );
- return fn( client, index );
- } );
+ var client = algoliasearch(appID, key, {protocol: 'https:'})
+
+ return client.deleteIndex(indexName)
+ .then(function() {
+ var index = client.initIndex(indexName)
+
+ return fn(client, index)
+ })
}
module.exports = {
- setup : setup
-};
+ setup: setup
+}
diff --git a/test/run.js b/test/run.js
index 027db606ae..20ed1bd80e 100644
--- a/test/run.js
+++ b/test/run.js
@@ -1,9 +1,8 @@
-"use strict";
+'use strict'
-require( "bulk-require" )( __dirname, ["spec/**/*.js"] );
+require('bulk-require')(__dirname, ['spec/**/*.js'])
-if ( process.env.INTEGRATION_TEST_API_KEY && process.env.INTEGRATION_TEST_APPID ) {
+if (process.env.INTEGRATION_TEST_API_KEY && process.env.INTEGRATION_TEST_APPID) {
// usage: INTEGRATION_TEST_APPID=$APPID INTEGRATION_TEST_API_KEY=$APIKEY npm run dev
- require( "bulk-require" )( __dirname, ["integration-spec/**/*.js"] );
+ require('bulk-require')(__dirname, ['integration-spec/**/*.js'])
}
-
diff --git a/test/spec/SearchParameters.addFacetRefinement.js b/test/spec/SearchParameters.addFacetRefinement.js
index 1c7ed580f1..ad9588b563 100644
--- a/test/spec/SearchParameters.addFacetRefinement.js
+++ b/test/spec/SearchParameters.addFacetRefinement.js
@@ -1,40 +1,41 @@
-"use strict";
-var test = require( "tape" );
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var test = require('tape')
+var SearchParameters = require('../../src/SearchParameters')
-test( "addFacetRefinement : should add a new item", function( t ) {
- var initialState = SearchParameters.make();
+test('addFacetRefinement: should add a new item', function(t) {
+ var initialState = SearchParameters.make()
- t.deepEqual( initialState.facetsRefinements, {}, "facetsRefinements should be empty at first" );
- var state1 = initialState.addFacetRefinement( "facetName", "facetValue1" );
- t.deepEqual( state1.facetsRefinements, { facetName : [ "facetValue1" ] } );
+ t.deepEqual(initialState.facetsRefinements, {}, 'facetsRefinements should be empty at first')
+ var state1 = initialState.addFacetRefinement('facetName', 'facetValue1')
- t.end();
-} );
+ t.deepEqual(state1.facetsRefinements, {facetName: ['facetValue1']})
-test( "addFacetRefinement : should be able to add more than one item", function( t ) {
+ t.end()
+})
+
+test('addFacetRefinement: should be able to add more than one item', function(t) {
var state = SearchParameters.make()
- .addFacetRefinement( "facetName", "facetValue1" )
- .addFacetRefinement( "facetName", "facetValue2" )
- .addFacetRefinement( "facetName", "facetValue3" );
+ .addFacetRefinement('facetName', 'facetValue1')
+ .addFacetRefinement('facetName', 'facetValue2')
+ .addFacetRefinement('facetName', 'facetValue3')
- t.deepEqual( state.facetsRefinements, { facetName : [ "facetValue1", "facetValue2", "facetValue3" ] } );
+ t.deepEqual(state.facetsRefinements, {facetName: ['facetValue1', 'facetValue2', 'facetValue3']})
- t.end();
-} );
+ t.end()
+})
-test( "addFacetRefinement : should be able to add values for different facet", function( t ) {
+test('addFacetRefinement: should be able to add values for different facet', function(t) {
var state = SearchParameters.make()
- .addFacetRefinement( "facetName1", "facetValue1" )
- .addFacetRefinement( "facetName2", "facetValue2" )
- .addFacetRefinement( "facetName2", "facetValue4" )
- .addFacetRefinement( "facetName3", "facetValue3" );
-
- t.deepEqual( state.facetsRefinements, {
- facetName1 : [ "facetValue1" ],
- facetName2 : [ "facetValue2", "facetValue4" ],
- facetName3 : [ "facetValue3" ]
- } );
-
- t.end();
-} );
+ .addFacetRefinement('facetName1', 'facetValue1')
+ .addFacetRefinement('facetName2', 'facetValue2')
+ .addFacetRefinement('facetName2', 'facetValue4')
+ .addFacetRefinement('facetName3', 'facetValue3')
+
+ t.deepEqual(state.facetsRefinements, {
+ facetName1: ['facetValue1'],
+ facetName2: ['facetValue2', 'facetValue4'],
+ facetName3: ['facetValue3']
+ })
+
+ t.end()
+})
diff --git a/test/spec/SearchParameters.getRefinedDisjunctiveFacets.js b/test/spec/SearchParameters.getRefinedDisjunctiveFacets.js
index 547db19cc1..e264f6718b 100644
--- a/test/spec/SearchParameters.getRefinedDisjunctiveFacets.js
+++ b/test/spec/SearchParameters.getRefinedDisjunctiveFacets.js
@@ -1,39 +1,42 @@
-"use strict";
-var test = require( "tape" );
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var test = require('tape')
+var SearchParameters = require('../../src/SearchParameters')
-test( "getRefinedDisjunctiveFacets should return the refined facets declared as disjunctive", function( t ) {
- var sp = new SearchParameters( {
- disjunctiveFacets : [ "myNumericFacet" ]
- } );
+test('getRefinedDisjunctiveFacets should return the refined facets declared as disjunctive', function(t) {
+ var sp = new SearchParameters({
+ disjunctiveFacets: ['myNumericFacet']
+ })
- t.equal( sp.getRefinedDisjunctiveFacets().length, 0, "Should be empty at first" );
- var newState = sp.addNumericRefinement( "myNumericFacet", ">", 3 );
- t.equal( newState.getRefinedDisjunctiveFacets().indexOf( "myNumericFacet" ), 0, "Should contain myNumericFacet" );
+ t.equal(sp.getRefinedDisjunctiveFacets().length, 0, 'Should be empty at first')
+ var newState = sp.addNumericRefinement('myNumericFacet', '>', 3)
- t.end();
-} );
+ t.equal(newState.getRefinedDisjunctiveFacets().indexOf('myNumericFacet'), 0, 'Should contain myNumericFacet')
-test( "getRefinedDisjunctiveFacets should return the refined once even if there are multiple filters on the same facet", function( t ) {
- var sp = new SearchParameters( {
- disjunctiveFacets : [ "myNumericFacet" ]
- } );
+ t.end()
+})
- t.equal( sp.getRefinedDisjunctiveFacets().length, 0, "Should be empty at first" );
- var newState = sp.addNumericRefinement( "myNumericFacet", ">", 3 ).addNumericRefinement( "myNumericFacet", "=", 3 );
- t.equal( newState.getRefinedDisjunctiveFacets().indexOf( "myNumericFacet" ), 0, "Should contain myNumericFacet" );
+test('getRefinedDisjunctiveFacets should return the refined once even if there are multiple filters on the same facet', function(t) {
+ var sp = new SearchParameters({
+ disjunctiveFacets: ['myNumericFacet']
+ })
- t.end();
-} );
+ t.equal(sp.getRefinedDisjunctiveFacets().length, 0, 'Should be empty at first')
+ var newState = sp.addNumericRefinement('myNumericFacet', '>', 3).addNumericRefinement('myNumericFacet', '=', 3)
-test( "getRefinedDisjunctiveFactes should not return refined normal facets", function( t ) {
- var sp = new SearchParameters( {
- facets : [ "myNumericFacet" ]
- } );
+ t.equal(newState.getRefinedDisjunctiveFacets().indexOf('myNumericFacet'), 0, 'Should contain myNumericFacet')
- t.equal( sp.getRefinedDisjunctiveFacets().length, 0, "Should be empty at first" );
- var newState = sp.addNumericRefinement( "myNumericFacet", ">", 3 );
- t.equal( newState.getRefinedDisjunctiveFacets().length, 0, "Should still be empty" );
+ t.end()
+})
- t.end();
-} );
+test('getRefinedDisjunctiveFactes should not return refined normal facets', function(t) {
+ var sp = new SearchParameters({
+ facets: ['myNumericFacet']
+ })
+
+ t.equal(sp.getRefinedDisjunctiveFacets().length, 0, 'Should be empty at first')
+ var newState = sp.addNumericRefinement('myNumericFacet', '>', 3)
+
+ t.equal(newState.getRefinedDisjunctiveFacets().length, 0, 'Should still be empty')
+
+ t.end()
+})
diff --git a/test/spec/SearchParameters.getUnrefinedDisjunctiveFacets.js b/test/spec/SearchParameters.getUnrefinedDisjunctiveFacets.js
index a019bd6396..b733ac6923 100644
--- a/test/spec/SearchParameters.getUnrefinedDisjunctiveFacets.js
+++ b/test/spec/SearchParameters.getUnrefinedDisjunctiveFacets.js
@@ -1,17 +1,17 @@
-"use strict";
-var test = require( "tape" );
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var test = require('tape')
+var SearchParameters = require('../../src/SearchParameters')
-test( "getUnrefinedDisjunctiveFacets : should return all non refined disjunctive facet", function( t ) {
- var state0 = SearchParameters.make( {
- disjunctiveFacets : [ "facet1", "facet2", "facet3" ]
- } );
+test('getUnrefinedDisjunctiveFacets: should return all non refined disjunctive facet', function(t) {
+ var state0 = SearchParameters.make({
+ disjunctiveFacets: ['facet1', 'facet2', 'facet3']
+ })
- var state1 = state0.addDisjunctiveFacetRefinement( "facet1", "a" )
- .addDisjunctiveFacetRefinement( "facet3", "x" )
- .addDisjunctiveFacetRefinement( "facet1", "abc" );
+ var state1 = state0.addDisjunctiveFacetRefinement('facet1', 'a')
+ .addDisjunctiveFacetRefinement('facet3', 'x')
+ .addDisjunctiveFacetRefinement('facet1', 'abc')
- t.deepEqual( state1.getUnrefinedDisjunctiveFacets(), [ "facet2" ], "Should only return [ facet2 ]" );
+ t.deepEqual(state1.getUnrefinedDisjunctiveFacets(), ['facet2'], 'Should only return [ facet2 ]')
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/SearchParameters.noChanges.js b/test/spec/SearchParameters.noChanges.js
index 98d607aacb..3cefc50bb0 100644
--- a/test/spec/SearchParameters.noChanges.js
+++ b/test/spec/SearchParameters.noChanges.js
@@ -1,132 +1,128 @@
-"use strict";
-var test = require( "tape" );
+'use strict'
+var test = require('tape')
-var SearchParameters = require( "../../src/SearchParameters" );
+var SearchParameters = require('../../src/SearchParameters')
-test( "[No changes] setHitsPerPage", function( t ) {
- var state = SearchParameters.make( {
- hitsPerPage : 2
- } );
+test('[No changes] setHitsPerPage', function(t) {
+ var state = SearchParameters.make({
+ hitsPerPage: 2
+ })
- t.equal( state.setHitsPerPage( 2 ), state, "setHitsPerPage should return the same instance" );
+ t.equal(state.setHitsPerPage(2), state, 'setHitsPerPage should return the same instance')
- t.end();
-} );
+ t.end()
+})
-test( "[No changes] setTypoTolerance", function( t ) {
- var state = SearchParameters.make( {
- typoTolerance : true
- } );
+test('[No changes] setTypoTolerance', function(t) {
+ var state = SearchParameters.make({
+ typoTolerance: true
+ })
- t.equal( state.setTypoTolerance( true ), state, "setTypoTolerance should return the same instance" );
+ t.equal(state.setTypoTolerance(true), state, 'setTypoTolerance should return the same instance')
- t.end();
-} );
+ t.end()
+})
-test( "[No changes] setPage", function( t ) {
- var state = SearchParameters.make( {
- page : 2
- } );
+test('[No changes] setPage', function(t) {
+ var state = SearchParameters.make({
+ page: 2
+ })
- t.equal( state.setPage( 2 ), state, "setPage should return the same instance" );
+ t.equal(state.setPage(2), state, 'setPage should return the same instance')
- t.end();
-} );
+ t.end()
+})
+test('[No changes] setQuery', function(t) {
+ var state = SearchParameters.make({
+ query: 'query'
+ })
-test( "[No changes] setQuery", function( t ) {
- var state = SearchParameters.make( {
- query : "query"
- } );
+ t.equal(state.setQuery('query'), state, 'setQuery should return the same instance')
- t.equal( state.setQuery( "query" ), state, "setQuery should return the same instance" );
+ t.end()
+})
- t.end();
-} );
+test('[No changes] addTagRefinement', function(t) {
+ var state = SearchParameters.make({}).addTagRefinement('tag')
+ t.equal(state.addTagRefinement('tag'), state, 'addTagRefinement should return the same instance')
-test( "[No changes] addTagRefinement", function( t ) {
- var state = SearchParameters.make( {} ).addTagRefinement( "tag" );
+ t.end()
+})
- t.equal( state.addTagRefinement( "tag" ), state, "addTagRefinement should return the same instance" );
+test('[No changes] clearTags', function(t) {
+ var state = SearchParameters.make({
+ query: 'query'
+ })
- t.end();
-} );
+ t.equal(state.clearTags(), state, 'clearTags should return the same instance')
-test( "[No changes] clearTags", function( t ) {
- var state = SearchParameters.make( {
- query : "query"
- } );
+ t.end()
+})
- t.equal( state.clearTags(), state, "clearTags should return the same instance" );
+test('[No changes] addDisjunctiveFacetRefinement', function(t) {
+ var state = SearchParameters.make({
+ disjunctiveFacets: ['facet']
+ }).addDisjunctiveFacetRefinement('facet', 'value')
- t.end();
-} );
+ t.equal(state.addDisjunctiveFacetRefinement('facet', 'value'), state, 'addDisjunctiveFacetRefinement should return the same instance')
+ t.end()
+})
-test( "[No changes] addDisjunctiveFacetRefinement", function( t ) {
- var state = SearchParameters.make( {
- disjunctiveFacets : ["facet"]
- } ).addDisjunctiveFacetRefinement( "facet", "value" );
+test('[No changes] removeDisjunctiveFacetRefinement', function(t) {
+ var state = SearchParameters.make({
+ disjunctiveFacets: ['facet']
+ })
- t.equal( state.addDisjunctiveFacetRefinement( "facet", "value" ), state, "addDisjunctiveFacetRefinement should return the same instance" );
+ t.equal(state.removeDisjunctiveFacetRefinement('facet', 'value'), state, 'removeDisjunctiveFacetRefinement should return the same instance')
- t.end();
-} );
+ t.end()
+})
-test( "[No changes] removeDisjunctiveFacetRefinement", function( t ) {
- var state = SearchParameters.make( {
- disjunctiveFacets : ["facet"]
- } );
+test('[No changes] addFacetRefinement', function(t) {
+ var state = SearchParameters.make({
+ facets: ['facet']
+ }).addFacetRefinement('facet', 'value')
- t.equal( state.removeDisjunctiveFacetRefinement( "facet", "value" ), state, "removeDisjunctiveFacetRefinement should return the same instance" );
+ t.equal(state.addFacetRefinement('facet', 'value'), state, 'addFacetRefinement should return the same instance')
- t.end();
-} );
+ t.end()
+})
+test('[No changes] removeDisjunctiveFacetRefinement', function(t) {
+ var state = SearchParameters.make({
+ facets: ['facet']
+ })
-test( "[No changes] addFacetRefinement", function( t ) {
- var state = SearchParameters.make( {
- facets : ["facet"]
- } ).addFacetRefinement( "facet", "value" );
+ t.equal(state.removeDisjunctiveFacetRefinement('facet', 'value'), state, 'removeDisjunctiveFacetRefinement should return the same instance')
- t.equal( state.addFacetRefinement( "facet", "value" ), state, "addFacetRefinement should return the same instance" );
+ t.end()
+})
- t.end();
-} );
+test('[No changes] addNumericRefinement', function(t) {
+ var state = SearchParameters.make({}).addNumericRefinement('attribute', '>', 0)
-test( "[No changes] removeDisjunctiveFacetRefinement", function( t ) {
- var state = SearchParameters.make( {
- facets : ["facet"]
- } );
+ t.equal(state.addNumericRefinement('attribute', '>', 0), state, 'addNumericRefinement should return the same instance')
- t.equal( state.removeDisjunctiveFacetRefinement( "facet", "value" ), state, "removeDisjunctiveFacetRefinement should return the same instance" );
+ t.end()
+})
- t.end();
-} );
+test('[No changes] removeNumericRefinement', function(t) {
+ var state = SearchParameters.make({})
-test( "[No changes] addNumericRefinement", function( t ) {
- var state = SearchParameters.make( {} ).addNumericRefinement( "attribute", ">", 0 );
+ t.equal(state.removeNumericRefinement('attribute', '>'), state, 'removeNumericRefinement should return the same instance')
- t.equal( state.addNumericRefinement( "attribute", ">", 0 ), state, "addNumericRefinement should return the same instance" );
+ t.end()
+})
- t.end();
-} );
+test('[No changes] setQueryParameter', function(t) {
+ var state = SearchParameters.make({
+ minWordSizefor1Typo: 50
+ })
-test( "[No changes] removeNumericRefinement", function( t ) {
- var state = SearchParameters.make( {} );
+ t.equal(state.setQueryParameter('minWordSizefor1Typo', 50), state, 'setQueryParameter should return the same instance')
- t.equal( state.removeNumericRefinement( "attribute", ">" ), state, "removeNumericRefinement should return the same instance" );
-
- t.end();
-} );
-
-test( "[No changes] setQueryParameter", function( t ) {
- var state = SearchParameters.make( {
- minWordSizefor1Typo : 50
- } );
-
- t.equal( state.setQueryParameter( "minWordSizefor1Typo", 50 ), state, "setQueryParameter should return the same instance" );
-
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/SearchParameters.setQueryParameter.js b/test/spec/SearchParameters.setQueryParameter.js
index 8a0d376b67..b28738859e 100644
--- a/test/spec/SearchParameters.setQueryParameter.js
+++ b/test/spec/SearchParameters.setQueryParameter.js
@@ -1,56 +1,56 @@
-"use strict";
-var test = require( "tape" );
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var test = require('tape')
+var SearchParameters = require('../../src/SearchParameters')
-test( "setqueryparameter should update existing parameter", function( t ) {
- var sp = new SearchParameters( {
- facets : ["facet"]
- } );
+test('setqueryparameter should update existing parameter', function(t) {
+ var sp = new SearchParameters({
+ facets: ['facet']
+ })
- var newValue = [];
- var newsp = sp.setQueryParameter( "facets", newValue );
+ var newValue = []
+ var newsp = sp.setQueryParameter('facets', newValue)
- t.equal( newsp.facets, newValue, "update of an existing parameter" );
+ t.equal(newsp.facets, newValue, 'update of an existing parameter')
- t.end();
-} );
+ t.end()
+})
-test( "setqueryparameter should add non-existing parameter", function( t ) {
- var sp = new SearchParameters( {
- facets : ["facet"]
- } );
+test('setqueryparameter should add non-existing parameter', function(t) {
+ var sp = new SearchParameters({
+ facets: ['facet']
+ })
- var newValue = [ "attributesToHighlight" ];
- var newsp = sp.setQueryParameter( "attributesToHighlight", newValue );
+ var newValue = ['attributesToHighlight']
+ var newsp = sp.setQueryParameter('attributesToHighlight', newValue)
- t.equal( newsp.attributesToHighlight, newValue, "add new parameter" );
+ t.equal(newsp.attributesToHighlight, newValue, 'add new parameter')
- t.end();
-} );
+ t.end()
+})
-test( "setQueryParameter should not create a new instance if the update is non effective", function( t ) {
- var sp = new SearchParameters( {
- facets : ["facet"],
- maxValuesPerFacet : 10
- } );
+test('setQueryParameter should not create a new instance if the update is non effective', function(t) {
+ var sp = new SearchParameters({
+ facets: ['facet'],
+ maxValuesPerFacet: 10
+ })
- var newValue = 10;
- var newsp = sp.setQueryParameter( "maxValuesPerFacet", newValue );
+ var newValue = 10
+ var newsp = sp.setQueryParameter('maxValuesPerFacet', newValue)
- t.equal( newsp, sp, "No change should result in the same instance" );
+ t.equal(newsp, sp, 'No change should result in the same instance')
- t.end();
-} );
+ t.end()
+})
-test( "setQueryParameter should throw an error when trying to add an unknown parameter", function( t ) {
- var partial = require( "lodash/function/partial" );
+test('setQueryParameter should throw an error when trying to add an unknown parameter', function(t) {
+ var partial = require('lodash/function/partial')
- var sp = new SearchParameters( {
- facets : ["facet"]
- } );
+ var sp = new SearchParameters({
+ facets: ['facet']
+ })
- t.throws( partial( sp.setQueryParameter, "unknown", "" ),
- "Unknown parameter should throw an exception" );
+ t.throws(partial(sp.setQueryParameter, 'unknown', ''),
+ 'Unknown parameter should throw an exception')
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/SearchParameters.setQueryParameters.js b/test/spec/SearchParameters.setQueryParameters.js
index d425927e36..6e10c048aa 100644
--- a/test/spec/SearchParameters.setQueryParameters.js
+++ b/test/spec/SearchParameters.setQueryParameters.js
@@ -1,45 +1,45 @@
-"use strict";
-var test = require( "tape" );
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var test = require('tape')
+var SearchParameters = require('../../src/SearchParameters')
-test( "setQueryParameters should be able to mix an actual state with a new set of parameters", function( t ) {
- var originalSP = new SearchParameters( {
- facets : [ "a", "b" ],
- ignorePlurals : false,
- attributesToHighlight : ""
- } );
+test('setQueryParameters should be able to mix an actual state with a new set of parameters', function(t) {
+ var originalSP = new SearchParameters({
+ facets: ['a', 'b'],
+ ignorePlurals: false,
+ attributesToHighlight: ''
+ })
var params = {
- facets : [ "a", "c" ],
- attributesToHighlight : [ "city", "country" ],
- replaceSynonymsInHighlight : true
- };
- var newSP = originalSP.setQueryParameters( params );
+ facets: ['a', 'c'],
+ attributesToHighlight: ['city', 'country'],
+ replaceSynonymsInHighlight: true
+ }
+ var newSP = originalSP.setQueryParameters(params)
- t.equal( newSP.facets, params.facets, "Facets should be updated (existing parameter)" );
- t.equal( newSP.attributesToHighlight, newSP.attributesToHighlight, "attributesToHighlight should be updated (existing parameter)" );
- t.equal( newSP.replaceSynonymsInHighlight, newSP.replaceSynonymsInHighlight, "replaceSynonymsInHighlight should be updated (new parameter)" );
- t.equal( newSP.ignorePlurals, originalSP.ignorePlurals, "ignorePlurals should be the same as the original" );
+ t.equal(newSP.facets, params.facets, 'Facets should be updated (existing parameter)')
+ t.equal(newSP.attributesToHighlight, newSP.attributesToHighlight, 'attributesToHighlight should be updated (existing parameter)')
+ t.equal(newSP.replaceSynonymsInHighlight, newSP.replaceSynonymsInHighlight, 'replaceSynonymsInHighlight should be updated (new parameter)')
+ t.equal(newSP.ignorePlurals, originalSP.ignorePlurals, 'ignorePlurals should be the same as the original')
- t.end();
-} );
+ t.end()
+})
-test( "setQueryParameters should not add unknown properties", function( t ) {
- var partial = require( "lodash/function/partial" );
+test('setQueryParameters should not add unknown properties', function(t) {
+ var partial = require('lodash/function/partial')
- var originalSP = new SearchParameters( {
- facets : [ "a", "b" ],
- ignorePlurals : false,
- attributesToHighlight : ""
- } );
+ var originalSP = new SearchParameters({
+ facets: ['a', 'b'],
+ ignorePlurals: false,
+ attributesToHighlight: ''
+ })
var params = {
- unknow1 : [ "a", "c" ],
- facet : [ "city", "country" ]
- };
+ unknow1: ['a', 'c'],
+ facet: ['city', 'country']
+ }
- t.throws( partial( originalSP.setQueryParameters, params ),
- "The new searchParameters should be strictly equal" );
+ t.throws(partial(originalSP.setQueryParameters, params),
+ 'The new searchParameters should be strictly equal')
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/SearchResults.getFacet.js b/test/spec/SearchResults.getFacet.js
index d3940a96af..804c9e24c2 100644
--- a/test/spec/SearchResults.getFacet.js
+++ b/test/spec/SearchResults.getFacet.js
@@ -1,19 +1,20 @@
-"use strict";
-var test = require( "tape" );
-var SearchResults = require( "../../src/SearchResults" );
+'use strict'
+var test = require('tape')
+var SearchResults = require('../../src/SearchResults')
-test( "getFacetByName should return a given facet be it disjunctive or conjunctive", function( t ) {
- var data = require( "./search.testdata" );
+test('getFacetByName should return a given facet be it disjunctive or conjunctive', function(t) {
+ var data = require('./search.testdata')
- var result = new SearchResults( data.searchParams, data.response );
+ var result = new SearchResults(data.searchParams, data.response)
- var cityFacet = result.getFacetByName( "city" );
- t.equal( cityFacet.name, "city", "name" );
- t.deepEqual( cityFacet.data, {
- "New York" : 1,
- "Paris" : 3,
- "San Francisco" : 1
- }, "values" );
+ var cityFacet = result.getFacetByName('city')
- t.end();
-} );
+ t.equal(cityFacet.name, 'city', 'name')
+ t.deepEqual(cityFacet.data, {
+ 'New York': 1,
+ Paris: 3,
+ 'San Francisco': 1
+ }, 'values')
+
+ t.end()
+})
diff --git a/test/spec/helper.clears.js b/test/spec/helper.clears.js
index 2dde73ea52..984817ed15 100644
--- a/test/spec/helper.clears.js
+++ b/test/spec/helper.clears.js
@@ -1,164 +1,163 @@
-"use strict";
-var test = require( "tape" ),
- algoliasearchHelper = require( "../../index" ),
- forEach = require( "lodash/collection/forEach" ),
- keys = require( "lodash/object/keys" ),
- isEmpty = require( "lodash/lang/isEmpty" ),
- isUndefined = require( "lodash/lang/isUndefined" );
+'use strict'
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
+var forEach = require('lodash/collection/forEach')
+var keys = require('lodash/object/keys')
+var isEmpty = require('lodash/lang/isEmpty')
+var isUndefined = require('lodash/lang/isUndefined')
var fixture = function fixture() {
- var helper = algoliasearchHelper( undefined, "Index", {
- facets : ["facet1", "facet2", "both_facet"],
- disjunctiveFacets : ["disjunctiveFacet1", "disjunctiveFacet2", "both_facet"]
- } );
+ var helper = algoliasearchHelper(undefined, 'Index', {
+ facets: ['facet1', 'facet2', 'both_facet'],
+ disjunctiveFacets: ['disjunctiveFacet1', 'disjunctiveFacet2', 'both_facet']
+ })
- return helper.toggleRefine( "facet1", "0" )
- .toggleRefine( "facet2", "0" )
- .toggleRefine( "disjunctiveFacet1", "0" )
- .toggleRefine( "disjunctiveFacet2", "0" )
- .toggleExclude( "excluded1", "0" )
- .toggleExclude( "excluded2", "0" )
- .addNumericRefinement( "numeric1", ">=", "0" )
- .addNumericRefinement( "numeric1", "<", "10" )
- .addNumericRefinement( "numeric2", ">=", 0 )
- .addNumericRefinement( "numeric2", "<", 10 );
-};
+ return helper.toggleRefine('facet1', '0')
+ .toggleRefine('facet2', '0')
+ .toggleRefine('disjunctiveFacet1', '0')
+ .toggleRefine('disjunctiveFacet2', '0')
+ .toggleExclude('excluded1', '0')
+ .toggleExclude('excluded2', '0')
+ .addNumericRefinement('numeric1', '>=', '0')
+ .addNumericRefinement('numeric1', '<', '10')
+ .addNumericRefinement('numeric2', '>=', 0)
+ .addNumericRefinement('numeric2', '<', 10)
+}
-test( "Check that the state objects match how we test them", function( t ) {
- var helper = fixture();
+test('Check that the state objects match how we test them', function(t) {
+ var helper = fixture()
- t.deepEqual( helper.state.facetsRefinements, { "facet1" : [ "0" ], "facet2" : [ "0" ] } );
- t.deepEqual( helper.state.disjunctiveFacetsRefinements, { "disjunctiveFacet1" : [ "0" ], "disjunctiveFacet2" : [ "0" ] } );
- t.deepEqual( helper.state.facetsExcludes, { "excluded1" : [ "0" ], "excluded2" : [ "0" ] } );
- t.deepEqual( helper.state.numericRefinements, { "numeric1" : { ">=" : "0", "<" : "10" }, "numeric2" : { ">=" : 0, "<" : 10 } } );
+ t.deepEqual(helper.state.facetsRefinements, {facet1: ['0'], facet2: ['0']})
+ t.deepEqual(helper.state.disjunctiveFacetsRefinements, {disjunctiveFacet1: ['0'], disjunctiveFacet2: ['0']})
+ t.deepEqual(helper.state.facetsExcludes, {excluded1: ['0'], excluded2: ['0']})
+ t.deepEqual(helper.state.numericRefinements, {numeric1: {'>=': '0', '<': '10'}, numeric2: {'>=': 0, '<': 10}})
- t.end();
-} );
+ t.end()
+})
-test( "Clear with a name should work on every type and not remove others than targetted name", function( t ) {
- var helper = fixture();
+test('Clear with a name should work on every type and not remove others than targetted name', function(t) {
+ var helper = fixture()
- helper.clearRefinements( "facet1" );
- t.deepEqual( helper.state.facetsRefinements, { "facet2" : [ "0" ] } );
+ helper.clearRefinements('facet1')
+ t.deepEqual(helper.state.facetsRefinements, {facet2: ['0']})
- helper.clearRefinements( "disjunctiveFacet1" );
- t.deepEqual( helper.state.disjunctiveFacetsRefinements, { "disjunctiveFacet2" : [ "0" ] } );
+ helper.clearRefinements('disjunctiveFacet1')
+ t.deepEqual(helper.state.disjunctiveFacetsRefinements, {disjunctiveFacet2: ['0']})
- helper.clearRefinements( "excluded1" );
- t.deepEqual( helper.state.facetsExcludes, { "excluded2" : [ "0" ] } );
+ helper.clearRefinements('excluded1')
+ t.deepEqual(helper.state.facetsExcludes, {excluded2: ['0']})
- helper.clearRefinements( "numeric1" );
- t.deepEqual( helper.state.numericRefinements, { "numeric2" : { ">=" : 0, "<" : 10 } } );
+ helper.clearRefinements('numeric1')
+ t.deepEqual(helper.state.numericRefinements, {numeric2: {'>=': 0, '<': 10}})
- t.end();
-} );
+ t.end()
+})
+test('Clearing the same field from multiple elements should remove it everywhere', function(t) {
+ var helper = fixture()
-test( "Clearing the same field from multiple elements should remove it everywhere", function( t ) {
- var helper = fixture();
+ helper.addNumericRefinement('facet1', '>=', '10').toggleExclude('facet1', 'value')
- helper.addNumericRefinement( "facet1", ">=", "10" ).toggleExclude( "facet1", "value" );
+ t.deepEqual(helper.state.facetsRefinements.facet1, ['0'])
+ t.deepEqual(helper.state.numericRefinements.facet1, {'>=': '10'})
+ t.deepEqual(helper.state.facetsExcludes.facet1, ['value'])
- t.deepEqual( helper.state.facetsRefinements.facet1, [ "0" ] );
- t.deepEqual( helper.state.numericRefinements.facet1, { ">=" : "10" } );
- t.deepEqual( helper.state.facetsExcludes.facet1, [ "value" ] );
+ helper.clearRefinements('facet1')
+ t.assert(isUndefined(helper.state.facetsRefinements.facet1))
+ t.assert(isUndefined(helper.state.numericRefinements.facet1))
+ t.assert(isUndefined(helper.state.facetsExcludes.facet1))
- helper.clearRefinements( "facet1" );
- t.assert( isUndefined( helper.state.facetsRefinements.facet1 ) );
- t.assert( isUndefined( helper.state.numericRefinements.facet1 ) );
- t.assert( isUndefined( helper.state.facetsExcludes.facet1 ) );
+ t.end()
+})
- t.end();
-} );
+test('Clear with a function: neutral predicate', function(t) {
+ var helper = fixture()
+ var state0 = helper.state
-test( "Clear with a function : neutral predicate", function( t ) {
- var helper = fixture();
- var state0 = helper.state;
+ helper.clearRefinements(function() {
+ return false
+ })
- helper.clearRefinements( function() {
- return false;
- } );
+ t.deepEqual(helper.state.numericRefinements, state0.numericRefinements, 'Neutral op: numeric ref should be equal')
+ t.deepEqual(helper.state.facetsRefinements, state0.facetsRefinements, 'Neutral op: conj ref should be equal')
+ t.deepEqual(helper.state.facetsExcludes, state0.facetsExcludes, 'Neutral op: exclude ref should be equal')
+ t.deepEqual(helper.state.disjunctiveFacetsRefinements, state0.disjunctiveFacetsRefinements, 'Neutral op: disj ref should be equal')
- t.deepEqual( helper.state.numericRefinements, state0.numericRefinements, "Neutral op : numeric ref should be equal" );
- t.deepEqual( helper.state.facetsRefinements, state0.facetsRefinements, "Neutral op : conj ref should be equal" );
- t.deepEqual( helper.state.facetsExcludes, state0.facetsExcludes, "Neutral op : exclude ref should be equal" );
- t.deepEqual( helper.state.disjunctiveFacetsRefinements, state0.disjunctiveFacetsRefinements, "Neutral op : disj ref should be equal" );
+ t.end()
+})
- t.end();
-} );
+test('Clear with a function: remove all predicate', function(t) {
+ var helper = fixture()
-test( "Clear with a function : remove all predicate", function( t ) {
- var helper = fixture();
+ helper.clearRefinements(function() {
+ return true
+ })
- helper.clearRefinements( function() {
- return true;
- } );
+ t.assert(isEmpty(helper.state.numericRefinements), 'remove all numericRefinements')
+ t.assert(isEmpty(helper.state.facetsRefinements), 'remove all facetsRefinements')
+ t.assert(isEmpty(helper.state.facetsExcludes), 'remove all facetsExcludes')
+ t.assert(isEmpty(helper.state.disjunctiveFacetsRefinements), 'remove all disjunctiveFacetsRefinements')
- t.assert( isEmpty( helper.state.numericRefinements ), "remove all numericRefinements" );
- t.assert( isEmpty( helper.state.facetsRefinements ), "remove all facetsRefinements" );
- t.assert( isEmpty( helper.state.facetsExcludes ), "remove all facetsExcludes" );
- t.assert( isEmpty( helper.state.disjunctiveFacetsRefinements ), "remove all disjunctiveFacetsRefinements" );
+ t.end()
+})
- t.end();
-} );
-
-test( "Clear with a function : filtering", function( t ) {
- var helper = fixture();
+test('Clear with a function: filtering', function(t) {
+ var helper = fixture()
var checkType = {
- numeric : false,
- disjunctiveFacet : false,
- conjunctiveFacet : false,
- exclude : false
- };
-
- helper.clearRefinements( function( value, key, type ) {
- checkType[ type ] = true;
-
- return key.indexOf( "1" ) !== -1;
- } );
-
- t.equal( keys( checkType ).length, 4, "There should be only 4 refinements" );
- forEach( checkType, function( typeTest, type ) { t.ok( typeTest, "clear should go through : " + type ); } );
-
- t.deepEqual( helper.state.facetsRefinements, { "facet2" : [ "0" ] } );
- t.deepEqual( helper.state.disjunctiveFacetsRefinements, { "disjunctiveFacet2" : [ "0" ] } );
- t.deepEqual( helper.state.facetsExcludes, { "excluded2" : [ "0" ] } );
- t.deepEqual( helper.state.numericRefinements, { "numeric2" : { ">=" : 0, "<" : 10 } } );
-
- t.end();
-} );
-
-test( "Clearing twice the same attribute should be not problem", function( t ) {
- var helper = fixture();
-
- t.deepEqual( helper.state.facetsRefinements.facet1, [ "0" ] );
- helper.clearRefinements( "facet1" );
- t.assert( isUndefined( helper.state.facetsRefinements.facet1 ) );
- t.doesNotThrow( function() {
- helper.clearRefinements( "facet1" );
- } );
-
- t.deepEqual( helper.state.disjunctiveFacetsRefinements.disjunctiveFacet1, [ "0" ] );
- helper.clearRefinements( "disjunctiveFacet1" );
- t.assert( isUndefined( helper.state.disjunctiveFacetsRefinements.disjunctiveFacet1 ) );
- t.doesNotThrow( function() {
- helper.clearRefinements( "disjunctiveFacet1" );
- } );
-
- t.deepEqual( helper.state.facetsExcludes.excluded1, [ "0" ] );
- helper.clearRefinements( "excluded1" );
- t.assert( isUndefined( helper.state.facetsExcludes.excluded1 ) );
- t.doesNotThrow( function() {
- helper.clearRefinements( "excluded1" );
- } );
-
- t.deepEqual( helper.state.numericRefinements.numeric1, { ">=" : "0", "<" : "10" } );
- helper.clearRefinements( "numeric1" );
- t.assert( isUndefined( helper.state.numericRefinements.numeric1 ) );
- t.doesNotThrow( function() {
- helper.clearRefinements( "numeric1" );
- } );
-
- t.end();
-} );
+ numeric: false,
+ disjunctiveFacet: false,
+ conjunctiveFacet: false,
+ exclude: false
+ }
+
+ helper.clearRefinements(function(value, key, type) {
+ checkType[type] = true
+
+ return key.indexOf('1') !== -1
+ })
+
+ t.equal(keys(checkType).length, 4, 'There should be only 4 refinements')
+ forEach(checkType, function(typeTest, type) { t.ok(typeTest, 'clear should go through: ' + type) })
+
+ t.deepEqual(helper.state.facetsRefinements, {facet2: ['0']})
+ t.deepEqual(helper.state.disjunctiveFacetsRefinements, {disjunctiveFacet2: ['0']})
+ t.deepEqual(helper.state.facetsExcludes, {excluded2: ['0']})
+ t.deepEqual(helper.state.numericRefinements, {numeric2: {'>=': 0, '<': 10}})
+
+ t.end()
+})
+
+test('Clearing twice the same attribute should be not problem', function(t) {
+ var helper = fixture()
+
+ t.deepEqual(helper.state.facetsRefinements.facet1, ['0'])
+ helper.clearRefinements('facet1')
+ t.assert(isUndefined(helper.state.facetsRefinements.facet1))
+ t.doesNotThrow(function() {
+ helper.clearRefinements('facet1')
+ })
+
+ t.deepEqual(helper.state.disjunctiveFacetsRefinements.disjunctiveFacet1, ['0'])
+ helper.clearRefinements('disjunctiveFacet1')
+ t.assert(isUndefined(helper.state.disjunctiveFacetsRefinements.disjunctiveFacet1))
+ t.doesNotThrow(function() {
+ helper.clearRefinements('disjunctiveFacet1')
+ })
+
+ t.deepEqual(helper.state.facetsExcludes.excluded1, ['0'])
+ helper.clearRefinements('excluded1')
+ t.assert(isUndefined(helper.state.facetsExcludes.excluded1))
+ t.doesNotThrow(function() {
+ helper.clearRefinements('excluded1')
+ })
+
+ t.deepEqual(helper.state.numericRefinements.numeric1, {'>=': '0', '<': '10'})
+ helper.clearRefinements('numeric1')
+ t.assert(isUndefined(helper.state.numericRefinements.numeric1))
+ t.doesNotThrow(function() {
+ helper.clearRefinements('numeric1')
+ })
+
+ t.end()
+})
diff --git a/test/spec/helper.distinct.js b/test/spec/helper.distinct.js
index 0a51481bb9..7dd796caa8 100644
--- a/test/spec/helper.distinct.js
+++ b/test/spec/helper.distinct.js
@@ -1,140 +1,146 @@
-"use strict";
-var test = require( "tape" );
-var forEach = require( "lodash/collection/forEach" );
-
-var algoliasearchHelper = require( "../../index.js" );
-
-test( "Distinct not set", function( t ) {
- var helper = algoliasearchHelper( null, null, {} );
- var state0 = helper.state;
-
- var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive] distinct should be false" );
-
- var facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits] distinct should be false" );
-
- helper.setState( state0 );
- helper.setQuery( "not empty" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, undefined, "[disjunctive][query not empty] distinct should be undefined" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, undefined, "[hits][query not empty] distinct should be undefined" );
- forEach( helper._getQueries(), function( q ) {
- t.notOk( q.hasOwnProperty( "distinct" ), "[hits][query not empty] no distinct should be in the queries by default" );
- } );
-
- helper.setState( state0 );
- helper.addDisjunctiveRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, undefined, "[disjunctive][disjunctive refinement] distinct should be undefined" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, undefined, "[hits][disjunctive refinement] distinct should be undefined" );
- forEach( helper._getQueries(), function( q ) {
- t.notOk( q.hasOwnProperty( "distinct" ), "[hits][disjunctive refinement] no distinct should be in the queries by default" );
- } );
-
- helper.setState( state0 );
- helper.addRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, undefined, "[disjunctive][conjunctive refinement] distinct should be undefined" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, undefined, "[hits][conjunctive refinement] distinct should be undefined" );
- forEach( helper._getQueries(), function( q ) {
- t.notOk( q.hasOwnProperty( "distinct" ), "[disjunctive][conjunctive refinement] no distinct should be in the queries by default" );
- } );
-
- helper.setState( state0 );
- helper.addNumericRefinement( "attribute", ">", "0" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, undefined, "[disjunctive][numeric refinement] distinct should be undefined" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, undefined, "[hits][numeric refinement] distinct should be undefined" );
- forEach( helper._getQueries(), function( q ) {
- t.notOk( q.hasOwnProperty( "distinct" ), "no distinct should be in the queries by default" );
- } );
-
- t.end();
-} );
-
-test( "Distinct set to true", function( t ) {
- var helper = algoliasearchHelper( null, null, {} ).setQueryParameter( "distinct", true );
- var state0 = helper.state;
-
- var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive] distinct should be false" );
-
- var facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits] distinct should be false" );
-
- helper.setState( state0 );
- helper.setQuery( "not empty" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, true, "[disjunctive][query not empty] distinct should be true" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, true, "[hits][query not empty] distinct should be true" );
-
- helper.setState( state0 );
- helper.addDisjunctiveRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, true, "[disjunctive][disjunctive refinement] distinct should be true" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, true, "[hits][disjunctive refinement] distinct should be true" );
-
- helper.setState( state0 );
- helper.addRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, true, "[disjunctive][conjunctive refinement] distinct should be true" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, true, "[hits][conjunctive refinement] distinct should be true" );
-
- helper.setState( state0 );
- helper.addNumericRefinement( "attribute", ">", "0" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, true, "[disjunctive][numeric refinement] distinct should be true" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, true, "[hits][numeric refinement] distinct should be true" );
-
- t.end();
-} );
-
-test( "Distinct to false", function( t ) {
- var helper = algoliasearchHelper( null, null, {} ).setQueryParameter( "distinct", false );
- var state0 = helper.state;
-
- var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive] distinct should be false" );
-
- var facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits] distinct should be false" );
-
- helper.setState( state0 );
- helper.setQuery( "not empty" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive][query not empty] distinct should be false" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits][query not empty] distinct should be false" );
-
- helper.setState( state0 );
- helper.addDisjunctiveRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive][disjunctive refinement] distinct should be false" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits][disjunctive refinement] distinct should be false" );
-
- helper.setState( state0 );
- helper.addRefine( "facet", "value" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive][conjunctive refinement] distinct should be false" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits][conjunctive refinement] distinct should be false" );
-
- helper.setState( state0 );
- helper.addNumericRefinement( "attribute", ">", "0" );
- disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams();
- t.equal( disjunctiveFacetSearchParam.distinct, false, "[disjunctive][numeric refinement] distinct should be false" );
- facetSearchParam = helper._getHitsSearchParams();
- t.equal( facetSearchParam.distinct, false, "[hits][numeric refinement] distinct should be false" );
-
- t.end();
-} );
+'use strict'
+var test = require('tape')
+var forEach = require('lodash/collection/forEach')
+
+var algoliasearchHelper = require('../../index.js')
+
+test('Distinct not set', function(t) {
+ var helper = algoliasearchHelper(null, null, {})
+ var state0 = helper.state
+
+ var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive] distinct should be false')
+
+ var facetSearchParam = helper._getHitsSearchParams()
+
+ t.equal(facetSearchParam.distinct, false, '[hits] distinct should be false')
+
+ helper.setState(state0)
+ helper.setQuery('not empty')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, undefined, '[disjunctive][query not empty] distinct should be undefined')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, undefined, '[hits][query not empty] distinct should be undefined')
+ forEach(helper._getQueries(), function(q) {
+ t.notOk(q.hasOwnProperty('distinct'), '[hits][query not empty] no distinct should be in the queries by default')
+ })
+
+ helper.setState(state0)
+ helper.addDisjunctiveRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, undefined, '[disjunctive][disjunctive refinement] distinct should be undefined')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, undefined, '[hits][disjunctive refinement] distinct should be undefined')
+ forEach(helper._getQueries(), function(q) {
+ t.notOk(q.hasOwnProperty('distinct'), '[hits][disjunctive refinement] no distinct should be in the queries by default')
+ })
+
+ helper.setState(state0)
+ helper.addRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, undefined, '[disjunctive][conjunctive refinement] distinct should be undefined')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, undefined, '[hits][conjunctive refinement] distinct should be undefined')
+ forEach(helper._getQueries(), function(q) {
+ t.notOk(q.hasOwnProperty('distinct'), '[disjunctive][conjunctive refinement] no distinct should be in the queries by default')
+ })
+
+ helper.setState(state0)
+ helper.addNumericRefinement('attribute', '>', '0')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, undefined, '[disjunctive][numeric refinement] distinct should be undefined')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, undefined, '[hits][numeric refinement] distinct should be undefined')
+ forEach(helper._getQueries(), function(q) {
+ t.notOk(q.hasOwnProperty('distinct'), 'no distinct should be in the queries by default')
+ })
+
+ t.end()
+})
+
+test('Distinct set to true', function(t) {
+ var helper = algoliasearchHelper(null, null, {}).setQueryParameter('distinct', true)
+ var state0 = helper.state
+
+ var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive] distinct should be false')
+
+ var facetSearchParam = helper._getHitsSearchParams()
+
+ t.equal(facetSearchParam.distinct, false, '[hits] distinct should be false')
+
+ helper.setState(state0)
+ helper.setQuery('not empty')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, true, '[disjunctive][query not empty] distinct should be true')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, true, '[hits][query not empty] distinct should be true')
+
+ helper.setState(state0)
+ helper.addDisjunctiveRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, true, '[disjunctive][disjunctive refinement] distinct should be true')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, true, '[hits][disjunctive refinement] distinct should be true')
+
+ helper.setState(state0)
+ helper.addRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, true, '[disjunctive][conjunctive refinement] distinct should be true')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, true, '[hits][conjunctive refinement] distinct should be true')
+
+ helper.setState(state0)
+ helper.addNumericRefinement('attribute', '>', '0')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, true, '[disjunctive][numeric refinement] distinct should be true')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, true, '[hits][numeric refinement] distinct should be true')
+
+ t.end()
+})
+
+test('Distinct to false', function(t) {
+ var helper = algoliasearchHelper(null, null, {}).setQueryParameter('distinct', false)
+ var state0 = helper.state
+
+ var disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive] distinct should be false')
+
+ var facetSearchParam = helper._getHitsSearchParams()
+
+ t.equal(facetSearchParam.distinct, false, '[hits] distinct should be false')
+
+ helper.setState(state0)
+ helper.setQuery('not empty')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive][query not empty] distinct should be false')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, false, '[hits][query not empty] distinct should be false')
+
+ helper.setState(state0)
+ helper.addDisjunctiveRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive][disjunctive refinement] distinct should be false')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, false, '[hits][disjunctive refinement] distinct should be false')
+
+ helper.setState(state0)
+ helper.addRefine('facet', 'value')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive][conjunctive refinement] distinct should be false')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, false, '[hits][conjunctive refinement] distinct should be false')
+
+ helper.setState(state0)
+ helper.addNumericRefinement('attribute', '>', '0')
+ disjunctiveFacetSearchParam = helper._getDisjunctiveFacetSearchParams()
+ t.equal(disjunctiveFacetSearchParam.distinct, false, '[disjunctive][numeric refinement] distinct should be false')
+ facetSearchParam = helper._getHitsSearchParams()
+ t.equal(facetSearchParam.distinct, false, '[hits][numeric refinement] distinct should be false')
+
+ t.end()
+})
diff --git a/test/spec/helper.events.js b/test/spec/helper.events.js
index 36ff026205..6c0d44d1e8 100644
--- a/test/spec/helper.events.js
+++ b/test/spec/helper.events.js
@@ -1,56 +1,58 @@
-"use strict";
-
-var test = require( "tape" );
-var sinon = require( "sinon" );
-var algoliaSearchHelper = require( "../../index" );
-
-test( "Change events should be emitted as soon as the state change, but search should be triggered (refactored)", function( t ) {
- var helper = algoliaSearchHelper( undefined, "Index", {
- disjunctiveFacets : ["city"],
- facets : ["tower"]
- } );
-
- var count = 0;
- helper.on( "change", function() {
- count++;
- } );
- var stubbedSearch = sinon.stub( helper, "_search" );
-
- helper.setQuery( "" );
- t.equal( count, 1, "search" );
- t.equal( stubbedSearch.callCount, 0, "search" );
-
- helper.clearRefinements();
- t.equal( count, 2, "clearRefinements" );
- t.equal( stubbedSearch.callCount, 0, "clearRefinements" );
-
- helper.addDisjunctiveRefine( "city", "Paris" );
- t.equal( count, 3, "addDisjunctiveRefine" );
- t.equal( stubbedSearch.callCount, 0, "addDisjunctiveRefine" );
-
- helper.removeDisjunctiveRefine( "city", "Paris" );
- t.equal( count, 4, "removeDisjunctiveRefine" );
- t.equal( stubbedSearch.callCount, 0, "removeDisjunctiveRefine" );
-
- helper.addExclude( "tower", "Empire State Building" );
- t.equal( count, 5, "addExclude" );
- t.equal( stubbedSearch.callCount, 0, "addExclude" );
-
- helper.removeExclude( "tower", "Empire State Building" );
- t.equal( count, 6, "removeExclude" );
- t.equal( stubbedSearch.callCount, 0, "removeExclude" );
-
- helper.addRefine( "tower", "Empire State Building" );
- t.equal( count, 7, "addRefine" );
- t.equal( stubbedSearch.callCount, 0, "addRefine" );
-
- helper.removeRefine( "tower", "Empire State Building" );
- t.equal( count, 8, "removeRefine" );
- t.equal( stubbedSearch.callCount, 0, "removeRefine" );
-
- helper.search();
- t.equal( count, 8, "final search doesn't call the change" );
- t.equal( stubbedSearch.callCount, 1, "final search triggers the search" );
-
- t.end();
-} );
+'use strict'
+
+var test = require('tape')
+var sinon = require('sinon')
+var algoliaSearchHelper = require('../../index')
+
+test('Change events should be emitted as soon as the state change, but search should be triggered (refactored)', function(t) {
+ var helper = algoliaSearchHelper(undefined, 'Index', {
+ disjunctiveFacets: ['city'],
+ facets: ['tower']
+ })
+
+ var count = 0
+
+ helper.on('change', function() {
+ count++
+ })
+
+ var stubbedSearch = sinon.stub(helper, '_search')
+
+ helper.setQuery('')
+ t.equal(count, 1, 'search')
+ t.equal(stubbedSearch.callCount, 0, 'search')
+
+ helper.clearRefinements()
+ t.equal(count, 2, 'clearRefinements')
+ t.equal(stubbedSearch.callCount, 0, 'clearRefinements')
+
+ helper.addDisjunctiveRefine('city', 'Paris')
+ t.equal(count, 3, 'addDisjunctiveRefine')
+ t.equal(stubbedSearch.callCount, 0, 'addDisjunctiveRefine')
+
+ helper.removeDisjunctiveRefine('city', 'Paris')
+ t.equal(count, 4, 'removeDisjunctiveRefine')
+ t.equal(stubbedSearch.callCount, 0, 'removeDisjunctiveRefine')
+
+ helper.addExclude('tower', 'Empire State Building')
+ t.equal(count, 5, 'addExclude')
+ t.equal(stubbedSearch.callCount, 0, 'addExclude')
+
+ helper.removeExclude('tower', 'Empire State Building')
+ t.equal(count, 6, 'removeExclude')
+ t.equal(stubbedSearch.callCount, 0, 'removeExclude')
+
+ helper.addRefine('tower', 'Empire State Building')
+ t.equal(count, 7, 'addRefine')
+ t.equal(stubbedSearch.callCount, 0, 'addRefine')
+
+ helper.removeRefine('tower', 'Empire State Building')
+ t.equal(count, 8, 'removeRefine')
+ t.equal(stubbedSearch.callCount, 0, 'removeRefine')
+
+ helper.search()
+ t.equal(count, 8, "final search doesn't call the change")
+ t.equal(stubbedSearch.callCount, 1, 'final search triggers the search')
+
+ t.end()
+})
diff --git a/test/spec/helper.excludes.js b/test/spec/helper.excludes.js
index 7ded31718a..41535b1f9f 100644
--- a/test/spec/helper.excludes.js
+++ b/test/spec/helper.excludes.js
@@ -1,54 +1,59 @@
-"use strict";
+'use strict'
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
-test( "addExclude should add an exclusion", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- helper._search = function() {};
- var facetName = "facet";
- var facetValueToExclude = "brand";
+test('addExclude should add an exclusion', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
- t.notOk( helper.state.facetsExcludes[ facetName ], "initialy empty" );
- helper.addExclude( facetName, facetValueToExclude );
- t.ok( helper.state.facetsExcludes[ facetName ], "not empty" );
- t.ok( helper.state.facetsExcludes[ facetName ][ 0 ] === facetValueToExclude, "with the correct value" );
+ helper._search = function() {}
- t.end();
-} );
+ var facetName = 'facet'
+ var facetValueToExclude = 'brand'
-test( "removeExclude should remove an exclusion", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- helper._search = function() {};
- var facetName = "facet";
- var facetValueToExclude = "brand";
+ t.notOk(helper.state.facetsExcludes[facetName], 'initialy empty')
+ helper.addExclude(facetName, facetValueToExclude)
+ t.ok(helper.state.facetsExcludes[facetName], 'not empty')
+ t.ok(helper.state.facetsExcludes[facetName][0] === facetValueToExclude, 'with the correct value')
- helper.addExclude( facetName, facetValueToExclude );
- t.ok( helper.state.facetsExcludes[ facetName ].length === 1, "not empty at first" );
- helper.removeExclude( facetName, facetValueToExclude );
- t.ok( !helper.state.facetsExcludes[ facetName ], "then empty" );
+ t.end()
+})
+
+test('removeExclude should remove an exclusion', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ helper._search = function() {}
+
+ var facetName = 'facet'
+ var facetValueToExclude = 'brand'
+
+ helper.addExclude(facetName, facetValueToExclude)
+ t.ok(helper.state.facetsExcludes[facetName].length === 1, 'not empty at first')
+ helper.removeExclude(facetName, facetValueToExclude)
+ t.ok(!helper.state.facetsExcludes[facetName], 'then empty')
try {
- helper.removeExclude( facetName, facetValueToExclude );
- }
- catch ( e ) {
- t.fail( "Removing unset exclusions should be ok..." );
+ helper.removeExclude(facetName, facetValueToExclude)
+ } catch (e) {
+ t.fail('Removing unset exclusions should be ok...')
}
- t.end();
-} );
+ t.end()
+})
+
+test('isExcluded should report exclusion correctly', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ helper._search = function() {}
-test( "isExcluded should report exclusion correctly", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- helper._search = function() {};
- var facetName = "facet";
- var facetValueToExclude = "brand";
+ var facetName = 'facet'
+ var facetValueToExclude = 'brand'
- t.notOk( helper.isExcluded( facetName, facetValueToExclude ), "value not exclude at first" );
- helper.addExclude( facetName, facetValueToExclude );
- t.ok( helper.isExcluded( facetName, facetValueToExclude ), "value is excluded" );
- helper.removeExclude( facetName, facetValueToExclude );
- t.notOk( helper.isExcluded( facetName, facetValueToExclude ), "value is not excluded anymore" );
+ t.notOk(helper.isExcluded(facetName, facetValueToExclude), 'value not exclude at first')
+ helper.addExclude(facetName, facetValueToExclude)
+ t.ok(helper.isExcluded(facetName, facetValueToExclude), 'value is excluded')
+ helper.removeExclude(facetName, facetValueToExclude)
+ t.notOk(helper.isExcluded(facetName, facetValueToExclude), 'value is not excluded anymore')
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/helper.facetFilters.js b/test/spec/helper.facetFilters.js
index edaa3e1fed..e68fb7b6a5 100644
--- a/test/spec/helper.facetFilters.js
+++ b/test/spec/helper.facetFilters.js
@@ -1,37 +1,37 @@
-//Make sure we do facet filters correctly before sending them to algolia
+// Make sure we do facet filters correctly before sending them to algolia
-"use strict";
+'use strict'
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
-test( "The filters should contain the different filters for a single conjunctive facet with multiple refinements",
- function( t ) {
- var facetName = "myFacet";
- var helper = algoliasearchHelper( "", "", {
- facets : [ facetName ]
- } );
+test('The filters should contain the different filters for a single conjunctive facet with multiple refinements',
+ function(t) {
+ var facetName = 'myFacet'
+ var helper = algoliasearchHelper('', '', {
+ facets: [facetName]
+ })
- helper.addRefine( facetName, "value1" );
- t.deepEqual( helper._getFacetFilters(),
- [ facetName + ":value1" ],
- "One value : one filter" );
- helper.addRefine( facetName, "value2" );
- t.deepEqual( helper._getFacetFilters(),
- [ facetName + ":value1", facetName + ":value2" ],
- "Two values : two filters" );
- helper.toggleRefine( facetName, "value3" );
- t.deepEqual( helper._getFacetFilters(),
- [ facetName + ":value1", facetName + ":value2", facetName + ":value3" ],
- "Three values : three filters" );
- helper.removeRefine( facetName, "value3" );
- t.deepEqual( helper._getFacetFilters(),
- [ facetName + ":value1", facetName + ":value2" ],
- "Three values : three filters" );
- helper.addRefine( facetName, "value1" );
- t.deepEqual( helper._getFacetFilters(),
- [ facetName + ":value1", facetName + ":value2"],
- "Add multiple times the same parameter : only two parameters" );
+ helper.addRefine(facetName, 'value1')
+ t.deepEqual(helper._getFacetFilters(),
+ [facetName + ':value1'],
+ 'One value: one filter')
+ helper.addRefine(facetName, 'value2')
+ t.deepEqual(helper._getFacetFilters(),
+ [facetName + ':value1', facetName + ':value2'],
+ 'Two values: two filters')
+ helper.toggleRefine(facetName, 'value3')
+ t.deepEqual(helper._getFacetFilters(),
+ [facetName + ':value1', facetName + ':value2', facetName + ':value3'],
+ 'Three values: three filters')
+ helper.removeRefine(facetName, 'value3')
+ t.deepEqual(helper._getFacetFilters(),
+ [facetName + ':value1', facetName + ':value2'],
+ 'Three values: three filters')
+ helper.addRefine(facetName, 'value1')
+ t.deepEqual(helper._getFacetFilters(),
+ [facetName + ':value1', facetName + ':value2'],
+ 'Add multiple times the same parameter: only two parameters')
- t.end();
-} );
+ t.end()
+ })
diff --git a/test/spec/helper.getQueryParameter.js b/test/spec/helper.getQueryParameter.js
index f556aac358..437d6feb0c 100644
--- a/test/spec/helper.getQueryParameter.js
+++ b/test/spec/helper.getQueryParameter.js
@@ -1,21 +1,21 @@
-"use strict";
-var test = require( "tape" );
-var algoliaSearchHelper = require( "../../index.js" );
+'use strict'
+var test = require('tape')
+var algoliaSearchHelper = require('../../index.js')
-test( "getQueryParameter", function( t ) {
- var partial = require( "lodash/function/partial" );
+test('getQueryParameter', function(t) {
+ var partial = require('lodash/function/partial')
- var helper = algoliaSearchHelper( null, null, {
- facets : [ "facet1" ],
- minWordSizefor1Typo : 8,
- ignorePlurals : true
- } );
+ var helper = algoliaSearchHelper(null, null, {
+ facets: ['facet1'],
+ minWordSizefor1Typo: 8,
+ ignorePlurals: true
+ })
- t.deepEqual( helper.getQueryParameter( "facets" ), [ "facet1" ] );
- t.equal( helper.getQueryParameter( "minWordSizefor1Typo" ), 8 );
- t.equal( helper.getQueryParameter( "ignorePlurals" ), true );
+ t.deepEqual(helper.getQueryParameter('facets'), ['facet1'])
+ t.equal(helper.getQueryParameter('minWordSizefor1Typo'), 8)
+ t.equal(helper.getQueryParameter('ignorePlurals'), true)
- t.throws( partial( helper.getQueryParameter, "unknown" ) );
+ t.throws(partial(helper.getQueryParameter, 'unknown'))
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/helper.numericFilters.js b/test/spec/helper.numericFilters.js
index b932316538..cfe7663c23 100644
--- a/test/spec/helper.numericFilters.js
+++ b/test/spec/helper.numericFilters.js
@@ -1,64 +1,70 @@
-"use strict";
-var test = require( "tape" );
-var algoliaSearch = require( "algoliasearch" );
-var algoliasearchHelper = require( "../../index" );
-
-test( "Numeric filters : numeric filters from constructor", function( t ) {
- var client = algoliaSearch( "dsf", "dsfdf" );
- client.search = function( queries ) {
- var ps = queries[0].params;
- t.equals( ps.numericFilters[ 0 ], "attribute1>3" );
- t.equals( ps.numericFilters[ 1 ], "attribute1<=100" );
- t.equals( ps.numericFilters[ 2 ], "attribute2=42" );
- t.end();
- };
-
- var helper = algoliasearchHelper( client, "index", {
- numericRefinements : {
- "attribute1" : {
- ">" : 3,
- "<=" : 100
+'use strict'
+var test = require('tape')
+var algoliaSearch = require('algoliasearch')
+var algoliasearchHelper = require('../../index')
+
+test('Numeric filters: numeric filters from constructor', function(t) {
+ var client = algoliaSearch('dsf', 'dsfdf')
+
+ client.search = function(queries) {
+ var ps = queries[0].params
+
+ t.equals(ps.numericFilters[0], 'attribute1>3')
+ t.equals(ps.numericFilters[1], 'attribute1<=100')
+ t.equals(ps.numericFilters[2], 'attribute2=42')
+ t.end()
+ }
+
+ var helper = algoliasearchHelper(client, 'index', {
+ numericRefinements: {
+ attribute1: {
+ '>': 3,
+ '<=': 100
},
- "attribute2" : {
- "=" : 42
+ attribute2: {
+ '=': 42
}
}
- } );
- helper.search();
-} );
-
-test( "Numeric filters : numeric filters from setters", function( t ) {
- var client = algoliaSearch( "dsf", "dsfdf" );
- client.search = function( queries ) {
- var ps = queries[0].params;
- t.equals( ps.numericFilters[ 0 ], "badassAttribute>9000" );
- t.equals( ps.numericFilters[ 1 ], "attribute2!=7" );
- t.end();
- };
-
- var helper = algoliasearchHelper( client, "index" );
- helper.addNumericRefinement( "badassAttribute", ">", 9000, true );
- helper.addNumericRefinement( "attribute2", "!=", "7", true );
-
- helper.search();
-} );
-
-test( "Should be able to remove a value if it equals 0", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
-
- helper.addNumericRefinement( "attribute", ">", 0 );
- t.equal( helper.state.numericRefinements.attribute[ ">" ], 0, "should be set to 0 initially" );
- helper.removeNumericRefinement( "attribute", ">", 0 );
- t.equal( helper.state.numericRefinements.attribute, undefined, "should set to undefined" );
- t.end();
-} );
-
-test( "Should be able to get if an attribute has numeric filter with hasRefinements", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
-
- t.notOk( helper.hasRefinements( "attribute" ), "not refined initially" );
- helper.addNumericRefinement( "attribute", "=", 42 );
- t.ok( helper.hasRefinements( "attribute" ), "should be refined" );
-
- t.end();
-} );
+ })
+
+ helper.search()
+})
+
+test('Numeric filters: numeric filters from setters', function(t) {
+ var client = algoliaSearch('dsf', 'dsfdf')
+
+ client.search = function(queries) {
+ var ps = queries[0].params
+
+ t.equals(ps.numericFilters[0], 'badassAttribute>9000')
+ t.equals(ps.numericFilters[1], 'attribute2!=7')
+ t.end()
+ }
+
+ var helper = algoliasearchHelper(client, 'index')
+
+ helper.addNumericRefinement('badassAttribute', '>', 9000, true)
+ helper.addNumericRefinement('attribute2', '!=', '7', true)
+
+ helper.search()
+})
+
+test('Should be able to remove a value if it equals 0', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ helper.addNumericRefinement('attribute', '>', 0)
+ t.equal(helper.state.numericRefinements.attribute['>'], 0, 'should be set to 0 initially')
+ helper.removeNumericRefinement('attribute', '>', 0)
+ t.equal(helper.state.numericRefinements.attribute, undefined, 'should set to undefined')
+ t.end()
+})
+
+test('Should be able to get if an attribute has numeric filter with hasRefinements', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ t.notOk(helper.hasRefinements('attribute'), 'not refined initially')
+ helper.addNumericRefinement('attribute', '=', 42)
+ t.ok(helper.hasRefinements('attribute'), 'should be refined')
+
+ t.end()
+})
diff --git a/test/spec/helper.pages.js b/test/spec/helper.pages.js
index a076c60d32..c51bd19f54 100644
--- a/test/spec/helper.pages.js
+++ b/test/spec/helper.pages.js
@@ -1,72 +1,72 @@
-"use strict";
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
-
-test( "setChange should change the current page", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
-
- t.ok( helper.getCurrentPage() === 0, "First page should be 0" );
- helper.setCurrentPage( 3 );
- t.ok( helper.getCurrentPage() === 3, "If page was changed to 3, getCurrentPage should return 3" );
- t.end();
-} );
-
-test( "nextPage should increment the page by one", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
-
- t.ok( helper.getCurrentPage() === 0, "First page should be 0" );
- helper.nextPage();
- helper.nextPage();
- helper.nextPage();
- t.ok( helper.getCurrentPage() === 3, "If page was increment 3 times, getCurrentPage should return 3" );
- t.end();
-} );
-
-test( "previousPage should decrement the current page by one", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
-
- t.ok( helper.getCurrentPage() === 0, "First page should be 0" );
- helper.setCurrentPage( 3 );
- t.ok( helper.getCurrentPage() === 3, "If page was changed to 3, getCurrentPage should return 3" );
- helper.previousPage();
- t.ok( helper.getCurrentPage() === 2, "must be 2 now" );
- t.end();
-} );
-
-test( "pages should be reset if the mutation might change the number of pages", function( t ) {
- var bindAll = require( "lodash/function/bindAll" );
- var partial = require( "lodash/function/partial" );
-
- var helper = algoliasearchHelper( "", "", {
- facets : [ "facet1", "f2" ],
- disjunctiveFacets : [ "f1" ]
- } );
-
- bindAll(helper);
-
- var testMutation = function( tester, text, testFn ) {
- helper.setCurrentPage( 10 );
- t.equal( helper.getCurrentPage(), 10, "set the current page to 10" + text );
- testFn();
- t.equal( helper.getCurrentPage(), 0, "page resetted" + text );
- };
-
- testMutation( t, " clearRefinements", helper.clearRefinements );
- testMutation( t, " setQuery", partial( helper.setQuery, "query" ) );
- testMutation( t, " addNumericRefinement", partial( helper.addNumericRefinement, "facet", ">", "2" ) );
- testMutation( t, " removeNumericRefinement", partial( helper.removeNumericRefinement, "facet", ">" ) );
-
- testMutation( t, " addExclude", partial( helper.addExclude, "facet1", "val2" ) );
- testMutation( t, " removeExclude", partial( helper.removeExclude, "facet1", "val2" ) );
-
- testMutation( t, " addRefine", partial( helper.addRefine, "f1", "val" ) );
- testMutation( t, " removeRefine", partial( helper.removeRefine, "f1", "val" ) );
-
- testMutation( t, " addDisjunctiveRefine", partial( helper.addDisjunctiveRefine, "f2", "val" ) );
- testMutation( t, " removeDisjunctiveRefine", partial( helper.removeDisjunctiveRefine, "f2", "val" ) );
-
- testMutation( t, " toggleRefine", partial( helper.toggleRefine, "f1", "v1" ) );
- testMutation( t, " toggleExclude", partial( helper.toggleExclude, "facet1", "55" ) );
-
- t.end();
-} );
+'use strict'
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
+
+test('setChange should change the current page', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ t.ok(helper.getCurrentPage() === 0, 'First page should be 0')
+ helper.setCurrentPage(3)
+ t.ok(helper.getCurrentPage() === 3, 'If page was changed to 3, getCurrentPage should return 3')
+ t.end()
+})
+
+test('nextPage should increment the page by one', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ t.ok(helper.getCurrentPage() === 0, 'First page should be 0')
+ helper.nextPage()
+ helper.nextPage()
+ helper.nextPage()
+ t.ok(helper.getCurrentPage() === 3, 'If page was increment 3 times, getCurrentPage should return 3')
+ t.end()
+})
+
+test('previousPage should decrement the current page by one', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ t.ok(helper.getCurrentPage() === 0, 'First page should be 0')
+ helper.setCurrentPage(3)
+ t.ok(helper.getCurrentPage() === 3, 'If page was changed to 3, getCurrentPage should return 3')
+ helper.previousPage()
+ t.ok(helper.getCurrentPage() === 2, 'must be 2 now')
+ t.end()
+})
+
+test('pages should be reset if the mutation might change the number of pages', function(t) {
+ var bindAll = require('lodash/function/bindAll')
+ var partial = require('lodash/function/partial')
+
+ var helper = algoliasearchHelper('', '', {
+ facets: ['facet1', 'f2'],
+ disjunctiveFacets: ['f1']
+ })
+
+ bindAll(helper)
+
+ var testMutation = function(tester, text, testFn) {
+ helper.setCurrentPage(10)
+ t.equal(helper.getCurrentPage(), 10, 'set the current page to 10' + text)
+ testFn()
+ t.equal(helper.getCurrentPage(), 0, 'page resetted' + text)
+ }
+
+ testMutation(t, ' clearRefinements', helper.clearRefinements)
+ testMutation(t, ' setQuery', partial(helper.setQuery, 'query'))
+ testMutation(t, ' addNumericRefinement', partial(helper.addNumericRefinement, 'facet', '>', '2'))
+ testMutation(t, ' removeNumericRefinement', partial(helper.removeNumericRefinement, 'facet', '>'))
+
+ testMutation(t, ' addExclude', partial(helper.addExclude, 'facet1', 'val2'))
+ testMutation(t, ' removeExclude', partial(helper.removeExclude, 'facet1', 'val2'))
+
+ testMutation(t, ' addRefine', partial(helper.addRefine, 'f1', 'val'))
+ testMutation(t, ' removeRefine', partial(helper.removeRefine, 'f1', 'val'))
+
+ testMutation(t, ' addDisjunctiveRefine', partial(helper.addDisjunctiveRefine, 'f2', 'val'))
+ testMutation(t, ' removeDisjunctiveRefine', partial(helper.removeDisjunctiveRefine, 'f2', 'val'))
+
+ testMutation(t, ' toggleRefine', partial(helper.toggleRefine, 'f1', 'v1'))
+ testMutation(t, ' toggleExclude', partial(helper.toggleExclude, 'facet1', '55'))
+
+ t.end()
+})
diff --git a/test/spec/helper.queryID.js b/test/spec/helper.queryID.js
index bb5ab0d0dd..f813cca8b2 100644
--- a/test/spec/helper.queryID.js
+++ b/test/spec/helper.queryID.js
@@ -1,43 +1,46 @@
-"use strict";
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
+'use strict'
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
-test( "the queryid should keep increasing when new requests arrives", function( t ) {
- var initialQueryID;
+test('the queryid should keep increasing when new requests arrives', function(t) {
+ var initialQueryID
var client = {
- search : function() {
- initialQueryID++;
+ search: function() {
+ initialQueryID++
}
- };
- var helper = algoliasearchHelper( client, null, {} );
- initialQueryID = helper._queryId;
+ }
+ var helper = algoliasearchHelper(client, null, {})
- helper.search().search().search().search().search();
+ initialQueryID = helper._queryId
- t.equal( helper._queryId, initialQueryID, "the _queryID should have increased of the number of calls" );
+ helper.search().search().search().search().search()
- t.end();
-} );
+ t.equal(helper._queryId, initialQueryID, 'the _queryID should have increased of the number of calls')
-test( "the response handler should check that the query is not outdated", function( t ) {
- var testData = require( "./search.testdata" );
- var shouldTriggerResult = true;
- var callCount = 0;
+ t.end()
+})
- var helper = algoliasearchHelper( null, null, {} );
- helper.on( "result", function() {
- callCount++;
- if( !shouldTriggerResult ) {
- t.fail( "The id was outdated" );
+test('the response handler should check that the query is not outdated', function(t) {
+ var testData = require('./search.testdata')
+ var shouldTriggerResult = true
+ var callCount = 0
+
+ var helper = algoliasearchHelper(null, null, {})
+
+ helper.on('result', function() {
+ callCount++
+
+ if (!shouldTriggerResult) {
+ t.fail('The id was outdated')
}
- } );
+ })
- helper._handleResponse( helper.state, helper._lastQueryIdReceived + 1, null, testData.response );
- helper._handleResponse( helper.state, helper._lastQueryIdReceived + 10, null, testData.response );
- t.equal( callCount, 2, "the callback should have been called twice" );
- shouldTriggerResult = false;
- helper._handleResponse( helper.state, helper._lastQueryIdReceived - 1, null, testData.response );
- t.equal( callCount, 2, "and shouldn't have been called if outdated" );
+ helper._handleResponse(helper.state, helper._lastQueryIdReceived + 1, null, testData.response)
+ helper._handleResponse(helper.state, helper._lastQueryIdReceived + 10, null, testData.response)
+ t.equal(callCount, 2, 'the callback should have been called twice')
+ shouldTriggerResult = false
+ helper._handleResponse(helper.state, helper._lastQueryIdReceived - 1, null, testData.response)
+ t.equal(callCount, 2, "and shouldn't have been called if outdated")
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/helper.setQueryParameter.js b/test/spec/helper.setQueryParameter.js
index d8937d3c65..42fdb4a07b 100644
--- a/test/spec/helper.setQueryParameter.js
+++ b/test/spec/helper.setQueryParameter.js
@@ -1,39 +1,39 @@
-"use strict";
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
-
-test( "setChange should change the current state", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- var changed = false;
-
- helper.on( "change", function() {
- changed = true;
- } );
-
- t.equal( helper.getCurrentPage(), 0, "Initially page is 0" );
- t.notOk( changed, "No changes called yet" );
- helper.setQueryParameter( "page", 22 );
- t.equal( helper.getCurrentPage(), 22, "After setting the page is 22" );
- t.ok( changed, "Change event should have been triggered" );
-
- t.end();
-} );
-
-test( "setChange should not change the current state : no real modification", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- var changed = false;
- var initialState = helper.state;
-
- helper.on( "change", function() {
- changed = true;
- } );
-
- t.equal( helper.getCurrentPage(), 0, "Initially page is 0" );
- t.notOk( changed, "No changes called yet" );
- helper.setQueryParameter( "page", 0 );
- t.equal( helper.getCurrentPage(), 0, "After setting the page is 0" );
- t.notOk( changed, "Change event should not have been triggered" );
- t.equal( helper.state, initialState, "The state instance should remain the same" );
-
- t.end();
-} );
+'use strict'
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
+
+test('setChange should change the current state', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+ var changed = false
+
+ helper.on('change', function() {
+ changed = true
+ })
+
+ t.equal(helper.getCurrentPage(), 0, 'Initially page is 0')
+ t.notOk(changed, 'No changes called yet')
+ helper.setQueryParameter('page', 22)
+ t.equal(helper.getCurrentPage(), 22, 'After setting the page is 22')
+ t.ok(changed, 'Change event should have been triggered')
+
+ t.end()
+})
+
+test('setChange should not change the current state: no real modification', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+ var changed = false
+ var initialState = helper.state
+
+ helper.on('change', function() {
+ changed = true
+ })
+
+ t.equal(helper.getCurrentPage(), 0, 'Initially page is 0')
+ t.notOk(changed, 'No changes called yet')
+ helper.setQueryParameter('page', 0)
+ t.equal(helper.getCurrentPage(), 0, 'After setting the page is 0')
+ t.notOk(changed, 'Change event should not have been triggered')
+ t.equal(helper.state, initialState, 'The state instance should remain the same')
+
+ t.end()
+})
diff --git a/test/spec/helper.tags.js b/test/spec/helper.tags.js
index 6954e91a9a..7455eefa45 100644
--- a/test/spec/helper.tags.js
+++ b/test/spec/helper.tags.js
@@ -1,53 +1,54 @@
-"use strict";
-var test = require( "tape" );
-var algoliasearchHelper = require( "../../index" );
+'use strict'
+var test = require('tape')
+var algoliasearchHelper = require('../../index')
-test( "Tag filters : operations on tags list", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
- helper.addTag( "tag" ).addTag( "tag2" );
- t.deepEqual( helper.getTags(), [ "tag", "tag2" ], "should be [ tag, tag2 ]" );
- helper.removeTag( "tag" );
- t.deepEqual( helper.getTags(), [ "tag2" ], "should be [ tag2 ]" );
- helper.toggleTag( "tag3" ).toggleTag( "tag2" ).toggleTag( "tag4" );
- t.deepEqual( helper.getTags(), [ "tag3", "tag4" ], "should be [ tag3, tag4 ]" );
- t.end();
-} );
+test('Tag filters: operations on tags list', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
-test( "Tags filters : advanced query", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
+ helper.addTag('tag').addTag('tag2')
+ t.deepEqual(helper.getTags(), ['tag', 'tag2'], 'should be [ tag, tag2 ]')
+ helper.removeTag('tag')
+ t.deepEqual(helper.getTags(), ['tag2'], 'should be [ tag2 ]')
+ helper.toggleTag('tag3').toggleTag('tag2').toggleTag('tag4')
+ t.deepEqual(helper.getTags(), ['tag3', 'tag4'], 'should be [ tag3, tag4 ]')
+ t.end()
+})
- var complexQuery = "( sea, city ), romantic, -mountain";
- helper.setQueryParameter( "tagFilters", complexQuery );
+test('Tags filters: advanced query', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
- t.deepEqual( helper._getTagFilters(), complexQuery, "The complex query should be equal to the user input" );
+ var complexQuery = '(sea, city), romantic, -mountain'
- t.end();
-} );
+ helper.setQueryParameter('tagFilters', complexQuery)
-test( "Tags filters : switching between advanced and simple API should be forbidden without clearing the refinements first", function( t ) {
- var helper = algoliasearchHelper( null, null, null );
+ t.deepEqual(helper._getTagFilters(), complexQuery, 'The complex query should be equal to the user input')
- helper.addTag( "tag" ).addTag( "tag2" );
- t.deepEqual( helper._getTagFilters(), "tag,tag2", "should be [ tag, tag2 ]" );
+ t.end()
+})
+
+test('Tags filters: switching between advanced and simple API should be forbidden without clearing the refinements first', function(t) {
+ var helper = algoliasearchHelper(null, null, null)
+
+ helper.addTag('tag').addTag('tag2')
+ t.deepEqual(helper._getTagFilters(), 'tag,tag2', 'should be [ tag, tag2 ]')
+
+ var complexQuery = '(sea, city), romantic, -mountain'
- var complexQuery = "( sea, city ), romantic, -mountain";
try {
- helper.setQueryParameter( "tagFilters", complexQuery );
- t.fail( "Can't switch directly from the advanced API to the managed API" );
- }
- catch( e0 ) {
- helper.clearTags().setQueryParameter( "tagFilters", complexQuery );
- t.deepEqual( helper._getTagFilters(), complexQuery, "The complex should override the simple mode if cleared before" );
+ helper.setQueryParameter('tagFilters', complexQuery)
+ t.fail("Can't switch directly from the advanced API to the managed API")
+ } catch (e0) {
+ helper.clearTags().setQueryParameter('tagFilters', complexQuery)
+ t.deepEqual(helper._getTagFilters(), complexQuery, 'The complex should override the simple mode if cleared before')
try {
- helper.addTag( "tag" ).addTag( "tag2" );
- t.fail( "Can't switch directly from the managed API to the advanced API" );
- }
- catch( e1 ) {
- helper.setQueryParameter( "tagFilters", undefined ).addTag( "tag" ).addTag( "tag2" );
- t.deepEqual( helper._getTagFilters(), "tag,tag2", "should be [ tag, tag2 ]" );
+ helper.addTag('tag').addTag('tag2')
+ t.fail("Can't switch directly from the managed API to the advanced API")
+ } catch (e1) {
+ helper.setQueryParameter('tagFilters', undefined).addTag('tag').addTag('tag2')
+ t.deepEqual(helper._getTagFilters(), 'tag,tag2', 'should be [ tag, tag2 ]')
- t.end();
+ t.end()
}
}
-} );
+})
diff --git a/test/spec/refinements.js b/test/spec/refinements.js
index fc80949ca0..798b1c5cee 100644
--- a/test/spec/refinements.js
+++ b/test/spec/refinements.js
@@ -1,252 +1,254 @@
-"use strict";
-var test = require( "tape" );
-var _ = require( "lodash" );
-var algoliasearchHelper = require( "../../index" );
-
-
-test( "Adding refinments should add an entry to the refinments attribute", function( t ) {
- var helper = algoliasearchHelper( {}, "index", {} );
-
- var facetName = "facet1";
- var facetValue = "42";
-
- t.ok( _.isEmpty( helper.state.facetsRefinements ), "should be empty at first" );
- helper.addRefine( facetName, facetValue );
- t.ok( _.size( helper.state.facetsRefinements ) === 1, "when adding a refinment, should have one" );
- t.deepEqual( helper.state.facetsRefinements.facet1, [ facetValue ] );
- helper.addRefine( facetName, facetValue );
- t.ok( _.size( helper.state.facetsRefinements ) === 1, "when adding the same, should still be one" );
- helper.removeRefine( facetName, facetValue );
- t.ok( _.size( helper.state.facetsRefinements ) === 0, "Then empty " );
- t.end();
-} );
-
-test( "Adding several refinements for a single attribute should be handled", function( t ) {
- var facetName = "facet";
-
- var helper = algoliasearchHelper( null, null, {
- facets : [ facetName ]
- } );
-
- t.ok( _.isEmpty( helper.state.facetsRefinements ), "empty" );
- helper.addRefine( facetName, "value1" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 1, "Adding one refinement, should have one" );
- helper.addRefine( facetName, "value2" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 2, "Adding another refinement, should have two" );
- helper.addRefine( facetName, "value1" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 2, "Adding same refinement as the first, should have two" );
-
- t.end();
-} );
-
-test( "Toggling several refinements for a single attribute should be handled", function( t ) {
- var facetName = "facet";
-
- var helper = algoliasearchHelper( null, null, {
- facets : [ facetName ]
- } );
-
- t.ok( _.isEmpty( helper.state.facetsRefinements ), "empty" );
- helper.toggleRefine( facetName, "value1" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 1, "Adding one refinement, should have one" );
- helper.toggleRefine( facetName, "value2" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 2, "Adding another refinement, should have two" );
- helper.toggleRefine( facetName, "value1" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 1, "Adding same refinement as the first, should have two" );
- t.deepEqual( helper.state.facetsRefinements[ facetName ], [ "value2" ], "should contain value2" );
-
- t.end();
-} );
-
-test( "Removing several refinements for a single attribute should be handled", function( t ) {
- var facetName = "facet";
-
- var helper = algoliasearchHelper( null, null, {
- facets : [ facetName ]
- } );
-
- t.ok( _.isEmpty( helper.state.facetsRefinements ), "empty" );
- helper.addRefine( facetName, "value1" );
- helper.addRefine( facetName, "value2" );
- helper.addRefine( facetName, "value3" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 3, "Adding another refinement, should have two" );
- helper.removeRefine( facetName, "value2" );
- t.ok( _.size( helper.state.facetsRefinements[ facetName ] ) === 2, "Adding same refinement as the first, should have two" );
- t.deepEqual( helper.state.facetsRefinements[ facetName ], [ "value1", "value3" ], "should contain value1 and value3" );
-
- t.end();
-} );
-
-test( "isDisjunctiveRefined", function( t ) {
- var helper = algoliasearchHelper( null, null, {} );
-
- var facet = "MyFacet";
- var value = "MyValue";
-
- t.notOk( helper.isDisjunctiveRefined( facet, value ),
- "isDisjunctiveRefined should not return true for undefined refinement" );
- helper.addDisjunctiveRefine( facet, value );
- t.ok( helper.isDisjunctiveRefined( facet, value ),
- "isDisjunctiveRefined should not return false for defined refinement" );
- helper.removeDisjunctiveRefine( facet, value );
- t.notOk( helper.isDisjunctiveRefined( facet, value ),
- "isDisjunctiveRefined should not return true for removed refinement" );
- t.end();
-} );
-
-test( "IsRefined should return true if the ( facet, value ) is refined.", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ]
- } );
-
- helper.addRefine( "facet1", "boom" );
-
- t.ok( helper.isRefined( "facet1", "boom" ), "the facet + value is refined >> true" );
-
- t.notOk( helper.isRefined( "facet1", "booohh" ), "value not refined but is a facet" );
- t.notOk( helper.isRefined( "notAFacet", "maoooh" ), "not refined because it's not a facet" );
- t.notOk( helper.isRefined( null, null ), "not even valid values" );
-
- t.end();
-} );
-
-test( "isRefined(facet)/hasRefinements should return true if the facet is refined.", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ]
- } );
-
- t.notOk( helper.isRefined( "facet1" ), "the facet is not refined yet >> false" );
- t.notOk( helper.hasRefinements( "facet1" ), "the facet is not refined yet >> false" );
-
- helper.addRefine( "facet1", "boom" );
-
- t.ok( helper.isRefined( "facet1" ), "the facet is refined >> true" );
- t.ok( helper.hasRefinements( "facet1" ), "the facet is refined >> true" );
-
- t.notOk( helper.isRefined( "notAFacet" ), "not a facet" );
- t.notOk( helper.hasRefinements( "notAFacet" ), "not a facet" );
- t.notOk( helper.isRefined( null ), "not even valid values" );
- t.notOk( helper.hasRefinements( null ), "not even valid values" );
-
- t.end();
-} );
-
-test( "getRefinements should return all the refinements for a given facet", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ],
- disjunctiveFacets : [ "facet2", "sales" ]
- } );
-
- helper.addRefine( "facet1", "val1" )
- .addRefine( "facet1", "val2" )
- .addExclude( "facet1", "val-1" )
- .toggleRefine( "facet1", "val3" );
-
- helper.addDisjunctiveRefine( "facet2", "val4" )
- .addDisjunctiveRefine( "facet2", "val5" )
- .toggleRefine( "facet2", "val6" );
-
- helper.addNumericRefinement( "sales", ">", "3" )
- .addNumericRefinement( "sales", "<", "9" );
-
- t.deepEqual( helper.getRefinements( "facet1" ),
- [
- { value : "val1", type : "conjunctive" },
- { value : "val2", type : "conjunctive" },
- { value : "val3", type : "conjunctive" },
- { value : "val-1", type : "exclude" }
- ],
- "" );
-
- t.deepEqual( helper.getRefinements( "facet2" ),
- [
- { value : "val4", type : "disjunctive" },
- { value : "val5", type : "disjunctive" },
- { value : "val6", type : "disjunctive" }
- ],
- "" );
-
- t.deepEqual( helper.getRefinements( "sales" ),
- [
- { value : "3", operator : ">", type : "numeric" },
- { value : "9", operator : "<", type : "numeric" }
- ],
- "" );
-
- t.end();
-} );
-
-test( "getRefinements should return an empty array if the facet has no refinement", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ],
- disjunctiveFacets : [ "facet2" ]
- } );
-
- t.deepEqual( helper.getRefinements( "facet1" ), [], "" );
- t.deepEqual( helper.getRefinements( "facet2" ), [], "" );
-
- t.end();
-} );
-
-test( "[Conjunctive] Facets should be resilient to user attempt to use numbers", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ],
- disjunctiveFacets : [ "facet2" ]
- } );
-
- helper.addRefine( "facet1", 42 );
- t.ok( helper.isRefined( "facet1", 42 ), "[facet][number] should be refined" );
- t.ok( helper.isRefined( "facet1", "42" ), "[facet][string] should be refined" );
-
- var stateWithFacet1and42 = helper.state;
- helper.removeRefine( "facet1", "42" );
- t.notOk( helper.isRefined( "facet1", "42" ), "[facet][string] should not be refined" );
-
- helper.setState( stateWithFacet1and42 );
- helper.removeRefine( "facet1", 42 );
- t.notOk( helper.isRefined( "facet1", 42 ), "[facet][number] should not be refined" );
-
- t.end();
-} );
-
-test( "[Disjunctive] Facets should be resilient to user attempt to use numbers", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ],
- disjunctiveFacets : [ "facet2" ]
- } );
-
- helper.addExclude( "facet1", 42 );
- t.ok( helper.isExcluded( "facet1", 42 ), "[facet][number] should be refined" );
- t.ok( helper.isExcluded( "facet1", "42" ), "[facet][string] should be refined" );
-
- var stateWithFacet1Without42 = helper.state;
- helper.removeExclude( "facet1", "42" );
- t.notOk( helper.isExcluded( "facet1", "42" ), "[facet][string] should not be refined" );
-
- helper.setState( stateWithFacet1Without42 );
- helper.removeExclude( "facet1", 42 );
- t.notOk( helper.isExcluded( "facet1", 42 ), "[facet][number] should not be refined" );
-
- t.end();
-} );
-
-test( "[Disjunctive] Facets should be resilient to user attempt to use numbers", function( t ) {
- var helper = algoliasearchHelper( null, null, {
- facets : [ "facet1" ],
- disjunctiveFacets : [ "facet2" ]
- } );
-
- helper.addDisjunctiveRefine( "facet2", 42 );
- t.ok( helper.isDisjunctiveRefined( "facet2", 42 ), "[facet][number] should be refined" );
- t.ok( helper.isDisjunctiveRefined( "facet2", "42" ), "[facet][string] should be refined" );
-
- var stateWithFacet2and42 = helper.state;
- helper.removeDisjunctiveRefine( "facet2", "42" );
- t.notOk( helper.isDisjunctiveRefined( "facet2", "42" ), "[facet][string] should not be refined" );
- helper.setState( stateWithFacet2and42 );
-
- helper.removeDisjunctiveRefine( "facet2", 42 );
- t.notOk( helper.isDisjunctiveRefined( "facet2", 42 ), "[facet][number] should not be refined" );
-
- t.end();
-} );
+'use strict'
+var test = require('tape')
+var _ = require('lodash')
+var algoliasearchHelper = require('../../index')
+
+test('Adding refinments should add an entry to the refinments attribute', function(t) {
+ var helper = algoliasearchHelper({}, 'index', {})
+
+ var facetName = 'facet1'
+ var facetValue = '42'
+
+ t.ok(_.isEmpty(helper.state.facetsRefinements), 'should be empty at first')
+ helper.addRefine(facetName, facetValue)
+ t.ok(_.size(helper.state.facetsRefinements) === 1, 'when adding a refinment, should have one')
+ t.deepEqual(helper.state.facetsRefinements.facet1, [facetValue])
+ helper.addRefine(facetName, facetValue)
+ t.ok(_.size(helper.state.facetsRefinements) === 1, 'when adding the same, should still be one')
+ helper.removeRefine(facetName, facetValue)
+ t.ok(_.size(helper.state.facetsRefinements) === 0, 'Then empty ')
+ t.end()
+})
+
+test('Adding several refinements for a single attribute should be handled', function(t) {
+ var facetName = 'facet'
+
+ var helper = algoliasearchHelper(null, null, {
+ facets: [facetName]
+ })
+
+ t.ok(_.isEmpty(helper.state.facetsRefinements), 'empty')
+ helper.addRefine(facetName, 'value1')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 1, 'Adding one refinement, should have one')
+ helper.addRefine(facetName, 'value2')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 2, 'Adding another refinement, should have two')
+ helper.addRefine(facetName, 'value1')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 2, 'Adding same refinement as the first, should have two')
+
+ t.end()
+})
+
+test('Toggling several refinements for a single attribute should be handled', function(t) {
+ var facetName = 'facet'
+
+ var helper = algoliasearchHelper(null, null, {
+ facets: [facetName]
+ })
+
+ t.ok(_.isEmpty(helper.state.facetsRefinements), 'empty')
+ helper.toggleRefine(facetName, 'value1')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 1, 'Adding one refinement, should have one')
+ helper.toggleRefine(facetName, 'value2')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 2, 'Adding another refinement, should have two')
+ helper.toggleRefine(facetName, 'value1')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 1, 'Adding same refinement as the first, should have two')
+ t.deepEqual(helper.state.facetsRefinements[facetName], ['value2'], 'should contain value2')
+
+ t.end()
+})
+
+test('Removing several refinements for a single attribute should be handled', function(t) {
+ var facetName = 'facet'
+
+ var helper = algoliasearchHelper(null, null, {
+ facets: [facetName]
+ })
+
+ t.ok(_.isEmpty(helper.state.facetsRefinements), 'empty')
+ helper.addRefine(facetName, 'value1')
+ helper.addRefine(facetName, 'value2')
+ helper.addRefine(facetName, 'value3')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 3, 'Adding another refinement, should have two')
+ helper.removeRefine(facetName, 'value2')
+ t.ok(_.size(helper.state.facetsRefinements[facetName]) === 2, 'Adding same refinement as the first, should have two')
+ t.deepEqual(helper.state.facetsRefinements[facetName], ['value1', 'value3'], 'should contain value1 and value3')
+
+ t.end()
+})
+
+test('isDisjunctiveRefined', function(t) {
+ var helper = algoliasearchHelper(null, null, {})
+
+ var facet = 'MyFacet'
+ var value = 'MyValue'
+
+ t.notOk(helper.isDisjunctiveRefined(facet, value),
+ 'isDisjunctiveRefined should not return true for undefined refinement')
+ helper.addDisjunctiveRefine(facet, value)
+ t.ok(helper.isDisjunctiveRefined(facet, value),
+ 'isDisjunctiveRefined should not return false for defined refinement')
+ helper.removeDisjunctiveRefine(facet, value)
+ t.notOk(helper.isDisjunctiveRefined(facet, value),
+ 'isDisjunctiveRefined should not return true for removed refinement')
+ t.end()
+})
+
+test('IsRefined should return true if the (facet, value ) is refined.', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1']
+ })
+
+ helper.addRefine('facet1', 'boom')
+
+ t.ok(helper.isRefined('facet1', 'boom'), 'the facet + value is refined >> true')
+
+ t.notOk(helper.isRefined('facet1', 'booohh'), 'value not refined but is a facet')
+ t.notOk(helper.isRefined('notAFacet', 'maoooh'), "not refined because it's not a facet")
+ t.notOk(helper.isRefined(null, null), 'not even valid values')
+
+ t.end()
+})
+
+test('isRefined(facet)/hasRefinements should return true if the facet is refined.', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1']
+ })
+
+ t.notOk(helper.isRefined('facet1'), 'the facet is not refined yet >> false')
+ t.notOk(helper.hasRefinements('facet1'), 'the facet is not refined yet >> false')
+
+ helper.addRefine('facet1', 'boom')
+
+ t.ok(helper.isRefined('facet1'), 'the facet is refined >> true')
+ t.ok(helper.hasRefinements('facet1'), 'the facet is refined >> true')
+
+ t.notOk(helper.isRefined('notAFacet'), 'not a facet')
+ t.notOk(helper.hasRefinements('notAFacet'), 'not a facet')
+ t.notOk(helper.isRefined(null), 'not even valid values')
+ t.notOk(helper.hasRefinements(null), 'not even valid values')
+
+ t.end()
+})
+
+test('getRefinements should return all the refinements for a given facet', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1'],
+ disjunctiveFacets: ['facet2', 'sales']
+ })
+
+ helper.addRefine('facet1', 'val1')
+ .addRefine('facet1', 'val2')
+ .addExclude('facet1', 'val-1')
+ .toggleRefine('facet1', 'val3')
+
+ helper.addDisjunctiveRefine('facet2', 'val4')
+ .addDisjunctiveRefine('facet2', 'val5')
+ .toggleRefine('facet2', 'val6')
+
+ helper.addNumericRefinement('sales', '>', '3')
+ .addNumericRefinement('sales', '<', '9')
+
+ t.deepEqual(helper.getRefinements('facet1'),
+ [
+ {value: 'val1', type: 'conjunctive'},
+ {value: 'val2', type: 'conjunctive'},
+ {value: 'val3', type: 'conjunctive'},
+ {value: 'val-1', type: 'exclude'}
+ ],
+ '')
+
+ t.deepEqual(helper.getRefinements('facet2'),
+ [
+ {value: 'val4', type: 'disjunctive'},
+ {value: 'val5', type: 'disjunctive'},
+ {value: 'val6', type: 'disjunctive'}
+ ],
+ '')
+
+ t.deepEqual(helper.getRefinements('sales'),
+ [
+ {value: '3', operator: '>', type: 'numeric'},
+ {value: '9', operator: '<', type: 'numeric'}
+ ],
+ '')
+
+ t.end()
+})
+
+test('getRefinements should return an empty array if the facet has no refinement', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1'],
+ disjunctiveFacets: ['facet2']
+ })
+
+ t.deepEqual(helper.getRefinements('facet1'), [], '')
+ t.deepEqual(helper.getRefinements('facet2'), [], '')
+
+ t.end()
+})
+
+test('[Conjunctive] Facets should be resilient to user attempt to use numbers', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1'],
+ disjunctiveFacets: ['facet2']
+ })
+
+ helper.addRefine('facet1', 42)
+ t.ok(helper.isRefined('facet1', 42), '[facet][number] should be refined')
+ t.ok(helper.isRefined('facet1', '42'), '[facet][string] should be refined')
+
+ var stateWithFacet1and42 = helper.state
+
+ helper.removeRefine('facet1', '42')
+ t.notOk(helper.isRefined('facet1', '42'), '[facet][string] should not be refined')
+
+ helper.setState(stateWithFacet1and42)
+ helper.removeRefine('facet1', 42)
+ t.notOk(helper.isRefined('facet1', 42), '[facet][number] should not be refined')
+
+ t.end()
+})
+
+test('[Disjunctive] Facets should be resilient to user attempt to use numbers', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1'],
+ disjunctiveFacets: ['facet2']
+ })
+
+ helper.addExclude('facet1', 42)
+ t.ok(helper.isExcluded('facet1', 42), '[facet][number] should be refined')
+ t.ok(helper.isExcluded('facet1', '42'), '[facet][string] should be refined')
+
+ var stateWithFacet1Without42 = helper.state
+
+ helper.removeExclude('facet1', '42')
+ t.notOk(helper.isExcluded('facet1', '42'), '[facet][string] should not be refined')
+
+ helper.setState(stateWithFacet1Without42)
+ helper.removeExclude('facet1', 42)
+ t.notOk(helper.isExcluded('facet1', 42), '[facet][number] should not be refined')
+
+ t.end()
+})
+
+test('[Disjunctive] Facets should be resilient to user attempt to use numbers', function(t) {
+ var helper = algoliasearchHelper(null, null, {
+ facets: ['facet1'],
+ disjunctiveFacets: ['facet2']
+ })
+
+ helper.addDisjunctiveRefine('facet2', 42)
+ t.ok(helper.isDisjunctiveRefined('facet2', 42), '[facet][number] should be refined')
+ t.ok(helper.isDisjunctiveRefined('facet2', '42'), '[facet][string] should be refined')
+
+ var stateWithFacet2and42 = helper.state
+
+ helper.removeDisjunctiveRefine('facet2', '42')
+ t.notOk(helper.isDisjunctiveRefined('facet2', '42'), '[facet][string] should not be refined')
+ helper.setState(stateWithFacet2and42)
+
+ helper.removeDisjunctiveRefine('facet2', 42)
+ t.notOk(helper.isDisjunctiveRefined('facet2', 42), '[facet][number] should not be refined')
+
+ t.end()
+})
diff --git a/test/spec/search.js b/test/spec/search.js
index deafbaa2a2..4c66904a7c 100644
--- a/test/spec/search.js
+++ b/test/spec/search.js
@@ -1,56 +1,56 @@
-"use strict";
-var test = require( "tape" );
-var sinon = require( "sinon" );
-var algoliaSearch = require( "algoliasearch" );
+'use strict'
+var test = require('tape')
+var sinon = require('sinon')
+var algoliaSearch = require('algoliasearch')
-var algoliasearchHelper = require( "../../index" );
+var algoliasearchHelper = require('../../index')
-test( "Search should call the algolia client according to the number of refinements", function( t ) {
- var testData = require( "./search.testdata" );
+test('Search should call the algolia client according to the number of refinements', function(t) {
+ var testData = require('./search.testdata')
- var client = algoliaSearch( "dsf", "dsfdf" );
+ var client = algoliaSearch('dsf', 'dsfdf')
+ var mock = sinon.mock(client)
- var mock = sinon.mock( client );
- mock.expects( "search" ).once().yields( null, testData.response );
+ mock.expects('search').once().yields(null, testData.response)
- var helper = algoliasearchHelper( client, "test_hotels-node", {
- disjunctiveFacets : ["city"]
- } );
+ var helper = algoliasearchHelper(client, 'test_hotels-node', {
+ disjunctiveFacets: ['city']
+ })
- helper.addDisjunctiveRefine( "city", "Paris", true );
- helper.addDisjunctiveRefine( "city", "New York", true );
+ helper.addDisjunctiveRefine('city', 'Paris', true)
+ helper.addDisjunctiveRefine('city', 'New York', true)
- helper.on( "result", function( data ) {
- t.deepEqual( data, testData.responseHelper, "should be equal" );
- t.ok( mock.verify(), "Mock constraints should be verified!" );
- t.end();
- } );
+ helper.on('result', function(data) {
+ t.deepEqual(data, testData.responseHelper, 'should be equal')
+ t.ok(mock.verify(), 'Mock constraints should be verified!')
+ t.end()
+ })
- helper.search( "" );
-} );
+ helper.search('')
+})
-test( "no mutating methods should trigger a search", function( t ) {
- var helper = algoliasearchHelper( undefined, "Index", {
- disjunctiveFacets : ["city"],
- facets : ["tower"]
- } );
+test('no mutating methods should trigger a search', function(t) {
+ var helper = algoliasearchHelper(undefined, 'Index', {
+ disjunctiveFacets: ['city'],
+ facets: ['tower']
+ })
- var stubbedSearch = sinon.stub( helper, "_search" );
+ var stubbedSearch = sinon.stub(helper, '_search')
- helper.setQuery( "" );
- helper.clearRefinements();
- helper.addDisjunctiveRefine( "city", "Paris" );
- helper.removeDisjunctiveRefine( "city", "Paris" );
- helper.addExclude( "tower", "Empire State Building" );
- helper.removeExclude( "tower", "Empire State Building" );
- helper.addRefine( "tower", "Empire State Building" );
- helper.removeRefine( "tower", "Empire State Building" );
+ helper.setQuery('')
+ helper.clearRefinements()
+ helper.addDisjunctiveRefine('city', 'Paris')
+ helper.removeDisjunctiveRefine('city', 'Paris')
+ helper.addExclude('tower', 'Empire State Building')
+ helper.removeExclude('tower', 'Empire State Building')
+ helper.addRefine('tower', 'Empire State Building')
+ helper.removeRefine('tower', 'Empire State Building')
- t.equal( stubbedSearch.callCount, 0, "should not have triggered calls" );
+ t.equal(stubbedSearch.callCount, 0, 'should not have triggered calls')
- helper.search();
+ helper.search()
- t.equal( stubbedSearch.callCount, 1, "should have triggered a single search" );
+ t.equal(stubbedSearch.callCount, 1, 'should have triggered a single search')
- t.end();
-} );
+ t.end()
+})
diff --git a/test/spec/search.testdata.js b/test/spec/search.testdata.js
index 4b1b4b8ab1..6e5138ca5b 100644
--- a/test/spec/search.testdata.js
+++ b/test/spec/search.testdata.js
@@ -1,369 +1,369 @@
-"use strict";
-var SearchParameters = require( "../../src/SearchParameters" );
+'use strict'
+var SearchParameters = require('../../src/SearchParameters')
var response = {
- "results" : [
- {
- "page" : 0,
- "index" : "test_hotels-node",
- "hits" : [
- {
- "stars" : "****",
- "facilities" : [
- "spa"
- ],
- "city" : "New York",
- "objectID" : "366084010",
- "name" : "Hotel E",
- "_highlightResult" : {
- "name" : {
- "matchedWords" : [],
- "value" : "Hotel E",
- "matchLevel" : "none"
- },
- "stars" : {
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "****"
- },
- "facilities" : [
- {
- "matchLevel" : "none",
- "value" : "spa",
- "matchedWords" : []
- }
- ],
- "city" : {
- "matchLevel" : "none",
- "value" : "New York",
- "matchedWords" : []
- }
+ 'results': [
+ {
+ 'page': 0,
+ 'index': 'test_hotels-node',
+ 'hits': [
+ {
+ 'stars': '****',
+ 'facilities': [
+ 'spa'
+ ],
+ 'city': 'New York',
+ 'objectID': '366084010',
+ 'name': 'Hotel E',
+ '_highlightResult': {
+ 'name': {
+ 'matchedWords': [],
+ 'value': 'Hotel E',
+ 'matchLevel': 'none'
+ },
+ 'stars': {
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': '****'
+ },
+ 'facilities': [
+ {
+ 'matchLevel': 'none',
+ 'value': 'spa',
+ 'matchedWords': []
}
+ ],
+ 'city': {
+ 'matchLevel': 'none',
+ 'value': 'New York',
+ 'matchedWords': []
+ }
+ }
+ },
+ {
+ '_highlightResult': {
+ 'stars': {
+ 'matchedWords': [],
+ 'value': '****',
+ 'matchLevel': 'none'
},
- {
- "_highlightResult" : {
- "stars" : {
- "matchedWords" : [],
- "value" : "****",
- "matchLevel" : "none"
- },
- "facilities" : [
- {
- "value" : "spa",
- "matchedWords" : [],
- "matchLevel" : "none"
- }
- ],
- "city" : {
- "matchedWords" : [],
- "value" : "Paris",
- "matchLevel" : "none"
- },
- "name" : {
- "value" : "Hotel D",
- "matchedWords" : [],
- "matchLevel" : "none"
- }
- },
- "name" : "Hotel D",
- "objectID" : "366084000",
- "facilities" : [
- "spa"
- ],
- "city" : "Paris",
- "stars" : "****"
+ 'facilities': [
+ {
+ 'value': 'spa',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
+ }
+ ],
+ 'city': {
+ 'matchedWords': [],
+ 'value': 'Paris',
+ 'matchLevel': 'none'
},
- {
- "_highlightResult" : {
- "stars" : {
- "matchLevel" : "none",
- "value" : "*",
- "matchedWords" : []
- },
- "city" : {
- "matchLevel" : "none",
- "value" : "Paris",
- "matchedWords" : []
- },
- "facilities" : [
- {
- "value" : "wifi",
- "matchedWords" : [],
- "matchLevel" : "none"
- }
- ],
- "name" : {
- "matchedWords" : [],
- "value" : "Hotel B",
- "matchLevel" : "none"
- }
- },
- "name" : "Hotel B",
- "objectID" : "366083980",
- "city" : "Paris",
- "facilities" : [
- "wifi"
- ],
- "stars" : "*"
+ 'name': {
+ 'value': 'Hotel D',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
+ }
+ },
+ 'name': 'Hotel D',
+ 'objectID': '366084000',
+ 'facilities': [
+ 'spa'
+ ],
+ 'city': 'Paris',
+ 'stars': '****'
+ },
+ {
+ '_highlightResult': {
+ 'stars': {
+ 'matchLevel': 'none',
+ 'value': '*',
+ 'matchedWords': []
},
- {
- "stars" : "*",
- "city" : "Paris",
- "facilities" : [
- "wifi",
- "bath",
- "spa"
- ],
- "objectID" : "366083970",
- "name" : "Hotel A",
- "_highlightResult" : {
- "name" : {
- "value" : "Hotel A",
- "matchedWords" : [],
- "matchLevel" : "none"
- },
- "stars" : {
- "matchLevel" : "none",
- "value" : "*",
- "matchedWords" : []
- },
- "facilities" : [
- {
- "matchLevel" : "none",
- "value" : "wifi",
- "matchedWords" : []
- },
- {
- "value" : "bath",
- "matchedWords" : [],
- "matchLevel" : "none"
- },
- {
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "spa"
- }
- ],
- "city" : {
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "Paris"
- }
+ 'city': {
+ 'matchLevel': 'none',
+ 'value': 'Paris',
+ 'matchedWords': []
+ },
+ 'facilities': [
+ {
+ 'value': 'wifi',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
}
+ ],
+ 'name': {
+ 'matchedWords': [],
+ 'value': 'Hotel B',
+ 'matchLevel': 'none'
}
- ],
- "params" : "query=&hitsPerPage=20&page=0&facets=%5B%5D&facetFilters=%5B%5B%22city%3AParis%22%2C%22city%3ANew%20York%22%5D%5D",
- "exhaustiveFacetsCount" : true,
- "nbHits" : 4,
- "query" : "",
- "processingTimeMS" : 2,
- "nbPages" : 1,
- "hitsPerPage" : 20
- },
- {
- "query" : "",
- "nbPages" : 5,
- "hitsPerPage" : 1,
- "processingTimeMS" : 3,
- "page" : 0,
- "index" : "test_hotels-node",
- "facets" : {
- "city" : {
- "New York" : 1,
- "Paris" : 3,
- "San Francisco" : 1
- }
+ },
+ 'name': 'Hotel B',
+ 'objectID': '366083980',
+ 'city': 'Paris',
+ 'facilities': [
+ 'wifi'
+ ],
+ 'stars': '*'
},
- "exhaustiveFacetsCount" : false,
- "nbHits" : 5,
- "hits" : [
- {
- "objectID" : "366084010"
+ {
+ 'stars': '*',
+ 'city': 'Paris',
+ 'facilities': [
+ 'wifi',
+ 'bath',
+ 'spa'
+ ],
+ 'objectID': '366083970',
+ 'name': 'Hotel A',
+ '_highlightResult': {
+ 'name': {
+ 'value': 'Hotel A',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
+ },
+ 'stars': {
+ 'matchLevel': 'none',
+ 'value': '*',
+ 'matchedWords': []
+ },
+ 'facilities': [
+ {
+ 'matchLevel': 'none',
+ 'value': 'wifi',
+ 'matchedWords': []
+ },
+ {
+ 'value': 'bath',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
+ },
+ {
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': 'spa'
+ }
+ ],
+ 'city': {
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': 'Paris'
}
- ],
- "params" : "query=&hitsPerPage=1&page=0&attributesToRetrieve=%5B%5D&attributesToHighlight=%5B%5D&attributesToSnippet=%5B%5D&facets=city&facetFilters=%5B%5D"
- }
- ]
-};
+ }
+ }
+ ],
+ 'params': 'query=&hitsPerPage=20&page=0&facets=%5B%5D&facetFilters=%5B%5B%22city%3AParis%22%2C%22city%3ANew%20York%22%5D%5D',
+ 'exhaustiveFacetsCount': true,
+ 'nbHits': 4,
+ 'query': '',
+ 'processingTimeMS': 2,
+ 'nbPages': 1,
+ 'hitsPerPage': 20
+ },
+ {
+ 'query': '',
+ 'nbPages': 5,
+ 'hitsPerPage': 1,
+ 'processingTimeMS': 3,
+ 'page': 0,
+ 'index': 'test_hotels-node',
+ 'facets': {
+ 'city': {
+ 'New York': 1,
+ 'Paris': 3,
+ 'San Francisco': 1
+ }
+ },
+ 'exhaustiveFacetsCount': false,
+ 'nbHits': 5,
+ 'hits': [
+ {
+ 'objectID': '366084010'
+ }
+ ],
+ 'params': 'query=&hitsPerPage=1&page=0&attributesToRetrieve=%5B%5D&attributesToHighlight=%5B%5D&attributesToSnippet=%5B%5D&facets=city&facetFilters=%5B%5D'
+ }
+ ]
+}
-var searchParams = new SearchParameters( {
- disjunctiveFacets : [ "city" ],
- disjunctiveFacetsRefinements : {
- city : [ "Paris", "New York" ]
+var searchParams = new SearchParameters({
+ disjunctiveFacets: ['city'],
+ disjunctiveFacetsRefinements: {
+ city: ['Paris', 'New York']
}
-} );
+})
var responseHelper = {
- "_state" : searchParams,
- "query" : "",
- "hits" : [
+ '_state': searchParams,
+ 'query': '',
+ 'hits': [
{
- "stars" : "****",
- "facilities" : [
- "spa"
+ 'stars': '****',
+ 'facilities': [
+ 'spa'
],
- "city" : "New York",
- "objectID" : "366084010",
- "name" : "Hotel E",
- "_highlightResult" : {
- "name" : {
- "matchedWords" : [],
- "value" : "Hotel E",
- "matchLevel" : "none"
+ 'city': 'New York',
+ 'objectID': '366084010',
+ 'name': 'Hotel E',
+ '_highlightResult': {
+ 'name': {
+ 'matchedWords': [],
+ 'value': 'Hotel E',
+ 'matchLevel': 'none'
},
- "stars" : {
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "****"
+ 'stars': {
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': '****'
},
- "facilities" : [
+ 'facilities': [
{
- "matchLevel" : "none",
- "value" : "spa",
- "matchedWords" : []
+ 'matchLevel': 'none',
+ 'value': 'spa',
+ 'matchedWords': []
}
],
- "city" : {
- "matchLevel" : "none",
- "value" : "New York",
- "matchedWords" : []
+ 'city': {
+ 'matchLevel': 'none',
+ 'value': 'New York',
+ 'matchedWords': []
}
}
},
{
- "_highlightResult" : {
- "stars" : {
- "matchedWords" : [],
- "value" : "****",
- "matchLevel" : "none"
+ '_highlightResult': {
+ 'stars': {
+ 'matchedWords': [],
+ 'value': '****',
+ 'matchLevel': 'none'
},
- "facilities" : [
+ 'facilities': [
{
- "value" : "spa",
- "matchedWords" : [],
- "matchLevel" : "none"
+ 'value': 'spa',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
}
],
- "city" : {
- "matchedWords" : [],
- "value" : "Paris",
- "matchLevel" : "none"
+ 'city': {
+ 'matchedWords': [],
+ 'value': 'Paris',
+ 'matchLevel': 'none'
},
- "name" : {
- "value" : "Hotel D",
- "matchedWords" : [],
- "matchLevel" : "none"
+ 'name': {
+ 'value': 'Hotel D',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
}
},
- "name" : "Hotel D",
- "objectID" : "366084000",
- "facilities" : [
- "spa"
+ 'name': 'Hotel D',
+ 'objectID': '366084000',
+ 'facilities': [
+ 'spa'
],
- "city" : "Paris",
- "stars" : "****"
+ 'city': 'Paris',
+ 'stars': '****'
},
{
- "_highlightResult" : {
- "stars" : {
- "matchLevel" : "none",
- "value" : "*",
- "matchedWords" : []
+ '_highlightResult': {
+ 'stars': {
+ 'matchLevel': 'none',
+ 'value': '*',
+ 'matchedWords': []
},
- "city" : {
- "matchLevel" : "none",
- "value" : "Paris",
- "matchedWords" : []
+ 'city': {
+ 'matchLevel': 'none',
+ 'value': 'Paris',
+ 'matchedWords': []
},
- "facilities" : [
+ 'facilities': [
{
- "value" : "wifi",
- "matchedWords" : [],
- "matchLevel" : "none"
+ 'value': 'wifi',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
}
],
- "name" : {
- "matchedWords" : [],
- "value" : "Hotel B",
- "matchLevel" : "none"
+ 'name': {
+ 'matchedWords': [],
+ 'value': 'Hotel B',
+ 'matchLevel': 'none'
}
},
- "name" : "Hotel B",
- "objectID" : "366083980",
- "city" : "Paris",
- "facilities" : [
- "wifi"
+ 'name': 'Hotel B',
+ 'objectID': '366083980',
+ 'city': 'Paris',
+ 'facilities': [
+ 'wifi'
],
- "stars" : "*"
+ 'stars': '*'
},
{
- "stars" : "*",
- "city" : "Paris",
- "facilities" : [
- "wifi",
- "bath",
- "spa"
+ 'stars': '*',
+ 'city': 'Paris',
+ 'facilities': [
+ 'wifi',
+ 'bath',
+ 'spa'
],
- "objectID" : "366083970",
- "name" : "Hotel A",
- "_highlightResult" : {
- "name" : {
- "value" : "Hotel A",
- "matchedWords" : [],
- "matchLevel" : "none"
+ 'objectID': '366083970',
+ 'name': 'Hotel A',
+ '_highlightResult': {
+ 'name': {
+ 'value': 'Hotel A',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
},
- "stars" : {
- "matchLevel" : "none",
- "value" : "*",
- "matchedWords" : []
+ 'stars': {
+ 'matchLevel': 'none',
+ 'value': '*',
+ 'matchedWords': []
},
- "facilities" : [
+ 'facilities': [
{
- "matchLevel" : "none",
- "value" : "wifi",
- "matchedWords" : []
+ 'matchLevel': 'none',
+ 'value': 'wifi',
+ 'matchedWords': []
},
{
- "value" : "bath",
- "matchedWords" : [],
- "matchLevel" : "none"
+ 'value': 'bath',
+ 'matchedWords': [],
+ 'matchLevel': 'none'
},
{
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "spa"
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': 'spa'
}
],
- "city" : {
- "matchLevel" : "none",
- "matchedWords" : [],
- "value" : "Paris"
+ 'city': {
+ 'matchLevel': 'none',
+ 'matchedWords': [],
+ 'value': 'Paris'
}
}
}
],
- "index" : "test_hotels-node",
- "hitsPerPage" : 20,
- "nbHits" : 4,
- "nbPages" : 1,
- "page" : 0,
- "processingTimeMS" : 5,
- "disjunctiveFacets" : [
+ 'index': 'test_hotels-node',
+ 'hitsPerPage': 20,
+ 'nbHits': 4,
+ 'nbPages': 1,
+ 'page': 0,
+ 'processingTimeMS': 5,
+ 'disjunctiveFacets': [
{
- "name" : "city",
- "data" : {
- "New York" : 1,
- "Paris" : 3,
- "San Francisco" : 1
+ 'name': 'city',
+ 'data': {
+ 'New York': 1,
+ 'Paris': 3,
+ 'San Francisco': 1
},
- "exhaustive" : false
+ 'exhaustive': false
}
],
- "facets" : []
-};
+ 'facets': []
+}
module.exports = {
- response : response,
- searchParams : searchParams,
- responseHelper : responseHelper
-};
+ response: response,
+ searchParams: searchParams,
+ responseHelper: responseHelper
+}
diff --git a/tutorials/00-cheatsheet.md b/tutorials/00-cheatsheet.md
index b261733a93..b6644847aa 100644
--- a/tutorials/00-cheatsheet.md
+++ b/tutorials/00-cheatsheet.md
@@ -1,7 +1,7 @@
# JS Helper Cheat Sheet
-
+
- [Init the helper](#init-the-helper)
@@ -21,37 +21,35 @@
## Init the helper
```
-var helper = algoliasearchHelper( client, indexName, parameters );
+var helper = algoliasearchHelper(client, indexName, parameters);
```
## Helper lifecycle
1. modify the parameters of the search (usually through user interactions)
```js
-helper.setQuery("iphone").addRefine( “category”, “phone” )
+helper.setQuery("iphone").addRefine("category", "phone");
```
2. trigger the search (after all the modification have been applied)
```js
-helper.search()
+helper.search();
```
3. read the results (with the event "result" handler) and update the UI with the results
```js
-helper.on( “result”, function( results) {
- updateUI( results );
-} );
+helper.on("result", updateUI);
```
4. go back to 1
## Objects
-**AlgoliasearchHelper** : the helper. Keeps the state of the search, makes the queries and calls the handlers when an event happen
+**AlgoliasearchHelper**: the helper. Keeps the state of the search, makes the queries and calls the handlers when an event happen
-**SearchParameters** : the object representing the state of the search.
+**SearchParameters**: the object representing the state of the search.
-**SearchResults** : the object in which the Algolia answers are transformed into. This object is passed to the result event handler.
+**SearchResults**: the object in which the Algolia answers are transformed into. This object is passed to the result event handler.
## Search
@@ -59,50 +57,48 @@ The search is triggered by the search() method.
It takes all the previous modifications to the search and use them to create the queries to Algolia. The search parameters are stateful.
-Example :
+Example:
```
-var helper = algoliasearchHelper( client, "index", {} );
+var helper = algoliasearchHelper(client, "index", {});
// Let’s monitor the results with the console
-helper.on( "result", function( content ) { console.log( content ) } );
+helper.on("result", function(content) {
+ console.log(content);
+});
// Let’s make an empty search
// The results are all taken sorted using the dashboard configuration
helper.search();
// Let’s search for "landscape"
-helper.setQuery( "landscape" ).search();
+helper.setQuery("landscape").search();
// Let’s add a category "photo"
-// Will make a search with "photo" tag and “landscape” as the query
-helper.addTag( "photo" ).search();
+// Will make a search with "photo" tag and "landscape" as the query
+helper.addTag("photo").search();
```
## Events
-result : get the new results when available. The handler function will receive two objects the search results (SearchResults) and the
+result: get the new results when available. The handler function will receive two objects the search results (SearchResults) and the
-error : get the errors from the API
+error: get the errors from the API
-change : get notified when a property has changed in the helper
+change: get notified when a property has changed in the helper
### Listen to the "result" event
```
-helper.on( "result", function( results ){
- updateTheResults( results );
-} )
+helper.on("result", updateTheResults);
```
-### Listen to an "result" event once
+### Listen to a "result" event once
```
-helper.once( "result", function( results ){
- updateTheResults( results );
-} )
+helper.once("result", updateTheResults);
```
### Remove all "result" listeners
```
-helper.removeListener( "result" )
+helper.removeListener("result");
```
## Query
@@ -110,33 +106,33 @@ helper.removeListener( "result" )
### Do a search with the query "fruit"
```
-helper.setQuery( "fruit" ).search();
+helper.setQuery("fruit").search();
```
## Filtering results
-Facets are categories created upon attributes. First you need to define which attribute will be used as facet in the dashboard : [https://www.algolia.com/explorer#?tab=display](https://www.algolia.com/explorer#?tab=display)
+Facets are categories created upon attributes. First you need to define which attribute will be used as facet in the dashboard: [https://www.algolia.com/explorer#?tab=display](https://www.algolia.com/explorer#?tab=display)
### "And" facets
#### Facet definition
```
-var helper = algoliasearchHelper( client, indexName, {
- facets : [ "andFacet" ]
-} );
+var helper = algoliasearchHelper(client, indexName, {
+ facets: ["andFacet"]
+});
```
#### Add a facet filter
```
-helper.addRefine( "andFacet", “valueOfAndFacet” ).search();
+helper.addRefine("andFacet", "valueOfAndFacet").search();
```
#### Remove a facet filter
```
-helper.removeRefine( "andFacet", “valueOfAndFacet” ).search();
+helper.removeRefine("andFacet", "valueOfAndFacet").search();
```
### "Or" facets
@@ -144,21 +140,21 @@ helper.removeRefine( "andFacet", “valueOfAndFacet” ).search();
#### Facet definition
```
-var helper = algoliasearchHelper( client, indexName, {
- disjunctiveFacets : [ "orFacet" ]
-} );
+var helper = algoliasearchHelper(client, indexName, {
+ disjunctiveFacets: ["orFacet"]
+});
```
#### Add a facet filter
```
-helper.addDisjunctiveRefine( "orFacet", “valueOfOrFacet” ).search();
+helper.addDisjunctiveRefine("orFacet", "valueOfOrFacet").search();
```
#### Remove a facet filter
```
-helper.removeDisjunctiveRefine( "orFacet", “valueOfFacet” ).search();
+helper.removeDisjunctiveRefine("orFacet", "valueOfFacet").search();
```
### Negative facets
@@ -168,21 +164,21 @@ filter so that we do NOT get a given category
#### Facet definition (same as "and" facet)
```
-var helper = algoliasearchHelper( client, indexName, {
- facets: [ "andFacet" ]
-} ).search();
+var helper = algoliasearchHelper(client, indexName, {
+ facets: ["andFacet"]
+}).search();
```
#### Exclude a value for a facet
```
-helper.addExclude( "andFacet", “valueOfAndFacetToExclude” );
+helper.addExclude("andFacet", "valueOfAndFacetToExclude");
```
#### Remove an exclude from the list of excluded values
```
-helper.removeExclude( "andFacet", “valueOfAndFacetToExclude” );
+helper.removeExclude("andFacet", "valueOfAndFacetToExclude");
```
### Numeric facets
@@ -192,21 +188,21 @@ Filter over numeric attributes with math operations like =, >, <, >=, <=. Can be
#### Facet definition
```
-var helper = algoliasearchHelper( client, indexName, {
- disjunctiveFacets : [ "numericFacet" ]
-} );
+var helper = algoliasearchHelper(client, indexName, {
+ disjunctiveFacets: ["numericFacet"]
+});
```
#### Add a numeric refinement
```
-helper.addNumericRefinement( "numericFacet", “=”, “3” ).search();
+helper.addNumericRefinement("numericFacet", "=", "3").search();
```
#### Remove a numeric refinement
```
-helper.removeNumericRefinemetn( "numericFacet", “=”, “3” ).search();
+helper.removeNumericRefinemetn("numericFacet", "=", "3").search();
```
### Clearing filters
@@ -220,15 +216,15 @@ helper.clearRefinements().search();
#### Clear all the refinements for a specific attribute
```
-helper.clearRefinements( "andFacet" ).search();
+helper.clearRefinements("andFacet").search();
```
#### [ADVANCED] Clear only the exclusions on the "andFacet" attribute
```
-helper.clearRefinements( function( value, attribute, type ) {
- return type==="exclude” && attribute===”andFacet”;
-} ).search();
+helper.clearRefinements(function(value, attribute, type) {
+ return type === "exclude" && attribute === "andFacet";
+}).search();
```
## Tags
@@ -238,13 +234,13 @@ Tags are an easy way to do filtering. They are based on a special attribute in t
### Add a tag filter for the value "landscape"
```
-helper.addTag( "landscape" ).search();
+helper.addTag("landscape").search();
```
### Remove a tag filter for the value "landscape"
```
-helper.removeTag( "landscape" ).search();
+helper.removeTag("landscape").search();
```
### Clear all the tags filters
@@ -262,7 +258,7 @@ helper.getCurrentPage();
### Change page
```
-helper.setCurrentPage( 3 ).search();
+helper.setCurrentPage(3).search();
```
## Index
@@ -271,7 +267,7 @@ Index can be changed. The common use case is when you have several slaves with d
### Change the current index
```
-helper.setIndex( "index_orderByPrice" ).search();
+helper.setIndex("index_orderByPrice").search();
```
### Get the current index
@@ -286,15 +282,15 @@ There are lots of other parameters you can set.
### Set a parameter at the initialization of the helper
```
-var helper = algoliasearchHelper( client, indexName, {
- hitsPerPage : 50
-} );
+var helper = algoliasearchHelper(client, indexName, {
+ hitsPerPage: 50
+});
```
### Set a parameter later
```
-helper.setQueryParameter( "hitsPerPage", 20 ).search();
+helper.setQueryParameter("hitsPerPage", 20).search();
```
### List of parameters that can be set
@@ -605,7 +601,7 @@ helper.setQueryParameter( "hitsPerPage", 20 ).search();
string
- How the query should be treated by the search engine. Possible values : prefixAll, prefixLast, prefixNone
+ How the query should be treated by the search engine. Possible values: prefixAll, prefixLast, prefixNone
queryType on Algolia.com
|
@@ -677,7 +673,7 @@ helper.setQueryParameter( "hitsPerPage", 20 ).search();
string
- How the typo tolerance behave in the search engine. Possible values : true, false, min, strict
+ How the typo tolerance behave in the search engine. Possible values: true, false, min, strict
typoTolerance on Algolia.com
|
diff --git a/zuul.config.js b/zuul.config.js
index 9c459b6fab..08949120a1 100644
--- a/zuul.config.js
+++ b/zuul.config.js
@@ -1,4 +1,4 @@
-"use strict";
+'use strict'
var zuulConfig = module.exports = {
ui: 'tape',
@@ -8,72 +8,76 @@ var zuulConfig = module.exports = {
transform: 'envify'
}],
scripts: [
+
// browser integration tests will use the dist file, so that we test the
// build process also
'/dist/algoliasearch.helper.min.js'
],
+
// only used when run with saucelabs
// not activated when dev or phantom
concurrency: 5,
+
// if browser does not sends output in 30s since last output:
// stop testing, something is wrong
- browser_output_timeout: 50*1000,
+ browser_output_timeout: 50 * 1000,
+
// we want to be notified something is wrong asap, so no retry
browser_retries: 0
-};
+}
if (process.env.TRAVIS_BUILD_NUMBER !== undefined) {
- zuulConfig.tunnel = 'ngrok';
+ zuulConfig.tunnel = 'ngrok'
}
var browsers = {
all: [{
- name: 'chrome',
- version: '42..beta',
- platform: 'Windows 2012 R2' // Force Win 8.1, more stable than linux etc
- }, {
- name: 'firefox',
- version: '37..beta',
- platform: 'Windows 2012 R2'
- }, {
- name: 'ie',
- version: '9..latest'
- }, {
- name: 'safari',
- version: '6..latest'
- }, {
- name: 'iphone',
- version: '7.0..latest'
- }, {
- name: 'android',
- version: '4.1..latest'
- }, {
- name: 'ipad',
- version: '7.0..latest'
- }
+ name: 'chrome',
+ version: '42..beta',
+ platform: 'Windows 2012 R2' // Force Win 8.1, more stable than linux etc
+ }, {
+ name: 'firefox',
+ version: '37..beta',
+ platform: 'Windows 2012 R2'
+ }, {
+ name: 'ie',
+ version: '9..latest'
+ }, {
+ name: 'safari',
+ version: '6..latest'
+ }, {
+ name: 'iphone',
+ version: '7.0..latest'
+ }, {
+ name: 'android',
+ version: '4.1..latest'
+ }, {
+ name: 'ipad',
+ version: '7.0..latest'
+ }
],
pullRequest: [{
- name: 'chrome',
- version: 'latest', // `latest` === stable
- platform: 'Windows 2012 R2'
- }, {
- name: 'firefox',
- version: 'latest',
- platform: 'Windows 2012 R2'
- }, {
- name: 'ie',
- version: 'latest'
- }, {
- name: 'iphone',
- version: 'latest'
- }, {
- name: 'android',
- version: 'latest'
- }
+ name: 'chrome',
+ version: 'latest', // `latest` === stable
+ platform: 'Windows 2012 R2'
+ }, {
+ name: 'firefox',
+ version: 'latest',
+ platform: 'Windows 2012 R2'
+ }, {
+ name: 'ie',
+ version: 'latest'
+ }, {
+ name: 'iphone',
+ version: 'latest'
+ }, {
+ name: 'android',
+ version: 'latest'
+ }
]
-};
+}
zuulConfig.browsers =
process.env.TRAVIS_PULL_REQUEST && process.env.TRAVIS_PULL_REQUEST !== 'false' ?
browsers.pullRequest :
- browsers.all;
+ browsers.all