Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
F
facets
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Custom Issue Tracker
Custom Issue Tracker
Labels
Merge Requests
8
Merge Requests
8
Requirements
Requirements
List
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Analytics
Analytics
Code Review
Insights
Issue
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Commits
Open sidebar
project
facets
Commits
3323ecff
Commit
3323ecff
authored
Dec 05, 2017
by
borisson_
Committed by
borisson_
Dec 05, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Issue
#2913329
by borisson_, ekes, d.novikov: Move numeric granularity to a processor
parent
33826d87
Changes
9
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
208 additions
and
71 deletions
+208
-71
config/schema/facets.processor.schema.yml
config/schema/facets.processor.schema.yml
+8
-0
facets.install
facets.install
+23
-0
src/Plugin/facets/processor/GranularItemProcessor.php
src/Plugin/facets/processor/GranularItemProcessor.php
+22
-11
src/Plugin/facets/query_type/SearchApiGranular.php
src/Plugin/facets/query_type/SearchApiGranular.php
+4
-3
tests/facets_custom_widget/src/Plugin/facets/widget/WidgetDateQT.php
...s_custom_widget/src/Plugin/facets/widget/WidgetDateQT.php
+25
-0
tests/src/Functional/ProcessorIntegrationTest.php
tests/src/Functional/ProcessorIntegrationTest.php
+90
-0
tests/src/Kernel/Entity/FacetFacetSourceTest.php
tests/src/Kernel/Entity/FacetFacetSourceTest.php
+1
-1
tests/src/Unit/Plugin/query_type/SearchApiGranularTest.php
tests/src/Unit/Plugin/query_type/SearchApiGranularTest.php
+35
-9
tests/src/Unit/Plugin/widget/NumericGranularWidgetTest.php
tests/src/Unit/Plugin/widget/NumericGranularWidgetTest.php
+0
-47
No files found.
config/schema/facets.processor.schema.yml
View file @
3323ecff
...
...
@@ -123,3 +123,11 @@ plugin.plugin_configuration.facets_processor.date_item:
date_format
:
type
:
string
label
:
'
Date
format'
plugin.plugin_configuration.facets_processor.granularity_item
:
type
:
mapping
label
:
'
Granular
item
processor'
mapping
:
granularity
:
type
:
integer
label
:
'
Granularity'
facets.install
View file @
3323ecff
...
...
@@ -126,3 +126,26 @@ function facets_update_8004() {
}
}
}
/**
* Migrate facets with granular widget to use date processors + links widget.
*/
function
facets_update_8005
()
{
foreach
(
Facet
::
loadMultiple
()
as
$facet
)
{
$widget
=
$facet
->
getWidget
();
if
(
$widget
[
'type'
]
===
'numericgranular'
)
{
// Set widget to use links instead.
$facet
->
setWidget
(
'links'
,
[
'show_numbers'
=>
$widget
[
'config'
][
'show_numbers'
]]);
// Migrate widget to processor settings and enable date_item processor.
$settings
=
[
'granularity'
=>
$widget
[
'config'
][
'granularity'
],
];
$facet
->
addProcessor
([
'processor_id'
=>
'granularity_item'
,
'weights'
=>
[
'build'
=>
35
],
'settings'
=>
$settings
,
]);
$facet
->
save
();
}
}
}
src/Plugin/facets/
widget/NumericGranularWidget
.php
→
src/Plugin/facets/
processor/GranularItemProcessor
.php
View file @
3323ecff
<?php
namespace
Drupal\facets\Plugin\facets\
widget
;
namespace
Drupal\facets\Plugin\facets\
processor
;
use
Drupal\Core\Form\FormStateInterface
;
use
Drupal\facets\FacetInterface
;
use
Drupal\facets\Processor\BuildProcessorInterface
;
use
Drupal\facets\Processor\ProcessorPluginBase
;
/**
*
Basic granular widget
.
*
Provides a processor for granularity
.
*
* @Facets
Widget
(
* id = "
numericgranular
",
* label = @Translation("Granular
numeric list
"),
* @Facets
Processor
(
* id = "
granularity_item
",
* label = @Translation("Granular
ity item processor
"),
* description = @Translation("List of numbers grouped in steps."),
* stages = {
* "build" = 35
* }
* )
*/
class
NumericGranularWidget
extends
LinksWidget
{
class
GranularItemProcessor
extends
ProcessorPluginBase
implements
BuildProcessorInterface
{
/**
* {@inheritdoc}
*/
public
function
build
(
FacetInterface
$facet
,
array
$results
)
{
return
$results
;
}
/**
* {@inheritdoc}
*/
public
function
defaultConfiguration
()
{
return
[
'granularity'
=>
0
,
'granularity'
=>
1
,
]
+
parent
::
defaultConfiguration
();
}
...
...
@@ -31,16 +43,15 @@ class NumericGranularWidget extends LinksWidget {
public
function
buildConfigurationForm
(
array
$form
,
FormStateInterface
$form_state
,
FacetInterface
$facet
)
{
$configuration
=
$this
->
getConfiguration
();
$form
+=
parent
::
buildConfigurationForm
(
$form
,
$form_state
,
$facet
);
$form
[
'granularity'
]
=
[
$build
[
'granularity'
]
=
[
'#type'
=>
'number'
,
'#attributes'
=>
[
'min'
=>
1
,
'step'
=>
1
],
'#title'
=>
$this
->
t
(
'Granularity'
),
'#default_value'
=>
$configuration
[
'granularity'
],
'#description'
=>
$this
->
t
(
'The numeric size of the steps to group the result facets in.'
),
];
return
$
form
;
return
$
build
;
}
/**
...
...
src/Plugin/facets/query_type/SearchApiGranular.php
View file @
3323ecff
...
...
@@ -23,7 +23,7 @@ class SearchApiGranular extends QueryTypeRangeBase {
public
function
calculateRange
(
$value
)
{
return
[
'start'
=>
$value
,
'stop'
=>
$value
+
$this
->
getGranularity
(),
'stop'
=>
(
int
)
$value
+
$this
->
getGranularity
(),
];
}
...
...
@@ -31,6 +31,7 @@ class SearchApiGranular extends QueryTypeRangeBase {
* {@inheritdoc}
*/
public
function
calculateResultFilter
(
$value
)
{
assert
(
$this
->
getGranularity
()
>
0
);
return
[
'display'
=>
$value
-
(
$value
%
$this
->
getGranularity
()),
'raw'
=>
$value
-
(
$value
%
$this
->
getGranularity
())
,
...
...
@@ -42,11 +43,11 @@ class SearchApiGranular extends QueryTypeRangeBase {
*
* Default behaviour an integer for the steps that the facet works in.
*
* @return
mixed
* @return
int
* If not an integer the inheriting class needs to deal with calculations.
*/
protected
function
getGranularity
()
{
return
$this
->
facet
->
get
WidgetInstance
()
->
getConfiguration
()[
'granularity'
];
return
$this
->
facet
->
get
Processors
()[
'granularity_item'
]
->
getConfiguration
()[
'granularity'
];
}
}
tests/facets_custom_widget/src/Plugin/facets/widget/WidgetDateQT.php
0 → 100644
View file @
3323ecff
<?php
namespace
Drupal\facets_custom_widget\Plugin\facets\widget
;
use
Drupal\facets\Widget\WidgetPluginBase
;
/**
* Test widget.
*
* @FacetsWidget(
* id = "widget_date_qt",
* label = @Translation("Widget with date query type"),
* description = @Translation("Widget with date query type"),
* )
*/
class
WidgetDateQT
extends
WidgetPluginBase
{
/**
* {@inheritdoc}
*/
public
function
getQueryType
()
{
return
'date'
;
}
}
tests/src/Functional/ProcessorIntegrationTest.php
View file @
3323ecff
...
...
@@ -203,6 +203,96 @@ class ProcessorIntegrationTest extends FacetsTestBase {
$this
->
assertFacetLabel
(
'Øn'
);
}
/**
* Tests the for configuration of granularity processor.
*/
public
function
testNumericGranularity
()
{
$field_name
=
'field_integer'
;
$field_storage
=
FieldStorageConfig
::
create
([
'field_name'
=>
$field_name
,
'entity_type'
=>
'entity_test_mulrev_changed'
,
'type'
=>
'integer'
,
]);
$field_storage
->
save
();
$field
=
FieldConfig
::
create
([
'field_storage'
=>
$field_storage
,
'bundle'
=>
'item'
,
]);
$field
->
save
();
$field
=
FieldConfig
::
create
([
'field_storage'
=>
$field_storage
,
'bundle'
=>
'article'
,
]);
$field
->
save
();
$index
=
$this
->
getIndex
();
// Index the taxonomy and entity reference fields.
$integerField
=
new
Field
(
$index
,
$field_name
);
$integerField
->
setType
(
'integer'
);
$integerField
->
setPropertyPath
(
$field_name
);
$integerField
->
setDatasourceId
(
'entity:entity_test_mulrev_changed'
);
$integerField
->
setLabel
(
'IntegerField'
);
$index
->
addField
(
$integerField
);
$index
->
save
();
$this
->
indexItems
(
$this
->
indexId
);
$entity_test_storage
=
\
Drupal
::
entityTypeManager
()
->
getStorage
(
'entity_test_mulrev_changed'
);
foreach
([
30
,
35
,
40
,
100
]
as
$val
)
{
$entity_test_storage
->
create
([
'name'
=>
'foo bar baz'
,
'body'
=>
'test test int'
,
'type'
=>
'item'
,
'keywords'
=>
[
'orange'
],
'category'
=>
'item_category'
,
$field_name
=>
$val
,
])
->
save
();
}
$this
->
indexItems
(
$this
->
indexId
);
$facet_id
=
"integer"
;
// Create facet.
$this
->
editForm
=
'admin/config/search/facets/'
.
$facet_id
.
'/edit'
;
$this
->
createFacet
(
"Integer"
,
$facet_id
,
$field_name
);
// Check values.
$this
->
drupalGet
(
'search-api-test-fulltext'
);
$this
->
assertFacetLabel
(
'100'
);
$this
->
assertFacetLabel
(
'30'
);
$this
->
assertFacetLabel
(
'35'
);
$this
->
assertFacetLabel
(
'40'
);
$form
=
[
'facet_settings[granularity_item][status]'
=>
TRUE
,
];
$this
->
drupalPostForm
(
$this
->
editForm
,
$form
,
'Save'
);
// Check values.
$this
->
drupalGet
(
'search-api-test-fulltext'
);
$this
->
assertFacetLabel
(
'30 (1)'
);
$this
->
assertFacetLabel
(
'35'
);
$this
->
assertFacetLabel
(
'40'
);
$this
->
assertFacetLabel
(
'100'
);
$form
=
[
'facet_settings[granularity_item][status]'
=>
TRUE
,
'facet_settings[granularity_item][settings][granularity]'
=>
10
,
];
$this
->
drupalPostForm
(
$this
->
editForm
,
$form
,
'Save'
);
// Check values.
$this
->
drupalGet
(
'search-api-test-fulltext'
);
$this
->
assertFacetLabel
(
'30 (2)'
);
$this
->
assertEmpty
(
$this
->
findFacetLink
(
'35'
));
$this
->
assertFacetLabel
(
'40'
);
$this
->
assertFacetLabel
(
'100'
);
}
/**
* Tests the for sorting processors in the frontend with a 'keywords' facet.
*/
...
...
tests/src/Kernel/Entity/FacetFacetSourceTest.php
View file @
3323ecff
...
...
@@ -178,7 +178,7 @@ class FacetFacetSourceTest extends EntityKernelTestBase {
*/
public
function
testQueryTypeJugglingInvalidCombo
()
{
$entity
=
new
Facet
([],
'facets_facet'
);
$entity
->
setWidget
(
'
numericgranular
'
);
$entity
->
setWidget
(
'
widget_date_qt
'
);
$entity
->
setFacetSourceId
(
'search_api:views_page__search_api_test_view__page_1'
);
$entity
->
setFieldIdentifier
(
'name'
);
$processor
=
[
...
...
tests/src/Unit/Plugin/query_type/SearchApiGranularTest.php
View file @
3323ecff
...
...
@@ -2,16 +2,19 @@
namespace
Drupal\Tests\facets\Unit\Plugin\query_type
;
use
Drupal\Core\DependencyInjection\ContainerBuilder
;
use
Drupal\facets\Entity\Facet
;
use
Drupal\facets\FacetInterface
;
use
Drupal\facets\Plugin\facets\processor\GranularItemProcessor
;
use
Drupal\facets\Plugin\facets\query_type
\
SearchApiGranular
;
use
Drupal\facets\Processor\ProcessorPluginManager
;
use
Drupal\search_api
\
Backend\BackendInterface
;
use
Drupal\search_api
\
IndexInterface
;
use
Drupal\facets\Result\ResultInterface
;
use
Drupal\facets\Widget\WidgetPluginInterface
;
use
Drupal\search_api
\
Plugin\views\query\SearchApiQuery
;
use
Drupal\search_api
\
ServerInterface
;
use
Drupal\Tests\UnitTestCase
;
use
Prophecy\Argument
;
/**
* Unit test for granular query type.
...
...
@@ -20,6 +23,32 @@ use Drupal\Tests\UnitTestCase;
*/
class
SearchApiGranularTest
extends
UnitTestCase
{
/**
* {@inheritdoc}
*/
public
function
setUp
()
{
parent
::
setUp
();
$processor_id
=
'granularity_item'
;
$processor_definitions
=
[
$processor_id
=>
[
'id'
=>
$processor_id
,
'class'
=>
GranularItemProcessor
::
class
,
],
];
$granularityProcessor
=
new
GranularItemProcessor
([
'granularity'
=>
10
],
'granularity_item'
,
[]);
$processor_manager
=
$this
->
prophesize
(
ProcessorPluginManager
::
class
);
$processor_manager
->
getDefinitions
()
->
willReturn
(
$processor_definitions
);
$processor_manager
->
createInstance
(
'granularity_item'
,
Argument
::
any
())
->
willReturn
(
$granularityProcessor
);
$container
=
new
ContainerBuilder
();
$container
->
set
(
'plugin.manager.facets.processor'
,
$processor_manager
->
reveal
());
\
Drupal
::
setContainer
(
$container
);
}
/**
* Tests string query type without executing the query with an "AND" operator.
*/
...
...
@@ -37,14 +66,11 @@ class SearchApiGranularTest extends UnitTestCase {
[
'query_operator'
=>
'AND'
,
'widget'
=>
'links'
],
'facets_facet'
);
$facetReflection
=
new
\
ReflectionClass
(
Facet
::
class
);
$widget
=
$this
->
getMockBuilder
(
WidgetPluginInterface
::
class
)
->
disableOriginalConstructor
()
->
getMock
();
$widget
->
method
(
'getConfiguration'
)
->
will
(
$this
->
returnValue
([
'granularity'
=>
10
]));
$widget_instance
=
$facetReflection
->
getProperty
(
'widgetInstance'
);
$widget_instance
->
setAccessible
(
TRUE
);
$widget_instance
->
setValue
(
$facet
,
$widget
);
$facet
->
addProcessor
([
'processor_id'
=>
'granularity_item'
,
'weights'
=>
[],
'settings'
=>
[
'granularity'
=>
10
],
]);
// Results for the widget.
$original_results
=
[
...
...
tests/src/Unit/Plugin/widget/NumericGranularWidgetTest.php
deleted
100644 → 0
View file @
33826d87
<?php
namespace
Drupal\Tests\facets\Unit\Plugin\widget
;
use
Drupal\facets\Plugin\facets\widget\NumericGranularWidget
;
/**
* Unit test for widget.
*
* @group facets
*/
class
NumericGranularWidgetTest
extends
WidgetTestBase
{
/**
* {@inheritdoc}
*/
public
function
setUp
()
{
parent
::
setUp
();
$this
->
widget
=
new
NumericGranularWidget
();
}
/**
* {@inheritdoc}
*/
public
function
testGetQueryType
()
{
$result
=
$this
->
widget
->
getQueryType
(
$this
->
queryTypes
);
$this
->
assertEquals
(
'numeric'
,
$result
);
}
/**
* {@inheritdoc}
*/
public
function
testDefaultConfiguration
()
{
$default_config
=
$this
->
widget
->
defaultConfiguration
();
$expected
=
[
'show_numbers'
=>
FALSE
,
'soft_limit'
=>
0
,
'granularity'
=>
0
,
'soft_limit_settings'
=>
[
'show_less_label'
=>
'Show less'
,
'show_more_label'
=>
'Show more'
,
],
];
$this
->
assertEquals
(
$expected
,
$default_config
);
}
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment