Skip to content

Commit 04f03ab

Browse files
evermind-zzStypox
evermind-zz
authored and
Stypox
committed
searchfilters: Moving DividerItem from NewPipeExtractor into NewPipe
DividerItem was inserted in the content filter framework in the NewPipeExtractor to have a section title for YoutubeMusic. But as UI releated stuff seems a bit out of place in the Extractor I came up with injecting the DividerItem aka section title in the frontend without having to change too much in the frontend.
1 parent 0985afa commit 04f03ab

File tree

8 files changed

+42
-52
lines changed

8 files changed

+42
-52
lines changed

‎extractor/src/main/java/org/schabi/newpipe/extractor/search/filter/FilterContainer.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
package org.schabi.newpipe.extractor.search.filter;
44

5+
import java.util.ArrayList;
6+
import java.util.Arrays;
57
import java.util.HashMap;
8+
import java.util.List;
69
import java.util.Map;
10+
import java.util.stream.Collectors;
711

812
import javax.annotation.Nonnull;
913

@@ -20,10 +24,11 @@ public final class FilterContainer {
2024
public static final int ITEM_IDENTIFIER_UNKNOWN = -1;
2125

2226
private final Map<Integer, FilterItem> idToFilterItem = new HashMap<>();
23-
private final FilterGroup[] filterGroups;
27+
private final List<FilterGroup> filterGroups;
2428

2529
public FilterContainer(@Nonnull final FilterGroup[] filterGroups) {
26-
this.filterGroups = filterGroups;
30+
this.filterGroups =
31+
Arrays.stream(filterGroups).collect(Collectors.toCollection(ArrayList::new));
2732
for (final FilterGroup group : filterGroups) {
2833
for (final FilterItem item : group.getFilterItems()) {
2934
idToFilterItem.put(item.getIdentifier(), item);
@@ -41,7 +46,7 @@ public FilterItem getFilterItem(final int id) {
4146
return idToFilterItem.get(id);
4247
}
4348

44-
public FilterGroup[] getFilterGroups() {
49+
public List<FilterGroup> getFilterGroups() {
4550
return filterGroups;
4651
}
4752
}

‎extractor/src/main/java/org/schabi/newpipe/extractor/search/filter/FilterGroup.java‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
package org.schabi.newpipe.extractor.search.filter;
44

5+
import java.util.ArrayList;
6+
import java.util.Arrays;
57
import java.util.HashMap;
8+
import java.util.List;
69
import java.util.Map;
10+
import java.util.stream.Collectors;
711

812
import javax.annotation.Nonnull;
913
import javax.annotation.Nullable;
@@ -44,7 +48,7 @@ public final class FilterGroup {
4448
/**
4549
* The filter items that belong to this {@link FilterGroup}.
4650
*/
47-
private final FilterItem[] filterItems;
51+
private final List<FilterItem> filterItems;
4852

4953
/**
5054
* {@link #getAllSortFilters()}.
@@ -55,7 +59,7 @@ private FilterGroup(final int identifier,
5559
@Nullable final LibraryStringIds groupNameId,
5660
final boolean onlyOneCheckable,
5761
final int defaultSelectedFilterId,
58-
@Nonnull final FilterItem[] filterItems,
62+
@Nonnull final List<FilterItem> filterItems,
5963
@Nullable final FilterContainer allSortFilters) {
6064
this.identifier = identifier;
6165
this.groupNameId = groupNameId;
@@ -99,8 +103,9 @@ public int getDefaultSelectedFilterId() {
99103

100104
/**
101105
* {@link #filterItems}
106+
* @return
102107
*/
103-
public FilterItem[] getFilterItems() {
108+
public List<FilterItem> getFilterItems() {
104109
return filterItems;
105110
}
106111

@@ -133,13 +138,6 @@ public static class Factory {
133138
void uniqueIdChecker(final Map<Integer, FilterItem> filterItems,
134139
final FilterItem item) {
135140

136-
if (item.getIdentifier() == FilterContainer.ITEM_IDENTIFIER_UNKNOWN
137-
&& !(item instanceof FilterItem.DividerItem)) {
138-
throw new InvalidFilterIdException("Filter ID "
139-
+ item.getIdentifier() + " aka FilterContainer.ITEM_IDENTIFIER_UNKNOWN"
140-
+ " for \"" + item.getNameId() + "\" not allowed");
141-
}
142-
143141
if (filterItems.containsKey(item.getIdentifier())) {
144142
throw new InvalidFilterIdException("Filter ID "
145143
+ item.getIdentifier() + " for \""
@@ -170,7 +168,9 @@ public FilterGroup createFilterGroup(final int identifier,
170168
@Nonnull final FilterItem[] filterItems,
171169
@Nullable final FilterContainer allSortFilters) {
172170
return new FilterGroup(identifier, groupNameId, onlyOneCheckable,
173-
defaultSelectedFilterId, filterItems, allSortFilters);
171+
defaultSelectedFilterId,
172+
Arrays.stream(filterItems).collect(Collectors.toCollection(ArrayList::new)),
173+
allSortFilters);
174174
}
175175

176176
/**

‎extractor/src/main/java/org/schabi/newpipe/extractor/search/filter/FilterItem.java‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,6 @@ public LibraryStringIds getNameId() {
5151
return this.nameId;
5252
}
5353

54-
/**
55-
* This class is used to have a sub title divider between regular {@link FilterItem}s.
56-
*/
57-
public static class DividerItem extends FilterItem {
58-
59-
public DividerItem(final LibraryStringIds nameId) {
60-
super(FilterContainer.ITEM_IDENTIFIER_UNKNOWN, nameId);
61-
}
62-
}
63-
6454
@Override
6555
public boolean equals(final Object obj) {
6656
return (obj instanceof FilterItem) && ((FilterItem) obj).identifier == this.identifier;

‎extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/search/filter/YoutubeFilters.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -430,9 +430,6 @@ protected void init() {
430430
groupsFactory.getFilterForId(ID_CF_MAIN_CHANNELS),
431431
groupsFactory.getFilterForId(ID_CF_MAIN_PLAYLISTS),
432432
// groupsFactory.getFilterForId(ID_CF_MAIN_MOVIES),
433-
groupsFactory.getFilterForId(groupsFactory.addFilterItem(
434-
new FilterItem.DividerItem(
435-
LibraryStringIds.SEARCH_FILTERS_YOUTUBE_MUSIC))),
436433
groupsFactory.getFilterForId(ID_CF_MAIN_YOUTUBE_MUSIC_SONGS),
437434
groupsFactory.getFilterForId(ID_CF_MAIN_YOUTUBE_MUSIC_VIDEOS),
438435
groupsFactory.getFilterForId(ID_CF_MAIN_YOUTUBE_MUSIC_ALBUMS),

‎extractor/src/test/java/org/schabi/newpipe/extractor/services/DefaultFiltersTest.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
import org.schabi.newpipe.extractor.search.filter.FilterItem;
1212

1313
import java.util.ArrayList;
14-
import java.util.Arrays;
1514
import java.util.HashMap;
1615
import java.util.List;
1716
import java.util.Map;
@@ -172,10 +171,10 @@ public void contentFiltersWithSortFilterTest() {
172171
contentFiltersThatHaveCorrespondingSortFilters);
173172

174173
for (final FilterGroup cfGroup : filterContainer.getFilterGroups()) {
175-
if (cfGroup.getFilterItems().length > 0) {
174+
if (!cfGroup.getFilterItems().isEmpty()) {
176175
// if below id is having a sortFilterVariant it should be the same
177176
// variant than the one placed as superset to this group
178-
final int id = cfGroup.getFilterItems()[0].getIdentifier();
177+
final int id = cfGroup.getFilterItems().get(0).getIdentifier();
179178
if (contentFiltersThatHaveCorrespondingSortFilters.contains(id)) {
180179
final FilterContainer sortFilterVariant =
181180
searchFilterBase.getContentFilterSortFilterVariant(id);
@@ -222,7 +221,7 @@ protected List<FilterItem> getAllSortFiltersList() {
222221
final FilterContainer sortFilterContainer = group.getAllSortFilters();
223222
if (null != sortFilterContainer) {
224223
for (final FilterGroup filterGroup : sortFilterContainer.getFilterGroups()) {
225-
filterItems.addAll(Arrays.asList(filterGroup.getFilterItems()));
224+
filterItems.addAll(filterGroup.getFilterItems());
226225
}
227226
}
228227
}
@@ -252,7 +251,7 @@ protected List<FilterItem> getAllContentFiltersList() {
252251
protected List<FilterItem> getAllFiltersList(final FilterContainer filterContainer) {
253252
final List<FilterItem> filterItemList = new ArrayList<>();
254253
for (final FilterGroup cfGroup : filterContainer.getFilterGroups()) {
255-
filterItemList.addAll(Arrays.asList(cfGroup.getFilterItems()));
254+
filterItemList.addAll(cfGroup.getFilterItems());
256255
}
257256
return filterItemList;
258257
}

‎extractor/src/test/java/org/schabi/newpipe/extractor/services/DefaultSearchExtractorTest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010

1111
import java.net.MalformedURLException;
1212
import java.net.URL;
13-
import java.util.Arrays;
1413
import java.util.Collections;
1514
import java.util.List;
1615
import java.util.stream.Collectors;
@@ -43,9 +42,9 @@ public static int getNoOfSortFilterItems(final FilterContainer contentFilterCont
4342
}
4443

4544
public static int getNoOfFilterItems(final FilterContainer filterContainer) {
46-
return Arrays.stream(filterContainer.getFilterGroups())
45+
return filterContainer.getFilterGroups().stream()
4746
.map(FilterGroup::getFilterItems)
48-
.mapToInt(filterItems -> filterItems.length)
47+
.mapToInt(filterItems -> filterItems.size())
4948
.sum();
5049
}
5150

‎extractor/src/test/java/org/schabi/newpipe/extractor/services/soundcloud/search/SoundcloudSearchQHTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ public void testGetAvailableContentFilter() {
8181

8282
assertEquals(4, noOfContentFilters);
8383
assertEquals(SoundcloudFilters.ID_CF_MAIN_ALL,
84-
contentFilter.getFilterGroups()[0].getFilterItems()[0].getIdentifier());
84+
contentFilter.getFilterGroups().get(0).getFilterItems().get(0).getIdentifier());
8585
assertEquals(SoundcloudFilters.ID_CF_MAIN_TRACKS,
86-
contentFilter.getFilterGroups()[0].getFilterItems()[1].getIdentifier());
86+
contentFilter.getFilterGroups().get(0).getFilterItems().get(1).getIdentifier());
8787
assertEquals(SoundcloudFilters.ID_CF_MAIN_USERS,
88-
contentFilter.getFilterGroups()[0].getFilterItems()[2].getIdentifier());
88+
contentFilter.getFilterGroups().get(0).getFilterItems().get(2).getIdentifier());
8989
assertEquals(SoundcloudFilters.ID_CF_MAIN_PLAYLISTS,
90-
contentFilter.getFilterGroups()[0].getFilterItems()[3].getIdentifier());
90+
contentFilter.getFilterGroups().get(0).getFilterItems().get(3).getIdentifier());
9191
}
9292

9393
@Test

‎extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/search/YoutubeSearchQHTest.java‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package org.schabi.newpipe.extractor.services.youtube.search;
22

33
import static org.junit.jupiter.api.Assertions.assertEquals;
4-
import static org.junit.jupiter.api.Assertions.assertTrue;
54
import static org.schabi.newpipe.extractor.ServiceList.YouTube;
65
import static java.util.Collections.singletonList;
76

@@ -11,6 +10,8 @@
1110
import org.schabi.newpipe.extractor.services.DefaultSearchExtractorTest;
1211
import org.schabi.newpipe.extractor.services.youtube.search.filter.YoutubeFilters;
1312

13+
import java.util.List;
14+
1415
public class YoutubeSearchQHTest {
1516

1617
@Test
@@ -71,18 +72,17 @@ public void testGetAvailableContentFilter() {
7172
YouTube.getSearchQHFactory().getAvailableContentFilter();
7273

7374
final int noOfContentFilters = DefaultSearchExtractorTest.getNoOfFilterItems(contentFilter);
74-
final FilterItem[] filterItems = contentFilter.getFilterGroups()[0].getFilterItems();
75-
assertEquals(10, noOfContentFilters);
76-
assertEquals(YoutubeFilters.ID_CF_MAIN_ALL, filterItems[0].getIdentifier());
77-
assertEquals(YoutubeFilters.ID_CF_MAIN_VIDEOS, filterItems[1].getIdentifier());
78-
assertEquals(YoutubeFilters.ID_CF_MAIN_CHANNELS, filterItems[2].getIdentifier());
79-
assertEquals(YoutubeFilters.ID_CF_MAIN_PLAYLISTS, filterItems[3].getIdentifier());
80-
assertTrue(filterItems[4] instanceof FilterItem.DividerItem);
81-
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_SONGS, filterItems[5].getIdentifier());
82-
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_VIDEOS, filterItems[6].getIdentifier());
83-
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_ALBUMS, filterItems[7].getIdentifier());
84-
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_PLAYLISTS, filterItems[8].getIdentifier());
85-
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_ARTISTS, filterItems[9].getIdentifier());
75+
final List<FilterItem> filterItems = contentFilter.getFilterGroups().get(0).getFilterItems();
76+
assertEquals(9, noOfContentFilters);
77+
assertEquals(YoutubeFilters.ID_CF_MAIN_ALL, filterItems.get(0).getIdentifier());
78+
assertEquals(YoutubeFilters.ID_CF_MAIN_VIDEOS, filterItems.get(1).getIdentifier());
79+
assertEquals(YoutubeFilters.ID_CF_MAIN_CHANNELS, filterItems.get(2).getIdentifier());
80+
assertEquals(YoutubeFilters.ID_CF_MAIN_PLAYLISTS, filterItems.get(3).getIdentifier());
81+
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_SONGS, filterItems.get(4).getIdentifier());
82+
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_VIDEOS, filterItems.get(5).getIdentifier());
83+
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_ALBUMS, filterItems.get(6).getIdentifier());
84+
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_PLAYLISTS, filterItems.get(7).getIdentifier());
85+
assertEquals(YoutubeFilters.ID_CF_MAIN_YOUTUBE_MUSIC_ARTISTS, filterItems.get(8).getIdentifier());
8686
}
8787

8888
@Test

0 commit comments

Comments
 (0)