ENH: Provide more control over elemental block indexing.

[GuySartorelli]

Provides a new configuration variable to exclude specific elemental block classes from being indexed in search.
Also provides a new extension point for modifying exactly what gets indexed for each block.

[GuySartorelli]

Not sure when I'll get a chance to update this to be in line with @michalkleiner's recommendations - setting to draft until then.

[GuySartorelli]

Tests are failing, but I don't see how the changes I've made could have caused that.... can someone who understands the ElementSiteTreeFilterSearchTest please take a look?

[emteknetnz]

Seems good, some requested changes

Could you also add some unit tests? Particularly for BaseElement::getContentForSearchIndex().

Let me know if not sure how to go about setting up tests for this and I'll point you in the right direction

[GuySartorelli]

@emteknetnz I'll make the requested changes as time permits, hopefully in the next week. Please refer to the discussion on the PHPDoc and let me know on that one.

I note there is also a conflict now so I'll resolve that at the same time.

[GuySartorelli]

@emteknetnz I've made the requested changes (though see discussion about phpdoc return type which affects the related typehint) except tests. I've also added some documentation, rebased off 4, and squashed commits.

Let me know if not sure how to go about setting up tests for this and I'll point you in the right direction

Yes please. I thought the tests would be relatively straight forward but I spent a good 15 minutes and then realised I'm not really sure what exactly I want to be testing... if you could give me a direction (even just some method signatures or comments to build off) that would be great.

[GuySartorelli]

Failed tests are because I forgot Extension isn't inherently Configurable - I'll fix that at the same time as writing tests once I know what tests to write.

[emteknetnz]

Tiny linting thing and change return type to string. Cheers

[emteknetnz]

@GuySartorelli This would be a good level of test coverage for the work you've done here:

Setup:

• Create a couple of test elements of ElementContent (comes with HTML db field). $element->HTML = '<p>some HTML</p><p>etc</p>'; $element->write();
• Create a test Extension and put it on ElementContent that implements the updateContentForSearchIndex hook.
• Add elements to an ElementalArea + SiteTree

See an example here for how to add test extensions in a unit test

To change the config for the delimiter in the unit test, simply MyClass::config()->set('config_var', $value); - it will reset between tests so won't affect other tests (we'll I'm at least 99% sure on that :-)

Tests:
a) Test that changing search_index_element_delimiter delimits the output
b) Test that getContentForSearchIndex adds spaces to HTML
c) Test that an extension implementing updateContentForSearchIndex updates the content

[GuySartorelli]

Tests failed - working on that now. I can't get the tests to run locally so there may be a few forced pushes while I get this sorted.

[GuySartorelli]

@emteknetnz I've added the requested tests and those are passing. There is one test that's failing, but I haven't touched that test and (from what I can tell) none of the changes I've made should be causing this to fail. Can you please take a look?

[emteknetnz]

@GuySartorelli found the issue for the travis failure, it was an existing bug - have created a PR #957

[emteknetnz]

Travis failure is an existing bug that this PR highlighted, separate PR to fix it is here #957